Applies to integrated customers using the RecoveryConnect API
Update an Order
Description: Updates specified fields on an order; unspecified fields remain unchanged.
URL: /api/v150/orders/{order_id}
Method: PUT
Request Body Parameters:
As this is an update endpoint, the fields provided in the request body will be changed.
NOTE: The following are not fixed fields
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
order_type | Order type code | No | 2 |
is_violent | Boolean flag indicating if the case involves a violent incident (0 = No, 1 = Yes). | No | 0 |
tier_level | The tier level assigned to the case | No | Tier1 |
placement_level | The placement level of the case. | No | 1 |
status | Current status of the order or case. | No | 16 |
status_note | Additional notes or remarks about the case status | No | Test note |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/orders/16644411 |
Request Body:
{ "order_type": 2, "is_violent": 0, "tier_level": "Tier1", "placement_level": 1, "status": 16, "status_note": "test note" } |
Response:
{ "data": { "id": 2594687, "client_id": 65690, "owner_id": 10001, "lienholder": 65690, "collector_id": null, "association_id": null, "assignment_manager": null, "status_date": "2020-07-15T23:48:12.000000Z", "note": null, "reason": null, "parent_id": null, "is_lender": "0", "order_type": 1, "prior_case_type_live_recovery": null, "client_accountno": "2321", "lien_accountno": "2321", "company_orderno": "2873", "debtor_skipped": null, "is_violent": 0, "expiration": null, "company_address": null, "accepted_date": "2014-10-22 08:00:00", "other_refno": null, "company_address_id": null, "tier_level": "Tier 5", "placement_level": null, "det_guid": null, "created_at": "2014-10-22 08:00:00", "updated_at": "2014-10-22 08:00:00m", "deleted_at": null, "source": null, "company_origin": 10001, "source_file": null, "managed_by_company": null, "flagged_delete": 0, "from_transparency_set": 0, "trans_set_by_client_id": null, "trans_main_parent_id": null, "parent_case": 2594687, "reopen_num": 1, "is_latest_case": 1, "assignment_situation": null, "recovery_situation": null, "primary_collateral": { "id": 2594687, "parent_id": 65690, "recovery_id": 2430092, "completed_by": 32322, "pending_recovery_id": 1212, "object_id": 1909384, "orders_id": 2611908, "current_disposition": "", "reason": null, "contract_date": "No Data", "deliquent_since": "No Data", "chargeoff_date": "No Data", "original_loan_amount": 0, "payment_amount": 0, "past_due_amount": 0, "unpaid_balance": 0, "maximum_bailout": 0, "additional_info": "No Data", "is_primary": 1, "note": null, "prior_status": null, "status": 9, "status_date": "2020-11-02T08:52:21.000000Z", "order_fulfillment_history_id": null, "created_at": "2020-11-02 08:52:21", "updated_at": "2020-11-02 08:52:21", "last_payment_date": "2020-11-02 08:52:21", "days_past_due": null, "number_payments_delinquent": 0, "tranche": 0, "last_payment_type": null, "chargeoff_amount": 0, "last_payment_amount": 0, "interest_amount": 0, "average_wholesale_value": 0, "outstanding_balance": 0, "average_cash_value": 0, "principal_amount": 0, "base_cash_value": 0, "estimated_value": 0, "source": null, "deleted_at": "2020-11-02 08:52:21", "display_string": null, "base_object": { "id": 85967, "model_id": 312123, "identification_number": "3GYFNFE34FS577997", "created_at": "2020-11-02 08:52:21", "updated_at": "2020-11-02 08:52:21", "object_properties": { "selling_dealer": 85967, "keycodes": "test1- test2", "license_state": "OH", "license_no": "ADASD", "trim": "Performance Collection", "drive_train": "All-Wheel Drive", "color": null, "license_exp": null, "engine": null, "body_type": null, "fuel_type": null }, "object_model": { "id": 85967, "manufacturer": 28, "type": 89, "name": "SRX", "year": "2011", "body_type": null, "fuel_type": null, "drive_train": null, "trim": null, "engine": null, "created_at": "2020-11-02 08:52:21", "updated_at": "2020-11-02 08:52:21", "make": { "id": 28, "name": "Cadillac", "description": null, "created_at": "2020-11-02 08:52:21", "updated_at": "2020-11-02 08:52:21" } }, "properties": [ { "id": 85967, "object_id": 1, "employee_id": 85967, "company_id": 10001, "name": "body_type", "data": "AWD", "data_source": "User Input", "created_at": "2020-11-02 08:52:21", "updated_at": "2020-11-02 08:52:21" } ] } } }, "status": "success" } |
3.5 Assign Order
Description: Assigns an existing order to a service provider, optionally limiting to specific address IDs; returns the updated order.
URL: /api/v150/orders/{order_id}/assign
Method: POST
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
company_id | ID of the assignee company | Yes | 10001 |
order_type | Order type ID | No | 2 |
only_addresses | Address IDs to include | No | 12243,82572 |
additional_info | Free text additional info | No | No info provided |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/orders/2843761/assign |
Request Body:
{ "company_id": 10001, "order_type": 2, "only_addresses": [ 123, 456 ], "additional_info": "No info provided" } |
Response:
{ "data": { "id": 2594687, "client_id": 65690, "owner_id": 10001, "lienholder": 65690, "collector_id": null, "association_id": null, "assignment_manager": null, "status_date": "2020-07-15T23:48:12.000000Z", "note": null, "reason": null, "parent_id": null, "is_lender": "0", "order_type": 1, "prior_case_type_live_recovery": null, "client_accountno": "2321", "lien_accountno": "2321", "company_orderno": "2873-1", "debtor_skipped": null, "is_violent": 0, "expiration": null, "company_address": null, "accepted_date": "Jan 14, 2026", "other_refno": null, "company_address_id": null, "tier_level": null, "placement_level": null, "det_guid": null, "created_at": "Jan 15, 2026 4:48 pm", "updated_at": "Jan 15, 2026 4:50 pm", "deleted_at": null, "source": null, "company_origin": 10001, "source_file": null, "managed_by_company": null, "flagged_delete": 0, "from_transparency_set": 0, "trans_set_by_client_id": null, "trans_main_parent_id": null, "parent_case": 2594687, "reopen_num": 1, "is_latest_case": 1, "assignment_situation": null, "recovery_situation": null } } |
3.6 Retrieve Order Employees
Description: Retrieves the list of employees assigned to a specific order by its unique ID.
URL: /api/v150/orders/{order_id}/employees
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/orders/57070465/employees |
Request Body: NA
Response:
{ "data": [ { "id": 83268, "company_id": 10004, "name": "QA DemoFor", "firstname": "QA", "lastname": "DemoFor", "contact": { "email": "test@gmail.com", "mobile_phone": null }, "roles": [ "Administrator FWD", "Case Worker FWD", "Accountant", "Billing Manager", "Billing Staff ", "Billing Supervisor", "Compliance Officer FWD ", "Field Agent", "Team Lead", "Billing Manager", "Billing Staff ", "Billing Supervisor", "Case Worker FWD", "VendorConnect Service Provider", "VendorConnect Client", "Billing Manager", "Billing Supervisor", "Billing Supervisor", "Billing Manager" ], "self": "http://stg-api.mbsisystems.com/api/employees/83268", "expand": "employee" }, { "id": 83445, "company_id": 10004, "name": "karibasappa Soma", "firstname": "karibasappa", "lastname": "Soma", "contact": { "email": null, "mobile_phone": null }, "roles": [ "Administrator FWD", "Field Agent", "Accountant" ], "self": "http://stg-api.mbsisystems.com/api/employees/83445", "expand": "employee" }, { "id": 87798, "company_id": 10004, "name": "Priya Jayakumar", "firstname": "Priya", "lastname": "Jayakumar", "contact": { "email": "ramakrishna@esginc.us", "mobile_phone": null }, "roles": [ "Administrator FWD", "Accountant", "Field Agent", "Billing Manager", "Billing Staff ", "Billing Supervisor", "Team Lead", "Transportation FWD", "Vendor Manager", "Case Worker FWD", "VendorConnect Client", "VendorConnect Service Provider", "Billing Staff ", "Billing Supervisor", "Billing Staff ", "Billing Supervisor", "Billing Manager", "Billing Supervisor", "Administrator FWD", "Billing Manager", "Billing Manager", "Billing Staff ", "Billing Supervisor" ], "self": "http://stg-api.mbsisystems.com/api/employees/87798", "expand": "employee" }, { "id": 202148, "company_id": 10004, "name": "Deploy QA Forwarder", "firstname": "Deploy", "lastname": "QA Forwarder", "contact": { "email": null, "mobile_phone": null }, "roles": [ "Administrator FWD", "Case Worker FWD", "Compliance Officer FWD ", "Field Agent", "Remarketing FWD", "Vendor Manager", "Billing Manager", "Billing Staff ", "Billing Supervisor", "VendorConnect Service Provider" ], "self": "http://stg-api.mbsisystems.com/api/employees/202148", "expand": "employee" }, { "id": 240458, "company_id": 10004, "name": "Alexis Paul ", "firstname": "Alexis ", "lastname": "Paul ", "contact": { "email": "apaul@mbsicorp.com", "mobile_phone": null }, "roles": [ "Administrator FWD", "Field Agent", "Accountant", "VendorConnect Service Provider", "VendorConnect Client" ], "self": "http://stg-api.mbsisystems.com/api/employees/240458", "expand": "employee" } ] } |
Delete Employee from Order
Description: Deletes a specific employee assigned to an order, identified by order_id and employee_id.
URL: /api/v150/orders/{order_id}/employees/{employee_id}
Method: DELETE
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
https://api.mbsisystems.com/api/v150/orders/57070465/employees/353379 |
Request Body: NA
Response:
{ "data": { "success": true } } |