Applies to integrated customers using the RecoveryConnect APDelete Smart Invoice Service Item
Description: This endpoint deletes a specific service item from a smart invoice.
Service items represent individual billable components of an invoice. This endpoint allows removal of a service item that is no longer required or was added incorrectly, and the invoice total will be recalculated accordingly.
Typically, service items can only be deleted when the invoice is in a draft or editable state.
All requests must include a valid Bearer Token in the request header.
URL: /api/v150/orders/order_id/invoices/{invoice_id}/service_items/{service_item_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/service_items/928101 |
Request Body: NA
Response:
{ "message": "Service item deleted successfully." } |
Add Expense to Smart Invoice
Description: This endpoint adds one or more expenses to an existing smart invoice.
Expenses represent additional costs incurred during service execution, such as towing charges, fuel costs, or miscellaneous operational expenses. These expenses are added separately from service items and contribute to the overall invoice total.
All requests must include a valid Bearer Token in the request header.
URL: /api/v150/orders/order_id/invoices/{invoice_id}/expenses
Method: POST
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
expensesToAdd | |||
expenseItem | Identifier of the expense type/item | Yes | 1001786 |
expenseCost | Cost of the expense | Yes | 50 |
expenseRemarks | Description or remarks for the expense | No | Expense Reason |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/orders/57036454/invoices/6065182/expenses |
Request Body:
{ "expensesToAdd": [ { "expenseItem": 1001786, "expenseCost": 50, "expenseRemarks": "Expense Reason" } ] } |
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 Smart Invoice Expenses
Description: This endpoint retrieves the list of expenses associated with a specific smart invoice.
Expenses represent additional costs incurred during service execution, such as towing charges, fuel, storage, or other operational expenses. These expenses contribute to the overall invoice total along with service items.
All requests must include a valid Bearer Token in the request header.
URL: /api/v150/orders/order_id/invoices/{invoice_id}/expenses
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/orders/57036454/invoices/6065182/expenses |
Request Body: NA
Response:
{ "data": [ { "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 } ] } |