Applies to integrated customers using the RecoveryConnect API
Smart Invoice
The Smart Invoice module provides APIs to create, manage, and process invoices dynamically for orders.
It supports:
- Invoice creation & updates
- Service items & expenses
- Fee request attachment
- Payable & receivable invoice tracking
All requests must include a valid Bearer Token.
Create Smart Invoice
Description: This endpoint creates a Smart Invoice for a specific order.
Smart invoices allow dynamic billing by combining collaterals, service items, and tax configurations into a single invoice. During creation, users can specify billing details, associated collaterals, and initial invoice items.
This endpoint is typically used as the first step in the smart invoicing workflow, after which additional items, expenses, or fee requests can be added.
All requests must include a valid Bearer Token in the request header.
URL: /api/v150/orders/order_id/invoices
Method: POST
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
billTo | Identifier of the entity to whom the invoice is billed | Yes | 65690 |
invoiceDueDate | Due date and time for the invoice (UTC format recommended) | Yes | 2025-08-28 22:02.57 |
bill_from_location | Location ID from where the invoice is generated | Yes | 16217129 |
bill_to_location | Location ID where the invoice is billed | Yes | 56458222 |
invoiceCollaterals | Array of collateral IDs included in the invoice | Yes | [58140207] |
itemsToAdd | |||
itemID | Identifier of the service item | Yes | 1016235 |
itemDate | Date and time when the service was performed | Yes | 2025-08-28 22:02.57 |
itemQty | Quantity of the service item | Yes | 1 |
itemCost | Cost of the service item | Yes | 122 |
itemRemarks | Description or remarks for the service item | No | Adding Personal Property Storage Fee |
itemTaxRate | Array of applicable tax rate IDs | No | [253] |
fee_request_ids | List of approved fee request IDs to be included in the invoice | No | 346264 |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/orders/invoices |
Request Body:
{ "billTo": 65690, "invoiceDueDate": "2023-08-28 22:02.57", "bill_from_location": 16217129, "bill_to_location": 56458222, "invoiceCollaterals": [ 58140207 ], "itemsToAdd": [ { "itemID": 1016235, "itemDate": "2023-08-28 22:02.57", "itemQty": 1, "itemCost": 122, "itemRemarks": "Adding Personal Property Storage Fee", "itemTaxRate": [ 253 ], “fee_request_ids”: 346264 } ] } |
Response:
{ "data": { "id": 6006470, "order_id": 56226663, "order_type_id": 1, "billed_company_id": 65690, "billed_company_name": "Demo Bank and Trust MRS", "company_refno": 19015, "status": "draft", "gross_amount": 500, "tax_amount": 68.75, "is_sent": 0, "is_recurring": 0, "payment_status": "unpaid", "due_date": "2023-04-09 12:00:00", "date_accepted": "2023-04-09 12:00:00", "created_at": "2024-04-04 00:00:00", "updated_at": "2023-03-09 23:23:00", "date_sent": "2023-03-09 23:23:00", "date_paid": "2024-04-04 23:23:00", "from_location": 4, "to_location": 276417, "is_contracted": 1, "service_items": [ { "id": 928101, "item_id": 6006470, "item_name": "Collateral Redemption Reinstatement Fee", "gross_amount": 75.3, "tax_amount": 10.35, "net_amount": 85.65, "quantity": 1, "remarks": "testing", "is_expense": 0, "pay_to_id": 23992, "pay_to_type": "employee", "created_at": "2024-04-04 00:00:00", "updated_at": "2024-04-04 00:00:00", "approval_status": "Approved", "is_contracted": 1 } ] } } |
Get Order Smart Invoices
Description: This endpoint retrieves the list of smart invoices associated with a specific order.
Smart invoices represent dynamic billing records that include service items, expenses, and applicable fees for an order. This endpoint allows users to view all invoices created for the given order, along with their status and summary details.
All requests must include a valid Bearer Token in the request header.
URL: /api/v150/orders/order_id/invoices
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/orders/57036454/invoices |
Request Body: NA
Response:
{ "data": [ { "id": 6065182, "order_id": 57036454, "order_type_id": 1, "billed_company_id": 65690, "billed_company_name": "Demo Bank & Trust MRS", "company_refno": 34316, "status": "approved", "gross_amount": "40.00", "tax_amount": "0.00", "is_sent": 1, "payment_status": "unpaid", "due_date": "2026-02-04 12:00:00", "date_accepted": null, "is_recurring": 0, "created_at": "2026-01-06 02:41:34", "updated_at": "2026-01-06 02:41:35", "date_sent": "2026-01-06 02:41:34", "date_paid": null, "from_location": 4, "to_location": 119977449, "is_contracted": 1, "service_items": [ { "id": 7507511, "item_id": 1018869, "item_name": "Collateral Redemption Reinstatement Fee", "master_id": 1659, "gross_amount": "20.00", "tax_amount": "0.00", "net_amount": "40.00", "quantity": 2, "remarks": "Added Service Items", "is_expense": 0, "pay_to_id": null, "pay_to_type": null, "created_at": "2026-01-05 00:00:00", "updated_at": "2026-01-06 02:41:35", "approval_status": "Approved", "is_contracted": 1 } ] } ], "links": { "first": "http://stg-api.mbsisystems.com/api/v2026/system/orders/57036454/invoices?q=%2Fapi%2Fv150%2Forders%2F57036454%2Finvoices&page=1", "last": "http://stg-api.mbsisystems.com/api/v2026/system/orders/57036454/invoices?q=%2Fapi%2Fv150%2Forders%2F57036454%2Finvoices&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "path": "http://stg-api.mbsisystems.com/api/v2026/system/orders/57036454/invoices", "per_page": "250", "to": 1, "total": 1 } } |
Get Order Smart Invoice
Description: This endpoint retrieves the details of a specific smart invoice associated with an order.
Smart invoices contain comprehensive billing information, including service items, expenses, applied taxes, and total amounts. This endpoint provides a detailed view of a single invoice, which is useful for reviewing invoice composition and status.
All requests must include a valid Bearer Token in the request header.
URL: /api/v150/orders/order_id/invoices/{invoice_id}
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/orders/57036454/invoices/6065182 |
Request Body: NA
Response:
{ "data": { "id": 6065182, "order_id": 57036454, "order_type_id": 1, "billed_company_id": 65690, "billed_company_name": "Demo Bank & Trust MRS", "company_refno": 34316, "status": "approved", "gross_amount": "40.00", "tax_amount": "0.00", "is_sent": 1, "payment_status": "unpaid", "due_date": "2026-02-04 12:00:00", "date_accepted": null, "is_recurring": 0, "created_at": "2026-01-06 02:41:34", "updated_at": "2026-01-06 02:41:35", "date_sent": "2026-01-06 02:41:34", "date_paid": null, "from_location": 4, "to_location": 119977449, "is_contracted": 1, "service_items": [ { "id": 7507511, "item_id": 1018869, "item_name": "Collateral Redemption Reinstatement Fee", "master_id": 1659, "gross_amount": "20.00", "tax_amount": "0.00", "net_amount": "40.00", "quantity": 2, "remarks": "Added Service Items", "is_expense": 0, "pay_to_id": null, "pay_to_type": null, "created_at": "2026-01-05 00:00:00", "updated_at": "2026-01-06 02:41:35", "approval_status": "Approved", "is_contracted": 1 } ] } } |