AccountingTrialBalance

HTTP	Operation	Type	Object	DTO Why-DTOs?
POST	Read	⚙️ ActionThe action resource represents a type of object that differs from standard queries or mutations. For a query, it returns a result already prepared by Sage Active, with no possibility to add filters, sorts, or explore the data further, or it executes an action (e.g., sending an email). For a mutation, it executes a specific business action, also carried out by Sage Active, which will impact the data (e.g., generating a credit note from an invoice). (Query)	`accountingTrialBalance`	`AccountingTrialBalanceGLDtoInput`

Description

The AccountingTrialBalance service provides a trial balance report for accounting.

This service generates a summary of all debits and credits, providing a clear view of the financial balance over a specified period.

Functionality

Balance Generation: Returns a detailed list of accounts with their balances.
Customizable Date Range: Allows selection of start and end dates for the report.
Account Filter: Optionally filters the report by account codes.
Enhanced Options: Offers options to exclude zero balances, compare trial balances, show temporary carryforwards, and closing entries.

Input Parameters

Report Range: Optionally, specify the range of account codes to include in the report between StartAccountCode and EndAccountCode.
Fiscal Exercise: Mandatory, identify the fiscal exercise for the report using ExerciseId the unique identifier of the fiscal exercise.
Report Dates: Mandatory, set the date range for the report using StartDate and EndDate.
Balance Filters: Optionally, default value to false, configure additional options for balance inclusion using the following parameters:
- IsWithoutZeroBalance: Whether to exclude third parties with zero balance.
- IsBalanceComparative: Whether to include comparative balance data.
- ShowTemporaryCarryForward: Whether to include temporary carryforwards.
- ShowClosingEntries: Whether to include closing entries (Spain legislation only).

Response

The service returns an array of AccountingTrialBalanceOutputGLDto objects, each representing an account with the following fields:

Account Details:
AccountDescription and AccountCode
Accumulated Amounts: Represent amounts for the entire fiscal exercise, available only if IsBalanceComparative is set to true. AccumulatedCreditAmount and AccumulatedDebitAmount
Period Amounts: Represent amounts for the specified period.
CreditAmount and DebitAmount
Balances: Represent the debit/credit balances.
AccumulatedBalance and Balance
Signed Values: Correspond to the previous values but return signed values.
AccumulatedCreditBalance, AccumulatedDebitBalance, CreditBalance, DebitBalance
- When CreditAmount = 1200 then CreditBalance = -1200,
- when DebitAmount = 1500 then DebitBalance= 1500

Tips and Tricks

Pagination is typically required for queries that return multiple records.
However, for the accountingTrialBalance query, pagination is not necessary because this query returns an array[] that includes all accounts and their totals.

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?

How to use the Accounting Trial Balance service?

graphQL Query

query($input: AccountingTrialBalanceGLDtoInput!) {
  accountingTrialBalance(input: $input) {
    accountCode
    accountDescription
    accountType
    accumulatedBalance
    accumulatedCreditAmount
    accumulatedCreditBalance
    accumulatedDebitAmount
    accumulatedDebitBalance
    balance
    creditAmount
    creditBalance
    debitAmount
    debitBalance
  }
}

All Available GraphQL Variables

{
  "input": {
    "startAccountCode": "1000000",
    "endAccountCode": "3999999",
    "exerciseId": "458e1d68-faff-4e02-8ae0-4843d05e00da",
    "startDate": "2022-12-01",
    "endDate": "2022-12-31",
    "isWithoutZeroBalance": false,
    "isTrialBalanceComparative": false,
    "showTemporaryCarryForward": false,
    "showClosingEntries": false
}
}

Or Minimum Required GraphQL Variables

{
  "input" : {
    "exerciseId" : "74396520-b798-4a75-b098-a55427d62b5a",
    "startDate" : "2024-05-01",
    "endDate" : "2024-05-31"
}
}

Example Response

{
    "data": {
        "accountingTrialBalance": [
              {
                  "accountCode": "311000000",
                  "accountDescription": "311000000 - Stock de matières 1ères",
                  "accountType": "BALANCE_SHEET",
                  "accumulatedBalance": 0,
                  "accumulatedCreditAmount": 0,
                  "accumulatedCreditBalance": 0,
                  "accumulatedDebitAmount": 0,
                  "accumulatedDebitBalance": 0,
                  "balance": -1275852.54,
                  "creditAmount": 1777965.18,
                  "creditBalance": -1777965.18,
                  "debitAmount": 502112.64,
                  "debitBalance": 502112.64
              },
              {
                  "accountCode": "355000000",
                  "accountDescription": "355000000 - Stock de produits finis",
                  "accountType": "BALANCE_SHEET",
                  "accumulatedBalance": 0,
                  "accumulatedCreditAmount": 0,
                  "accumulatedCreditBalance": 0,
                  "accumulatedDebitAmount": 0,
                  "accumulatedDebitBalance": 0,
                  "balance": -59480.00,
                  "creditAmount": 255080.00,
                  "creditBalance": -255080.00,
                  "debitAmount": 195600.00,
                  "debitBalance": 195600.00
              }
        ]
    }
}