Latinum Billing Item API Resources

GET

/v2/billingitem/all

(billing)

List Billing Items.

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)
item_code	query	string	Filter by item_code. (can suffix with wildcard )*
l	query	integer	Paginate Limit / Entities per Page. (1-50, -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, item_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
default_description	body	string	Default Description.
default_payable_account_id	body	string	Default Payable Account Id.
default_receivable_account_id	body	string	Default Receivable Account Id.
default_sales_account_id	body	string	Default Sales Account Id.
default_sales_tax_code	body	string	Default Sales Tax Code.
default_unit_value	body	string	Default Unit Value.
domain	body	string	Entity Domain.
id	body	string	Unique Entity ID.
inventory_item	body	boolean	Inventory Item.
item_code	body	string	Item Code.
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": "interstellio.io",
            "legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "item_code": "001",
            "default_description": null,
            "default_sales_tax_code": null,
            "default_unit_value": "50.00",
            "default_sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "default_receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "default_payable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "inventory_item": false
        },
        {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "domain": "interstellio.io",
            "legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "item_code": "002",
            "default_description": "Item Description",
            "default_sales_tax_code": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "default_unit_value": "100.00",
            "default_sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "default_receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "default_payable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "inventory_item": true
        },
    ],
    "metadata": {
        "records": 3,
        "page": 1,
        "pages": 1,
        "per_page": 10
    }
}

GET

/v2/billingitem/{billing_item_id}

(billing)

Get Billing Item Details.

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)
billing_item_id	url	string	Billing Item 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
default_description	body	string	Default Description.
default_payable_account_id	body	string	Default Payable Account Id.
default_receivable_account_id	body	string	Default Receivable Account Id.
default_sales_account_id	body	string	Default Sales Account Id.
default_sales_tax_code	body	string	Default Sales Tax Code.
default_unit_value	body	string	Default Unit Value.
domain	body	string	Entity Domain.
id	body	string	Unique Entity ID.
inventory_item	body	boolean	Inventory Item.
item_code	body	string	Item Code.
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",
    "item_code": "001",
    "default_description": null,
    "default_sales_tax_code": null,
    "default_unit_value": "50.00",
    "default_sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "default_receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "default_payable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "inventory_item": false
}

POST

/v2/billingitem

(billing)

Create Billing Item

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)
default_description	body	string	Default Description.
default_payable_account_id	body	string	Default Payable Account Id.
default_receivable_account_id	body	string	Default Receivable Account Id.
default_sales_account_id	body	string	Default Sales Account Id.
default_sales_tax_code	body	string	Default Sales Tax Code.
default_unit_value	body	string	Default Unit Value.
inventory_item	body	boolean	Inventory Item.
item_code	body	string	Item Code.
legal_entity_id	body	string	Legal Entity Id.

Request Example

{
    "legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "item_code": "001",
    "default_description": null,
    "default_sales_tax_code": null,
    "default_unit_value": "50.00",
    "default_sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "default_receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "default_payable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "inventory_item": false
}

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
default_description	body	string	Default Description.
default_payable_account_id	body	string	Default Payable Account Id.
default_receivable_account_id	body	string	Default Receivable Account Id.
default_sales_account_id	body	string	Default Sales Account Id.
default_sales_tax_code	body	string	Default Sales Tax Code.
default_unit_value	body	string	Default Unit Value.
domain	body	string	Entity Domain.
id	body	string	Unique Entity ID.
inventory_item	body	boolean	Inventory Item.
item_code	body	string	Item Code.
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",
    "item_code": "001",
    "default_description": null,
    "default_sales_tax_code": null,
    "default_unit_value": "50.00",
    "default_sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "default_receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "default_payable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "inventory_item": false
}

Navigation

Latinum Billing Item API Resources