This service compiles detailed transaction records across all accounts associated with third parties, allowing for comprehensive financial tracking over specified periods.
AccountingThirdPartyBalance
Quick Links
Accounts Accounting Entries Products Customers Sales quotes Sales invoices Suppliers Purchase invoicesHTTP | Operation | Type | Object | DTO Why-DTOs? |
---|---|---|---|---|
(Query) | accountingThirdPartyBalance |
AccountingThirdPartyBalanceGLDtoInput |
Description

Functionality
- Balance Generation: Returns a detailed list of third parties with their balances.
- Customizable Date Range: Allows selection of start and end dates for the report.
- Third Party Filter: Optionally filters the report by third party codes.
- Enhanced Options: Offers options to exclude zero balances and compare balances.
Input Parameters
-
Report Range: Optionally, specify the range of third party codes to include in the report between
ThirdPartyCodeFrom
andThirdPartyCodeTo
. -
Third Party Type: Mandatory, define the type of third party for which the report is generated using
ThirdPartyType
(customer, supplier, employee). -
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
andEndDate
. -
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.
Response
The service returns an array of AccountingThirdPartyBalanceOutputGLDto
objects, each representing a third party account with the following fields:
-
Third Party Details:
ThirdPartyDescription
andThirdPartyId
-
Accumulated Amounts: Represent amounts for the entire fiscal exercise, available only if
IsBalanceComparative
is set totrue
.AccumulatedCreditAmount
andAccumulatedDebitAmount
-
Period Amounts: Represent amounts for the specified period.
CreditAmount
andDebitAmount
-
Balances: Represent the debit/credit balances.
AccumulatedBalance
andBalance
-
Signed Values: Correspond to the previous values but return signed values.
AccumulatedCreditBalance
,AccumulatedDebitBalance
,CreditBalance
,DebitBalance
- When
CreditAmount
=1200
thenCreditBalance
=-1200
, - when
DebitAmount
=1500
thenDebitBalance
=1500
- When
Tips and Tricks
Pagination is typically required for queries that return multiple records.
However, for the accountingThirdPartyBalance query, pagination is not necessary because this query returns an array[] that includes all accounts and their totals.
Header
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 Third Party Balance service?
graphQL Query
query($input: AccountingThirdPartyBalanceGLDtoInput!) {
accountingThirdPartyBalance(input: $input) {
thirdPartyDescription
thirdPartyId
accumulatedBalance
accumulatedCreditAmount
accumulatedCreditBalance
accumulatedDebitAmount
accumulatedDebitBalance
balance
creditAmount
creditBalance
debitAmount
debitBalance
}
}
All Available GraphQL Variables
{
"input":{
"thirdPartyCodeFrom": "CARAT",
"thirdPartyCodeTo": "OPALE",
"thirdPartyType": "CUSTOMER",
"exerciseId": "65f3cd39-9fb0-424d-bcaf-3fe2e88c9579",
"startDate": "2024-05-01",
"endDate": "2024-05-31",
"isWithoutZeroBalance": false,
"isBalanceComparative": false,
"showTemporaryCarryForward": false
}
}
Or Minimum Required GraphQL Variables
{
"input" : {
"thirdPartyType": "CUSTOMER",
"exerciseId": "65f3cd39-9fb0-424d-bcaf-3fe2e88c9579",
"startDate": "2024-05-01",
"endDate": "2024-05-31"
}
}
Example Response
{
"data": {
"accountingThirdPartyBalance": [
{
"thirdPartyDescription": "CARAT - Carat S.a.r.l",
"thirdPartyId": "65f3cd39-a1f0-424d-bcaf-3fe2e88c9579",
"accumulatedBalance": 0,
"accumulatedCreditAmount": 0,
"accumulatedCreditBalance": 0,
"accumulatedDebitAmount": 0,
"accumulatedDebitBalance": 0,
"balance": 51080.39,
"creditAmount": 19000,
"creditBalance": -19000,
"debitAmount": 70080.39,
"debitBalance": 70080.39
},
{
"thirdPartyDescription": "COMPTOIR - Client divers",
"thirdPartyId": "65f3cd39-a1a5-424d-bcaf-3fe2e88c9579",
"accumulatedBalance": 0,
"accumulatedCreditAmount": 0,
"accumulatedCreditBalance": 0,
"accumulatedDebitAmount": 0,
"accumulatedDebitBalance": 0,
"balance": -7023.43,
"creditAmount": 115157.3,
"creditBalance": -115157.3,
"debitAmount": 108133.87,
"debitBalance": 108133.87
}
]
}
}
accountingThirdPartyBalance Input parameters
Fields | Type | Description | Length |
---|---|---|---|
thirdPartyCodeFrom | String | Starting third party code in the report range | 20 |
thirdPartyCodeTo | String | Ending third party code in the report range | 20 |
thirdPartyType |
|
Type of third party | |
exerciseId |
UUID | Unique identifier of the fiscal exercise | |
startDate |
Datetime |
Start date of the report | |
endDate |
Datetime |
End date of the report | |
isWithoutZeroBalance | Boolean | Exclude third parties with zero balance | |
isBalanceComparative | Boolean | Compare with previous balances | |
showTemporaryCarryForward | Boolean | Include temporary carryforwards |
accountingThirdPartyBalance Response
Fields | Type | Description | Length |
---|---|---|---|
thirdPartyId | UUID | Unique identifier of the third party | |
thirdPartyDescription | String | Description of the third party | 100 |
accumulatedBalance | Decimal | Accumulated balance of the third party account |
|
accumulatedCreditAmount | Decimal | Credit amount for the entire fiscal exercise |
|
accumulatedCreditBalance | Decimal | Signed Credit amount for the entire fiscal exercise |
|
accumulatedDebitAmount | Decimal | Accumulated debit amount for the entire fiscal exercise |
|
accumulatedDebitBalance | Decimal | Signed accumulated debit balance for the entire fiscal exercise |
|
balance | Decimal | Net balance of the third party account | |
creditAmount | Decimal | Total credit amount within the specified period | |
creditBalance | Decimal | Signed credit balance within the specified period | |
debitAmount | Decimal | Total debit amount within the specified period | |
debitBalance | Decimal | Signed debit balance within the specified period |
Info
- accumulatedBalance and other accumulated values: only available if
isBalanceComparative
is set totrue