--- title: "Filter carriers" method: POST path: "/carriers/filter" tags: ["Carriers"] --- # Filter carriers `POST /carriers/filter` Query carriers using flexible filter criteria with AND/OR logic. By default, only non-deleted carriers are returned (deletedAt: { isNull: true }). Override this by explicitly setting deletedAt filter criteria. Returns carriers of all types (TRUCKLOAD, AIR, CARTAGE, LINEHAUL, LTL, OCEAN, RAIL) with type-specific fields included based on carrier type. ## Request body - CarrierFilterRequest — Request body for filtering carriers - `filter` CarrierFilter — Filter criteria for carriers with AND/OR logic support - `and` CarrierFilter[] — All conditions must match (recursive) - `or` CarrierFilter[] — At least one condition must match (recursive) - `not` CarrierFilter — recursive - `id` IDFilter — Filter options for ID fields (limited operations - exact match only) - `equalTo` string, uuid — Exact match - `in` string[] — Matches any UUID in the array - `friendlyId` StringFilter — Filter options for string fields - `equalTo` string — Exact match - `notEqualTo` string — Not equal to - `in` string[] — Matches any value in the array - `notIn` string[] — Does not match any value in the array - `includes` string — Contains substring (case-insensitive) - `notIncludes` string — Does not contain substring (case-insensitive) - `startsWith` string — Starts with prefix (case-insensitive) - `notStartsWith` string — Does not start with prefix (case-insensitive) - `endsWith` string — Ends with suffix (case-insensitive) - `notEndsWith` string — Does not end with suffix (case-insensitive) - `isNull` boolean — Field is null (true) or not null (false) - `name` StringFilter — Filter options for string fields - `equalTo` string — Exact match - `notEqualTo` string — Not equal to - `in` string[] — Matches any value in the array - `notIn` string[] — Does not match any value in the array - `includes` string — Contains substring (case-insensitive) - `notIncludes` string — Does not contain substring (case-insensitive) - `startsWith` string — Starts with prefix (case-insensitive) - `notStartsWith` string — Does not start with prefix (case-insensitive) - `endsWith` string — Ends with suffix (case-insensitive) - `notEndsWith` string — Does not end with suffix (case-insensitive) - `isNull` boolean — Field is null (true) or not null (false) - `dbaName` StringFilter — Filter options for string fields - `equalTo` string — Exact match - `notEqualTo` string — Not equal to - `in` string[] — Matches any value in the array - `notIn` string[] — Does not match any value in the array - `includes` string — Contains substring (case-insensitive) - `notIncludes` string — Does not contain substring (case-insensitive) - `startsWith` string — Starts with prefix (case-insensitive) - `notStartsWith` string — Does not start with prefix (case-insensitive) - `endsWith` string — Ends with suffix (case-insensitive) - `notEndsWith` string — Does not end with suffix (case-insensitive) - `isNull` boolean — Field is null (true) or not null (false) - `key` ClientKeyFilter — Filter options for client key fields (limited operations - exact match only) - `equalTo` string — Exact match - `in` string[] — Matches any value in the array - `isNull` boolean — Field is null (true) or not null (false) - `email` StringFilter — Filter options for string fields - `equalTo` string — Exact match - `notEqualTo` string — Not equal to - `in` string[] — Matches any value in the array - `notIn` string[] — Does not match any value in the array - `includes` string — Contains substring (case-insensitive) - `notIncludes` string — Does not contain substring (case-insensitive) - `startsWith` string — Starts with prefix (case-insensitive) - `notStartsWith` string — Does not start with prefix (case-insensitive) - `endsWith` string — Ends with suffix (case-insensitive) - `notEndsWith` string — Does not end with suffix (case-insensitive) - `isNull` boolean — Field is null (true) or not null (false) - `phone` StringFilter — Filter options for string fields - `equalTo` string — Exact match - `notEqualTo` string — Not equal to - `in` string[] — Matches any value in the array - `notIn` string[] — Does not match any value in the array - `includes` string — Contains substring (case-insensitive) - `notIncludes` string — Does not contain substring (case-insensitive) - `startsWith` string — Starts with prefix (case-insensitive) - `notStartsWith` string — Does not start with prefix (case-insensitive) - `endsWith` string — Ends with suffix (case-insensitive) - `notEndsWith` string — Does not end with suffix (case-insensitive) - `isNull` boolean — Field is null (true) or not null (false) - `website` StringFilter — Filter options for string fields - `equalTo` string — Exact match - `notEqualTo` string — Not equal to - `in` string[] — Matches any value in the array - `notIn` string[] — Does not match any value in the array - `includes` string — Contains substring (case-insensitive) - `notIncludes` string — Does not contain substring (case-insensitive) - `startsWith` string — Starts with prefix (case-insensitive) - `notStartsWith` string — Does not start with prefix (case-insensitive) - `endsWith` string — Ends with suffix (case-insensitive) - `notEndsWith` string — Does not end with suffix (case-insensitive) - `isNull` boolean — Field is null (true) or not null (false) - `status` StringFilter — Filter options for string fields - `equalTo` string — Exact match - `notEqualTo` string — Not equal to - `in` string[] — Matches any value in the array - `notIn` string[] — Does not match any value in the array - `includes` string — Contains substring (case-insensitive) - `notIncludes` string — Does not contain substring (case-insensitive) - `startsWith` string — Starts with prefix (case-insensitive) - `notStartsWith` string — Does not start with prefix (case-insensitive) - `endsWith` string — Ends with suffix (case-insensitive) - `notEndsWith` string — Does not end with suffix (case-insensitive) - `isNull` boolean — Field is null (true) or not null (false) - `statusReason` StringFilter — Filter options for string fields - `equalTo` string — Exact match - `notEqualTo` string — Not equal to - `in` string[] — Matches any value in the array - `notIn` string[] — Does not match any value in the array - `includes` string — Contains substring (case-insensitive) - `notIncludes` string — Does not contain substring (case-insensitive) - `startsWith` string — Starts with prefix (case-insensitive) - `notStartsWith` string — Does not start with prefix (case-insensitive) - `endsWith` string — Ends with suffix (case-insensitive) - `notEndsWith` string — Does not end with suffix (case-insensitive) - `isNull` boolean — Field is null (true) or not null (false) - `type` StringFilter — Filter options for string fields - `equalTo` string — Exact match - `notEqualTo` string — Not equal to - `in` string[] — Matches any value in the array - `notIn` string[] — Does not match any value in the array - `includes` string — Contains substring (case-insensitive) - `notIncludes` string — Does not contain substring (case-insensitive) - `startsWith` string — Starts with prefix (case-insensitive) - `notStartsWith` string — Does not start with prefix (case-insensitive) - `endsWith` string — Ends with suffix (case-insensitive) - `notEndsWith` string — Does not end with suffix (case-insensitive) - `isNull` boolean — Field is null (true) or not null (false) - `mcNumber` StringFilter — Filter options for string fields - `equalTo` string — Exact match - `notEqualTo` string — Not equal to - `in` string[] — Matches any value in the array - `notIn` string[] — Does not match any value in the array - `includes` string — Contains substring (case-insensitive) - `notIncludes` string — Does not contain substring (case-insensitive) - `startsWith` string — Starts with prefix (case-insensitive) - `notStartsWith` string — Does not start with prefix (case-insensitive) - `endsWith` string — Ends with suffix (case-insensitive) - `notEndsWith` string — Does not end with suffix (case-insensitive) - `isNull` boolean — Field is null (true) or not null (false) - `dotNumber` StringFilter — Filter options for string fields - `equalTo` string — Exact match - `notEqualTo` string — Not equal to - `in` string[] — Matches any value in the array - `notIn` string[] — Does not match any value in the array - `includes` string — Contains substring (case-insensitive) - `notIncludes` string — Does not contain substring (case-insensitive) - `startsWith` string — Starts with prefix (case-insensitive) - `notStartsWith` string — Does not start with prefix (case-insensitive) - `endsWith` string — Ends with suffix (case-insensitive) - `notEndsWith` string — Does not end with suffix (case-insensitive) - `isNull` boolean — Field is null (true) or not null (false) - `scac` StringFilter — Filter options for string fields - `equalTo` string — Exact match - `notEqualTo` string — Not equal to - `in` string[] — Matches any value in the array - `notIn` string[] — Does not match any value in the array - `includes` string — Contains substring (case-insensitive) - `notIncludes` string — Does not contain substring (case-insensitive) - `startsWith` string — Starts with prefix (case-insensitive) - `notStartsWith` string — Does not start with prefix (case-insensitive) - `endsWith` string — Ends with suffix (case-insensitive) - `notEndsWith` string — Does not end with suffix (case-insensitive) - `isNull` boolean — Field is null (true) or not null (false) - `einNumber` StringFilter — Filter options for string fields - `equalTo` string — Exact match - `notEqualTo` string — Not equal to - `in` string[] — Matches any value in the array - `notIn` string[] — Does not match any value in the array - `includes` string — Contains substring (case-insensitive) - `notIncludes` string — Does not contain substring (case-insensitive) - `startsWith` string — Starts with prefix (case-insensitive) - `notStartsWith` string — Does not start with prefix (case-insensitive) - `endsWith` string — Ends with suffix (case-insensitive) - `notEndsWith` string — Does not end with suffix (case-insensitive) - `isNull` boolean — Field is null (true) or not null (false) - `ffNumber` StringFilter — Filter options for string fields - `equalTo` string — Exact match - `notEqualTo` string — Not equal to - `in` string[] — Matches any value in the array - `notIn` string[] — Does not match any value in the array - `includes` string — Contains substring (case-insensitive) - `notIncludes` string — Does not contain substring (case-insensitive) - `startsWith` string — Starts with prefix (case-insensitive) - `notStartsWith` string — Does not start with prefix (case-insensitive) - `endsWith` string — Ends with suffix (case-insensitive) - `notEndsWith` string — Does not end with suffix (case-insensitive) - `isNull` boolean — Field is null (true) or not null (false) - `mxNumber` StringFilter — Filter options for string fields - `equalTo` string — Exact match - `notEqualTo` string — Not equal to - `in` string[] — Matches any value in the array - `notIn` string[] — Does not match any value in the array - `includes` string — Contains substring (case-insensitive) - `notIncludes` string — Does not contain substring (case-insensitive) - `startsWith` string — Starts with prefix (case-insensitive) - `notStartsWith` string — Does not start with prefix (case-insensitive) - `endsWith` string — Ends with suffix (case-insensitive) - `notEndsWith` string — Does not end with suffix (case-insensitive) - `isNull` boolean — Field is null (true) or not null (false) - `rfcNumber` StringFilter — Filter options for string fields - `equalTo` string — Exact match - `notEqualTo` string — Not equal to - `in` string[] — Matches any value in the array - `notIn` string[] — Does not match any value in the array - `includes` string — Contains substring (case-insensitive) - `notIncludes` string — Does not contain substring (case-insensitive) - `startsWith` string — Starts with prefix (case-insensitive) - `notStartsWith` string — Does not start with prefix (case-insensitive) - `endsWith` string — Ends with suffix (case-insensitive) - `notEndsWith` string — Does not end with suffix (case-insensitive) - `isNull` boolean — Field is null (true) or not null (false) - `iataCode` StringFilter — Filter options for string fields - `equalTo` string — Exact match - `notEqualTo` string — Not equal to - `in` string[] — Matches any value in the array - `notIn` string[] — Does not match any value in the array - `includes` string — Contains substring (case-insensitive) - `notIncludes` string — Does not contain substring (case-insensitive) - `startsWith` string — Starts with prefix (case-insensitive) - `notStartsWith` string — Does not start with prefix (case-insensitive) - `endsWith` string — Ends with suffix (case-insensitive) - `notEndsWith` string — Does not end with suffix (case-insensitive) - `isNull` boolean — Field is null (true) or not null (false) - `isHazmat` BooleanFilter — Filter options for boolean fields - `equalTo` boolean — Exact match - `notEqualTo` boolean — Not equal to - `isNull` boolean — Field is null (true) or not null (false) - `tsaApproved` BooleanFilter — Filter options for boolean fields - `equalTo` boolean — Exact match - `notEqualTo` boolean — Not equal to - `isNull` boolean — Field is null (true) or not null (false) - `trucks` IntFilter — Filter options for integer fields - `equalTo` integer — Exact match - `notEqualTo` integer — Not equal to - `lessThan` integer — Less than - `lessThanOrEqualTo` integer — Less than or equal to - `greaterThan` integer — Greater than - `greaterThanOrEqualTo` integer — Greater than or equal to - `in` integer[] — Matches any value in the array - `notIn` integer[] — Does not match any value in the array - `isNull` boolean — Field is null (true) or not null (false) - `trailers` IntFilter — Filter options for integer fields - `equalTo` integer — Exact match - `notEqualTo` integer — Not equal to - `lessThan` integer — Less than - `lessThanOrEqualTo` integer — Less than or equal to - `greaterThan` integer — Greater than - `greaterThanOrEqualTo` integer — Greater than or equal to - `in` integer[] — Matches any value in the array - `notIn` integer[] — Does not match any value in the array - `isNull` boolean — Field is null (true) or not null (false) - `drivers` IntFilter — Filter options for integer fields - `equalTo` integer — Exact match - `notEqualTo` integer — Not equal to - `lessThan` integer — Less than - `lessThanOrEqualTo` integer — Less than or equal to - `greaterThan` integer — Greater than - `greaterThanOrEqualTo` integer — Greater than or equal to - `in` integer[] — Matches any value in the array - `notIn` integer[] — Does not match any value in the array - `isNull` boolean — Field is null (true) or not null (false) - `powerUnits` IntFilter — Filter options for integer fields - `equalTo` integer — Exact match - `notEqualTo` integer — Not equal to - `lessThan` integer — Less than - `lessThanOrEqualTo` integer — Less than or equal to - `greaterThan` integer — Greater than - `greaterThanOrEqualTo` integer — Greater than or equal to - `in` integer[] — Matches any value in the array - `notIn` integer[] — Does not match any value in the array - `isNull` boolean — Field is null (true) or not null (false) - `currency` StringFilter — Filter options for string fields - `equalTo` string — Exact match - `notEqualTo` string — Not equal to - `in` string[] — Matches any value in the array - `notIn` string[] — Does not match any value in the array - `includes` string — Contains substring (case-insensitive) - `notIncludes` string — Does not contain substring (case-insensitive) - `startsWith` string — Starts with prefix (case-insensitive) - `notStartsWith` string — Does not start with prefix (case-insensitive) - `endsWith` string — Ends with suffix (case-insensitive) - `notEndsWith` string — Does not end with suffix (case-insensitive) - `isNull` boolean — Field is null (true) or not null (false) - `isFactoringPreferred` BooleanFilter — Filter options for boolean fields - `equalTo` boolean — Exact match - `notEqualTo` boolean — Not equal to - `isNull` boolean — Field is null (true) or not null (false) - `goldenCarrierId` UUIDFilter — Filter options for UUID fields (all operations) - `equalTo` string, uuid — Exact match - `notEqualTo` string, uuid — Not equal to - `in` string[] — Matches any UUID in the array - `notIn` string[] — Does not match any UUID in the array - `isNull` boolean — Field is null (true) or not null (false) - `paymentTermId` UUIDFilter — Filter options for UUID fields (all operations) - `equalTo` string, uuid — Exact match - `notEqualTo` string, uuid — Not equal to - `in` string[] — Matches any UUID in the array - `notIn` string[] — Does not match any UUID in the array - `isNull` boolean — Field is null (true) or not null (false) - `rating` StringFilter — Filter options for string fields - `equalTo` string — Exact match - `notEqualTo` string — Not equal to - `in` string[] — Matches any value in the array - `notIn` string[] — Does not match any value in the array - `includes` string — Contains substring (case-insensitive) - `notIncludes` string — Does not contain substring (case-insensitive) - `startsWith` string — Starts with prefix (case-insensitive) - `notStartsWith` string — Does not start with prefix (case-insensitive) - `endsWith` string — Ends with suffix (case-insensitive) - `notEndsWith` string — Does not end with suffix (case-insensitive) - `isNull` boolean — Field is null (true) or not null (false) - `ratingDate` DatetimeFilter — Filter options for datetime fields - `equalTo` string, date-time — Exact match - `notEqualTo` string, date-time — Not equal to - `lessThan` string, date-time — Before this datetime - `lessThanOrEqualTo` string, date-time — On or before this datetime - `greaterThan` string, date-time — After this datetime - `greaterThanOrEqualTo` string, date-time — On or after this datetime - `isNull` boolean — Field is null (true) or not null (false) - `operatingAbility` StringFilter — Filter options for string fields - `equalTo` string — Exact match - `notEqualTo` string — Not equal to - `in` string[] — Matches any value in the array - `notIn` string[] — Does not match any value in the array - `includes` string — Contains substring (case-insensitive) - `notIncludes` string — Does not contain substring (case-insensitive) - `startsWith` string — Starts with prefix (case-insensitive) - `notStartsWith` string — Does not start with prefix (case-insensitive) - `endsWith` string — Ends with suffix (case-insensitive) - `notEndsWith` string — Does not end with suffix (case-insensitive) - `isNull` boolean — Field is null (true) or not null (false) - `inFmcsa` BooleanFilter — Filter options for boolean fields - `equalTo` boolean — Exact match - `notEqualTo` boolean — Not equal to - `isNull` boolean — Field is null (true) or not null (false) - `insuranceCompany` StringFilter — Filter options for string fields - `equalTo` string — Exact match - `notEqualTo` string — Not equal to - `in` string[] — Matches any value in the array - `notIn` string[] — Does not match any value in the array - `includes` string — Contains substring (case-insensitive) - `notIncludes` string — Does not contain substring (case-insensitive) - `startsWith` string — Starts with prefix (case-insensitive) - `notStartsWith` string — Does not start with prefix (case-insensitive) - `endsWith` string — Ends with suffix (case-insensitive) - `notEndsWith` string — Does not end with suffix (case-insensitive) - `isNull` boolean — Field is null (true) or not null (false) - `insuranceExpirationDate` DatetimeFilter — Filter options for datetime fields - `equalTo` string, date-time — Exact match - `notEqualTo` string, date-time — Not equal to - `lessThan` string, date-time — Before this datetime - `lessThanOrEqualTo` string, date-time — On or before this datetime - `greaterThan` string, date-time — After this datetime - `greaterThanOrEqualTo` string, date-time — On or after this datetime - `isNull` boolean — Field is null (true) or not null (false) - `createdAt` DatetimeFilter — Filter options for datetime fields - `equalTo` string, date-time — Exact match - `notEqualTo` string, date-time — Not equal to - `lessThan` string, date-time — Before this datetime - `lessThanOrEqualTo` string, date-time — On or before this datetime - `greaterThan` string, date-time — After this datetime - `greaterThanOrEqualTo` string, date-time — On or after this datetime - `isNull` boolean — Field is null (true) or not null (false) - `updatedAt` DatetimeFilter — Filter options for datetime fields - `equalTo` string, date-time — Exact match - `notEqualTo` string, date-time — Not equal to - `lessThan` string, date-time — Before this datetime - `lessThanOrEqualTo` string, date-time — On or before this datetime - `greaterThan` string, date-time — After this datetime - `greaterThanOrEqualTo` string, date-time — On or after this datetime - `isNull` boolean — Field is null (true) or not null (false) - `deletedAt` DatetimeFilter — Filter options for datetime fields - `equalTo` string, date-time — Exact match - `notEqualTo` string, date-time — Not equal to - `lessThan` string, date-time — Before this datetime - `lessThanOrEqualTo` string, date-time — On or before this datetime - `greaterThan` string, date-time — After this datetime - `greaterThanOrEqualTo` string, date-time — On or after this datetime - `isNull` boolean — Field is null (true) or not null (false) - `pageSize` integer — Number of results per page - `cursor` string — Pagination cursor for next page ## Response `200` Filtered carriers with pagination - object - `data` Carrier[], required - 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 - `state` string, nullable — State or province code - `zipCode` string, nullable — Postal / ZIP code - `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 - `state` string, nullable — State or province code - `zipCode` string, nullable — Postal / ZIP code - `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' | 'E_TRANSFER' | 'EFT_DIRECT_DEPOSIT' | 'SPEI', 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 - `state` string, nullable — State or province code - `zipCode` string, nullable — Postal / ZIP code - `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 - `state` string, nullable — State or province code - `zipCode` string, nullable — Postal / ZIP code - `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' | 'E_TRANSFER' | 'EFT_DIRECT_DEPOSIT' | 'SPEI', 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 - `state` string, nullable — State or province code - `zipCode` string, nullable — Postal / ZIP code - `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 - `state` string, nullable — State or province code - `zipCode` string, nullable — Postal / ZIP code - `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' | 'E_TRANSFER' | 'EFT_DIRECT_DEPOSIT' | 'SPEI', 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 - `state` string, nullable — State or province code - `zipCode` string, nullable — Postal / ZIP code - `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 - `state` string, nullable — State or province code - `zipCode` string, nullable — Postal / ZIP code - `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' | 'E_TRANSFER' | 'EFT_DIRECT_DEPOSIT' | 'SPEI', 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 - `state` string, nullable — State or province code - `zipCode` string, nullable — Postal / ZIP code - `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 - `state` string, nullable — State or province code - `zipCode` string, nullable — Postal / ZIP code - `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' | 'E_TRANSFER' | 'EFT_DIRECT_DEPOSIT' | 'SPEI', 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 - `state` string, nullable — State or province code - `zipCode` string, nullable — Postal / ZIP code - `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 - `state` string, nullable — State or province code - `zipCode` string, nullable — Postal / ZIP code - `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' | 'E_TRANSFER' | 'EFT_DIRECT_DEPOSIT' | 'SPEI', 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 - `state` string, nullable — State or province code - `zipCode` string, nullable — Postal / ZIP code - `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 - `state` string, nullable — State or province code - `zipCode` string, nullable — Postal / ZIP code - `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' | 'E_TRANSFER' | 'EFT_DIRECT_DEPOSIT' | 'SPEI', 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) - AgentCarrier — Agent (interline/partner agent) carrier - `object` 'CARRIER' — Object type identifier - `id` string, uuid, required — Unique carrier identifier - `friendlyId` string, required — Human-readable carrier identifier - `type` 'AGENT', 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 - `state` string, nullable — State or province code - `zipCode` string, nullable — Postal / ZIP code - `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 - `state` string, nullable — State or province code - `zipCode` string, nullable — Postal / ZIP code - `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' | 'E_TRANSFER' | 'EFT_DIRECT_DEPOSIT' | 'SPEI', 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) - `pageInfo` PaginationInfo, required - `pageSize` integer, required — Number of items per page - `hasNextPage` boolean, required — Whether there are more pages - `hasPreviousPage` boolean — Whether there are previous pages - `endCursor` string, nullable — Cursor for the next page (null if no next page) ## Other responses - `400` — Bad request - invalid input - `401` — Unauthorized - invalid or missing access token - `500` — Internal server error --- [API](https://skmtc.dev/mvmnt/apis/mvmnt-api.md) · [All operations](https://skmtc.dev/mvmnt/apis/mvmnt-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mvmnt/mvmnt-api/revisions/7af4e91459ca/schema)