Skip to main content
GET
/
tradepayoffbalances
Get Trade Payoff Balances
curl --request GET \
  --url https://commerce.driv.ly/api/tradepayoffbalances
{
  "data": [
    {
      "trade": {
        "customer": "<string>",
        "vehicle": "<string>"
      },
      "balance": 123,
      "goodThroughDate": "2023-12-25",
      "lender": "<string>"
    }
  ],
  "success": true,
  "page": 2,
  "nextPage": 3,
  "prevPage": 1,
  "totalPages": 3,
  "totalCount": 25,
  "limit": 10,
  "pagingCounter": 11,
  "hasPrevPage": true,
  "hasNextPage": true
}

Query Parameters

​
depth
integer

The number of levels of related objects to include in the response

​
sort
string

Pass the name of a top-level field to sort by that field in ascending order. Prefix the name of the field with a minus symbol ("-") to sort in descending order.

​
limit
number

Limit number of results, default 10

​
where
object

Search for results fitting criteria, uses qs library for query string parsing

Response

Trade Payoff Balances Found

​
data
Trade Payoff Balance · object[]
​
success
boolean
​
page
number

Current page number

Examples:

2

​
nextPage
number | null

number of next page, null if it doesn't exist

Examples:

3

​
prevPage
number | null

number of previous page, null if it doesn't exist

Examples:

1

​
totalPages
number

Total pages available, based upon the limit

Examples:

3

​
totalCount
number

Total available records within the database

Examples:

25

​
limit
number

Limit query parameter, defaults to 10

Examples:

10

​
pagingCounter
number

number of the first record on the current page

Examples:

11

​
hasPrevPage
boolean

true/false if previous page exists

Examples:

true

​
hasNextPage
boolean

true/false if next page exists

Examples:

true

⌘I