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?
Mutation How to create?  
Mutation deleteAccountingEntry AccountingEntryDeleteGLDtoInput
Query accountingEntries filtered by id Why?  
Query accountingEntries  
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

img

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?

accountingEntries

Fields Type Description Length
id UUID Id  
       
date Datetime Date  
journalType JournalType Fields of JournalType  
journalTypeId UUID JournalType Id  
session Session Fields of Session (id, name, stamp,deactivated)  
sessionId UUID Session id  
number Decimal Number  
description String Description 200
closeDate Datetime closing date of entry  
isClosed Boolean True if closed  
accountingEntryLines[] Array List of all lines of entry  
       
salesInvoice salesInvoice Sales Invoice Header Fields  
sourceEntityId UUID If provided, see sourceType to identify the entity  
sourceType
  • NOT_SPECIFIED
  • SALES
  • ACCOUNTING
  • IMPORT_FILES
  • YEAR_END_PROCESS
  • AP_AUTOMATION
  • PUBLIC_API
indicates the origin of the accounting entry  
Info
  • number : operational Number Counter Id
  • 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.

    img


accountingEntries/accountingEntryLines

Fields Type Description Length
id UUID Id  
       
subAccount AccountingAccount Fields of AccountingAccount  
subAccountId UUID Id of accountingAccount  
contraAccount String Contra Account 113
description String Description 200
debitAmount Decimal Amount debit  
creditAmount Decimal Amount credit  
accountingEntryThirdParty ObjectType ThirdParty  
accountingEntryPayment ObjectType Matching  
accountingEntryInvoice ObjectType Invoice  
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
id UUID Id  
       
thirdPartyId UUID Third Id  
socialName String Third Name 70
code String Code 17
origin
  • UNDEFINED
  • CUSTOMER
  • SUPPLIER
  • EMPLOYEE
 Type of third  
identificationTypeId UUID DocumentType Id  
documentId String Document Id 25
vatNumber String vat Number 25
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 UUID Id  
       
matching
  • FULL_MATCH
  • PARTIAL_MATCH
 Status matching  
matchingLetter String Letter matching 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
id UUID Id  
       
documentDate Datetime Document date  
externalInvoiceNumber String Invoice number 50
amount Decimal Amount  
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.

img

Fields Type Description
id UUID Unique identifier of the item
     
amount Decimal Total amount of the item
creationDate DateTime Creation date of the item
modificationDate DateTime Last modification date of the item, null if not modified
paidAmountAccumulated Decimal Accumulated amount that has been paid
dueDate DateTime Due date for the payment
status
  • NOT_SPECIFIED
  • COLLECTED
  • PAID
  • PARTIAL
 Status of the payment
paymentMean 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
id UUID Id
     
taxTreatmentId UUID Id of the tax Treatment
taxGroupId UUID Id of the Taxe Group of tax treatment
taxType
  • NOT_SPECIFIED
  • IVA
  • IGIC
  • IPSI
  • FOREIGN
  • TVA
  • DOM
 Tax Type of the tax treatment
taxId UUID Id Tax found by groupId=taxGroupId
taxPercentage Decimal Percentage of the tax found by groupId=taxGroupId
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