Applies to integrated customers using the RecoveryConnect APIOrders Operations
The Order Operations section contains endpoints used to create, retrieve, update, assign, and manage orders (cases) in the system. These endpoints allow users to manage order details, employees assigned to orders, addresses, tags, attachments, and related order information.
All requests must include a valid Bearer Token in the request header.
Create Order
Description: This endpoint is used to create a new order (case) in the system. To create an order, you must provide mandatory details such as case type ID, client ID, lien holder ID, collateral details, borrower’s information, and borrower’s address.
URL: /api/v140/orders
Method: POST
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE | ||
determination_flag | Defines case flow: | No | 0 or 1 | ||
case_type_id | Type of the case | Yes | 1 | ||
client_id | Unique identifier for the client | Yes | 65690 | ||
lienholder_id |
Unique identifier for the lienholder | Yes | 65690 | ||
client_account_number | Account number of the client | No | 2345324 | ||
lienholder_account_number | Account number of the lienholder | No | 6468637 | ||
assign_service_provider_id | Company ID to which the case is assigned (Forwarder/Agent) | No | 10004 | ||
tier_level | Tier level of the case | No | 1 | ||
placement_level | Placement level of the case | No | 1 | ||
Collaterals - Mandatory | |||||
identification_number | Vehicle Identification Number (VIN) | Yes | 1FALP13P9VW12034926456 | ||
vehicle_type_id | Type of collateral (vehicle) | No | 5 | ||
year | Manufacture year of the vehicle | No | 2015 | ||
make | Make of the Vehicle (brand) | No | Ford | ||
model | Model of the vehicle | No | Fusion | ||
body_type | Body type of the vehicle | No | Sedan/Saloon | ||
drive_train | Type of drive train of the vehicle | No | Front-Wheel Drive | ||
engine | Type of the engine | No | Cylinder | ||
trim | Trim type | No | LX | ||
fuel_type | Fuel type of the vehicle | No | Gasoline | ||
license_plate | License plate of the vehicle | No | 139507 | ||
license_state | State of the license plate | No | OH | ||
Loan Info | |||||
original_loan_amount | Loan amount taken by the borrower | No | 900 | ||
payment_amount | Amount paid | No | 500 | ||
past_due_amount | Amount overdue (not paid by due date) | No | 200 | ||
unpaid_balance | Outstanding principal balance on the loan | No | 200 | ||
contract_date | The date on which the loan agreement was officially created and recorded. | No | 2020-01-01 | ||
delinquent_since | The date when the loan account first became past due or delinquent. | No | 2020-01-01 | ||
chargeoff_date | The date when the lender officially declared the loan as a loss (charged off). | No | 2020-05-05 | ||
collateral_value | Assessed value of the collateral securing the loan | No | 700 | ||
collateral_value_added | The date when the collateral value was last added or updated for the loan | No | 2020-01-01 | ||
color | Vehicle color | No | Light Blue | ||
Borrowers - Mandatory | |||||
firstname |
Borrower’s first name | Yes | Vinay | ||
middle_initial | Borrower’s Middle name | No | Sai | ||
lastname | Borrower’s Last name | Yes | Bandi | ||
date_of_birth | Borrower’s Date of Birth | No | 1984-01-01 | ||
type | Indicates borrower or co-signer | Yes | borrower | ||
ssn | Borrower’s Social Security Number | No | 123456789 | ||
is_fraud | Boolean flag indicating fraud status (0 = No, 1 = Yes) | No | 0 | ||
bankruptcy | Bankruptcy type and status | No | chapter_7_active | ||
active_military | Boolean flag indicating if borrower is serving in the military (0/1) | No | 0 | ||
is_deceased | Boolean flag indicating if borrower is deceased (0 = No, 1 = Yes) | No | 0 | ||
Phones – Not Mandatory | |||||
type | Phone type identifier that defines the type of phone number (e.g., Mobile, Home, Work). Refer to Phone Type IDs table. | No | 6 | ||
mobile_carrier_id | Identifier of the mobile carrier associated with the phone number. Refer to Mobile Carrier ID Mapping table. | No | 1 | ||
number | Phone number of the contact person. | No | 123456 | ||
extension | Phone extension number if applicable.
| No | 22 | ||
memo | Additional note or description related to the phone number. | No | home | ||
valid | Indicates whether the phone number is valid. Values: 1 = Valid, 0 = Invalid | No | 1 | ||
no_contact | Indicates whether the phone number should not be contacted. Values: 1 = Do Not Contact, 0 = Contact Allowed
| No | 0 | ||
Addresses - Mandatory | |||||
name | Type of address (e.g., Home, Mailing, Additional) | Yes | Home Address | ||
address_1 | Primary address line | Yes | 10851 Black Canyon | ||
address_2 | Secondary address line | No | Highway Suite 500 | ||
unit | The apartment, suite, or unit number within the borrower’s address | No | 3 | ||
city | City name | No | Los Angeles | ||
state | State of the borrower’s address | No | CA | ||
zip_code | Zip/Postal code of the borrower’s address | Yes | 43015 | ||
latitude | The geographic latitude coordinate | No | 42.795435 | ||
longitude | The geographic longitude coordinate | No | -78.81862 | ||
dwelling_id | Unique identifier for the | No | 1 | ||
category_id | Identifier for the loan’s category/classification | No | 1 | ||
Phones – Not Mandatory | |||||
type | Phone type identifier that defines the type of phone number (e.g., Mobile, Home, Work). Refer to Phone Type IDs table. | No | 6 | ||
mobile_carrier_id | Identifier of the mobile carrier associated with the phone number. Refer to Mobile Carrier ID Mapping table. | No | 1 | ||
number | Phone number of the contact person. | No | 123456 | ||
extension | Phone extension number if applicable.
| No | 22 | ||
memo | Additional note or description related to the phone number. | No | home | ||
valid | Indicates whether the phone number is valid. Values: 1 = Valid, 0 = Invalid | No | 1 | ||
no_contact | Indicates whether the phone number should not be contacted. Values: 1 = Do Not Contact, 0 = Contact Allowed
| No | 0 | ||
Additional_addresses – Not Mandatory | |||||
name | Type of address (e.g., Home, Mailing, Additional) | No | additional_addresses | ||
address_1 | Primary address line | Yes | 10851 Black Canyon | ||
address_2 | Secondary address line | No | Highway Suite 500 | ||
unit | The apartment, suite, or unit number within the borrower’s address | No | 3 | ||
city | City name | No | Los Angeles | ||
state | State of the borrower's address | No | CA | ||
zip_code | Zip/Postal code of the borrower’s address | Yes | 85123 | ||
latitude | The geographic latitude coordinate | No | 42.795435 | ||
longitude | The geographic longitude coordinate | No | -78.81862 | ||
dwelling_id | Unique identifier for the | No | 1 | ||
category_id | Identifier for the loan’s category/classification | No | 1 | ||
Phones – Not Mandatory | |||||
type | Phone type identifier that defines the type of phone number (e.g., Mobile, Home, Work). Refer to Phone Type IDs table. | No | 6 | ||
mobile_carrier_id | Identifier of the mobile carrier associated with the phone number. Refer to Mobile Carrier ID Mapping table. | No | 1 | ||
number | Phone number of the contact person. | No | 123456 | ||
extension | Phone extension number if applicable.
| No | 22 | ||
memo | Additional note or description related to the phone number. | No | home | ||
valid | Indicates whether the phone number is valid. Values: 1 = Valid, 0 = Invalid | No | 1 | ||
no_contact | Indicates whether the phone number should not be contacted. Values: 1 = Do Not Contact, 0 = Contact Allowed
| No | 0 | ||
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders |
Request Body:
{ "determination_flag": 0, "case_type_id": 1, "client_id": 65690, "lienholder_id": 65690, "client_account_number": "2321", "lienholder_account_number": "3321", "assign_service_provider_id": 123, "tier_level": 1, "placement_level": 1, "collaterals": [ { "identification_number": "3C8FY58B82T389999", "vehicle_type_id": 1, "year": "2014", "make": "Ford", "model": "Fusion", "body_type": "Short Bed", "drive_train": "Front-Wheel Drive", "engine": "3.7-L V-6 DOHC 24V", "trim": "4dr 1500 LS", "fuel_type": "Diesel", "license_plate": "139507", "license_state": "OH", "loan_info": { "original_loan_amount": 900, "payment_amount": 500, "past_due_amount": 200, "unpaid_balance": 200, "contract_date": "2020-01-01", "delinquent_since": "2020-01-01", "chargeoff_date": "2020-01-01", "collateral_value": 700, "collateral_value_added": "2020-01-01" }, "color": "string" } ], "borrowers": [ { "firstname": "VINAY", "middle_initial": "B", "lastname": "TEST", "date_of_birth": "1984-01-01", "type": "borrower", "ssn": "123456789", "is_fraud": 1, "bankruptcy": "chapter_7_active", "active_military": 1, "is_deceased": 0, "phones": [ { "type": 6, "mobile_carrier_id": 1, "number": "123456", "extension": "22", "memo": "home", "valid": 1, "no_contact": 0 } ], "addresses": [ { "name": "Home Address", "address_1": "10851 Black Canyon", "address_2": "Highway Suite 500", "unit": "3", "city": "Los Angeles", "state": "CA", "zip_code": "43015", "latitude": 42.795435, "longitude": -78.81862, "dwelling_id": 1, "category_id": 1, "phones": [ { "type": 6, "mobile_carrier_id": 1, "number": "123456", "extension": "22", "memo": "home", "valid": 1, "no_contact": 0 } ] } ] } ], "additional_addresses": [ { "name": "Home Address", "address_1": "10851 Black Canyon", "address_2": "Highway Suite 500", "unit": "3", "city": "Los Angeles", "state": "CA", "zip_code": "43015", "latitude": 42.795435, "longitude": -78.81862, "dwelling_id": 1, "category_id": 1, "phones": [ { "type": 6, "mobile_carrier_id": 1, "number": "123456", "extension": "22", "memo": "home", "valid": 1, "no_contact": 0 } ] } ] } |
Response:
{ "data": { "id": 16664834, "client_id": 65690, "owner_id": 10004, "lienholder": 65690, "collector_id": null, "association_id": null, "assignment_manager": null, "status_date": "2026-03-05T13:59:56.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": 60186, "debtor_skipped": null, "is_violent": 0, "expiration": null, "company_address": null, "accepted_date": "2026-03-05 13:59:56", "other_refno": null, "company_address_id": null, "tier_level": "1", "placement_level": 1, "det_guid": null, "created_at": "2026-03-05 13:59:56", "updated_at": "2026-03-05 13:59:59", "deleted_at": null, "source": null, "company_origin": 10004, "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": 16664834, "reopen_num": 1, "is_latest_case": 1, "assignment_situation": null, "recovery_situation": null, "status": "Open", "status_id": 0 }, "status": "success", "warnings": [] } |
Retrieve Orders
Description: Lists orders for the authenticated company with pagination and expanded details; supports query params per platform defaults.
URL: /api/v140/orders
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders |
Request Body: NA
Response:
{ "data": [ { "id": 20, "has_mbsi_source": null, "source": 172724, "other_refno": "10230481", "client_id": 26930, "parent_order_id": 2009347, "status_date": "2023-12-06 15:27:49", "is_violent": 0, "accepted_date": "2016-06-03 14:19:00", "tier_level": null, "placement_level": null, "created_at": "2014-10-29 18:46:48", "reopen_num": 1, "is_latest_case": 1, "client_accountno": "3700956", "company_orderno": "1081-1", "agreement_type": null, "order_type": "Condition Report", "order_type_id": 2, "special_instructions": [ { "id": 1984, "created_by": 212188, "created_by_company": 70883, "created_for_company": 65690, "caselien": 65690, "collateral_status": 9, "content": "Test PAR", "display_to_serviceprovider": 1, "created_at": "2020-11-02 08:52:21", "updated_at": "2020-11-02 08:52:21", "deleted_at": "2020-11-02 08:52:21" } ], "number_of_runs": 0, "client_office_location": { "id": 1984, "name": "address name", "address_1": "test address", "address_2": "SM Test", "state_abbr": "AZ", "city_name": "Phoenix", "zip_code": "85023", "county_name": "Maricopa", "longitude": "-112.089368", "latitude": "33.627294", "unit": "45678" }, "order_location": { "id": 1984, "name": "address name", "address_1": "test address", "address_2": "SM Test", "state_abbr": "AZ", "city_name": "Phoenix", "zip_code": "85023", "county_name": "Maricopa", "longitude": "-112.089368", "latitude": "33.627294", "unit": "45678" }, "owner": { "id": 65690, "name": "Demo Bank and Trust" }, "client": { "id": 26930, "name": "1St National Bank", "self": "api/clients/26930", "expand": "client" }, "lien_holder": { "id": 26930, "name": "1St National Bank", "self": "api/clients/26930", "expand": "client" }, "collector": { "id": 10047, "company_id": 10001, "name": "collector name", "firstname": "Jeff", "lastname": "Inani", "contact": { "email": "abc@gmail.com", "mobile_phone": "123-456-7890" }, "roles": [ "string" ], "self": "api/employees/10047", "expand": "employee" }, "borrower_details": [ { "id": 119, "parent_id": null, "order_id": 20, "person_id": 221, "role": "borrower", "is_violent": 0, "is_primary": 1, "active_military": 0, "bk": null, "is_fraud": 1, "is_deceased": 0, "firstname": "Justin", "middle_initial": null, "lastname": "McNeal", "validated": 1, "created_at": "2014-11-24 04:36:10", "updated_at": "2014-11-24 04:36:10", "deleted_at": null, "person_details": { "id": 221, "firstname": "Justin", "middle_initial": null, "lastname": "McNeal", "birthday": "06/17/1977", "license_no": null, "license_state": null, "validated": 1, "created_at": "2014-10-29 18:46:48", "updated_at": "2014-11-27 17:00:46", "phones": [ { "id": 11314, "type": 6, "mobile_carrier_id": null, "number": "123456", "extension": null, "memo": null, "valid": 1, "no_contact": 0, "created_at": "2020-06-10 10:53:41", "updated_at": "2020-06-10 10:53:41", "migration": null, "address_with_number": "No Address" } ] } } ], "collateral_details": [ { "id": 17, "is_primary": 1, "vehicle_type_id": 79, "vehicle_type": "Sedan", "year": "2008", "make": "Chevrolet", "model": "Silverado 1500", "color": "Yellow", "drive_train": "Rear Wheel Drive", "fuel_type": null, "engine": "8 Cylinder Engine", "selling_dealer": null, "original_loan_amount": 0, "payment_amount": 0, "past_due_amount": 0, "unpaid_balance": 0, "chargeoff_date": "2019-01-17 07:00:00", "key_codes": "", "maximum_bailout": 0, "additional_info": "color could be blue", "contract_date": "No Data", "license_no": "DLNRCO", "license_state": "CA", "license_exp": "string", "vin": "2GCEC19T921286485", "status": "Open", "status_id": 0, "status_reason": 29, "status_date": "2014-10-29 18:46:48", "status_note": "test note", "on_hook_by": { "id": 10047, "company_id": 10001, "name": "collector name", "firstname": "Jeff", "lastname": "Inani", "contact": { "email": "abc@gmail.com", "mobile_phone": "123-456-7890" }, "roles": [ "string" ], "self": "api/employees/10047", "expand": "employee", "employee_id": 86019, "latitude": "0", "longitude": "0", "created_at": "2018-10-26 20:10:00", "updated_at": "2018-10-26 20:10:00" }, "assignment_on_hook_by": { "id": 10047, "company_id": 10001, "name": "collector name", "firstname": "Jeff", "lastname": "Inani", "contact": { "email": "abc@gmail.com", "mobile_phone": "123-456-7890" }, "roles": [ "string" ], "self": "api/employees/10047", "expand": "employee", "employee_id": 86019, "latitude": "0", "longitude": "0", "created_at": "2018-10-26 20:10:00", "updated_at": "2018-10-26 20:10:00" }, "vehicle_value": 7000, "created_at": "2014-10-29 18:46:48", "updated_at": "2019-01-17 23:18:13" } ], "address_details": [ { "id": 23, "lpr_hit_id": null, "company_id": 10001, "parent_id": null, "orders_id": 22, "address_id": 56712, "order_person": null, "category": 3, "dwelling": null, "object_id": 10, "dwelling_type": 1, "employee": null, "created_at": "2014-10-29 19:01:18", "updated_at": "2014-10-29 19:01:18", "valid": 1, "invalid_address_reason": null, "order_collaterals_id": null, "is_accepted": 1, "is_public": 0, "is_pickup": 0, "is_reference": null, "last_update_by": null, "invalid_reason": null, "deleted_at": null, "address_details": { "id": 56712, "name": "0", "address_1": "730 Paradise Lane", "address_2": null, "unit": null, "zip": 48336, "type": 1, "latitude": 33.65031449, "longitude": -117.24815155, "date_delay": null, "available_from": "00:00:00", "available_to": "23:59:00", "priority": 0, "hits": 0, "no_contact": 0, "created_at": "2014-10-29 19:01:18", "updated_at": "2017-12-13 01:21:33", "deleted_at": null, "migration": null, "phones": [ { "id": 11314, "type": 6, "mobile_carrier_id": null, "number": "123456", "extension": null, "memo": null, "valid": 1, "no_contact": 0, "created_at": "2020-06-10 10:53:41", "updated_at": "2020-06-10 10:53:41", "migration": null, "address_with_number": "No Address" } ], "zip_code_details": { "zip_code_id": 48336, "zip_code": "92507", "zip_code_city_id": 48330, "city_name": "Riverside", "zip_code_state_id": 47459, "state_name": "California", "state_abbr": "CA", "state_county": "CA-Riverside", "zip_code_county_id": 47953, "county_name": "Riverside", "latitude": 33.976325, "longitude": -117.330414, "system_msg": 0, "country": "United States of America", "country_code": "US", "trigger_msg": 0, "shape_data": "[[[\"-117.274844\",\"34.004654\",\"0.0\"],[\"-117.268245\",\"33.940869\",\"0.0\"],[\"-117.289141\",\"33.924923\",\"0.0\"],[\"-117.37657\",\"33.968912\",\"0.0\"],[\"-117.339179\",\"34.0195\",\"0.0\"],[\"-117.336429\",\"34.0195\",\"0.0\"],[\"-117.305637\",\"34.0195\",\"0.0\"],[\"-117.274844\",\"34.004654\",\"0.0\"]]" } }, "category_details": { "id": 3, "name": "borrower_home", "friendlyname": "Borrower - Home", "created_at": "2020-06-02 16:44:26", "updated_at": "2020-06-02 16:44:26", "deleted_at": null }, "dwelling_details": { "id": 3, "name": "unverified", "friendlyname": "Borrower - Home", "created_at": "2020-06-02 16:44:26", "updated_at": "2020-06-02 16:44:26", "deleted_at": null } } ] } ], "links": { "first": "?page=1", "last": "?page=99", "prev": "?page=1", "next": "?page=2" }, "meta": { "current_page": 1, "from": 1, "last_page": 10, "path": "/api/resource/path", "per_page": "10", "to": 1, "total": 1 } }
|
Retrieve Specific Order Details
Description: Retrieves the full details of a specific order by its unique ID, including borrower information, collateral details, addresses, and related metadata.
URL: /api/v140/orders/{order_id}
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/16644411 |
Request Body: NA
Response:
{ "data": { "id": 20, "has_mbsi_source": null, "source": 172724, "other_refno": "10230481", "client_id": 26930, "parent_order_id": 2009347, "status_date": "2023-12-06 15:27:49", "is_violent": 0, "accepted_date": "2016-06-03 14:19:00", "tier_level": null, "placement_level": null, "created_at": "2014-10-29 18:46:48", "reopen_num": 1, "is_latest_case": 1, "client_accountno": "3700956", "company_orderno": "1081-1", "agreement_type": null, "order_type": "Condition Report", "order_type_id": 2, "special_instructions": [ { "id": 1984, "created_by": 212188, "created_by_company": 70883, "created_for_company": 65690, "caselien": 65690, "collateral_status": 9, "content": "Test PAR", "display_to_serviceprovider": 1, "created_at": "2020-11-02 08:52:21", "updated_at": "2020-11-02 08:52:21", "deleted_at": "2020-11-02 08:52:21" } ], "number_of_runs": 0, "client_office_location": { "id": 1984, "name": "address name", "address_1": "test address", "address_2": "SM Test", "state_abbr": "AZ", "city_name": "Phoenix", "zip_code": "85023", "county_name": "Maricopa", "longitude": "-112.089368", "latitude": "33.627294", "unit": "45678" }, "order_location": { "id": 1984, "name": "address name", "address_1": "test address", "address_2": "SM Test", "state_abbr": "AZ", "city_name": "Phoenix", "zip_code": "85023", "county_name": "Maricopa", "longitude": "-112.089368", "latitude": "33.627294", "unit": "45678" }, "owner": { "id": 65690, "name": "Demo Bank and Trust" }, "client": { "id": 26930, "name": "1St National Bank", "self": "api/clients/26930", "expand": "client" }, "lien_holder": { "id": 26930, "name": "1St National Bank", "self": "api/clients/26930", "expand": "client" }, "collector": { "id": 10047, "company_id": 10001, "name": "collector name", "firstname": "Jeff", "lastname": "Inani", "contact": { "email": "abc@gmail.com", "mobile_phone": "123-456-7890" }, "roles": [ "string" ], "self": "api/employees/10047", "expand": "employee" }, "borrower_details": [ { "id": 119, "parent_id": null, "order_id": 20, "person_id": 221, "role": "borrower", "is_violent": 0, "is_primary": 1, "active_military": 0, "bk": null, "is_fraud": 1, "is_deceased": 0, "firstname": "Justin", "middle_initial": null, "lastname": "McNeal", "validated": 1, "created_at": "2014-11-24 04:36:10", "updated_at": "2014-11-24 04:36:10", "deleted_at": null, "person_details": { "id": 221, "firstname": "Justin", "middle_initial": null, "lastname": "McNeal", "birthday": "06/17/1977", "license_no": null, "license_state": null, "validated": 1, "created_at": "2014-10-29 18:46:48", "updated_at": "2014-11-27 17:00:46", "phones": [ { "id": 11314, "type": 6, "mobile_carrier_id": null, "number": "123456", "extension": null, "memo": null, "valid": 1, "no_contact": 0, "created_at": "2020-06-10 10:53:41", "updated_at": "2020-06-10 10:53:41", "migration": null, "address_with_number": "No Address" } ] } } ], "collateral_details": [ { "id": 17, "is_primary": 1, "vehicle_type_id": 79, "vehicle_type": "Sedan", "year": "2008", "make": "Chevrolet", "model": "Silverado 1500", "color": "Yellow", "drive_train": "Rear Wheel Drive", "fuel_type": null, "engine": "8 Cylinder Engine", "selling_dealer": null, "original_loan_amount": 0, "payment_amount": 0, "past_due_amount": 0, "unpaid_balance": 0, "chargeoff_date": "2019-01-17 07:00:00", "key_codes": "", "maximum_bailout": 0, "additional_info": "color could be blue", "contract_date": "No Data", "license_no": "DLNRCO", "license_state": "CA", "license_exp": "string", "vin": "2GCEC19T921286485", "status": "Open", "status_id": 0, "status_reason": 29, "status_date": "2014-10-29 18:46:48", "status_note": "test note", "on_hook_by": { "id": 10047, "company_id": 10001, "name": "collector name", "firstname": "Jeff", "lastname": "Inani", "contact": { "email": "abc@gmail.com", "mobile_phone": "123-456-7890" }, "roles": [ "string" ], "self": "api/employees/10047", "expand": "employee", "employee_id": 86019, "latitude": "0", "longitude": "0", "created_at": "2018-10-26 20:10:00", "updated_at": "2018-10-26 20:10:00" }, "assignment_on_hook_by": { "id": 10047, "company_id": 10001, "name": "collector name", "firstname": "Jeff", "lastname": "Inani", "contact": { "email": "abc@gmail.com", "mobile_phone": "123-456-7890" }, "roles": [ "string" ], "self": "api/employees/10047", "expand": "employee", "employee_id": 86019, "latitude": "0", "longitude": "0", "created_at": "2018-10-26 20:10:00", "updated_at": "2018-10-26 20:10:00" }, "vehicle_value": 7000, "created_at": "2014-10-29 18:46:48", "updated_at": "2019-01-17 23:18:13" } ], "address_details": [ { "id": 23, "lpr_hit_id": null, "company_id": 10001, "parent_id": null, "orders_id": 22, "address_id": 56712, "order_person": null, "category": 3, "dwelling": null, "object_id": 10, "dwelling_type": 1, "employee": null, "created_at": "2014-10-29 19:01:18", "updated_at": "2014-10-29 19:01:18", "valid": 1, "invalid_address_reason": null, "order_collaterals_id": null, "is_accepted": 1, "is_public": 0, "is_pickup": 0, "is_reference": null, "last_update_by": null, "invalid_reason": null, "deleted_at": null, "address_details": { "id": 56712, "name": "0", "address_1": "730 Paradise Lane", "address_2": null, "unit": null, "zip": 48336, "type": 1, "latitude": 33.65031449, "longitude": -117.24815155, "date_delay": null, "available_from": "00:00:00", "available_to": "23:59:00", "priority": 0, "hits": 0, "no_contact": 0, "created_at": "2014-10-29 19:01:18", "updated_at": "2017-12-13 01:21:33", "deleted_at": null, "migration": null, "phones": [ { "id": 11314, "type": 6, "mobile_carrier_id": null, "number": "123456", "extension": null, "memo": null, "valid": 1, "no_contact": 0, "created_at": "2020-06-10 10:53:41", "updated_at": "2020-06-10 10:53:41", "migration": null, "address_with_number": "No Address" } ], "zip_code_details": { "zip_code_id": 48336, "zip_code": "92507", "zip_code_city_id": 48330, "city_name": "Riverside", "zip_code_state_id": 47459, "state_name": "California", "state_abbr": "CA", "state_county": "CA-Riverside", "zip_code_county_id": 47953, "county_name": "Riverside", "latitude": 33.976325, "longitude": -117.330414, "system_msg": 0, "country": "United States of America", "country_code": "US", "trigger_msg": 0, "shape_data": "[[[\"-117.274844\",\"34.004654\",\"0.0\"],[\"-117.268245\",\"33.940869\",\"0.0\"],[\"-117.289141\",\"33.924923\",\"0.0\"],[\"-117.37657\",\"33.968912\",\"0.0\"],[\"-117.339179\",\"34.0195\",\"0.0\"],[\"-117.336429\",\"34.0195\",\"0.0\"],[\"-117.305637\",\"34.0195\",\"0.0\"],[\"-117.274844\",\"34.004654\",\"0.0\"]]" } }, "category_details": { "id": 3, "name": "borrower_home", "friendlyname": "Borrower - Home", "created_at": "2020-06-02 16:44:26", "updated_at": "2020-06-02 16:44:26", "deleted_at": null }, "dwelling_details": { "id": 3, "name": "unverified", "friendlyname": "Borrower - Home", "created_at": "2020-06-02 16:44:26", "updated_at": "2020-06-02 16:44:26", "deleted_at": null } } ] } } |
Update an Order
Description: Updates specified fields on an order; unspecified fields remain unchanged.
URL: /api/v140/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/v140/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" } |
Assign Order
Description: Assigns an existing order to a service provider, optionally limiting to specific address IDs; returns the updated order.
URL: /api/v140/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/v140/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 } } |
Retrieve Order Employees
Description: Retrieves the list of employees assigned to a specific order by its unique ID.
URL: /api/v140/orders/{order_id}/employees
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/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/v140/orders/{order_id}/employees/{employee_id}
Method: DELETE
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
https://api.mbsisystems.com/api/v140/orders/57070465/employees/353379 |
Request Body: NA
Response:
{ "data": { "success": true } }
|
Retrieve Order Addresses
Description: Retrieves all address details associated with a specific order by its unique ID.
URL: /api/v140/orders/{order_id}/addresses
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57070465/addresses |
Request Body: NA
Response:
{ "data": [ { "id": 219111136, "lpr_hit_id": null, "company_id": 65690, "parent_id": 219111135, "orders_id": 57070465, "address_id": 120092420, "order_person": 124938336, "category": 3, "dwelling": 9, "object_id": null, "dwelling_type": 1, "employee": 86567, "created_at": "2026-03-02 15:46:47", "updated_at": "2026-03-02 15:46:47", "valid": 1, "invalid_address_reason": null, "order_collaterals_id": null, "is_accepted": 1, "is_public": 1, "is_pickup": 0, "is_reference": false, "last_update_by": null, "invalid_reason": null, "deleted_at": null, "address_details": { "id": 120092420, "name": "Home Address", "address_1": "A_Charlene2384 E Browning Pl Chandler", "address_2": "", "unit": "", "zip": 46177, "type": 1, "latitude": "33.28924300", "longitude": "-111.80938200", "date_delay": null, "available_from": "00:00:00", "available_to": "23:59:00", "priority": 0, "hits": 0, "no_contact": 0, "created_at": "2026-03-02 15:46:47", "updated_at": "2026-03-02 15:46:47", "deleted_at": null, "migration": null, "phones": [], "zip_code_details": { "zip_code_id": 46177, "zip_code": "85001", "zip_code_city_id": 46177, "city_name": "Phoenix", "zip_code_state_id": 46177, "state_name": "Arizona", "state_abbr": "AZ", "state_county": "AZ-Maricopa", "zip_code_county_id": 46177, "county_name": "Maricopa", "latitude": "33.449215", "longitude": "-112.069209", "system_msg": 0, "country": "United States of America", "country_code": "US", "trigger_msg": 0, "shape_data": null }, "reference_person": null }, "category_details": { "id": 3, "name": "borrower_home", "friendlyname": "Borrower - Home", "created_at": "2021-12-09 02:47:49", "updated_at": "2021-12-09 02:47:49", "deleted_at": null }, "dwelling_details": { "id": 9, "name": "unverified", "friendlyname": "Unknown Type", "created_at": null, "updated_at": null, "deleted_at": null } } ], "links": { "first": "http://stg-api.mbsisystems.com/api/v140/orders/57070465/addresses?q=%2Fapi%2Fv140%2Forders%2F57070465%2Faddresses&page=1", "last": "http://stg-api.mbsisystems.com/api/v140/orders/57070465/addresses?q=%2Fapi%2Fv140%2Forders%2F57070465%2Faddresses&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "path": "http://stg-api.mbsisystems.com/api/v140/orders/57070465/addresses", "per_page": "20", "to": 1, "total": 1, "fixme": { "message": "GenericCollectionResource: create specific resource collection object", "source": { "file": "/var/www/mobile_dev/releases/20210210171746/versions/v140/app/Http/Controllers/Api/Mixins/Helper/ReturnsOrderableCollections.php", "line": 66, "function": "__construct", "class": "App\\Http\\Resources\\GenericCollectionResource", "type": "->" } } } } |
Update Order Address
Description: Updates the details of a specific address associated with an order, identified by order_id and address_id.
URL: /api/v140/orders/{order_id}/addresses/{address_id}
Method: PUT
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
is_accepted | Boolean flag (0 = No, 1 = Yes) indicating whether the address update is accepted | No | 1 |
address_1 | Primary address line (e.g., street name, building number) | No | 3620 W Greenway Rd |
address_2 | Secondary address details such as apartment, suite, or additional location info | No | Apt 12B, Phoenix AZ |
zip | Postal/ZIP code of the address location | No | 85014 |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/16644246/addresses/17664959 |
Request Body:
{ "is_accepted": 1 } |
Response:
{ "data": { "id": 23, "lpr_hit_id": null, "company_id": 10001, "parent_id": null, "orders_id": 22, "address_id": 56712, "order_person": null, "category": 3, "dwelling": null, "object_id": 10, "dwelling_type": 1, "employee": null, "created_at": "2014-10-29 19:01:18", "updated_at": "2014-10-29 19:01:18", "valid": 1, "invalid_address_reason": null, "order_collaterals_id": null, "is_accepted": 1, "is_public": 0, "is_pickup": 0, "is_reference": null, "last_update_by": null, "invalid_reason": null, "deleted_at": null, "address_details": { "id": 56712, "name": "0", "address_1": "730 Paradise Lane", "address_2": null, "unit": null, "zip": 48336, "type": 1, "latitude": 33.65031449, "longitude": -117.24815155, "date_delay": null, "available_from": "00:00:00", "available_to": "23:59:00", "priority": 0, "hits": 0, "no_contact": 0, "created_at": "2014-10-29 19:01:18", "updated_at": "2017-12-13 01:21:33", "deleted_at": null, "migration": null, "phones": [ { "id": 11314, "type": 6, "mobile_carrier_id": null, "number": "123456", "extension": null, "memo": null, "valid": 1, "no_contact": 0, "created_at": "2020-06-10 10:53:41", "updated_at": "2020-06-10 10:53:41", "migration": null, "address_with_number": "No Address" } ], "zip_code_details": { "zip_code_id": 48336, "zip_code": "92507", "zip_code_city_id": 48330, "city_name": "Riverside", "zip_code_state_id": 47459, "state_name": "California", "state_abbr": "CA", "state_county": "CA-Riverside", "zip_code_county_id": 47953, "county_name": "Riverside", "latitude": 33.976325, "longitude": -117.330414, "system_msg": 0, "country": "United States of America", "country_code": "US", "trigger_msg": 0, "shape_data": "[[[\"-117.274844\",\"34.004654\",\"0.0\"],[\"-117.268245\",\"33.940869\",\"0.0\"],[\"-117.289141\",\"33.924923\",\"0.0\"],[\"-117.37657\",\"33.968912\",\"0.0\"],[\"-117.339179\",\"34.0195\",\"0.0\"],[\"-117.336429\",\"34.0195\",\"0.0\"],[\"-117.305637\",\"34.0195\",\"0.0\"],[\"-117.274844\",\"34.004654\",\"0.0\"]]" } }, "category_details": { "id": 3, "name": "borrower_home", "friendlyname": "Borrower - Home", "created_at": "2020-06-02 16:44:26", "updated_at": "2020-06-02 16:44:26", "deleted_at": null }, "dwelling_details": { "id": 3, "name": "unverified", "friendlyname": "Borrower - Home", "created_at": "2020-06-02 16:44:26", "updated_at": "2020-06-02 16:44:26", "deleted_at": null } } } |
Remove Employee from Order Address
Description: Deletes a specific employee assigned to an address within an order, identified by order_id, address_id, and employee_id.
URL: /api/v140/orders/{order_id}/addresses/{address_id}/employees/{employee_id}
Method: DELETE
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
https://api.mbsisystems.com/api/v140/orders/16644246/addresses/17664959/employees/353379 |
Request Body: NA
Response:
{ "data": { "success": true } } |
Retrieve Order Client Details
Description: This endpoint retrieves the client information associated with a specific order (case). It returns the client details linked to the provided order ID.
URL: /api/v140/orders/{order_id}/client
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
https://api.mbsisystems.com/api/v140/orders/57066438/client |
Request Body: NA
Response:
{ "data": [ { "id": 65690, "district_id": null, "parent_company": null, "type": 11, "status": 1, "created_by": 10001, "created_by_employee": 10013, "merged_from": null, "owned_by": 3099, "name": "Demo Bank & Trust MRS", "legal_name": "Demo Bank and Trust", "website": "", "is_global": 2, "tin": "123", "current_caseno": 10431, "current_transid": 70112, "signup_code": 0, "htmlhead": null, "allow_provider_change": 1, "allow_client_personal_items": 1, "allow_bk_scrub": 1, "allow_ssn_hide": 1, "auto_purchase_plates": 0, "lienholder_verification": 1, "ssn_digits": 4, "password_expiration": 0, "password_expiration_days": 0, "previous_passwords": 0, "previous_passwords_number": 0, "allow_cln_hide": 0, "cln_digits": 8, "scorecard_enabled": 1, "scorecard_enabled_at": "2020-06-23 16:39:17", "login_type": null, "service_provider_custom_fees": 0, "allow_sp_add": 1, "auto_sp_add": 0, "store_number": "5678", "disable_adding_ssn": 0, "disable_adding_loan_payment": 0, "service_provider_allow_sp_add": 1, "only_approved_invoiceprint": 0, "parent_approval_invoice_exp": 0, "address_is_public_by_default": 1, "preferred_billing": "ACH Deposit", "invoices_created_due_after": 30, "recovery_acknowledgement_lockout": null, "company_wide_hold": 0, "auto_ack_plate_share_web": 0, "filter_sp_by_cvt": 1, "fieldvisit_ackn": 0, "repo_ackn": 0, "bulk_recharge": 1, "use_company_email": 1, "validate_case_import_vin": 0, "search_data_staging_member_companies": 0, "charge_transaction_fees": 1, "geo_assignment_restriction": 0, "created_at": "2015-04-08 22:23:30", "updated_at": "2026-03-05 12:27:54", "deleted_at": null, "manual_contract": 1, "client_invoicing_requirements": 1, "deliver_to_auction": 0, "release_to_auction": 0, "donot_contact_flag": 0, "enable_contracted_fees": null, "allow_vin_hide": null, "vin_digits": null, "has_claims": 0, "pre_approved_auto_invoice": 1, "bill_to_debtor": 1, "bill_to_debtor_days": "45", "sla_enforced": 0, "sla_enforced_days": "0", "sla_allowed_invoice": "0", "gl_code_require": 0, "phones": [] } ], "meta": { "fixme": { "message": "GenericResource: create specific resource object", "source": { "file": "/var/www/mobile_dev/releases/20210210171746/versions/v140/app/Http/Controllers/Api/Mixins/Actions/Get/ShowSingleCompanyOrder.php", "line": 34, "function": "__construct", "class": "App\\Http\\Resources\\GenericResource", "type": "->" } } } } |
Retrieve Tags for a Specified Company
Description: This endpoint retrieves all tags associated with the company identified by the company_id provided in the endpoint URL.
URL: /api/v140/companies/10004/tags
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/companies/10004/tags |
Request Body: NA
Response:
{ "data": [ { "id": 2412, "company_id": 10004, "employee_id": 78830, "name": "Transport needed", "seq": null, "created_at": "2019-05-23 16:51:29", "updated_at": "2022-09-25 17:06:08", "deleted_at": null }, { "id": 2428, "company_id": 10004, "employee_id": 78830, "name": "Hurricane Hold - David", "seq": null, "created_at": "2019-06-14 18:38:59", "updated_at": "2022-09-25 17:06:08", "deleted_at": null }, { "id": 2514, "company_id": 10004, "employee_id": 11765, "name": "01-mikes", "seq": null, "created_at": "2019-11-20 19:09:13", "updated_at": "2022-09-25 17:06:08", "deleted_at": null }, { "id": 2608, "company_id": 10004, "employee_id": 80558, "name": "LPR Eligible", "seq": null, "created_at": "2020-04-02 20:18:47", "updated_at": "2022-09-25 17:06:08", "deleted_at": null }, { "id": 2660, "company_id": 10004, "employee_id": 201362, "name": "", "seq": null, "created_at": "2020-08-20 14:24:34", "updated_at": "2022-09-25 17:06:08", "deleted_at": null }, { "id": 2688, "company_id": 10004, "employee_id": 11765, "name": "Adam's accounts", "seq": null, "created_at": "2020-10-07 19:16:35", "updated_at": "2022-09-25 17:06:08", "deleted_at": null }, { "id": 3790, "company_id": 10004, "employee_id": 86524, "name": "shilpa test tag", "seq": null, "created_at": "2022-12-15 04:47:26", "updated_at": "2022-12-15 04:47:26", "deleted_at": null }, { "id": 4246, "company_id": 10004, "employee_id": 420711, "name": "anirudh", "seq": null, "created_at": "2023-10-20 11:57:35", "updated_at": "2023-10-20 11:57:35", "deleted_at": null }, { "id": 4247, "company_id": 10004, "employee_id": 420710, "name": "Field Agent1", "seq": null, "created_at": "2023-10-20 13:20:24", "updated_at": "2023-10-20 13:20:24", "deleted_at": null }, { "id": 4251, "company_id": 10004, "employee_id": 420708, "name": "Transport/Redemption hold", "seq": null, "created_at": "2023-12-18 13:53:57", "updated_at": "2023-12-18 13:53:57", "deleted_at": null }, { "id": 4252, "company_id": 10004, "employee_id": 420708, "name": "Repo Only - Vehicle at Auction", "seq": null, "created_at": "2023-12-18 13:54:14", "updated_at": "2023-12-18 13:54:14", "deleted_at": null }, { "id": 4253, "company_id": 10004, "employee_id": 420708, "name": "Redemptions/Waiting signed release", "seq": null, "created_at": "2023-12-18 13:54:29", "updated_at": "2023-12-18 13:54:29", "deleted_at": null }, { "id": 4254, "company_id": 10004, "employee_id": 420708, "name": " Vehicle redeemed", "seq": null, "created_at": "2023-12-18 13:54:40", "updated_at": "2023-12-18 13:54:40", "deleted_at": null }, { "id": 4327, "company_id": 10004, "employee_id": null, "name": "Bonus Program", "seq": null, "created_at": "2024-12-02 12:17:28", "updated_at": "2024-12-02 12:17:28", "deleted_at": null } ], "meta": { "fixme": { "message": "GenericCollectionResource: create specific resource collection object", "source": { "file": "/var/www/mobile_dev/releases/20210210171746/versions/v130/app/Http/Resources/GenericResource.php", "line": 19, "function": "__construct", "class": "App\\Http\\Resources\\GenericCollectionResource", "type": "->" } } } } |
Attach Tags to Order
Description: This endpoint attaches one or more tags to a specified order. Tags are used for the classification, tracking, or grouping of orders.
URL: /api/v140/orders/{order_id}/tags
Method: POST
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
tags | |||
id | Unique identifier of the tag | Yes | 3790 |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57070223/tags |
Request Body: NA
Response:
{ "data": [ { "id": 3790, "company_id": 10004, "name": "shilpa test tag" } ] } |
Delete Order Tag
Description: This endpoint removes a specific tag associated with an order.
URL: /api/v140/orders/{order_id}/tags/{tag_id}
Method: DELETE
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57070223/tags/3790 |
Request Body: NA
Response:
{ "data": [] } |
Retrieve Recon Orders – Filtering endpoint
Description: This endpoint retrieves orders with limited parameters. It is primarily used for reconciliation purposes and allows filtering orders using several query parameters such as order status, client ID, VIN, and creation date range.
URL: /api/v140/recon/orders
Method: GET
Query Parameters:
PARAMETER | DESCRIPTION | EXAMPLE |
status | Filters orders by collateral status ID | 1 |
acct_no | Filters orders by client account number | 122121 |
client_id | Filters orders by client identifier | 65690 |
owner_id | Filters orders by owner company ID | 10001 |
other_refno | Filters orders by other reference number | Aab121 |
order_type | Filters orders by order type | 1 |
vin | Filters orders by VIN | 1HGCM82633A123456 |
ids | Filters orders by specific order IDs (comma-separated list) | 109773,109774 |
per_page | Number of records per page. Default value is 250 | 100 |
page | Specifies the page number for paginated results | 2 |
created_at_start | Start of the order creation date range. Must be used together with created_at_end | 2022-01-31 01:11:14 |
created_at_end | End of the order creation date range. Must be used together with created_at_start | 2022-03-31 01:11:14 |
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/recon/orders?client_id=65690&status=1&order_type=2&page=1 |
Request Body: NA
Response:
{ "data": [ { "id": 28501398, "other_refno": null, "client_id": 65690, "lienholder": 65690, "status_date": "2022-03-02T09:59:00.000000Z", "accepted_date": "2022-02-09 03:26:00", "tier_level": "Placement2", "placement_level": 2, "created_at": "2022-01-31 01:11:14", "company_orderno": "18255-1", "order_type": 2, "status": 1, "vin": "4C5FY406132T72853", "borrower_firstname": "Eldred", "borrower_middle_initial": "", "borrower_lastname": "Hane", "mass_hold_tags": [], "violent_event_details": [] }, { "id": 34647200, "other_refno": null, "client_id": 65690, "lienholder": 65690, "status_date": "2022-07-16T09:59:00.000000Z", "accepted_date": "2022-07-15 05:46:00", "tier_level": "Tier2", "placement_level": 2, "created_at": "2022-07-15 03:25:37", "company_orderno": "20185-1", "order_type": 2, "status": 1, "vin": "1N6BA07C38N334329", "borrower_firstname": "Gerald", "borrower_middle_initial": "", "borrower_lastname": "Marquardt", "mass_hold_tags": [], "violent_event_details": [] }, { "id": 51608760, "other_refno": null, "client_id": 65690, "lienholder": 65690, "status_date": "2023-07-03T21:40:14.000000Z", "accepted_date": "2023-07-03 21:11:32", "tier_level": "Placement 1", "placement_level": 1, "created_at": "2023-07-03 21:11:32", "company_orderno": "22393-1", "order_type": 2, "status": 1, "vin": "WAUED24B1YN136182", "borrower_firstname": "Gillian", "borrower_middle_initial": "M", "borrower_lastname": "Davis", "mass_hold_tags": [], "violent_event_details": [] }, { "id": 56542446, "other_refno": null, "client_id": 65690, "lienholder": 65690, "status_date": "2025-01-06T22:35:00.000000Z", "accepted_date": "2024-11-22 15:00:00", "tier_level": "Placemen1", "placement_level": 1, "created_at": "2024-11-22 13:40:35", "company_orderno": "67067-1", "order_type": 2, "status": 1, "vin": "WA1DGAFP4EA014325", "borrower_firstname": "AMBROISE", "borrower_middle_initial": "", "borrower_lastname": "NATALIE2", "mass_hold_tags": [], "violent_event_details": [] } ], "links": { "first": "http://stg-api.mbsisystems.com/api/v140/recon/orders?q=%2Fapi%2Fv140%2Frecon%2Forders&client_id=65690&status=1&order_type=2&page=1", "last": "http://stg-api.mbsisystems.com/api/v140/recon/orders?q=%2Fapi%2Fv140%2Frecon%2Forders&client_id=65690&status=1&order_type=2&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "path": "http://stg-api.mbsisystems.com/api/v140/recon/orders", "per_page": "20", "to": 4, "total": 4, "orderby": "id", "direction": "asc", "orderby_options": [ "id" ] }, "warnings": [] } |
Retrieve Recon Assignments – Filtering endpoint
Description: This endpoint retrieves assignments with limited parameters. It allows filtering assignment records using query parameters such as status, client ID, account number, and assignment IDs. The endpoint also supports pagination.
URL: /api/v140/recon/assignments
Method: GET
Query Parameters:
PARAMETER | DESCRIPTION | EXAMPLE |
status | Filters orders by collateral status ID | 1 |
acct_no | Filters orders by client account number | 122121 |
client_id | Filters orders by client identifier | 65690 |
owner_id | Filters orders by owner company ID | 10001 |
ids | Filters assignments by specific assignment IDs (comma-separated list) | 109773,109774 |
per_page | Number of records per page. Default value is 250 | 100 |
page | Specifies the page number for paginated results | 2 |
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/recon/assignments?client_id=65690&status=1 |
Request Body: NA
Response:
{ "data": [ { "id": 30554, "other_refno": null, "client_id": 65690, "lienholder": null, "status_date": null, "accepted_date": null, "tier_level": null, "placement_level": null, "created_at": "2016-02-26 18:32:33", "company_orderno": "1031-1", "order_type": 1, "status": 1, "vin": null, "borrower_firstname": null, "borrower_middle_initial": null, "borrower_lastname": null, "mass_hold_tags": [], "violent_event_details": [] } ], "links": { "first": "http://stg-api.mbsisystems.com/api/v140/recon/assignments?q=%2Fapi%2Fv140%2Frecon%2Fassignments&client_id=65690&status=1&page=1", "last": "http://stg-api.mbsisystems.com/api/v140/recon/assignments?q=%2Fapi%2Fv140%2Frecon%2Fassignments&client_id=65690&status=1&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "path": "http://stg-api.mbsisystems.com/api/v140/recon/assignments", "per_page": "20", "to": 1, "total": 1, "orderby": "id", "direction": "asc", "orderby_options": [ "id" ] }, "warnings": [] } |
Add Office Employee to Order
Description: This endpoint assigns one or more office employees to a specific order.
URL: /api/v140/orders/{order_id}/office_employees
Method: POST
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
employee_ids | An array containing the employee IDs to be assigned to the order | Yes | 131709 |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57070212/office_employees |
Request Body:
{ "employee_ids": [ 78830, 80034 ] } |
Response:
{ "data": [ { "id": 124941377, "order_id": 57070212, "employee_id": 78830, "person_id": 1971583, "firstname": "William", "middlename": null, "lastname": "Sheehan", "role": null, "is_violent": 0, "is_primary": 0 }, { "id": 124941378, "order_id": 57070212, "employee_id": 80034, "person_id": 2046199, "firstname": "Erika", "middlename": null, "lastname": "Clark", "role": null, "is_violent": 0, "is_primary": 0 } ], "status": "success" } |
Retrieve Office Employees
Description: This endpoint retrieves the list of office employees assigned to a specific order.
URL: /api/v140/orders/{order_id}/office_employees
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57070212/office_employees |
Request Body: NA
Response:
{ "data": [ { "id": 124937951, "order_id": 57070212, "employee_id": 83268, "person_id": 2262442, "firstname": "QA", "middlename": null, "lastname": "DemoFor", "role": null, "is_violent": 0, "is_primary": 0 }, { "id": 124941377, "order_id": 57070212, "employee_id": 78830, "person_id": 1971583, "firstname": "William", "middlename": null, "lastname": "Sheehan", "role": null, "is_violent": 0, "is_primary": 0 }, { "id": 124941378, "order_id": 57070212, "employee_id": 80034, "person_id": 2046199, "firstname": "Erika", "middlename": null, "lastname": "Clark", "role": null, "is_violent": 0, "is_primary": 0 } ] } |
Delete Office Employees
Description: This endpoint removes an office employee assigned to a specific order
URL: /api/v140/orders/{order_id}/office_employees/{employee_id}
Method: DELETE
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57070212/office_employees/83268 |
Request Body: NA
Response:
{ "data": { "success": true } } |
Retrieve Critical Dates
Description: This endpoint retrieves the critical dates associated with the collateral of a specific order. These dates represent important milestones in the order lifecycle such as repossession, transport, redemption, and case closure.
URL: /api/v140/orders/{order_id}/collateral_critical_dates
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57070212/collateral_critical_dates |
Request Body: NA
Response:
{ "data": [ { "date_type_id": 10, "date_at": "2026-03-02 06:34:54", "timezone": "UTC" }, { "date_type_id": 20, "date_at": "2026-03-02 06:35:00", "timezone": "UTC" } ] } |
Transfer Order Attachment
Description: This endpoint transfers an attachment associated with an order to another order.
URL: /api/v140/orders/{order_id}/attachments/{attachment_id}/transfer
Method: PUT
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
transfer_to | Array containing the target order ID(s) to which the attachment will be transferred | Yes | 262552 |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/56934626/attachments/67288827/transfer |
Request Body:
{ "transfer_to": [ 262552 ] } |
Response:
{ "orders": [ { "id": 262552, "attachments": [ { "id": 6299652, "status": "fail" } ] } ] } |