DocumentationAPI GuideChangelogStatusAccounting APIConsent API
v1
OAS 3.0.4

Accounting API

Server: https://apione.zwapgrid.com/accounting
Client Libraries

Trial Balances

​

Trial Balances

Trial Balances Operations

Get trial balances (V2)

​
Path Parameters
  • consentId
    Type:string Format: uuid
    required

    The consent for which you wish to get trial balances.

Query Parameters
  • StartDate
    Type:string Format: date
    required

    The start date that you wish to return trial balances for, in the following format: "YYYY-MM-DD"

  • EndDate
    Type:string Format: date
    required

    The end date that you wish to return trial balances for, in the following format: "YYYY-MM-DD"

  • Level
    Type:integer Format: int32
    min: 
    1
    max: 
    3

    The level of detail you wish to return trial balances for. Possible values are: 1, 2, 3

    • Headers
    • x-correlation-id
      Type:string Format: uuid
      required

      A unique GUID that can be used to track this request

    Responses
    • 501

      Not Implemented

    Request Example forGET/api/v2/consents/{consentId}/trialbalances
    curl 'https://apione.zwapgrid.com/accounting/api/v2/consents/{consentId}/trialbalances?StartDate=&EndDate=' \
  --header 'X-Correlation-Id: ' \
  --header 'X-Api-Key: YOUR_SECRET_TOKEN'

    {
  "trialBalancePeriod": {
    "startDate": null,
    "endDate": null
  },
  "financialReport": {
    "accounts": [
      {
        "accountingAccount": {
          "id": null,
          "accountingAccountId": null,
          "name": null,
          "standardAccountingAccountId": null,
          "descriptions": [
            {
              "text": null,
              "languageId": null
            }
          ],
          "accountingAccountTypeCode": {
            "code": null,
            "listId": null
          }
        },
        "endingBalance": {
          "baseCurrencies": [
            {
              "currencyId": null,
              "baseAmount": 1
            }
          ]
        },
        "accountMovement": {
          "baseCurrencies": [
            {
              "currencyId": null,
              "baseAmount": 1
            }
          ]
        }
      }
    ],
    "categories": [
      {
        "descriptions": [
          {
            "text": null,
            "languageId": null
          }
        ],
        "endingBalance": {
          "baseCurrencies": [
            {
              "currencyId": null,
              "baseAmount": 1
            }
          ]
        },
        "accountMovement": {
          "baseCurrencies": [
            {
              "currencyId": null,
              "baseAmount": 1
            }
          ]
        },
        "subCategories": [
          {
            "descriptions": [
              {
                "text": null,
                "languageId": null
              }
            ],
            "endingBalance": {
              "baseCurrencies": [
                {
                  "currencyId": null,
                  "baseAmount": 1
                }
              ]
            },
            "accountMovement": {
              "baseCurrencies": [
                {
                  "currencyId": null,
                  "baseAmount": 1
                }
              ]
            },
            "subCategories": "[Circular Reference]",
            "accounts": [
              {
                "accountingAccount": {
                  "id": null,
                  "accountingAccountId": null,
                  "name": null,
                  "standardAccountingAccountId": null,
                  "descriptions": [
                    {
                      "text": null,
                      "languageId": null
                    }
                  ],
                  "accountingAccountTypeCode": {
                    "code": null,
                    "listId": null
                  }
                },
                "endingBalance": {
                  "baseCurrencies": [
                    {
                      "currencyId": null,
                      "baseAmount": 1
                    }
                  ]
                },
                "accountMovement": {
                  "baseCurrencies": [
                    {
                      "currencyId": null,
                      "baseAmount": 1
                    }
                  ]
                }
              }
            ]
          }
        ],
        "accounts": [
          {
            "accountingAccount": {
              "id": null,
              "accountingAccountId": null,
              "name": null,
              "standardAccountingAccountId": null,
              "descriptions": [
                {
                  "text": null,
                  "languageId": null
                }
              ],
              "accountingAccountTypeCode": {
                "code": null,
                "listId": null
              }
            },
            "endingBalance": {
              "baseCurrencies": [
                {
                  "currencyId": null,
                  "baseAmount": 1
                }
              ]
            },
            "accountMovement": {
              "baseCurrencies": [
                {
                  "currencyId": null,
                  "baseAmount": 1
                }
              ]
            }
          }
        ]
      }
    ]
  }
}

    OK

    Account Balances (Collapsed)

    ​

    Account Balances

    Account Balances Operations

    Accounting Periods (Collapsed)

    ​

    Accounting Periods

    Accounting Periods Operations

    Models