Latinum Document API Resources
GET
/v2/document/invoice/pdf(billing)
Get Invoice PDF
Service
billing
billing
Accepted Roles (RBAC)
AdministratorBilling AccountantBilling AdministratorCustomerStaff MemberSupportRequest 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) | |
| document_number | query | string | Document Number. | X |
| legal_entity_id | query | string | Legal Entity Id. | X |
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 |
GET
/v2/document/invoice/docnum/{document_number}(billing)
Get Invoice By Document Number
Service
billing
billing
Accepted Roles (RBAC)
AdministratorBilling AccountantBilling AdministratorCustomerStaff MemberSupportRequest 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) | |
| document_number | url | string | Document Number. | 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 |
|---|---|---|---|
| customer_account_id | body | string | Customer Account Id. |
| date | body | string | Date. |
| document_number | body | string | Document Number. |
| domain | body | string | Entity Domain. |
| id | body | string | Unique Entity 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 | body | array | Line Items. |
| metadata | body | object | Metadata. |
| metadata.currency_symbol | body | string | Metadata Currency Symbol. |
| metadata.customer_account_code | body | string | Metadata Customer Account Code. |
| metadata.customer_address_country | body | string | Metadata Customer Address Country. |
| metadata.customer_address_line1 | body | string | Metadata Customer Address Line1. |
| metadata.customer_address_line2 | body | string | Metadata Customer Address Line2. |
| metadata.customer_address_line3 | body | string | Metadata Customer Address Line3. |
| metadata.customer_address_line4 | body | string | Metadata Customer Address Line4. |
| metadata.customer_address_postal_code | body | string | Metadata Customer Address Postal Code. |
| metadata.customer_address_state | body | string | Metadata Customer Address State. |
| metadata.customer_address_type | body | string | Metadata Customer Address Type. |
| metadata.customer_email | body | string | Metadata Customer Email. |
| metadata.customer_name | body | string | Metadata Customer Name. |
| metadata.customer_phone_no | body | string | Metadata Customer Phone No. |
| metadata.customer_reg_no | body | string | Metadata Customer Reg No. |
| metadata.customer_sales_tax_reg_no | body | string | Metadata Customer Sales Tax Reg No. |
| metadata.customer_type | body | string | Metadata Customer Type. |
| metadata.discount_total | body | decimal | Metadata Discount Total. |
| metadata.excluding_total | body | decimal | Metadata Excluding Total. |
| metadata.including_total | body | decimal | Metadata Including Total. |
| metadata.legal_entity_address | body | string | Metadata Legal Entity Address. |
| metadata.legal_entity_email | body | string | Metadata Legal Entity Email. |
| metadata.legal_entity_name | body | string | Metadata Legal Entity Name. |
| metadata.legal_entity_phone_no | body | string | Metadata Legal Entity Phone No. |
| metadata.legal_entity_reg_no | body | string | Metadata Legal Entity Reg No. |
| metadata.legal_entity_sales_tax_reg_no | body | string | Metadata Legal Entity Sales Tax Reg No. |
| metadata.legal_entity_timezone | body | string | Metadata Legal Entity Timezone. |
| metadata.legal_entity_website | body | string | Metadata Legal Entity Website. |
| metadata.tax_total | body | decimal | Metadata Tax Total. |
| status | body | string | Status. |
| supplier_account_id | body | string | Supplier Account Id. |
| type | body | string | Type. |
Response Example
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "domain.com",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"supplier_account_id": null,
"document_number": "INV-1",
"date": "2020-01-01T12:00:00.000Z",
"type": "INVOICE",
"status": "PROCESSED",
"metadata": {
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"tax_total": "12.91",
"legal_entity_timezone": "Africa/Johannesburg",
"legal_entity_name": "XXX",
"legal_entity_email": "user@domain.com",
"legal_entity_phone_no": "0123456789",
"legal_entity_website": "domain.com",
"legal_entity_address": "123 Street Road, Suburb, City",
"legal_entity_sales_tax_reg_no": "XXX",
"legal_entity_reg_no": "XXX",
"customer_type": "INDIVIDUAL",
"customer_account_code": "XXXX-XXXX-XXXX",
"customer_reg_no": null,
"customer_sales_tax_reg_no": null,
"customer_name": "XXX",
"customer_phone_no": null,
"customer_email": "user@domain.com",
"customer_address_type": "PHYSICAL",
"customer_address_line1": "123 Street Road",
"customer_address_line2": "Suburb",
"customer_address_line3": "City",
"customer_address_line4": null,
"customer_address_state": "Gauteng",
"customer_address_country": "ZA",
"customer_address_postal_code": "0000",
"currency_symbol": "R"
},
"line_items": [
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"document_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"date": "2020-01-01T12:00:00.000Z",
"item_code": null,
"description": "XXX",
"quantity": 1,
"unit_value": "86.09",
"excluding": "86.09",
"including": "99.00",
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "15.00",
"sales_tax_code": null,
"sales_tax_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_tax_account_code": "XXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX",
"payable_account_code": "XXX"
}
]
}GET
/v2/document/invoice/id/{document_id}(billing)
Get Invoice By ID
Service
billing
billing
Accepted Roles (RBAC)
AdministratorBilling AccountantBilling AdministratorCustomerStaff MemberSupportRequest 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) | |
| document_id | url | string | Document 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 |
|---|---|---|---|
| customer_account_id | body | string | Customer Account Id. |
| date | body | string | Date. |
| document_number | body | string | Document Number. |
| domain | body | string | Entity Domain. |
| id | body | string | Unique Entity 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 | body | array | Line Items. |
| metadata | body | object | Metadata. |
| metadata.currency_symbol | body | string | Metadata Currency Symbol. |
| metadata.customer_account_code | body | string | Metadata Customer Account Code. |
| metadata.customer_address_country | body | string | Metadata Customer Address Country. |
| metadata.customer_address_line1 | body | string | Metadata Customer Address Line1. |
| metadata.customer_address_line2 | body | string | Metadata Customer Address Line2. |
| metadata.customer_address_line3 | body | string | Metadata Customer Address Line3. |
| metadata.customer_address_line4 | body | string | Metadata Customer Address Line4. |
| metadata.customer_address_postal_code | body | string | Metadata Customer Address Postal Code. |
| metadata.customer_address_state | body | string | Metadata Customer Address State. |
| metadata.customer_address_type | body | string | Metadata Customer Address Type. |
| metadata.customer_email | body | string | Metadata Customer Email. |
| metadata.customer_name | body | string | Metadata Customer Name. |
| metadata.customer_phone_no | body | string | Metadata Customer Phone No. |
| metadata.customer_reg_no | body | string | Metadata Customer Reg No. |
| metadata.customer_sales_tax_reg_no | body | string | Metadata Customer Sales Tax Reg No. |
| metadata.customer_type | body | string | Metadata Customer Type. |
| metadata.discount_total | body | decimal | Metadata Discount Total. |
| metadata.excluding_total | body | decimal | Metadata Excluding Total. |
| metadata.including_total | body | decimal | Metadata Including Total. |
| metadata.legal_entity_address | body | string | Metadata Legal Entity Address. |
| metadata.legal_entity_email | body | string | Metadata Legal Entity Email. |
| metadata.legal_entity_name | body | string | Metadata Legal Entity Name. |
| metadata.legal_entity_phone_no | body | string | Metadata Legal Entity Phone No. |
| metadata.legal_entity_reg_no | body | string | Metadata Legal Entity Reg No. |
| metadata.legal_entity_sales_tax_reg_no | body | string | Metadata Legal Entity Sales Tax Reg No. |
| metadata.legal_entity_timezone | body | string | Metadata Legal Entity Timezone. |
| metadata.legal_entity_website | body | string | Metadata Legal Entity Website. |
| metadata.tax_total | body | decimal | Metadata Tax Total. |
| status | body | string | Status. |
| supplier_account_id | body | string | Supplier Account Id. |
| type | body | string | Type. |
Response Example
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "domain.com",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"supplier_account_id": null,
"document_number": "INV-1",
"date": "2020-01-01T12:00:00.000Z",
"type": "INVOICE",
"status": "PROCESSED",
"metadata": {
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"tax_total": "12.91",
"legal_entity_timezone": "Africa/Johannesburg",
"legal_entity_name": "XXX",
"legal_entity_email": "user@domain.com",
"legal_entity_phone_no": "0123456789",
"legal_entity_website": "domain.com",
"legal_entity_address": "123 Street Road, Suburb, City",
"legal_entity_sales_tax_reg_no": "XXX",
"legal_entity_reg_no": "XXX",
"customer_type": "INDIVIDUAL",
"customer_account_code": "XXXX-XXXX-XXXX",
"customer_reg_no": null,
"customer_sales_tax_reg_no": null,
"customer_name": "XXX",
"customer_phone_no": null,
"customer_email": "user@domain.com",
"customer_address_type": "PHYSICAL",
"customer_address_line1": "123 Street Road",
"customer_address_line2": "Suburb",
"customer_address_line3": "City",
"customer_address_line4": null,
"customer_address_state": "Gauteng",
"customer_address_country": "ZA",
"customer_address_postal_code": "0000",
"currency_symbol": "R"
},
"line_items": [
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"document_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"date": "2020-01-01T12:00:00.000Z",
"item_code": null,
"description": "XXX",
"quantity": 1,
"unit_value": "86.09",
"excluding": "86.09",
"including": "99.00",
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "15.00",
"sales_tax_code": null,
"sales_tax_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_tax_account_code": "XXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX",
"payable_account_code": "XXX"
}
]
}GET
/v2/document/invoice/all(billing)
Get All Invoices
Service
billing
billing
Returns a list of invoices within the specified range. This resource is limited to respond with a maximum of 250 invoices. If a greater number of invoices is desired, it is recommended to use the /v2/report/document/invoice/csv resource.
If the "month" query parameter is provided, the "range_start" and "range_end" query parameters need not be included. If the "legal_entity_id" query parameter is not provided, all Legal Entities within the requesting domain will be queried. If the "customer_Account_id" query parameter is not provided, all Customer Accounts will be queried.
Accepted Roles (RBAC)
AdministratorBilling AccountantBilling AdministratorCustomerStaff MemberSupportRequest 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 | Customer Account Id. | |
| legal_entity_id | query | string | Legal Entity Id. | |
| month | query | string | Month. | |
| range_end | query | string | Range End. | X |
| range_start | query | string | Range Start. | X |
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 |
|---|---|---|---|
| customer_account_id | body | string | Customer Account Id. |
| date | body | string | Date. |
| document_number | body | string | Document Number. |
| domain | body | string | Entity Domain. |
| id | body | string | Unique Entity 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 | body | array | Line Items. |
| metadata | body | object | Metadata. |
| metadata.currency_symbol | body | string | Metadata Currency Symbol. |
| metadata.customer_account_code | body | string | Metadata Customer Account Code. |
| metadata.customer_address_country | body | string | Metadata Customer Address Country. |
| metadata.customer_address_line1 | body | string | Metadata Customer Address Line1. |
| metadata.customer_address_line2 | body | string | Metadata Customer Address Line2. |
| metadata.customer_address_line3 | body | string | Metadata Customer Address Line3. |
| metadata.customer_address_line4 | body | string | Metadata Customer Address Line4. |
| metadata.customer_address_postal_code | body | string | Metadata Customer Address Postal Code. |
| metadata.customer_address_state | body | string | Metadata Customer Address State. |
| metadata.customer_address_type | body | string | Metadata Customer Address Type. |
| metadata.customer_email | body | string | Metadata Customer Email. |
| metadata.customer_name | body | string | Metadata Customer Name. |
| metadata.customer_phone_no | body | string | Metadata Customer Phone No. |
| metadata.customer_reg_no | body | string | Metadata Customer Reg No. |
| metadata.customer_sales_tax_reg_no | body | string | Metadata Customer Sales Tax Reg No. |
| metadata.customer_type | body | string | Metadata Customer Type. |
| metadata.discount_total | body | decimal | Metadata Discount Total. |
| metadata.excluding_total | body | decimal | Metadata Excluding Total. |
| metadata.including_total | body | decimal | Metadata Including Total. |
| metadata.legal_entity_address | body | string | Metadata Legal Entity Address. |
| metadata.legal_entity_email | body | string | Metadata Legal Entity Email. |
| metadata.legal_entity_name | body | string | Metadata Legal Entity Name. |
| metadata.legal_entity_phone_no | body | string | Metadata Legal Entity Phone No. |
| metadata.legal_entity_reg_no | body | string | Metadata Legal Entity Reg No. |
| metadata.legal_entity_sales_tax_reg_no | body | string | Metadata Legal Entity Sales Tax Reg No. |
| metadata.legal_entity_timezone | body | string | Metadata Legal Entity Timezone. |
| metadata.legal_entity_website | body | string | Metadata Legal Entity Website. |
| metadata.tax_total | body | decimal | Metadata Tax Total. |
| status | body | string | Status. |
| supplier_account_id | body | string | Supplier Account Id. |
| type | body | string | Type. |
Response Example
[
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "domain.com",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"supplier_account_id": null,
"document_number": "INV-1",
"date": "2020-01-01T12:00:00.000Z",
"type": "INVOICE",
"status": "PROCESSED",
"metadata": {
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"tax_total": "12.91",
"legal_entity_timezone": "Africa/Johannesburg",
"legal_entity_name": "XXX",
"legal_entity_email": "user@domain.com",
"legal_entity_phone_no": "0123456789",
"legal_entity_website": "domain.com",
"legal_entity_address": "123 Street Road, Suburb, City",
"legal_entity_sales_tax_reg_no": "XXX",
"legal_entity_reg_no": "XXX",
"customer_type": "INDIVIDUAL",
"customer_account_code": "XXXX-XXXX-XXXX",
"customer_reg_no": null,
"customer_sales_tax_reg_no": null,
"customer_name": "XXX",
"customer_phone_no": null,
"customer_email": "user@domain.com",
"customer_address_type": "PHYSICAL",
"customer_address_line1": "123 Street Road",
"customer_address_line2": "Suburb",
"customer_address_line3": "City",
"customer_address_line4": null,
"customer_address_state": "Gauteng",
"customer_address_country": "ZA",
"customer_address_postal_code": "0000",
"currency_symbol": "R"
},
"line_items": [
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"document_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"date": "2020-01-01T12:00:00.000Z",
"item_code": null,
"description": "XXX",
"quantity": 1,
"unit_value": "86.09",
"excluding": "86.09",
"including": "99.00",
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "15.00",
"sales_tax_code": null,
"sales_tax_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_tax_account_code": "XXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX",
"payable_account_code": "XXX"
}
]
},
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "domain.com",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"supplier_account_id": null,
"document_number": "INV-2",
"date": "2020-01-02T12:00:00.000Z",
"type": "INVOICE",
"status": "PROCESSED",
"metadata": {
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"tax_total": "12.91",
"legal_entity_timezone": "Africa/Johannesburg",
"legal_entity_name": "XXX",
"legal_entity_email": "user@domain.com",
"legal_entity_phone_no": "0123456789",
"legal_entity_website": "domain.com",
"legal_entity_address": "123 Street Road, Suburb, City",
"legal_entity_sales_tax_reg_no": "XXX",
"legal_entity_reg_no": "XXX",
"customer_type": "INDIVIDUAL",
"customer_account_code": "XXXX-XXXX-XXXX",
"customer_reg_no": null,
"customer_sales_tax_reg_no": null,
"customer_name": "XXX",
"customer_phone_no": null,
"customer_email": "user@domain.com",
"customer_address_type": "PHYSICAL",
"customer_address_line1": "123 Street Road",
"customer_address_line2": "Suburb",
"customer_address_line3": "City",
"customer_address_line4": null,
"customer_address_state": "Gauteng",
"customer_address_country": "ZA",
"customer_address_postal_code": "0000",
"currency_symbol": "R"
},
"line_items": [
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"document_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"date": "2020-01-02T12:00:00.000Z",
"item_code": null,
"description": "XXX",
"quantity": 1,
"unit_value": "86.09",
"excluding": "86.09",
"including": "99.00",
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "15.00",
"sales_tax_code": null,
"sales_tax_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_tax_account_code": "XXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX",
"payable_account_code": "XXX"
}
]
}
]POST
/v2/document/invoice(billing)
Create Invoice
Service
billing
billing
Multiple invoices can be created with a single request. Simply include the invoice objects in the "invoice" parameter.
Either account codes or account IDs can be provided for each line item, if both are provided the IDs will be used by default.
Accepted Roles (RBAC)
AdministratorBilling AccountantBilling AdministratorRequest 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) | |
| invoice.customer_account_id | body | string | Invoice Customer Account Id. | |
| invoice.date | body | string | Invoice Date. | |
| invoice.line_items | body | array | Invoice Line Items. | |
| invoices | body | array | Invoices. | |
| legal_entity_id | body | string | Legal Entity Id. | |
| line_item.description | body | string | Line Item Description. | |
| 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. | |
| 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. |
Request Example
{
"legal_entity_id":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"invoices":
[
{
"date":"2024-01-01T12:00:00+02:00",
"customer_account_id":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"line_items":
[
{
"quantity":1,
"description":"XXX",
"unit_value":50,
"discount_percent":0,
"tax_percent": 0,
"item_code": "XXX",
"sales_tax_code": "XXX",
"receivable_account_code": "XXX",
"sales_account_code":"XXX",
"payable_account_code":"XXX",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_id":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
}
]
}
]
}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 |
|---|---|---|---|
| customer_account_id | body | string | Customer Account Id. |
| date | body | string | Date. |
| document_number | body | string | Document Number. |
| domain | body | string | Entity Domain. |
| id | body | string | Unique Entity 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 | body | array | Line Items. |
| metadata | body | object | Metadata. |
| metadata.currency_symbol | body | string | Metadata Currency Symbol. |
| metadata.customer_account_code | body | string | Metadata Customer Account Code. |
| metadata.customer_address_country | body | string | Metadata Customer Address Country. |
| metadata.customer_address_line1 | body | string | Metadata Customer Address Line1. |
| metadata.customer_address_line2 | body | string | Metadata Customer Address Line2. |
| metadata.customer_address_line3 | body | string | Metadata Customer Address Line3. |
| metadata.customer_address_line4 | body | string | Metadata Customer Address Line4. |
| metadata.customer_address_postal_code | body | string | Metadata Customer Address Postal Code. |
| metadata.customer_address_state | body | string | Metadata Customer Address State. |
| metadata.customer_address_type | body | string | Metadata Customer Address Type. |
| metadata.customer_email | body | string | Metadata Customer Email. |
| metadata.customer_name | body | string | Metadata Customer Name. |
| metadata.customer_phone_no | body | string | Metadata Customer Phone No. |
| metadata.customer_reg_no | body | string | Metadata Customer Reg No. |
| metadata.customer_sales_tax_reg_no | body | string | Metadata Customer Sales Tax Reg No. |
| metadata.customer_type | body | string | Metadata Customer Type. |
| metadata.discount_total | body | decimal | Metadata Discount Total. |
| metadata.excluding_total | body | decimal | Metadata Excluding Total. |
| metadata.including_total | body | decimal | Metadata Including Total. |
| metadata.legal_entity_address | body | string | Metadata Legal Entity Address. |
| metadata.legal_entity_email | body | string | Metadata Legal Entity Email. |
| metadata.legal_entity_name | body | string | Metadata Legal Entity Name. |
| metadata.legal_entity_phone_no | body | string | Metadata Legal Entity Phone No. |
| metadata.legal_entity_reg_no | body | string | Metadata Legal Entity Reg No. |
| metadata.legal_entity_sales_tax_reg_no | body | string | Metadata Legal Entity Sales Tax Reg No. |
| metadata.legal_entity_timezone | body | string | Metadata Legal Entity Timezone. |
| metadata.legal_entity_website | body | string | Metadata Legal Entity Website. |
| metadata.tax_total | body | decimal | Metadata Tax Total. |
| status | body | string | Status. |
| supplier_account_id | body | string | Supplier Account Id. |
| type | body | string | Type. |
Response Example
[
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "domain.com",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"supplier_account_id": null,
"document_number": null,
"date": "2024-01-01T12:00:00.000Z",
"type": "INVOICE",
"status": "UNPROCESSED",
"metadata": {
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"tax_total": "12.91",
"legal_entity_timezone": "Africa/Johannesburg",
"legal_entity_name": "XXX",
"legal_entity_email": "user@domain.com",
"legal_entity_phone_no": "0123456789",
"legal_entity_website": "domain.com",
"legal_entity_address": "123 Street Road, Suburb, City",
"legal_entity_sales_tax_reg_no": "XXX",
"legal_entity_reg_no": "XXX",
"customer_type": "INDIVIDUAL",
"customer_account_code": "XXXX-XXXX-XXXX",
"customer_reg_no": null,
"customer_sales_tax_reg_no": null,
"customer_name": "XXX",
"customer_phone_no": null,
"customer_email": "user@domain.com",
"customer_address_type": "PHYSICAL",
"customer_address_line1": "123 Street Road",
"customer_address_line2": "Suburb",
"customer_address_line3": "City",
"customer_address_line4": null,
"customer_address_state": "Gauteng",
"customer_address_country": "ZA",
"customer_address_postal_code": "0000",
"currency_symbol": "R"
},
"line_items": [
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"document_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"date": "2024-01-01T12:00:00.000Z",
"item_code": null,
"description": "XXX",
"quantity": 1,
"unit_value": "86.09",
"excluding": "86.09",
"including": "99.00",
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "15.00",
"sales_tax_code": "XXX",
"sales_tax_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_tax_account_code": "XXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX",
"payable_account_code": "XXX"
}
]
}
]GET
/v2/document/creditnote/pdf(billing)
Get Credit Note PDF
Service
billing
billing
Accepted Roles (RBAC)
AdministratorBilling AccountantBilling AdministratorCustomerStaff MemberSupportRequest 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) | |
| document_number | query | string | Document Number. | X |
| legal_entity_id | query | string | Legal Entity Id. | X |
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 |
GET
/v2/document/creditnote/docnum/{document_number}(billing)
Get Credit Note By Document Number
Service
billing
billing
Accepted Roles (RBAC)
AdministratorBilling AccountantBilling AdministratorCustomerStaff MemberSupportRequest 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) | |
| document_number | url | string | Document Number. | 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 |
|---|---|---|---|
| customer_account_id | body | string | Customer Account Id. |
| date | body | string | Date. |
| document_number | body | string | Document Number. |
| domain | body | string | Entity Domain. |
| id | body | string | Unique Entity 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 | body | array | Line Items. |
| metadata | body | object | Metadata. |
| metadata.currency_symbol | body | string | Metadata Currency Symbol. |
| metadata.customer_account_code | body | string | Metadata Customer Account Code. |
| metadata.customer_address_country | body | string | Metadata Customer Address Country. |
| metadata.customer_address_line1 | body | string | Metadata Customer Address Line1. |
| metadata.customer_address_line2 | body | string | Metadata Customer Address Line2. |
| metadata.customer_address_line3 | body | string | Metadata Customer Address Line3. |
| metadata.customer_address_line4 | body | string | Metadata Customer Address Line4. |
| metadata.customer_address_postal_code | body | string | Metadata Customer Address Postal Code. |
| metadata.customer_address_state | body | string | Metadata Customer Address State. |
| metadata.customer_address_type | body | string | Metadata Customer Address Type. |
| metadata.customer_email | body | string | Metadata Customer Email. |
| metadata.customer_name | body | string | Metadata Customer Name. |
| metadata.customer_phone_no | body | string | Metadata Customer Phone No. |
| metadata.customer_reg_no | body | string | Metadata Customer Reg No. |
| metadata.customer_sales_tax_reg_no | body | string | Metadata Customer Sales Tax Reg No. |
| metadata.customer_type | body | string | Metadata Customer Type. |
| metadata.discount_total | body | decimal | Metadata Discount Total. |
| metadata.excluding_total | body | decimal | Metadata Excluding Total. |
| metadata.including_total | body | decimal | Metadata Including Total. |
| metadata.legal_entity_address | body | string | Metadata Legal Entity Address. |
| metadata.legal_entity_email | body | string | Metadata Legal Entity Email. |
| metadata.legal_entity_name | body | string | Metadata Legal Entity Name. |
| metadata.legal_entity_phone_no | body | string | Metadata Legal Entity Phone No. |
| metadata.legal_entity_reg_no | body | string | Metadata Legal Entity Reg No. |
| metadata.legal_entity_sales_tax_reg_no | body | string | Metadata Legal Entity Sales Tax Reg No. |
| metadata.legal_entity_timezone | body | string | Metadata Legal Entity Timezone. |
| metadata.legal_entity_website | body | string | Metadata Legal Entity Website. |
| metadata.tax_total | body | decimal | Metadata Tax Total. |
| status | body | string | Status. |
| supplier_account_id | body | string | Supplier Account Id. |
| type | body | string | Type. |
Response Example
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "domain.com",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"supplier_account_id": null,
"document_number": "INV-1",
"date": "2020-01-01T12:00:00.000Z",
"type": "CREDIT_NOTE",
"status": "PROCESSED",
"metadata": {
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"tax_total": "12.91",
"legal_entity_timezone": "Africa/Johannesburg",
"legal_entity_name": "XXX",
"legal_entity_email": "user@domain.com",
"legal_entity_phone_no": "0123456789",
"legal_entity_website": "domain.com",
"legal_entity_address": "123 Street Road, Suburb, City",
"legal_entity_sales_tax_reg_no": "XXX",
"legal_entity_reg_no": "XXX",
"customer_type": "INDIVIDUAL",
"customer_account_code": "XXXX-XXXX-XXXX",
"customer_reg_no": null,
"customer_sales_tax_reg_no": null,
"customer_name": "XXX",
"customer_phone_no": null,
"customer_email": "user@domain.com",
"customer_address_type": "PHYSICAL",
"customer_address_line1": "123 Street Road",
"customer_address_line2": "Suburb",
"customer_address_line3": "City",
"customer_address_line4": null,
"customer_address_state": "Gauteng",
"customer_address_country": "ZA",
"customer_address_postal_code": "0000",
"currency_symbol": "R"
},
"line_items": [
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"document_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"date": "2020-01-01T12:00:00.000Z",
"item_code": null,
"description": "XXX",
"quantity": 1,
"unit_value": "86.09",
"excluding": "86.09",
"including": "99.00",
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "15.00",
"sales_tax_code": null,
"sales_tax_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_tax_account_code": "XXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX",
"payable_account_code": "XXX"
}
]
}GET
/v2/document/creditnote/id/{document_id}(billing)
Get Credit Note By ID
Service
billing
billing
Accepted Roles (RBAC)
AdministratorBilling AccountantBilling AdministratorCustomerStaff MemberSupportRequest 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) | |
| document_id | url | string | Document 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 |
|---|---|---|---|
| customer_account_id | body | string | Customer Account Id. |
| date | body | string | Date. |
| document_number | body | string | Document Number. |
| domain | body | string | Entity Domain. |
| id | body | string | Unique Entity 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 | body | array | Line Items. |
| metadata | body | object | Metadata. |
| metadata.currency_symbol | body | string | Metadata Currency Symbol. |
| metadata.customer_account_code | body | string | Metadata Customer Account Code. |
| metadata.customer_address_country | body | string | Metadata Customer Address Country. |
| metadata.customer_address_line1 | body | string | Metadata Customer Address Line1. |
| metadata.customer_address_line2 | body | string | Metadata Customer Address Line2. |
| metadata.customer_address_line3 | body | string | Metadata Customer Address Line3. |
| metadata.customer_address_line4 | body | string | Metadata Customer Address Line4. |
| metadata.customer_address_postal_code | body | string | Metadata Customer Address Postal Code. |
| metadata.customer_address_state | body | string | Metadata Customer Address State. |
| metadata.customer_address_type | body | string | Metadata Customer Address Type. |
| metadata.customer_email | body | string | Metadata Customer Email. |
| metadata.customer_name | body | string | Metadata Customer Name. |
| metadata.customer_phone_no | body | string | Metadata Customer Phone No. |
| metadata.customer_reg_no | body | string | Metadata Customer Reg No. |
| metadata.customer_sales_tax_reg_no | body | string | Metadata Customer Sales Tax Reg No. |
| metadata.customer_type | body | string | Metadata Customer Type. |
| metadata.discount_total | body | decimal | Metadata Discount Total. |
| metadata.excluding_total | body | decimal | Metadata Excluding Total. |
| metadata.including_total | body | decimal | Metadata Including Total. |
| metadata.legal_entity_address | body | string | Metadata Legal Entity Address. |
| metadata.legal_entity_email | body | string | Metadata Legal Entity Email. |
| metadata.legal_entity_name | body | string | Metadata Legal Entity Name. |
| metadata.legal_entity_phone_no | body | string | Metadata Legal Entity Phone No. |
| metadata.legal_entity_reg_no | body | string | Metadata Legal Entity Reg No. |
| metadata.legal_entity_sales_tax_reg_no | body | string | Metadata Legal Entity Sales Tax Reg No. |
| metadata.legal_entity_timezone | body | string | Metadata Legal Entity Timezone. |
| metadata.legal_entity_website | body | string | Metadata Legal Entity Website. |
| metadata.tax_total | body | decimal | Metadata Tax Total. |
| status | body | string | Status. |
| supplier_account_id | body | string | Supplier Account Id. |
| type | body | string | Type. |
Response Example
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "domain.com",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"supplier_account_id": null,
"document_number": "INV-1",
"date": "2020-01-01T12:00:00.000Z",
"type": "CREDIT_NOTE",
"status": "PROCESSED",
"metadata": {
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"tax_total": "12.91",
"legal_entity_timezone": "Africa/Johannesburg",
"legal_entity_name": "XXX",
"legal_entity_email": "user@domain.com",
"legal_entity_phone_no": "0123456789",
"legal_entity_website": "domain.com",
"legal_entity_address": "123 Street Road, Suburb, City",
"legal_entity_sales_tax_reg_no": "XXX",
"legal_entity_reg_no": "XXX",
"customer_type": "INDIVIDUAL",
"customer_account_code": "XXXX-XXXX-XXXX",
"customer_reg_no": null,
"customer_sales_tax_reg_no": null,
"customer_name": "XXX",
"customer_phone_no": null,
"customer_email": "user@domain.com",
"customer_address_type": "PHYSICAL",
"customer_address_line1": "123 Street Road",
"customer_address_line2": "Suburb",
"customer_address_line3": "City",
"customer_address_line4": null,
"customer_address_state": "Gauteng",
"customer_address_country": "ZA",
"customer_address_postal_code": "0000",
"currency_symbol": "R"
},
"line_items": [
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"document_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"date": "2020-01-01T12:00:00.000Z",
"item_code": null,
"description": "XXX",
"quantity": 1,
"unit_value": "86.09",
"excluding": "86.09",
"including": "99.00",
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "15.00",
"sales_tax_code": null,
"sales_tax_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_tax_account_code": "XXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX",
"payable_account_code": "XXX"
}
]
}GET
/v2/document/creditnote/all(billing)
Get All Credit Notes
Service
billing
billing
Returns a list of credit notes within the specified range. This resource is limited to respond with a maximum of 250 credit notes. If a greater number of credit notes is desired, it is recommended to use the /v2/report/document/creditnote/csv resource.
If the "month" query parameter is provided, the "range_start" and "range_end" query parameters need not be included. If the "legal_entity_id" query parameter is not provided, all Legal Entities within the requesting domain will be queried. If the "customer_Account_id" query parameter is not provided, all Customer Accounts will be queried.
Accepted Roles (RBAC)
AdministratorBilling AccountantBilling AdministratorCustomerStaff MemberSupportRequest 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 | Customer Account Id. | |
| legal_entity_id | query | string | Legal Entity Id. | |
| month | query | string | Month. | |
| range_end | query | string | Range End. | X |
| range_start | query | string | Range Start. | X |
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 |
|---|---|---|---|
| customer_account_id | body | string | Customer Account Id. |
| date | body | string | Date. |
| document_number | body | string | Document Number. |
| domain | body | string | Entity Domain. |
| id | body | string | Unique Entity 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 | body | array | Line Items. |
| metadata | body | object | Metadata. |
| metadata.currency_symbol | body | string | Metadata Currency Symbol. |
| metadata.customer_account_code | body | string | Metadata Customer Account Code. |
| metadata.customer_address_country | body | string | Metadata Customer Address Country. |
| metadata.customer_address_line1 | body | string | Metadata Customer Address Line1. |
| metadata.customer_address_line2 | body | string | Metadata Customer Address Line2. |
| metadata.customer_address_line3 | body | string | Metadata Customer Address Line3. |
| metadata.customer_address_line4 | body | string | Metadata Customer Address Line4. |
| metadata.customer_address_postal_code | body | string | Metadata Customer Address Postal Code. |
| metadata.customer_address_state | body | string | Metadata Customer Address State. |
| metadata.customer_address_type | body | string | Metadata Customer Address Type. |
| metadata.customer_email | body | string | Metadata Customer Email. |
| metadata.customer_name | body | string | Metadata Customer Name. |
| metadata.customer_phone_no | body | string | Metadata Customer Phone No. |
| metadata.customer_reg_no | body | string | Metadata Customer Reg No. |
| metadata.customer_sales_tax_reg_no | body | string | Metadata Customer Sales Tax Reg No. |
| metadata.customer_type | body | string | Metadata Customer Type. |
| metadata.discount_total | body | decimal | Metadata Discount Total. |
| metadata.excluding_total | body | decimal | Metadata Excluding Total. |
| metadata.including_total | body | decimal | Metadata Including Total. |
| metadata.legal_entity_address | body | string | Metadata Legal Entity Address. |
| metadata.legal_entity_email | body | string | Metadata Legal Entity Email. |
| metadata.legal_entity_name | body | string | Metadata Legal Entity Name. |
| metadata.legal_entity_phone_no | body | string | Metadata Legal Entity Phone No. |
| metadata.legal_entity_reg_no | body | string | Metadata Legal Entity Reg No. |
| metadata.legal_entity_sales_tax_reg_no | body | string | Metadata Legal Entity Sales Tax Reg No. |
| metadata.legal_entity_timezone | body | string | Metadata Legal Entity Timezone. |
| metadata.legal_entity_website | body | string | Metadata Legal Entity Website. |
| metadata.tax_total | body | decimal | Metadata Tax Total. |
| status | body | string | Status. |
| supplier_account_id | body | string | Supplier Account Id. |
| type | body | string | Type. |
Response Example
[
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "domain.com",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"supplier_account_id": null,
"document_number": "INV-1",
"date": "2020-01-01T12:00:00.000Z",
"type": "CREDIT_NOTE",
"status": "PROCESSED",
"metadata": {
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"tax_total": "12.91",
"legal_entity_timezone": "Africa/Johannesburg",
"legal_entity_name": "XXX",
"legal_entity_email": "user@domain.com",
"legal_entity_phone_no": "0123456789",
"legal_entity_website": "domain.com",
"legal_entity_address": "123 Street Road, Suburb, City",
"legal_entity_sales_tax_reg_no": "XXX",
"legal_entity_reg_no": "XXX",
"customer_type": "INDIVIDUAL",
"customer_account_code": "XXXX-XXXX-XXXX",
"customer_reg_no": null,
"customer_sales_tax_reg_no": null,
"customer_name": "XXX",
"customer_phone_no": null,
"customer_email": "user@domain.com",
"customer_address_type": "PHYSICAL",
"customer_address_line1": "123 Street Road",
"customer_address_line2": "Suburb",
"customer_address_line3": "City",
"customer_address_line4": null,
"customer_address_state": "Gauteng",
"customer_address_country": "ZA",
"customer_address_postal_code": "0000",
"currency_symbol": "R"
},
"line_items": [
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"document_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"date": "2020-01-01T12:00:00.000Z",
"item_code": null,
"description": "XXX",
"quantity": 1,
"unit_value": "86.09",
"excluding": "86.09",
"including": "99.00",
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "15.00",
"sales_tax_code": null,
"sales_tax_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_tax_account_code": "XXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX",
"payable_account_code": "XXX"
}
]
},
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "domain.com",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"supplier_account_id": null,
"document_number": "INV-2",
"date": "2020-01-02T12:00:00.000Z",
"type": "CREDIT_NOTE",
"status": "PROCESSED",
"metadata": {
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"tax_total": "12.91",
"legal_entity_timezone": "Africa/Johannesburg",
"legal_entity_name": "XXX",
"legal_entity_email": "user@domain.com",
"legal_entity_phone_no": "0123456789",
"legal_entity_website": "domain.com",
"legal_entity_address": "123 Street Road, Suburb, City",
"legal_entity_sales_tax_reg_no": "XXX",
"legal_entity_reg_no": "XXX",
"customer_type": "INDIVIDUAL",
"customer_account_code": "XXXX-XXXX-XXXX",
"customer_reg_no": null,
"customer_sales_tax_reg_no": null,
"customer_name": "XXX",
"customer_phone_no": null,
"customer_email": "user@domain.com",
"customer_address_type": "PHYSICAL",
"customer_address_line1": "123 Street Road",
"customer_address_line2": "Suburb",
"customer_address_line3": "City",
"customer_address_line4": null,
"customer_address_state": "Gauteng",
"customer_address_country": "ZA",
"customer_address_postal_code": "0000",
"currency_symbol": "R"
},
"line_items": [
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"document_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"date": "2020-01-02T12:00:00.000Z",
"item_code": null,
"description": "XXX",
"quantity": 1,
"unit_value": "86.09",
"excluding": "86.09",
"including": "99.00",
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "15.00",
"sales_tax_code": null,
"sales_tax_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_tax_account_code": "XXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX",
"payable_account_code": "XXX"
}
]
}
]POST
/v2/document/creditnote(billing)
Create Credit Note
Service
billing
billing
Multiple credit notes can be created with a single request. Simply include the credit note objects in the "credit_notes" parameter.
Either account codes or account IDs can be provided for each line item, if both are provided the IDs will be used by default.
Accepted Roles (RBAC)
AdministratorBilling AccountantBilling AdministratorRequest 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) | |
| credit_notes | body | string | Credit Notes. | |
| legal_entity_id | body | string | Legal Entity Id. |
Request Example
{
"legal_entity_id":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"credit_notes":
[
{
"date":"2024-01-01T12:00:00+02:00",
"customer_account_id":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"line_items":
[
{
"quantity":1,
"description":"XXX",
"unit_value":50,
"discount_percent":0,
"tax_percent": 0,
"item_code": "XXX",
"sales_tax_code": "XXX",
"receivable_account_code": "XXX",
"sales_account_code":"XXX",
"payable_account_code":"XXX",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_id":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
}
]
}
]
}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 |
|---|---|---|---|
| customer_account_id | body | string | Customer Account Id. |
| date | body | string | Date. |
| document_number | body | string | Document Number. |
| domain | body | string | Entity Domain. |
| id | body | string | Unique Entity 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 | body | array | Line Items. |
| metadata | body | object | Metadata. |
| metadata.currency_symbol | body | string | Metadata Currency Symbol. |
| metadata.customer_account_code | body | string | Metadata Customer Account Code. |
| metadata.customer_address_country | body | string | Metadata Customer Address Country. |
| metadata.customer_address_line1 | body | string | Metadata Customer Address Line1. |
| metadata.customer_address_line2 | body | string | Metadata Customer Address Line2. |
| metadata.customer_address_line3 | body | string | Metadata Customer Address Line3. |
| metadata.customer_address_line4 | body | string | Metadata Customer Address Line4. |
| metadata.customer_address_postal_code | body | string | Metadata Customer Address Postal Code. |
| metadata.customer_address_state | body | string | Metadata Customer Address State. |
| metadata.customer_address_type | body | string | Metadata Customer Address Type. |
| metadata.customer_email | body | string | Metadata Customer Email. |
| metadata.customer_name | body | string | Metadata Customer Name. |
| metadata.customer_phone_no | body | string | Metadata Customer Phone No. |
| metadata.customer_reg_no | body | string | Metadata Customer Reg No. |
| metadata.customer_sales_tax_reg_no | body | string | Metadata Customer Sales Tax Reg No. |
| metadata.customer_type | body | string | Metadata Customer Type. |
| metadata.discount_total | body | decimal | Metadata Discount Total. |
| metadata.excluding_total | body | decimal | Metadata Excluding Total. |
| metadata.including_total | body | decimal | Metadata Including Total. |
| metadata.legal_entity_address | body | string | Metadata Legal Entity Address. |
| metadata.legal_entity_email | body | string | Metadata Legal Entity Email. |
| metadata.legal_entity_name | body | string | Metadata Legal Entity Name. |
| metadata.legal_entity_phone_no | body | string | Metadata Legal Entity Phone No. |
| metadata.legal_entity_reg_no | body | string | Metadata Legal Entity Reg No. |
| metadata.legal_entity_sales_tax_reg_no | body | string | Metadata Legal Entity Sales Tax Reg No. |
| metadata.legal_entity_timezone | body | string | Metadata Legal Entity Timezone. |
| metadata.legal_entity_website | body | string | Metadata Legal Entity Website. |
| metadata.tax_total | body | decimal | Metadata Tax Total. |
| status | body | string | Status. |
| supplier_account_id | body | string | Supplier Account Id. |
| type | body | string | Type. |
Response Example
[
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "domain.com",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"supplier_account_id": null,
"document_number": null,
"date": "2024-01-01T12:00:00.000Z",
"type": "CREDIT_NOTE",
"status": "UNPROCESSED",
"metadata": {
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"tax_total": "12.91",
"legal_entity_timezone": "Africa/Johannesburg",
"legal_entity_name": "XXX",
"legal_entity_email": "user@domain.com",
"legal_entity_phone_no": "0123456789",
"legal_entity_website": "domain.com",
"legal_entity_address": "123 Street Road, Suburb, City",
"legal_entity_sales_tax_reg_no": "XXX",
"legal_entity_reg_no": "XXX",
"customer_type": "INDIVIDUAL",
"customer_account_code": "XXXX-XXXX-XXXX",
"customer_reg_no": null,
"customer_sales_tax_reg_no": null,
"customer_name": "XXX",
"customer_phone_no": null,
"customer_email": "user@domain.com",
"customer_address_type": "PHYSICAL",
"customer_address_line1": "123 Street Road",
"customer_address_line2": "Suburb",
"customer_address_line3": "City",
"customer_address_line4": null,
"customer_address_state": "Gauteng",
"customer_address_country": "ZA",
"customer_address_postal_code": "0000",
"currency_symbol": "R"
},
"line_items": [
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"document_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"date": "2024-01-01T12:00:00.000Z",
"item_code": null,
"description": "XXX",
"quantity": 1,
"unit_value": "86.09",
"excluding": "86.09",
"including": "99.00",
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "15.00",
"sales_tax_code": "XXX",
"sales_tax_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_tax_account_code": "XXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX",
"payable_account_code": "XXX"
}
]
}
]GET
/v2/document/debitnote/pdf(billing)
Get Debit Note PDF
Service
billing
billing
Accepted Roles (RBAC)
AdministratorBilling AccountantBilling AdministratorCustomerStaff MemberSupportRequest 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) | |
| document_number | query | string | Document Number. | X |
| legal_entity_id | query | string | Legal Entity Id. | X |
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 |
GET
/v2/document/debitnote/docnum/{document_number}(billing)
Get Debit Note By Document Number
Service
billing
billing
Accepted Roles (RBAC)
AdministratorBilling AccountantBilling AdministratorCustomerStaff MemberSupportRequest 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) | |
| document_number | url | string | Document Number. | 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 |
|---|---|---|---|
| customer_account_id | body | string | Customer Account Id. |
| date | body | string | Date. |
| document_number | body | string | Document Number. |
| domain | body | string | Entity Domain. |
| id | body | string | Unique Entity 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 | body | array | Line Items. |
| metadata | body | object | Metadata. |
| metadata.currency_symbol | body | string | Metadata Currency Symbol. |
| metadata.customer_account_code | body | string | Metadata Customer Account Code. |
| metadata.customer_address_country | body | string | Metadata Customer Address Country. |
| metadata.customer_address_line1 | body | string | Metadata Customer Address Line1. |
| metadata.customer_address_line2 | body | string | Metadata Customer Address Line2. |
| metadata.customer_address_line3 | body | string | Metadata Customer Address Line3. |
| metadata.customer_address_line4 | body | string | Metadata Customer Address Line4. |
| metadata.customer_address_postal_code | body | string | Metadata Customer Address Postal Code. |
| metadata.customer_address_state | body | string | Metadata Customer Address State. |
| metadata.customer_address_type | body | string | Metadata Customer Address Type. |
| metadata.customer_email | body | string | Metadata Customer Email. |
| metadata.customer_name | body | string | Metadata Customer Name. |
| metadata.customer_phone_no | body | string | Metadata Customer Phone No. |
| metadata.customer_reg_no | body | string | Metadata Customer Reg No. |
| metadata.customer_sales_tax_reg_no | body | string | Metadata Customer Sales Tax Reg No. |
| metadata.customer_type | body | string | Metadata Customer Type. |
| metadata.discount_total | body | decimal | Metadata Discount Total. |
| metadata.excluding_total | body | decimal | Metadata Excluding Total. |
| metadata.including_total | body | decimal | Metadata Including Total. |
| metadata.legal_entity_address | body | string | Metadata Legal Entity Address. |
| metadata.legal_entity_email | body | string | Metadata Legal Entity Email. |
| metadata.legal_entity_name | body | string | Metadata Legal Entity Name. |
| metadata.legal_entity_phone_no | body | string | Metadata Legal Entity Phone No. |
| metadata.legal_entity_reg_no | body | string | Metadata Legal Entity Reg No. |
| metadata.legal_entity_sales_tax_reg_no | body | string | Metadata Legal Entity Sales Tax Reg No. |
| metadata.legal_entity_timezone | body | string | Metadata Legal Entity Timezone. |
| metadata.legal_entity_website | body | string | Metadata Legal Entity Website. |
| metadata.tax_total | body | decimal | Metadata Tax Total. |
| status | body | string | Status. |
| supplier_account_id | body | string | Supplier Account Id. |
| type | body | string | Type. |
Response Example
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "domain.com",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"supplier_account_id": null,
"document_number": "INV-1",
"date": "2020-01-01T12:00:00.000Z",
"type": "DEBIT_NOTE",
"status": "PROCESSED",
"metadata": {
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"tax_total": "12.91",
"legal_entity_timezone": "Africa/Johannesburg",
"legal_entity_name": "XXX",
"legal_entity_email": "user@domain.com",
"legal_entity_phone_no": "0123456789",
"legal_entity_website": "domain.com",
"legal_entity_address": "123 Street Road, Suburb, City",
"legal_entity_sales_tax_reg_no": "XXX",
"legal_entity_reg_no": "XXX",
"customer_type": "INDIVIDUAL",
"customer_account_code": "XXXX-XXXX-XXXX",
"customer_reg_no": null,
"customer_sales_tax_reg_no": null,
"customer_name": "XXX",
"customer_phone_no": null,
"customer_email": "user@domain.com",
"customer_address_type": "PHYSICAL",
"customer_address_line1": "123 Street Road",
"customer_address_line2": "Suburb",
"customer_address_line3": "City",
"customer_address_line4": null,
"customer_address_state": "Gauteng",
"customer_address_country": "ZA",
"customer_address_postal_code": "0000",
"currency_symbol": "R"
},
"line_items": [
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"document_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"date": "2020-01-01T12:00:00.000Z",
"item_code": null,
"description": "XXX",
"quantity": 1,
"unit_value": "86.09",
"excluding": "86.09",
"including": "99.00",
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "15.00",
"sales_tax_code": null,
"sales_tax_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_tax_account_code": "XXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX",
"payable_account_code": "XXX"
}
]
}GET
/v2/document/debitnote/id/{document_id}(billing)
Get Debit Note By ID
Service
billing
billing
Accepted Roles (RBAC)
AdministratorBilling AccountantBilling AdministratorCustomerStaff MemberSupportRequest 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) | |
| document_id | url | string | Document 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 |
|---|---|---|---|
| customer_account_id | body | string | Customer Account Id. |
| date | body | string | Date. |
| document_number | body | string | Document Number. |
| domain | body | string | Entity Domain. |
| id | body | string | Unique Entity 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 | body | array | Line Items. |
| metadata | body | object | Metadata. |
| metadata.currency_symbol | body | string | Metadata Currency Symbol. |
| metadata.customer_account_code | body | string | Metadata Customer Account Code. |
| metadata.customer_address_country | body | string | Metadata Customer Address Country. |
| metadata.customer_address_line1 | body | string | Metadata Customer Address Line1. |
| metadata.customer_address_line2 | body | string | Metadata Customer Address Line2. |
| metadata.customer_address_line3 | body | string | Metadata Customer Address Line3. |
| metadata.customer_address_line4 | body | string | Metadata Customer Address Line4. |
| metadata.customer_address_postal_code | body | string | Metadata Customer Address Postal Code. |
| metadata.customer_address_state | body | string | Metadata Customer Address State. |
| metadata.customer_address_type | body | string | Metadata Customer Address Type. |
| metadata.customer_email | body | string | Metadata Customer Email. |
| metadata.customer_name | body | string | Metadata Customer Name. |
| metadata.customer_phone_no | body | string | Metadata Customer Phone No. |
| metadata.customer_reg_no | body | string | Metadata Customer Reg No. |
| metadata.customer_sales_tax_reg_no | body | string | Metadata Customer Sales Tax Reg No. |
| metadata.customer_type | body | string | Metadata Customer Type. |
| metadata.discount_total | body | decimal | Metadata Discount Total. |
| metadata.excluding_total | body | decimal | Metadata Excluding Total. |
| metadata.including_total | body | decimal | Metadata Including Total. |
| metadata.legal_entity_address | body | string | Metadata Legal Entity Address. |
| metadata.legal_entity_email | body | string | Metadata Legal Entity Email. |
| metadata.legal_entity_name | body | string | Metadata Legal Entity Name. |
| metadata.legal_entity_phone_no | body | string | Metadata Legal Entity Phone No. |
| metadata.legal_entity_reg_no | body | string | Metadata Legal Entity Reg No. |
| metadata.legal_entity_sales_tax_reg_no | body | string | Metadata Legal Entity Sales Tax Reg No. |
| metadata.legal_entity_timezone | body | string | Metadata Legal Entity Timezone. |
| metadata.legal_entity_website | body | string | Metadata Legal Entity Website. |
| metadata.tax_total | body | decimal | Metadata Tax Total. |
| status | body | string | Status. |
| supplier_account_id | body | string | Supplier Account Id. |
| type | body | string | Type. |
Response Example
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "domain.com",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"supplier_account_id": null,
"document_number": "INV-1",
"date": "2020-01-01T12:00:00.000Z",
"type": "DEBIT_NOTE",
"status": "PROCESSED",
"metadata": {
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"tax_total": "12.91",
"legal_entity_timezone": "Africa/Johannesburg",
"legal_entity_name": "XXX",
"legal_entity_email": "user@domain.com",
"legal_entity_phone_no": "0123456789",
"legal_entity_website": "domain.com",
"legal_entity_address": "123 Street Road, Suburb, City",
"legal_entity_sales_tax_reg_no": "XXX",
"legal_entity_reg_no": "XXX",
"customer_type": "INDIVIDUAL",
"customer_account_code": "XXXX-XXXX-XXXX",
"customer_reg_no": null,
"customer_sales_tax_reg_no": null,
"customer_name": "XXX",
"customer_phone_no": null,
"customer_email": "user@domain.com",
"customer_address_type": "PHYSICAL",
"customer_address_line1": "123 Street Road",
"customer_address_line2": "Suburb",
"customer_address_line3": "City",
"customer_address_line4": null,
"customer_address_state": "Gauteng",
"customer_address_country": "ZA",
"customer_address_postal_code": "0000",
"currency_symbol": "R"
},
"line_items": [
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"document_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"date": "2020-01-01T12:00:00.000Z",
"item_code": null,
"description": "XXX",
"quantity": 1,
"unit_value": "86.09",
"excluding": "86.09",
"including": "99.00",
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "15.00",
"sales_tax_code": null,
"sales_tax_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_tax_account_code": "XXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX",
"payable_account_code": "XXX"
}
]
}GET
/v2/document/debitnote/all(billing)
Get All Debit Notes
Service
billing
billing
Returns a list of debit notes within the specified range. This resource is limited to respond with a maximum of 250 debit notes. If a greater number of debit notes is desired, it is recommended to use the /v2/report/document/debitnote/csv resource.
If the "month" query parameter is provided, the "range_start" and "range_end" query parameters need not be included. If the "legal_entity_id" query parameter is not provided, all Legal Entities within the requesting domain will be queried. If the "customer_Account_id" query parameter is not provided, all Customer Accounts will be queried.
Accepted Roles (RBAC)
AdministratorBilling AccountantBilling AdministratorCustomerStaff MemberSupportRequest 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 | Customer Account Id. | |
| legal_entity_id | query | string | Legal Entity Id. | |
| month | query | string | Month. | |
| range_end | query | string | Range End. | X |
| range_start | query | string | Range Start. | X |
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 |
|---|---|---|---|
| customer_account_id | body | string | Customer Account Id. |
| date | body | string | Date. |
| document_number | body | string | Document Number. |
| domain | body | string | Entity Domain. |
| id | body | string | Unique Entity 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 | body | array | Line Items. |
| metadata | body | object | Metadata. |
| metadata.currency_symbol | body | string | Metadata Currency Symbol. |
| metadata.customer_account_code | body | string | Metadata Customer Account Code. |
| metadata.customer_address_country | body | string | Metadata Customer Address Country. |
| metadata.customer_address_line1 | body | string | Metadata Customer Address Line1. |
| metadata.customer_address_line2 | body | string | Metadata Customer Address Line2. |
| metadata.customer_address_line3 | body | string | Metadata Customer Address Line3. |
| metadata.customer_address_line4 | body | string | Metadata Customer Address Line4. |
| metadata.customer_address_postal_code | body | string | Metadata Customer Address Postal Code. |
| metadata.customer_address_state | body | string | Metadata Customer Address State. |
| metadata.customer_address_type | body | string | Metadata Customer Address Type. |
| metadata.customer_email | body | string | Metadata Customer Email. |
| metadata.customer_name | body | string | Metadata Customer Name. |
| metadata.customer_phone_no | body | string | Metadata Customer Phone No. |
| metadata.customer_reg_no | body | string | Metadata Customer Reg No. |
| metadata.customer_sales_tax_reg_no | body | string | Metadata Customer Sales Tax Reg No. |
| metadata.customer_type | body | string | Metadata Customer Type. |
| metadata.discount_total | body | decimal | Metadata Discount Total. |
| metadata.excluding_total | body | decimal | Metadata Excluding Total. |
| metadata.including_total | body | decimal | Metadata Including Total. |
| metadata.legal_entity_address | body | string | Metadata Legal Entity Address. |
| metadata.legal_entity_email | body | string | Metadata Legal Entity Email. |
| metadata.legal_entity_name | body | string | Metadata Legal Entity Name. |
| metadata.legal_entity_phone_no | body | string | Metadata Legal Entity Phone No. |
| metadata.legal_entity_reg_no | body | string | Metadata Legal Entity Reg No. |
| metadata.legal_entity_sales_tax_reg_no | body | string | Metadata Legal Entity Sales Tax Reg No. |
| metadata.legal_entity_timezone | body | string | Metadata Legal Entity Timezone. |
| metadata.legal_entity_website | body | string | Metadata Legal Entity Website. |
| metadata.tax_total | body | decimal | Metadata Tax Total. |
| status | body | string | Status. |
| supplier_account_id | body | string | Supplier Account Id. |
| type | body | string | Type. |
Response Example
[
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "domain.com",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"supplier_account_id": null,
"document_number": "INV-1",
"date": "2020-01-01T12:00:00.000Z",
"type": "DEBIT_NOTE",
"status": "PROCESSED",
"metadata": {
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"tax_total": "12.91",
"legal_entity_timezone": "Africa/Johannesburg",
"legal_entity_name": "XXX",
"legal_entity_email": "user@domain.com",
"legal_entity_phone_no": "0123456789",
"legal_entity_website": "domain.com",
"legal_entity_address": "123 Street Road, Suburb, City",
"legal_entity_sales_tax_reg_no": "XXX",
"legal_entity_reg_no": "XXX",
"customer_type": "INDIVIDUAL",
"customer_account_code": "XXXX-XXXX-XXXX",
"customer_reg_no": null,
"customer_sales_tax_reg_no": null,
"customer_name": "XXX",
"customer_phone_no": null,
"customer_email": "user@domain.com",
"customer_address_type": "PHYSICAL",
"customer_address_line1": "123 Street Road",
"customer_address_line2": "Suburb",
"customer_address_line3": "City",
"customer_address_line4": null,
"customer_address_state": "Gauteng",
"customer_address_country": "ZA",
"customer_address_postal_code": "0000",
"currency_symbol": "R"
},
"line_items": [
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"document_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"date": "2020-01-01T12:00:00.000Z",
"item_code": null,
"description": "XXX",
"quantity": 1,
"unit_value": "86.09",
"excluding": "86.09",
"including": "99.00",
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "15.00",
"sales_tax_code": null,
"sales_tax_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_tax_account_code": "XXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX",
"payable_account_code": "XXX"
}
]
},
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "domain.com",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"supplier_account_id": null,
"document_number": "INV-2",
"date": "2020-01-02T12:00:00.000Z",
"type": "DEBIT_NOTE",
"status": "PROCESSED",
"metadata": {
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"tax_total": "12.91",
"legal_entity_timezone": "Africa/Johannesburg",
"legal_entity_name": "XXX",
"legal_entity_email": "user@domain.com",
"legal_entity_phone_no": "0123456789",
"legal_entity_website": "domain.com",
"legal_entity_address": "123 Street Road, Suburb, City",
"legal_entity_sales_tax_reg_no": "XXX",
"legal_entity_reg_no": "XXX",
"customer_type": "INDIVIDUAL",
"customer_account_code": "XXXX-XXXX-XXXX",
"customer_reg_no": null,
"customer_sales_tax_reg_no": null,
"customer_name": "XXX",
"customer_phone_no": null,
"customer_email": "user@domain.com",
"customer_address_type": "PHYSICAL",
"customer_address_line1": "123 Street Road",
"customer_address_line2": "Suburb",
"customer_address_line3": "City",
"customer_address_line4": null,
"customer_address_state": "Gauteng",
"customer_address_country": "ZA",
"customer_address_postal_code": "0000",
"currency_symbol": "R"
},
"line_items": [
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"document_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"date": "2020-01-02T12:00:00.000Z",
"item_code": null,
"description": "XXX",
"quantity": 1,
"unit_value": "86.09",
"excluding": "86.09",
"including": "99.00",
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "15.00",
"sales_tax_code": null,
"sales_tax_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_tax_account_code": "XXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX",
"payable_account_code": "XXX"
}
]
}
]POST
/v2/document/debitnote(billing)
Create Debit Note
Service
billing
billing
Multiple debit notes can be created with a single request. Simply include the debit note objects in the "debit_notes" parameter.
Either account codes or account IDs can be provided for each line item, if both are provided the IDs will be used by default.
Accepted Roles (RBAC)
AdministratorBilling AccountantBilling AdministratorRequest 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) | |
| debit_notes | body | string | Debit Notes. | |
| legal_entity_id | body | string | Legal Entity Id. |
Request Example
{
"legal_entity_id":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"debit_notes":
[
{
"date":"2024-01-01T12:00:00+02:00",
"customer_account_id":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"line_items":
[
{
"quantity":1,
"description":"XXX",
"unit_value":50,
"discount_percent":0,
"tax_percent": 0,
"item_code": "XXX",
"sales_tax_code": "XXX",
"receivable_account_code": "XXX",
"sales_account_code":"XXX",
"payable_account_code":"XXX",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_id":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
}
]
}
]
}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 |
|---|---|---|---|
| customer_account_id | body | string | Customer Account Id. |
| date | body | string | Date. |
| document_number | body | string | Document Number. |
| domain | body | string | Entity Domain. |
| id | body | string | Unique Entity 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 | body | array | Line Items. |
| metadata | body | object | Metadata. |
| metadata.currency_symbol | body | string | Metadata Currency Symbol. |
| metadata.customer_account_code | body | string | Metadata Customer Account Code. |
| metadata.customer_address_country | body | string | Metadata Customer Address Country. |
| metadata.customer_address_line1 | body | string | Metadata Customer Address Line1. |
| metadata.customer_address_line2 | body | string | Metadata Customer Address Line2. |
| metadata.customer_address_line3 | body | string | Metadata Customer Address Line3. |
| metadata.customer_address_line4 | body | string | Metadata Customer Address Line4. |
| metadata.customer_address_postal_code | body | string | Metadata Customer Address Postal Code. |
| metadata.customer_address_state | body | string | Metadata Customer Address State. |
| metadata.customer_address_type | body | string | Metadata Customer Address Type. |
| metadata.customer_email | body | string | Metadata Customer Email. |
| metadata.customer_name | body | string | Metadata Customer Name. |
| metadata.customer_phone_no | body | string | Metadata Customer Phone No. |
| metadata.customer_reg_no | body | string | Metadata Customer Reg No. |
| metadata.customer_sales_tax_reg_no | body | string | Metadata Customer Sales Tax Reg No. |
| metadata.customer_type | body | string | Metadata Customer Type. |
| metadata.discount_total | body | decimal | Metadata Discount Total. |
| metadata.excluding_total | body | decimal | Metadata Excluding Total. |
| metadata.including_total | body | decimal | Metadata Including Total. |
| metadata.legal_entity_address | body | string | Metadata Legal Entity Address. |
| metadata.legal_entity_email | body | string | Metadata Legal Entity Email. |
| metadata.legal_entity_name | body | string | Metadata Legal Entity Name. |
| metadata.legal_entity_phone_no | body | string | Metadata Legal Entity Phone No. |
| metadata.legal_entity_reg_no | body | string | Metadata Legal Entity Reg No. |
| metadata.legal_entity_sales_tax_reg_no | body | string | Metadata Legal Entity Sales Tax Reg No. |
| metadata.legal_entity_timezone | body | string | Metadata Legal Entity Timezone. |
| metadata.legal_entity_website | body | string | Metadata Legal Entity Website. |
| metadata.tax_total | body | decimal | Metadata Tax Total. |
| status | body | string | Status. |
| supplier_account_id | body | string | Supplier Account Id. |
| type | body | string | Type. |
Response Example
[
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "domain.com",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"supplier_account_id": null,
"document_number": null,
"date": "2024-01-01T12:00:00.000Z",
"type": "DEBIT_NOTE",
"status": "UNPROCESSED",
"metadata": {
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"tax_total": "12.91",
"legal_entity_timezone": "Africa/Johannesburg",
"legal_entity_name": "XXX",
"legal_entity_email": "user@domain.com",
"legal_entity_phone_no": "0123456789",
"legal_entity_website": "domain.com",
"legal_entity_address": "123 Street Road, Suburb, City",
"legal_entity_sales_tax_reg_no": "XXX",
"legal_entity_reg_no": "XXX",
"customer_type": "INDIVIDUAL",
"customer_account_code": "XXXX-XXXX-XXXX",
"customer_reg_no": null,
"customer_sales_tax_reg_no": null,
"customer_name": "XXX",
"customer_phone_no": null,
"customer_email": "user@domain.com",
"customer_address_type": "PHYSICAL",
"customer_address_line1": "123 Street Road",
"customer_address_line2": "Suburb",
"customer_address_line3": "City",
"customer_address_line4": null,
"customer_address_state": "Gauteng",
"customer_address_country": "ZA",
"customer_address_postal_code": "0000",
"currency_symbol": "R"
},
"line_items": [
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"document_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"date": "2024-01-01T12:00:00.000Z",
"item_code": null,
"description": "XXX",
"quantity": 1,
"unit_value": "86.09",
"excluding": "86.09",
"including": "99.00",
"excluding_total": "86.09",
"including_total": "99.00",
"discount_total": "0.00",
"discount_percent": "0.00",
"tax_percent": "15.00",
"sales_tax_code": "XXX",
"sales_tax_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"payable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sales_tax_account_code": "XXX",
"sales_account_code": "XXX",
"receivable_account_code": "XXX",
"payable_account_code": "XXX"
}
]
}
]GET
/v2/document/receipt/pdf(billing)
Get Receipt PDF
Service
billing
billing
Accepted Roles (RBAC)
AdministratorBilling AccountantBilling AdministratorCustomerStaff MemberSupportRequest 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) | |
| document_number | query | string | Document Number. | X |
| legal_entity_id | query | string | Legal Entity Id. | X |
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 |
GET
/v2/document/receipt/docnum/{document_number}(billing)
Get Receipt By Document Number
Service
billing
billing
Accepted Roles (RBAC)
AdministratorBilling AccountantBilling AdministratorCustomerStaff MemberSupportRequest 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) | |
| document_number | url | string | Document Number. | 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 |
|---|---|---|---|
| customer_account_id | body | string | Customer Account Id. |
| date | body | string | Date. |
| document_number | body | string | Document Number. |
| domain | body | string | Entity Domain. |
| id | body | string | Unique Entity ID. |
| legal_entity_id | body | string | Legal Entity Id. |
| metadata | body | object | Metadata. |
| metadata.amount | body | decimal | Metadata Amount. |
| metadata.bank_account_id | body | string | Metadata Bank Account Id. |
| metadata.currency_symbol | body | string | Metadata Currency Symbol. |
| metadata.customer_account_code | body | string | Metadata Customer Account Code. |
| metadata.customer_address_country | body | string | Metadata Customer Address Country. |
| metadata.customer_address_line1 | body | string | Metadata Customer Address Line1. |
| metadata.customer_address_line2 | body | string | Metadata Customer Address Line2. |
| metadata.customer_address_line3 | body | string | Metadata Customer Address Line3. |
| metadata.customer_address_line4 | body | string | Metadata Customer Address Line4. |
| metadata.customer_address_postal_code | body | string | Metadata Customer Address Postal Code. |
| metadata.customer_address_state | body | string | Metadata Customer Address State. |
| metadata.customer_address_type | body | string | Metadata Customer Address Type. |
| metadata.customer_email | body | string | Metadata Customer Email. |
| metadata.customer_name | body | string | Metadata Customer Name. |
| metadata.customer_phone_no | body | string | Metadata Customer Phone No. |
| metadata.customer_reg_no | body | string | Metadata Customer Reg No. |
| metadata.customer_sales_tax_reg_no | body | string | Metadata Customer Sales Tax Reg No. |
| metadata.customer_type | body | string | Metadata Customer Type. |
| metadata.legal_entity_address | body | string | Metadata Legal Entity Address. |
| metadata.legal_entity_email | body | string | Metadata Legal Entity Email. |
| metadata.legal_entity_name | body | string | Metadata Legal Entity Name. |
| metadata.legal_entity_phone_no | body | string | Metadata Legal Entity Phone No. |
| metadata.legal_entity_reg_no | body | string | Metadata Legal Entity Reg No. |
| metadata.legal_entity_sales_tax_reg_no | body | string | Metadata Legal Entity Sales Tax Reg No. |
| metadata.legal_entity_timezone | body | string | Metadata Legal Entity Timezone. |
| metadata.legal_entity_website | body | string | Metadata Legal Entity Website. |
| metadata.receivable_account_id | body | string | Metadata Receivable Account Id. |
| status | body | string | Status. |
| supplier_account_id | body | string | Supplier Account Id. |
| type | body | string | Type. |
Response Example
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "domain.com",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"supplier_account_id": null,
"document_number": "RCPT-1",
"date": "2024-01-01T12:00:00.000Z",
"type": "RECEIPT",
"status": "PROCESSED",
"metadata": {
"amount": "99.00",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"bank_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"legal_entity_timezone": "Africa/Johannesburg",
"legal_entity_name": "XXX",
"legal_entity_email": null,
"legal_entity_phone_no": "0123456789",
"legal_entity_website": null,
"legal_entity_address": "123 Street Road, Suburb, City",
"legal_entity_sales_tax_reg_no": "XXXX",
"legal_entity_reg_no": "XXXX",
"customer_type": "INDIVIDUAL",
"customer_account_code": "CUST-001",
"customer_reg_no": null,
"customer_sales_tax_reg_no": null,
"customer_name": "XXX",
"customer_phone_no": null,
"customer_email": "user@domain.com",
"customer_address_type": "PHYSICAL",
"customer_address_line1": "123 Street Road",
"customer_address_line2": "Suburb",
"customer_address_line3": "City",
"customer_address_line4": null,
"customer_address_state": "Gauteng",
"customer_address_country": "ZA",
"customer_address_postal_code": "0000",
"currency_symbol": "R"
}
}GET
/v2/document/receipt/id/{document_id}(billing)
Get Receipt By ID
Service
billing
billing
Accepted Roles (RBAC)
AdministratorBilling AccountantBilling AdministratorCustomerStaff MemberSupportRequest 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) | |
| document_id | url | string | Document 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 |
|---|---|---|---|
| customer_account_id | body | string | Customer Account Id. |
| date | body | string | Date. |
| document_number | body | string | Document Number. |
| domain | body | string | Entity Domain. |
| id | body | string | Unique Entity ID. |
| legal_entity_id | body | string | Legal Entity Id. |
| metadata | body | object | Metadata. |
| metadata.amount | body | decimal | Metadata Amount. |
| metadata.bank_account_id | body | string | Metadata Bank Account Id. |
| metadata.currency_symbol | body | string | Metadata Currency Symbol. |
| metadata.customer_account_code | body | string | Metadata Customer Account Code. |
| metadata.customer_address_country | body | string | Metadata Customer Address Country. |
| metadata.customer_address_line1 | body | string | Metadata Customer Address Line1. |
| metadata.customer_address_line2 | body | string | Metadata Customer Address Line2. |
| metadata.customer_address_line3 | body | string | Metadata Customer Address Line3. |
| metadata.customer_address_line4 | body | string | Metadata Customer Address Line4. |
| metadata.customer_address_postal_code | body | string | Metadata Customer Address Postal Code. |
| metadata.customer_address_state | body | string | Metadata Customer Address State. |
| metadata.customer_address_type | body | string | Metadata Customer Address Type. |
| metadata.customer_email | body | string | Metadata Customer Email. |
| metadata.customer_name | body | string | Metadata Customer Name. |
| metadata.customer_phone_no | body | string | Metadata Customer Phone No. |
| metadata.customer_reg_no | body | string | Metadata Customer Reg No. |
| metadata.customer_sales_tax_reg_no | body | string | Metadata Customer Sales Tax Reg No. |
| metadata.customer_type | body | string | Metadata Customer Type. |
| metadata.legal_entity_address | body | string | Metadata Legal Entity Address. |
| metadata.legal_entity_email | body | string | Metadata Legal Entity Email. |
| metadata.legal_entity_name | body | string | Metadata Legal Entity Name. |
| metadata.legal_entity_phone_no | body | string | Metadata Legal Entity Phone No. |
| metadata.legal_entity_reg_no | body | string | Metadata Legal Entity Reg No. |
| metadata.legal_entity_sales_tax_reg_no | body | string | Metadata Legal Entity Sales Tax Reg No. |
| metadata.legal_entity_timezone | body | string | Metadata Legal Entity Timezone. |
| metadata.legal_entity_website | body | string | Metadata Legal Entity Website. |
| metadata.receivable_account_id | body | string | Metadata Receivable Account Id. |
| status | body | string | Status. |
| supplier_account_id | body | string | Supplier Account Id. |
| type | body | string | Type. |
Response Example
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "domain.com",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"supplier_account_id": null,
"document_number": "RCPT-1",
"date": "2024-01-01T12:00:00.000Z",
"type": "RECEIPT",
"status": "PROCESSED",
"metadata": {
"amount": "99.00",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"bank_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"legal_entity_timezone": "Africa/Johannesburg",
"legal_entity_name": "XXX",
"legal_entity_email": null,
"legal_entity_phone_no": "0123456789",
"legal_entity_website": null,
"legal_entity_address": "123 Street Road, Suburb, City",
"legal_entity_sales_tax_reg_no": "XXXX",
"legal_entity_reg_no": "XXXX",
"customer_type": "INDIVIDUAL",
"customer_account_code": "CUST-001",
"customer_reg_no": null,
"customer_sales_tax_reg_no": null,
"customer_name": "XXX",
"customer_phone_no": null,
"customer_email": "user@domain.com",
"customer_address_type": "PHYSICAL",
"customer_address_line1": "123 Street Road",
"customer_address_line2": "Suburb",
"customer_address_line3": "City",
"customer_address_line4": null,
"customer_address_state": "Gauteng",
"customer_address_country": "ZA",
"customer_address_postal_code": "0000",
"currency_symbol": "R"
}
}GET
/v2/document/receipt/all(billing)
Get All Receipts
Service
billing
billing
Returns a list of receipts within the specified range. This resource is limited to respond with a maximum of 250 receipts. If a greater number of receipts is desired, it is recommended to use the /v2/report/document/receipt/csv resource.
If the "month" query parameter is provided, the "range_start" and "range_end" query parameters need not be included. If the "legal_entity_id" query parameter is not provided, all Legal Entities within the requesting domain will be queried. If the "customer_Account_id" query parameter is not provided, all Customer Accounts will be queried.
Accepted Roles (RBAC)
AdministratorBilling AccountantBilling AdministratorCustomerStaff MemberSupportRequest 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 | Customer Account Id. | |
| legal_entity_id | query | string | Legal Entity Id. | |
| month | query | string | Month. | |
| range_end | query | string | Range End. | X |
| range_start | query | string | Range Start. | X |
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 |
|---|---|---|---|
| customer_account_id | body | string | Customer Account Id. |
| date | body | string | Date. |
| document_number | body | string | Document Number. |
| domain | body | string | Entity Domain. |
| id | body | string | Unique Entity ID. |
| legal_entity_id | body | string | Legal Entity Id. |
| metadata | body | object | Metadata. |
| metadata.amount | body | decimal | Metadata Amount. |
| metadata.bank_account_id | body | string | Metadata Bank Account Id. |
| metadata.currency_symbol | body | string | Metadata Currency Symbol. |
| metadata.customer_account_code | body | string | Metadata Customer Account Code. |
| metadata.customer_address_country | body | string | Metadata Customer Address Country. |
| metadata.customer_address_line1 | body | string | Metadata Customer Address Line1. |
| metadata.customer_address_line2 | body | string | Metadata Customer Address Line2. |
| metadata.customer_address_line3 | body | string | Metadata Customer Address Line3. |
| metadata.customer_address_line4 | body | string | Metadata Customer Address Line4. |
| metadata.customer_address_postal_code | body | string | Metadata Customer Address Postal Code. |
| metadata.customer_address_state | body | string | Metadata Customer Address State. |
| metadata.customer_address_type | body | string | Metadata Customer Address Type. |
| metadata.customer_email | body | string | Metadata Customer Email. |
| metadata.customer_name | body | string | Metadata Customer Name. |
| metadata.customer_phone_no | body | string | Metadata Customer Phone No. |
| metadata.customer_reg_no | body | string | Metadata Customer Reg No. |
| metadata.customer_sales_tax_reg_no | body | string | Metadata Customer Sales Tax Reg No. |
| metadata.customer_type | body | string | Metadata Customer Type. |
| metadata.legal_entity_address | body | string | Metadata Legal Entity Address. |
| metadata.legal_entity_email | body | string | Metadata Legal Entity Email. |
| metadata.legal_entity_name | body | string | Metadata Legal Entity Name. |
| metadata.legal_entity_phone_no | body | string | Metadata Legal Entity Phone No. |
| metadata.legal_entity_reg_no | body | string | Metadata Legal Entity Reg No. |
| metadata.legal_entity_sales_tax_reg_no | body | string | Metadata Legal Entity Sales Tax Reg No. |
| metadata.legal_entity_timezone | body | string | Metadata Legal Entity Timezone. |
| metadata.legal_entity_website | body | string | Metadata Legal Entity Website. |
| metadata.receivable_account_id | body | string | Metadata Receivable Account Id. |
| status | body | string | Status. |
| supplier_account_id | body | string | Supplier Account Id. |
| type | body | string | Type. |
Response Example
[
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "domain.com",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"supplier_account_id": null,
"document_number": "RCPT-1",
"date": "2024-01-01T12:00:00.000Z",
"type": "RECEIPT",
"status": "PROCESSED",
"metadata": {
"amount": "99.00",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"bank_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"legal_entity_timezone": "Africa/Johannesburg",
"legal_entity_name": "XXX",
"legal_entity_email": null,
"legal_entity_phone_no": "0123456789",
"legal_entity_website": null,
"legal_entity_address": "123 Street Road, Suburb, City",
"legal_entity_sales_tax_reg_no": "XXXX",
"legal_entity_reg_no": "XXXX",
"customer_type": "INDIVIDUAL",
"customer_account_code": "CUST-001",
"customer_reg_no": null,
"customer_sales_tax_reg_no": null,
"customer_name": "XXX",
"customer_phone_no": null,
"customer_email": "user@domain.com",
"customer_address_type": "PHYSICAL",
"customer_address_line1": "123 Street Road",
"customer_address_line2": "Suburb",
"customer_address_line3": "City",
"customer_address_line4": null,
"customer_address_state": "Gauteng",
"customer_address_country": "ZA",
"customer_address_postal_code": "0000",
"currency_symbol": "R"
}
},
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "domain.com",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"supplier_account_id": null,
"document_number": "RCPT-2",
"date": "2024-01-02T12:00:00.000Z",
"type": "RECEIPT",
"status": "PROCESSED",
"metadata": {
"amount": "99.00",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"bank_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"legal_entity_timezone": "Africa/Johannesburg",
"legal_entity_name": "XXX",
"legal_entity_email": null,
"legal_entity_phone_no": "0123456789",
"legal_entity_website": null,
"legal_entity_address": "123 Street Road, Suburb, City",
"legal_entity_sales_tax_reg_no": "XXXX",
"legal_entity_reg_no": "XXXX",
"customer_type": "INDIVIDUAL",
"customer_account_code": "CUST-001",
"customer_reg_no": null,
"customer_sales_tax_reg_no": null,
"customer_name": "XXX",
"customer_phone_no": null,
"customer_email": "user@domain.com",
"customer_address_type": "PHYSICAL",
"customer_address_line1": "123 Street Road",
"customer_address_line2": "Suburb",
"customer_address_line3": "City",
"customer_address_line4": null,
"customer_address_state": "Gauteng",
"customer_address_country": "ZA",
"customer_address_postal_code": "0000",
"currency_symbol": "R"
}
}
]POST
/v2/document/receipt(billing)
Create Receipt
Service
billing
billing
Multiple receipts can be created with a single request. Simply include the receipt objects in the "receipts" parameter.
Either account codes or account IDs can be provided for each line item, if both are provided the IDs will be used by default.
Accepted Roles (RBAC)
AdministratorBilling AccountantBilling AdministratorRequest 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) | |
| legal_entity_id | body | string | Legal Entity Id. | |
| receipts | body | string | Receipts. |
Request Example
{
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"receipts": [
{
"date": "2024-01-01T12:00:00+0200",
"amount": 2864.85,
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"bank_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
}
]
}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 |
|---|---|---|---|
| customer_account_id | body | string | Customer Account Id. |
| date | body | string | Date. |
| document_number | body | string | Document Number. |
| domain | body | string | Entity Domain. |
| id | body | string | Unique Entity ID. |
| legal_entity_id | body | string | Legal Entity Id. |
| metadata | body | object | Metadata. |
| metadata.amount | body | decimal | Metadata Amount. |
| metadata.bank_account_id | body | string | Metadata Bank Account Id. |
| metadata.currency_symbol | body | string | Metadata Currency Symbol. |
| metadata.customer_account_code | body | string | Metadata Customer Account Code. |
| metadata.customer_address_country | body | string | Metadata Customer Address Country. |
| metadata.customer_address_line1 | body | string | Metadata Customer Address Line1. |
| metadata.customer_address_line2 | body | string | Metadata Customer Address Line2. |
| metadata.customer_address_line3 | body | string | Metadata Customer Address Line3. |
| metadata.customer_address_line4 | body | string | Metadata Customer Address Line4. |
| metadata.customer_address_postal_code | body | string | Metadata Customer Address Postal Code. |
| metadata.customer_address_state | body | string | Metadata Customer Address State. |
| metadata.customer_address_type | body | string | Metadata Customer Address Type. |
| metadata.customer_email | body | string | Metadata Customer Email. |
| metadata.customer_name | body | string | Metadata Customer Name. |
| metadata.customer_phone_no | body | string | Metadata Customer Phone No. |
| metadata.customer_reg_no | body | string | Metadata Customer Reg No. |
| metadata.customer_sales_tax_reg_no | body | string | Metadata Customer Sales Tax Reg No. |
| metadata.customer_type | body | string | Metadata Customer Type. |
| metadata.legal_entity_address | body | string | Metadata Legal Entity Address. |
| metadata.legal_entity_email | body | string | Metadata Legal Entity Email. |
| metadata.legal_entity_name | body | string | Metadata Legal Entity Name. |
| metadata.legal_entity_phone_no | body | string | Metadata Legal Entity Phone No. |
| metadata.legal_entity_reg_no | body | string | Metadata Legal Entity Reg No. |
| metadata.legal_entity_sales_tax_reg_no | body | string | Metadata Legal Entity Sales Tax Reg No. |
| metadata.legal_entity_timezone | body | string | Metadata Legal Entity Timezone. |
| metadata.legal_entity_website | body | string | Metadata Legal Entity Website. |
| metadata.receivable_account_id | body | string | Metadata Receivable Account Id. |
| status | body | string | Status. |
| supplier_account_id | body | string | Supplier Account Id. |
| type | body | string | Type. |
Response Example
[
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "domain.com",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"supplier_account_id": null,
"document_number": null,
"date": "2024-01-02T12:00:00.000Z",
"type": "RECEIPT",
"status": "UNPROCESSED",
"metadata": {
"amount": "2864.85",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"bank_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"legal_entity_timezone": "Africa/Johannesburg",
"legal_entity_name": "XXX",
"legal_entity_email": null,
"legal_entity_phone_no": "0123456789",
"legal_entity_website": null,
"legal_entity_address": "123 Street Road, Suburb, City",
"legal_entity_sales_tax_reg_no": "XXXX",
"legal_entity_reg_no": "XXXX",
"customer_type": "INDIVIDUAL",
"customer_account_code": "CUST-001",
"customer_reg_no": null,
"customer_sales_tax_reg_no": null,
"customer_name": "XXX",
"customer_phone_no": null,
"customer_email": "user@domain.com",
"customer_address_type": "PHYSICAL",
"customer_address_line1": "123 Street Road",
"customer_address_line2": "Suburb",
"customer_address_line3": "City",
"customer_address_line4": null,
"customer_address_state": "Gauteng",
"customer_address_country": "ZA",
"customer_address_postal_code": "0000",
"currency_symbol": "R"
}
}
]GET
/v2/document/reversalreceipt/pdf(billing)
Get Reversal Receipt PDF
Service
billing
billing
Accepted Roles (RBAC)
AdministratorBilling AccountantBilling AdministratorCustomerStaff MemberSupportRequest 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) | |
| document_number | query | string | Document Number. | X |
| legal_entity_id | query | string | Legal Entity Id. | X |
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 |
GET
/v2/document/reversalreceipt/docnum/{document_number}(billing)
Get Reversal Receipt By Document Number
Service
billing
billing
Accepted Roles (RBAC)
AdministratorBilling AccountantBilling AdministratorCustomerStaff MemberSupportRequest 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) | |
| document_number | url | string | Document Number. | 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 |
|---|---|---|---|
| customer_account_id | body | string | Customer Account Id. |
| date | body | string | Date. |
| document_number | body | string | Document Number. |
| domain | body | string | Entity Domain. |
| id | body | string | Unique Entity ID. |
| legal_entity_id | body | string | Legal Entity Id. |
| metadata | body | object | Metadata. |
| metadata.amount | body | decimal | Metadata Amount. |
| metadata.bank_account_id | body | string | Metadata Bank Account Id. |
| metadata.currency_symbol | body | string | Metadata Currency Symbol. |
| metadata.customer_account_code | body | string | Metadata Customer Account Code. |
| metadata.customer_address_country | body | string | Metadata Customer Address Country. |
| metadata.customer_address_line1 | body | string | Metadata Customer Address Line1. |
| metadata.customer_address_line2 | body | string | Metadata Customer Address Line2. |
| metadata.customer_address_line3 | body | string | Metadata Customer Address Line3. |
| metadata.customer_address_line4 | body | string | Metadata Customer Address Line4. |
| metadata.customer_address_postal_code | body | string | Metadata Customer Address Postal Code. |
| metadata.customer_address_state | body | string | Metadata Customer Address State. |
| metadata.customer_address_type | body | string | Metadata Customer Address Type. |
| metadata.customer_email | body | string | Metadata Customer Email. |
| metadata.customer_name | body | string | Metadata Customer Name. |
| metadata.customer_phone_no | body | string | Metadata Customer Phone No. |
| metadata.customer_reg_no | body | string | Metadata Customer Reg No. |
| metadata.customer_sales_tax_reg_no | body | string | Metadata Customer Sales Tax Reg No. |
| metadata.customer_type | body | string | Metadata Customer Type. |
| metadata.legal_entity_address | body | string | Metadata Legal Entity Address. |
| metadata.legal_entity_email | body | string | Metadata Legal Entity Email. |
| metadata.legal_entity_name | body | string | Metadata Legal Entity Name. |
| metadata.legal_entity_phone_no | body | string | Metadata Legal Entity Phone No. |
| metadata.legal_entity_reg_no | body | string | Metadata Legal Entity Reg No. |
| metadata.legal_entity_sales_tax_reg_no | body | string | Metadata Legal Entity Sales Tax Reg No. |
| metadata.legal_entity_timezone | body | string | Metadata Legal Entity Timezone. |
| metadata.legal_entity_website | body | string | Metadata Legal Entity Website. |
| metadata.receivable_account_id | body | string | Metadata Receivable Account Id. |
| status | body | string | Status. |
| supplier_account_id | body | string | Supplier Account Id. |
| type | body | string | Type. |
Response Example
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "domain.com",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"supplier_account_id": null,
"document_number": "RCPT-1",
"date": "2024-01-01T12:00:00.000Z",
"type": "REVERSAL_RECEIPT",
"status": "PROCESSED",
"metadata": {
"amount": "99.00",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"bank_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"legal_entity_timezone": "Africa/Johannesburg",
"legal_entity_name": "XXX",
"legal_entity_email": null,
"legal_entity_phone_no": "0123456789",
"legal_entity_website": null,
"legal_entity_address": "123 Street Road, Suburb, City",
"legal_entity_sales_tax_reg_no": "XXXX",
"legal_entity_reg_no": "XXXX",
"customer_type": "INDIVIDUAL",
"customer_account_code": "CUST-001",
"customer_reg_no": null,
"customer_sales_tax_reg_no": null,
"customer_name": "XXX",
"customer_phone_no": null,
"customer_email": "user@domain.com",
"customer_address_type": "PHYSICAL",
"customer_address_line1": "123 Street Road",
"customer_address_line2": "Suburb",
"customer_address_line3": "City",
"customer_address_line4": null,
"customer_address_state": "Gauteng",
"customer_address_country": "ZA",
"customer_address_postal_code": "0000",
"currency_symbol": "R"
}
}GET
/v2/document/reversalreceipt/id/{document_id}(billing)
Get Reversal Receipt By ID
Service
billing
billing
Accepted Roles (RBAC)
AdministratorBilling AccountantBilling AdministratorCustomerStaff MemberSupportRequest 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) | |
| document_id | url | string | Document 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 |
|---|---|---|---|
| customer_account_id | body | string | Customer Account Id. |
| date | body | string | Date. |
| document_number | body | string | Document Number. |
| domain | body | string | Entity Domain. |
| id | body | string | Unique Entity ID. |
| legal_entity_id | body | string | Legal Entity Id. |
| metadata | body | object | Metadata. |
| metadata.amount | body | decimal | Metadata Amount. |
| metadata.bank_account_id | body | string | Metadata Bank Account Id. |
| metadata.currency_symbol | body | string | Metadata Currency Symbol. |
| metadata.customer_account_code | body | string | Metadata Customer Account Code. |
| metadata.customer_address_country | body | string | Metadata Customer Address Country. |
| metadata.customer_address_line1 | body | string | Metadata Customer Address Line1. |
| metadata.customer_address_line2 | body | string | Metadata Customer Address Line2. |
| metadata.customer_address_line3 | body | string | Metadata Customer Address Line3. |
| metadata.customer_address_line4 | body | string | Metadata Customer Address Line4. |
| metadata.customer_address_postal_code | body | string | Metadata Customer Address Postal Code. |
| metadata.customer_address_state | body | string | Metadata Customer Address State. |
| metadata.customer_address_type | body | string | Metadata Customer Address Type. |
| metadata.customer_email | body | string | Metadata Customer Email. |
| metadata.customer_name | body | string | Metadata Customer Name. |
| metadata.customer_phone_no | body | string | Metadata Customer Phone No. |
| metadata.customer_reg_no | body | string | Metadata Customer Reg No. |
| metadata.customer_sales_tax_reg_no | body | string | Metadata Customer Sales Tax Reg No. |
| metadata.customer_type | body | string | Metadata Customer Type. |
| metadata.legal_entity_address | body | string | Metadata Legal Entity Address. |
| metadata.legal_entity_email | body | string | Metadata Legal Entity Email. |
| metadata.legal_entity_name | body | string | Metadata Legal Entity Name. |
| metadata.legal_entity_phone_no | body | string | Metadata Legal Entity Phone No. |
| metadata.legal_entity_reg_no | body | string | Metadata Legal Entity Reg No. |
| metadata.legal_entity_sales_tax_reg_no | body | string | Metadata Legal Entity Sales Tax Reg No. |
| metadata.legal_entity_timezone | body | string | Metadata Legal Entity Timezone. |
| metadata.legal_entity_website | body | string | Metadata Legal Entity Website. |
| metadata.receivable_account_id | body | string | Metadata Receivable Account Id. |
| status | body | string | Status. |
| supplier_account_id | body | string | Supplier Account Id. |
| type | body | string | Type. |
Response Example
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "domain.com",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"supplier_account_id": null,
"document_number": "RCPT-1",
"date": "2024-01-01T12:00:00.000Z",
"type": "REVERSAL_RECEIPT",
"status": "PROCESSED",
"metadata": {
"amount": "99.00",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"bank_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"legal_entity_timezone": "Africa/Johannesburg",
"legal_entity_name": "XXX",
"legal_entity_email": null,
"legal_entity_phone_no": "0123456789",
"legal_entity_website": null,
"legal_entity_address": "123 Street Road, Suburb, City",
"legal_entity_sales_tax_reg_no": "XXXX",
"legal_entity_reg_no": "XXXX",
"customer_type": "INDIVIDUAL",
"customer_account_code": "CUST-001",
"customer_reg_no": null,
"customer_sales_tax_reg_no": null,
"customer_name": "XXX",
"customer_phone_no": null,
"customer_email": "user@domain.com",
"customer_address_type": "PHYSICAL",
"customer_address_line1": "123 Street Road",
"customer_address_line2": "Suburb",
"customer_address_line3": "City",
"customer_address_line4": null,
"customer_address_state": "Gauteng",
"customer_address_country": "ZA",
"customer_address_postal_code": "0000",
"currency_symbol": "R"
}
}GET
/v2/document/reversalreceipt/all(billing)
Get All Reversal Receipts
Service
billing
billing
Returns a list of reversal receipts within the specified range. This resource is limited to respond with a maximum of 250 reversal receipts. If a greater number of reversal receipts is desired, it is recommended to use the /v2/report/document/reversalreceipt/csv resource.
If the "month" query parameter is provided, the "range_start" and "range_end" query parameters need not be included. If the "legal_entity_id" query parameter is not provided, all Legal Entities within the requesting domain will be queried. If the "customer_Account_id" query parameter is not provided, all Customer Accounts will be queried.
Accepted Roles (RBAC)
AdministratorBilling AccountantBilling AdministratorCustomerStaff MemberSupportRequest 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 | Customer Account Id. | |
| legal_entity_id | query | string | Legal Entity Id. | |
| month | query | string | Month. | |
| range_end | query | string | Range End. | X |
| range_start | query | string | Range Start. | X |
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 |
|---|---|---|---|
| customer_account_id | body | string | Customer Account Id. |
| date | body | string | Date. |
| document_number | body | string | Document Number. |
| domain | body | string | Entity Domain. |
| id | body | string | Unique Entity ID. |
| legal_entity_id | body | string | Legal Entity Id. |
| metadata | body | object | Metadata. |
| metadata.amount | body | decimal | Metadata Amount. |
| metadata.bank_account_id | body | string | Metadata Bank Account Id. |
| metadata.currency_symbol | body | string | Metadata Currency Symbol. |
| metadata.customer_account_code | body | string | Metadata Customer Account Code. |
| metadata.customer_address_country | body | string | Metadata Customer Address Country. |
| metadata.customer_address_line1 | body | string | Metadata Customer Address Line1. |
| metadata.customer_address_line2 | body | string | Metadata Customer Address Line2. |
| metadata.customer_address_line3 | body | string | Metadata Customer Address Line3. |
| metadata.customer_address_line4 | body | string | Metadata Customer Address Line4. |
| metadata.customer_address_postal_code | body | string | Metadata Customer Address Postal Code. |
| metadata.customer_address_state | body | string | Metadata Customer Address State. |
| metadata.customer_address_type | body | string | Metadata Customer Address Type. |
| metadata.customer_email | body | string | Metadata Customer Email. |
| metadata.customer_name | body | string | Metadata Customer Name. |
| metadata.customer_phone_no | body | string | Metadata Customer Phone No. |
| metadata.customer_reg_no | body | string | Metadata Customer Reg No. |
| metadata.customer_sales_tax_reg_no | body | string | Metadata Customer Sales Tax Reg No. |
| metadata.customer_type | body | string | Metadata Customer Type. |
| metadata.legal_entity_address | body | string | Metadata Legal Entity Address. |
| metadata.legal_entity_email | body | string | Metadata Legal Entity Email. |
| metadata.legal_entity_name | body | string | Metadata Legal Entity Name. |
| metadata.legal_entity_phone_no | body | string | Metadata Legal Entity Phone No. |
| metadata.legal_entity_reg_no | body | string | Metadata Legal Entity Reg No. |
| metadata.legal_entity_sales_tax_reg_no | body | string | Metadata Legal Entity Sales Tax Reg No. |
| metadata.legal_entity_timezone | body | string | Metadata Legal Entity Timezone. |
| metadata.legal_entity_website | body | string | Metadata Legal Entity Website. |
| metadata.receivable_account_id | body | string | Metadata Receivable Account Id. |
| status | body | string | Status. |
| supplier_account_id | body | string | Supplier Account Id. |
| type | body | string | Type. |
Response Example
[
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "domain.com",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"supplier_account_id": null,
"document_number": "RCPT-1",
"date": "2024-01-01T12:00:00.000Z",
"type": "REVERSAL_RECEIPT",
"status": "PROCESSED",
"metadata": {
"amount": "99.00",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"bank_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"legal_entity_timezone": "Africa/Johannesburg",
"legal_entity_name": "XXX",
"legal_entity_email": null,
"legal_entity_phone_no": "0123456789",
"legal_entity_website": null,
"legal_entity_address": "123 Street Road, Suburb, City",
"legal_entity_sales_tax_reg_no": "XXXX",
"legal_entity_reg_no": "XXXX",
"customer_type": "INDIVIDUAL",
"customer_account_code": "CUST-001",
"customer_reg_no": null,
"customer_sales_tax_reg_no": null,
"customer_name": "XXX",
"customer_phone_no": null,
"customer_email": "user@domain.com",
"customer_address_type": "PHYSICAL",
"customer_address_line1": "123 Street Road",
"customer_address_line2": "Suburb",
"customer_address_line3": "City",
"customer_address_line4": null,
"customer_address_state": "Gauteng",
"customer_address_country": "ZA",
"customer_address_postal_code": "0000",
"currency_symbol": "R"
}
},
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "domain.com",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"supplier_account_id": null,
"document_number": "RCPT-2",
"date": "2024-01-02T12:00:00.000Z",
"type": "REVERSAL_RECEIPT",
"status": "PROCESSED",
"metadata": {
"amount": "99.00",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"bank_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"legal_entity_timezone": "Africa/Johannesburg",
"legal_entity_name": "XXX",
"legal_entity_email": null,
"legal_entity_phone_no": "0123456789",
"legal_entity_website": null,
"legal_entity_address": "123 Street Road, Suburb, City",
"legal_entity_sales_tax_reg_no": "XXXX",
"legal_entity_reg_no": "XXXX",
"customer_type": "INDIVIDUAL",
"customer_account_code": "CUST-001",
"customer_reg_no": null,
"customer_sales_tax_reg_no": null,
"customer_name": "XXX",
"customer_phone_no": null,
"customer_email": "user@domain.com",
"customer_address_type": "PHYSICAL",
"customer_address_line1": "123 Street Road",
"customer_address_line2": "Suburb",
"customer_address_line3": "City",
"customer_address_line4": null,
"customer_address_state": "Gauteng",
"customer_address_country": "ZA",
"customer_address_postal_code": "0000",
"currency_symbol": "R"
}
}
]POST
/v2/document/reversalreceipt(billing)
Create Reversal Receipt
Service
billing
billing
Multiple reversal receipts can be created with a single request. Simply include the reversal receipt objects in the "reversal_receipts" parameter.
Either account codes or account IDs can be provided for each line item, if both are provided the IDs will be used by default.
Accepted Roles (RBAC)
AdministratorBilling AccountantBilling AdministratorRequest 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) | |
| legal_entity_id | body | string | Legal Entity Id. | |
| reversal_receipts | body | string | Reversal Receipts. |
Request Example
{
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"reversal_receipts": [
{
"date": "2024-01-01T12:00:00+0200",
"amount": 2864.85,
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"bank_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
}
]
}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 |
|---|---|---|---|
| customer_account_id | body | string | Customer Account Id. |
| date | body | string | Date. |
| document_number | body | string | Document Number. |
| domain | body | string | Entity Domain. |
| id | body | string | Unique Entity ID. |
| legal_entity_id | body | string | Legal Entity Id. |
| metadata | body | object | Metadata. |
| metadata.amount | body | decimal | Metadata Amount. |
| metadata.bank_account_id | body | string | Metadata Bank Account Id. |
| metadata.currency_symbol | body | string | Metadata Currency Symbol. |
| metadata.customer_account_code | body | string | Metadata Customer Account Code. |
| metadata.customer_address_country | body | string | Metadata Customer Address Country. |
| metadata.customer_address_line1 | body | string | Metadata Customer Address Line1. |
| metadata.customer_address_line2 | body | string | Metadata Customer Address Line2. |
| metadata.customer_address_line3 | body | string | Metadata Customer Address Line3. |
| metadata.customer_address_line4 | body | string | Metadata Customer Address Line4. |
| metadata.customer_address_postal_code | body | string | Metadata Customer Address Postal Code. |
| metadata.customer_address_state | body | string | Metadata Customer Address State. |
| metadata.customer_address_type | body | string | Metadata Customer Address Type. |
| metadata.customer_email | body | string | Metadata Customer Email. |
| metadata.customer_name | body | string | Metadata Customer Name. |
| metadata.customer_phone_no | body | string | Metadata Customer Phone No. |
| metadata.customer_reg_no | body | string | Metadata Customer Reg No. |
| metadata.customer_sales_tax_reg_no | body | string | Metadata Customer Sales Tax Reg No. |
| metadata.customer_type | body | string | Metadata Customer Type. |
| metadata.legal_entity_address | body | string | Metadata Legal Entity Address. |
| metadata.legal_entity_email | body | string | Metadata Legal Entity Email. |
| metadata.legal_entity_name | body | string | Metadata Legal Entity Name. |
| metadata.legal_entity_phone_no | body | string | Metadata Legal Entity Phone No. |
| metadata.legal_entity_reg_no | body | string | Metadata Legal Entity Reg No. |
| metadata.legal_entity_sales_tax_reg_no | body | string | Metadata Legal Entity Sales Tax Reg No. |
| metadata.legal_entity_timezone | body | string | Metadata Legal Entity Timezone. |
| metadata.legal_entity_website | body | string | Metadata Legal Entity Website. |
| metadata.receivable_account_id | body | string | Metadata Receivable Account Id. |
| status | body | string | Status. |
| supplier_account_id | body | string | Supplier Account Id. |
| type | body | string | Type. |
Response Example
[
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "domain.com",
"legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"customer_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"supplier_account_id": null,
"document_number": null,
"date": "2024-01-02T12:00:00.000Z",
"type": "REVERSAL_RECEIPT",
"status": "UNPROCESSED",
"metadata": {
"amount": "2864.85",
"receivable_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"bank_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"legal_entity_timezone": "Africa/Johannesburg",
"legal_entity_name": "XXX",
"legal_entity_email": null,
"legal_entity_phone_no": "0123456789",
"legal_entity_website": null,
"legal_entity_address": "123 Street Road, Suburb, City",
"legal_entity_sales_tax_reg_no": "XXXX",
"legal_entity_reg_no": "XXXX",
"customer_type": "INDIVIDUAL",
"customer_account_code": "CUST-001",
"customer_reg_no": null,
"customer_sales_tax_reg_no": null,
"customer_name": "XXX",
"customer_phone_no": null,
"customer_email": "user@domain.com",
"customer_address_type": "PHYSICAL",
"customer_address_line1": "123 Street Road",
"customer_address_line2": "Suburb",
"customer_address_line3": "City",
"customer_address_line4": null,
"customer_address_state": "Gauteng",
"customer_address_country": "ZA",
"customer_address_postal_code": "0000",
"currency_symbol": "R"
}
}
]