AccountingEntry

Note

There are several methods available for creating accounting entries.

This page provides information about the general structure of an accounting entry as returned in a query.
For the creation process, please refer to How to create?

HTTP	Operation	Type	Object	DTO Why-DTOs?
POST	Create	Mutation	How to create?
POST	Delete	Mutation	`deleteAccountingEntry`	`AccountingEntryDeleteGLDtoInput`
POST	Read	Query	`accountingEntries filtered by id` Why?
POST	List	Query	`accountingEntries`
POST	List	Query	`accountingEntryLines`

Description

Accounting entries, known as AccountingEntry in the API context and Journal entries in the product interface, in the context of financial management and record-keeping, refer to the detailed transactions that accurately record the movement of funds, assets, liabilities, and equity within an organization.

These entries serve as crucial components of a company’s financial records, capturing various financial activities such as revenue generation, expense allocation, and asset acquisitions.
Accounting entries are categorized and organized into journals based on their specific characteristics, and these characteristics are determined by the associated journal.
It’s important to note that an accounting entry must be balanced, ensuring that debits equal credits.
This means that accounting entries are complete accounting documents rather than individual lines of entries

Key	Value
`Authorization`	Bearer Current access Token How to find?
`X-TenantId`	Current tenant id How to find?
`X-OrganizationId`	Current organization Id How to find?
`x-api-key`	Primary or secondary subscription key of your app How to find?

Quick Tips

It is possible to query either accountingEntry or directly from accountingEntryLines.

Querying accountingEntry allows you to retrieve entire entries with all their associated line items.
This is useful when you need the complete context of an entry, including all details of the related lines.
Querying accountingEntryLines directly is beneficial when you want to filter or aggregate specific line item data across multiple entries.

accountingEntries

Fields	Type	Description	Length
idSSystem field that cannot be assigned	UUID	Id
creationDateSSystem field that cannot be assigned	DateTime	Creation Date
modificationDateSSystem field that cannot be assigned	DateTime	Modification Date

date	Datetime DateThe GraphQL field type is DateTime, but only the date value is considered, the time value is ignored if provided.	Date
documentDate NEWNew Feature Recently Added. (Introduced in the last version as well as in the previous version)	Datetime DateThe GraphQL field type is DateTime, but only the date value is considered, the time value is ignored if provided.	Document Date
accountingExercise DATALOADERUtilize the DATALOADER feature to enrich your query by adding additional resource fields directly in the query.	AccountingExercise	Fields of AccountingExercise
accountingExerciseId	UUID	Id of AccountingExercise
accountingPeriod DATALOADERUtilize the DATALOADER feature to enrich your query by adding additional resource fields directly in the query.	AccountingPeriod	Fields of AccountingPeriod
accountingPeriodId	UUID	Id of AccountingPeriod
journalType DATALOADERUtilize the DATALOADER feature to enrich your query by adding additional resource fields directly in the query.	JournalType	Fields of JournalType
journalTypeId	UUID	JournalType Id
entryType	UNDEFINED OPENING GENERAL CLOSURE_ACCOUNTING CLOSURE_WORTH CLOSURE_EXERCISE TEMPORARY_CARRY_FORWARD	Type of entry
session DATALOADERUtilize the DATALOADER feature to enrich your query by adding additional resource fields directly in the query.	Session	Fields of Session (id, name, stamp,deactivated) See InfoAdditional information is available in the Info block below
sessionId DIn creation, this field can have a default value automatically calculated	UUID	Session id See InfoAdditional information is available in the Info block below
number	Decimal	Number See InfoAdditional information is available in the Info block below
documentNumber	String	Document number or reference of the entrySee InfoAdditional information is available in the Info block below	50
description	String	Description See InfoAdditional information is available in the Info block below	200
closeDate InvThis field is not visible in the product interface	Datetime DateThe GraphQL field type is DateTime, but only the date value is considered, the time value is ignored if provided.	closing date of entry
isClosed	Boolean	True if closed
accountingEntryLines[]	Array	List of all lines of entry See InfoAdditional information is available in the Info block below

salesInvoice DATALOADERUtilize the DATALOADER feature to enrich your query by adding additional resource fields directly in the query.	salesInvoice	Sales Invoice Header Fields See InfoAdditional information is available in the Info block below
sourceEntityId	UUID	If provided, see sourceType to identify the entity See InfoAdditional information is available in the Info block below
sourceType	NOT_SPECIFIED SALES PURCHASES COLLECTIONS PAYMENTS ACCOUNTING IMPORT_FILES IMPORT_OD YEAR_END_PROCESS PUBLIC_API AP_AUTOMATION YEAR_END_PROCESS_PREVIEW OTHER	indicates the origin of the accounting entrySee InfoAdditional information is available in the Info block below

Info

number : operational Number Counter Id
documentNumber : The reference number of the document. Mandatory in legislation DE. For purchases or sales, it can be filled with the invoice number.
description : optional value, used as template for lines from the interface to assign default value to lines.
accountingEntryLines : List of lines in the accounting entry, the accounting entry must be balanced, the total of the lines with a debit must be equal to the total of the lines with a credit. Adding an unbalanced entry will return an error.
sourceEntityId : ID of a sales invoice, purchase invoice, collected payment, or issued payment, this value can be null.
If this value is provided, refer to the sourceType to determine the associated entity.
Note that salesInvoiceId holds the same value as sourceEntityId when sourceType=SALES
sourceType : Indicates the origin of the accounting entry, detailing how it was generated. This field categorizes entries based on their source, such as sales, purchases, collections, and various import processes among others, to provide clarity and facilitate tracking of financial activities.
Each source type corresponds to a specific method or area within the business operations that has contributed to the accounting record.
salesInvoice : Only invoice header fields are available. To obtain other information (such as lines, addresses, etc.), use the salesInvoice operation directly.
sessionId and session:
A session adds identifiable information to journal entries.
Unused (For Germany only).

Unused (For Germany only).
sessionId: the session identifier, this value is mandatory.

session allows retrieving:

id: the session identifier, which can be retrieved here or via sessionId.

name: the session name (e.g., Automatisch erstellt)

stamp: the session name and timestamp (e.g., Automatisch erstellt 12.06.2024 10:20:04)

deactivated: the session status. When true, the session cannot be used for a new accounting entry.

accountingEntries/accountingEntryLines or accountingEntryLines

If the query targets accountingEntries, then use accountingEntries/accountingEntrylines to get the details of the lines.
If the query targets accountingEntryLines, access the following fields directly, including the option to retrieve information on the parent accountingEntries.

Fields	Type	Description	Length
idSSystem field that cannot be assigned	UUID	Id
creationDateSSystem field that cannot be assigned	DateTime	Creation Date
modificationDateSSystem field that cannot be assigned	Date	Modification Date

*accountingEntries Parent Information*
accountingEntries DATALOADERUtilize the DATALOADER feature to enrich your query by adding additional resource fields directly in the query.	accountingEntry	Fields of the parent accountingEntries	36
accountingEntryId	UUID	accountingEntry ID

subAccount DATALOADERUtilize the DATALOADER feature to enrich your query by adding additional resource fields directly in the query.	AccountingAccount	Fields of AccountingAccount
subAccountId	UUID	Id of accountingAccount
order	Int	Classification of lines from 0 to n
documentNumber	String	Document number or reference of the entry	50
contraAccount	String	Contra Account See InfoAdditional information is available in the Info block below	113
description	String	Description	200
debitAmount	Decimal	Amount debit
creditAmount	Decimal	Amount credit
accountingEntryThirdParty	ObjectType	ThirdParty See InfoAdditional information is available in the Info block below
accountingEntryPayment	ObjectType	Matching
accountingEntryInvoice	ObjectType	Invoice See InfoAdditional information is available in the Info block below

Info

accountingEntryThirdParty :Lines with a third party CUSTOMER, SUPPLIER, EMPLOYEE.
accountingEntryInvoice : Lines with a third party CUSTOMER, SUPPLIER for journal types PURCHASE_INVOICE or SALES_INVOICE.
contraAccount : Lines with a general offset account.

Unused (For Germany only).

Unused (For Germany only).

Used only for Germany.

accountingEntries/accountingEntryLines/accountingEntryThirdParty

Fields	Type	Description	Length
idSSystem field that cannot be assigned	UUID	Id
creationDateSSystem field that cannot be assigned	DateTime	Creation Date
modificationDateSSystem field that cannot be assigned	DateTime	Modification Date

thirdPartyId	UUID	Third Id See InfoAdditional information is available in the Info block below
socialName	String	Third Name See InfoAdditional information is available in the Info block below	70
code	String	Code See InfoAdditional information is available in the Info block below	17
origin	CUSTOMER SUPPLIER EMPLOYEE	Type of third
identificationTypeId	UUID	DocumentType Id See InfoAdditional information is available in the Info block below
documentId	String	Document Id See InfoAdditional information is available in the Info block below	25
vatNumber	String	vat Number See InfoAdditional information is available in the Info block below	25
countryAcronym	String	Country Acronym	2
viesCode RThis field is read-only, its value cannot be assigned	String	VIES value prefix of the European Community VAT numbers

Info

thirdPartyId : Third party id :
- If journal type equal to PURCHASE_INVOICE the third party is a Supplier.
- If journal type equal to SALES_INVOICE the third party is a Customer.
- In the other cases, the third party can be a Supplier, Customer or Employee.
socialName : Found in the third party as socialName for customer & supplier and name for employee.
code : Found in the third party as code.
identificationTypeId : Found in the third party as documentTypeId.
documentId : Found in the third party as documentId.
vatNumber : Found in the third party as vatNumber.

accountingEntries/accountingEntryLines/accountingEntryPayment

Fields	Type	Description	Length
id SSystem field that cannot be assigned	UUID	Id
creationDate SSystem field that cannot be assigned	DateTime	Creation Date
modificationDate SSystem field that cannot be assigned	DateTime	Modification Date

matching	PARTIAL_MATCH FULL_MATCH	Status matching See InfoAdditional information is available in the Info block below
matchingLetter	String	Letter matching See InfoAdditional information is available in the Info block below	5

Info

Information available only in reading mode concerning the lettering of the line.

matching: Indicates if the line corresponds to a complete or partial lettering. Can take the values FULL_MATCH for a complete lettering, PARTIAL_MATCH for a partial lettering.
matchingLetter: letter A, B, C … for a complete lettering, letter a, b, c … for a partial lettering.

accountingEntries/accountingEntryLines/accountingEntryInvoice

Fields	Type	Description	Length
idSSystem field that cannot be assigned	UUID	Id
creationDateSSystem field that cannot be assigned	DateTime	Date Creation
modificationDateSSystem field that cannot be assigned	DateTime	Date Modification

documentDate	Datetime	Document date
externalInvoiceNumber	String	Invoice number	50
amount	Decimal	Amount See InfoAdditional information is available in the Info block below
openItems[]	Array	open Items
accountingEntryTaxes[]	Array	Tax registers

Info

amount : Amount of the invoice

accountingEntries/accountingEntryLines/accountingEntryInvoice/openItems

An Open Item is a financial transaction that allows you to know if it has been fully settled or paid.
Each open item includes detailed information such as the total amount, accumulated amount paid, and the payment due date.

For a single invoice, there can be as many open items as there are different payment installments, which is why openItems is structured as an array to accommodate multiple entries per invoice.

The payment status provides insight into the progress of settling each item.
Additionally, the identifier of the payment method used is provided to track the settlement method.

Fields	Type	Description
idSSystem field that cannot be assigned	UUID	Id
creationDate SSystem field that cannot be assigned	DateTime	Creation Date
modificationDate SSystem field that cannot be assigned	DateTime	Modification Date

amount	Decimal	Total amount of the item See InfoAdditional information is available in the Info block below
paidAmountAccumulated	Decimal	Accumulated amount that has been paid See InfoAdditional information is available in the Info block below
dueDate	DateTime	Due date for the payment See InfoAdditional information is available in the Info block below
status	NOT_SPECIFIED COLLECTED PAID PARTIAL	Status of the payment See InfoAdditional information is available in the Info block below
paymentMean DATALOADERUtilize the DATALOADER feature to enrich your query by adding additional resource fields directly in the query.	PaymentMean	Fields of PaymentMean
paymentMeanId	UUID	Identifier of the payment method used

Info

amount : Total amount due for the open item.
creationDate : Indicates when the item was initially created.
modificationDate : Timestamp of the last update to the item, null if no updates have been made.
paidAmountAccumulated : Total amount that has been paid towards the item up to the current date.
dueDate : Date by which the payment for the item is due.
status: Represents the current status of the payment, indicating the extent to which the item has been settled. The possible values are:
- NOT_SPECIFIED: No specific payment status has been detailed.
- COLLECTED: Payment has been fully collected from customers.
- PAID: Payment has been fully made to suppliers.
- PARTIAL: Payment for the item has been made partially.

accountingEntries/accountingEntryLines/accountingEntryInvoice/accountingEntryTaxes

Fields	Type	Description
idSSystem field that cannot be assigned	UUID	Id
creationDateSSystem field that cannot be assigned	DateTime	Creation Date
modificationDateSSystem field that cannot be assigned	DateTime	Modification Date

taxTreatmentId	UUID	Id of the tax Treatment See InfoAdditional information is available in the Info block below
taxGroupId	UUID	Id of the Taxe Group of tax treatment See InfoAdditional information is available in the Info block below
taxType	NOT_SPECIFIED IVA IGIC IPSI FOREIGN TVA DOM UST IRPF	Tax Type of the tax treatment See InfoAdditional information is available in the Info block below
taxId	UUID	Id Tax found by groupId=taxGroupId See InfoAdditional information is available in the Info block below
taxPercentage	Decimal	Percentage of the tax found by groupId=taxGroupId See InfoAdditional information is available in the Info block below
taxBase	Decimal	Base of tax calculation
taxAmount	Decimal	Tax amount
deductible	Boolean	true for a deductible tax, false for a collected tax
regimeType	GENERAL	Always fill in GENERAL

Info

taxTreatmentId : A tax Treatment is associated to each line of acounting Entry taxes. see Taxes Treatments
taxGroupId : found in Taxes Treatments
taxType : found in Taxes Treatments
taxId : Id of the taxe found by groupId of tax = taxGroupId of Tax Treatment
taxPourcentage : Pourcentage of the taxe found in tax

Note

Description

Header

Quick Tips

accountingEntries

Info

accountingEntries/accountingEntryLines or accountingEntryLines

Info

accountingEntries/accountingEntryLines/accountingEntryThirdParty

Info

accountingEntries/accountingEntryLines/accountingEntryPayment

Info

accountingEntries/accountingEntryLines/accountingEntryInvoice

Info

accountingEntries/accountingEntryLines/accountingEntryInvoice/openItems

Info

accountingEntries/accountingEntryLines/accountingEntryInvoice/accountingEntryTaxes

Info