URL Expired

The URL for this request expired after 30 days.

id

integer

required

The id of the contract

api-version

integer

required

Target API version

``200 Success

object

id

integer

required

Statement ID

balance

float

required

Remaining balance due for the contract

customer_balance

float

required

Remaining balance due for the customer

total

float

required

Total cost of the contract, before applied payments

customer_total

float

required

Total customer cost of the contract, before applied payments

customer_payments_total

float

required

Total of successful customer payments on the contract

payer_total

float

required

Total additional payer cost of the contract

payer_payments_total

float

required

Total of payments made by the additional payer

payer_balance

float

required

Remaining additional payer balance of the contract

payments_total

float

required

Total of successful payments on the contract

currency_code

string

required

Applicable currency code for the contract

pricing

array of objects

required

Collection of charge types and line items

pricing*

object

name

string

required

Display name of pricing section

type

string

required

Type of adjustment or charge line items

total

float

required

Sum of included line items.

groups

array of objects

required

Grouped line items for split bills

groups*

object

description

string

required

The description of the line item total

float

required

Total of the line items

items

array of objects

required

Line items for the line item group

items*

object

bill_to

string

required

Bill To Name total

float

required

Total of the line item

additional_payer_totals

array of objects

required

Collection of split bill totals by each payer

additional_payer_totals*

object

customer_name

string

Name of the additional payer

amount

float

Total amount owed by the additional payer

links

object

required

contract

object

contract object

``401 Unauthorized

``403 Forbidden

``404 Not found

``406 Not Acceptable

{
  "id": 42,
  "balance": 89.23,
  "customer_balance": 89,
  "total": 125.98,
  "customer_total": 125.98,
  "customer_payments_total": 36.98,
  "payer_total": 0,
  "payer_payments_total": 0,
  "payer_balance": 0,
  "payments_total": 36.98,
  "currency_code": "USD",
  "pricing": [
    {
      "name": "Total Rental Charges",
      "type": "rental",
      "total": 125.98,
      "groups": [
        {
          "description": "12 Daily Rates ($4.00 per day)",
          "total": 48.5,
          "items": [
            {
              "bill_to": "Leslie Knope",
              "total": 48.5
            }
          ]
        }
      ]
    }
  ],
  "additional_payer_totals": [
    {
      "customer_name": "payer1",
      "amount": 75
    }
  ],
  "links": {
    "contract": {
      "id": 2,
      "href": "https://api.dw-tst.com/admin/some_resources/2"
    }
  }
}