Latinum Account API Resources

GET

/v2/account/{account_id}

(billing)

Get One Account

Service
billing

Accepted Roles (RBAC)

AdministratorBilling AccountantBilling AdministratorStaff MemberSupport

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
account_id	url	string	Account Id.	X

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
account_category	body	string	Account Category.
account_code	body	string	Account Code.
account_name	body	string	Account Name.
account_type	body	string	Account Type.
balance	body	string	Balance.
domain	body	string	Entity Domain.
id	body	string	Unique Entity ID.
legal_entity_id	body	string	Legal Entity Id.

Response Example

{
    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "domain": "interstellio.io",
    "legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "account_name": "Sales Account",
    "account_code": "SALE-001",
    "account_category": "REVENUE",
    "account_type": "SALES_ACC",
    "balance": "0.00"
}

GET

/v2/account/all

(billing)

Get All Accounts

Service
billing

Accepted Roles (RBAC)

AdministratorBilling AccountantBilling AdministratorStaff MemberSupport

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
account_code	query	string	Filter by account_code. (can suffix with wildcard )*
account_name	query	string	Filter by account_name. (can suffix with wildcard )*
l	query	integer	Paginate Limit / Entities per Page. (1-50, 0 for infinite, -1 for streaming)
legal_entity_id	query	string	Filter by legal_entity_id. (can suffix with wildcard )*
p	query	integer	Paginate Current Page. (default 1)
sc	query	string	Sort by Property/Column. (legal_entity_id, account_name, account_code)
sd	query	string	Sort direction. asc for Ascending or desc for Descending

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
account_category	body	string	Account Category.
account_code	body	string	Account Code.
account_name	body	string	Account Name.
account_type	body	string	Account Type.
balance	body	string	Balance.
domain	body	string	Entity Domain.
id	body	string	Unique Entity ID.
legal_entity_id	body	string	Legal Entity Id.
metadata.page	body	integer	Current Page. (always 1 for infinite)
metadata.pages	body	integer	Total Pages. (always 1 for infinite)
metadata.per_page	body	integer	Equeal to the entities per page limit or always equal to total records for infinite queries.
metadata.records	body	integer	Total entities found. (always max 250 unless infinite is accepted query parameter)

Response Example

{
    "payload": [
        {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "domain": "domain.com",
            "legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "account_name": "Account 1",
            "account_code": "ACC-001",
            "account_category": "REVENUE",
            "account_type": "SALES_ACC",
            "balance": "0.0000"
        },
        {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "domain": "domain.com",
            "legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "account_name": "Payable Account 1",
            "account_code": "PAY-ACC-001",
            "account_category": "CURRENT_LIABILITIES",
            "account_type": "ACC_PAYABLE",
            "balance": "0.0000"
        },
        {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "domain": "domain.com",
            "legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "account_name": "Receivable Account 1",
            "account_code": "RCV-ACC-001",
            "account_category": "CURRENT_ASSETS",
            "account_type": "ACC_RECEIVABLE",
            "balance": "0.0000"
        }
    ],
    "metadata": {
        "records": 3,
        "page": 1,
        "pages": 1,
        "per_page": 10
    }
}

POST

/v2/account

(billing)

Create An Account

Service
billing

Accepted Roles (RBAC)

AdministratorBilling Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
account_code	body	string	Account Code.	X
account_name	body	string	Account Name.	X
account_type	body	string	Account Type.
legal_entity_id	body	string	Legal Entity Id.	X

Request Example

{
    "legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "account_name": "Receivable Account 1",
    "account_code": "RCV-ACC-001",
    "account_type": "ACC_RECEIVABLE"
}

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
account_category	body	string	Account Category.
account_code	body	string	Account Code.
account_name	body	string	Account Name.
account_type	body	string	Account Type.
balance	body	string	Balance.
domain	body	string	Entity Domain.
id	body	string	Unique Entity ID.
legal_entity_id	body	string	Legal Entity Id.

Response Example

{
    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "domain": "interstellio.io",
    "legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "account_name": "Sales Account",
    "account_code": "SALE-001",
    "account_category": "REVENUE",
    "account_type": "SALES_ACC",
    "balance": "0.00"
}

POST

/v2/account/journalentry

(billing)

Add Manual Journal Entry

Service
billing

Accepted Roles (RBAC)

AdministratorBilling AccountantBilling Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
account_debits_credits	body	array	Account Debits Credits.	X
date	body	string	Date.	X
description	body	string	Description of Entity.	X
legal_entity_id	body	string	Legal Entity Id.	X

Request Example

{
    "legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "date": "2024-09-23T00:00:00+02:00",
    "description": "Manual Entry Description",
    "account_debits_credits": [
        {
            "account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "debit": "2000",
            "credit": "0"
        },
        {
            "account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "debit": "0",
            "credit": "2000"
        }
    ]
}

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
account_debits_credits	body	array	Account Debits Credits.
date	body	string	Date.
description	body	string	Description of Entity.
legal_entity_id	body	string	Legal Entity Id.

Response Example

{
    "legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "date": "2024-09-23T00:00:00+02:00",
    "description": "Manual Entry Description",
    "account_debits_credits": [
        {
            "account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "debit": "2000",
            "credit": "0"
        },
        {
            "account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "debit": "0",
            "credit": "2000"
        }
    ]
}

DELETE

/v2/account/{account_id}

(billing)

Remove One Account

Service
billing

Accepted Roles (RBAC)

AdministratorBilling Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
account_id	url	string	Account Id.	X

Response Status Codes

Code	Meaning
204	OK - No Content
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Navigation

Latinum Account API Resources