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?

Info

• sourceType : Indicates the origin of the accounting entry, detailing how it was generated.
  Each source type corresponds to a specific method or area within the business operations that has contributed to the accounting record.
• 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
• salesInvoice: Only invoice header fields are available. To obtain other information (such as lines, addresses, etc.), use the salesInvoice operation directly.

  This dataloader salesInvoice is only relevant when the accounting entry was generated from a posted invoice created in the Sales module.
  If the accounting entry was recorded directly in Accounting, this dataloader will not contain any information.

• 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.

  

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.

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.

Info

• matching: Indicates how the entry line has been matched.
  PARTIAL_MATCH means the entry is partially reconciled, while FULL_MATCH indicates a complete reconciliation.
• matchingLetter: Used to group matched entries under a common letter.
  Lowercase letters are used for partial matches (a, b, c …), uppercase letters for full matches (A, B, C …)
• matchId: Technical grouping key.
  All lines that are matched together share the same matchId, regardless of the matching letter used. This avoids ambiguity when letters are reused.

Info

• dimensionId: Refers to the analytic category (e.g. Warehouse, Department, Project).
• dimensionTagId: Refers to a tag that belongs to the selected dimension.
• amount: Specifies how much of the accounting entry amount is allocated to this tag.

Info

• creditNoteType
  • ByDifferences → “Rectificativa por diferencias”
    • Used when the corrective invoice partially adjusts the original invoice (e.g., correcting price differences or quantity errors).
    • The original invoice remains valid, but its amounts are adjusted.
    • Common cases include VAT miscalculations, incorrect unit prices, or missing line items.
  • Substitutive → “Rectificativa sustitutiva”
    • Used when the original invoice is entirely replaced by the corrective invoice.
    • The original invoice is considered null and void, and the new invoice takes its place.
    • Often used when an invoice was issued incorrectly (e.g., wrong client details, incorrect tax rates, or errors affecting the entire invoice).
  • Undefined → No specific classification; used as a fallback when the corrective invoice type is unknown or not applicable.
• creditNoteReason
  • R1: Return of packaging
    • Used when goods include packaging that is later returned, requiring an invoice adjustment.
  • R2: Bankruptcy proceedings
    • Issued in cases where the debtor enters bankruptcy and VAT correction is needed.
  • R3: Bad debt
    • Used when the original invoice cannot be collected due to non-payment, allowing VAT recovery.
  • R4: Other corrective invoices
    • Covers general corrections not included in other predefined categories.
  • R5: Simplified invoice correction
    • Used when correcting simplified invoices (i.e., receipts instead of full invoices).

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.

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

• taxPercentage : Percentage of the tax found in tax

• Equivalence Surcharge Fields
  Unused (For Spain only).

  These fields relate to the equivalence surcharge (Recargo de Equivalencia), a special VAT regime applicable to specific Spanish retailers.

  • hasEquivalenceSurcharge: Indicates whether the surcharge applies to the invoice.
  • equivalenceSurchargePercentage: The percentage applied when the surcharge is enabled, depending on product type.
  • equivalenceSurchargeQuota: An optional fixed amount used instead of a percentage, in specific tax contexts.

  Unused (For Spain only).