Applies to integrated customers using the RecoveryConnect APIUpdate an Order
Description: Updates selected fields on an order; unspecified fields remain unchanged.
URL: /api/v130/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 |
| reopen_num | Number of times the case has been reopened. | No | 1 |
| is_latest_case | Boolean flag indicating if this is the most recent (latest) case record. | 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://test-api.mbsisystems.com/api/v130/orders/16644411 |
Request Body:
{ "order_type": 2, "is_violent": 0, "tier_level": "Tier1", "placement_level": 1, "reopen_num": 1, "is_latest_case": 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" }
|
Get Case 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/v130/orders/{order_id}
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://test-api.mbsisystems.com/api/v130/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 } } ] } } |