Endpoint: GET /api/v3/invoices
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 parameters 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
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.
{
"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"
}
}
Endpoint: GET /api/v3/invoices/{invoice_id}
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. |
Request
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.
{
"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"
}
}
}
Endpoint: GET /api/v2/invoices/{invoice_id}/information
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. |
Request
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.
{
"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": []
}
}
Endpoint: GET /api/v3/orders/{order_id}/invoices
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. |
Request
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.
{
"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"
}
}
}
Endpoint: GET /api/v3/accounts/{account_id}/invoices
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. |
Request
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.
{
"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"
}
}
}
Endpoint: GET /api/v2/invoices/{invoice_id}/pdf
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. |
Request
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.
