Retrieve Proforma Invoice List: /proforma-invoices
Purpose
This API retrieves a list of all proforma invoices associated with the authenticated account. It provides details such as status, total amount, due amount, paid amount, issue date, due date, and operational acceptance requirements.
Use Case
Use this API to display or analyze all proforma invoices in a system dashboard, billing overview, or financial reporting module. It helps users to view payment statuses, track issued invoices, and monitor outstanding dues.
Path Parameters
This API does not require any path parameters.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Optional parameter to limit the number of records returned per page. |
| offset | integer | Optional parameter to specify the starting point for record retrieval in paginated results. |
Request Body
This endpoint does not require a request body.
Response
The API returns a paginated list of proforma invoices. Each invoice object includes status, UUID, invoice ID, operational acceptance details, monetary values, and key dates. The response also contains pagination information to support data navigation across multiple pages.
Response Body
{
"proforma_invoices": [
{
"status": "STATUS",
"uuid": "UUID",
"invoice_id": "INVOICE_ID",
"operation_acceptance_required": "BOOLEAN",
"operation_acceptance_payment_required": "BOOLEAN",
"operation_acceptance_date_selector": "DATE_SELECTOR_TYPE",
"operation_acceptance_terms_and_conditions": "TERMS_TEXT",
"total_amount": "TOTAL_AMOUNT",
"due_amount": "DUE_AMOUNT",
"paid_amount": "PAID_AMOUNT",
"invoice_status": "INVOICE_STATUS",
"payment_status": "PAYMENT_STATUS",
"issue_date": "ISSUE_DATE",
"due_date": "DUE_DATE"
}
],
"pagination": {
"records": "TOTAL_RECORDS",
"limit": "LIMIT",
"offset": "OFFSET",
"previous_page": "PREVIOUS_PAGE_URL",
"next_page": "NEXT_PAGE_URL"
}
}
| Attribute | Type | Description |
|---|---|---|
| status | string | The current status of the proforma invoice (example: ACTIVE, IMMUTABLE). |
| uuid | string | The unique identifier of the proforma invoice. |
| invoice_id | string | The user-visible identifier for the proforma invoice. |
| operation_acceptance_required | boolean | Indicates whether operational acceptance is required before finalizing the invoice. |
| operation_acceptance_payment_required | boolean | Indicates if payment is mandatory for operational acceptance. |
| operation_acceptance_date_selector | string | Specifies how the acceptance date is determined (example: ProFormaInvoicePaymentDate, AcceptanceDate). |
| operation_acceptance_terms_and_conditions | string | The terms and conditions applied for operational acceptance. |
| total_amount | string | The total billed amount for the invoice. |
| due_amount | string | The remaining amount due on the invoice. |
| paid_amount | string | The amount already paid toward the invoice. |
| invoice_status | string | The overall status of the invoice (example: ACTIVE). |
| payment_status | string | The payment status of the invoice (example: PAID, DUE). |
| issue_date | string | The date the invoice was issued. |
| due_date | string | The date by which payment is due. |
Retrieve Proforma Invoice Details: /proforma-invoices/{proforma_invoice_id}
Purpose
This API retrieves detailed information about a specific proforma invoice identified by its invoice ID.
Use Case
Use this API when a user selects or views a specific proforma invoice in detail. It provides full information about the selected invoice, such as operational requirements, payment status, and billing dates.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| proforma_invoice_id | string | The unique identifier (invoice ID) of the proforma invoice to retrieve. |
Query Parameters
This API does not require any query parameters.
Request Body
This endpoint does not require a request body.
Response
The API returns a single proforma invoice object containing all related attributes such as status, invoice ID, total amount, due amount, payment status, and key operational acceptance flags. This response helps users to inspect a specific proforma invoice for payment validation, business rules, or audit tracking.
Response Body
{
"proforma_invoice": {
"status": "STATUS",
"uuid": "UUID",
"invoice_id": "INVOICE_ID",
"operation_acceptance_required": "BOOLEAN",
"operation_acceptance_payment_required": "BOOLEAN",
"operation_acceptance_date_selector": "DATE_SELECTOR_TYPE",
"operation_acceptance_terms_and_conditions": "TERMS_TEXT",
"total_amount": "TOTAL_AMOUNT",
"due_amount": "DUE_AMOUNT",
"paid_amount": "PAID_AMOUNT",
"invoice_status": "INVOICE_STATUS",
"payment_status": "PAYMENT_STATUS",
"issue_date": "ISSUE_DATE",
"due_date": "DUE_DATE"
}
}
| Attribute | Type | Description |
|---|---|---|
| status | string | The current status of the proforma invoice (example: ACTIVE, IMMUTABLE). |
| uuid | string | The unique identifier of the proforma invoice. |
| invoice_id | string | The user-visible identifier for the proforma invoice. |
| operation_acceptance_required | boolean | Indicates whether operational acceptance is required. |
| operation_acceptance_payment_required | boolean | Indicates if payment is required for acceptance. |
| operation_acceptance_date_selector | string | Specifies how the acceptance date is selected (example: ProFormaInvoicePaymentDate). |
| operation_acceptance_terms_and_conditions | string | The applicable terms and conditions for acceptance. |
| total_amount | string | The total billed amount for the invoice. |
| due_amount | string | The remaining due amount for the invoice. |
| paid_amount | string | The amount already paid. |
| invoice_status | string | The overall status of the invoice (example: ACTIVE). |
| payment_status | string | The payment status of the invoice (example: PAID, DUE). |
| issue_date | string | The date when the invoice was issued. |
| due_date | string | The date by which the payment is due. |