ATatlar
GL Accounts

List GL accounts

Changed on

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

get/accounting/v2beta/gl-accounts

Request

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.

glEntityIdstring

Unique resource identifier.

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

Only include accounts that are associated with the specified GL entity.

inactiveboolean

Only include accounts with the given inactive state. Omit to include both.

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
}

Changes

  • b49df1e4b3e9Revision changes
    • info

      the security scope gl_entities:read was added to the endpoint's security scheme basicAuth

    • info

      added the new optional query request parameter glEntityId

    • info

      added the new optional query request parameter inactive

    • info

      added the optional property // to the response with the status

    • info

      added the required property /// to the response with the status