»
Invoice GET API Documentation
Retrieve Invoice List: /invoices
GET
https://dev-api.exsited.com/api/v3/invoices
Try It Out
Purpose
This endpoint allows retrieval of detailed information about invoices, including their status, billing periods, associated payments, and financial summaries. It supports pagination for managing large datasets.
Use Case
Businesses can use this endpoint to generate reports, track outstanding balances, review payment history or integrate invoice data into accounting systems.
Path Parameters
No path parameter is required for this endpoint.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Specifies the maximum number of records to return in the response. |
| order_by | String | Determines the sort order; use asc for ascending or desc for descending. |
| offset | Integer | Defines the starting point for retrieving records, used for pagination. |
Request Body
No data is required for the request body.
Response
The response includes a list of invoices, each with metadata such as status, billing periods, payment details, and associated links. Additionally, pagination details like total records, current limit, and next/previous page links are provided to navigate through the data.
Response Body
JSON
{
"invoices": [
{
"status": "ACTIVE",
"id": "INV-PLACEHOLDER",
"type": "LINKED_WITH_ORDER",
"custom_form": {
"uuid": "UUID-PLACEHOLDER",
"name": "CUSTOM_FORM_NAME_PLACEHOLDER"
},
"currency": {
"uuid": "UUID-PLACEHOLDER",
"name": "CURRENCY_NAME_PLACEHOLDER",
"link": "https://api-stage.exsited.com/api/v1/currencies/UUID-PLACEHOLDER"
},
"customer_purchase_order_id": "CUSTOMER_PO_ID_PLACEHOLDER",
"billing_start_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_billing_start_date": "YYYY-MM-DDTHH:MM:SSZ",
"billing_end_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_billing_end_date": "YYYY-MM-DDTHH:MM:SSZ",
"issue_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_issue_date": "YYYY-MM-DDTHH:MM:SSZ",
"due_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_due_date": "YYYY-MM-DDTHH:MM:SSZ",
"subtotal": "AMOUNT_PLACEHOLDER",
"tax": "AMOUNT_PLACEHOLDER",
"tax_total": "AMOUNT_PLACEHOLDER",
"total": "AMOUNT_PLACEHOLDER",
"paid": "AMOUNT_PLACEHOLDER",
"due": "AMOUNT_PLACEHOLDER",
"payment_status": "STATUS_PLACEHOLDER",
"last_payment": {
"id": "PMT-PLACEHOLDER",
"amount": "AMOUNT_PLACEHOLDER",
"created_at": "YYYY-MM-DDTHH:MM:SSZ"
},
"discount_amount": "AMOUNT_PLACEHOLDER",
"price_tax_inclusive": "BOOLEAN_PLACEHOLDER",
"invoice_note": "INVOICE_NOTE_PLACEHOLDER",
"account_id": "ACCOUNT_ID_PLACEHOLDER",
"order_id": "ORDER_ID_PLACEHOLDER",
"created_by": "CREATED_BY_PLACEHOLDER",
"created_on": "YYYY-MM-DDTHH:MM:SSZ",
"last_updated_by": "UPDATED_BY_PLACEHOLDER",
"last_updated_on": "YYYY-MM-DDTHH:MM:SSZ",
"uuid": "UUID-PLACEHOLDER",
"version": "VERSION_PLACEHOLDER",
"custom_attributes": [
{
"name": "ATTRIBUTE_NAME_PLACEHOLDER",
"value": "ATTRIBUTE_VALUE_PLACEHOLDER"
}
],
"custom_objects": [],
"lines": [
{
"subtotal": "AMOUNT_PLACEHOLDER",
"total": "AMOUNT_PLACEHOLDER",
"tax": {
"amount": "AMOUNT_PLACEHOLDER",
"uuid": "UUID-PLACEHOLDER",
"code": "TAX_CODE_PLACEHOLDER",
"rate": "TAX_RATE_PLACEHOLDER",
"link": "https://app-stage.exsited.com/api/v1/taxes/UUID-PLACEHOLDER"
},
"accounting_code": {
"sales_revenue": "SALES_REVENUE_CODE_PLACEHOLDER"
},
"item_uuid": "UUID-PLACEHOLDER",
"item_id": "ITEM_ID_PLACEHOLDER",
"item_order_quantity": "QUANTITY_PLACEHOLDER",
"item_uom": "UOM_PLACEHOLDER",
"item_warehouse": "WAREHOUSE_PLACEHOLDER",
"pricing_snapshot_uuid": "UUID-PLACEHOLDER",
"charging_start_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_charging_start_date": "YYYY-MM-DDTHH:MM:SSZ",
"charging_end_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_charging_end_date": "YYYY-MM-DDTHH:MM:SSZ",
"uuid": "UUID-PLACEHOLDER",
"version": "VERSION_PLACEHOLDER"
}
],
"kpis": {
"outstanding": 0,
"overdue": 0,
"last_payment_date": "YYYY-MM-DDTHH:MM:SSZ",
"payment_applied": 0,
"credit_applied": 0,
"credit_issued": 0,
"last_reactivated_on": "YYYY-MM-DDTHH:MM:SSZ",
"last_cancelled_on": "YYYY-MM-DDTHH:MM:SSZ",
"last_amended_on": "YYYY-MM-DDTHH:MM:SSZ",
"voided_on": "YYYY-MM-DDTHH:MM:SSZ",
"deleted_on": "YYYY-MM-DDTHH:MM:SSZ"
}
}
],
"pagination": {
"records": "RECORDS_COUNT_PLACEHOLDER",
"limit": "LIMIT_PLACEHOLDER",
"offset": "OFFSET_PLACEHOLDER",
"previous_page": "https://api-stage.exsited.com/api/v2/invoices?limit=LIMIT_PLACEHOLDER&offset=OFFSET_PLACEHOLDER",
"next_page": "https://api-stage.exsited.com/api/v2/invoices?limit=LIMIT_PLACEHOLDER&offset=OFFSET_PLACEHOLDER"
}
}
| Attribute | Type | Description |
|---|---|---|
| status | String | Current status of the invoice (example: ACTIVE) |
| id | String | Unique identifier of the invoice (human-readable code) |
| type | String | Type of invoice (example: LINKED_WITH_ORDER) |
| custom_form | Object | Custom form details linked to the invoice |
| currency | Object | Currency information for the invoice |
| customer_purchase_order_id | String | External customer purchase order reference |
| issue_date | String (DateTime) | Date when invoice was issued |
| alternate_issue_date | String (DateTime) | Alternate invoice issue date |
| due_date | String (DateTime) | Due date for payment |
| alternate_due_date | String (DateTime) | Alternate due date for payment |
| subtotal | String (Decimal) | Subtotal amount before taxes/discounts |
| tax | String (Decimal) | Tax applied |
| tax_total | String (Decimal) | Total tax amount |
| total | String (Decimal) | Final total of invoice |
| paid | String (Decimal) | Amount paid |
| due | String (Decimal) | Remaining amount due |
| payment_status | String | Status of payment (example: PAID) |
| last_payment | Object | Information about the last payment |
| discount_amount | String (Decimal) | Total discount applied |
| price_tax_inclusive | String (Boolean) | Whether tax is included in prices |
| invoice_note | String | Additional notes for the invoice |
| account_id | String | Associated account identifier |
| order_id | String | Linked order identifier |
| created_by | String | User who created the invoice |
| created_on | String (DateTime) | Creation timestamp |
| last_updated_by | String | User who last updated the invoice |
| last_updated_on | String (DateTime) | Last update timestamp |
| uuid | String (UUID) | Unique system identifier for invoice |
| version | String | Version number of the record |
| custom_attributes | Array | List of custom attributes applied |
| custom_objects | Array | List of custom objects linked |
| lines | Array | Line items of the invoice |
| kpis | Object | Key performance indicators for invoice |
Retrieve Specific Invoice Details: /invoices/{invoice_id}
GET
https://dev-api.exsited.com/api/v3/invoices/{invoice_id}
Try It Out
Purpose
Retrieves detailed information about a specific invoice, including metadata, billing cycles, payment status, line items, and associated custom attributes. It is primarily used to monitor invoice details and payment history for better financial tracking.
Use Case
Businesses or users use this endpoint to view the status of an invoice, check outstanding payments, review associated line items, or retrieve metadata for financial reporting or customer inquiries.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| invoice_id | String | Unique identifier of the invoice to retrieve. |
Query Parameters
No query parameter is required for this endpoint.
Request Body
No data is required for the request body.
Response
The response provides a detailed structure of the invoice, including its status, payment details, billing period, associated line items, and custom attributes. This data helps in validating transactions and ensuring transparency in financial operations.
Response Body
JSON
{
"invoice": {
"status": "STATUS",
"id": "INVOICE_ID",
"type": "INVOICE_TYPE",
"custom_form": {
"uuid": "FORM_UUID",
"name": "FORM_NAME"
},
"currency": {
"uuid": "CURRENCY_UUID",
"name": "CURRENCY_NAME",
"link": "CURRENCY_LINK"
},
"customer_purchase_order_id": "PURCHASE_ORDER_ID",
"billing_start_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_billing_start_date": "YYYY-MM-DDTHH:MM:SSZ",
"billing_end_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_billing_end_date": "YYYY-MM-DDTHH:MM:SSZ",
"issue_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_issue_date": "YYYY-MM-DDTHH:MM:SSZ",
"due_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_due_date": "YYYY-MM-DDTHH:MM:SSZ",
"subtotal": "SUBTOTAL_AMOUNT",
"tax": "TAX_AMOUNT",
"tax_total": "TAX_TOTAL",
"total": "TOTAL_AMOUNT",
"paid": "PAID_AMOUNT",
"due": "DUE_AMOUNT",
"payment_status": "PAYMENT_STATUS",
"last_payment": {
"id": "PAYMENT_ID",
"amount": "PAYMENT_AMOUNT",
"created_at": "YYYY-MM-DDTHH:MM:SSZ"
},
"discount_amount": "DISCOUNT_AMOUNT",
"price_tax_inclusive": "BOOLEAN",
"invoice_note": "NOTE",
"account_id": "ACCOUNT_ID",
"order_id": "ORDER_ID",
"created_by": "CREATED_BY",
"created_on": "YYYY-MM-DDTHH:MM:SSZ",
"last_updated_by": "LAST_UPDATED_BY",
"last_updated_on": "YYYY-MM-DDTHH:MM:SSZ",
"uuid": "INVOICE_UUID",
"version": "VERSION_NUMBER",
"custom_attributes": [
{
"name": "ATTRIBUTE_NAME",
"value": "ATTRIBUTE_VALUE"
}
],
"custom_objects": [],
"lines": [
{
"subtotal": "LINE_SUBTOTAL",
"total": "LINE_TOTAL",
"tax": {
"amount": "TAX_AMOUNT",
"uuid": "TAX_UUID",
"code": "TAX_CODE",
"rate": "TAX_RATE",
"link": "TAX_LINK"
},
"accounting_code": {
"sales_revenue": "SALES_REVENUE_CODE"
},
"item_uuid": "ITEM_UUID",
"item_id": "ITEM_ID",
"item_order_quantity": "ITEM_QUANTITY",
"item_uom": "UOM",
"item_warehouse": "WAREHOUSE",
"pricing_snapshot_uuid": "PRICING_SNAPSHOT_UUID",
"charging_start_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_charging_start_date": "YYYY-MM-DDTHH:MM:SSZ",
"charging_end_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_charging_end_date": "YYYY-MM-DDTHH:MM:SSZ",
"uuid": "LINE_UUID",
"version": "LINE_VERSION"
}
],
"kpis": {
"outstanding": "OUTSTANDING_AMOUNT",
"overdue": "OVERDUE_AMOUNT",
"last_payment_date": "LAST_PAYMENT_DATE",
"payment_applied": "PAYMENT_APPLIED_AMOUNT",
"credit_applied": "CREDIT_APPLIED_AMOUNT",
"credit_issued": "CREDIT_ISSUED_AMOUNT",
"last_reactivated_on": "LAST_REACTIVATED_DATE",
"last_cancelled_on": "LAST_CANCELLED_DATE",
"last_amended_on": "LAST_AMENDED_DATE",
"voided_on": "VOIDED_DATE",
"deleted_on": "DELETED_DATE"
}
}
}
| Attribute | Type | Description |
|---|---|---|
| status | String | Current status of the invoice (example: ACTIVE) |
| id | String | Unique identifier of the invoice (human-readable code) |
| type | String | Type of invoice (example: LINKED_WITH_ORDER) |
| custom_form | Object | Custom form details linked to the invoice |
| currency | Object | Currency information for the invoice |
| customer_purchase_order_id | String | External customer purchase order reference |
| issue_date | String (DateTime) | Date when invoice was issued |
| alternate_issue_date | String (DateTime) | Alternate invoice issue date |
| due_date | String (DateTime) | Due date for payment |
| alternate_due_date | String (DateTime) | Alternate due date for payment |
| subtotal | String (Decimal) | Subtotal amount before taxes/discounts |
| tax | String (Decimal) | Tax applied |
| tax_total | String (Decimal) | Total tax amount |
| total | String (Decimal) | Final total of invoice |
| paid | String (Decimal) | Amount paid |
| due | String (Decimal) | Remaining amount due |
| payment_status | String | Status of payment (example: PAID) |
| last_payment | Object | Information about the last payment |
| discount_amount | String (Decimal) | Total discount applied |
| price_tax_inclusive | String (Boolean) | Whether tax is included in prices |
| invoice_note | String | Additional notes for the invoice |
| account_id | String | Associated account identifier |
| order_id | String | Linked order identifier |
| created_by | String | User who created the invoice |
| created_on | String (DateTime) | Creation timestamp |
| last_updated_by | String | User who last updated the invoice |
| last_updated_on | String (DateTime) | Last update timestamp |
| uuid | String (UUID) | Unique system identifier for invoice |
| version | String | Version number of the record |
| custom_attributes | Array | List of custom attributes applied |
| custom_objects | Array | List of custom objects linked |
| lines | Array | Line items of the invoice |
| kpis | Object | Key performance indicators for invoice |
Retrieve Information of an Specific Invoice: /invoices/{invoice_id}/information
GET
https://dev-api.exsited.com/api/v3/invoices/{invoice_id}/information
Try It Out
Purpose
This endpoint provides comprehensive information about a specific invoice, including its metadata, billing details, payment status, applied discounts, custom attributes and associated KPIs. It is used for in-depth financial analysis and invoice management.
Use Case
Companies or users utilize this endpoint to retrieve a full breakdown of invoice details, such as billing periods, payment progress, outstanding balances, and related metadata, to ensure accurate tracking and effective customer support.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| invoice_id | String | Unique identifier of the invoice for which information is being requested. |
Query Parameters
No query parameter is required for this endpoint.
Request Body
No data is required for the request body.
Response
The response returns detailed invoice data, including general information, billing periods, payment status, associated metadata, and custom attributes. This information supports accurate tracking of invoice statuses and facilitates effective business decisions.
Response Body
JSON
{
"invoice": {
"status": "STATUS",
"id": "INVOICE_ID",
"type": "INVOICE_TYPE",
"custom_form": {
"uuid": "FORM_UUID",
"name": "FORM_NAME"
},
"currency": {
"uuid": "CURRENCY_UUID",
"name": "CURRENCY_NAME",
"link": "CURRENCY_LINK"
},
"customer_purchase_order_id": "PURCHASE_ORDER_ID",
"billing_start_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_billing_start_date": "YYYY-MM-DDTHH:MM:SSZ",
"billing_end_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_billing_end_date": "YYYY-MM-DDTHH:MM:SSZ",
"issue_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_issue_date": "YYYY-MM-DDTHH:MM:SSZ",
"due_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_due_date": "YYYY-MM-DDTHH:MM:SSZ",
"subtotal": "SUBTOTAL_AMOUNT",
"tax": "TAX_AMOUNT",
"total": "TOTAL_AMOUNT",
"paid": "PAID_AMOUNT",
"due": "DUE_AMOUNT",
"payment_status": "PAYMENT_STATUS",
"last_payment": {
"id": "PAYMENT_ID",
"amount": "PAYMENT_AMOUNT",
"created_at": "YYYY-MM-DDTHH:MM:SSZ"
},
"discount_amount": "DISCOUNT_AMOUNT",
"price_tax_inclusive": "BOOLEAN",
"invoice_note": "NOTE",
"account_id": "ACCOUNT_ID",
"order_id": "ORDER_ID",
"kpis": {
"outstanding": "OUTSTANDING_AMOUNT",
"overdue": "OVERDUE_AMOUNT",
"last_payment_date": "LAST_PAYMENT_DATE",
"payment_applied": "PAYMENT_APPLIED_AMOUNT",
"credit_applied": "CREDIT_APPLIED_AMOUNT",
"credit_issued": "CREDIT_ISSUED_AMOUNT",
"last_reactivated_on": "LAST_REACTIVATED_DATE",
"last_cancelled_on": "LAST_CANCELLED_DATE",
"last_amended_on": "LAST_AMENDED_DATE",
"voided_on": "VOIDED_DATE",
"deleted_on": "DELETED_DATE"
},
"created_by": "CREATOR_NAME",
"created_on": "YYYY-MM-DDTHH:MM:SSZ",
"last_updated_by": "UPDATER_NAME",
"last_updated_on": "YYYY-MM-DDTHH:MM:SSZ",
"uuid": "INVOICE_UUID",
"version": "VERSION_NUMBER",
"custom_attributes": [
{
"name": "ATTRIBUTE_NAME",
"value": "ATTRIBUTE_VALUE"
}
],
"custom_objects": []
}
}
| Attribute | Type | Description |
|---|---|---|
| status | String | Current status of the invoice (example: ACTIVE) |
| id | String | Unique identifier of the invoice (human-readable code) |
| type | String | Type of invoice (example: LINKED_WITH_ORDER) |
| custom_form | Object | Custom form details linked to the invoice |
| currency | Object | Currency information for the invoice |
| customer_purchase_order_id | String | External customer purchase order reference |
| issue_date | String (DateTime) | Date when invoice was issued |
| alternate_issue_date | String (DateTime) | Alternate invoice issue date |
| due_date | String (DateTime) | Due date for payment |
| alternate_due_date | String (DateTime) | Alternate due date for payment |
| subtotal | String (Decimal) | Subtotal amount before taxes/discounts |
| tax | String (Decimal) | Tax applied |
| tax_total | String (Decimal) | Total tax amount |
| total | String (Decimal) | Final total of invoice |
| paid | String (Decimal) | Amount paid |
| due | String (Decimal) | Remaining amount due |
| payment_status | String | Status of payment (example: PAID) |
| last_payment | Object | Information about the last payment |
| discount_amount | String (Decimal) | Total discount applied |
| price_tax_inclusive | String (Boolean) | Whether tax is included in prices |
| invoice_note | String | Additional notes for the invoice |
| account_id | String | Associated account identifier |
| order_id | String | Linked order identifier |
| created_by | String | User who created the invoice |
| created_on | String (DateTime) | Creation timestamp |
| last_updated_by | String | User who last updated the invoice |
| last_updated_on | String (DateTime) | Last update timestamp |
| uuid | String (UUID) | Unique system identifier for invoice |
| version | String | Version number of the record |
| custom_attributes | Array | List of custom attributes applied |
| custom_objects | Array | List of custom objects linked |
| lines | Array | Line items of the invoice |
| kpis | Object | Key performance indicators for invoice |
Retrieve Invoices of an Order: /orders/{order_id}/invoices
GET
https://dev-api.exsited.com/api/v3/orders/{order_id}/invoices
Try It Out
Purpose
Retrieve all invoices linked to a specific order, including details such as invoice status, payment information, and associated items.
Use Case
To fetch detailed information about all invoices tied to an order, useful for financial reconciliation or tracking order-related payments.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| order_id | String | The unique identifier of the order for which invoices are to be retrieved. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Optional. Number of records to return per page. Default is 20. |
| offset | integer | Optional. Number of records to skip for pagination. Default is 0. |
Request Body
No data is required for the request body.
Response
Provides a list of invoices associated with the given order, including invoice details such as amounts, due dates, payment statuses, and itemized line details. Pagination information is also included for navigating through the dataset.
Response Body
JSON
{
"order": {
"invoices": [
{
"status": "STATUS",
"id": "INVOICE_ID",
"type": "INVOICE_TYPE",
"custom_form": {
"uuid": "FORM_UUID",
"name": "FORM_NAME"
},
"currency": {
"uuid": "CURRENCY_UUID",
"name": "CURRENCY_NAME",
"link": "CURRENCY_LINK"
},
"customer_purchase_order_id": "PURCHASE_ORDER_ID",
"billing_start_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_billing_start_date": "YYYY-MM-DDTHH:MM:SSZ",
"billing_end_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_billing_end_date": "YYYY-MM-DDTHH:MM:SSZ",
"issue_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_issue_date": "YYYY-MM-DDTHH:MM:SSZ",
"due_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_due_date": "YYYY-MM-DDTHH:MM:SSZ",
"subtotal": "SUBTOTAL_AMOUNT",
"tax": "TAX_AMOUNT",
"total": "TOTAL_AMOUNT",
"paid": "PAID_AMOUNT",
"due": "DUE_AMOUNT",
"payment_status": "PAYMENT_STATUS",
"last_payment": {
"id": "PAYMENT_ID",
"amount": "PAYMENT_AMOUNT",
"created_at": "YYYY-MM-DDTHH:MM:SSZ"
},
"discount_amount": "DISCOUNT_AMOUNT",
"price_tax_inclusive": "BOOLEAN",
"invoice_note": "NOTE",
"account_id": "ACCOUNT_ID",
"order_id": "ORDER_ID",
"kpis": {
"outstanding": "OUTSTANDING_AMOUNT",
"overdue": "OVERDUE_AMOUNT",
"last_payment_date": "LAST_PAYMENT_DATE",
"payment_applied": "PAYMENT_APPLIED_AMOUNT",
"credit_applied": "CREDIT_APPLIED_AMOUNT",
"credit_issued": "CREDIT_ISSUED_AMOUNT",
"last_reactivated_on": "LAST_REACTIVATED_DATE",
"last_cancelled_on": "LAST_CANCELLED_DATE",
"last_amended_on": "LAST_AMENDED_DATE",
"voided_on": "VOIDED_DATE",
"deleted_on": "DELETED_DATE"
},
"created_by": "CREATOR_NAME",
"created_on": "YYYY-MM-DDTHH:MM:SSZ",
"last_updated_by": "UPDATER_NAME",
"last_updated_on": "YYYY-MM-DDTHH:MM:SSZ",
"uuid": "INVOICE_UUID",
"version": "VERSION_NUMBER",
"custom_attributes": [
{
"name": "ATTRIBUTE_NAME",
"value": "ATTRIBUTE_VALUE"
}
],
"custom_objects": [],
"lines": [
{
"subtotal": "LINE_SUBTOTAL",
"total": "LINE_TOTAL",
"tax": {
"amount": "LINE_TAX_AMOUNT",
"uuid": "TAX_UUID",
"code": "TAX_CODE",
"rate": "TAX_RATE",
"link": "TAX_LINK"
},
"accounting_code": {
"sales_revenue": "REVENUE_CODE"
},
"item_uuid": "ITEM_UUID",
"item_id": "ITEM_ID",
"item_order_quantity": "ITEM_QUANTITY",
"item_uom": "UNIT_OF_MEASURE",
"item_warehouse": "WAREHOUSE_NAME",
"pricing_snapshot_uuid": "PRICING_SNAPSHOT_UUID",
"charging_start_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_charging_start_date": "YYYY-MM-DDTHH:MM:SSZ",
"charging_end_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_charging_end_date": "YYYY-MM-DDTHH:MM:SSZ",
"uuid": "LINE_UUID",
"version": "LINE_VERSION"
}
]
}
],
"pagination": {
"records": "RECORD_COUNT",
"limit": "PAGE_LIMIT",
"offset": "PAGE_OFFSET",
"previous_page": "PREVIOUS_PAGE_LINK",
"next_page": "NEXT_PAGE_LINK"
}
}
}
| Attribute | Type | Description |
|---|---|---|
| status | String | Current status of the invoice (example: ACTIVE) |
| id | String | Unique identifier of the invoice (human-readable code) |
| type | String | Type of invoice (example: LINKED_WITH_ORDER) |
| custom_form | Object | Custom form details linked to the invoice |
| currency | Object | Currency information for the invoice |
| customer_purchase_order_id | String | External customer purchase order reference |
| issue_date | String (DateTime) | Date when invoice was issued |
| alternate_issue_date | String (DateTime) | Alternate invoice issue date |
| due_date | String (DateTime) | Due date for payment |
| alternate_due_date | String (DateTime) | Alternate due date for payment |
| subtotal | String (Decimal) | Subtotal amount before taxes/discounts |
| tax | String (Decimal) | Tax applied |
| tax_total | String (Decimal) | Total tax amount |
| total | String (Decimal) | Final total of invoice |
| paid | String (Decimal) | Amount paid |
| due | String (Decimal) | Remaining amount due |
| payment_status | String | Status of payment (example: PAID) |
| last_payment | Object | Information about the last payment |
| discount_amount | String (Decimal) | Total discount applied |
| price_tax_inclusive | String (Boolean) | Whether tax is included in prices |
| invoice_note | String | Additional notes for the invoice |
| account_id | String | Associated account identifier |
| order_id | String | Linked order identifier |
| created_by | String | User who created the invoice |
| created_on | String (DateTime) | Creation timestamp |
| last_updated_by | String | User who last updated the invoice |
| last_updated_on | String (DateTime) | Last update timestamp |
| uuid | String (UUID) | Unique system identifier for invoice |
| version | String | Version number of the record |
| custom_attributes | Array | List of custom attributes applied |
| custom_objects | Array | List of custom objects linked |
| lines | Array | Line items of the invoice |
| kpis | Object | Key performance indicators for invoice |
Retrieve Invoices of an Account: /accounts/{account_id}/invoices
GET
https://dev-api.exsited.com/api/v3/accounts/{account_id}/invoices
Try It Out
Purpose
This endpoint retrieves the list of invoices associated with a specific account. It includes detailed information such as invoice status, billing details, payment information, and line item breakdown.
Use Case
Use this endpoint to fetch a comprehensive summary of invoices for a given account, including outstanding balances, payment history, and billing periods, to streamline financial reporting and account management.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| account_id | String | Unique identifier of the account whose invoices need to be retrieved. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Optional. Number of records to return per page. Default is 20. |
| offset | integer | Optional. Number of records to skip for pagination. Default is 0. |
Request Body
No data is required for the request body.
Response
The response provides a detailed overview of the account's invoices, including status, type, billing period, payment status, and associated line items. Pagination metadata is also included for handling multiple invoices.
Response Body
JSON
{
"account": {
"invoices": [
{
"status": "STATUS",
"id": "INVOICE_ID",
"type": "INVOICE_TYPE",
"custom_form": {
"uuid": "FORM_UUID",
"name": "FORM_NAME"
},
"currency": {
"uuid": "CURRENCY_UUID",
"name": "CURRENCY_NAME",
"link": "CURRENCY_LINK"
},
"customer_purchase_order_id": "PURCHASE_ORDER_ID",
"billing_start_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_billing_start_date": "YYYY-MM-DDTHH:MM:SSZ",
"billing_end_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_billing_end_date": "YYYY-MM-DDTHH:MM:SSZ",
"issue_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_issue_date": "YYYY-MM-DDTHH:MM:SSZ",
"due_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_due_date": "YYYY-MM-DDTHH:MM:SSZ",
"subtotal": "SUBTOTAL_AMOUNT",
"tax": "TAX_AMOUNT",
"total": "TOTAL_AMOUNT",
"paid": "PAID_AMOUNT",
"due": "DUE_AMOUNT",
"shipping_cost": "SHIPPING_COST",
"payment_status": "PAYMENT_STATUS",
"last_payment": {
"id": "PAYMENT_ID",
"amount": "PAYMENT_AMOUNT",
"created_at": "YYYY-MM-DDTHH:MM:SSZ"
},
"discount_amount": "DISCOUNT_AMOUNT",
"price_tax_inclusive": "PRICE_TAX_INCLUSIVE",
"invoice_note": "NOTE",
"account_id": "ACCOUNT_ID",
"account_name": "ACCOUNT_NAME",
"order_id": "ORDER_ID",
"kpis": {
"outstanding": "OUTSTANDING_AMOUNT",
"overdue": "OVERDUE_AMOUNT",
"last_payment_date": "LAST_PAYMENT_DATE",
"payment_applied": "PAYMENT_APPLIED_AMOUNT",
"credit_applied": "CREDIT_APPLIED_AMOUNT",
"credit_issued": "CREDIT_ISSUED_AMOUNT",
"last_reactivated_on": "YYYY-MM-DDTHH:MM:SSZ",
"last_cancelled_on": "YYYY-MM-DDTHH:MM:SSZ",
"last_amended_on": "YYYY-MM-DDTHH:MM:SSZ",
"voided_on": "YYYY-MM-DDTHH:MM:SSZ",
"deleted_on": "YYYY-MM-DDTHH:MM:SSZ"
},
"created_by": "CREATED_BY",
"created_on": "YYYY-MM-DDTHH:MM:SSZ",
"last_updated_by": "UPDATED_BY",
"last_updated_on": "YYYY-MM-DDTHH:MM:SSZ",
"uuid": "INVOICE_UUID",
"version": "VERSION",
"custom_attributes": [
{
"name": "ATTRIBUTE_NAME",
"value": "ATTRIBUTE_VALUE"
}
],
"custom_objects": [],
"lines": [
{
"subtotal": "LINE_SUBTOTAL",
"total": "LINE_TOTAL",
"tax": {
"amount": "TAX_AMOUNT",
"uuid": "TAX_UUID",
"code": "TAX_CODE",
"rate": "TAX_RATE",
"link": "TAX_LINK"
},
"accounting_code": {
"sales_revenue": "SALES_REVENUE"
},
"item_uuid": "ITEM_UUID",
"item_id": "ITEM_ID",
"item_name": "ITEM_NAME",
"item_order_quantity": "ITEM_ORDER_QUANTITY",
"item_uom": "ITEM_UOM",
"item_warehouse": "ITEM_WAREHOUSE",
"pricing_snapshot_uuid": "PRICING_SNAPSHOT_UUID",
"charging_start_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_charging_start_date": "YYYY-MM-DDTHH:MM:SSZ",
"charging_end_date": "YYYY-MM-DDTHH:MM:SSZ",
"alternate_charging_end_date": "YYYY-MM-DDTHH:MM:SSZ",
"uuid": "LINE_UUID",
"version": "LINE_VERSION"
}
]
}
],
"pagination": {
"records": "RECORD_COUNT",
"limit": "LIMIT",
"offset": "OFFSET",
"previous_page": "PREVIOUS_PAGE",
"next_page": "NEXT_PAGE"
}
}
}
| Attribute | Type | Description |
|---|---|---|
| status | String | Current status of the invoice (example: ACTIVE) |
| id | String | Unique identifier of the invoice (human-readable code) |
| type | String | Type of invoice (example: LINKED_WITH_ORDER) |
| custom_form | Object | Custom form details linked to the invoice |
| currency | Object | Currency information for the invoice |
| customer_purchase_order_id | String | External customer purchase order reference |
| issue_date | String (DateTime) | Date when invoice was issued |
| alternate_issue_date | String (DateTime) | Alternate invoice issue date |
| due_date | String (DateTime) | Due date for payment |
| alternate_due_date | String (DateTime) | Alternate due date for payment |
| subtotal | String (Decimal) | Subtotal amount before taxes/discounts |
| tax | String (Decimal) | Tax applied |
| tax_total | String (Decimal) | Total tax amount |
| total | String (Decimal) | Final total of invoice |
| paid | String (Decimal) | Amount paid |
| due | String (Decimal) | Remaining amount due |
| payment_status | String | Status of payment (example: PAID) |
| last_payment | Object | Information about the last payment |
| discount_amount | String (Decimal) | Total discount applied |
| price_tax_inclusive | String (Boolean) | Whether tax is included in prices |
| invoice_note | String | Additional notes for the invoice |
| account_id | String | Associated account identifier |
| order_id | String | Linked order identifier |
| created_by | String | User who created the invoice |
| created_on | String (DateTime) | Creation timestamp |
| last_updated_by | String | User who last updated the invoice |
| last_updated_on | String (DateTime) | Last update timestamp |
| uuid | String (UUID) | Unique system identifier for invoice |
| version | String | Version number of the record |
| custom_attributes | Array | List of custom attributes applied |
| custom_objects | Array | List of custom objects linked |
| lines | Array | Line items of the invoice |
| kpis | Object | Key performance indicators for invoice |
Retrieve PDF of an Invoice: /invoices/{invoice_id}/pdf
GET
https://dev-api.exsited.com/api/v3/invoices/{invoice_id}/pdf
Try It Out
Purpose
This endpoint retrieves the PDF representation of a specific invoice identified by its invoice ID. It provides the invoice in a ready-to-download and shareable format, including all relevant billing, item, and payment details.
Use Case
Businesses or users can use this endpoint to generate a detailed PDF of an invoice for record-keeping, sharing with customers, or auditing purposes. For example, a client might request a copy of their invoice in PDF format for their own financial tracking.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| invoice_id | String | Unique identifier of the invoice. |
Query Parameters
No query parameter is required for this endpoint.
Request Body
No data is required for the request body.
Response
The response is a PDF file containing the full invoice details, including the billing and shipping addresses, itemized charges, tax information, and total amount paid or due.
Response Body
Retrieve Invoice Notes: /invoices/{invoice_id}/notes
GET
https://dev-api.exsited.com/api/v3/invoices/{invoice_id}/notes
Try It Out
Purpose
This endpoint retrieves all notes associated with a specific invoice. Each note may include text content, optional file attachments, creator details, and audit metadata. The response also provides pagination information to handle multiple notes efficiently.
Use Case
- Retrieve a history of annotations, discussions, or comments made on a specific invoice.
- Fetch supporting documents attached to an invoice.
- Display invoice-related notes for auditing, collaboration, or customer support.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | Yes | Unique identifier of the invoice. |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | int | No | Maximum number of records to return (default: 20). |
| offset | int | No | Number of records to skip for pagination. |
Request Body
This endpoint does not require a request body.
Response
On success, the API returns the invoice object containing an array of notes associated with the invoice. Each note includes a unique identifier, version, content (supports HTML), optional file attachments, creator information, creation and update timestamps, and any defined custom attributes. The response also contains pagination details for handling multiple notes.
Response Body
JSON
{
"invoice": {
"notes": [
{
"uuid": "{{NOTE_UUID}}",
"version": "1",
"content": "<p>{{note_content}}</p>",
"files": [],
"created_by": "{{user_name}}",
"created_on": "{{created_timestamp}}",
"last_updated_by": "{{last_updated_user}}",
"last_updated_on": "{{last_updated_timestamp}}",
"custom_attributes": []
}
],
"pagination": {
"records": 1,
"limit": 20,
"offset": 0,
"previous_page": "",
"next_page": "NULL"
}
}
}
| Attribute | Type | Description |
|---|---|---|
| invoice | object | Container object holding notes related to the invoice. |
| invoice.notes | array | List of notes associated with the invoice. |
| invoice.notes[].uuid | string | Unique identifier of the note (UUID). |
| invoice.notes[].version | string | Version of the note (used for concurrency control). |
| invoice.notes[].content | string | Content of the note (supports HTML formatting). |
| invoice.notes[].files | array | List of files attached to the note (if any). |
| invoice.notes[].created_by | string | Name of the user who created the note. |
| invoice.notes[].created_on | string | Timestamp when the note was created (ISO 8601 format). |
| invoice.notes[].last_updated_by | string | Name of the user who last updated the note (if any). |
| invoice.notes[].last_updated_on | string | Timestamp when the note was last updated (ISO 8601 format). |
| invoice.notes[].custom_attributes | array | Custom attributes defined for the note. |
| invoice.pagination | object | Pagination details for navigating multiple notes. |
| invoice.pagination.records | int | Total number of notes retrieved. |
| invoice.pagination.limit | int | Maximum number of records returned per request. |
| invoice.pagination.offset | int | Number of records skipped for pagination. |
| invoice.pagination.previous_page | string | Link to the previous page of results (if available). |
| invoice.pagination.next_page | string | Link to the next page of results (if available). |
Retrieve Invoice Note Details: /invoices/{invoice_id}/notes/{NOTE_UUID}
GET
https://dev-api.exsited.com/api/v3/invoices/{invoice_id}/notes/{NOTE_UUID}
Try It Out
Purpose
This endpoint retrieves details of a specific note associated with a given invoice. It returns note content, optional file attachments, creator details, timestamps, and custom attributes.
Use Case
- Fetch the full details of a specific note added to an invoice.
- Retrieve audit information such as who created or last updated the note.
- Load attached files related to a particular invoice note.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | Yes | Unique identifier of the invoice. |
| NOTE_UUID | string | Yes | Unique identifier of the note (UUID). |
Query Parameters
This endpoint does not support query parameters.
Request Body
This endpoint does not require a request body.
Response
On success, the API returns an invoice object containing a note object. The note includes its unique identifier, version, content (HTML-supported), file attachments, creator details, creation timestamp, last update information, and any defined custom attributes.
Response Body
JSON
{
"invoice": {
"note": {
"uuid": "{{NOTE_UUID}}",
"version": "1",
"content": "<p>{{note_content}}</p>",
"files": [],
"created_by": "{{user_name}}",
"created_on": "{{created_timestamp}}",
"last_updated_by": "{{last_updated_user}}",
"last_updated_on": "{{last_updated_timestamp}}",
"custom_attributes": []
}
}
}
| Attribute | Type | Description |
|---|---|---|
| invoice | object | Container object holding the invoice note. |
| invoice.note | object | The note object containing details of the specific invoice note. |
| invoice.note.uuid | string | Unique identifier of the note (UUID). |
| invoice.note.version | string | Version number of the note (used for concurrency control). |
| invoice.note.content | string | Content of the note (supports HTML formatting). |
| invoice.note.files | array | List of files attached to the note (if any). |
| invoice.note.created_by | string | Name of the user who created the note. |
| invoice.note.created_on | string | Timestamp when the note was created (ISO 8601 format). |
| invoice.note.last_updated_by | string | Name of the user who last updated the note (if any). |
| invoice.note.last_updated_on | string | Timestamp when the note was last updated (ISO 8601 format). |
| invoice.note.custom_attributes | array | Custom attributes defined for the note. |
Retrieve All Files of a Specific Invoice Note: /invoices/{invoice_iD}/notes/{NOTE_UUID}/files
GET
https://dev-api.exsited.com/api/v3/invoices/{invoice_iD}/notes/{NOTE_UUID}/files
Try It Out
Purpose
This endpoint retrieves all files attached to a specific note within an invoice. It allows you to list file details such as UUID, filename, and version for auditing or downloading purposes.
Use Case
- Retrieve a list of files linked to a particular note in an invoice.
- Display file metadata (name, version, identifiers) in an application.
- Manage attached documents or images for invoice notes.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | Yes | Unique identifier of the invoice. |
| NOTE_UUID | string | Yes | Unique identifier of the note (UUID). |
Query Parameters
This endpoint does not support query parameters.
Request Body
This endpoint does not require a request body.
Response
On success, the API returns an invoice object containing a note object. Inside the note, the files array lists all files attached to the note, including their UUIDs, names, and version numbers. The response also includes custom_attributes if any are defined.
Response Body
JSON
{
"invoice": {
"note": {
"files": [
{
"uuid": "{{FILE_UUID}}",
"name": "{{file_name}}",
"version": "1"
}
],
"custom_attributes": []
}
}
}
| Attribute | Type | Description |
|---|---|---|
| invoice | object | Container object holding the invoice note. |
| invoice.note | object | The note object that contains file details. |
| invoice.note.files | array | List of files attached to the note. |
| invoice.note.files[].uuid | string | Unique identifier of the file (UUID). |
| invoice.note.files[].name | string | Name of the file (including extension). |
| invoice.note.files[].version | string | Version number of the file (used for concurrency control). |
| invoice.note.custom_attributes | array | Custom attributes defined for the note. |
Retrieve a Specific File from an Invoice Note: /invoices/{invoice_id}/notes/{NOTE_UUID}/files/{FILE_UUID}
GET
https://dev-api.exsited.com/api/v3/invoices/{invoice_id}/notes/{NOTE_UUID}/files/{FILE_UUID}
Try It Out
Purpose
This endpoint retrieves details of a specific file attached to a note within an invoice. It allows you to access metadata about the file such as its unique identifier, name, and version.
Use Case
- Fetch metadata for a specific file linked to an invoice note.
- Validate file existence before download.
- Display details of the file (name, version, UUID) in a user interface.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | Yes | Unique identifier of the invoice. |
| NOTE_UUID | string | Yes | Unique identifier of the note (UUID). |
| FILE_UUID | string | Yes | Unique identifier of the file (UUID). |
Query Parameters
This endpoint does not support query parameters.
Request Body
This endpoint does not require a request body.
Response
On success, the API returns an invoice object containing a note object. The note object includes a single file object with its UUID, name, and version. Additionally, custom_attributes may be present to store client-defined metadata.
Response Body
JSON
{
"invoice": {
"note": {
"file": {
"uuid": "{{FILE_UUID}}",
"name": "{{file_name}}",
"version": "1"
},
"custom_attributes": []
}
}
}
| Attribute | Type | Description |
|---|---|---|
| invoice | object | Container object holding the invoice note. |
| invoice.note | object | The note object that contains the requested file. |
| invoice.note.file | object | File object representing the specific attached file. |
| invoice.note.file.uuid | string | Unique identifier of the file (UUID). |
| invoice.note.file.name | string | Name of the file (including extension). |
| invoice.note.file.version | string | Version number of the file (used for concurrency control). |
| invoice.note.custom_attributes | array | Custom attributes defined for the note. |