---
title: "Retrieve a vehiclesale"
url: "https://docs.unified.to/dms/vehiclesale/Retrieve_a_vehiclesale"
description: "Retrieve a vehiclesale with Unified's Vehiclesale API (GET /dms/{connection_id}/vehiclesale/{id}). Filter by fields and raw. Supported by 6 Vehiclesale integrations."
date: "2026-11-21T17:08:55.315Z"
updated: "2026-11-21T17:08:55.315Z"
---
# Retrieve a vehiclesale

Updated: November 21, 2026

 GET/dms/{connection\_id}/vehiclesale/{id}

Retrieves a single DmsVehiclesale by its `id`. Obtain `id` values from the corresponding list endpoint. Use `fields` to return only the fields you need.

## Parameters

**fields**string array 

id

created\_at

updated\_at

number

status

type

finance\_type

contact\_ids

company\_ids

lead\_id

salesperson\_user\_ids

sales\_manager\_user\_id

finance\_manager\_user\_ids

vehicles

trade\_ins

fees

products

taxes

finance

currency

rebate\_amount

down\_payment\_amount

tax\_amount

total\_amount

front\_gross\_amount

back\_gross\_amount

sold\_at

delivered\_at

posted\_at

source

notes

metadata

raw

Fields to return

**raw**string 

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

**connection\_id**string  required 

ID of the connection

**id**string  required 

ID of the Vehiclesale

## Returns

[DmsVehiclesale](https://docs.unified.to/dms/vehiclesale/model.md)

| Response field                             | Type                      | Required | Description                                                                                                                                                                                                   |
| ------------------------------------------ | ------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id                                         | string                    | No       |                                                                                                                                                                                                               |
| created\_at                                | string (date-time)        | No       | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)                                                                                                                                                                      |
| updated\_at                                | string (date-time)        | No       | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)                                                                                                                                                                      |
| number                                     | string                    | No       | Dealer-visible deal number                                                                                                                                                                                    |
| status                                     | enum                      | No       | Values: QUOTE, PENDING, SOLD, DELIVERED, FINALIZED, CANCELLED, OTHER                                                                                                                                          |
| type                                       | enum                      | No       | Sale channel Values: RETAIL, WHOLESALE, FLEET, DEALER\_TRADE, OTHER                                                                                                                                           |
| finance\_type                              | enum                      | No       | Values: CASH, FINANCE, LEASE, BALLOON, OTHER                                                                                                                                                                  |
| contact\_ids                               | string\[\]                | No       | Buyers as CRM Contacts, primary buyer first                                                                                                                                                                   |
| company\_ids                               | string\[\]                | No       | Business buyers as CRM Companies                                                                                                                                                                              |
| lead\_id                                   | string                    | No       | The CRM Lead this sale came from (reference to CrmLead)                                                                                                                                                       |
| salesperson\_user\_ids                     | string\[\]                | No       | Salespeople, as HR Employees                                                                                                                                                                                  |
| sales\_manager\_user\_id                   | string                    | No       | Sales manager, as an HR Employee (reference to HrisEmployee)                                                                                                                                                  |
| finance\_manager\_user\_ids                | string\[\]                | No       | Finance (F&I) managers, as HR Employees                                                                                                                                                                       |
| vehicles                                   | DmsVehiclesaleVehicle\[\] | No       | Vehicles sold                                                                                                                                                                                                 |
| vehicles\[\].vehicle\_id                   | string                    | No       | The DmsVehicle ID                                                                                                                                                                                             |
| vehicles\[\].vin                           | string                    | No       | VIN as sold                                                                                                                                                                                                   |
| vehicles\[\].stock\_number                 | string                    | No       | Stock number as sold                                                                                                                                                                                          |
| vehicles\[\].odometer                      | number                    | No       | Odometer at sale                                                                                                                                                                                              |
| vehicles\[\].price\_amount                 | number                    | No       | Agreed selling price of the vehicle                                                                                                                                                                           |
| vehicles\[\].msrp\_amount                  | number                    | No       |                                                                                                                                                                                                               |
| vehicles\[\].cost\_amount                  | number                    | No       | Dealer cost of the vehicle                                                                                                                                                                                    |
| trade\_ins                                 | DmsVehiclesaleTradein\[\] | No       |                                                                                                                                                                                                               |
| trade\_ins\[\].vehicle\_id                 | string                    | No       | The DmsVehicle ID of the trade-in, when recorded                                                                                                                                                              |
| trade\_ins\[\].vin                         | string                    | No       |                                                                                                                                                                                                               |
| trade\_ins\[\].year                        | number                    | No       |                                                                                                                                                                                                               |
| trade\_ins\[\].make                        | string                    | No       |                                                                                                                                                                                                               |
| trade\_ins\[\].model                       | string                    | No       |                                                                                                                                                                                                               |
| trade\_ins\[\].odometer                    | number                    | No       |                                                                                                                                                                                                               |
| trade\_ins\[\].allowance\_amount           | number                    | No       | Trade allowance given to the buyer                                                                                                                                                                            |
| trade\_ins\[\].actual\_cash\_value\_amount | number                    | No       | Actual cash value (dealer valuation)                                                                                                                                                                          |
| trade\_ins\[\].payoff\_amount              | number                    | No       | Outstanding loan payoff                                                                                                                                                                                       |
| trade\_ins\[\].lienholder\_name            | string                    | No       | Lender owed the payoff                                                                                                                                                                                        |
| fees                                       | DmsVehiclesaleFee\[\]     | No       |                                                                                                                                                                                                               |
| fees\[\].name                              | string                    | No       |                                                                                                                                                                                                               |
| fees\[\].price\_amount                     | number                    | No       | Amount charged to the buyer                                                                                                                                                                                   |
| fees\[\].cost\_amount                      | number                    | No       | Dealer cost                                                                                                                                                                                                   |
| fees\[\].is\_capitalized                   | boolean                   | No       | Rolled into the financed or leased amount                                                                                                                                                                     |
| products                                   | DmsVehiclesaleProduct\[\] | No       | Finance and insurance (F&I) products                                                                                                                                                                          |
| products\[\].type                          | enum                      | No       | Values: SERVICE\_CONTRACT, GAP, CREDIT\_LIFE, ACCIDENT\_HEALTH, MAINTENANCE, PROTECTION, INSURANCE, OTHER                                                                                                     |
| products\[\].name                          | string                    | No       | Product or plan name                                                                                                                                                                                          |
| products\[\].provider                      | string                    | No       | Provider or carrier name                                                                                                                                                                                      |
| products\[\].price\_amount                 | number                    | No       | Price charged to the buyer                                                                                                                                                                                    |
| products\[\].cost\_amount                  | number                    | No       | Dealer cost                                                                                                                                                                                                   |
| products\[\].term\_months                  | number                    | No       | Coverage term in months                                                                                                                                                                                       |
| products\[\].term\_mileage                 | number                    | No       | Coverage distance limit                                                                                                                                                                                       |
| products\[\].deductible\_amount            | number                    | No       |                                                                                                                                                                                                               |
| products\[\].contract\_number              | string                    | No       | Policy or contract number                                                                                                                                                                                     |
| taxes                                      | DmsVehiclesaleTax\[\]     | No       |                                                                                                                                                                                                               |
| taxes\[\].name                             | string                    | No       |                                                                                                                                                                                                               |
| taxes\[\].rate                             | number                    | No       | Tax rate, as a percentage                                                                                                                                                                                     |
| taxes\[\].total\_amount                    | number                    | No       | Tax amount                                                                                                                                                                                                    |
| finance                                    | object                    | No       | Finance or lease terms                                                                                                                                                                                        |
| finance.lender\_name                       | string                    | No       | Bank or finance company                                                                                                                                                                                       |
| finance.term\_months                       | number                    | No       |                                                                                                                                                                                                               |
| finance.interest\_rate                     | number                    | No       | APR, as a percentage                                                                                                                                                                                          |
| finance.payment\_amount                    | number                    | No       | Regular payment amount                                                                                                                                                                                        |
| finance.payment\_frequency                 | enum                      | No       | Values: MONTHLY, SEMI\_MONTHLY, BIWEEKLY, WEEKLY, YEARLY, OTHER                                                                                                                                               |
| finance.financed\_amount                   | number                    | No       | Amount financed                                                                                                                                                                                               |
| finance.residual\_amount                   | number                    | No       | Lease residual or guaranteed future value                                                                                                                                                                     |
| finance.money\_factor                      | number                    | No       | Lease money factor                                                                                                                                                                                            |
| finance.first\_payment\_at                 | string (date-time)        | No       | First payment due date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)                                                                                                                                               |
| currency                                   | string                    | No       | ISO 4217 currency code                                                                                                                                                                                        |
| rebate\_amount                             | number                    | No       | Manufacturer and dealer rebates and incentives                                                                                                                                                                |
| down\_payment\_amount                      | number                    | No       | Cash down payment and deposits                                                                                                                                                                                |
| tax\_amount                                | number                    | No       | Total tax                                                                                                                                                                                                     |
| total\_amount                              | number                    | No       | Total cash price including fees, products and taxes, before trade-ins                                                                                                                                         |
| front\_gross\_amount                       | number                    | No       | Front-end (vehicle) gross profit                                                                                                                                                                              |
| back\_gross\_amount                        | number                    | No       | Back-end (F&I) gross profit                                                                                                                                                                                   |
| sold\_at                                   | string (date-time)        | No       | Sale or contract date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)                                                                                                                                                |
| delivered\_at                              | string (date-time)        | No       | When the vehicle was handed over (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)                                                                                                                                     |
| posted\_at                                 | string (date-time)        | No       | When the sale was finalized or posted to accounting (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)                                                                                                                  |
| source                                     | string                    | No       | Lead or advertising source                                                                                                                                                                                    |
| notes                                      | string                    | No       |                                                                                                                                                                                                               |
| metadata                                   | DmsMetadata\[\]           | No       |                                                                                                                                                                                                               |
| metadata\[\].id                            | string                    | No       | The ID of the custom field definition (from the metadata/metadata endpoint).                                                                                                                                  |
| metadata\[\].slug                          | string                    | No       | The integration's API name (key) of an existing custom field.                                                                                                                                                 |
| metadata\[\].value                         | object                    | No       | The field's value, typed by format.                                                                                                                                                                           |
| metadata\[\].namespace                     | string                    | No       |                                                                                                                                                                                                               |
| metadata\[\].format                        | enum                      | No       | The data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE\_SELECT, MULTIPLE\_SELECT, MEASUREMENT, PRICE, YES\_NO, CURRENCY, URL |
| metadata\[\].extra\_data                   | object                    | No       |                                                                                                                                                                                                               |

## Errors

 Errors return the HTTP status code and a JSON body with `statusCode`, `error` (the short label) and `message` (a human-readable detail). 

```json
{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
```

| Status | Error                 | Meaning                                           |
| ------ | --------------------- | ------------------------------------------------- |
| 400    | Bad Request           | The request was malformed or failed validation.   |
| 401    | Unauthorized          | The connection is likely broken; re-authorize it. |
| 403    | Forbidden             | The connection is missing permissions or scopes.  |
| 404    | Not Found             | The requested resource does not exist.            |
| 429    | Too Many Requests     | Rate limit exceeded (see the two sources below).  |
| 500    | Internal Server Error | An unexpected error occurred.                     |
| 501    | Not Implemented       | Not supported by this integration.                |

 Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message. 

### 429 Too Many Requests

A 429 has two possible sources:

* The integration's own rate limit, passed through.
* Unified's workspace limit: a rolling 60 seconds, set by plan, with the message `Too many requests to unified.to API; max requests per minute: N`.

## Code Samples

### Node.js SDK

```javascript
import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const id = '1234';

const results = await sdk.dms.getDmsVehiclesale({ connectionId, id, 
    fields: '',
    raw: '',
 });
```

### Node.js (axios)

```javascript
const options = {
  method: 'GET',
  url: 'https://api.unified.to/dms/5de520f96e439b002043d8dc/vehiclesale/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
```

### Java

```java
AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("GET", "https://api.unified.to/dms/5de520f96e439b002043d8dc/vehiclesale/5de520f96e439b002043d8d8?fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();
```

### Go

```go
import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/dms/5de520f96e439b002043d8dc/vehiclesale/5de520f96e439b002043d8d8?fields=&raw=

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
```

### Python

```python
import requests

url = "https://api.unified.to/dms/5de520f96e439b002043d8dc/vehiclesale/5de520f96e439b002043d8d8?fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.get(url, headers=headers)
```

### PHP

```php
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/dms/5de520f96e439b002043d8dc/vehiclesale/5de520f96e439b002043d8d8?fields=&raw=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);
```

### Ruby

```ruby
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/dms/5de520f96e439b002043d8dc/vehiclesale/5de520f96e439b002043d8d8?fields=&raw=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

response = http.request(request)
puts response.read_body
```

### cURL

```bash
curl --request GET \
  --url 'https://api.unified.to/dms/5de520f96e439b002043d8dc/vehiclesale/5de520f96e439b002043d8d8?fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'
```
