ATatlar
GL Accounts

Update account

Changed on

Update a general ledger account.

patch/accounting/v2beta/gl-accounts/{id}

Request

Path parameters

idstring required

Atlar resource ID.

Headers

If-Matchstring

ETag (version) of resource to be updated.

Request body

Example request

[
  {
    "value": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8"
  }
]

Response

The updated 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. When type is BANK, at most one id (or empty when the bank account is not yet linked). For other types, at least one and at most 100 ids.

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.

inactiveboolean required

Whether the GL account is inactive in the customer's ERP.

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

Changes

  • b49df1e4b3e9Revision changes
    • breaking

      removed from the request property oneOf list

    • info

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

    • info

      added to the request property oneOf list

    • info

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

    • info

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

    • info

      added the required property to the response with the status