createAccountingEntryUsingIds

Note

Creation of Accounting Entries using the same logic as createAccountingEntryUsingCode but utilizing internal Sage Active IDs instead of business codes.

Note that to ensure business rule consistency, when the API receives a createAccountingEntryUsingIds mutation, it internally ends up calling createAccountingEntry.

HTTP	Operation	Type	Object	DTO Why-DTOs?
POST	Create	Mutation	`createAccountingEntryUsingIds`	`AccountingEntryCreateUsingIdsGLDtoInput`

Description

This mutation is based on the same logic as createAccountingEntryUsingCode, but here the business codes of journals, parties, and general accounts are replaced with their internal Sage Active Ids.

Depending on your application’s structure, it may be simpler to directly use the business values, or conversely, as demonstrated here, the internal IDs.

Using IDs provides more flexibility and accuracy in complex scenarios where unique identification is crucial, even if it requires additional steps to fetch the IDs beforehand.
The choice between using business codes and IDs depends on your specific needs and the complexity of the accounting entry being created.

Advantages

Simplified model definition with streamlined lines that eliminate the need to manage accountingEntryThirdParty and accountingEntryInvoice sub-resources.
Automatic assignment of the description and document number from the header to the lines if not defined in the line.
NEWNew Feature Recently Added Automatic creation of tax registers if the consistency of the transaction amounts allows it.
Automatic summation of debit or credit from multiple lines of the same third party in the entry, merging them into a single entry line.
Preservation of all business controls managed by Sage Active to ensure the integrity of the added entries.

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 pertains to a sales invoice.
To convert it into a purchase invoice, simply use a purchase journal and a supplier code.

graphQL Mutation

mutation ($values:AccountingEntryCreateUsingIdsGLDtoInput!) {    
  createAccountingEntryUsingIds (input: $values) {
    id
  }
}

graphQL Variables

{
  "values": {
    "description": "Facture FA0022",
    "date": "2023-01-01",
    "documentDate": "2022-12-16",
    "documentNumber": "FA0022",
    "journalTypeId": "4edc3c3f-6e0e-4e96-a949-63e955606aac",
    "accountingEntryLines": [
      {
        "thirdId": "901d2323-67ee-4426-aac6-e3745b8e6fd9",
        "description": "Facture FA0022 régularisation",
        "creditAmount": 0,
        "debitAmount": 158.25
        "subAccountId": "6e3533f3-621b-4c0b-bd71-435ec982c85b"
      },
      {
        "creditAmount": 150,
        "debitAmount": 0,
        "subAccountId": "6e3533f3-6221-4c0b-bd71-435ec982c85b"
      },
      {
        "creditAmount": 8.25,
        "debitAmount": 0,
        "subAccountId": "6e3533f3-621e-4c0b-bd71-435ec982c85b""
      }
    ]
  }
}

Tax registers

NEWNew Feature Recently Added Automatic creation of tax registers

The creation of tax registers for purchase and sales invoices is now automatic.
Registers are created if the prerequisites are met; otherwise, priority is given to the creation of the accounting entry without creating the registers, rather than allowing the Sage Active business controller to reject the entry for non-compliance with the registers.

The conditions are:

Tax codes for revenue or expense accounts must be defined.
The VAT accounts defined in the tax codes of these accounts must be those present in the entry.
The VAT amount and the associated taxable base for the VAT account and the expense or revenue account must be consistent with the VAT rate of the tax code.
Other management rules not respected or not yet accounted for by Sage Active.

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?

Fields	Type	Description
date *The value of the field or object is mandatory	Datetime DateThe GraphQL field type is DateTime, but only the date value is considered, the time value is ignored if provided.	Date of the accounting entry
journalTypeId *The value of the field or object is mandatory	String	Id of an existing journal
documentDate	Datetime DateThe GraphQL field type is DateTime, but only the date value is considered, the time value is ignored if provided.	Date of the accounting document See InfoAdditional information is available in the Info block below
documentNumber	String	Document number or reference of the entry See InfoAdditional information is available in the Info block below
description	String	Description See InfoAdditional information is available in the Info block below
accountingEntryLines[] *The value of the field or object is mandatory	Array	List of all entry lines See InfoAdditional information is available in the Info block below

Info

documentDate: An optional date field indicating the date of the document associated with the accounting entry.
If not provided, the document date will be automatically set to match the accounting entry date.
documentNumber: The reference number of the document.
For purchases or sales, it can be filled with the invoice number.
description: A value used as a template for lines from the interface, which assigns a default value to the lines.

This value is optional

This value is optional

This value is mandatory even if descriptions are given for each line.
accountingEntryLines: A list of lines in the accounting entry.
The accounting entry must be balanced, meaning the total of the lines with a debit must be equal to the total of the lines with a credit.
Attempting to add an unbalanced entry will result in an error.

createAccountingEntryUsingIds/accountingEntryLines

Fields	Type	Description
subAccountId *The value of the field or object is mandatory	String	Id of a general account See InfoAdditional information is available in the Info block below
thirdId	String	Id of a third (customer,supplier or employee) See InfoAdditional information is available in the Info block below
description	String	Description
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