GL Accounts

Manages General Ledger (GL) account entries used when coding accounting data.

Endpoints

GET /api/v1/accounting/gl_accounts
GET /api/v1/accounting/gl_accounts/{id}
POST /api/v1/accounting/gl_accounts/{id}/update
POST /api/v1/accounting/gl_accounts/create

List General Ledger AccountsBeta

GET /api/v1/accounting/gl_accounts

Copy for LLMView as Markdown

Returns GL accounts filtered by the specified query parameters.

Parameters

external_idstring

Filter by external ID.

legal_entity_idstring

Filter by legal entity ID.

pagestring

A bookmark for use in pagination to retrieve the next or previous page of results.

statusstring

Filter by GL account status. Possible values are ACTIVE and ARCHIVED.

ACTIVE

ARCHIVED

Response body - 200 OK

itemsarray

List of GL accounts returned.

items.created_atstring

Time at which the GL account was created, in ISO 8601 format.

items.idstring

Unique identifier of the GL account.

items.statusstring

Accounting resource status. Possible values are ACTIVE and ARCHIVED.

ACTIVE

ARCHIVED

items.updated_atstring

Time at which the GL account was last updated, in ISO 8601 format.

items.valuestring

GL account name.

items.codestring

GL account code.

items.external_idstring

External ID from the accounting system.

items.legal_entity_idsarray

Legal entity IDs to which this GL account applies. Omit this field when it applies to all legal entities.

items.value_labelstring

Airwallex display name for the GL account.

page_afterstring

A pointer to the end of the page list used to retrieve the next page of results.

page_beforestring

A pointer to the start of the page list used to retrieve the previous page of results.

Errors

Error status	Description
400	Invalid request.
500	Internal server error.

GET /api/v1/accounting/gl_accounts

$curl --request GET \
>  --url 'https://api.sandbox.airwallex.com/api/v1/accounting/gl_accounts' \
>  --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \
>  --header 'Content-Type: application/json'

Response (200 OK)

1{
2  "items": [
3    {
4      "id": "985461d5-016f-4e1f-a387-5f1380b42d92",
5      "code": "601022001-2",
6      "value": "Travel Costs-Domestic-Transportation -2",
7      "value_label": "Travel-Domestic-Flight | 601022001",
8      "external_id": "601022001-2",
9      "legal_entity_ids": [
10        "le_U3jlHqQRNHWn2zAKeeT8sg"
11      ],
12      "status": "ACTIVE",
13      "created_at": "2025-01-01T00:00:00Z",
14      "updated_at": "2025-02-02T00:00:00Z"
15    }
16  ],
17  "page_after": "eyJwYWdlIjoiMiJ9"
18}

Was this section helpful?

Get General Ledger AccountBeta

GET /api/v1/accounting/gl_accounts/{id}

Copy for LLMView as Markdown

Retrieves an existing GL account.

Parameters

idrequiredstring

Unique identifier of the GL account.

Response body - 200 OK

codestring

GL account code.

created_atstring

Time at which the GL account was created, in ISO 8601 format.

external_idstring

External ID from the accounting system.

idstring

Unique identifier of the GL account.

legal_entity_idsarray

Legal entity IDs to which this GL account applies. Omit this field when it applies to all legal entities.

statusstring

Accounting resource status. Possible values are ACTIVE and ARCHIVED.

ACTIVE

ARCHIVED

updated_atstring

Time at which the GL account was last updated, in ISO 8601 format.

valuestring

GL account name.

value_labelstring

Airwallex display name for the GL account.

Errors

Error status	Description
400	Invalid request.
404	Not found.
500	Internal server error.

GET /api/v1/accounting/gl_accounts/{id}

$curl --request GET \
>  --url 'https://api.sandbox.airwallex.com/api/v1/accounting/gl_accounts/985461d5-016f-4e1f-a387-5f1380b42d92' \
>  --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \
>  --header 'Content-Type: application/json'

Response (200 OK)

1{
2  "id": "985461d5-016f-4e1f-a387-5f1380b42d92",
3  "code": "601022001-2",
4  "value": "Travel Costs-Domestic-Transportation -2",
5  "value_label": "Travel-Domestic-Flight | 601022001",
6  "external_id": "601022001-2",
7  "legal_entity_ids": [
8    "le_U3jlHqQRNHWn2zAKeeT8sg"
9  ],
10  "status": "ACTIVE",
11  "created_at": "2025-01-01T00:00:00Z",
12  "updated_at": "2025-02-02T00:00:00Z"
13}

Was this section helpful?

Update General Ledger AccountBeta

POST /api/v1/accounting/gl_accounts/{id}/update

Copy for LLMView as Markdown

Updates an existing GL account.

Parameters

idrequiredstring

Unique identifier of the GL account.

Request body

statusrequiredstring

Accounting resource status. Possible values are ACTIVE and ARCHIVED.

ACTIVE

ARCHIVED

valuerequiredstring

GL account name.

codestring

GL account code.

external_idstring

External ID from the accounting system.

legal_entity_idsarray

Legal entity IDs to which this GL account applies. Omit this field when it applies to all legal entities.

value_labelstring

Airwallex display name for the GL account.

Response body - 200 OK

codestring

GL account code.

created_atstring

Time at which the GL account was created, in ISO 8601 format.

external_idstring

External ID from the accounting system.

idstring

Unique identifier of the GL account.

legal_entity_idsarray

Legal entity IDs to which this GL account applies. Omit this field when it applies to all legal entities.

statusstring

Accounting resource status. Possible values are ACTIVE and ARCHIVED.

ACTIVE

ARCHIVED

updated_atstring

Time at which the GL account was last updated, in ISO 8601 format.

valuestring

GL account name.

value_labelstring

Airwallex display name for the GL account.

Errors

Error status	Description
400	Invalid request.
404	Not found.
500	Internal server error.

POST /api/v1/accounting/gl_accounts/{id}/update

$curl --request POST \
>  --url 'https://api.sandbox.airwallex.com/api/v1/accounting/gl_accounts/985461d5-016f-4e1f-a387-5f1380b42d92/update' \
>  --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \
>  --header 'Content-Type: application/json' \
>  --data '{
>  "code": "601022001-2",
>  "value": "Travel Costs-Domestic-Transportation -2",
>  "value_label": "Travel-Domestic-Flight | 601022001",
>  "external_id": "601022001-2",
>  "legal_entity_ids": [
>    "le_U3jlHqQRNHWn2zAKeeT8sg"
>  ],
>  "status": "ACTIVE"
>}'

Response (200 OK)

1{
2  "id": "985461d5-016f-4e1f-a387-5f1380b42d92",
3  "code": "601022001-2",
4  "value": "Travel Costs-Domestic-Transportation -2",
5  "value_label": "Travel-Domestic-Flight | 601022001",
6  "external_id": "601022001-2",
7  "legal_entity_ids": [
8    "le_U3jlHqQRNHWn2zAKeeT8sg"
9  ],
10  "status": "ACTIVE",
11  "created_at": "2025-01-01T00:00:00Z",
12  "updated_at": "2025-02-02T00:00:00Z"
13}

Was this section helpful?

Create General Ledger AccountBeta

POST /api/v1/accounting/gl_accounts/create

Copy for LLMView as Markdown

Creates a new GL account.

Request body

request_idrequiredstring

Unique identifier for this request to ensure idempotency. Generate a random UUID to prevent accidental duplication.

valuerequiredstring

GL account name.

codestring

GL account code.

external_idstring

External ID from the accounting system.

legal_entity_idsarray

Legal entity IDs to which this GL account applies. Omit this field when it applies to all legal entities.

value_labelstring

Airwallex display name for the GL account.

Response body - 201 Created

codestring

GL account code.

created_atstring

Time at which the GL account was created, in ISO 8601 format.

external_idstring

External ID from the accounting system.

idstring

Unique identifier of the GL account.

legal_entity_idsarray

Legal entity IDs to which this GL account applies. Omit this field when it applies to all legal entities.

statusstring

Accounting resource status. Possible values are ACTIVE and ARCHIVED.

ACTIVE

ARCHIVED

updated_atstring

Time at which the GL account was last updated, in ISO 8601 format.

valuestring

GL account name.

value_labelstring

Airwallex display name for the GL account.

Errors

Error status	Description
400	Invalid request.
500	Internal server error.

POST /api/v1/accounting/gl_accounts/create

$curl --request POST \
>  --url 'https://api.sandbox.airwallex.com/api/v1/accounting/gl_accounts/create' \
>  --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \
>  --header 'Content-Type: application/json' \
>  --data '{
>  "request_id": "4b8d83d6-70c4-429d-8a0b-bb3281f6b17f",
>  "code": "601022001-2",
>  "value": "Travel Costs-Domestic-Transportation -2",
>  "value_label": "Travel-Domestic-Flight | 601022001",
>  "external_id": "601022001-2",
>  "legal_entity_ids": [
>    "le_U3jlHqQRNHWn2zAKeeT8sg"
>  ]
>}'

Response (201 Created)

1{
2  "id": "985461d5-016f-4e1f-a387-5f1380b42d92",
3  "code": "601022001-2",
4  "value": "Travel Costs-Domestic-Transportation -2",
5  "value_label": "Travel-Domestic-Flight | 601022001",
6  "external_id": "601022001-2",
7  "legal_entity_ids": [
8    "le_U3jlHqQRNHWn2zAKeeT8sg"
9  ],
10  "status": "ACTIVE",
11  "created_at": "2025-01-01T00:00:00Z",
12  "updated_at": "2025-01-01T00:00:00Z"
13}

Was this section helpful?