Applies to integrated customers using the RecoveryConnect API



Delete Expense from Smart Invoice

DescriptionThis endpoint deletes a specific expense from a smart invoice.

Expenses represent additional costs added to an invoice, and removing an expense will update the total invoice amount accordingly. This operation is typically allowed 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}/expenses/{expense_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/expenses/928101

 

Request Body: NA

Response:

{

  "message": "Expense deleted successfully."

}

 

Get Smart Invoice Billable Fees

DescriptionThis endpoint retrieves the list of billable fees available for smart invoice creation for a specific order.

Billable fees represent predefined chargeable items configured under the contract, such as recovery charges, storage fees, transportation costs, and other service-related fees. These fees can be used to populate service items while creating or updating a smart invoice.

The response also includes contract-related details applicable to the order.

All requests must include a valid Bearer Token in the request header.

 

URL: /api/v150/orders/order_id/invoice_billable_fees

Method: GET

Request Body Parameters: NA

Success Code: 200 OK – Request Successful

Example:

URL: https://api.mbsisystems.com/api/v150/orders/57036454/invoice_billable_fees

 

Request Body: NA

Response:

{

  "data": {

    "contract_id": 155,

    "version_number": 1,

    "misc_fees": [

      {

        "fee_id": 1001786,

        "fee_name": "Advanced Funds",

        "fee_type": "misc-fees",

           "default_amount": 75.3,

           "sla_enforced": "Yes",

           "pre_approval_required": "Yes",

           "status_required": "Closed",

           "item_allowed_for_invoice": false,

           "item_not_allowed_for_invoice_reason": "Pre-approval is required."

      }

    ]

  }

}

 

Get Contract Details

DescriptionThis endpoint retrieves the contract details associated with a specific order.

Contract details define the billing configuration for the order, including applicable fee structures, service items, pricing rules, and billing entities. These details are used during smart invoice creation and billing calculations.

All requests must include a valid Bearer Token in the request header.

 

URL: /api/v150/orders/order_id/contract_details

Method: GET

Request Body Parameters: NA

Success Code: 200 OK – Request Successful

Example:

URL: https://api.mbsisystems.com/api/v150/orders/57036454/contract_details

 

Request Body: NA

Response:

{

  "contract_id": 155,

  "version_number": 1,

  "contract_name": "Service provider Contract",

     "contract_start_date": "2022-10-18",

  "contract_end_date": "9999-12-31",

  "recovery_fees": [

    {

      "fee_id": 1001786,

      "fee_name": "Advanced Funds",

      "fee_type": "recovery_fee",

         "coverage_area_id": 155,

         "coverage_area_name": "Arizona",

      "sla_enforced": "Yes",

         "pre_approval_required": "No",

      "case_type_id": 4,

         "case_type_name": "transport",

         "default_amount": [

        {

          "tier": 1,

          "amount": 20

        }

      ]

    }

  ],

  "misc_fees": [

    {

      "fee_id": 1001786,

      "fee_name": "Advanced Funds",

      "fee_type": "misc-fees",

         "default_amount": 75.3,

      "sla_enforced": "Yes",

         "pre_approval_required": "Yes",

         "status_required": "Closed"

    }

  ],

     "recovery-add-on-fees": [

    {

      "fee_id": 1001786,

      "fee_name": "Advanced Funds",

         "coverage_area_name": "Phoenix",

         "default_amount": 75.3

    }

  ]

}