Applies to integrated customers using the RecoveryConnect API
Get Smart Invoice Service Items
Description: This endpoint retrieves the list of service items associated with a specific smart invoice.
Service items represent individual billable services included in the invoice, such as recovery fees, storage charges, or transportation costs. This endpoint is typically used to view all items contributing to the invoice total.
All requests must include a valid Bearer Token in the request header.
URL: /api/v150/orders/order_id/invoices/{invoice_id}/service_items
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/orders/57036454/invoices/6065182/service_items |
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 } ] } |
Update Smart Invoice Service Item
Description: This endpoint updates an existing service item associated with a smart invoice.
Service items represent individual billable components of an invoice. This endpoint allows updating values such as item cost and tax amount, which directly impact the overall invoice total.
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}/service_items/{service_item_id}
Method: PUT
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
itemCost | Updated cost of the service item | No | 100.2 |
itemTaxAmount | Updated tax amount applied to the service item | No | 22.32 |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/orders/57036454/invoices/6065182/service_items/928101 |
Request Body:
{ "itemCost": 100.2, "itemTaxAmount": 22.32 } |
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 } } |
Get Smart Invoice Service Item
Description: This endpoint retrieves the details of a specific service item associated with a smart invoice.
Service items represent individual billable components of an invoice, such as recovery fees, storage charges, or transportation costs. This endpoint provides a detailed view of a single service item, including cost, quantity, tax, and remarks.
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: GET
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:
{ "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 } } |