Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB
GL Accounts

List accounts

Returns a list of general ledger accounts. Sort order is always ascending on account number.

get/accounting/v2beta/gl-accounts

Query parameters

type'UNSPECIFIED' | 'BANK' | 'ACCOUNTS_PAYABLE' | 'ACCOUNTS_RECEIVABLE'

The general ledger account types are not uniform across other third-party systems. However, it is useful to have a consistent type for the general ledger account. For example, to suggest accounts one can match with a bank account.

Example:BANK

Only include accounts that are associated with the specified type

excludeIgnoredboolean

Exclude ignored accounts from the response

connectionIdstring

Unique resource identifier.

Example:2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8

Only include accounts that are associated with the specified connection.

accountIdstring

Unique resource identifier.

Example:2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8

Filter by financial data account ID.

limitinteger

Limit the number of items in resulting query response.

tokenstring

If a query response contains a non-empty nextToken, use that value as token query parameter to continue pagination.

Response

A list of general ledger accounts.

nextTokenstring required

Pagination token for next page. The value will be a non-empty string if there are more resources to be fetched. The value will be an empty string if there are no more resources to be fetched.

tokenstring required

The pagination token that was used for this request. The value will be an empty string if no token query parameter was provided with the request.

limitinteger required

The page limit that was used for this request.

Example response

{
  "items": [
    {
      "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "externalId": "walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl",
      "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
      "thirdPartyId": "9a8b1372-5c80-44a5-81a9-553a34041eb7",
      "accountId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "name": "Cheque Account",
      "number": "2400",
      "currency": "EUR",
      "type": "BANK",
      "displayType": "Cheque Account",
      "version": 1,
      "etag": "version:3",
      "created": "2022-05-04T18:31:12.889104898Z",
      "updated": "2022-05-04T18:47:32.213842599Z"
    }
  ],
  "nextToken": "eyIxIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "token": "eyIwIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "limit": 100
}