Retrieve Purchase Invoice List: /purchase-invoices
Purpose
Retrieve a paginated list of all purchase invoices from the system. This includes invoice metadata, associated lines, currency, and KPIs (Key Performance Indicators) for financial tracking.
Use Case
A procurement officer or finance team member wants to view all purchase invoices issued in the system. This API is used to:
- Display invoice history in a UI.
- Fetch data for financial reporting.
- Filter invoices by account or status using optional parameters.
Path Parameters
This endpoint does not require any path parameters.
Query Parameters
Parameter | Type | Description |
---|---|---|
limit |
int | Number of records to return per page (default: 20). |
offset |
int | Number of records to skip for pagination. |
status |
string | Filter invoices by status (e.g., ACTIVE , VOID , DRAFT ). |
account_id |
string | Filter invoices by account ID. |
issue_date_from |
string (ISO 8601) | Filter invoices issued on or after this date. |
issue_date_to |
string (ISO 8601) | Filter invoices issued on or before this date. |
Request Body
No request body is required for this endpoint.
Response
The response includes a paginated list of purchase invoice objects with detailed data such as status, issue/due dates, currency, invoice lines, totals, related purchase orders, and financial KPIs. It also includes pagination metadata for client-side navigation.
Response Body
{
"purchase_invoices": [
{
"status": "ACTIVE",
"id": "PI-DQLP9B-0001",
"custom_form": {},
"currency": {
"id": "1",
"name": "AUD",
"link": {
"rel": "self",
"href": "https://dev-api.exsited.com/api/v1/currencies/1"
}
},
"issue_date": "2025-07-20T00:00:00Z",
"alternate_issue_date": "2025-07-20T00:00:00Z",
"due_date": "2025-07-20T00:00:00Z",
"alternate_due_date": "2025-07-20T00:00:00Z",
"subtotal": "",
"tax": "",
"total": "50.000000",
"price_tax_inclusive": "true",
"account_id": "DQLP9B",
"purchase_order_id": "PO-DQLP9B-0001",
"created_by": "Implementer",
"created_on": "2025-07-20T08:50:23Z",
"last_updated_by": "saeed",
"last_updated_on": "2025-07-30T04:05:54Z",
"uuid": "8499f7e3-b120-4f5c-a17e-21ef83e0ea1d",
"version": "3",
"custom_attributes": [],
"custom_objects": [],
"lines": [
{
"subtotal": "50.000000",
"total": "50.000000",
"tax": "0.000000",
"accounting_code": "Account Receivable",
"item_uuid": "8a83dc00-1976-4b51-923f-1ec8837c242c",
"item_purchase_order_quantity": "1.000000",
"item_uom": "",
"item_warehouse": "Default Warehouse",
"uuid": "26eb02eb-8d0c-40e3-82e9-984cb9e67a3b",
"version": "0"
}
],
"kpis": {
"outstanding": 0,
"overdue": 0,
"last_payment_date": "",
"payment_applied": 0,
"credit_applied": 0,
"credit_issued": "",
"last_reactivated_on": "",
"last_cancelled_on": "",
"last_amended_on": "",
"voided_on": "",
"deleted_on": ""
}
},
{
"status": "ACTIVE",
"id": "PI-DQLP9B-0002",
"custom_form": {},
"currency": {
"id": "1",
"name": "AUD",
"link": {
"rel": "self",
"href": "https://dev-api.exsited.com/api/v1/currencies/1"
}
},
"issue_date": "2025-07-20T00:00:00Z",
"alternate_issue_date": "2025-07-20T00:00:00Z",
"due_date": "2025-07-20T00:00:00Z",
"alternate_due_date": "2025-07-20T00:00:00Z",
"subtotal": "",
"tax": "",
"total": "350.000000",
"price_tax_inclusive": "true",
"account_id": "DQLP9B",
"purchase_order_id": "",
"created_by": "Implementer",
"created_on": "2025-07-20T10:17:35Z",
"last_updated_by": "",
"last_updated_on": "",
"uuid": "c611b4bf-be32-453f-9dce-1eecd90d3911",
"version": "1",
"custom_attributes": [],
"custom_objects": [],
"lines": [
{
"subtotal": "350.000000",
"total": "350.000000",
"tax": "0.000000",
"accounting_code": "Account Receivable",
"item_uuid": "",
"item_purchase_order_quantity": "5.000000",
"item_uom": "",
"item_warehouse": "Default Warehouse",
"uuid": "2f5f5d1e-5441-4ecc-a0c8-880089cd1855",
"version": "0"
}
],
"kpis": {
"outstanding": 0,
"overdue": 0,
"last_payment_date": "",
"payment_applied": 0,
"credit_applied": 0,
"credit_issued": "",
"last_reactivated_on": "",
"last_cancelled_on": "",
"last_amended_on": "",
"voided_on": "",
"deleted_on": ""
}
},
{
"status": "ACTIVE",
"id": "PI-DQLP9B-0003",
"custom_form": {},
"currency": {
"id": "1",
"name": "AUD",
"link": {
"rel": "self",
"href": "https://dev-api.exsited.com/api/v1/currencies/1"
}
},
"issue_date": "2025-07-27T00:00:00Z",
"alternate_issue_date": "2025-07-27T00:00:00Z",
"due_date": "2025-07-27T00:00:00Z",
"alternate_due_date": "2025-07-27T00:00:00Z",
"subtotal": "",
"tax": "",
"total": "1500.000000",
"price_tax_inclusive": "true",
"account_id": "DQLP9B",
"purchase_order_id": "",
"created_by": "Implementer",
"created_on": "2025-07-27T05:51:56Z",
"last_updated_by": "",
"last_updated_on": "",
"uuid": "eb361cf8-17d8-41f7-a00f-df57d68db057",
"version": "0",
"custom_attributes": [],
"custom_objects": [],
"lines": [
{
"subtotal": "1500.000000",
"total": "1500.000000",
"tax": "0.000000",
"accounting_code": "Account Receivable",
"item_uuid": "",
"item_purchase_order_quantity": "10.000000",
"item_uom": "",
"item_warehouse": "Default Warehouse",
"uuid": "365ee374-4f04-4afe-8790-24c61fdca122",
"version": "0"
}
],
"kpis": {
"outstanding": 0,
"overdue": 0,
"last_payment_date": "",
"payment_applied": 0,
"credit_applied": 0,
"credit_issued": "",
"last_reactivated_on": "",
"last_cancelled_on": "",
"last_amended_on": "",
"voided_on": "",
"deleted_on": ""
}
},
{
"status": "ACTIVE",
"id": "PI-7O8DW7-0004",
"custom_form": {},
"currency": {
"id": "1",
"name": "AUD",
"link": {
"rel": "self",
"href": "https://dev-api.exsited.com/api/v1/currencies/1"
}
},
"issue_date": "2025-07-27T00:00:00Z",
"alternate_issue_date": "2025-07-27T00:00:00Z",
"due_date": "2025-07-27T00:00:00Z",
"alternate_due_date": "2025-07-27T00:00:00Z",
"subtotal": "",
"tax": "",
"total": "1000.000000",
"price_tax_inclusive": "true",
"account_id": "7O8DW7",
"purchase_order_id": "",
"created_by": "Implementer",
"created_on": "2025-07-27T08:09:33Z",
"last_updated_by": "",
"last_updated_on": "",
"uuid": "7ce74a23-a760-4b12-9aac-ec750b4e2771",
"version": "0",
"custom_attributes": [],
"custom_objects": [],
"lines": [
{
"subtotal": "1000.000000",
"total": "1000.000000",
"tax": "0.000000",
"accounting_code": "Account Receivable",
"item_uuid": "",
"item_purchase_order_quantity": "20.000000",
"item_uom": "",
"item_warehouse": "Default Warehouse",
"uuid": "6bf3a78a-94b7-4128-8ffd-a58c778de17c",
"version": "0"
}
],
"kpis": {
"outstanding": 0,
"overdue": 0,
"last_payment_date": "",
"payment_applied": 0,
"credit_applied": 0,
"credit_issued": "",
"last_reactivated_on": "",
"last_cancelled_on": "",
"last_amended_on": "",
"voided_on": "",
"deleted_on": ""
}
},
{
"status": "ACTIVE",
"id": "PI-DQLP9B-0005",
"custom_form": {},
"currency": {
"id": "1",
"name": "AUD",
"link": {
"rel": "self",
"href": "https://dev-api.exsited.com/api/v1/currencies/1"
}
},
"issue_date": "2025-07-29T00:00:00Z",
"alternate_issue_date": "2025-07-29T00:00:00Z",
"due_date": "2025-07-29T00:00:00Z",
"alternate_due_date": "2025-07-29T00:00:00Z",
"subtotal": "",
"tax": "",
"total": "100.000000",
"price_tax_inclusive": "true",
"account_id": "DQLP9B",
"purchase_order_id": "PO-DQLP9B-0002",
"created_by": "Implementer",
"created_on": "2025-07-29T10:00:14Z",
"last_updated_by": "",
"last_updated_on": "",
"uuid": "84e0220f-07d8-45c3-a279-ce7832999a84",
"version": "0",
"custom_attributes": [],
"custom_objects": [],
"lines": [
{
"subtotal": "100.000000",
"total": "100.000000",
"tax": "0.000000",
"accounting_code": "Account Receivable",
"item_uuid": "",
"item_purchase_order_quantity": "5.000000",
"item_uom": "",
"item_warehouse": "",
"uuid": "027dc2c4-4c8a-4f9c-904b-4def24557e2d",
"version": "0"
}
],
"kpis": {
"outstanding": 0,
"overdue": 0,
"last_payment_date": "",
"payment_applied": 0,
"credit_applied": 0,
"credit_issued": "",
"last_reactivated_on": "",
"last_cancelled_on": "",
"last_amended_on": "",
"voided_on": "",
"deleted_on": ""
}
},
{
"status": "INACTIVE",
"id": "PI-DQLP9B-0014",
"custom_form": {},
"currency": {
"id": "1",
"name": "AUD",
"link": {
"rel": "self",
"href": "https://dev-api.exsited.com/api/v1/currencies/1"
}
},
"issue_date": "2025-07-30T00:00:00Z",
"alternate_issue_date": "2025-07-30T00:00:00Z",
"due_date": "2025-07-30T00:00:00Z",
"alternate_due_date": "2025-07-30T00:00:00Z",
"subtotal": "",
"tax": "",
"total": "50.000000",
"price_tax_inclusive": "true",
"account_id": "DQLP9B",
"purchase_order_id": "",
"created_by": "Implementer",
"created_on": "2025-07-30T10:18:13Z",
"last_updated_by": "saeed",
"last_updated_on": "2025-07-30T10:23:11Z",
"uuid": "6a1d05ea-7376-4112-bc82-1b11a7eed85d",
"version": "7",
"custom_attributes": [],
"custom_objects": [],
"lines": [
{
"subtotal": "50.000000",
"total": "50.000000",
"tax": "0.000000",
"accounting_code": "Account Receivable",
"item_uuid": "",
"item_purchase_order_quantity": "1.000000",
"item_uom": "",
"item_warehouse": "Default Warehouse",
"uuid": "0a3f6e1e-ab14-4ccf-ab9f-d4a189a00c5c",
"version": "0"
}
],
"kpis": {
"outstanding": 0,
"overdue": 0,
"last_payment_date": "",
"payment_applied": 0,
"credit_applied": 0,
"credit_issued": "",
"last_reactivated_on": "",
"last_cancelled_on": "",
"last_amended_on": "",
"voided_on": "",
"deleted_on": ""
}
}
],
"pagination": {
"records": 6,
"limit": 20,
"offset": 0,
"previous_page": "",
"next_page": "NULL"
}
}
Attribute | Type | Description |
---|---|---|
status | String | Current status of the purchase invoice |
id | String | Unique ID of the purchase invoice |
custom_form | Object | Custom form data associated (empty object here) |
currency | Object | Currency used in the invoice |
issue_date | String | Issue date in ISO 8601 format |
alternate_issue_date | String | Alternate issue date |
due_date | String | Due date of the invoice |
alternate_due_date | String | Alternate due date |
subtotal | String | Subtotal amount |
tax | String | Tax amount |
total | String | Total amount |
price_tax_inclusive | String | Indicates if tax is included in the price |
account_id | String | ID of the associated account |
purchase_order_id | String | ID of the related purchase order |
created_by | String | Name of the creator of the invoice |
created_on | String | Timestamp when the invoice was created |
last_updated_by | String | Name of the last user who updated the invoice |
last_updated_on | String | Timestamp of last update |
uuid | String | Universally unique identifier |
version | String | Version number of the invoice |
custom_attributes | Array | Custom attributes (empty array here) |
custom_objects | Array | Custom objects (empty array here) |
lines | Array | Line items in the invoice |
kpis | Object | KPI-related metrics for the invoice |
Retrieve Purchase Invoice Details by ID: /purchase-invoices/{id}
Purpose
Retrieve detailed information of a single purchase invoice identified by its unique invoice ID. This allows clients to access all related metadata, line items, currency, totals, and financial KPIs.
Use Case
Used by internal systems or staff (e.g., finance, procurement, auditors) to:
- View full invoice details on an invoice detail page.
- Fetch invoice data for reporting or exporting.
- Verify invoice values, issue/due dates, line items, and associated purchase orders.
Path Parameters
Parameter | Type | Description |
---|---|---|
id |
String | Unique ID of the purchase invoice to fetch (e.g., PI-DQLP9B-0001 ) |
Query Parameters
No query parameters are required or supported for this endpoint.
Request Body
No request body is required for this endpoint.
Response
Returns a detailed purchase invoice object including header information, currency, metadata, invoice lines, and financial KPIs.
Response Body
{
"purchase_invoice": {
"status": "INACTIVE",
"id": "PI-DQLP9B-0014",
"custom_form": {},
"currency": {
"id": "1",
"name": "AUD",
"link": {
"rel": "self",
"href": "https://dev-api.exsited.com/api/v1/currencies/1"
}
},
"issue_date": "2025-07-30T00:00:00Z",
"alternate_issue_date": "2025-07-30T00:00:00Z",
"due_date": "2025-07-30T00:00:00Z",
"alternate_due_date": "2025-07-30T00:00:00Z",
"subtotal": "",
"tax": "",
"total": "50.000000",
"price_tax_inclusive": "true",
"account_id": "DQLP9B",
"purchase_order_id": "",
"created_by": "Implementer",
"created_on": "2025-07-30T10:18:13Z",
"last_updated_by": "saeed",
"last_updated_on": "2025-07-30T10:23:11Z",
"uuid": "6a1d05ea-7376-4112-bc82-1b11a7eed85d",
"version": "7",
"custom_attributes": [],
"custom_objects": [],
"lines": [
{
"subtotal": "50.000000",
"total": "50.000000",
"tax": "0.000000",
"accounting_code": "Account Receivable",
"item_uuid": "",
"item_purchase_order_quantity": "1.000000",
"item_uom": "",
"item_warehouse": "Default Warehouse",
"uuid": "0a3f6e1e-ab14-4ccf-ab9f-d4a189a00c5c",
"version": "0"
}
],
"kpis": {
"outstanding": 0,
"overdue": 0,
"last_payment_date": "",
"payment_applied": 0,
"credit_applied": 0,
"credit_issued": "",
"last_reactivated_on": "",
"last_cancelled_on": "",
"last_amended_on": "",
"voided_on": "",
"deleted_on": ""
}
}
}
Attribute | Type | Description |
---|---|---|
status | String | Status of the purchase invoice (e.g., INACTIVE ) |
id | String | Unique invoice ID (e.g., PI-DQLP9B-0014 ) |
custom_form | Object | Custom form data (empty in this case) |
currency | Object | Currency details with id , name , and link |
issue_date | String | Invoice issue date (ISO 8601 format) |
alternate_issue_date | String | Alternate issue date |
due_date | String | Invoice due date |
alternate_due_date | String | Alternate due date |
subtotal | String | Subtotal amount (blank in this example) |
tax | String | Tax amount (blank in this example) |
total | String | Total invoice amount (e.g., "50.000000" ) |
price_tax_inclusive | String | Indicates if price includes tax (e.g., "true" ) |
account_id | String | ID of the associated account (e.g., DQLP9B ) |
purchase_order_id | String | ID of the related purchase order (blank here) |
created_by | String | Name of the user who created the invoice |
created_on | String | Creation timestamp in ISO format |
last_updated_by | String | Name of the user who last updated the invoice |
last_updated_on | String | Last updated timestamp in ISO format |
uuid | String | Universally unique identifier for the invoice |
version | String | Version number of the invoice |
custom_attributes | Array | Custom attributes array (empty in this case) |
custom_objects | Array | Custom objects array (empty in this case) |
lines | Array | Line items array with subtotal, total, tax, etc. |
kpis | Object | Key performance indicators related to the invoice |
Retrieve Purchase Invoice List by Account ID: /accounts/{id}/purchase-invoices
Purpose
Fetch a paginated list of all purchase invoices that belong to a specific account. This is useful for filtering invoice records by customer or vendor context.
Use Case
This endpoint is used by:
- Finance or procurement teams to review transactions by account.
- Internal systems to display account-specific invoices.
- Reports requiring customer/vendor invoice groupings.
Path Parameters
Parameter | Type | Description |
---|---|---|
account_id |
String | Unique ID of the account whose purchase invoices are to be fetched. |
Query Parameters
Parameter | Type | Description |
---|---|---|
order_by |
String | Field name to sort the result set (e.g., issue_date , total , status ). |
direction |
String | Sorting direction. Accepts asc or desc . |
limit |
Integer | Number of records to retrieve per page. Default is 20. |
offset |
Integer | Number of records to skip from the beginning. Used for pagination. |
fields |
String | Comma-separated list of specific fields to include in the response. |
Request Body
No request body is required for this endpoint.
Response
Returns an account object with a list of associated purchase invoices and pagination metadata.
Response Body
{
"account": {
"purchase_invoices": [
{
"status": "ACTIVE",
"id": "PI-7O8DW7-0004",
"custom_form": {},
"currency": {
"id": "1",
"name": "AUD",
"link": {
"rel": "self",
"href": "https://dev-api.exsited.com/api/v1/currencies/1"
}
},
"issue_date": "2025-07-27T00:00:00Z",
"alternate_issue_date": "2025-07-27T00:00:00Z",
"due_date": "2025-07-27T00:00:00Z",
"alternate_due_date": "2025-07-27T00:00:00Z",
"subtotal": "",
"tax": "",
"total": "1000.000000",
"price_tax_inclusive": "true",
"account_id": "7O8DW7",
"purchase_order_id": "",
"created_by": "Implementer",
"created_on": "2025-07-27T08:09:33Z",
"last_updated_by": "",
"last_updated_on": "",
"uuid": "7ce74a23-a760-4b12-9aac-ec750b4e2771",
"version": "0",
"custom_attributes": [],
"custom_objects": [],
"lines": [
{
"subtotal": "1000.000000",
"total": "1000.000000",
"tax": "0.000000",
"accounting_code": "Account Receivable",
"item_uuid": "",
"item_purchase_order_quantity": "20.000000",
"item_uom": "",
"item_warehouse": "Default Warehouse",
"uuid": "6bf3a78a-94b7-4128-8ffd-a58c778de17c",
"version": "0"
}
],
"kpis": {
"outstanding": 0,
"overdue": 0,
"last_payment_date": "",
"payment_applied": 0,
"credit_applied": 0,
"credit_issued": "",
"last_reactivated_on": "",
"last_cancelled_on": "",
"last_amended_on": "",
"voided_on": "",
"deleted_on": ""
}
}
],
"pagination": {
"records": 1,
"limit": 20,
"offset": 0,
"previous_page": "",
"next_page": "NULL"
}
}
}
Attribute | Type | Description |
---|---|---|
status | String | Status of the purchase invoice (e.g., ACTIVE ) |
id | String | Unique invoice ID (e.g., PI-7O8DW7-0004 ) |
custom_form | Object | Custom form object (empty in this case) |
currency | Object | Currency details including id , name , and link |
issue_date | String | Invoice issue date (ISO 8601 format) |
alternate_issue_date | String | Alternate issue date |
due_date | String | Invoice due date |
alternate_due_date | String | Alternate due date |
subtotal | String | Subtotal amount (blank in this example) |
tax | String | Tax amount (blank in this example) |
total | String | Total invoice amount (e.g., "1000.000000" ) |
price_tax_inclusive | String | Indicates if price includes tax (e.g., "true" ) |
account_id | String | ID of the associated account (e.g., 7O8DW7 ) |
purchase_order_id | String | Purchase order ID (blank in this example) |
created_by | String | Creator of the invoice |
created_on | String | Timestamp of creation in ISO format |
last_updated_by | String | Last updater (empty in this example) |
last_updated_on | String | Timestamp of last update (empty in this example) |
uuid | String | Unique UUID of the invoice |
version | String | Version number |
custom_attributes | Array | Custom attributes array (empty in this case) |
custom_objects | Array | Custom objects array (empty in this case) |
lines | Array | Line items array |
kpis | Object | Key performance indicators for the invoice |
Retrieve Purchase Invoice Line Details: /purchase-invoices/{id}/lines/{uuid}
Purpose
Retrieve detailed information of a specific line item from a given purchase invoice.
Use Case
A client or integration needs to fetch line-level data (such as product, tax, warehouse, subtotal) associated with a specific purchase invoice to:
- Display line-item level breakdowns
- Validate pricing, tax, or quantities
- Analyze financial details for auditing or reporting
Path Parameters
Parameter | Type | Required | Description |
---|---|---|---|
PI_ID |
String | ✅ Yes | Unique ID of the purchase invoice |
line_uuid |
String | ✅ Yes | Unique UUID of the invoice line item |
Query Parameters
No query parameters are required or supported for this endpoint.
Request Body
This endpoint does not require a request body.
Response
Returns detailed data for the specified invoice line item along with limited invoice-level metadata.
Response Body
{
"purchase_invoice": {
"status": null,
"id": null,
"custom_form": {},
"subtotal": "",
"tax": "",
"created_by": "",
"last_updated_by": "",
"custom_attributes": [],
"custom_objects": [],
"line": null,
"kpis": {
"outstanding": 0,
"overdue": 0,
"last_payment_date": "",
"payment_applied": 0,
"credit_applied": 0,
"credit_issued": "",
"last_reactivated_on": "",
"last_cancelled_on": "",
"last_amended_on": "",
"voided_on": "",
"deleted_on": ""
}
}
}
Attribute | Type | Description |
---|---|---|
status | String | Status of the purchase invoice (e.g., ACTIVE , INACTIVE , or null ) |
id | String | Unique ID of the purchase invoice (can be null ) |
custom_form | Object | Custom form metadata (empty object in this example) |
subtotal | String | Subtotal amount (empty in this example) |
tax | String | Tax amount (empty in this example) |
created_by | String | Username who created the invoice (empty in this example) |
last_updated_by | String | Username who last updated the invoice |
custom_attributes | Array | List of custom attributes (empty in this example) |
custom_objects | Array | List of custom objects (empty in this example) |
line | Object|Null | Single line item object (null in this example) |
kpis | Object | Key performance indicators for the invoice |