---
title: "Update a carrier"
method: PATCH
path: "/carriers/{id}"
tags: ["Carriers"]
---

# Update a carrier

`PATCH /carriers/{id}`

Partially update a carrier. Only provided fields will be updated.

- **Omitted fields**: Not modified (current value preserved)
- **Provided fields**: Updated to the new value
- **Null values**: Clear the field (set to null) where applicable

The carrier type determines which fields can be updated:
- **TRUCKLOAD**: Can update insurance, safety rating, and FMCSA fields
- **AIR, CARTAGE, LINEHAUL, LTL, OCEAN, RAIL**: Can only update base carrier fields

Changing the carrier type will affect which specialized fields are available.

## Path parameters

- `id` string, required

## Request body

- union
  - TruckloadCarrierPatch — Partial update for truckload carrier
    - `name` string — Carrier legal name
    - `type` 'TRUCKLOAD' — Carrier type discriminator (optional - only needed if changing type)
    - `dbaName` string, nullable — Doing Business As name
    - `key` string, nullable — Client-defined reference identifier
    - `email` string, email, nullable — Primary email address
    - `phone` string, nullable — Primary phone number
    - `website` string, nullable — Company website URL
    - `status` string — Carrier status
    - `statusReason` string, nullable — Reason for current status
    - `notes` string, nullable — Internal notes about the carrier
    - `corporateAddress` AddressPatch — Partial address update. All fields are optional. - **Omitted fields**: Not modified (current value preserved) - **Provided fields**: Updated to the new value - **Null values**: Clear the field (set to null) where applicable
      - `line1` string — Primary street address line
      - `line2` string, nullable — Secondary address line
      - `city` string — City name
      - `country` string — Country name or code
      - `market` string — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record
    - `billingAddress` AddressPatch — Partial address update. All fields are optional. - **Omitted fields**: Not modified (current value preserved) - **Provided fields**: Updated to the new value - **Null values**: Clear the field (set to null) where applicable
      - `line1` string — Primary street address line
      - `line2` string, nullable — Secondary address line
      - `city` string — City name
      - `country` string — Country name or code
      - `market` string — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record
    - `mcNumber` string, nullable — Motor Carrier (MC) number
    - `dotNumber` string, nullable — Department of Transportation (DOT) number
    - `scac` string, nullable — Standard Carrier Alpha Code
    - `einNumber` string, nullable — Employer Identification Number
    - `ffNumber` string, nullable — Freight Forwarder (FF) number
    - `mxNumber` string, nullable — Mexico carrier registration number
    - `rfcNumber` string, nullable — RFC (Mexico tax ID) number
    - `iataCode` string, nullable — International Air Transport Association code
    - `equipments` CarrierEquipment[] — Equipment types this carrier operates
    - `isHazmat` boolean, nullable — Whether carrier is certified to transport hazardous materials
    - `tsaApproved` boolean, nullable — Whether carrier is TSA approved
    - `trucks` integer, nullable — Number of trucks in fleet
    - `trailers` integer, nullable — Number of trailers in fleet
    - `drivers` integer, nullable — Number of drivers employed
    - `powerUnits` integer, nullable — Number of power units
    - `currency` 'ARS' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'IDR' | 'INR' | 'JPY' | 'KRW' | 'MXN' | 'RUB' | 'SAR' | 'TRY' | 'USD' | 'ZAR' — Currency code (ISO 4217)
    - `paymentTermId` string, uuid, nullable — Payment term ID
    - `isFactoringPreferred` boolean, nullable — Whether carrier prefers factoring for payment
    - `goldenCarrierId` string, uuid, nullable — Reference to golden carrier record (for deduplication)
    - `insuranceCompany` string, nullable — Insurance company name
    - `insuranceAgent` string, nullable — Insurance agent name
    - `insuranceAgentPhone` string, nullable — Insurance agent phone number
    - `insuranceAuthorityDate` string, date-time, nullable — Date insurance authority was granted
    - `insuranceExpirationDate` string, date-time, nullable — Insurance policy expiration date
    - `insuranceAutoLiabilityLimit` number, float, nullable — Auto liability insurance limit (in dollars)
    - `insuranceCargoLiabilityLimit` number, float, nullable — Cargo liability insurance limit (in dollars)
    - `insuranceGeneralLiabilityLimit` number, float, nullable — General liability insurance limit (in dollars)
    - `rating` string, nullable — Carrier safety rating
    - `ratingDate` string, date, nullable — Date of last safety rating
    - `reviewType` string, nullable — Type of safety review conducted
    - `reviewDate` string, date, nullable — Date of last safety review
    - `operatingAbility` string, nullable — FMCSA operating authority status
    - `inFmcsa` boolean, nullable — Whether carrier is registered in FMCSA database
    - `usDriverInspections` integer, nullable — Total number of US driver inspections
    - `usDriverInspectionsOos` integer, nullable — Number of US driver inspections resulting in out-of-service
    - `usDriverInspectionsOosPct` number, float, nullable — Percentage of US driver inspections resulting in out-of-service
    - `usVehicleInspections` integer, nullable — Total number of US vehicle inspections
    - `usVehicleInspectionsOos` integer, nullable — Number of US vehicle inspections resulting in out-of-service
    - `usVehicleInspectionsOosPct` number, float, nullable — Percentage of US vehicle inspections resulting in out-of-service
  - AirCarrierPatch — Partial update for air carrier
    - `name` string — Carrier legal name
    - `type` 'AIR' — Carrier type discriminator (optional - only needed if changing type)
    - `dbaName` string, nullable — Doing Business As name
    - `key` string, nullable — Client-defined reference identifier
    - `email` string, email, nullable — Primary email address
    - `phone` string, nullable — Primary phone number
    - `website` string, nullable — Company website URL
    - `status` string — Carrier status
    - `statusReason` string, nullable — Reason for current status
    - `notes` string, nullable — Internal notes about the carrier
    - `corporateAddress` AddressPatch — Partial address update. All fields are optional. - **Omitted fields**: Not modified (current value preserved) - **Provided fields**: Updated to the new value - **Null values**: Clear the field (set to null) where applicable
      - `line1` string — Primary street address line
      - `line2` string, nullable — Secondary address line
      - `city` string — City name
      - `country` string — Country name or code
      - `market` string — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record
    - `billingAddress` AddressPatch — Partial address update. All fields are optional. - **Omitted fields**: Not modified (current value preserved) - **Provided fields**: Updated to the new value - **Null values**: Clear the field (set to null) where applicable
      - `line1` string — Primary street address line
      - `line2` string, nullable — Secondary address line
      - `city` string — City name
      - `country` string — Country name or code
      - `market` string — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record
    - `mcNumber` string, nullable — Motor Carrier (MC) number
    - `dotNumber` string, nullable — Department of Transportation (DOT) number
    - `scac` string, nullable — Standard Carrier Alpha Code
    - `einNumber` string, nullable — Employer Identification Number
    - `ffNumber` string, nullable — Freight Forwarder (FF) number
    - `mxNumber` string, nullable — Mexico carrier registration number
    - `rfcNumber` string, nullable — RFC (Mexico tax ID) number
    - `iataCode` string, nullable — International Air Transport Association code
    - `equipments` CarrierEquipment[] — Equipment types this carrier operates
    - `isHazmat` boolean, nullable — Whether carrier is certified to transport hazardous materials
    - `tsaApproved` boolean, nullable — Whether carrier is TSA approved
    - `trucks` integer, nullable — Number of trucks in fleet
    - `trailers` integer, nullable — Number of trailers in fleet
    - `drivers` integer, nullable — Number of drivers employed
    - `powerUnits` integer, nullable — Number of power units
    - `currency` 'ARS' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'IDR' | 'INR' | 'JPY' | 'KRW' | 'MXN' | 'RUB' | 'SAR' | 'TRY' | 'USD' | 'ZAR' — Currency code (ISO 4217)
    - `paymentTermId` string, uuid, nullable — Payment term ID
    - `isFactoringPreferred` boolean, nullable — Whether carrier prefers factoring for payment
    - `goldenCarrierId` string, uuid, nullable — Reference to golden carrier record (for deduplication)
  - CartageCarrierPatch — Partial update for cartage carrier
    - `name` string — Carrier legal name
    - `type` 'CARTAGE' — Carrier type discriminator (optional - only needed if changing type)
    - `dbaName` string, nullable — Doing Business As name
    - `key` string, nullable — Client-defined reference identifier
    - `email` string, email, nullable — Primary email address
    - `phone` string, nullable — Primary phone number
    - `website` string, nullable — Company website URL
    - `status` string — Carrier status
    - `statusReason` string, nullable — Reason for current status
    - `notes` string, nullable — Internal notes about the carrier
    - `corporateAddress` AddressPatch — Partial address update. All fields are optional. - **Omitted fields**: Not modified (current value preserved) - **Provided fields**: Updated to the new value - **Null values**: Clear the field (set to null) where applicable
      - `line1` string — Primary street address line
      - `line2` string, nullable — Secondary address line
      - `city` string — City name
      - `country` string — Country name or code
      - `market` string — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record
    - `billingAddress` AddressPatch — Partial address update. All fields are optional. - **Omitted fields**: Not modified (current value preserved) - **Provided fields**: Updated to the new value - **Null values**: Clear the field (set to null) where applicable
      - `line1` string — Primary street address line
      - `line2` string, nullable — Secondary address line
      - `city` string — City name
      - `country` string — Country name or code
      - `market` string — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record
    - `mcNumber` string, nullable — Motor Carrier (MC) number
    - `dotNumber` string, nullable — Department of Transportation (DOT) number
    - `scac` string, nullable — Standard Carrier Alpha Code
    - `einNumber` string, nullable — Employer Identification Number
    - `ffNumber` string, nullable — Freight Forwarder (FF) number
    - `mxNumber` string, nullable — Mexico carrier registration number
    - `rfcNumber` string, nullable — RFC (Mexico tax ID) number
    - `iataCode` string, nullable — International Air Transport Association code
    - `equipments` CarrierEquipment[] — Equipment types this carrier operates
    - `isHazmat` boolean, nullable — Whether carrier is certified to transport hazardous materials
    - `tsaApproved` boolean, nullable — Whether carrier is TSA approved
    - `trucks` integer, nullable — Number of trucks in fleet
    - `trailers` integer, nullable — Number of trailers in fleet
    - `drivers` integer, nullable — Number of drivers employed
    - `powerUnits` integer, nullable — Number of power units
    - `currency` 'ARS' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'IDR' | 'INR' | 'JPY' | 'KRW' | 'MXN' | 'RUB' | 'SAR' | 'TRY' | 'USD' | 'ZAR' — Currency code (ISO 4217)
    - `paymentTermId` string, uuid, nullable — Payment term ID
    - `isFactoringPreferred` boolean, nullable — Whether carrier prefers factoring for payment
    - `goldenCarrierId` string, uuid, nullable — Reference to golden carrier record (for deduplication)
  - LinehaulCarrierPatch — Partial update for linehaul carrier
    - `name` string — Carrier legal name
    - `type` 'LINEHAUL' — Carrier type discriminator (optional - only needed if changing type)
    - `dbaName` string, nullable — Doing Business As name
    - `key` string, nullable — Client-defined reference identifier
    - `email` string, email, nullable — Primary email address
    - `phone` string, nullable — Primary phone number
    - `website` string, nullable — Company website URL
    - `status` string — Carrier status
    - `statusReason` string, nullable — Reason for current status
    - `notes` string, nullable — Internal notes about the carrier
    - `corporateAddress` AddressPatch — Partial address update. All fields are optional. - **Omitted fields**: Not modified (current value preserved) - **Provided fields**: Updated to the new value - **Null values**: Clear the field (set to null) where applicable
      - `line1` string — Primary street address line
      - `line2` string, nullable — Secondary address line
      - `city` string — City name
      - `country` string — Country name or code
      - `market` string — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record
    - `billingAddress` AddressPatch — Partial address update. All fields are optional. - **Omitted fields**: Not modified (current value preserved) - **Provided fields**: Updated to the new value - **Null values**: Clear the field (set to null) where applicable
      - `line1` string — Primary street address line
      - `line2` string, nullable — Secondary address line
      - `city` string — City name
      - `country` string — Country name or code
      - `market` string — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record
    - `mcNumber` string, nullable — Motor Carrier (MC) number
    - `dotNumber` string, nullable — Department of Transportation (DOT) number
    - `scac` string, nullable — Standard Carrier Alpha Code
    - `einNumber` string, nullable — Employer Identification Number
    - `ffNumber` string, nullable — Freight Forwarder (FF) number
    - `mxNumber` string, nullable — Mexico carrier registration number
    - `rfcNumber` string, nullable — RFC (Mexico tax ID) number
    - `iataCode` string, nullable — International Air Transport Association code
    - `equipments` CarrierEquipment[] — Equipment types this carrier operates
    - `isHazmat` boolean, nullable — Whether carrier is certified to transport hazardous materials
    - `tsaApproved` boolean, nullable — Whether carrier is TSA approved
    - `trucks` integer, nullable — Number of trucks in fleet
    - `trailers` integer, nullable — Number of trailers in fleet
    - `drivers` integer, nullable — Number of drivers employed
    - `powerUnits` integer, nullable — Number of power units
    - `currency` 'ARS' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'IDR' | 'INR' | 'JPY' | 'KRW' | 'MXN' | 'RUB' | 'SAR' | 'TRY' | 'USD' | 'ZAR' — Currency code (ISO 4217)
    - `paymentTermId` string, uuid, nullable — Payment term ID
    - `isFactoringPreferred` boolean, nullable — Whether carrier prefers factoring for payment
    - `goldenCarrierId` string, uuid, nullable — Reference to golden carrier record (for deduplication)
  - LtlCarrierPatch — Partial update for LTL carrier
    - `name` string — Carrier legal name
    - `type` 'LTL' — Carrier type discriminator (optional - only needed if changing type)
    - `dbaName` string, nullable — Doing Business As name
    - `key` string, nullable — Client-defined reference identifier
    - `email` string, email, nullable — Primary email address
    - `phone` string, nullable — Primary phone number
    - `website` string, nullable — Company website URL
    - `status` string — Carrier status
    - `statusReason` string, nullable — Reason for current status
    - `notes` string, nullable — Internal notes about the carrier
    - `corporateAddress` AddressPatch — Partial address update. All fields are optional. - **Omitted fields**: Not modified (current value preserved) - **Provided fields**: Updated to the new value - **Null values**: Clear the field (set to null) where applicable
      - `line1` string — Primary street address line
      - `line2` string, nullable — Secondary address line
      - `city` string — City name
      - `country` string — Country name or code
      - `market` string — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record
    - `billingAddress` AddressPatch — Partial address update. All fields are optional. - **Omitted fields**: Not modified (current value preserved) - **Provided fields**: Updated to the new value - **Null values**: Clear the field (set to null) where applicable
      - `line1` string — Primary street address line
      - `line2` string, nullable — Secondary address line
      - `city` string — City name
      - `country` string — Country name or code
      - `market` string — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record
    - `mcNumber` string, nullable — Motor Carrier (MC) number
    - `dotNumber` string, nullable — Department of Transportation (DOT) number
    - `scac` string, nullable — Standard Carrier Alpha Code
    - `einNumber` string, nullable — Employer Identification Number
    - `ffNumber` string, nullable — Freight Forwarder (FF) number
    - `mxNumber` string, nullable — Mexico carrier registration number
    - `rfcNumber` string, nullable — RFC (Mexico tax ID) number
    - `iataCode` string, nullable — International Air Transport Association code
    - `equipments` CarrierEquipment[] — Equipment types this carrier operates
    - `isHazmat` boolean, nullable — Whether carrier is certified to transport hazardous materials
    - `tsaApproved` boolean, nullable — Whether carrier is TSA approved
    - `trucks` integer, nullable — Number of trucks in fleet
    - `trailers` integer, nullable — Number of trailers in fleet
    - `drivers` integer, nullable — Number of drivers employed
    - `powerUnits` integer, nullable — Number of power units
    - `currency` 'ARS' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'IDR' | 'INR' | 'JPY' | 'KRW' | 'MXN' | 'RUB' | 'SAR' | 'TRY' | 'USD' | 'ZAR' — Currency code (ISO 4217)
    - `paymentTermId` string, uuid, nullable — Payment term ID
    - `isFactoringPreferred` boolean, nullable — Whether carrier prefers factoring for payment
    - `goldenCarrierId` string, uuid, nullable — Reference to golden carrier record (for deduplication)
  - OceanCarrierPatch — Partial update for ocean carrier
    - `name` string — Carrier legal name
    - `type` 'OCEAN' — Carrier type discriminator (optional - only needed if changing type)
    - `dbaName` string, nullable — Doing Business As name
    - `key` string, nullable — Client-defined reference identifier
    - `email` string, email, nullable — Primary email address
    - `phone` string, nullable — Primary phone number
    - `website` string, nullable — Company website URL
    - `status` string — Carrier status
    - `statusReason` string, nullable — Reason for current status
    - `notes` string, nullable — Internal notes about the carrier
    - `corporateAddress` AddressPatch — Partial address update. All fields are optional. - **Omitted fields**: Not modified (current value preserved) - **Provided fields**: Updated to the new value - **Null values**: Clear the field (set to null) where applicable
      - `line1` string — Primary street address line
      - `line2` string, nullable — Secondary address line
      - `city` string — City name
      - `country` string — Country name or code
      - `market` string — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record
    - `billingAddress` AddressPatch — Partial address update. All fields are optional. - **Omitted fields**: Not modified (current value preserved) - **Provided fields**: Updated to the new value - **Null values**: Clear the field (set to null) where applicable
      - `line1` string — Primary street address line
      - `line2` string, nullable — Secondary address line
      - `city` string — City name
      - `country` string — Country name or code
      - `market` string — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record
    - `mcNumber` string, nullable — Motor Carrier (MC) number
    - `dotNumber` string, nullable — Department of Transportation (DOT) number
    - `scac` string, nullable — Standard Carrier Alpha Code
    - `einNumber` string, nullable — Employer Identification Number
    - `ffNumber` string, nullable — Freight Forwarder (FF) number
    - `mxNumber` string, nullable — Mexico carrier registration number
    - `rfcNumber` string, nullable — RFC (Mexico tax ID) number
    - `iataCode` string, nullable — International Air Transport Association code
    - `equipments` CarrierEquipment[] — Equipment types this carrier operates
    - `isHazmat` boolean, nullable — Whether carrier is certified to transport hazardous materials
    - `tsaApproved` boolean, nullable — Whether carrier is TSA approved
    - `trucks` integer, nullable — Number of trucks in fleet
    - `trailers` integer, nullable — Number of trailers in fleet
    - `drivers` integer, nullable — Number of drivers employed
    - `powerUnits` integer, nullable — Number of power units
    - `currency` 'ARS' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'IDR' | 'INR' | 'JPY' | 'KRW' | 'MXN' | 'RUB' | 'SAR' | 'TRY' | 'USD' | 'ZAR' — Currency code (ISO 4217)
    - `paymentTermId` string, uuid, nullable — Payment term ID
    - `isFactoringPreferred` boolean, nullable — Whether carrier prefers factoring for payment
    - `goldenCarrierId` string, uuid, nullable — Reference to golden carrier record (for deduplication)
  - RailCarrierPatch — Partial update for rail carrier
    - `name` string — Carrier legal name
    - `type` 'RAIL' — Carrier type discriminator (optional - only needed if changing type)
    - `dbaName` string, nullable — Doing Business As name
    - `key` string, nullable — Client-defined reference identifier
    - `email` string, email, nullable — Primary email address
    - `phone` string, nullable — Primary phone number
    - `website` string, nullable — Company website URL
    - `status` string — Carrier status
    - `statusReason` string, nullable — Reason for current status
    - `notes` string, nullable — Internal notes about the carrier
    - `corporateAddress` AddressPatch — Partial address update. All fields are optional. - **Omitted fields**: Not modified (current value preserved) - **Provided fields**: Updated to the new value - **Null values**: Clear the field (set to null) where applicable
      - `line1` string — Primary street address line
      - `line2` string, nullable — Secondary address line
      - `city` string — City name
      - `country` string — Country name or code
      - `market` string — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record
    - `billingAddress` AddressPatch — Partial address update. All fields are optional. - **Omitted fields**: Not modified (current value preserved) - **Provided fields**: Updated to the new value - **Null values**: Clear the field (set to null) where applicable
      - `line1` string — Primary street address line
      - `line2` string, nullable — Secondary address line
      - `city` string — City name
      - `country` string — Country name or code
      - `market` string — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record
    - `mcNumber` string, nullable — Motor Carrier (MC) number
    - `dotNumber` string, nullable — Department of Transportation (DOT) number
    - `scac` string, nullable — Standard Carrier Alpha Code
    - `einNumber` string, nullable — Employer Identification Number
    - `ffNumber` string, nullable — Freight Forwarder (FF) number
    - `mxNumber` string, nullable — Mexico carrier registration number
    - `rfcNumber` string, nullable — RFC (Mexico tax ID) number
    - `iataCode` string, nullable — International Air Transport Association code
    - `equipments` CarrierEquipment[] — Equipment types this carrier operates
    - `isHazmat` boolean, nullable — Whether carrier is certified to transport hazardous materials
    - `tsaApproved` boolean, nullable — Whether carrier is TSA approved
    - `trucks` integer, nullable — Number of trucks in fleet
    - `trailers` integer, nullable — Number of trailers in fleet
    - `drivers` integer, nullable — Number of drivers employed
    - `powerUnits` integer, nullable — Number of power units
    - `currency` 'ARS' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'IDR' | 'INR' | 'JPY' | 'KRW' | 'MXN' | 'RUB' | 'SAR' | 'TRY' | 'USD' | 'ZAR' — Currency code (ISO 4217)
    - `paymentTermId` string, uuid, nullable — Payment term ID
    - `isFactoringPreferred` boolean, nullable — Whether carrier prefers factoring for payment
    - `goldenCarrierId` string, uuid, nullable — Reference to golden carrier record (for deduplication)

## Response `200`

Carrier updated successfully

- union
  - TruckloadCarrier — Truckload carrier with insurance, safety rating, and FMCSA data
    - `object` 'CARRIER' — Object type identifier
    - `id` string, uuid, required — Unique carrier identifier
    - `friendlyId` string, required — Human-readable carrier identifier
    - `type` 'TRUCKLOAD', required — Carrier type discriminator
    - `name` string, required — Carrier legal name
    - `dbaName` string, nullable — Doing Business As name
    - `key` string, nullable — Client-defined reference identifier
    - `email` string, email, nullable — Primary email address
    - `phone` string, nullable — Primary phone number
    - `website` string, nullable — Company website URL
    - `status` string, required — Carrier status
    - `statusReason` string, nullable — Reason for current status
    - `notes` string, nullable — Internal notes about the carrier
    - `corporateAddress` Address — Physical address/location details (nested, without id). This is an embedded object representing a Location record. The id is managed internally and not exposed in the API.
      - `line1` string, required — Primary street address line
      - `line2` string, nullable — Secondary address line (suite, floor, etc.)
      - `city` string, required — City name
      - `country` string, required — Country name or code
      - `market` string, required — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean, required — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean, required — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean, required — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean, required — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record (internal use)
    - `billingAddress` Address — Physical address/location details (nested, without id). This is an embedded object representing a Location record. The id is managed internally and not exposed in the API.
      - `line1` string, required — Primary street address line
      - `line2` string, nullable — Secondary address line (suite, floor, etc.)
      - `city` string, required — City name
      - `country` string, required — Country name or code
      - `market` string, required — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean, required — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean, required — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean, required — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean, required — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record (internal use)
    - `mcNumber` string, nullable — Motor Carrier (MC) number
    - `dotNumber` string, nullable — Department of Transportation (DOT) number
    - `scac` string, nullable — Standard Carrier Alpha Code
    - `einNumber` string, nullable — Employer Identification Number
    - `ffNumber` string, nullable — Freight Forwarder (FF) number
    - `mxNumber` string, nullable — Mexico carrier registration number
    - `rfcNumber` string, nullable — RFC (Mexico tax ID) number
    - `iataCode` string, nullable — International Air Transport Association code
    - `equipments` CarrierEquipment[] — Equipment types this carrier operates
    - `isHazmat` boolean, nullable — Whether carrier is certified to transport hazardous materials
    - `tsaApproved` boolean, nullable — Whether carrier is TSA approved
    - `trucks` integer, nullable — Number of trucks in fleet
    - `trailers` integer, nullable — Number of trailers in fleet
    - `drivers` integer, nullable — Number of drivers employed
    - `powerUnits` integer, nullable — Number of power units
    - `currency` 'ARS' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'IDR' | 'INR' | 'JPY' | 'KRW' | 'MXN' | 'RUB' | 'SAR' | 'TRY' | 'USD' | 'ZAR' — Currency code (ISO 4217)
    - `paymentTerm` PaymentTermReference — Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.
      - `id` string, uuid, required — Payment term UUID
      - `key` string, nullable — Client-defined reference ID if set
      - `name` string, required — Payment term name
      - `description` string, nullable — Payment term description or notes
      - `days` integer, nullable — Number of days until payment is due
      - `quickPayFee` number, float, nullable — Quick pay fee percentage (e.g., 0.05 for 5%)
      - `apOnly` boolean, nullable — Whether this payment term is for accounts payable only
      - `doNotUse` boolean, nullable — Flag to prevent using this payment term for new transactions
      - `createdAt` string, date-time, required — When the payment term was created
      - `updatedAt` string, date-time, required — When the payment term was last updated
      - `deletedAt` string, date-time, nullable — When the payment term was soft deleted (null if active)
    - `isFactoringPreferred` boolean, nullable — Whether carrier prefers factoring for payment
    - `goldenCarrierId` string, uuid, nullable — Reference to golden carrier record (for deduplication)
    - `paymentMethods` CarrierPaymentMethodReference[] — Payment methods configured for this carrier
      - `id` string, uuid, required — Unique carrier payment method identifier
      - `key` string, nullable — Client-defined reference identifier
      - `paymentRecipientType` 'DIRECT' | 'FACTOR', required — Who receives the payment. - `DIRECT`: Payment goes directly to the carrier - `FACTOR`: Payment goes to a factoring company (requires carrierFactorId)
      - `paymentMethodType` 'ACH_WIRE' | 'ZELLE' | 'VENMO' | 'ACH' | 'CHECK' | 'WIRE' | 'CAD_EFT' | 'TRIUMPH_PAY' | 'COMCHECK' | 'EFS' | 'ECHECK', required — Payment method type
      - `status` string, nullable — Payment method status
      - `isPreferred` boolean, nullable — Whether this is the preferred payment method
      - `email` string, email, nullable — Email address for payment notifications
      - `phone` string, nullable — Phone number for payment contact
      - `companyName` string, nullable — Company name for this payment method
      - `username` string, nullable — Username for payment platforms
      - `bankName` string, nullable — Bank name
      - `bankAddress` string, nullable — Bank address
      - `accountName` string, nullable — Bank account holder name
      - `accountNumber` string, nullable — Bank account number (masked in responses)
      - `abaAch` string, nullable — ABA/ACH routing number
      - `wire` string, nullable — Wire transfer routing number
      - `swiftCode` string, nullable — SWIFT/BIC code
      - `eftInstitution` string, nullable — EFT institution number (Canadian banking)
      - `eftTransit` string, nullable — EFT transit number (Canadian banking)
      - `clabe` string, nullable — CLABE number (Mexican banking)
      - `currency` string, nullable — Preferred currency code
      - `carrierFactor` CarrierFactorReference — Enhanced reference to a carrier factor (factoring company). Includes full carrier factor details in addition to id/key.
        - `id` string, uuid, required — Carrier factor UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `companyName` string, required — Factoring company legal name
        - `email` string, email, nullable — Primary email address
        - `phoneNumber` string, nullable — Primary phone number
        - `currency` string, nullable — Preferred currency code (ISO 4217)
        - `createdAt` string, date-time, required — When the carrier factor was created
        - `updatedAt` string, date-time, required — When the carrier factor was last updated
      - `paymentTerm` PaymentTermReference — Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.
        - `id` string, uuid, required — Payment term UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `name` string, required — Payment term name
        - `description` string, nullable — Payment term description or notes
        - `days` integer, nullable — Number of days until payment is due
        - `quickPayFee` number, float, nullable — Quick pay fee percentage (e.g., 0.05 for 5%)
        - `apOnly` boolean, nullable — Whether this payment term is for accounts payable only
        - `doNotUse` boolean, nullable — Flag to prevent using this payment term for new transactions
        - `createdAt` string, date-time, required — When the payment term was created
        - `updatedAt` string, date-time, required — When the payment term was last updated
        - `deletedAt` string, date-time, nullable — When the payment term was soft deleted (null if active)
      - `createdAt` string, date-time, required — When the payment method was created
      - `updatedAt` string, date-time, required — When the payment method was last updated
      - `deletedAt` string, date-time, nullable — When the payment method was soft deleted
      - `deletedBy` UserReference — Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key. Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
        - `id` string, uuid, required — User UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `email` string, email, required — User's email address
        - `name` string, nullable — User's full name
        - `phone` string, nullable — User's phone number
        - `phoneExt` string, nullable — Phone extension
        - `status` 'PENDING' | 'ACTIVE' | 'INACTIVE', required — User account status
        - `avatarId` string, uuid, nullable — Profile avatar document ID
        - `createdAt` string, date-time, required — When the user was created
        - `updatedAt` string, date-time, required — When the user was last updated
        - `deletedAt` string, date-time, nullable — When the user was soft deleted (null if active)
    - `contacts` CarrierContactReference[] — Contacts for this carrier
      - `object` 'CARRIER_CONTACT' — Object type identifier
      - `id` string, uuid, required — Unique contact identifier
      - `key` string, nullable — Client-defined reference identifier
      - `name` string, required — Contact person's name
      - `contactInfo` ContactInfo, required — Contact information details (nested, without id). This is an embedded object representing a Contact record. The id is managed internally and not exposed in the API.
        - `name` string, required — Contact person's full name
        - `email` string, email, nullable — Email address
        - `phoneNumber` string, nullable — Phone number
        - `title` string, nullable — Job title or position
      - `contactTypes` CarrierContactType[], nullable — Types/roles this contact serves
      - `invitedUser` UserReference — Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key. Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
        - `id` string, uuid, required — User UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `email` string, email, required — User's email address
        - `name` string, nullable — User's full name
        - `phone` string, nullable — User's phone number
        - `phoneExt` string, nullable — Phone extension
        - `status` 'PENDING' | 'ACTIVE' | 'INACTIVE', required — User account status
        - `avatarId` string, uuid, nullable — Profile avatar document ID
        - `createdAt` string, date-time, required — When the user was created
        - `updatedAt` string, date-time, required — When the user was last updated
        - `deletedAt` string, date-time, nullable — When the user was soft deleted (null if active)
      - `deletedBy` UserReference — Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key. Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
        - `id` string, uuid, required — User UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `email` string, email, required — User's email address
        - `name` string, nullable — User's full name
        - `phone` string, nullable — User's phone number
        - `phoneExt` string, nullable — Phone extension
        - `status` 'PENDING' | 'ACTIVE' | 'INACTIVE', required — User account status
        - `avatarId` string, uuid, nullable — Profile avatar document ID
        - `createdAt` string, date-time, required — When the user was created
        - `updatedAt` string, date-time, required — When the user was last updated
        - `deletedAt` string, date-time, nullable — When the user was soft deleted (null if active)
      - `createdAt` string, date-time, required — When the contact was created
      - `deletedAt` string, date-time, nullable — When the contact was soft deleted
    - `createdAt` string, date-time, required — When the carrier was created
    - `updatedAt` string, date-time, required — When the carrier was last updated
    - `deletedAt` string, date-time, nullable — When the carrier was soft deleted (null if active)
    - `insuranceCompany` string, nullable — Insurance company name
    - `insuranceAgent` string, nullable — Insurance agent name
    - `insuranceAgentPhone` string, nullable — Insurance agent phone number
    - `insuranceAuthorityDate` string, date-time, nullable — Date insurance authority was granted
    - `insuranceExpirationDate` string, date-time, nullable — Insurance policy expiration date
    - `insuranceAutoLiabilityLimit` number, float, nullable — Auto liability insurance limit (in dollars)
    - `insuranceCargoLiabilityLimit` number, float, nullable — Cargo liability insurance limit (in dollars)
    - `insuranceGeneralLiabilityLimit` number, float, nullable — General liability insurance limit (in dollars)
    - `rating` string, nullable — Carrier safety rating
    - `ratingDate` string, date, nullable — Date of last safety rating
    - `reviewType` string, nullable — Type of safety review conducted
    - `reviewDate` string, date, nullable — Date of last safety review
    - `operatingAbility` string, nullable — FMCSA operating authority status
    - `inFmcsa` boolean, nullable — Whether carrier is registered in FMCSA database
    - `usDriverInspections` integer, nullable — Total number of US driver inspections
    - `usDriverInspectionsOos` integer, nullable — Number of US driver inspections resulting in out-of-service
    - `usDriverInspectionsOosPct` number, float, nullable — Percentage of US driver inspections resulting in out-of-service
    - `usVehicleInspections` integer, nullable — Total number of US vehicle inspections
    - `usVehicleInspectionsOos` integer, nullable — Number of US vehicle inspections resulting in out-of-service
    - `usVehicleInspectionsOosPct` number, float, nullable — Percentage of US vehicle inspections resulting in out-of-service
  - AirCarrier — Air cargo carrier
    - `object` 'CARRIER' — Object type identifier
    - `id` string, uuid, required — Unique carrier identifier
    - `friendlyId` string, required — Human-readable carrier identifier
    - `type` 'AIR', required — Carrier type discriminator
    - `name` string, required — Carrier legal name
    - `dbaName` string, nullable — Doing Business As name
    - `key` string, nullable — Client-defined reference identifier
    - `email` string, email, nullable — Primary email address
    - `phone` string, nullable — Primary phone number
    - `website` string, nullable — Company website URL
    - `status` string, required — Carrier status
    - `statusReason` string, nullable — Reason for current status
    - `notes` string, nullable — Internal notes about the carrier
    - `corporateAddress` Address — Physical address/location details (nested, without id). This is an embedded object representing a Location record. The id is managed internally and not exposed in the API.
      - `line1` string, required — Primary street address line
      - `line2` string, nullable — Secondary address line (suite, floor, etc.)
      - `city` string, required — City name
      - `country` string, required — Country name or code
      - `market` string, required — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean, required — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean, required — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean, required — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean, required — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record (internal use)
    - `billingAddress` Address — Physical address/location details (nested, without id). This is an embedded object representing a Location record. The id is managed internally and not exposed in the API.
      - `line1` string, required — Primary street address line
      - `line2` string, nullable — Secondary address line (suite, floor, etc.)
      - `city` string, required — City name
      - `country` string, required — Country name or code
      - `market` string, required — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean, required — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean, required — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean, required — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean, required — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record (internal use)
    - `mcNumber` string, nullable — Motor Carrier (MC) number
    - `dotNumber` string, nullable — Department of Transportation (DOT) number
    - `scac` string, nullable — Standard Carrier Alpha Code
    - `einNumber` string, nullable — Employer Identification Number
    - `ffNumber` string, nullable — Freight Forwarder (FF) number
    - `mxNumber` string, nullable — Mexico carrier registration number
    - `rfcNumber` string, nullable — RFC (Mexico tax ID) number
    - `iataCode` string, nullable — International Air Transport Association code
    - `equipments` CarrierEquipment[] — Equipment types this carrier operates
    - `isHazmat` boolean, nullable — Whether carrier is certified to transport hazardous materials
    - `tsaApproved` boolean, nullable — Whether carrier is TSA approved
    - `trucks` integer, nullable — Number of trucks in fleet
    - `trailers` integer, nullable — Number of trailers in fleet
    - `drivers` integer, nullable — Number of drivers employed
    - `powerUnits` integer, nullable — Number of power units
    - `currency` 'ARS' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'IDR' | 'INR' | 'JPY' | 'KRW' | 'MXN' | 'RUB' | 'SAR' | 'TRY' | 'USD' | 'ZAR' — Currency code (ISO 4217)
    - `paymentTerm` PaymentTermReference — Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.
      - `id` string, uuid, required — Payment term UUID
      - `key` string, nullable — Client-defined reference ID if set
      - `name` string, required — Payment term name
      - `description` string, nullable — Payment term description or notes
      - `days` integer, nullable — Number of days until payment is due
      - `quickPayFee` number, float, nullable — Quick pay fee percentage (e.g., 0.05 for 5%)
      - `apOnly` boolean, nullable — Whether this payment term is for accounts payable only
      - `doNotUse` boolean, nullable — Flag to prevent using this payment term for new transactions
      - `createdAt` string, date-time, required — When the payment term was created
      - `updatedAt` string, date-time, required — When the payment term was last updated
      - `deletedAt` string, date-time, nullable — When the payment term was soft deleted (null if active)
    - `isFactoringPreferred` boolean, nullable — Whether carrier prefers factoring for payment
    - `goldenCarrierId` string, uuid, nullable — Reference to golden carrier record (for deduplication)
    - `paymentMethods` CarrierPaymentMethodReference[] — Payment methods configured for this carrier
      - `id` string, uuid, required — Unique carrier payment method identifier
      - `key` string, nullable — Client-defined reference identifier
      - `paymentRecipientType` 'DIRECT' | 'FACTOR', required — Who receives the payment. - `DIRECT`: Payment goes directly to the carrier - `FACTOR`: Payment goes to a factoring company (requires carrierFactorId)
      - `paymentMethodType` 'ACH_WIRE' | 'ZELLE' | 'VENMO' | 'ACH' | 'CHECK' | 'WIRE' | 'CAD_EFT' | 'TRIUMPH_PAY' | 'COMCHECK' | 'EFS' | 'ECHECK', required — Payment method type
      - `status` string, nullable — Payment method status
      - `isPreferred` boolean, nullable — Whether this is the preferred payment method
      - `email` string, email, nullable — Email address for payment notifications
      - `phone` string, nullable — Phone number for payment contact
      - `companyName` string, nullable — Company name for this payment method
      - `username` string, nullable — Username for payment platforms
      - `bankName` string, nullable — Bank name
      - `bankAddress` string, nullable — Bank address
      - `accountName` string, nullable — Bank account holder name
      - `accountNumber` string, nullable — Bank account number (masked in responses)
      - `abaAch` string, nullable — ABA/ACH routing number
      - `wire` string, nullable — Wire transfer routing number
      - `swiftCode` string, nullable — SWIFT/BIC code
      - `eftInstitution` string, nullable — EFT institution number (Canadian banking)
      - `eftTransit` string, nullable — EFT transit number (Canadian banking)
      - `clabe` string, nullable — CLABE number (Mexican banking)
      - `currency` string, nullable — Preferred currency code
      - `carrierFactor` CarrierFactorReference — Enhanced reference to a carrier factor (factoring company). Includes full carrier factor details in addition to id/key.
        - `id` string, uuid, required — Carrier factor UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `companyName` string, required — Factoring company legal name
        - `email` string, email, nullable — Primary email address
        - `phoneNumber` string, nullable — Primary phone number
        - `currency` string, nullable — Preferred currency code (ISO 4217)
        - `createdAt` string, date-time, required — When the carrier factor was created
        - `updatedAt` string, date-time, required — When the carrier factor was last updated
      - `paymentTerm` PaymentTermReference — Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.
        - `id` string, uuid, required — Payment term UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `name` string, required — Payment term name
        - `description` string, nullable — Payment term description or notes
        - `days` integer, nullable — Number of days until payment is due
        - `quickPayFee` number, float, nullable — Quick pay fee percentage (e.g., 0.05 for 5%)
        - `apOnly` boolean, nullable — Whether this payment term is for accounts payable only
        - `doNotUse` boolean, nullable — Flag to prevent using this payment term for new transactions
        - `createdAt` string, date-time, required — When the payment term was created
        - `updatedAt` string, date-time, required — When the payment term was last updated
        - `deletedAt` string, date-time, nullable — When the payment term was soft deleted (null if active)
      - `createdAt` string, date-time, required — When the payment method was created
      - `updatedAt` string, date-time, required — When the payment method was last updated
      - `deletedAt` string, date-time, nullable — When the payment method was soft deleted
      - `deletedBy` UserReference — Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key. Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
        - `id` string, uuid, required — User UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `email` string, email, required — User's email address
        - `name` string, nullable — User's full name
        - `phone` string, nullable — User's phone number
        - `phoneExt` string, nullable — Phone extension
        - `status` 'PENDING' | 'ACTIVE' | 'INACTIVE', required — User account status
        - `avatarId` string, uuid, nullable — Profile avatar document ID
        - `createdAt` string, date-time, required — When the user was created
        - `updatedAt` string, date-time, required — When the user was last updated
        - `deletedAt` string, date-time, nullable — When the user was soft deleted (null if active)
    - `contacts` CarrierContactReference[] — Contacts for this carrier
      - `object` 'CARRIER_CONTACT' — Object type identifier
      - `id` string, uuid, required — Unique contact identifier
      - `key` string, nullable — Client-defined reference identifier
      - `name` string, required — Contact person's name
      - `contactInfo` ContactInfo, required — Contact information details (nested, without id). This is an embedded object representing a Contact record. The id is managed internally and not exposed in the API.
        - `name` string, required — Contact person's full name
        - `email` string, email, nullable — Email address
        - `phoneNumber` string, nullable — Phone number
        - `title` string, nullable — Job title or position
      - `contactTypes` CarrierContactType[], nullable — Types/roles this contact serves
      - `invitedUser` UserReference — Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key. Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
        - `id` string, uuid, required — User UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `email` string, email, required — User's email address
        - `name` string, nullable — User's full name
        - `phone` string, nullable — User's phone number
        - `phoneExt` string, nullable — Phone extension
        - `status` 'PENDING' | 'ACTIVE' | 'INACTIVE', required — User account status
        - `avatarId` string, uuid, nullable — Profile avatar document ID
        - `createdAt` string, date-time, required — When the user was created
        - `updatedAt` string, date-time, required — When the user was last updated
        - `deletedAt` string, date-time, nullable — When the user was soft deleted (null if active)
      - `deletedBy` UserReference — Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key. Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
        - `id` string, uuid, required — User UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `email` string, email, required — User's email address
        - `name` string, nullable — User's full name
        - `phone` string, nullable — User's phone number
        - `phoneExt` string, nullable — Phone extension
        - `status` 'PENDING' | 'ACTIVE' | 'INACTIVE', required — User account status
        - `avatarId` string, uuid, nullable — Profile avatar document ID
        - `createdAt` string, date-time, required — When the user was created
        - `updatedAt` string, date-time, required — When the user was last updated
        - `deletedAt` string, date-time, nullable — When the user was soft deleted (null if active)
      - `createdAt` string, date-time, required — When the contact was created
      - `deletedAt` string, date-time, nullable — When the contact was soft deleted
    - `createdAt` string, date-time, required — When the carrier was created
    - `updatedAt` string, date-time, required — When the carrier was last updated
    - `deletedAt` string, date-time, nullable — When the carrier was soft deleted (null if active)
  - CartageCarrier — Cartage (local pickup/delivery) carrier
    - `object` 'CARRIER' — Object type identifier
    - `id` string, uuid, required — Unique carrier identifier
    - `friendlyId` string, required — Human-readable carrier identifier
    - `type` 'CARTAGE', required — Carrier type discriminator
    - `name` string, required — Carrier legal name
    - `dbaName` string, nullable — Doing Business As name
    - `key` string, nullable — Client-defined reference identifier
    - `email` string, email, nullable — Primary email address
    - `phone` string, nullable — Primary phone number
    - `website` string, nullable — Company website URL
    - `status` string, required — Carrier status
    - `statusReason` string, nullable — Reason for current status
    - `notes` string, nullable — Internal notes about the carrier
    - `corporateAddress` Address — Physical address/location details (nested, without id). This is an embedded object representing a Location record. The id is managed internally and not exposed in the API.
      - `line1` string, required — Primary street address line
      - `line2` string, nullable — Secondary address line (suite, floor, etc.)
      - `city` string, required — City name
      - `country` string, required — Country name or code
      - `market` string, required — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean, required — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean, required — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean, required — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean, required — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record (internal use)
    - `billingAddress` Address — Physical address/location details (nested, without id). This is an embedded object representing a Location record. The id is managed internally and not exposed in the API.
      - `line1` string, required — Primary street address line
      - `line2` string, nullable — Secondary address line (suite, floor, etc.)
      - `city` string, required — City name
      - `country` string, required — Country name or code
      - `market` string, required — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean, required — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean, required — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean, required — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean, required — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record (internal use)
    - `mcNumber` string, nullable — Motor Carrier (MC) number
    - `dotNumber` string, nullable — Department of Transportation (DOT) number
    - `scac` string, nullable — Standard Carrier Alpha Code
    - `einNumber` string, nullable — Employer Identification Number
    - `ffNumber` string, nullable — Freight Forwarder (FF) number
    - `mxNumber` string, nullable — Mexico carrier registration number
    - `rfcNumber` string, nullable — RFC (Mexico tax ID) number
    - `iataCode` string, nullable — International Air Transport Association code
    - `equipments` CarrierEquipment[] — Equipment types this carrier operates
    - `isHazmat` boolean, nullable — Whether carrier is certified to transport hazardous materials
    - `tsaApproved` boolean, nullable — Whether carrier is TSA approved
    - `trucks` integer, nullable — Number of trucks in fleet
    - `trailers` integer, nullable — Number of trailers in fleet
    - `drivers` integer, nullable — Number of drivers employed
    - `powerUnits` integer, nullable — Number of power units
    - `currency` 'ARS' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'IDR' | 'INR' | 'JPY' | 'KRW' | 'MXN' | 'RUB' | 'SAR' | 'TRY' | 'USD' | 'ZAR' — Currency code (ISO 4217)
    - `paymentTerm` PaymentTermReference — Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.
      - `id` string, uuid, required — Payment term UUID
      - `key` string, nullable — Client-defined reference ID if set
      - `name` string, required — Payment term name
      - `description` string, nullable — Payment term description or notes
      - `days` integer, nullable — Number of days until payment is due
      - `quickPayFee` number, float, nullable — Quick pay fee percentage (e.g., 0.05 for 5%)
      - `apOnly` boolean, nullable — Whether this payment term is for accounts payable only
      - `doNotUse` boolean, nullable — Flag to prevent using this payment term for new transactions
      - `createdAt` string, date-time, required — When the payment term was created
      - `updatedAt` string, date-time, required — When the payment term was last updated
      - `deletedAt` string, date-time, nullable — When the payment term was soft deleted (null if active)
    - `isFactoringPreferred` boolean, nullable — Whether carrier prefers factoring for payment
    - `goldenCarrierId` string, uuid, nullable — Reference to golden carrier record (for deduplication)
    - `paymentMethods` CarrierPaymentMethodReference[] — Payment methods configured for this carrier
      - `id` string, uuid, required — Unique carrier payment method identifier
      - `key` string, nullable — Client-defined reference identifier
      - `paymentRecipientType` 'DIRECT' | 'FACTOR', required — Who receives the payment. - `DIRECT`: Payment goes directly to the carrier - `FACTOR`: Payment goes to a factoring company (requires carrierFactorId)
      - `paymentMethodType` 'ACH_WIRE' | 'ZELLE' | 'VENMO' | 'ACH' | 'CHECK' | 'WIRE' | 'CAD_EFT' | 'TRIUMPH_PAY' | 'COMCHECK' | 'EFS' | 'ECHECK', required — Payment method type
      - `status` string, nullable — Payment method status
      - `isPreferred` boolean, nullable — Whether this is the preferred payment method
      - `email` string, email, nullable — Email address for payment notifications
      - `phone` string, nullable — Phone number for payment contact
      - `companyName` string, nullable — Company name for this payment method
      - `username` string, nullable — Username for payment platforms
      - `bankName` string, nullable — Bank name
      - `bankAddress` string, nullable — Bank address
      - `accountName` string, nullable — Bank account holder name
      - `accountNumber` string, nullable — Bank account number (masked in responses)
      - `abaAch` string, nullable — ABA/ACH routing number
      - `wire` string, nullable — Wire transfer routing number
      - `swiftCode` string, nullable — SWIFT/BIC code
      - `eftInstitution` string, nullable — EFT institution number (Canadian banking)
      - `eftTransit` string, nullable — EFT transit number (Canadian banking)
      - `clabe` string, nullable — CLABE number (Mexican banking)
      - `currency` string, nullable — Preferred currency code
      - `carrierFactor` CarrierFactorReference — Enhanced reference to a carrier factor (factoring company). Includes full carrier factor details in addition to id/key.
        - `id` string, uuid, required — Carrier factor UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `companyName` string, required — Factoring company legal name
        - `email` string, email, nullable — Primary email address
        - `phoneNumber` string, nullable — Primary phone number
        - `currency` string, nullable — Preferred currency code (ISO 4217)
        - `createdAt` string, date-time, required — When the carrier factor was created
        - `updatedAt` string, date-time, required — When the carrier factor was last updated
      - `paymentTerm` PaymentTermReference — Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.
        - `id` string, uuid, required — Payment term UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `name` string, required — Payment term name
        - `description` string, nullable — Payment term description or notes
        - `days` integer, nullable — Number of days until payment is due
        - `quickPayFee` number, float, nullable — Quick pay fee percentage (e.g., 0.05 for 5%)
        - `apOnly` boolean, nullable — Whether this payment term is for accounts payable only
        - `doNotUse` boolean, nullable — Flag to prevent using this payment term for new transactions
        - `createdAt` string, date-time, required — When the payment term was created
        - `updatedAt` string, date-time, required — When the payment term was last updated
        - `deletedAt` string, date-time, nullable — When the payment term was soft deleted (null if active)
      - `createdAt` string, date-time, required — When the payment method was created
      - `updatedAt` string, date-time, required — When the payment method was last updated
      - `deletedAt` string, date-time, nullable — When the payment method was soft deleted
      - `deletedBy` UserReference — Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key. Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
        - `id` string, uuid, required — User UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `email` string, email, required — User's email address
        - `name` string, nullable — User's full name
        - `phone` string, nullable — User's phone number
        - `phoneExt` string, nullable — Phone extension
        - `status` 'PENDING' | 'ACTIVE' | 'INACTIVE', required — User account status
        - `avatarId` string, uuid, nullable — Profile avatar document ID
        - `createdAt` string, date-time, required — When the user was created
        - `updatedAt` string, date-time, required — When the user was last updated
        - `deletedAt` string, date-time, nullable — When the user was soft deleted (null if active)
    - `contacts` CarrierContactReference[] — Contacts for this carrier
      - `object` 'CARRIER_CONTACT' — Object type identifier
      - `id` string, uuid, required — Unique contact identifier
      - `key` string, nullable — Client-defined reference identifier
      - `name` string, required — Contact person's name
      - `contactInfo` ContactInfo, required — Contact information details (nested, without id). This is an embedded object representing a Contact record. The id is managed internally and not exposed in the API.
        - `name` string, required — Contact person's full name
        - `email` string, email, nullable — Email address
        - `phoneNumber` string, nullable — Phone number
        - `title` string, nullable — Job title or position
      - `contactTypes` CarrierContactType[], nullable — Types/roles this contact serves
      - `invitedUser` UserReference — Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key. Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
        - `id` string, uuid, required — User UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `email` string, email, required — User's email address
        - `name` string, nullable — User's full name
        - `phone` string, nullable — User's phone number
        - `phoneExt` string, nullable — Phone extension
        - `status` 'PENDING' | 'ACTIVE' | 'INACTIVE', required — User account status
        - `avatarId` string, uuid, nullable — Profile avatar document ID
        - `createdAt` string, date-time, required — When the user was created
        - `updatedAt` string, date-time, required — When the user was last updated
        - `deletedAt` string, date-time, nullable — When the user was soft deleted (null if active)
      - `deletedBy` UserReference — Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key. Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
        - `id` string, uuid, required — User UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `email` string, email, required — User's email address
        - `name` string, nullable — User's full name
        - `phone` string, nullable — User's phone number
        - `phoneExt` string, nullable — Phone extension
        - `status` 'PENDING' | 'ACTIVE' | 'INACTIVE', required — User account status
        - `avatarId` string, uuid, nullable — Profile avatar document ID
        - `createdAt` string, date-time, required — When the user was created
        - `updatedAt` string, date-time, required — When the user was last updated
        - `deletedAt` string, date-time, nullable — When the user was soft deleted (null if active)
      - `createdAt` string, date-time, required — When the contact was created
      - `deletedAt` string, date-time, nullable — When the contact was soft deleted
    - `createdAt` string, date-time, required — When the carrier was created
    - `updatedAt` string, date-time, required — When the carrier was last updated
    - `deletedAt` string, date-time, nullable — When the carrier was soft deleted (null if active)
  - LinehaulCarrier — Linehaul (long-distance) carrier
    - `object` 'CARRIER' — Object type identifier
    - `id` string, uuid, required — Unique carrier identifier
    - `friendlyId` string, required — Human-readable carrier identifier
    - `type` 'LINEHAUL', required — Carrier type discriminator
    - `name` string, required — Carrier legal name
    - `dbaName` string, nullable — Doing Business As name
    - `key` string, nullable — Client-defined reference identifier
    - `email` string, email, nullable — Primary email address
    - `phone` string, nullable — Primary phone number
    - `website` string, nullable — Company website URL
    - `status` string, required — Carrier status
    - `statusReason` string, nullable — Reason for current status
    - `notes` string, nullable — Internal notes about the carrier
    - `corporateAddress` Address — Physical address/location details (nested, without id). This is an embedded object representing a Location record. The id is managed internally and not exposed in the API.
      - `line1` string, required — Primary street address line
      - `line2` string, nullable — Secondary address line (suite, floor, etc.)
      - `city` string, required — City name
      - `country` string, required — Country name or code
      - `market` string, required — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean, required — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean, required — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean, required — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean, required — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record (internal use)
    - `billingAddress` Address — Physical address/location details (nested, without id). This is an embedded object representing a Location record. The id is managed internally and not exposed in the API.
      - `line1` string, required — Primary street address line
      - `line2` string, nullable — Secondary address line (suite, floor, etc.)
      - `city` string, required — City name
      - `country` string, required — Country name or code
      - `market` string, required — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean, required — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean, required — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean, required — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean, required — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record (internal use)
    - `mcNumber` string, nullable — Motor Carrier (MC) number
    - `dotNumber` string, nullable — Department of Transportation (DOT) number
    - `scac` string, nullable — Standard Carrier Alpha Code
    - `einNumber` string, nullable — Employer Identification Number
    - `ffNumber` string, nullable — Freight Forwarder (FF) number
    - `mxNumber` string, nullable — Mexico carrier registration number
    - `rfcNumber` string, nullable — RFC (Mexico tax ID) number
    - `iataCode` string, nullable — International Air Transport Association code
    - `equipments` CarrierEquipment[] — Equipment types this carrier operates
    - `isHazmat` boolean, nullable — Whether carrier is certified to transport hazardous materials
    - `tsaApproved` boolean, nullable — Whether carrier is TSA approved
    - `trucks` integer, nullable — Number of trucks in fleet
    - `trailers` integer, nullable — Number of trailers in fleet
    - `drivers` integer, nullable — Number of drivers employed
    - `powerUnits` integer, nullable — Number of power units
    - `currency` 'ARS' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'IDR' | 'INR' | 'JPY' | 'KRW' | 'MXN' | 'RUB' | 'SAR' | 'TRY' | 'USD' | 'ZAR' — Currency code (ISO 4217)
    - `paymentTerm` PaymentTermReference — Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.
      - `id` string, uuid, required — Payment term UUID
      - `key` string, nullable — Client-defined reference ID if set
      - `name` string, required — Payment term name
      - `description` string, nullable — Payment term description or notes
      - `days` integer, nullable — Number of days until payment is due
      - `quickPayFee` number, float, nullable — Quick pay fee percentage (e.g., 0.05 for 5%)
      - `apOnly` boolean, nullable — Whether this payment term is for accounts payable only
      - `doNotUse` boolean, nullable — Flag to prevent using this payment term for new transactions
      - `createdAt` string, date-time, required — When the payment term was created
      - `updatedAt` string, date-time, required — When the payment term was last updated
      - `deletedAt` string, date-time, nullable — When the payment term was soft deleted (null if active)
    - `isFactoringPreferred` boolean, nullable — Whether carrier prefers factoring for payment
    - `goldenCarrierId` string, uuid, nullable — Reference to golden carrier record (for deduplication)
    - `paymentMethods` CarrierPaymentMethodReference[] — Payment methods configured for this carrier
      - `id` string, uuid, required — Unique carrier payment method identifier
      - `key` string, nullable — Client-defined reference identifier
      - `paymentRecipientType` 'DIRECT' | 'FACTOR', required — Who receives the payment. - `DIRECT`: Payment goes directly to the carrier - `FACTOR`: Payment goes to a factoring company (requires carrierFactorId)
      - `paymentMethodType` 'ACH_WIRE' | 'ZELLE' | 'VENMO' | 'ACH' | 'CHECK' | 'WIRE' | 'CAD_EFT' | 'TRIUMPH_PAY' | 'COMCHECK' | 'EFS' | 'ECHECK', required — Payment method type
      - `status` string, nullable — Payment method status
      - `isPreferred` boolean, nullable — Whether this is the preferred payment method
      - `email` string, email, nullable — Email address for payment notifications
      - `phone` string, nullable — Phone number for payment contact
      - `companyName` string, nullable — Company name for this payment method
      - `username` string, nullable — Username for payment platforms
      - `bankName` string, nullable — Bank name
      - `bankAddress` string, nullable — Bank address
      - `accountName` string, nullable — Bank account holder name
      - `accountNumber` string, nullable — Bank account number (masked in responses)
      - `abaAch` string, nullable — ABA/ACH routing number
      - `wire` string, nullable — Wire transfer routing number
      - `swiftCode` string, nullable — SWIFT/BIC code
      - `eftInstitution` string, nullable — EFT institution number (Canadian banking)
      - `eftTransit` string, nullable — EFT transit number (Canadian banking)
      - `clabe` string, nullable — CLABE number (Mexican banking)
      - `currency` string, nullable — Preferred currency code
      - `carrierFactor` CarrierFactorReference — Enhanced reference to a carrier factor (factoring company). Includes full carrier factor details in addition to id/key.
        - `id` string, uuid, required — Carrier factor UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `companyName` string, required — Factoring company legal name
        - `email` string, email, nullable — Primary email address
        - `phoneNumber` string, nullable — Primary phone number
        - `currency` string, nullable — Preferred currency code (ISO 4217)
        - `createdAt` string, date-time, required — When the carrier factor was created
        - `updatedAt` string, date-time, required — When the carrier factor was last updated
      - `paymentTerm` PaymentTermReference — Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.
        - `id` string, uuid, required — Payment term UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `name` string, required — Payment term name
        - `description` string, nullable — Payment term description or notes
        - `days` integer, nullable — Number of days until payment is due
        - `quickPayFee` number, float, nullable — Quick pay fee percentage (e.g., 0.05 for 5%)
        - `apOnly` boolean, nullable — Whether this payment term is for accounts payable only
        - `doNotUse` boolean, nullable — Flag to prevent using this payment term for new transactions
        - `createdAt` string, date-time, required — When the payment term was created
        - `updatedAt` string, date-time, required — When the payment term was last updated
        - `deletedAt` string, date-time, nullable — When the payment term was soft deleted (null if active)
      - `createdAt` string, date-time, required — When the payment method was created
      - `updatedAt` string, date-time, required — When the payment method was last updated
      - `deletedAt` string, date-time, nullable — When the payment method was soft deleted
      - `deletedBy` UserReference — Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key. Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
        - `id` string, uuid, required — User UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `email` string, email, required — User's email address
        - `name` string, nullable — User's full name
        - `phone` string, nullable — User's phone number
        - `phoneExt` string, nullable — Phone extension
        - `status` 'PENDING' | 'ACTIVE' | 'INACTIVE', required — User account status
        - `avatarId` string, uuid, nullable — Profile avatar document ID
        - `createdAt` string, date-time, required — When the user was created
        - `updatedAt` string, date-time, required — When the user was last updated
        - `deletedAt` string, date-time, nullable — When the user was soft deleted (null if active)
    - `contacts` CarrierContactReference[] — Contacts for this carrier
      - `object` 'CARRIER_CONTACT' — Object type identifier
      - `id` string, uuid, required — Unique contact identifier
      - `key` string, nullable — Client-defined reference identifier
      - `name` string, required — Contact person's name
      - `contactInfo` ContactInfo, required — Contact information details (nested, without id). This is an embedded object representing a Contact record. The id is managed internally and not exposed in the API.
        - `name` string, required — Contact person's full name
        - `email` string, email, nullable — Email address
        - `phoneNumber` string, nullable — Phone number
        - `title` string, nullable — Job title or position
      - `contactTypes` CarrierContactType[], nullable — Types/roles this contact serves
      - `invitedUser` UserReference — Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key. Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
        - `id` string, uuid, required — User UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `email` string, email, required — User's email address
        - `name` string, nullable — User's full name
        - `phone` string, nullable — User's phone number
        - `phoneExt` string, nullable — Phone extension
        - `status` 'PENDING' | 'ACTIVE' | 'INACTIVE', required — User account status
        - `avatarId` string, uuid, nullable — Profile avatar document ID
        - `createdAt` string, date-time, required — When the user was created
        - `updatedAt` string, date-time, required — When the user was last updated
        - `deletedAt` string, date-time, nullable — When the user was soft deleted (null if active)
      - `deletedBy` UserReference — Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key. Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
        - `id` string, uuid, required — User UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `email` string, email, required — User's email address
        - `name` string, nullable — User's full name
        - `phone` string, nullable — User's phone number
        - `phoneExt` string, nullable — Phone extension
        - `status` 'PENDING' | 'ACTIVE' | 'INACTIVE', required — User account status
        - `avatarId` string, uuid, nullable — Profile avatar document ID
        - `createdAt` string, date-time, required — When the user was created
        - `updatedAt` string, date-time, required — When the user was last updated
        - `deletedAt` string, date-time, nullable — When the user was soft deleted (null if active)
      - `createdAt` string, date-time, required — When the contact was created
      - `deletedAt` string, date-time, nullable — When the contact was soft deleted
    - `createdAt` string, date-time, required — When the carrier was created
    - `updatedAt` string, date-time, required — When the carrier was last updated
    - `deletedAt` string, date-time, nullable — When the carrier was soft deleted (null if active)
  - LtlCarrier — Less-than-truckload (LTL) carrier
    - `object` 'CARRIER' — Object type identifier
    - `id` string, uuid, required — Unique carrier identifier
    - `friendlyId` string, required — Human-readable carrier identifier
    - `type` 'LTL', required — Carrier type discriminator
    - `name` string, required — Carrier legal name
    - `dbaName` string, nullable — Doing Business As name
    - `key` string, nullable — Client-defined reference identifier
    - `email` string, email, nullable — Primary email address
    - `phone` string, nullable — Primary phone number
    - `website` string, nullable — Company website URL
    - `status` string, required — Carrier status
    - `statusReason` string, nullable — Reason for current status
    - `notes` string, nullable — Internal notes about the carrier
    - `corporateAddress` Address — Physical address/location details (nested, without id). This is an embedded object representing a Location record. The id is managed internally and not exposed in the API.
      - `line1` string, required — Primary street address line
      - `line2` string, nullable — Secondary address line (suite, floor, etc.)
      - `city` string, required — City name
      - `country` string, required — Country name or code
      - `market` string, required — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean, required — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean, required — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean, required — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean, required — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record (internal use)
    - `billingAddress` Address — Physical address/location details (nested, without id). This is an embedded object representing a Location record. The id is managed internally and not exposed in the API.
      - `line1` string, required — Primary street address line
      - `line2` string, nullable — Secondary address line (suite, floor, etc.)
      - `city` string, required — City name
      - `country` string, required — Country name or code
      - `market` string, required — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean, required — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean, required — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean, required — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean, required — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record (internal use)
    - `mcNumber` string, nullable — Motor Carrier (MC) number
    - `dotNumber` string, nullable — Department of Transportation (DOT) number
    - `scac` string, nullable — Standard Carrier Alpha Code
    - `einNumber` string, nullable — Employer Identification Number
    - `ffNumber` string, nullable — Freight Forwarder (FF) number
    - `mxNumber` string, nullable — Mexico carrier registration number
    - `rfcNumber` string, nullable — RFC (Mexico tax ID) number
    - `iataCode` string, nullable — International Air Transport Association code
    - `equipments` CarrierEquipment[] — Equipment types this carrier operates
    - `isHazmat` boolean, nullable — Whether carrier is certified to transport hazardous materials
    - `tsaApproved` boolean, nullable — Whether carrier is TSA approved
    - `trucks` integer, nullable — Number of trucks in fleet
    - `trailers` integer, nullable — Number of trailers in fleet
    - `drivers` integer, nullable — Number of drivers employed
    - `powerUnits` integer, nullable — Number of power units
    - `currency` 'ARS' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'IDR' | 'INR' | 'JPY' | 'KRW' | 'MXN' | 'RUB' | 'SAR' | 'TRY' | 'USD' | 'ZAR' — Currency code (ISO 4217)
    - `paymentTerm` PaymentTermReference — Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.
      - `id` string, uuid, required — Payment term UUID
      - `key` string, nullable — Client-defined reference ID if set
      - `name` string, required — Payment term name
      - `description` string, nullable — Payment term description or notes
      - `days` integer, nullable — Number of days until payment is due
      - `quickPayFee` number, float, nullable — Quick pay fee percentage (e.g., 0.05 for 5%)
      - `apOnly` boolean, nullable — Whether this payment term is for accounts payable only
      - `doNotUse` boolean, nullable — Flag to prevent using this payment term for new transactions
      - `createdAt` string, date-time, required — When the payment term was created
      - `updatedAt` string, date-time, required — When the payment term was last updated
      - `deletedAt` string, date-time, nullable — When the payment term was soft deleted (null if active)
    - `isFactoringPreferred` boolean, nullable — Whether carrier prefers factoring for payment
    - `goldenCarrierId` string, uuid, nullable — Reference to golden carrier record (for deduplication)
    - `paymentMethods` CarrierPaymentMethodReference[] — Payment methods configured for this carrier
      - `id` string, uuid, required — Unique carrier payment method identifier
      - `key` string, nullable — Client-defined reference identifier
      - `paymentRecipientType` 'DIRECT' | 'FACTOR', required — Who receives the payment. - `DIRECT`: Payment goes directly to the carrier - `FACTOR`: Payment goes to a factoring company (requires carrierFactorId)
      - `paymentMethodType` 'ACH_WIRE' | 'ZELLE' | 'VENMO' | 'ACH' | 'CHECK' | 'WIRE' | 'CAD_EFT' | 'TRIUMPH_PAY' | 'COMCHECK' | 'EFS' | 'ECHECK', required — Payment method type
      - `status` string, nullable — Payment method status
      - `isPreferred` boolean, nullable — Whether this is the preferred payment method
      - `email` string, email, nullable — Email address for payment notifications
      - `phone` string, nullable — Phone number for payment contact
      - `companyName` string, nullable — Company name for this payment method
      - `username` string, nullable — Username for payment platforms
      - `bankName` string, nullable — Bank name
      - `bankAddress` string, nullable — Bank address
      - `accountName` string, nullable — Bank account holder name
      - `accountNumber` string, nullable — Bank account number (masked in responses)
      - `abaAch` string, nullable — ABA/ACH routing number
      - `wire` string, nullable — Wire transfer routing number
      - `swiftCode` string, nullable — SWIFT/BIC code
      - `eftInstitution` string, nullable — EFT institution number (Canadian banking)
      - `eftTransit` string, nullable — EFT transit number (Canadian banking)
      - `clabe` string, nullable — CLABE number (Mexican banking)
      - `currency` string, nullable — Preferred currency code
      - `carrierFactor` CarrierFactorReference — Enhanced reference to a carrier factor (factoring company). Includes full carrier factor details in addition to id/key.
        - `id` string, uuid, required — Carrier factor UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `companyName` string, required — Factoring company legal name
        - `email` string, email, nullable — Primary email address
        - `phoneNumber` string, nullable — Primary phone number
        - `currency` string, nullable — Preferred currency code (ISO 4217)
        - `createdAt` string, date-time, required — When the carrier factor was created
        - `updatedAt` string, date-time, required — When the carrier factor was last updated
      - `paymentTerm` PaymentTermReference — Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.
        - `id` string, uuid, required — Payment term UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `name` string, required — Payment term name
        - `description` string, nullable — Payment term description or notes
        - `days` integer, nullable — Number of days until payment is due
        - `quickPayFee` number, float, nullable — Quick pay fee percentage (e.g., 0.05 for 5%)
        - `apOnly` boolean, nullable — Whether this payment term is for accounts payable only
        - `doNotUse` boolean, nullable — Flag to prevent using this payment term for new transactions
        - `createdAt` string, date-time, required — When the payment term was created
        - `updatedAt` string, date-time, required — When the payment term was last updated
        - `deletedAt` string, date-time, nullable — When the payment term was soft deleted (null if active)
      - `createdAt` string, date-time, required — When the payment method was created
      - `updatedAt` string, date-time, required — When the payment method was last updated
      - `deletedAt` string, date-time, nullable — When the payment method was soft deleted
      - `deletedBy` UserReference — Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key. Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
        - `id` string, uuid, required — User UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `email` string, email, required — User's email address
        - `name` string, nullable — User's full name
        - `phone` string, nullable — User's phone number
        - `phoneExt` string, nullable — Phone extension
        - `status` 'PENDING' | 'ACTIVE' | 'INACTIVE', required — User account status
        - `avatarId` string, uuid, nullable — Profile avatar document ID
        - `createdAt` string, date-time, required — When the user was created
        - `updatedAt` string, date-time, required — When the user was last updated
        - `deletedAt` string, date-time, nullable — When the user was soft deleted (null if active)
    - `contacts` CarrierContactReference[] — Contacts for this carrier
      - `object` 'CARRIER_CONTACT' — Object type identifier
      - `id` string, uuid, required — Unique contact identifier
      - `key` string, nullable — Client-defined reference identifier
      - `name` string, required — Contact person's name
      - `contactInfo` ContactInfo, required — Contact information details (nested, without id). This is an embedded object representing a Contact record. The id is managed internally and not exposed in the API.
        - `name` string, required — Contact person's full name
        - `email` string, email, nullable — Email address
        - `phoneNumber` string, nullable — Phone number
        - `title` string, nullable — Job title or position
      - `contactTypes` CarrierContactType[], nullable — Types/roles this contact serves
      - `invitedUser` UserReference — Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key. Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
        - `id` string, uuid, required — User UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `email` string, email, required — User's email address
        - `name` string, nullable — User's full name
        - `phone` string, nullable — User's phone number
        - `phoneExt` string, nullable — Phone extension
        - `status` 'PENDING' | 'ACTIVE' | 'INACTIVE', required — User account status
        - `avatarId` string, uuid, nullable — Profile avatar document ID
        - `createdAt` string, date-time, required — When the user was created
        - `updatedAt` string, date-time, required — When the user was last updated
        - `deletedAt` string, date-time, nullable — When the user was soft deleted (null if active)
      - `deletedBy` UserReference — Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key. Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
        - `id` string, uuid, required — User UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `email` string, email, required — User's email address
        - `name` string, nullable — User's full name
        - `phone` string, nullable — User's phone number
        - `phoneExt` string, nullable — Phone extension
        - `status` 'PENDING' | 'ACTIVE' | 'INACTIVE', required — User account status
        - `avatarId` string, uuid, nullable — Profile avatar document ID
        - `createdAt` string, date-time, required — When the user was created
        - `updatedAt` string, date-time, required — When the user was last updated
        - `deletedAt` string, date-time, nullable — When the user was soft deleted (null if active)
      - `createdAt` string, date-time, required — When the contact was created
      - `deletedAt` string, date-time, nullable — When the contact was soft deleted
    - `createdAt` string, date-time, required — When the carrier was created
    - `updatedAt` string, date-time, required — When the carrier was last updated
    - `deletedAt` string, date-time, nullable — When the carrier was soft deleted (null if active)
  - OceanCarrier — Ocean freight carrier
    - `object` 'CARRIER' — Object type identifier
    - `id` string, uuid, required — Unique carrier identifier
    - `friendlyId` string, required — Human-readable carrier identifier
    - `type` 'OCEAN', required — Carrier type discriminator
    - `name` string, required — Carrier legal name
    - `dbaName` string, nullable — Doing Business As name
    - `key` string, nullable — Client-defined reference identifier
    - `email` string, email, nullable — Primary email address
    - `phone` string, nullable — Primary phone number
    - `website` string, nullable — Company website URL
    - `status` string, required — Carrier status
    - `statusReason` string, nullable — Reason for current status
    - `notes` string, nullable — Internal notes about the carrier
    - `corporateAddress` Address — Physical address/location details (nested, without id). This is an embedded object representing a Location record. The id is managed internally and not exposed in the API.
      - `line1` string, required — Primary street address line
      - `line2` string, nullable — Secondary address line (suite, floor, etc.)
      - `city` string, required — City name
      - `country` string, required — Country name or code
      - `market` string, required — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean, required — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean, required — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean, required — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean, required — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record (internal use)
    - `billingAddress` Address — Physical address/location details (nested, without id). This is an embedded object representing a Location record. The id is managed internally and not exposed in the API.
      - `line1` string, required — Primary street address line
      - `line2` string, nullable — Secondary address line (suite, floor, etc.)
      - `city` string, required — City name
      - `country` string, required — Country name or code
      - `market` string, required — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean, required — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean, required — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean, required — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean, required — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record (internal use)
    - `mcNumber` string, nullable — Motor Carrier (MC) number
    - `dotNumber` string, nullable — Department of Transportation (DOT) number
    - `scac` string, nullable — Standard Carrier Alpha Code
    - `einNumber` string, nullable — Employer Identification Number
    - `ffNumber` string, nullable — Freight Forwarder (FF) number
    - `mxNumber` string, nullable — Mexico carrier registration number
    - `rfcNumber` string, nullable — RFC (Mexico tax ID) number
    - `iataCode` string, nullable — International Air Transport Association code
    - `equipments` CarrierEquipment[] — Equipment types this carrier operates
    - `isHazmat` boolean, nullable — Whether carrier is certified to transport hazardous materials
    - `tsaApproved` boolean, nullable — Whether carrier is TSA approved
    - `trucks` integer, nullable — Number of trucks in fleet
    - `trailers` integer, nullable — Number of trailers in fleet
    - `drivers` integer, nullable — Number of drivers employed
    - `powerUnits` integer, nullable — Number of power units
    - `currency` 'ARS' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'IDR' | 'INR' | 'JPY' | 'KRW' | 'MXN' | 'RUB' | 'SAR' | 'TRY' | 'USD' | 'ZAR' — Currency code (ISO 4217)
    - `paymentTerm` PaymentTermReference — Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.
      - `id` string, uuid, required — Payment term UUID
      - `key` string, nullable — Client-defined reference ID if set
      - `name` string, required — Payment term name
      - `description` string, nullable — Payment term description or notes
      - `days` integer, nullable — Number of days until payment is due
      - `quickPayFee` number, float, nullable — Quick pay fee percentage (e.g., 0.05 for 5%)
      - `apOnly` boolean, nullable — Whether this payment term is for accounts payable only
      - `doNotUse` boolean, nullable — Flag to prevent using this payment term for new transactions
      - `createdAt` string, date-time, required — When the payment term was created
      - `updatedAt` string, date-time, required — When the payment term was last updated
      - `deletedAt` string, date-time, nullable — When the payment term was soft deleted (null if active)
    - `isFactoringPreferred` boolean, nullable — Whether carrier prefers factoring for payment
    - `goldenCarrierId` string, uuid, nullable — Reference to golden carrier record (for deduplication)
    - `paymentMethods` CarrierPaymentMethodReference[] — Payment methods configured for this carrier
      - `id` string, uuid, required — Unique carrier payment method identifier
      - `key` string, nullable — Client-defined reference identifier
      - `paymentRecipientType` 'DIRECT' | 'FACTOR', required — Who receives the payment. - `DIRECT`: Payment goes directly to the carrier - `FACTOR`: Payment goes to a factoring company (requires carrierFactorId)
      - `paymentMethodType` 'ACH_WIRE' | 'ZELLE' | 'VENMO' | 'ACH' | 'CHECK' | 'WIRE' | 'CAD_EFT' | 'TRIUMPH_PAY' | 'COMCHECK' | 'EFS' | 'ECHECK', required — Payment method type
      - `status` string, nullable — Payment method status
      - `isPreferred` boolean, nullable — Whether this is the preferred payment method
      - `email` string, email, nullable — Email address for payment notifications
      - `phone` string, nullable — Phone number for payment contact
      - `companyName` string, nullable — Company name for this payment method
      - `username` string, nullable — Username for payment platforms
      - `bankName` string, nullable — Bank name
      - `bankAddress` string, nullable — Bank address
      - `accountName` string, nullable — Bank account holder name
      - `accountNumber` string, nullable — Bank account number (masked in responses)
      - `abaAch` string, nullable — ABA/ACH routing number
      - `wire` string, nullable — Wire transfer routing number
      - `swiftCode` string, nullable — SWIFT/BIC code
      - `eftInstitution` string, nullable — EFT institution number (Canadian banking)
      - `eftTransit` string, nullable — EFT transit number (Canadian banking)
      - `clabe` string, nullable — CLABE number (Mexican banking)
      - `currency` string, nullable — Preferred currency code
      - `carrierFactor` CarrierFactorReference — Enhanced reference to a carrier factor (factoring company). Includes full carrier factor details in addition to id/key.
        - `id` string, uuid, required — Carrier factor UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `companyName` string, required — Factoring company legal name
        - `email` string, email, nullable — Primary email address
        - `phoneNumber` string, nullable — Primary phone number
        - `currency` string, nullable — Preferred currency code (ISO 4217)
        - `createdAt` string, date-time, required — When the carrier factor was created
        - `updatedAt` string, date-time, required — When the carrier factor was last updated
      - `paymentTerm` PaymentTermReference — Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.
        - `id` string, uuid, required — Payment term UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `name` string, required — Payment term name
        - `description` string, nullable — Payment term description or notes
        - `days` integer, nullable — Number of days until payment is due
        - `quickPayFee` number, float, nullable — Quick pay fee percentage (e.g., 0.05 for 5%)
        - `apOnly` boolean, nullable — Whether this payment term is for accounts payable only
        - `doNotUse` boolean, nullable — Flag to prevent using this payment term for new transactions
        - `createdAt` string, date-time, required — When the payment term was created
        - `updatedAt` string, date-time, required — When the payment term was last updated
        - `deletedAt` string, date-time, nullable — When the payment term was soft deleted (null if active)
      - `createdAt` string, date-time, required — When the payment method was created
      - `updatedAt` string, date-time, required — When the payment method was last updated
      - `deletedAt` string, date-time, nullable — When the payment method was soft deleted
      - `deletedBy` UserReference — Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key. Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
        - `id` string, uuid, required — User UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `email` string, email, required — User's email address
        - `name` string, nullable — User's full name
        - `phone` string, nullable — User's phone number
        - `phoneExt` string, nullable — Phone extension
        - `status` 'PENDING' | 'ACTIVE' | 'INACTIVE', required — User account status
        - `avatarId` string, uuid, nullable — Profile avatar document ID
        - `createdAt` string, date-time, required — When the user was created
        - `updatedAt` string, date-time, required — When the user was last updated
        - `deletedAt` string, date-time, nullable — When the user was soft deleted (null if active)
    - `contacts` CarrierContactReference[] — Contacts for this carrier
      - `object` 'CARRIER_CONTACT' — Object type identifier
      - `id` string, uuid, required — Unique contact identifier
      - `key` string, nullable — Client-defined reference identifier
      - `name` string, required — Contact person's name
      - `contactInfo` ContactInfo, required — Contact information details (nested, without id). This is an embedded object representing a Contact record. The id is managed internally and not exposed in the API.
        - `name` string, required — Contact person's full name
        - `email` string, email, nullable — Email address
        - `phoneNumber` string, nullable — Phone number
        - `title` string, nullable — Job title or position
      - `contactTypes` CarrierContactType[], nullable — Types/roles this contact serves
      - `invitedUser` UserReference — Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key. Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
        - `id` string, uuid, required — User UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `email` string, email, required — User's email address
        - `name` string, nullable — User's full name
        - `phone` string, nullable — User's phone number
        - `phoneExt` string, nullable — Phone extension
        - `status` 'PENDING' | 'ACTIVE' | 'INACTIVE', required — User account status
        - `avatarId` string, uuid, nullable — Profile avatar document ID
        - `createdAt` string, date-time, required — When the user was created
        - `updatedAt` string, date-time, required — When the user was last updated
        - `deletedAt` string, date-time, nullable — When the user was soft deleted (null if active)
      - `deletedBy` UserReference — Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key. Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
        - `id` string, uuid, required — User UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `email` string, email, required — User's email address
        - `name` string, nullable — User's full name
        - `phone` string, nullable — User's phone number
        - `phoneExt` string, nullable — Phone extension
        - `status` 'PENDING' | 'ACTIVE' | 'INACTIVE', required — User account status
        - `avatarId` string, uuid, nullable — Profile avatar document ID
        - `createdAt` string, date-time, required — When the user was created
        - `updatedAt` string, date-time, required — When the user was last updated
        - `deletedAt` string, date-time, nullable — When the user was soft deleted (null if active)
      - `createdAt` string, date-time, required — When the contact was created
      - `deletedAt` string, date-time, nullable — When the contact was soft deleted
    - `createdAt` string, date-time, required — When the carrier was created
    - `updatedAt` string, date-time, required — When the carrier was last updated
    - `deletedAt` string, date-time, nullable — When the carrier was soft deleted (null if active)
  - RailCarrier — Rail freight carrier
    - `object` 'CARRIER' — Object type identifier
    - `id` string, uuid, required — Unique carrier identifier
    - `friendlyId` string, required — Human-readable carrier identifier
    - `type` 'RAIL', required — Carrier type discriminator
    - `name` string, required — Carrier legal name
    - `dbaName` string, nullable — Doing Business As name
    - `key` string, nullable — Client-defined reference identifier
    - `email` string, email, nullable — Primary email address
    - `phone` string, nullable — Primary phone number
    - `website` string, nullable — Company website URL
    - `status` string, required — Carrier status
    - `statusReason` string, nullable — Reason for current status
    - `notes` string, nullable — Internal notes about the carrier
    - `corporateAddress` Address — Physical address/location details (nested, without id). This is an embedded object representing a Location record. The id is managed internally and not exposed in the API.
      - `line1` string, required — Primary street address line
      - `line2` string, nullable — Secondary address line (suite, floor, etc.)
      - `city` string, required — City name
      - `country` string, required — Country name or code
      - `market` string, required — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean, required — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean, required — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean, required — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean, required — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record (internal use)
    - `billingAddress` Address — Physical address/location details (nested, without id). This is an embedded object representing a Location record. The id is managed internally and not exposed in the API.
      - `line1` string, required — Primary street address line
      - `line2` string, nullable — Secondary address line (suite, floor, etc.)
      - `city` string, required — City name
      - `country` string, required — Country name or code
      - `market` string, required — Market or region identifier
      - `latitude` string, nullable — Latitude coordinate
      - `longitude` string, nullable — Longitude coordinate
      - `isAirportOrAirbase` boolean, required — Whether this location is an airport or airbase
      - `isConstructionOrUtilitySite` boolean, required — Whether this location is a construction or utility site
      - `isSmartyValidated` boolean, required — Whether address has been validated by SmartyStreets
      - `obeysDst` boolean, required — Whether this location observes daylight saving time
      - `cityId` string, uuid, nullable — Reference to standardized city record (internal use)
    - `mcNumber` string, nullable — Motor Carrier (MC) number
    - `dotNumber` string, nullable — Department of Transportation (DOT) number
    - `scac` string, nullable — Standard Carrier Alpha Code
    - `einNumber` string, nullable — Employer Identification Number
    - `ffNumber` string, nullable — Freight Forwarder (FF) number
    - `mxNumber` string, nullable — Mexico carrier registration number
    - `rfcNumber` string, nullable — RFC (Mexico tax ID) number
    - `iataCode` string, nullable — International Air Transport Association code
    - `equipments` CarrierEquipment[] — Equipment types this carrier operates
    - `isHazmat` boolean, nullable — Whether carrier is certified to transport hazardous materials
    - `tsaApproved` boolean, nullable — Whether carrier is TSA approved
    - `trucks` integer, nullable — Number of trucks in fleet
    - `trailers` integer, nullable — Number of trailers in fleet
    - `drivers` integer, nullable — Number of drivers employed
    - `powerUnits` integer, nullable — Number of power units
    - `currency` 'ARS' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'IDR' | 'INR' | 'JPY' | 'KRW' | 'MXN' | 'RUB' | 'SAR' | 'TRY' | 'USD' | 'ZAR' — Currency code (ISO 4217)
    - `paymentTerm` PaymentTermReference — Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.
      - `id` string, uuid, required — Payment term UUID
      - `key` string, nullable — Client-defined reference ID if set
      - `name` string, required — Payment term name
      - `description` string, nullable — Payment term description or notes
      - `days` integer, nullable — Number of days until payment is due
      - `quickPayFee` number, float, nullable — Quick pay fee percentage (e.g., 0.05 for 5%)
      - `apOnly` boolean, nullable — Whether this payment term is for accounts payable only
      - `doNotUse` boolean, nullable — Flag to prevent using this payment term for new transactions
      - `createdAt` string, date-time, required — When the payment term was created
      - `updatedAt` string, date-time, required — When the payment term was last updated
      - `deletedAt` string, date-time, nullable — When the payment term was soft deleted (null if active)
    - `isFactoringPreferred` boolean, nullable — Whether carrier prefers factoring for payment
    - `goldenCarrierId` string, uuid, nullable — Reference to golden carrier record (for deduplication)
    - `paymentMethods` CarrierPaymentMethodReference[] — Payment methods configured for this carrier
      - `id` string, uuid, required — Unique carrier payment method identifier
      - `key` string, nullable — Client-defined reference identifier
      - `paymentRecipientType` 'DIRECT' | 'FACTOR', required — Who receives the payment. - `DIRECT`: Payment goes directly to the carrier - `FACTOR`: Payment goes to a factoring company (requires carrierFactorId)
      - `paymentMethodType` 'ACH_WIRE' | 'ZELLE' | 'VENMO' | 'ACH' | 'CHECK' | 'WIRE' | 'CAD_EFT' | 'TRIUMPH_PAY' | 'COMCHECK' | 'EFS' | 'ECHECK', required — Payment method type
      - `status` string, nullable — Payment method status
      - `isPreferred` boolean, nullable — Whether this is the preferred payment method
      - `email` string, email, nullable — Email address for payment notifications
      - `phone` string, nullable — Phone number for payment contact
      - `companyName` string, nullable — Company name for this payment method
      - `username` string, nullable — Username for payment platforms
      - `bankName` string, nullable — Bank name
      - `bankAddress` string, nullable — Bank address
      - `accountName` string, nullable — Bank account holder name
      - `accountNumber` string, nullable — Bank account number (masked in responses)
      - `abaAch` string, nullable — ABA/ACH routing number
      - `wire` string, nullable — Wire transfer routing number
      - `swiftCode` string, nullable — SWIFT/BIC code
      - `eftInstitution` string, nullable — EFT institution number (Canadian banking)
      - `eftTransit` string, nullable — EFT transit number (Canadian banking)
      - `clabe` string, nullable — CLABE number (Mexican banking)
      - `currency` string, nullable — Preferred currency code
      - `carrierFactor` CarrierFactorReference — Enhanced reference to a carrier factor (factoring company). Includes full carrier factor details in addition to id/key.
        - `id` string, uuid, required — Carrier factor UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `companyName` string, required — Factoring company legal name
        - `email` string, email, nullable — Primary email address
        - `phoneNumber` string, nullable — Primary phone number
        - `currency` string, nullable — Preferred currency code (ISO 4217)
        - `createdAt` string, date-time, required — When the carrier factor was created
        - `updatedAt` string, date-time, required — When the carrier factor was last updated
      - `paymentTerm` PaymentTermReference — Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.
        - `id` string, uuid, required — Payment term UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `name` string, required — Payment term name
        - `description` string, nullable — Payment term description or notes
        - `days` integer, nullable — Number of days until payment is due
        - `quickPayFee` number, float, nullable — Quick pay fee percentage (e.g., 0.05 for 5%)
        - `apOnly` boolean, nullable — Whether this payment term is for accounts payable only
        - `doNotUse` boolean, nullable — Flag to prevent using this payment term for new transactions
        - `createdAt` string, date-time, required — When the payment term was created
        - `updatedAt` string, date-time, required — When the payment term was last updated
        - `deletedAt` string, date-time, nullable — When the payment term was soft deleted (null if active)
      - `createdAt` string, date-time, required — When the payment method was created
      - `updatedAt` string, date-time, required — When the payment method was last updated
      - `deletedAt` string, date-time, nullable — When the payment method was soft deleted
      - `deletedBy` UserReference — Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key. Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
        - `id` string, uuid, required — User UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `email` string, email, required — User's email address
        - `name` string, nullable — User's full name
        - `phone` string, nullable — User's phone number
        - `phoneExt` string, nullable — Phone extension
        - `status` 'PENDING' | 'ACTIVE' | 'INACTIVE', required — User account status
        - `avatarId` string, uuid, nullable — Profile avatar document ID
        - `createdAt` string, date-time, required — When the user was created
        - `updatedAt` string, date-time, required — When the user was last updated
        - `deletedAt` string, date-time, nullable — When the user was soft deleted (null if active)
    - `contacts` CarrierContactReference[] — Contacts for this carrier
      - `object` 'CARRIER_CONTACT' — Object type identifier
      - `id` string, uuid, required — Unique contact identifier
      - `key` string, nullable — Client-defined reference identifier
      - `name` string, required — Contact person's name
      - `contactInfo` ContactInfo, required — Contact information details (nested, without id). This is an embedded object representing a Contact record. The id is managed internally and not exposed in the API.
        - `name` string, required — Contact person's full name
        - `email` string, email, nullable — Email address
        - `phoneNumber` string, nullable — Phone number
        - `title` string, nullable — Job title or position
      - `contactTypes` CarrierContactType[], nullable — Types/roles this contact serves
      - `invitedUser` UserReference — Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key. Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
        - `id` string, uuid, required — User UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `email` string, email, required — User's email address
        - `name` string, nullable — User's full name
        - `phone` string, nullable — User's phone number
        - `phoneExt` string, nullable — Phone extension
        - `status` 'PENDING' | 'ACTIVE' | 'INACTIVE', required — User account status
        - `avatarId` string, uuid, nullable — Profile avatar document ID
        - `createdAt` string, date-time, required — When the user was created
        - `updatedAt` string, date-time, required — When the user was last updated
        - `deletedAt` string, date-time, nullable — When the user was soft deleted (null if active)
      - `deletedBy` UserReference — Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key. Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
        - `id` string, uuid, required — User UUID
        - `key` string, nullable — Client-defined reference ID if set
        - `email` string, email, required — User's email address
        - `name` string, nullable — User's full name
        - `phone` string, nullable — User's phone number
        - `phoneExt` string, nullable — Phone extension
        - `status` 'PENDING' | 'ACTIVE' | 'INACTIVE', required — User account status
        - `avatarId` string, uuid, nullable — Profile avatar document ID
        - `createdAt` string, date-time, required — When the user was created
        - `updatedAt` string, date-time, required — When the user was last updated
        - `deletedAt` string, date-time, nullable — When the user was soft deleted (null if active)
      - `createdAt` string, date-time, required — When the contact was created
      - `deletedAt` string, date-time, nullable — When the contact was soft deleted
    - `createdAt` string, date-time, required — When the carrier was created
    - `updatedAt` string, date-time, required — When the carrier was last updated
    - `deletedAt` string, date-time, nullable — When the carrier was soft deleted (null if active)

## Other responses

- `400` — Bad request - invalid input
- `401` — Unauthorized - invalid or missing access token
- `404` — Resource not found
- `409` — Conflict - resource already exists or constraint violation
- `500` — Internal server error

---

[API](https://skmtc.net/mvmnt/apis/mvmnt-api.md) · [All operations](https://skmtc.net/mvmnt/apis/mvmnt-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mvmnt/mvmnt-api/revisions/c44e5e7a4256/schema)