Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB
GL Accounts

Create account

Create a new general ledger account.

post/accounting/v2beta/gl-accounts

Request body

externalIdstring required

External ID is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique across all resources. It is possible to retrieve a resource using the external ID using the prefix external:.

thirdPartyIdstring

ID of the associated third-party, e.g. the ERP in which the account is held.

namestring required

The name of the general ledger account.

numberstring

The number of the general ledger account.

glEntityIdsstring[] required

The Atlar general ledger entity ids that this general ledger account is associated with. May be empty for BANK accounts that have not been linked to a GL entity yet (e.g. unlinked Rillet CoA entries). Non-BANK accounts must have at least one entry.

currencystring

Three-letter ISO 4217 currency code.

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.

displayTypestring required

The general ledger account types are not uniform across other third-party systems. So instead, we accept the raw type from the third-party system that we can display to the user.

Example request

{
  "externalId": "walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl",
  "thirdPartyId": "9a8b1372-5c80-44a5-81a9-553a34041eb7",
  "name": "Cheque Account",
  "number": "2400",
  "currency": "EUR",
  "type": "BANK",
  "displayType": "Cheque Account"
}

Response

The created general ledger account.

idstring required

Unique resource identifier.

externalIdstring required

External ID is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique across all resources. It is possible to retrieve a resource using the external ID using the prefix external:.

organizationIdstring required

Unique resource identifier for an Organization.

thirdPartyIdstring

ID of the associated third-party, e.g. the ERP in which the account is held.

accountIdstring

Unique resource identifier.

glEntityIdsstring[] required

The Atlar general ledger entity ids that this general ledger account is associated with.

namestring required

The name of the general ledger account.

numberstring

The number of the general ledger account.

currencystring

Three-letter ISO 4217 currency code.

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.

displayTypestring required

The general ledger account types are not uniform across other third-party systems. So instead, we accept the raw type from the third-party system that we can display to the user.

ignoredboolean required

Whether the account is ignored in the accounting system.

versioninteger required

Resource version. Starts at value 1 when the resource is created and increases by one for each successive update.

etagstring required

ETag based on the resource version. This can be passed along in If-Match HTTP header when updating a resource to perform a conditional update.

createdstring date-time required

Time at which the resource was created.

updatedstring date-time required

Time at which the resource was last updated.

Example response

{
  "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"
}