AccountingEntry

BETA

Note:
There exists a highly simplified method for adding accounting entries, createSimplifiedAccountingEntry, which handles the majority of use cases for adding such entries.
It is recommended to explore the capabilities of createSimplifiedAccountingEntry before attempting to add entries with createAccountingEntry.
The utilization of createAccountingEntry for adding entries may be unnecessary given the effectiveness of the simplified method.

Operation	Type	Object	Dto
Create	Mutation	`createAccountingEntry`	`AccountingEntryCreateGLDtoInput`
Delete	Mutation	`deleteAccountingEntry`	`AccountingEntryDeleteGLDtoInput`
Read	Query	`accountingEntryById`	`AccountingEntryGLDto`
List	Query	`accountingEntries`	`AccountingEntryGLDto`

Description

Accounting entries management

Given the model of the accounting entries and the mandatory object types in the context of purchase or sale journal entries, we absolutely recommend that you start with an example from the postman collection and adapt it rather than starting from scratch.
To see examples of mutations that include the adding of accounting entries :
download the Postman collection: Quick start / 5. Test your first query in Postman

Would you like to see an example of how to add an entry?

This example concerns a sales invoice, to transform it into a purchase invoice, just :

replace origin CUSTOMER by SUPPLIER
replace registerType ISSUED by RECEIVED
Assign a third party Supplier instead of a Customer

{
    "values":{
      "description": "Facture FA0022",
      "date": "2023-03-01",
      "entryType": "GENERAL",
      "journalTypeId": "{journalId}",
      "accountingEntryLines": [
        {
          "description": "Facture FA0022",
          "creditAmount": 0,
          "debitAmount": 1824.67,
          "subAccountId": "{customerAccountId}",
          "accountingEntryThirdParty": {
            "socialName":"{customerSocialName}",
            "origin":"CUSTOMER",
            "thirdPartyId":"{customerId}",
            "identificationTypeId":"{documentTypeId}",
            "documentId":"{customerDocumentId}"
          },
          "registerType":"ISSUED",
          "accountingEntryInvoice":{
              "amount":1824.67,
              "documentDate":"2023-03-01",
              "expeditionDate":"2023-03-01",
              "operationDate":"2023-03-01",
              "settlementDate":"2023-03-01",
              "externalInvoiceNumber":"FA0022",
              "registerType":"ISSUED"
          }
        },
        {
          "description": "Facture FA0022",
          "creditAmount": 1520.56,
          "debitAmount": 0,
          "subAccountId": "{AccountId}",
          "registerType":"UNDEFINED"
        },
        {
          "description": "Facture FA0022",
          "creditAmount": 304.11,
          "debitAmount": 0,
          "subAccountId": "{taxAccountId}",
          "registerType":"UNDEFINED"
        }
      ]
    }
}

Key	Value
`Authorization`	Bearer Current access Token
`X-TenantId`	Current tenant id obtained from userProfile
`X-OrganizationId`	Current organization Id
`x-api-key`	Primary or secondary subscription key of your app

accountingEntries

Fields	Type	Description	Length
idSSystem field that cannot be assigned	UUID	Id
date *The value of the field or object is mandatory	datetime	Date
journalTypeId *The value of the field or object is mandatory NThe value of this field cannot be modified after the record is created	UUID	Journal Id
number RThis field is read-only, its value cannot be assigned	decimal	Number See InfoAdditional information is available in the Info block below
entryType *The value of the field or object is mandatory	GENERAL	Always fill in GENERAL
description	string	Description See InfoAdditional information is available in the Info block below	200
closeDate InvThis field is not visible in the product interface RThis field is read-only, its value cannot be assigned	datetime	closing date of entry
isClosed RThis field is read-only, its value cannot be assigned	boolean	True if closed
accountingEntryLines[]	Array	List of all lines of entry See InfoAdditional information is available in the Info block below

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.

accountingEntries/accountingEntryLines

Fields	Type	Description	Length
idSSystem field that cannot be assigned	UUID	Id
subAccountId *The value of the field or object is mandatory	UUID	Id of accountingAccount
description	string	Description	200
debitAmount *The value of the field or object is mandatory	decimal	Amount debit See InfoAdditional information is available in the Info block below
creditAmount *The value of the field or object is mandatory	decimal	Amount credit See InfoAdditional information is available in the Info block below
registerType *The value of the field or object is mandatory	UNDEFINED ISSUED RECEIVED BOTH	Type of tax register See InfoAdditional information is available in the Info block below	6
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

creditAmount, debitAmount : 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.
registerType : used for tax registers, mandatory value.
- For journal types equal to GENERAL or FINANCIAL or CARRY_FORWARD, always assign UNDEFINED for each line.
- For journals types equal to PURCHASE_INVOICE or SALES_INVOICE :
  - For lines without a third party CUSTOMER or SUPPLIER, always assign UNDEFINED
  - For lines with a third party CUSTOMER, assign ISSUED
  - For lines with a third party SUPPLIER, assign RECEIVED
accountingEntryThirdParty : mandatory for lines with a third party CUSTOMER, SUPPLIER, EMPLOYEE.
accountingEntryInvoice : mandatory for lines with a third party CUSTOMER, SUPPLIER for journal types PURCHASE_INVOICE or SALES_INVOICE. Must not be defined for other journals.

It is not possible to group several invoices in one accounting entry for the journals PURCHASE_INVOICE or SALES_INVOICE.
So only one accountingEntryThirdParty and one accountingEntryInvoice per accountingEntry for these journals.

accountingEntries/accountingEntryLines/accountingEntryThirdParty

Fields	Type	Description	Length
idSSystem field that cannot be assigned	UUID	Id
thirdPartyId *The value of the field or object is mandatory	UUID	Third Id See InfoAdditional information is available in the Info block below
socialName *The value of the field or object is mandatory	string	Third Name See InfoAdditional information is available in the Info block below	70
code RThis field is read-only, its value cannot be assigned	string	Code See InfoAdditional information is available in the Info block below	17
origin *The value of the field or object is mandatory	UNDEFINED CUSTOMER SUPPLIER EMPLOYEE	Type of third
identificationTypeId *The value of the field or object is mandatory	UUID	DocumentType Id See InfoAdditional information is available in the Info block below
documentId *The value of the field or object is mandatory	string	Document Id See InfoAdditional information is available in the Info block below	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, must be filled in.
code : Found in the third party as code, must be filled in.
identificationTypeId : Found in the third party as documentTypeId, must be filled in.
documentId : Found in the third party as documentId, must be filled in.

accountingEntries/accountingEntryLines/accountingEntryPayment

Fields	Type	Description	Length
id RThis field is read-only, its value cannot be assigned	UUID	Id
matching RThis field is read-only, its value cannot be assigned	MATCHING UN_MATCHING	Status matching See InfoAdditional information is available in the Info block below
matchingLetter RThis field is read-only, its value cannot be assigned	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 whether the line is lettered
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
documentDate *The value of the field or object is mandatory	datetime	Document date
expeditionDate *The value of the field or object is mandatory InvThis field is not visible in the product interface	datetime	Expedition date See InfoAdditional information is available in the Info block below
operationDate *The value of the field or object is mandatory InvThis field is not visible in the product interface	datetime	Operation date See InfoAdditional information is available in the Info block below
settlementDate *The value of the field or object is mandatory InvThis field is not visible in the product interface	datetime	Settlement date See InfoAdditional information is available in the Info block below
externalInvoiceNumber *The value of the field or object is mandatory	string	Invoice number	50
amount *The value of the field or object is mandatory	decimal	Amount
registerType *The value of the field or object is mandatory	UNDEFINED ISSUED RECEIVED BOTH	Type of tax register See InfoAdditional information is available in the Info block below	6
accountingEntryTaxes[]	Array	Tax registers

Info

expeditionDate : mandatory, assign it by default with documentDate.
operationDate : mandatory, assign it by default with documentDate.
settlementDate : mandatory, assign it by default with documentDate.
amount : Amount of the invoice, must be equal to the amount of the entry line where the third party is present (accountingEntryThirdParty)
registerType : used for tax registers, mandatory value.
- For customer invoice, assign ISSUED
- For supplier invoice, assign RECEIVED

accountingEntries/accountingEntryLines/accountingEntryInvoice/accountingEntryTaxes

Fields	Type	Description
idSSystem field that cannot be assigned	UUID	Id
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	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 must be 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

Description

Would you like to see an example of how to add an entry?

Header

accountingEntries

Info

accountingEntries/accountingEntryLines

Info

accountingEntries/accountingEntryLines/accountingEntryThirdParty

Info

accountingEntries/accountingEntryLines/accountingEntryPayment

Info

accountingEntries/accountingEntryLines/accountingEntryInvoice

Info

accountingEntries/accountingEntryLines/accountingEntryInvoice/accountingEntryTaxes

Info