Latinum Contracts API Resources
GET
/v1/contract/contract_term_units/list(billing)
Get All Contract Term Units
Service
billing
billing
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) |
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 |
|---|---|---|---|
| contract term units | body | array | Contract Term Units. |
Response Example
[
"day",
"week",
"month",
"year"
]GET
/v1/contract/payment_term_units/list(billing)
Get All Payment Term Units
Service
billing
billing
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) |
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 |
|---|---|---|---|
| payment term units | body | array | Payment Term Units. |
Response Example
[
"day",
"week",
"month",
"year"
]GET
/v1/contract/payment_term_strategies/list(billing)
Get All Payment Term Strategies
Service
billing
billing
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) |
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 |
|---|---|---|---|
| payment term units | body | array | Payment Term Units. |
Response Example
[
"start-of-day",
"end-of-day",
"start-of-week",
"end-of-week",
"start-of-month",
"end-of-month",
"start-of-year",
"end-of-year"
]GET
/v1/contract/contract_template/list(billing)
List All Contract Templates
Service
billing
billing
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) | |
| 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) | |
| 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 |
|---|---|---|---|
| contract_template.contract_term_count | body | integer | Contract Template Contract Term Count. |
| contract_template.contract_term_unit | body | string | Contract Template Contract Term Unit. |
| contract_template.created | body | string | Contract Template Created. |
| contract_template.domain | body | string | Contract Template Domain. |
| contract_template.id | body | string | Contract Template Id. |
| contract_template.legal_entity_id | body | string | Contract Template Legal Entity Id. |
| contract_template.line_item.date | body | string | Contract Template Line Item Date. |
| contract_template.line_item.description | body | string | Contract Template Line Item Description. |
| contract_template.line_item.discount_percent | body | decimal | Contract Template Line Item Discount Percent. |
| contract_template.line_item.discount_total | body | decimal | Contract Template Line Item Discount Total. |
| contract_template.line_item.document_id | body | string | Contract Template Line Item Document Id. |
| contract_template.line_item.excluding | body | decimal | Contract Template Line Item Excluding. |
| contract_template.line_item.excluding_total | body | decimal | Contract Template Line Item Excluding Total. |
| contract_template.line_item.id | body | string | Contract Template Line Item Id. |
| contract_template.line_item.including | body | decimal | Contract Template Line Item Including. |
| contract_template.line_item.including_total | body | decimal | Contract Template Line Item Including Total. |
| contract_template.line_item.item_code | body | string | Contract Template Line Item Item Code. |
| contract_template.line_item.payable_account_code | body | string | Contract Template Line Item Payable Account Code. |
| contract_template.line_item.payable_account_id | body | string | Contract Template Line Item Payable Account Id. |
| contract_template.line_item.quantity | body | integer | Contract Template Line Item Quantity. |
| contract_template.line_item.receivable_account_code | body | string | Contract Template Line Item Receivable Account Code. |
| contract_template.line_item.receivable_account_id | body | string | Contract Template Line Item Receivable Account Id. |
| contract_template.line_item.sales_account_code | body | string | Contract Template Line Item Sales Account Code. |
| contract_template.line_item.sales_account_id | body | string | Contract Template Line Item Sales Account Id. |
| contract_template.line_item.sales_tax_account_code | body | string | Contract Template Line Item Sales Tax Account Code. |
| contract_template.line_item.sales_tax_account_id | body | string | Contract Template Line Item Sales Tax Account Id. |
| contract_template.line_item.sales_tax_code | body | string | Contract Template Line Item Sales Tax Code. |
| contract_template.line_item.tax_percent | body | decimal | Contract Template Line Item Tax Percent. |
| contract_template.line_item.unit_value | body | decimal | Contract Template Line Item Unit Value. |
| contract_template.line_items_once_off | body | array | Contract Template Line Items Once Off. |
| contract_template.line_items_recurring | body | array | Contract Template Line Items Recurring. |
| contract_template.name | body | string | Contract Template Name. |
| contract_template.payment_term_count | body | integer | Contract Template Payment Term Count. |
| contract_template.payment_term_strategy | body | string | Contract Template Payment Term Strategy. |
| contract_template.payment_term_unit | body | string | Contract Template Payment Term Unit. |
| contract_template.renewable | body | boolean | Contract Template Renewable. |
| contract_template.timezone | body | string | Contract Template Timezone. |
| contract_template.updated | body | string | Contract Template Updated. |
| contract_templates | body | array | Contract Templates. |
| 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",
"name": "Contract Template #1",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"timezone": "Africa/Johannesburg",
"contract_term_count": 10,
"contract_term_unit": "day",
"payment_term_count": 1,
"payment_term_unit": "day",
"payment_term_strategy": "end-of-day",
"renewable": false,
"created": "2025-03-05T08:37:41.304Z",
"updated": "2025-03-05T08:37:41.304Z",
"line_items_once_off": [
{
"line_item_type": "once_off",
"item_code": null,
"description": "Product #1",
"quantity": 1,
"unit_value": "50.00",
"excluding": "50.00",
"including": "50.00",
"excluding_total": "50.00",
"including_total": "50.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "0.00",
"sales_tax_code": null,
"sales_tax_account_id": null,
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": null,
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX"
}
],
"line_items_recurring": [
{
"line_item_type": "recurring",
"item_code": null,
"description": "Product",
"quantity": 1,
"unit_value": "50.00",
"excluding": "50.00",
"including": "50.00",
"excluding_total": "50.00",
"including_total": "50.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "0.00",
"sales_tax_code": null,
"sales_tax_account_id": null,
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": null,
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX"
}
]
},
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-ab0456424a86",
"domain": "interstellio.io",
"name": "Contract Template #2",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"timezone": "Africa/Johannesburg",
"contract_term_count": 10,
"contract_term_unit": "day",
"payment_term_count": 1,
"payment_term_unit": "day",
"payment_term_strategy": "end-of-day",
"renewable": false,
"created": "2025-03-05T09:38:15.840Z",
"updated": "2025-03-05T09:38:15.840Z",
"line_items_once_off": [
{
"line_item_type": "once_off",
"item_code": null,
"description": "Product",
"quantity": 1,
"unit_value": "50.00",
"excluding": "50.00",
"including": "50.00",
"excluding_total": "50.00",
"including_total": "50.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "0.00",
"sales_tax_code": null,
"sales_tax_account_id": null,
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": null,
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX"
}
],
"line_items_recurring": [
{
"line_item_type": "recurring",
"item_code": null,
"description": "Product",
"quantity": 1,
"unit_value": "50.00",
"excluding": "50.00",
"including": "50.00",
"excluding_total": "50.00",
"including_total": "50.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "0.00",
"sales_tax_code": null,
"sales_tax_account_id": null,
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": null,
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX"
}
]
}
],
"metadata": {
"records": 2,
"page": 1,
"pages": 1,
"per_page": 10
}
}GET
/v1/contract/contract_template/{contract_template_id}(billing)
Get Single Contract Template
Service
billing
billing
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) | |
| contract_template_id | url | string | Contract Template 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 |
|---|---|---|---|
| contract_term_count | body | integer | Contract Term Count. |
| contract_term_unit | body | string | Contract Term Unit. |
| created | body | string | Created. |
| legal_entity_id | body | string | Legal Entity Id. |
| line_item.date | body | string | Line Item Date. |
| line_item.description | body | string | Line Item Description. |
| line_item.discount_percent | body | decimal | Line Item Discount Percent. |
| line_item.discount_total | body | decimal | Line Item Discount Total. |
| line_item.document_id | body | string | Line Item Document Id. |
| line_item.excluding | body | decimal | Line Item Excluding. |
| line_item.excluding_total | body | decimal | Line Item Excluding Total. |
| line_item.id | body | string | Line Item Id. |
| line_item.including | body | decimal | Line Item Including. |
| line_item.including_total | body | decimal | Line Item Including Total. |
| line_item.item_code | body | string | Line Item Item Code. |
| line_item.payable_account_code | body | string | Line Item Payable Account Code. |
| line_item.payable_account_id | body | string | Line Item Payable Account Id. |
| line_item.quantity | body | integer | Line Item Quantity. |
| line_item.receivable_account_code | body | string | Line Item Receivable Account Code. |
| line_item.receivable_account_id | body | string | Line Item Receivable Account Id. |
| line_item.sales_account_code | body | string | Line Item Sales Account Code. |
| line_item.sales_account_id | body | string | Line Item Sales Account Id. |
| line_item.sales_tax_account_code | body | string | Line Item Sales Tax Account Code. |
| line_item.sales_tax_account_id | body | string | Line Item Sales Tax Account Id. |
| line_item.sales_tax_code | body | string | Line Item Sales Tax Code. |
| line_item.tax_percent | body | decimal | Line Item Tax Percent. |
| line_item.unit_value | body | decimal | Line Item Unit Value. |
| line_items_once_off | body | array | Line Items Once Off. |
| line_items_recurring | body | array | Line Items Recurring. |
| name | body | string | Name of Entity. |
| payment_term_count | body | integer | Payment Term Count. |
| payment_term_strategy | body | string | Payment Term Strategy. |
| payment_term_unit | body | string | Payment Term Unit. |
| renewable | body | boolean | Renewable. |
| timezone | body | string | Timezone. |
| updated | body | string | Updated. |
Response Example
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "interstellio.io",
"name": "Contract Template #1",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"contract_term_count": 10,
"contract_term_unit": "day",
"payment_term_count": "1",
"payment_term_unit": "day",
"payment_term_strategy": "end-of-day",
"timezone": "Africa/Johannesburg",
"renewable": false,
"created": "2025-03-05T08:37:41.304Z",
"updated": "2025-03-05T08:37:41.304Z",
"line_items_once_off": [
{
"line_item_type": "once_off",
"item_code": null,
"description": "Product",
"quantity": 1,
"unit_value": "50.00",
"excluding": "50.00",
"including": "50.00",
"excluding_total": "50.00",
"including_total": "50.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "0.00",
"sales_tax_code": null,
"sales_tax_account_id": null,
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": null,
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX"
}
],
"line_items_recurring": [
{
"line_item_type": "recurring",
"item_code": null,
"description": "Product",
"quantity": 1,
"unit_value": "50.00",
"excluding": "50.00",
"including": "50.00",
"excluding_total": "50.00",
"including_total": "50.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "0.00",
"sales_tax_code": null,
"sales_tax_account_id": null,
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": null,
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX"
}
]
}POST
/v1/contract/contract_template(billing)
Create Contract Template
Service
billing
billing
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) | |
| contract_term_count | body | integer | Contract Term Count. | X |
| contract_term_unit | body | string | Contract Term Unit. | X |
| legal_entity_id | body | string | Legal Entity Id. | X |
| line_item.description | body | string | Line Item Description. | X |
| line_item.discount_percent | body | decimal | Line Item Discount Percent. | |
| line_item.item_code | body | string | Line Item Item Code. | |
| line_item.payable_account_code | body | string | Line Item Payable Account Code. | |
| line_item.payable_account_id | body | string | Line Item Payable Account Id. | |
| line_item.quantity | body | integer | Line Item Quantity. | X |
| line_item.receivable_account_code | body | string | Line Item Receivable Account Code. | |
| line_item.receivable_account_id | body | string | Line Item Receivable Account Id. | |
| line_item.sales_account_code | body | string | Line Item Sales Account Code. | |
| line_item.sales_account_id | body | string | Line Item Sales Account Id. | |
| line_item.sales_tax_account_code | body | string | Line Item Sales Tax Account Code. | |
| line_item.sales_tax_account_id | body | string | Line Item Sales Tax Account Id. | |
| line_item.sales_tax_code | body | string | Line Item Sales Tax Code. | |
| line_item.tax_percent | body | decimal | Line Item Tax Percent. | |
| line_item.unit_value | body | decimal | Line Item Unit Value. | |
| line_items_once_off | body | array | Line Items Once Off. | X |
| line_items_recurring | body | array | Line Items Recurring. | X |
| name | body | string | Name of Entity. | X |
| payment_term_count | body | integer | Payment Term Count. | X |
| payment_term_strategy | body | string | Payment Term Strategy. | X |
| payment_term_unit | body | string | Payment Term Unit. | X |
| renewable | body | boolean | Renewable. | X |
| timezone | body | string | Timezone. | X |
Request Example
{
"name": "Test Contract #1",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"timezone": "Africa/Johannesburg",
"contract_term_count": 10,
"contract_term_unit": "day",
"payment_term_count": 1,
"payment_term_unit": "day",
"payment_term_strategy": "end-of-day",
"line_items_once_off": [
{
"quantity": 1,
"description": "Product #1",
"unit_value": 50,
"discount_percent": 0,
"item_code": null,
"receivable_account_code": "XXX",
"sales_account_code": "XXX"
}
],
"line_items_recurring": [
{
"quantity": 1,
"description": "Product #2",
"unit_value": 100,
"discount_percent": 0,
"item_code": null,
"receivable_account_code": "XXX",
"sales_account_code": "XXX"
}
],
"renewable": false
}Response Status Codes
| Code | Meaning |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized / Require Authentication |
| 403 | Forbidden / Access Denied |
| 409 | Conflict |
| 429 | Too Many Requests / Your Rate Limited |
| 500, 501, 502, 503, 504 | Service Unavailable |
Response Properties
| Name | In | Type | Description |
|---|---|---|---|
| contract_term_count | body | integer | Contract Term Count. |
| contract_term_unit | body | string | Contract Term Unit. |
| created | body | string | Created. |
| legal_entity_id | body | string | Legal Entity Id. |
| line_item.date | body | string | Line Item Date. |
| line_item.description | body | string | Line Item Description. |
| line_item.discount_percent | body | decimal | Line Item Discount Percent. |
| line_item.document_id | body | string | Line Item Document Id. |
| line_item.id | body | string | Line Item Id. |
| line_item.item_code | body | string | Line Item Item Code. |
| line_item.payable_account_code | body | string | Line Item Payable Account Code. |
| line_item.payable_account_id | body | string | Line Item Payable Account Id. |
| line_item.quantity | body | integer | Line Item Quantity. |
| line_item.receivable_account_code | body | string | Line Item Receivable Account Code. |
| line_item.receivable_account_id | body | string | Line Item Receivable Account Id. |
| line_item.sales_account_code | body | string | Line Item Sales Account Code. |
| line_item.sales_account_id | body | string | Line Item Sales Account Id. |
| line_item.sales_tax_account_code | body | string | Line Item Sales Tax Account Code. |
| line_item.sales_tax_account_id | body | string | Line Item Sales Tax Account Id. |
| line_item.sales_tax_code | body | string | Line Item Sales Tax Code. |
| line_item.tax_percent | body | decimal | Line Item Tax Percent. |
| line_item.unit_value | body | decimal | Line Item Unit Value. |
| line_items_once_off | body | array | Line Items Once Off. |
| line_items_recurring | body | array | Line Items Recurring. |
| name | body | string | Name of Entity. |
| payment_term_count | body | integer | Payment Term Count. |
| payment_term_strategy | body | string | Payment Term Strategy. |
| payment_term_unit | body | string | Payment Term Unit. |
| renewable | body | boolean | Renewable. |
| timezone | body | string | Timezone. |
| updated | body | string | Updated. |
Response Example
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "interstellio.io",
"name": "Test Contract #1",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"contract_term_count": 10,
"contract_term_unit": "day",
"payment_term_count": "1",
"payment_term_unit": "day",
"payment_term_strategy": "end-of-day",
"timezone": "Africa/Johannesburg",
"renewable": false,
"created": "2025-03-12T05:35:32.009Z",
"updated": "2025-03-12T05:35:32.009Z",
"line_items_once_off": [
{
"line_item_type": "once_off",
"item_code": null,
"description": "Product",
"quantity": 1,
"unit_value": "50.00",
"excluding": "50.00",
"including": "50.00",
"excluding_total": "50.00",
"including_total": "50.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "0.00",
"sales_tax_code": null,
"sales_tax_account_id": null,
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": null,
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
}
],
"line_items_recurring": [
{
"line_item_type": "recurring",
"item_code": null,
"description": "Product",
"quantity": 1,
"unit_value": "50.00",
"excluding": "50.00",
"including": "50.00",
"excluding_total": "50.00",
"including_total": "50.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "0.00",
"sales_tax_code": null,
"sales_tax_account_id": null,
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": null,
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
}
]
}PATCH
/v1/contract/contract_template/{contract_template_id}(billing)
Update Contract Template
Service
billing
billing
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) | |
| contract_template_id | url | string | Contract Template Id. | X |
| contract_term_count | body | integer | Contract Term Count. | |
| contract_term_unit | body | string | Contract Term Unit. | |
| created | body | string | Created. | |
| legal_entity_id | body | string | Legal Entity Id. | |
| line_item.date | body | string | Line Item Date. | |
| line_item.description | body | string | Line Item Description. | |
| line_item.discount_percent | body | decimal | Line Item Discount Percent. | |
| line_item.discount_total | body | decimal | Line Item Discount Total. | |
| line_item.document_id | body | string | Line Item Document Id. | |
| line_item.excluding | body | decimal | Line Item Excluding. | |
| line_item.excluding_total | body | decimal | Line Item Excluding Total. | |
| line_item.id | body | string | Line Item Id. | |
| line_item.including | body | decimal | Line Item Including. | |
| line_item.including_total | body | decimal | Line Item Including Total. | |
| line_item.item_code | body | string | Line Item Item Code. | |
| line_item.payable_account_code | body | string | Line Item Payable Account Code. | |
| line_item.payable_account_id | body | string | Line Item Payable Account Id. | |
| line_item.quantity | body | integer | Line Item Quantity. | |
| line_item.receivable_account_code | body | string | Line Item Receivable Account Code. | |
| line_item.receivable_account_id | body | string | Line Item Receivable Account Id. | |
| line_item.sales_account_code | body | string | Line Item Sales Account Code. | |
| line_item.sales_account_id | body | string | Line Item Sales Account Id. | |
| line_item.sales_tax_account_code | body | string | Line Item Sales Tax Account Code. | |
| line_item.sales_tax_account_id | body | string | Line Item Sales Tax Account Id. | |
| line_item.sales_tax_code | body | string | Line Item Sales Tax Code. | |
| line_item.tax_percent | body | decimal | Line Item Tax Percent. | |
| line_item.unit_value | body | decimal | Line Item Unit Value. | |
| line_items_once_off | body | array | Line Items Once Off. | |
| line_items_recurring | body | array | Line Items Recurring. | |
| name | body | string | Name of Entity. | |
| payment_term_count | body | integer | Payment Term Count. | |
| payment_term_strategy | body | string | Payment Term Strategy. | |
| payment_term_unit | body | string | Payment Term Unit. | |
| renewable | body | boolean | Renewable. | |
| timezone | body | string | Timezone. | |
| updated | body | string | Updated. |
Request Example
{
"name": "Test Contract #1",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"timezone": "Africa/Johannesburg",
"contract_term_count": 10,
"contract_term_unit": "day",
"payment_term_count": 1,
"payment_term_unit": "day",
"payment_term_strategy": "end-of-day",
"line_items_once_off": [
{
"quantity": 1,
"description": "Product #1",
"unit_value": 50,
"discount_percent": 0,
"item_code": null,
"receivable_account_code": "XXX",
"sales_account_code": "XXX"
}
],
"line_items_recurring": [
{
"quantity": 1,
"description": "Product #2",
"unit_value": 100,
"discount_percent": 0,
"item_code": null,
"receivable_account_code": "XXX",
"sales_account_code": "XXX"
}
],
"renewable": false,
"created": "2025-01-01T12:00:00.000Z",
"updated": "2025-01-01T12:00:00.000Z"
}Response Status Codes
| Code | Meaning |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized / Require Authentication |
| 403 | Forbidden / Access Denied |
| 404 | Not Found |
| 409 | Conflict |
| 429 | Too Many Requests / Your Rate Limited |
| 500, 501, 502, 503, 504 | Service Unavailable |
Response Properties
| Name | In | Type | Description |
|---|---|---|---|
| contract_term_count | body | integer | Contract Term Count. |
| contract_term_unit | body | string | Contract Term Unit. |
| created | body | string | Created. |
| legal_entity_id | body | string | Legal Entity Id. |
| line_item.date | body | string | Line Item Date. |
| line_item.description | body | string | Line Item Description. |
| line_item.discount_percent | body | decimal | Line Item Discount Percent. |
| line_item.discount_total | body | decimal | Line Item Discount Total. |
| line_item.document_id | body | string | Line Item Document Id. |
| line_item.excluding | body | decimal | Line Item Excluding. |
| line_item.excluding_total | body | decimal | Line Item Excluding Total. |
| line_item.id | body | string | Line Item Id. |
| line_item.including | body | decimal | Line Item Including. |
| line_item.including_total | body | decimal | Line Item Including Total. |
| line_item.item_code | body | string | Line Item Item Code. |
| line_item.payable_account_code | body | string | Line Item Payable Account Code. |
| line_item.payable_account_id | body | string | Line Item Payable Account Id. |
| line_item.quantity | body | integer | Line Item Quantity. |
| line_item.receivable_account_code | body | string | Line Item Receivable Account Code. |
| line_item.receivable_account_id | body | string | Line Item Receivable Account Id. |
| line_item.sales_account_code | body | string | Line Item Sales Account Code. |
| line_item.sales_account_id | body | string | Line Item Sales Account Id. |
| line_item.sales_tax_account_code | body | string | Line Item Sales Tax Account Code. |
| line_item.sales_tax_account_id | body | string | Line Item Sales Tax Account Id. |
| line_item.sales_tax_code | body | string | Line Item Sales Tax Code. |
| line_item.tax_percent | body | decimal | Line Item Tax Percent. |
| line_item.unit_value | body | decimal | Line Item Unit Value. |
| line_items_once_off | body | array | Line Items Once Off. |
| line_items_recurring | body | array | Line Items Recurring. |
| name | body | string | Name of Entity. |
| payment_term_count | body | integer | Payment Term Count. |
| payment_term_strategy | body | string | Payment Term Strategy. |
| payment_term_unit | body | string | Payment Term Unit. |
| renewable | body | boolean | Renewable. |
| timezone | body | string | Timezone. |
| updated | body | string | Updated. |
Response Example
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "interstellio.io",
"name": "Contract Template #1",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"contract_term_count": 10,
"contract_term_unit": "day",
"payment_term_count": "1",
"payment_term_unit": "day",
"payment_term_strategy": "end-of-day",
"timezone": "Africa/Johannesburg",
"renewable": false,
"created": "2025-03-12T05:35:32.009Z",
"updated": "2025-03-12T06:02:23.544Z",
"line_items_once_off": [
{
"line_item_type": "once_off",
"item_code": null,
"description": "Product",
"quantity": 1,
"unit_value": "50.00",
"excluding": "50.00",
"including": "50.00",
"excluding_total": "50.00",
"including_total": "50.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "0.00",
"sales_tax_code": null,
"sales_tax_account_id": null,
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": null,
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX"
}
],
"line_items_recurring": [
{
"line_item_type": "recurring",
"item_code": null,
"description": "Product",
"quantity": 1,
"unit_value": "50.00",
"excluding": "50.00",
"including": "50.00",
"excluding_total": "50.00",
"including_total": "50.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "0.00",
"sales_tax_code": null,
"sales_tax_account_id": null,
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": null,
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX"
}
]
}DELETE
/v1/contract/contract_template/{contract_template_id}(billing)
Delete Contract Template
Service
billing
billing
Request Parameters
| Name | In | Type | Description | MUST include |
|---|---|---|---|---|
| X-Auth-Token | header | string | Valid Authentication Token. Please see developers documentation/identity. | X |
| contract_template_id | url | string | Contract Template 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 |
GET
/v1/contract/list(billing)
List All Contracts
Service
billing
billing
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) | |
| customer_account_id | query | string | Filter by customer_account_id. (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, customer_account_id) | |
| 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 |
|---|---|---|---|
| contract_end | body | string | Contract End. |
| contract_start | body | string | Contract Start. |
| contract_term_count | body | integer | Contract Term Count. |
| contract_term_unit | body | string | Contract Term Unit. |
| created | body | string | Created. |
| customer_account_id | body | string | Customer Account Id. |
| legal_entity_id | body | string | Legal Entity Id. |
| line_item.date | body | string | Line Item Date. |
| line_item.description | body | string | Line Item Description. |
| line_item.discount_percent | body | decimal | Line Item Discount Percent. |
| line_item.discount_total | body | decimal | Line Item Discount Total. |
| line_item.document_id | body | string | Line Item Document Id. |
| line_item.excluding | body | decimal | Line Item Excluding. |
| line_item.excluding_total | body | decimal | Line Item Excluding Total. |
| line_item.id | body | string | Line Item Id. |
| line_item.including | body | decimal | Line Item Including. |
| line_item.including_total | body | decimal | Line Item Including Total. |
| line_item.item_code | body | string | Line Item Item Code. |
| line_item.payable_account_code | body | string | Line Item Payable Account Code. |
| line_item.payable_account_id | body | string | Line Item Payable Account Id. |
| line_item.quantity | body | integer | Line Item Quantity. |
| line_item.receivable_account_code | body | string | Line Item Receivable Account Code. |
| line_item.receivable_account_id | body | string | Line Item Receivable Account Id. |
| line_item.sales_account_code | body | string | Line Item Sales Account Code. |
| line_item.sales_account_id | body | string | Line Item Sales Account Id. |
| line_item.sales_tax_account_code | body | string | Line Item Sales Tax Account Code. |
| line_item.sales_tax_account_id | body | string | Line Item Sales Tax Account Id. |
| line_item.sales_tax_code | body | string | Line Item Sales Tax Code. |
| line_item.tax_percent | body | decimal | Line Item Tax Percent. |
| line_item.unit_value | body | decimal | Line Item Unit Value. |
| line_items_once_off | body | array | Line Items Once Off. |
| line_items_recurring | body | array | Line Items Recurring. |
| metadata | body | object | Metadata. |
| 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) |
| name | body | string | Name of Entity. |
| payment_term_count | body | integer | Payment Term Count. |
| payment_term_strategy | body | string | Payment Term Strategy. |
| payment_term_unit | body | string | Payment Term Unit. |
| renewable | body | boolean | Renewable. |
| timezone | body | string | Timezone. |
| updated | body | string | Updated. |
Response Example
{
"payload": [
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "interstellio.io",
"contract_number": "C-25",
"name": "Contract #1",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"timezone": "Africa/Johannesburg",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"created": "2025-03-07T12:20:23.779Z",
"updated": "2025-03-07T12:38:52.521Z",
"expired": null,
"renewed": null,
"contract_term_count": 10,
"contract_term_unit": "day",
"contract_start": "2025-03-07T12:30:00.000Z",
"contract_end": "2025-03-17T12:30:00.000Z",
"payment_term_count": 1,
"payment_term_unit": "day",
"payment_term_strategy": "end-of-day",
"line_items_once_off": [
{
"line_item_type": "once_off",
"item_code": null,
"description": "Product",
"quantity": 1,
"unit_value": "50.00",
"excluding": "50.00",
"including": "50.00",
"excluding_total": "50.00",
"including_total": "50.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "0.00",
"sales_tax_code": null,
"sales_tax_account_id": null,
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": null,
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX"
},
{
"line_item_type": "once_off",
"item_code": null,
"description": "Product #2",
"quantity": 1,
"unit_value": "90.00",
"excluding": "90.00",
"including": "90.00",
"excluding_total": "90.00",
"including_total": "90.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "0.00",
"sales_tax_code": null,
"sales_tax_account_id": null,
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": null,
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX"
}
],
"line_items_recurring": [
{
"line_item_type": "recurring",
"item_code": null,
"description": "Product",
"quantity": 1,
"unit_value": "50.00",
"excluding": "50.00",
"including": "50.00",
"excluding_total": "50.00",
"including_total": "50.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "0.00",
"sales_tax_code": null,
"sales_tax_account_id": null,
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": null,
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX"
}
],
"renewable": false,
"metadata": {
"invoices": [
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"date": "2025-03-07T12:30:43.182Z"
}
]
}
},
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "interstellio.io",
"contract_number": "C-26",
"name": "Contract #2",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"timezone": "Africa/Johannesburg",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"created": "2025-03-07T12:33:02.014Z",
"updated": "2025-03-07T12:38:41.392Z",
"expired": null,
"renewed": null,
"contract_term_count": 10,
"contract_term_unit": "day",
"contract_start": "2025-03-07T12:40:00.000Z",
"contract_end": "2025-03-17T12:40:00.000Z",
"payment_term_count": 1,
"payment_term_unit": "day",
"payment_term_strategy": "end-of-day",
"line_items_once_off": [
{
"line_item_type": "once_off",
"item_code": null,
"description": "Product",
"quantity": 1,
"unit_value": "50.00",
"excluding": "50.00",
"including": "50.00",
"excluding_total": "50.00",
"including_total": "50.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "0.00",
"sales_tax_code": null,
"sales_tax_account_id": null,
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": null,
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX"
}
],
"line_items_recurring": [
{
"line_item_type": "recurring",
"item_code": null,
"description": "Product",
"quantity": 1,
"unit_value": "50.00",
"excluding": "50.00",
"including": "50.00",
"excluding_total": "50.00",
"including_total": "50.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "0.00",
"sales_tax_code": null,
"sales_tax_account_id": null,
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": null,
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX"
}
],
"renewable": false,
"metadata": {
"invoices": [
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"date": "2025-03-07T12:33:02.202Z"
}
]
}
}
],
"metadata": {
"records": 2,
"page": 1,
"pages": 1,
"per_page": 10
}
}GET
/v1/contract/{contract_id}(billing)
Get Single Contract
Service
billing
billing
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) | |
| contract_id | url | string | Contract 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 |
|---|---|---|---|
| contract_end | body | string | Contract End. |
| contract_start | body | string | Contract Start. |
| contract_term_count | body | integer | Contract Term Count. |
| contract_term_unit | body | string | Contract Term Unit. |
| created | body | string | Created. |
| customer_account_id | body | string | Customer Account Id. |
| legal_entity_id | body | string | Legal Entity Id. |
| line_item.date | body | string | Line Item Date. |
| line_item.description | body | string | Line Item Description. |
| line_item.discount_percent | body | decimal | Line Item Discount Percent. |
| line_item.discount_total | body | decimal | Line Item Discount Total. |
| line_item.document_id | body | string | Line Item Document Id. |
| line_item.excluding | body | decimal | Line Item Excluding. |
| line_item.excluding_total | body | decimal | Line Item Excluding Total. |
| line_item.id | body | string | Line Item Id. |
| line_item.including | body | decimal | Line Item Including. |
| line_item.including_total | body | decimal | Line Item Including Total. |
| line_item.item_code | body | string | Line Item Item Code. |
| line_item.payable_account_code | body | string | Line Item Payable Account Code. |
| line_item.payable_account_id | body | string | Line Item Payable Account Id. |
| line_item.quantity | body | integer | Line Item Quantity. |
| line_item.receivable_account_code | body | string | Line Item Receivable Account Code. |
| line_item.receivable_account_id | body | string | Line Item Receivable Account Id. |
| line_item.sales_account_code | body | string | Line Item Sales Account Code. |
| line_item.sales_account_id | body | string | Line Item Sales Account Id. |
| line_item.sales_tax_account_code | body | string | Line Item Sales Tax Account Code. |
| line_item.sales_tax_account_id | body | string | Line Item Sales Tax Account Id. |
| line_item.sales_tax_code | body | string | Line Item Sales Tax Code. |
| line_item.tax_percent | body | decimal | Line Item Tax Percent. |
| line_item.unit_value | body | decimal | Line Item Unit Value. |
| line_items_once_off | body | array | Line Items Once Off. |
| line_items_recurring | body | array | Line Items Recurring. |
| metadata | body | object | Metadata. |
| name | body | string | Name of Entity. |
| payment_term_count | body | integer | Payment Term Count. |
| payment_term_strategy | body | string | Payment Term Strategy. |
| payment_term_unit | body | string | Payment Term Unit. |
| renewable | body | boolean | Renewable. |
| timezone | body | string | Timezone. |
| updated | body | string | Updated. |
Response Example
{
"id": "XXXXXXXX-XXXX-XXXX-951c-ab0456424a86",
"domain": "interstellio.io",
"contract_number": "C-28",
"name": "Contract #3",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"created": "2025-03-12T06:24:44.325Z",
"updated": "2025-03-12T06:25:03.679Z",
"renewed": null,
"expired": null,
"cancelled": "2025-03-12T06:25:03.679Z",
"contract_term_count": 10,
"contract_term_unit": "day",
"contract_start": "2025-03-12T06:30:00.000Z",
"contract_end": "2025-03-22T06:30:00.000Z",
"payment_term_count": "1",
"payment_term_unit": "day",
"payment_term_strategy": "end-of-day",
"renewable": false,
"timezone": "Africa/Johannesburg",
"metadata": {
"invoices": [
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"date": "2025-03-12T06:24:44.458Z"
}
]
},
"line_items_once_off": [
{
"line_item_type": "once_off",
"item_code": null,
"description": "Product",
"quantity": 1,
"unit_value": "50.00",
"excluding": "50.00",
"including": "50.00",
"excluding_total": "50.00",
"including_total": "50.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "0.00",
"sales_tax_code": null,
"sales_tax_account_id": null,
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": null,
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX"
}
],
"line_items_recurring": [
{
"line_item_type": "recurring",
"item_code": null,
"description": "Product",
"quantity": 1,
"unit_value": "50.00",
"excluding": "50.00",
"including": "50.00",
"excluding_total": "50.00",
"including_total": "50.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "0.00",
"sales_tax_code": null,
"sales_tax_account_id": null,
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": null,
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX"
}
]
}POST
/v1/contract(billing)
Create Contract
Service
billing
billing
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) | |
| contract_start | body | string | Contract Start. | X |
| contract_term_count | body | integer | Contract Term Count. | X |
| contract_term_unit | body | string | Contract Term Unit. | X |
| customer_account_id | body | string | Customer Account Id. | X |
| legal_entity_id | body | string | Legal Entity Id. | X |
| line_item.description | body | string | Line Item Description. | X |
| line_item.discount_percent | body | decimal | Line Item Discount Percent. | |
| line_item.excluding | body | decimal | Line Item Excluding. | |
| line_item.including | body | decimal | Line Item Including. | |
| line_item.item_code | body | string | Line Item Item Code. | |
| line_item.payable_account_code | body | string | Line Item Payable Account Code. | |
| line_item.payable_account_id | body | string | Line Item Payable Account Id. | |
| line_item.quantity | body | integer | Line Item Quantity. | X |
| line_item.receivable_account_code | body | string | Line Item Receivable Account Code. | |
| line_item.receivable_account_id | body | string | Line Item Receivable Account Id. | |
| line_item.sales_account_code | body | string | Line Item Sales Account Code. | |
| line_item.sales_account_id | body | string | Line Item Sales Account Id. | |
| line_item.sales_tax_account_code | body | string | Line Item Sales Tax Account Code. | |
| line_item.sales_tax_account_id | body | string | Line Item Sales Tax Account Id. | |
| line_item.sales_tax_code | body | string | Line Item Sales Tax Code. | |
| line_item.tax_percent | body | decimal | Line Item Tax Percent. | |
| line_item.unit_value | body | decimal | Line Item Unit Value. | |
| line_items_once_off | body | array | Line Items Once Off. | X |
| line_items_recurring | body | array | Line Items Recurring. | X |
| name | body | string | Name of Entity. | X |
| payment_term_count | body | integer | Payment Term Count. | X |
| payment_term_strategy | body | string | Payment Term Strategy. | X |
| payment_term_unit | body | string | Payment Term Unit. | X |
| renewable | body | boolean | Renewable. | X |
| timezone | body | string | Timezone. | X |
Request Example
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "interstellio.io",
"name": "Test Contract #1",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"timezone": "Africa/Johannesburg",
"contract_start": "2025-01-01T12:00:00.000Z",
"contract_term_count": 10,
"contract_term_unit": "day",
"payment_term_count": 1,
"payment_term_unit": "day",
"payment_term_strategy": "end-of-day",
"line_items_once_off": [
{
"quantity": 1,
"description": "Product #1",
"unit_value": 50,
"discount_percent": 0,
"item_code": null,
"receivable_account_code": "XXX",
"sales_account_code": "XXX"
}
],
"line_items_recurring": [
{
"quantity": 1,
"description": "Product #2",
"unit_value": 100,
"discount_percent": 0,
"item_code": null,
"receivable_account_code": "XXX",
"sales_account_code": "XXX"
}
],
"renewable": 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 |
|---|---|---|---|
| contract_end | body | string | Contract End. |
| contract_start | body | string | Contract Start. |
| contract_term_count | body | integer | Contract Term Count. |
| contract_term_unit | body | string | Contract Term Unit. |
| created | body | string | Created. |
| customer_account_id | body | string | Customer Account Id. |
| legal_entity_id | body | string | Legal Entity Id. |
| line_item.date | body | string | Line Item Date. |
| line_item.description | body | string | Line Item Description. |
| line_item.discount_percent | body | decimal | Line Item Discount Percent. |
| line_item.discount_total | body | decimal | Line Item Discount Total. |
| line_item.document_id | body | string | Line Item Document Id. |
| line_item.excluding | body | decimal | Line Item Excluding. |
| line_item.excluding_total | body | decimal | Line Item Excluding Total. |
| line_item.id | body | string | Line Item Id. |
| line_item.including | body | decimal | Line Item Including. |
| line_item.including_total | body | decimal | Line Item Including Total. |
| line_item.item_code | body | string | Line Item Item Code. |
| line_item.payable_account_code | body | string | Line Item Payable Account Code. |
| line_item.payable_account_id | body | string | Line Item Payable Account Id. |
| line_item.quantity | body | integer | Line Item Quantity. |
| line_item.receivable_account_code | body | string | Line Item Receivable Account Code. |
| line_item.receivable_account_id | body | string | Line Item Receivable Account Id. |
| line_item.sales_account_code | body | string | Line Item Sales Account Code. |
| line_item.sales_account_id | body | string | Line Item Sales Account Id. |
| line_item.sales_tax_account_code | body | string | Line Item Sales Tax Account Code. |
| line_item.sales_tax_account_id | body | string | Line Item Sales Tax Account Id. |
| line_item.sales_tax_code | body | string | Line Item Sales Tax Code. |
| line_item.tax_percent | body | decimal | Line Item Tax Percent. |
| line_item.unit_value | body | decimal | Line Item Unit Value. |
| line_items_once_off | body | array | Line Items Once Off. |
| line_items_recurring | body | array | Line Items Recurring. |
| metadata | body | object | Metadata. |
| name | body | string | Name of Entity. |
| payment_term_count | body | integer | Payment Term Count. |
| payment_term_strategy | body | string | Payment Term Strategy. |
| payment_term_unit | body | string | Payment Term Unit. |
| renewable | body | boolean | Renewable. |
| timezone | body | string | Timezone. |
| updated | body | string | Updated. |
Response Example
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "interstellio.io",
"contract_number": "C-28",
"name": "Contract #3",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"created": "2025-03-12T06:24:44.325Z",
"updated": "2025-03-12T06:24:44.325Z",
"renewed": null,
"expired": null,
"cancelled": null,
"contract_term_count": 10,
"contract_term_unit": "day",
"contract_start": "2025-03-12T06:30:00.000Z",
"contract_end": "2025-03-22T06:30:00.000Z",
"payment_term_count": "1",
"payment_term_unit": "day",
"payment_term_strategy": "end-of-day",
"renewable": false,
"timezone": "Africa/Johannesburg",
"metadata": {
"invoices": []
},
"line_items_once_off": [
{
"line_item_type": "once_off",
"item_code": null,
"description": "Product",
"quantity": 1,
"unit_value": "50.00",
"excluding": "50.00",
"including": "50.00",
"excluding_total": "50.00",
"including_total": "50.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "0.00",
"sales_tax_code": null,
"sales_tax_account_id": null,
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": null,
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
}
],
"line_items_recurring": [
{
"line_item_type": "recurring",
"item_code": null,
"description": "Product",
"quantity": 1,
"unit_value": "50.00",
"excluding": "50.00",
"including": "50.00",
"excluding_total": "50.00",
"including_total": "50.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "0.00",
"sales_tax_code": null,
"sales_tax_account_id": null,
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": null,
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
}
]
}POST
/v1/contract/{contract_id}/renew(billing)
Renew Single Contract
Service
billing
billing
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) | |
| contract_id | url | string | Contract 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 |
POST
/v1/contract/{contract_id}/cancel(billing)
Cancel Single Contract
Service
billing
billing
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) | |
| contract_id | url | string | Contract 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 |