Retrieve a repairorder

Updated:

GET/dms/{connection_id}/repairorder/{id}

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

Parameters

fieldsstring array
Fields to return
rawstring
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_idstring required
ID of the connection
idstring required
ID of the Repairorder

Returns

Response fieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
numberstringNoDealer-visible repair order number
statusenumNoValues: ESTIMATE, OPEN, IN_PROGRESS, ON_HOLD, COMPLETED, CLOSED, CANCELLED, OTHER
pay_typeenumNoPrimary pay type of the repair order Values: CUSTOMER, WARRANTY, INTERNAL, SERVICE_CONTRACT, OTHER
contact_idstringNoCustomer, as a CRM Contact
billing_contact_idstringNoBill-to party, as a CRM Contact, when it differs from the customer
vehicle_idstringNoThe DmsVehicle ID
vinstringNoVIN of the vehicle serviced
appointment_idstringNoThe DmsAppointment this repair order was created from
advisor_user_idstringNoService advisor, as an HR Employee (reference to HrisEmployee)
technician_user_idsstring[]NoTechnicians, as HR Employees
appointment_atstring (date-time)NoScheduled appointment or due-in time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
opened_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
promised_atstring (date-time)NoPromised completion time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
completed_atstring (date-time)NoWhen work finished (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
closed_atstring (date-time)NoWhen the repair order was closed or invoiced (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
delivered_atstring (date-time)NoWhen the vehicle was handed back (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
odometer_innumberNo
odometer_outnumberNo
odometer_unitenumNoValues: MILES, KILOMETERS, HOURS, OTHER
transport_typeenumNoCustomer transport while the vehicle is in Values: WAITER, DROP_OFF, SHUTTLE, LOANER, RENTAL, PICKUP_DELIVERY, TAXI, OTHER
tag_numberstringNoHang-tag or key-tag number
purchase_order_numberstringNoCustomer purchase order number
is_comebackbooleanNoRepeat repair
notesstringNo
currencystringNoISO 4217 currency code
estimate_amountnumberNoAuthorized estimate
labor_amountnumberNo
parts_amountnumberNo
sublet_amountnumberNo
misc_amountnumberNoOther charges: shop supplies, environmental, freight, lube
discount_amountnumberNo
tax_amountnumberNo
total_amountnumberNoGrand total including tax
balance_amountnumberNoAmount still owed
totalsDmsRepairorderTotal[]NoTotals split by pay type
totals[].pay_typeenumNoValues: CUSTOMER, WARRANTY, INTERNAL, SERVICE_CONTRACT, OTHER
totals[].labor_amountnumberNo
totals[].parts_amountnumberNo
totals[].sublet_amountnumberNo
totals[].misc_amountnumberNoOther charges: shop supplies, environmental, freight, lube
totals[].discount_amountnumberNo
totals[].tax_amountnumberNo
totals[].total_amountnumberNo
jobsDmsRepairorderJob[]No
jobs[].idstringNoLine identifier
jobs[].numberstringNoLine letter or sequence
jobs[].namestringNoShort job title or operation name
jobs[].complaintstringNoCustomer concern or request
jobs[].causestringNoDiagnosed cause
jobs[].correctionstringNoWork performed or technician story
jobs[].statusenumNoValues: PENDING, IN_PROGRESS, ON_HOLD, COMPLETED, DECLINED, CANCELLED, OTHER
jobs[].pay_typeenumNoWho pays for this job Values: CUSTOMER, WARRANTY, INTERNAL, SERVICE_CONTRACT, OTHER
jobs[].opcode_idstringNoThe primary DmsOpcode ID
jobs[].technician_user_idsstring[]NoTechnicians, as HR Employees (reference to HrisEmployee)
jobs[].sold_hoursnumberNoBilled or flat-rate hours
jobs[].actual_hoursnumberNoClocked hours
jobs[].labor_amountnumberNo
jobs[].parts_amountnumberNo
jobs[].total_amountnumberNo
jobs[].completed_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
jobs[].laborsDmsRepairorderLabor[]No
jobs[].labors[].idstringNoLine identifier
jobs[].labors[].opcode_idstringNoThe DmsOpcode ID
jobs[].labors[].namestringNoOperation description
jobs[].labors[].pay_typeenumNoValues: CUSTOMER, WARRANTY, INTERNAL, SERVICE_CONTRACT, OTHER
jobs[].labors[].technician_user_idsstring[]NoTechnicians, as HR Employees (reference to HrisEmployee)
jobs[].labors[].sold_hoursnumberNoBilled or flat-rate hours
jobs[].labors[].actual_hoursnumberNoClocked hours
jobs[].labors[].rate_amountnumberNoHourly labor rate
jobs[].labors[].total_amountnumberNoLabor sale amount
jobs[].partsDmsPartline[]No
jobs[].parts[].idstringNoLine identifier
jobs[].parts[].part_idstringNoThe DmsPart ID
jobs[].parts[].part_numberstringNoPart number as sold
jobs[].parts[].manufacturer_codestringNoMake, brand or line code the part number belongs to
jobs[].parts[].descriptionstringNo
jobs[].parts[].pay_typeenumNoWho pays for this line Values: CUSTOMER, WARRANTY, INTERNAL, SERVICE_CONTRACT, OTHER
jobs[].parts[].quantitynumberNoQuantity sold or issued
jobs[].parts[].quantity_orderednumberNoQuantity requested by the customer
jobs[].parts[].unit_price_amountnumberNoUnit selling price
jobs[].parts[].list_price_amountnumberNoUnit list or retail price
jobs[].parts[].unit_cost_amountnumberNoUnit dealer cost
jobs[].parts[].total_amountnumberNoExtended selling amount
jobs[].parts[].total_cost_amountnumberNoExtended dealer cost
jobs[].parts[].tax_amountnumberNo
metadataDmsMetadata[]No
metadata[].idstringNoThe ID of the custom field definition (from the metadata/metadata endpoint).
metadata[].slugstringNoThe integration's API name (key) of an existing custom field.
metadata[].valueobjectNoThe field's value, typed by format.
metadata[].namespacestringNo
metadata[].formatenumNoThe 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_dataobjectNo

Errors

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

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot 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.
const options = {
  method: 'GET',
  url: 'https://api.unified.to/dms/5de520f96e439b002043d8dc/repairorder/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?