Applies to integrated customers using the RecoveryConnect API
Update Smart Invoice
Description: This endpoint updates an existing smart invoice associated with a specific order.
It allows modification of billing details, invoice status, due date, and invoice number. This is typically used during the invoice lifecycle, such as moving an invoice from draft → submitted → approved.
Only the fields provided in the request body will be updated. Fields not included will remain unchanged.
All requests must include a valid Bearer Token in the request header.
URL: /api/v150/orders/order_id/invoices/{invoice_id}
Method: PUT
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
billTo | Identifier of the entity to whom the invoice is billed | No | 65690 |
invoiceDueDate | Updated due date and time for the invoice | No | 2026-02-17 22:02.57 |
bill_from_location | Updated billing source location ID | No | 16217129 |
bill_to_location | Updated billing destination location ID | No | 56458222 |
status | Status of the invoice (e.g., draft, submitted, approved) | No | submitted |
invoiceNum | Invoice number assigned to the smart invoice | No | 648 |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/orders/57036454/invoices/6065182 |
Request Body:
{ "billTo": 65690, "invoiceDueDate": "2026-02-17 23:02.57", "bill_from_location": 16217129, "bill_to_location": 56458222, "status": "submitted", "invoiceNum": 648 } |
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 } ] } } |
Delete Smart Invoice
Description: This endpoint deletes an existing smart invoice associated with a specific order.
Smart invoices can be deleted when they are no longer required or were created incorrectly. Typically, only invoices in draft or unsubmitted state can be deleted. Once an invoice is submitted or approved, deletion may be restricted based on system rules.
All requests must include a valid Bearer Token in the request header.
URL: /api/v150/orders/order_id/invoices/{invoice_id}
Method: DELETE
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:
{ "message": "Invoice deleted successfully." } |
Create Smart Invoice Service Item
Description: This endpoint adds one or more service items to an existing smart invoice.
Service items represent individual billable services included in the invoice, such as recovery charges, storage fees, or transportation costs. Each item can include quantity, cost, remarks, and applicable tax rates.
This endpoint is typically used after creating a smart invoice to add additional billing items dynamically.
All requests must include a valid Bearer Token in the request header.
URL: /api/v150/orders/order_id/invoices/{invoice_id}/service_items
Method: POST
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
itemsToAdd | |||
itemID | Identifier of the service item | Yes | 1016235 |
itemDate | Date and time when the service was performed | Yes | 2023-08-28 22:02.57 |
itemQty | Quantity of the service item | Yes | 1 |
itemCost | Cost per unit 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] |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/orders/57036454/invoices/6065182/service_items |
Request Body:
{ "itemsToAdd": [ { "itemID": 1016235, "itemDate": "2023-08-28 22:02.57", "itemQty": 1, "itemCost": 122, "itemRemarks": "Adding Personal Property Storage Fee", "itemTaxRate": [ 253 ] } ] } |
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 } ] } } |