Axiomatic
Core

Accounts

Chart of accounts

List accounts

GET
/api/accounts

Authorization

bearerAuth
AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string
Formatuuid

Response Body

application/json

application/json

application/json

curl -X GET "https://app.axiomatic.software/api/accounts?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
    "code": "string",
    "name": "string",
    "type": "ASSET",
    "normalBalance": "DEBIT",
    "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
    "currency": "string",
    "isActive": true,
    "tags": [
      "string"
    ],
    "createdAt": "2019-08-24T14:15:22Z"
  }
]
{
  "error": "string"
}
{
  "error": "string"
}

Create an account

POST
/api/accounts

Authorization

bearerAuth
AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://app.axiomatic.software/api/accounts" \  -H "Content-Type: application/json" \  -d '{    "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",    "code": "1000",    "name": "Cash",    "type": "ASSET"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
  "code": "string",
  "name": "string",
  "type": "ASSET",
  "normalBalance": "DEBIT",
  "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  "currency": "string",
  "isActive": true,
  "tags": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z"
}
{
  "error": "string"
}
{
  "error": "string"
}

Delete an account

DELETE
/api/accounts

Authorization

bearerAuth
AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

id*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://app.axiomatic.software/api/accounts?id=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "success": true
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}

Update an account

PUT
/api/accounts

Authorization

bearerAuth
AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PUT "https://app.axiomatic.software/api/accounts" \  -H "Content-Type: application/json" \  -d '{    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "code": "string",    "name": "string",    "type": "ASSET",    "normalBalance": "DEBIT"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
  "code": "string",
  "name": "string",
  "type": "ASSET",
  "normalBalance": "DEBIT",
  "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  "currency": "string",
  "isActive": true,
  "tags": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}

Get ledger for a specific account

GET
/api/accounts/{id}/ledger

Authorization

bearerAuth
AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/json

curl -X GET "https://app.axiomatic.software/api/accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08/ledger"
{}
{
  "error": "string"
}

Books

Previous Page

Account Mappings

Next Page