C.H. Robinson · Schema

invoiceSummary

All properties returned on the invoice get call.

FreightLogisticsShippingSupply ChainTransportationTransportation ManagementFortune 500

Properties

Name Type Description
invoiceNumber integer C.H. Robinson defined invoice number.
customerCode string C.H. Robinson defined code for a given customer i.e. C124516.
currencyCode object
invoiceAmount integer Currency amount of entire invoice.
invoiceBalance integer Remaining currency amount to be paid of entire invoice.
receivedAmount integer Currency amount C.H. Robinson has received as payment for the entire invoice.
invoiceDate string An ISO8601 UTC date-time indicating when order was invoiced.
dueDate string An ISO8601 UTC date-time indicating the date invoice must be paid.
releasedDate string An ISO8601 UTC date-time indicating when invoice was available.
printDate string An ISO8601 UTC date-time indicating when the invoice was provided to the customer.
invoiceShipments object
View JSON Schema on GitHub

JSON Schema

ch-robinson-worldwide-invoice-summary-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ch-robinson-worldwide/main/json-schema/ch-robinson-worldwide-invoice-summary-schema.json",
  "title": "invoiceSummary",
  "description": "All properties returned on the invoice get call.",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ch-robinson-worldwide-financials-api-openapi.yml#/components/schemas/invoiceSummary",
  "type": "object",
  "properties": {
    "invoiceNumber": {
      "type": "integer",
      "description": "C.H. Robinson defined invoice number."
    },
    "customerCode": {
      "type": "string",
      "description": "C.H. Robinson defined code for a given customer i.e. C124516."
    },
    "currencyCode": {
      "$ref": "#/$defs/currencyCodeEnum"
    },
    "invoiceAmount": {
      "type": "integer",
      "description": "Currency amount of entire invoice."
    },
    "invoiceBalance": {
      "type": "integer",
      "description": "Remaining currency amount to be paid of entire invoice."
    },
    "receivedAmount": {
      "type": "integer",
      "description": "Currency amount C.H. Robinson has received as payment for the entire invoice."
    },
    "invoiceDate": {
      "type": "string",
      "description": "An ISO8601 UTC date-time indicating when order was invoiced."
    },
    "dueDate": {
      "type": "string",
      "description": "An ISO8601 UTC date-time indicating the date invoice must be paid."
    },
    "releasedDate": {
      "type": "string",
      "description": "An ISO8601 UTC date-time indicating when invoice was available."
    },
    "printDate": {
      "type": "string",
      "format": "date-time",
      "description": "An ISO8601 UTC date-time indicating when the invoice was provided to the customer."
    },
    "invoiceShipments": {
      "$ref": "#/$defs/invoiceShipmentsWithRates"
    }
  },
  "$defs": {
    "currencyCodeEnum": {
      "type": "string",
      "description": "Code to indicate the currency being used. The most common currently in use with C.H. Robinson:\n\n* `USD` - US Dollar\n* `CAD` - Canadian Dollar \n* `MXN` - Mexican Peso\n* `EUR` - European Euro\n\n\n\nFor a detailed description of all enumerated codes please find them <a href=\"https://api.navisphere.com/api/B2B/Portal/v1/documents/descriptions/CurrencyCodeDescriptions.xlsx\" target=\"_blank\">here</a>.",
      "enum": [
        "USD",
        "CAD",
        "EUR",
        "MXN",
        "CHF",
        "GBP",
        "HUF",
        "CZK",
        "NZD",
        "PLN",
        "ZAR",
        "VEB",
        "VND",
        "TWD",
        "TRY",
        "SEK",
        "SGD",
        "RUB",
        "NOK",
        "HKD",
        "INR",
        "JPY",
        "CLP",
        "CNY",
        "DKK",
        "AUD",
        "BRL",
        "AED",
        "PEN",
        "THB",
        "ARS",
        "MYR",
        "VEF",
        "SAR",
        "BBD",
        "BHD",
        "BMD",
        "BSD",
        "ILS",
        "ISK",
        "KES",
        "KRW",
        "KWD",
        "OMR",
        "PHP",
        "PKR",
        "QAR",
        "RON",
        "TTD",
        "UAH",
        "LKR",
        "XPF",
        "UYU",
        "COP",
        "CRC",
        "FJD"
      ]
    },
    "invoiceRates": {
      "type": "array",
      "description": "Defines all charges properties",
      "items": {
        "type": "object",
        "properties": {
          "balance": {
            "type": "integer",
            "description": "Currency amount left to pay."
          },
          "notes": {
            "type": "string",
            "description": "Notes about the charge."
          },
          "totalRateAmount": {
            "type": "number",
            "description": "Total currency amount of specific charge."
          },
          "rateCode": {
            "$ref": "#/$defs/rateCodeEnum"
          },
          "ratePerUnit": {
            "type": "number",
            "description": "Amount of each unit."
          },
          "rateType": {
            "type": "string",
            "description": "Rate type"
          },
          "units": {
            "type": "number",
            "description": "Total count of units per rate."
          }
        }
      }
    },
    "invoiceShipmentsWithRates": {
      "type": "array",
      "description": "Contains detailed shipment charge information.",
      "items": {
        "type": "object",
        "properties": {
          "branchCode": {
            "type": "string",
            "description": "C.H Robinson code identifying the internal C.H. Robinson owning branch."
          },
          "chrOrderNumber": {
            "type": "integer",
            "description": "C.H. Robinson defined order number."
          },
          "currencyCode": {
            "$ref": "#/$defs/currencyCodeEnum"
          },
          "customerReferenceNumber": {
            "type": "string",
            "description": "Customer defined reference number."
          },
          "invoiceAmount": {
            "type": "integer",
            "description": "Total currency amount of shipment."
          },
          "invoiceBalance": {
            "type": "integer",
            "description": "Remaining currency amount left to be paid on the shipment."
          },
          "loadNumber": {
            "type": "integer",
            "format": "base32 integer",
            "description": "C.H. Robinson provided shipment identifier."
          },
          "receivedAmount": {
            "type": "integer",
            "description": "Currency amount C.H. Robinson has received as payment for the charge."
          },
          "salesRep": {
            "type": "string",
            "description": "C.H. Robinson representative's 7 letter."
          },
          "invoiceRates": {
            "$ref": "#/$defs/invoiceRates"
          }
        }
      }
    },
    "rateCodeEnum": {
      "type": "string",
      "description": "C.H. Robinson defined code for rating code. Here is a list of the most commonly used rate codes: \n\n`400` - Line Haul, `405` - Fuel Surchage, `260` - Deliver Surchage, `IDL` - Inside Delivery, `IPU` - Inside Pickup \n`LFT` - Lift Gate or Forklift Service, `DET` - Detention, `DLA` - Delivery Limited Access, `PLA` - Pickup Limited Access \n`RES` - Residential Delivery Fee, `REP` - Residential Pickup Fee, `CSD` - Construction Site Delivery <a href=\"https://api.navisphere.com/api/B2B/Portal/v1/documents/descriptions/RateCodeDescriptions.xlsx\" target=\"_blank\">here</a>.",
      "enum": [
        "Customer",
        "20",
        "55",
        "65",
        "115",
        "170",
        "180",
        "205",
        "215",
        "230",
        "260",
        "275",
        "280",
        "285",
        "300",
        "315",
        "350",
        "360",
        "365",
        "370",
        "385",
        "400",
        "405",
        "420",
        "425",
        "445",
        "450",
        "455",
        "470",
        "485",
        "495",
        "497",
        "510",
        "520",
        "540",
        "545",
        "590",
        "593",
        "605",
        "635",
        "665",
        "670",
        "685",
        "690",
        "695",
        "740",
        "761",
        "800",
        "801",
        "802",
        "803",
        "804",
        "898",
        "899",
        "900",
        "901",
        "902",
        "903",
        "904",
        "905",
        "906",
        "907",
        "908",
        "909",
        "910",
        "911",
        "ACC",
        "AGR",
        "AGS",
        "AIR",
        "ALH",
        "AMC",
        "AMS",
        "APT",
        "ATR",
        "BAT",
        "BIO",
        "BLC",
        "BLK",
        "BND",
        "BRD",
        "BSC",
        "CAA",
        "CEX",
        "CHE",
        "CHN",
        "CIS",
        "CLA",
        "CLN",
        "CLS",
        "CNS",
        "COA",
        "COL",
        "COU",
        "CPC",
        "CPE",
        "CRE",
        "CRS",
        "CSE",
        "CTC",
        "CTG",
        "CTL",
        "CUF",
        "CUS",
        "DAM",
        "DCF",
        "DEL",
        "DEN",
        "DEP",
        "DET",
        "DFD",
        "DFG",
        "DHF",
        "DIC",
        "DIS",
        "DMC",
        "DOC",
        "DOV",
        "DRC",
        "DRF",
        "DSC",
        "DTC",
        "DTL",
        "DTU",
        "DTV",
        "DUT",
        "DYA",
        "EBD",
        "EEX",
        "EMT",
        "ENC",
        "ESD",
        "EUC",
        "EXC",
        "EXD",
        "EXL",
        "EXM",
        "EXP",
        "EXR",
        "EXW",
        "FDA",
        "FDT",
        "FFR",
        "FLP",
        "FTH",
        "FTW",
        "FTZ",
        "FWA",
        "FWC",
        "GST",
        "HMF",
        "HOL",
        "HST",
        "IDL",
        "IFS",
        "IHT",
        "INC",
        "INS",
        "INV",
        "IPU",
        "ISO",
        "IST",
        "ITS",
        "LAA",
        "LAY",
        "LEC",
        "LFT",
        "LMF",
        "LOA",
        "LOC",
        "MIC",
        "MPF",
        "MRK",
        "MSG",
        "NDD",
        "NYD",
        "NYP",
        "OFU",
        "OHF",
        "OPT",
        "ORD",
        "ORF",
        "ORM",
        "OVR",
        "PAE",
        "PCS",
        "PEC",
        "PER",
        "PFA",
        "PKG",
        "PMT",
        "POD",
        "PPH",
        "PPN",
        "PRT",
        "PSC",
        "PSH",
        "PSS",
        "PST",
        "PUC",
        "QST",
        "RAJ",
        "RCC",
        "RCL",
        "REC",
        "REF",
        "REP",
        "RES",
        "RET",
        "SAT",
        "SCL",
        "SCS",
        "SDL",
        "SEC",
        "SEG",
        "SER",
        "SET",
        "SOC",
        "SPS",
        "SPT",
        "SRA",
        "SRG",
        "SUR",
        "SYA",
        "TAK",
        "TAL",
        "TAR",
        "TDT",
        "THC",
        "TMF",
        "TRC",
        "TRL",
        "TTC",
        "UNL",
        "URC",
        "VOR",
        "WAR",
        "WBF",
        "WBL",
        "WCT",
        "WDC",
        "WFL",
        "WHC",
        "WHF",
        "WIO",
        "WIS",
        "WKT",
        "WLB",
        "WLC",
        "WLS",
        "WMS",
        "WOP",
        "WOT",
        "WPC",
        "WPK",
        "WPL",
        "WPP",
        "WRC",
        "WRE",
        "WRI",
        "WRS",
        "WSS",
        "WSW",
        "WTV",
        "WWT",
        "WXD",
        "XTN",
        "496",
        "BYD",
        "BYP",
        "DCV",
        "ICT",
        "PDD",
        "PDO",
        "TSA",
        "UND",
        "HAZ",
        "ISF",
        "913",
        "914",
        "915",
        "916",
        "316",
        "BPC",
        "BPR",
        "BPS",
        "BPT",
        "CEM",
        "CMX",
        "COT",
        "CUV",
        "MXC",
        "MXH",
        "MXR",
        "MXV",
        "OVT",
        "PEN",
        "CTS",
        "LRC",
        "AMF",
        "BPI",
        "SCR",
        "AES",
        "NAV",
        "DLA",
        "PLA",
        "PSF",
        "CSF",
        "894",
        "895",
        "896",
        "897",
        "EMN",
        "SPF",
        "TSC",
        "HCR",
        "CNT",
        "CMM",
        "RNT",
        "PRF",
        "CSD",
        "HCD",
        "CSP",
        "GVP",
        "GVD",
        "HCP",
        "NCP",
        "NCD",
        "BUV",
        "COW",
        "HOS",
        "INP",
        "RAP",
        "SIE",
        "TAW",
        "OTD",
        "MES",
        "ENS",
        "ACF",
        "SLF",
        "BLR",
        "FLT",
        "917",
        "FCP",
        "GSI",
        "SMA",
        "CFI",
        "EXT",
        "EXY",
        "AAI",
        "CAS",
        "CCF",
        "CMC",
        "DCC",
        "DOF",
        "EDC",
        "EMS",
        "ERF",
        "FLC",
        "FUC",
        "GAS",
        "GTA",
        "HBL",
        "LBE",
        "LUC",
        "MLC",
        "PAC",
        "PCH",
        "PRC",
        "PRS",
        "PUD",
        "SCH",
        "STR",
        "STU",
        "TPA",
        "OCT",
        "STC",
        "EPC",
        "DPC",
        "STD",
        "RFC",
        "SYC",
        "SED",
        "MEC",
        "SUF",
        "IAC",
        "CFS",
        "BTF",
        "ESS",
        "AMD",
        "ORC",
        "LIF",
        "PCF",
        "GIO",
        "TLX",
        "GAT",
        "LBL",
        "LCG",
        "LBF",
        "HLS",
        "IMP",
        "CIF",
        "CCE",
        "EDN",
        "HET",
        "PMU",
        "HEL",
        "STM",
        "TOL",
        "VAC",
        "PRP",
        "PDC",
        "SBC",
        "PFC",
        "TDR",
        "OTH",
        "DTH",
        "ODO",
        "DDO",
        "AWB",
        "CYC",
        "DEC",
        "FAF",
        "GRI",
        "LCL",
        "PCC",
        "PPF",
        "TPF",
        "WVF",
        "CSR",
        "27",
        "GSC",
        "ATC",
        "ECV",
        "GAR",
        "BTR",
        "CRD",
        "IVT",
        "TAP",
        "SEN",
        "IVP",
        "IBP",
        "COC",
        "DRY",
        "FOB",
        "EWC",
        "HTS",
        "DSB",
        "HTC",
        "FAH",
        "EIC",
        "NPC",
        "LSF",
        "AHD",
        "ESV",
        "FCC",
        "PEP",
        "OGA",
        "MFE",
        "CAH",
        "GOA",
        "75",
        "CBT",
        "DCT",
        "921",
        "922",
        "COV",
        "DBR",
        "IAT",
        "POM",
        "ACI",
        "ASF",
        "BOK",
        "CDD",
        "CDF",
        "COF",
        "CVE",
        "DCH",
        "DDP",
        "DKF",
        "DMI",
        "ESC",
        "EXA",
        "EXO",
        "LCH",
        "PES",
        "VMS",
        "SRC",
        "CFE",
        "CDA",
        "IEC",
        "DGS",
        "HAS",
        "701",
        "750",
        "751",
        "753",
        "754",
        "755",
        "756",
        "1401",
        "1402",
        "1403",
        "DTF",
        "OTF",
        "SRD",
        "SRO",
        "1900",
        "2000",
        "2100",
        "INF",
        "DDT",
        "DUF",
        "EMF",
        "LYO",
        "LYD",
        "999",
        "145",
        "ADV",
        "AMB",
        "ARB",
        "BEY",
        "BKA",
        "BSS",
        "CBL",
        "CFL",
        "CTF",
        "DAA",
        "DEM",
        "FAK",
        "FCB",
        "GSS",
        "HAN",
        "HHB",
        "HRS",
        "HZC",
        "IFC",
        "LAB",
        "LFC",
        "MIN",
        "MNC",
        "MSC",
        "OCH",
        "PIR",
        "POS",
        "PTS",
        "PWT",
        "PYS",
        "RAM",
        "RLS",
        "RMC",
        "SPC",
        "SSF",
        "STO",
        "STP",
        "SWC",
        "TAY",
        "TER",
        "TRM",
        "WEA",
        "WFG",
        "WFH",
        "IFF",
        "CME",
        "MDF",
        "CPV",
        "EMA",
        "EPF",
        "TPC",
        "GOF",
        "LOM",
        "ISE",
        "STF",
        "CSU",
        "AHF",
        "MEF",
        "FID",
        "LCK",
        "BYC",
        "BCD",
        "SO1",
        "SO2",
        "SO3",
        "COR",
        "TRE",
        "LSK",
        "DON",
        "CTM",
        "DCK",
        "RPK",
        "FGT",
        "CHF",
        "BRF",
        "MKF",
        "FES",
        "CLM",
        "PDR",
        "AVP",
        "GBB",
        "GLF",
        "GLT",
        "MOTLF",
        "MOTMF",
        "TROLF",
        "TROMF",
        "REBAT",
        "ASCMB",
        "SPCRV",
        "SPCAS",
        "PENNY",
        "WELLF",
        "WELMF",
        "BAMLF",
        "BAMMF",
        "SWTLF",
        "ECOLF",
        "ECOMF",
        "SRVLF",
        "SRVMF",
        "N22LF",
        "N23LF",
        "OURLF",
        "GLYLF",
        "GLYMF",
        "PNKLF",
        "PECLF",
        "GRNLF",
        "SWTMF",
        "MKU",
        "EVC",
        "APA",
        "ARA",
        "GAV",
        "REB",
        "SEL",
        "ABG",
        "ICG",
        "TET",
        "PAF",
        "OSO",
        "RSP",
        "MIF",
        "SPL",
        "SPA",
        "SPO",
        "AFS",
        "NCH",
        "ASM",
        "LGP",
        "444",
        "CNA",
        "DEB",
        "DOM",
        "EGY",
        "FER",
        "FIM",
        "FOR",
        "FRA",
        "FUM",
        "HRT",
        "MAU",
        "PCD",
        "PNL",
        "PPC",
        "RED",
        "REI",
        "SLU",
        "VET",
        "WAS",
        "WAT",
        "BIN",
        "206",
        "PLS",
        "OCS",
        "TPS",
        "BUP",
        "RBU",
        "CMR",
        "SPQ",
        "IMF",
        "IMV",
        "BLD",
        "1404",
        "1405",
        "1406",
        "ENF",
        "ENV",
        "PRO",
        "PRV",
        "WAF",
        "WAV",
        "EPS",
        "AKS",
        "CCT",
        "ECC",
        "HIS",
        "PRD",
        "TRR",
        "RIT",
        "GIT",
        "BAC",
        "CCR",
        "CLC",
        "DCR",
        "SC1",
        "FCH",
        "AFC",
        "WMF",
        "IFP",
        "OSP",
        "OCP",
        "DSP",
        "DCP",
        "CBC",
        "BRT",
        "ECH",
        "OID",
        "OCR",
        "RPT",
        "SOS",
        "TGS",
        "TKP",
        "WSC",
        "SFA",
        "HHC",
        "RHC",
        "IFA",
        "FLB",
        "LWS",
        "MFD",
        "SEP",
        "SCA",
        "PHL",
        "JAM",
        "VGM",
        "HSB",
        "PFS",
        "CCS",
        "DTY",
        "RNR",
        "RCD",
        "DRP",
        "PKU",
        "EBP",
        "LFD",
        "CPL",
        "AGM",
        "APH",
        "FSI",
        "FWS",
        "NHT",
        "EPA",
        "CPS",
        "USL",
        "NMF",
        "RCO",
        "ROS",
        "OVS",
        "TIV",
        "TMR",
        "RER",
        "FTA",
        "RBY",
        "RBI",
        "RBV",
        "RBE",
        "WAC",
        "ABT",
        "CON",
        "QCC",
        "SUN",
        "SBS",
        "SDV",
        "NGT",
        "GTD",
        "ASR",
        "SGR",
        "SOG",
        "1013",
        "101",
        "1014",
        "DTZ",
        "919",
        "923",
        "WTT"
      ]
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/ch-robinson-worldwide-invoice-summary"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.