Axiomatic
API Reference

Entities

Legal entities / organizations

List all entities

GET
/api/entities

Authorization

x-api-key<token>

API key for programmatic access

In: header

Response Body

application/json

application/json

curl -X GET "https://app.axiomatic.us/api/entities"
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "legalName": "string",
    "type": "string",
    "functionalCurrency": "string",
    "fiscalYearStartMonth": 0,
    "periodType": "monthly",
    "timezone": "string",
    "parentEntityId": "104d03d6-66fa-40da-8ad1-17945ff5bbe2",
    "ownershipPercentage": 0,
    "consolidationGroupId": "cb72ea30-f8ea-40f2-99f2-2983e4e5cdac",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
]
{
  "error": "string"
}

Create an entity

POST
/api/entities

Authorization

x-api-key<token>

API key for programmatic access

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.us/api/entities" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "legalName": "string",
  "type": "string",
  "functionalCurrency": "string",
  "fiscalYearStartMonth": 0,
  "periodType": "monthly",
  "timezone": "string",
  "parentEntityId": "104d03d6-66fa-40da-8ad1-17945ff5bbe2",
  "ownershipPercentage": 0,
  "consolidationGroupId": "cb72ea30-f8ea-40f2-99f2-2983e4e5cdac",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "error": "string"
}
{
  "error": "string"
}

Get entity by ID

GET
/api/entities/{id}

Authorization

x-api-key<token>

API key for programmatic access

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/json

application/json

curl -X GET "https://app.axiomatic.us/api/entities/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "legalName": "string",
  "type": "string",
  "functionalCurrency": "string",
  "fiscalYearStartMonth": 0,
  "periodType": "monthly",
  "timezone": "string",
  "parentEntityId": "104d03d6-66fa-40da-8ad1-17945ff5bbe2",
  "ownershipPercentage": 0,
  "consolidationGroupId": "cb72ea30-f8ea-40f2-99f2-2983e4e5cdac",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "error": "string"
}
{
  "error": "string"
}

Update entity fields

PATCH
/api/entities/{id}

Authorization

x-api-key<token>

API key for programmatic access

In: header

Path Parameters

id*string
Formatuuid

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 PATCH "https://app.axiomatic.us/api/entities/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "legalName": "string",
  "type": "string",
  "functionalCurrency": "string",
  "fiscalYearStartMonth": 0,
  "periodType": "monthly",
  "timezone": "string",
  "parentEntityId": "104d03d6-66fa-40da-8ad1-17945ff5bbe2",
  "ownershipPercentage": 0,
  "consolidationGroupId": "cb72ea30-f8ea-40f2-99f2-2983e4e5cdac",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}

Health GET

Previous Page

Books

Next Page