Skip to main content
API docs by Redocly

Loop API (0.1)

The HTTP REST API for Loop.

loop

artifacts

Retrieve a list of artifact ingestion states

Returns a list of artifact ingestion states.

Authorizations:
bearer
query Parameters
completedBefore
string <utc-timestamp>
Example: completedBefore=2020-01-01T00:00:00.000Z

Filter to only results that have been marked as completed before this timestamp. This can be a UTC timestamp or a floating date. If a floating date is passed, the timestamp used will be the beginning (midnight UTC) of the date.

completedAfter
string <utc-timestamp>
Example: completedAfter=2020-01-01T00:00:00.000Z

Filter to only results that have been marked as completed after this timestamp. This can be a UTC timestamp or a floating date. If a floating date is passed, the timestamp used will be the beginning (midnight UTC) of the date.

first
number

The number of results to return. Default value is 10. Any custom value specified must lie between 0 and 100, inclusive.

after
string

The cursor to start returning results from

Responses

Response Schema: application/json
Array of objects (ArtifactIngestionState)
object

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "artifactQid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "artifactType": "INVOICE",
      • "artifactFormat": "PDF",
      • "preprocessingStatus": {
        • "status": "IN_PROGRESS"
        },
      • "screeningStatus": {
        • "status": "IN_PROGRESS"
        },
      • "categorizationStatus": {
        • "status": "IN_PROGRESS"
        },
      • "derivedArtifactIngestionStates": [
        • { }
        ],
      • "assignedShipmentJobStatuses": [
        • {
          • "status": "IN_PROGRESS",
          • "qid": { }
          }
        ],
      • "assignedPayableInvoiceStatuses": [
        • {
          • "status": "IN_PROGRESS"
          }
        ],
      • "aggregateIngestionStatus": {
        • "status": "COMPLETED"
        }
      }
    ],
  • "pageInfo": {
    • "hasPreviousPage": true,
    • "hasNextPage": true,
    • "startCursor": "string",
    • "endCursor": "string"
    }
}

Retrieve the artifact ingestion state for an artifact

Authorizations:
bearer
path Parameters
qid
required
string <qid>
Example: qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c5

QID of the entity to retrieve

Responses

Response Schema: application/json
artifactQid
required
string <qid>

Qualified unique identifier.

artifactType
required
string
Enum: "BILL_OF_LADING" "DELIVERY_ORDER" "DELIVERY_RECEIPT" "INVOICE" "LUMPER_RECEIPT" "OTHER" "PACKET" "PACKING_LIST" "RATE_CONFIRMATION" "SHIPMENT_RECORD" "UNKNOWN" "WEIGHT_INSPECTION"

Domain-specific type of the artifact.

artifactFormat
required
string
Enum: "BIN" "CSV" "DOC" "DOCX" "GIF" "HEIC" "JPG" "JPEG" "JSON" "JSONL" "PDF" "PNG" "RTF" "TIFF" "TNEF" "TXT" "XLSB" "XLSX" "XLS" "XML" "ZIP"

Encoding format of the artifact.

required
ArtifactPreprocessingStatusInProgress (object) or ArtifactPreprocessingStatusComplete (object)

The artifact preprocessing status

required
(ArtifactScreeningStatusInProgress (object or null)) or (ArtifactScreeningStatusComplete (object or null))

The artifact screening status of the artifact

required
(ArtifactCategorizationStatusInProgress (object or null)) or (ArtifactCategorizationStatusComplete (object or null))

The status of determining the categorization of the artifact

derivedArtifactIngestionStates
required
Array of objects (ArtifactIngestionState)

The ingestion states of any artifacts derived from this artifact

required
Array of ArtifactAssignedShipmentJobStatusInProgress (object) or ArtifactAssignedShipmentJobStatusComplete (object)

The status of each of the shipment jobs that this artifact is assigned to

required
Array of ArtifactAssignedPayableInvoiceStatusInProgress (object) or ArtifactAssignedPayableInvoiceStatusComplete (object)

The status of each of the payable invoices that this artifact is assigned to

required
ArtifactAggregateIngestionStatusComplete (object) or ArtifactAggregateIngestionStatusInProgress (object)

The overall ingestion status of the artifact, including all its derived artifacts and associated entities. If there are any in progress statuses it will result in this returning in progress

Response samples

Content type
application/json
{
  • "artifactQid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "artifactType": "INVOICE",
  • "artifactFormat": "PDF",
  • "preprocessingStatus": {
    • "status": "IN_PROGRESS"
    },
  • "screeningStatus": {
    • "status": "IN_PROGRESS"
    },
  • "categorizationStatus": {
    • "status": "IN_PROGRESS"
    },
  • "derivedArtifactIngestionStates": [
    • { }
    ],
  • "assignedShipmentJobStatuses": [
    • {
      • "status": "IN_PROGRESS",
      • "qid": { }
      }
    ],
  • "assignedPayableInvoiceStatuses": [
    • {
      • "status": "IN_PROGRESS"
      }
    ],
  • "aggregateIngestionStatus": {
    • "status": "COMPLETED"
    }
}

Create an artifact

Creates a new artifact. This endpoint can be used to create artifacts in either simple formats such as CSV and JSON where the artifact is included in the HTTP request body, or as files where the data is sent in the multipart/form-data format as an uploaded file. If the artifact is detected as a duplicate, via md5 hash, the existing artifact will be returned instead of creating a new one.

Authorizations:
bearer
query Parameters
expand
Array of strings
Items Value: "tags"
Request Body schema:
artifactType
required
string
Enum: "BILL_OF_LADING" "DELIVERY_ORDER" "DELIVERY_RECEIPT" "INVOICE" "LUMPER_RECEIPT" "OTHER" "PACKET" "PACKING_LIST" "RATE_CONFIRMATION" "SHIPMENT_RECORD" "UNKNOWN" "WEIGHT_INSPECTION"

Type of the artifact.

artifactFormat
string or null
Enum: "CSV" "JSON" "JPG" "JPEG" "PDF" "PNG"

Format of the artifact. The direct create endpoint supports a limited set of formats.

This can only be omitted when sending a file through a multipart/form-data request.

displayName
string or null

Name to display for the artifact. If the name is not provided and the request is a multipart/form-data request, the name of the file will be used.

tags
object

Entity tags assigned to the artifact.

value
string

Value of the artifact.

This can only be omitted when sending a file through a multipart/form-data request.

Responses

Response Schema: application/json
qid
required
string <qid>

Qualified unique identifier.

createdAt
required
string <utc-timestamp>
revisionNumber
required
number
revisionCreatedAt
required
string <utc-timestamp>
artifactType
required
string
Enum: "BILL_OF_LADING" "DELIVERY_ORDER" "DELIVERY_RECEIPT" "INVOICE" "LUMPER_RECEIPT" "OTHER" "PACKET" "PACKING_LIST" "RATE_CONFIRMATION" "SHIPMENT_RECORD" "UNKNOWN" "WEIGHT_INSPECTION"

Domain-specific type of the artifact.

artifactFormat
required
string
Enum: "BIN" "CSV" "DOC" "DOCX" "GIF" "HEIC" "JPG" "JPEG" "JSON" "JSONL" "PDF" "PNG" "RTF" "TIFF" "TNEF" "TXT" "XLSB" "XLSX" "XLS" "XML" "ZIP"

Encoding format of the artifact.

displayName
required
string

Name of the artifact for display purposes.

tags
object

Entity tags assigned to the artifact. This is an expansion field. To include this field, you must include tags in the query parameters.

Request samples

Content type
{
  • "artifactType": "SHIPMENT_RECORD",
  • "artifactFormat": "JSON",
  • "displayName": "Shipment 8392743",
  • "tags": {
    • "externalId": "123456789"
    },
  • "value": "{\"id\":\"8392743\",\"pickupDate\":\"2023-12-01\",\"deliveryDate\":\"2023-12-01\"}"
}

Response samples

Content type
application/json
{
  • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "revisionNumber": 1,
  • "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
  • "artifactType": "INVOICE",
  • "artifactFormat": "PDF",
  • "displayName": "XPO Invoice 54219 - 2023-12-01",
  • "tags": { }
}

Retrieve an artifact

Returns the artifact with the specified tag

Authorizations:
bearer
path Parameters
tagType
required
string
Example: externalId
tagTypeValue
required
string
Example: 123456789
query Parameters
expand
Array of strings
Items Enum: "derivatives" "summary" "tags"

Responses

Response Schema: application/json
qid
required
string <qid>

Qualified unique identifier.

createdAt
required
string <utc-timestamp>
revisionNumber
required
number
revisionCreatedAt
required
string <utc-timestamp>
artifactType
required
string
Enum: "BILL_OF_LADING" "DELIVERY_ORDER" "DELIVERY_RECEIPT" "INVOICE" "LUMPER_RECEIPT" "OTHER" "PACKET" "PACKING_LIST" "RATE_CONFIRMATION" "SHIPMENT_RECORD" "UNKNOWN" "WEIGHT_INSPECTION"

Domain-specific type of the artifact.

artifactFormat
required
string
Enum: "BIN" "CSV" "DOC" "DOCX" "GIF" "HEIC" "JPG" "JPEG" "JSON" "JSONL" "PDF" "PNG" "RTF" "TIFF" "TNEF" "TXT" "XLSB" "XLSX" "XLS" "XML" "ZIP"

Encoding format of the artifact.

displayName
required
string

Name of the artifact for display purposes.

object

Summary of semi-structured metadata extracted or parsed from the artifact. This is an expansion field. To include this field, you must include summary in the query parameters.

Array of objects (ArtifactExpanded)

This API provides a list of QIDs and corresponding types for artifacts that have been derived from the queried artifact. This is particularly useful when the queried artifact is a collection of other artifacts, such as a PDF document containing an invoice and a bill of lading. This is an expansion field. To include this field, you must include derivativeArtifacts in the query parameters.

tags
object

Entity tags assigned to the artifact. This is an expansion field. To include this field, you must include tags in the query parameters.

Response samples

Content type
application/json
{
  • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "revisionNumber": 1,
  • "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
  • "artifactType": "INVOICE",
  • "artifactFormat": "PDF",
  • "displayName": "XPO Invoice 54219 - 2023-12-01",
  • "summary": {
    • "bolNumber": "201946",
    • "carrierName": "Tom's Trucking LLC",
    • "consigneeAddress": {
      • "addressLine1": "123 Main Street",
      • "addressLine2": "Suite 456",
      • "city": "Chicago",
      • "state": "IL",
      • "postalCode": "60601",
      • "country": "USA"
      },
    • "dropoffAppointmentDateTime": "2023-12-01T12:00:00.000Z",
    • "dropoffAppointmentType": "FCFS, Appointment",
    • "equipmentRequirements": "straps, tarps, food grade, etc.",
    • "equipmentSize": "53', 48'",
    • "equipmentType": "Dry Van, Reefer, Flatbed, etc.",
    • "consigneeName": "Catherine's Culinary Corner",
    • "externalIdentifiers": [
      • "89213",
      • "OF7890"
      ],
    • "invoicedTotal": {
      • "amount": "3.50",
      • "currencyCode": "AUD"
      },
    • "invoiceNumber": "419204",
    • "invoiceDate": "2023-12-01",
    • "pickupAppointmentDateTime": "2023-12-01T12:00:00.000Z",
    • "pickupDateAppointmentType": "FCFS, Appointment",
    • "pickupDate": "2023-11-01",
    • "poNumber": "19012",
    • "proNumber": "76910234",
    • "reeferEquipmentTemperature": "35-36F",
    • "shipperAddress": {
      • "addressLine1": "123 Main Street",
      • "addressLine2": "Suite 456",
      • "city": "Chicago",
      • "state": "IL",
      • "postalCode": "60601",
      • "country": "USA"
      },
    • "shipperName": "Sally's Supply Store",
    • "transportationProvider": "TQL, CHR"
    },
  • "derivativeArtifacts": [
    • {
      • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "artifactType": "INVOICE"
      }
    ],
  • "tags": { }
}

Retrieve an artifact

Returns the artifact with the specified QID. Supports optional expansion for the "summary" field, the "derivatives" field, and the "tags" field. For example: /artifacts/<qid>?expand=summary&expand=derivatives&expand=tags

Authorizations:
bearer
path Parameters
qid
required
string <qid>
Example: qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c5

QID of the entity to retrieve

query Parameters
expand
Array of strings
Items Enum: "derivatives" "summary" "tags"

Responses

Response Schema: application/json
qid
required
string <qid>

Qualified unique identifier.

createdAt
required
string <utc-timestamp>
revisionNumber
required
number
revisionCreatedAt
required
string <utc-timestamp>
artifactType
required
string
Enum: "BILL_OF_LADING" "DELIVERY_ORDER" "DELIVERY_RECEIPT" "INVOICE" "LUMPER_RECEIPT" "OTHER" "PACKET" "PACKING_LIST" "RATE_CONFIRMATION" "SHIPMENT_RECORD" "UNKNOWN" "WEIGHT_INSPECTION"

Domain-specific type of the artifact.

artifactFormat
required
string
Enum: "BIN" "CSV" "DOC" "DOCX" "GIF" "HEIC" "JPG" "JPEG" "JSON" "JSONL" "PDF" "PNG" "RTF" "TIFF" "TNEF" "TXT" "XLSB" "XLSX" "XLS" "XML" "ZIP"

Encoding format of the artifact.

displayName
required
string

Name of the artifact for display purposes.

object

Summary of semi-structured metadata extracted or parsed from the artifact. This is an expansion field. To include this field, you must include summary in the query parameters.

Array of objects (ArtifactExpanded)

This API provides a list of QIDs and corresponding types for artifacts that have been derived from the queried artifact. This is particularly useful when the queried artifact is a collection of other artifacts, such as a PDF document containing an invoice and a bill of lading. This is an expansion field. To include this field, you must include derivativeArtifacts in the query parameters.

tags
object

Entity tags assigned to the artifact. This is an expansion field. To include this field, you must include tags in the query parameters.

Response samples

Content type
application/json
{
  • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "revisionNumber": 1,
  • "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
  • "artifactType": "INVOICE",
  • "artifactFormat": "PDF",
  • "displayName": "XPO Invoice 54219 - 2023-12-01",
  • "summary": {
    • "bolNumber": "201946",
    • "carrierName": "Tom's Trucking LLC",
    • "consigneeAddress": {
      • "addressLine1": "123 Main Street",
      • "addressLine2": "Suite 456",
      • "city": "Chicago",
      • "state": "IL",
      • "postalCode": "60601",
      • "country": "USA"
      },
    • "dropoffAppointmentDateTime": "2023-12-01T12:00:00.000Z",
    • "dropoffAppointmentType": "FCFS, Appointment",
    • "equipmentRequirements": "straps, tarps, food grade, etc.",
    • "equipmentSize": "53', 48'",
    • "equipmentType": "Dry Van, Reefer, Flatbed, etc.",
    • "consigneeName": "Catherine's Culinary Corner",
    • "externalIdentifiers": [
      • "89213",
      • "OF7890"
      ],
    • "invoicedTotal": {
      • "amount": "3.50",
      • "currencyCode": "AUD"
      },
    • "invoiceNumber": "419204",
    • "invoiceDate": "2023-12-01",
    • "pickupAppointmentDateTime": "2023-12-01T12:00:00.000Z",
    • "pickupDateAppointmentType": "FCFS, Appointment",
    • "pickupDate": "2023-11-01",
    • "poNumber": "19012",
    • "proNumber": "76910234",
    • "reeferEquipmentTemperature": "35-36F",
    • "shipperAddress": {
      • "addressLine1": "123 Main Street",
      • "addressLine2": "Suite 456",
      • "city": "Chicago",
      • "state": "IL",
      • "postalCode": "60601",
      • "country": "USA"
      },
    • "shipperName": "Sally's Supply Store",
    • "transportationProvider": "TQL, CHR"
    },
  • "derivativeArtifacts": [
    • {
      • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "artifactType": "INVOICE"
      }
    ],
  • "tags": { }
}

Download an artifact

Downloads the artifact with the specified QID as binary.

Authorizations:
bearer
path Parameters
qid
required
string <qid>
Example: qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c5

QID of the entity to retrieve

query Parameters
optimized
boolean

Controls whether to return an optimized version of the artifact. If set to true, optimization is enabled, and an optimized version of the artifact is available, returns the optimized version; otherwise, returns the original.

Responses

Response Headers
Content-Type
string
Example: "application/json"

The MIME type of the artifact.

Content-Disposition
string
Example: "attachment; filename=\"loop-artifact-e543dbd9-e964-4250-ba28-9cfa0b88beba.json\""

The filename of the artifact.

artifacts-schema-validated

Create a OrganizationFactorAssignment record artifact

Creates a new OrganizationFactorAssignment record artifact.

The OrganizationFactorAssignment record artifact is a structured, schema-enforced object that carries the information needed to validate a factoring relationship between two orgs.

Authorizations:
bearer
Request Body schema: application/json
carrierOrganizationQid
required
string <qid>

Qualified unique identifier.

required
object (CreateOrganizationFactorAssignmentRecordFactorInfoInput)

Responses

Response Schema: application/json
qid
required
string <qid>

Qualified unique identifier.

createdAt
required
string <utc-timestamp>
revisionNumber
required
number
revisionCreatedAt
required
string <utc-timestamp>
artifactType
required
string
Enum: "BILL_OF_LADING" "DELIVERY_ORDER" "DELIVERY_RECEIPT" "INVOICE" "LUMPER_RECEIPT" "OTHER" "PACKET" "PACKING_LIST" "RATE_CONFIRMATION" "SHIPMENT_RECORD" "UNKNOWN" "WEIGHT_INSPECTION"

Domain-specific type of the artifact.

artifactFormat
required
string
Enum: "BIN" "CSV" "DOC" "DOCX" "GIF" "HEIC" "JPG" "JPEG" "JSON" "JSONL" "PDF" "PNG" "RTF" "TIFF" "TNEF" "TXT" "XLSB" "XLSX" "XLS" "XML" "ZIP"

Encoding format of the artifact.

displayName
required
string

Name of the artifact for display purposes.

object

Summary of semi-structured metadata extracted or parsed from the artifact. This is an expansion field. To include this field, you must include summary in the query parameters.

Array of objects (ArtifactExpanded)

This API provides a list of QIDs and corresponding types for artifacts that have been derived from the queried artifact. This is particularly useful when the queried artifact is a collection of other artifacts, such as a PDF document containing an invoice and a bill of lading. This is an expansion field. To include this field, you must include derivativeArtifacts in the query parameters.

tags
object

Entity tags assigned to the artifact. This is an expansion field. To include this field, you must include tags in the query parameters.

Request samples

Content type
application/json
{
  • "carrierOrganizationQid": "qid::organization:ad894a60-34a6-49e0-b3f4-a6cbab0f47b6",
  • "factorInfo": {
    • "name": "ACME Factoring, Inc.",
    • "primaryAddress": {
      • "addressLine1": "123 Main St",
      • "addressLine2": "Suite 100",
      • "city": "San Diego",
      • "state": "CA",
      • "postalCode": "92101",
      • "country": "USA"
      },
    • "remittanceAddress": {
      • "addressLine1": "123 Main St",
      • "addressLine2": "Suite 100",
      • "city": "San Diego",
      • "state": "CA",
      • "postalCode": "92101",
      • "country": "USA"
      },
    • "additionalInfo": {
      • "phone": "858-555-1212",
      • "last4AccountNumber": "1234",
      • "arContact": {
        • "name": "John Doe",
        • "role": "Accountant",
        • "email": "jd@acme.com",
        • "phone": "7708820124"
        }
      }
    }
}

Response samples

Content type
application/json
{
  • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "revisionNumber": 1,
  • "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
  • "artifactType": "INVOICE",
  • "artifactFormat": "PDF",
  • "displayName": "XPO Invoice 54219 - 2023-12-01",
  • "summary": {
    • "bolNumber": "201946",
    • "carrierName": "Tom's Trucking LLC",
    • "consigneeAddress": {
      • "addressLine1": "123 Main Street",
      • "addressLine2": "Suite 456",
      • "city": "Chicago",
      • "state": "IL",
      • "postalCode": "60601",
      • "country": "USA"
      },
    • "dropoffAppointmentDateTime": "2023-12-01T12:00:00.000Z",
    • "dropoffAppointmentType": "FCFS, Appointment",
    • "equipmentRequirements": "straps, tarps, food grade, etc.",
    • "equipmentSize": "53', 48'",
    • "equipmentType": "Dry Van, Reefer, Flatbed, etc.",
    • "consigneeName": "Catherine's Culinary Corner",
    • "externalIdentifiers": [
      • "89213",
      • "OF7890"
      ],
    • "invoicedTotal": {
      • "amount": "3.50",
      • "currencyCode": "AUD"
      },
    • "invoiceNumber": "419204",
    • "invoiceDate": "2023-12-01",
    • "pickupAppointmentDateTime": "2023-12-01T12:00:00.000Z",
    • "pickupDateAppointmentType": "FCFS, Appointment",
    • "pickupDate": "2023-11-01",
    • "poNumber": "19012",
    • "proNumber": "76910234",
    • "reeferEquipmentTemperature": "35-36F",
    • "shipperAddress": {
      • "addressLine1": "123 Main Street",
      • "addressLine2": "Suite 456",
      • "city": "Chicago",
      • "state": "IL",
      • "postalCode": "60601",
      • "country": "USA"
      },
    • "shipperName": "Sally's Supply Store",
    • "transportationProvider": "TQL, CHR"
    },
  • "derivativeArtifacts": [
    • {
      • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "artifactType": "INVOICE"
      }
    ],
  • "tags": { }
}

Create a receivable invoice record artifact

Creates a new receivable invoice record artifact.

The receivable invoice record artifact is a structured, schema-enforced object that represents a receivable invoice at a point in time. This artifact is used to generate a normalized representation of a receivable invoice in Loop.

Asynchronously, Loop will normalize the receivable invoice entity and link the invoice to a shipment.

For more information on artifacts, please see our public docs.

Note: This endpoint is in development and subject to change.

Authorizations:
bearer
query Parameters
expand
Array of strings
Items Value: "tags"
Request Body schema: application/json
invoiceNumber
required
string

The invoice number. This will be used to match against existing invoices in Loop.

currencyCode
required
string
Enum: "AUD" "CAD" "EUR" "GBP" "MXN" "USD"
customerOrganizationQid
string <qid>

The QID of the customer organization. Must be specified if customerOrganizationTag is not specified.

object

A tag used to identify the customer organization. Must be specified if customerOrganizationQid is not specified.

payeeOrganizationQid
string <qid>

The QID of the payee organization. Will default to the primary organization for the tenant if not specified.

shipmentQid
string <qid>

The QID of the shipment. Must be specified if shipmentExternalIdentifier is not specified.

shipmentExternalIdentifier
string

The external identifier of the shipment. Must be specified if shipmentQid is not specified.

required
Array of objects (CreateReceivableInvoiceLineItemInput)

The receivable line items to be invoiced.

artifactTags
object or null

Entity tags to be assigned to the artifact.

Responses

Response Schema: application/json
qid
required
string <qid>

Qualified unique identifier.

createdAt
required
string <utc-timestamp>
revisionNumber
required
number
revisionCreatedAt
required
string <utc-timestamp>
artifactType
required
string
Enum: "BILL_OF_LADING" "DELIVERY_ORDER" "DELIVERY_RECEIPT" "INVOICE" "LUMPER_RECEIPT" "OTHER" "PACKET" "PACKING_LIST" "RATE_CONFIRMATION" "SHIPMENT_RECORD" "UNKNOWN" "WEIGHT_INSPECTION"

Domain-specific type of the artifact.

artifactFormat
required
string
Enum: "BIN" "CSV" "DOC" "DOCX" "GIF" "HEIC" "JPG" "JPEG" "JSON" "JSONL" "PDF" "PNG" "RTF" "TIFF" "TNEF" "TXT" "XLSB" "XLSX" "XLS" "XML" "ZIP"

Encoding format of the artifact.

displayName
required
string

Name of the artifact for display purposes.

object

Summary of semi-structured metadata extracted or parsed from the artifact. This is an expansion field. To include this field, you must include summary in the query parameters.

Array of objects (ArtifactExpanded)

This API provides a list of QIDs and corresponding types for artifacts that have been derived from the queried artifact. This is particularly useful when the queried artifact is a collection of other artifacts, such as a PDF document containing an invoice and a bill of lading. This is an expansion field. To include this field, you must include derivativeArtifacts in the query parameters.

tags
object

Entity tags assigned to the artifact. This is an expansion field. To include this field, you must include tags in the query parameters.

Request samples

Content type
application/json
{
  • "invoiceNumber": "I123412",
  • "currencyCode": "AUD",
  • "customerOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "customerOrganizationTag": {
    • "tagType": "externalCustomerUuid",
    • "tagValue": "e00b356d-8db3-476d-86dc-2c1a6808ea2c"
    },
  • "payeeOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "shipmentQid": "qid::shipment:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "shipmentExternalIdentifier": "S112154220",
  • "receivableLineItems": [
    • {
      • "chargeCode": "201",
      • "externalIdentifier": "13423",
      • "description": "Linehaul",
      • "amount": {
        • "amount": "3.50",
        • "currencyCode": "USD"
        }
      }
    ],
  • "artifactTags": {
    • "tag1": "value1",
    • "tag2": "value2"
    }
}

Response samples

Content type
application/json
{
  • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "revisionNumber": 1,
  • "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
  • "artifactType": "INVOICE",
  • "artifactFormat": "PDF",
  • "displayName": "XPO Invoice 54219 - 2023-12-01",
  • "summary": {
    • "bolNumber": "201946",
    • "carrierName": "Tom's Trucking LLC",
    • "consigneeAddress": {
      • "addressLine1": "123 Main Street",
      • "addressLine2": "Suite 456",
      • "city": "Chicago",
      • "state": "IL",
      • "postalCode": "60601",
      • "country": "USA"
      },
    • "dropoffAppointmentDateTime": "2023-12-01T12:00:00.000Z",
    • "dropoffAppointmentType": "FCFS, Appointment",
    • "equipmentRequirements": "straps, tarps, food grade, etc.",
    • "equipmentSize": "53', 48'",
    • "equipmentType": "Dry Van, Reefer, Flatbed, etc.",
    • "consigneeName": "Catherine's Culinary Corner",
    • "externalIdentifiers": [
      • "89213",
      • "OF7890"
      ],
    • "invoicedTotal": {
      • "amount": "3.50",
      • "currencyCode": "AUD"
      },
    • "invoiceNumber": "419204",
    • "invoiceDate": "2023-12-01",
    • "pickupAppointmentDateTime": "2023-12-01T12:00:00.000Z",
    • "pickupDateAppointmentType": "FCFS, Appointment",
    • "pickupDate": "2023-11-01",
    • "poNumber": "19012",
    • "proNumber": "76910234",
    • "reeferEquipmentTemperature": "35-36F",
    • "shipperAddress": {
      • "addressLine1": "123 Main Street",
      • "addressLine2": "Suite 456",
      • "city": "Chicago",
      • "state": "IL",
      • "postalCode": "60601",
      • "country": "USA"
      },
    • "shipperName": "Sally's Supply Store",
    • "transportationProvider": "TQL, CHR"
    },
  • "derivativeArtifacts": [
    • {
      • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "artifactType": "INVOICE"
      }
    ],
  • "tags": { }
}

Create a shipment record artifact

Creates a new shipment record artifact.

The shipment record artifact is a structured, schema-enforced object that represents a set of logistics activity at a point in time. This artifact is extracted and merged downstream with other artifacts from various sources (TMS, Email, etc) in different formats (PDF, PNG, JSON, etc) to form normalized shipment and job entities.

A shipment record is expected to have a single unique external identifier that matches the identifier used for the shipment in the source system. This identifier is used to assign the shipment record.

For more information, please see our public docs.

Note: This endpoint is in development and subject to change.

Authorizations:
bearer
query Parameters
expand
Array of strings
Items Value: "tags"
Request Body schema: application/json
source
string

The source of the shipment data.

required
Array of objects (CreateShipmentRecordJobInput)
artifactTags
object

Entity tags assigned to the artifact

Responses

Response Schema: application/json
qid
required
string <qid>

Qualified unique identifier.

createdAt
required
string <utc-timestamp>
revisionNumber
required
number
revisionCreatedAt
required
string <utc-timestamp>
artifactType
required
string
Enum: "BILL_OF_LADING" "DELIVERY_ORDER" "DELIVERY_RECEIPT" "INVOICE" "LUMPER_RECEIPT" "OTHER" "PACKET" "PACKING_LIST" "RATE_CONFIRMATION" "SHIPMENT_RECORD" "UNKNOWN" "WEIGHT_INSPECTION"

Domain-specific type of the artifact.

artifactFormat
required
string
Enum: "BIN" "CSV" "DOC" "DOCX" "GIF" "HEIC" "JPG" "JPEG" "JSON" "JSONL" "PDF" "PNG" "RTF" "TIFF" "TNEF" "TXT" "XLSB" "XLSX" "XLS" "XML" "ZIP"

Encoding format of the artifact.

displayName
required
string

Name of the artifact for display purposes.

object

Summary of semi-structured metadata extracted or parsed from the artifact. This is an expansion field. To include this field, you must include summary in the query parameters.

Array of objects (ArtifactExpanded)

This API provides a list of QIDs and corresponding types for artifacts that have been derived from the queried artifact. This is particularly useful when the queried artifact is a collection of other artifacts, such as a PDF document containing an invoice and a bill of lading. This is an expansion field. To include this field, you must include derivativeArtifacts in the query parameters.

tags
object

Entity tags assigned to the artifact. This is an expansion field. To include this field, you must include tags in the query parameters.

Request samples

Content type
application/json
Example

A simple FTL shipment job with a single pickup, dropoff and expected charges.

{
  • "jobs": [
    • {
      • "jobType": "FTL",
      • "jobTypeInfo": {
        • "jobType": "FTL",
        • "freightChargeTerms": "COLLECT",
        • "carrierOrganizationTag": {
          • "tagType": "externalCarrierUuid",
          • "tagValue": "304fb3dd-1f4a-404b-9f9e-c9134584915b"
          },
        • "stops": [
          • {
            • "address": {
              • "addressLine1": "123 Main Street",
              • "city": "Anytown",
              • "state": "CA",
              • "postalCode": "12345",
              • "country": "US"
              },
            • "date": "2023-01-01",
            • "organizationQid": "qid::organization:b309f6cf-cc13-4c4c-a55b-da71a7405d04",
            • "organizationTag": {
              • "tagType": "externalShipperUuid",
              • "tagValue": "304fb3dd-1f4a-404b-9f9e-c9134584915b"
              },
            • "stopType": "PICK_UP",
            • "articles": [
              • {
                • "dimensions": {
                  • "height": "12",
                  • "length": "12",
                  • "unit": "INCH",
                  • "width": "12"
                  },
                • "grossWeight": {
                  • "amount": "387",
                  • "unit": "POUND"
                  },
                • "nmfcClass": "50",
                • "packageCount": {
                  • "amount": 11,
                  • "unit": "CARTON"
                  }
                }
              ]
            },
          • {
            • "address": {
              • "addressLine1": "123 Second Street",
              • "city": "Anytown",
              • "state": "CA",
              • "postalCode": "12345",
              • "country": "US"
              },
            • "date": "2023-01-06",
            • "organizationQid": "qid::organization:92fc8b83-459c-450c-8f92-47bd5b7063f8",
            • "stopType": "DROP_OFF",
            • "articles": [
              • {
                • "dimensions": {
                  • "height": "12",
                  • "length": "12",
                  • "unit": "INCH",
                  • "width": "12"
                  },
                • "grossWeight": {
                  • "amount": "387",
                  • "unit": "POUND"
                  },
                • "nmfcClass": "50",
                • "packageCount": {
                  • "amount": 11,
                  • "unit": "CARTON"
                  }
                }
              ]
            }
          ]
        },
      • "expectedCharges": [
        • {
          • "code": "240",
          • "description": "Linehaul Charge",
          • "category": "LINEHAUL",
          • "amount": {
            • "amount": "1200.56",
            • "currencyCode": "USD"
            }
          },
        • {
          • "code": "872",
          • "description": "California Fuel Surcharge",
          • "category": "FUEL_SURCHARGE",
          • "amount": {
            • "amount": "450.56",
            • "currencyCode": "USD"
            }
          },
        • {
          • "code": "950",
          • "description": "Loading Fee",
          • "category": "OTHER",
          • "amount": {
            • "amount": "100.23",
            • "currencyCode": "USD"
            }
          }
        ]
      }
    ]
}

Response samples

Content type
application/json
{
  • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "revisionNumber": 1,
  • "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
  • "artifactType": "INVOICE",
  • "artifactFormat": "PDF",
  • "displayName": "XPO Invoice 54219 - 2023-12-01",
  • "summary": {
    • "bolNumber": "201946",
    • "carrierName": "Tom's Trucking LLC",
    • "consigneeAddress": {
      • "addressLine1": "123 Main Street",
      • "addressLine2": "Suite 456",
      • "city": "Chicago",
      • "state": "IL",
      • "postalCode": "60601",
      • "country": "USA"
      },
    • "dropoffAppointmentDateTime": "2023-12-01T12:00:00.000Z",
    • "dropoffAppointmentType": "FCFS, Appointment",
    • "equipmentRequirements": "straps, tarps, food grade, etc.",
    • "equipmentSize": "53', 48'",
    • "equipmentType": "Dry Van, Reefer, Flatbed, etc.",
    • "consigneeName": "Catherine's Culinary Corner",
    • "externalIdentifiers": [
      • "89213",
      • "OF7890"
      ],
    • "invoicedTotal": {
      • "amount": "3.50",
      • "currencyCode": "AUD"
      },
    • "invoiceNumber": "419204",
    • "invoiceDate": "2023-12-01",
    • "pickupAppointmentDateTime": "2023-12-01T12:00:00.000Z",
    • "pickupDateAppointmentType": "FCFS, Appointment",
    • "pickupDate": "2023-11-01",
    • "poNumber": "19012",
    • "proNumber": "76910234",
    • "reeferEquipmentTemperature": "35-36F",
    • "shipperAddress": {
      • "addressLine1": "123 Main Street",
      • "addressLine2": "Suite 456",
      • "city": "Chicago",
      • "state": "IL",
      • "postalCode": "60601",
      • "country": "USA"
      },
    • "shipperName": "Sally's Supply Store",
    • "transportationProvider": "TQL, CHR"
    },
  • "derivativeArtifacts": [
    • {
      • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "artifactType": "INVOICE"
      }
    ],
  • "tags": { }
}

factoring-relationships

Upsert a factoring relationship

Creates or updates a factoring relationship between a carrier organization and a factor organization. A carrier can only have one effective factoring relationship at any given time.

If a factoring relationship is currently active between the carrier and the passed factor organization, the existing factoring relationship will be merged with the passed factoring relationship.

If a factoring relationship is currently active between the carrier and a different factor organization, the existing factoring relationship will be terminated and a new factoring relationship will be created with the passed factor organization.

Authorizations:
bearer
Request Body schema: application/json
carrierOrganizationQid
required
string <qid>

Qualified unique identifier of the carrier organization.

factorOrganizationQid
required
string <qid>

Qualified unique identifier of the factoring organization.

effectiveFrom
string or null <utc-timestamp>

Timestamp indicating when the factoring relationship becomes active. This timestamp must be in the future. If not specified, the current timestamp will be used (effective immediately).

effectiveTo
string or null <utc-timestamp>

Timestamp indicating when the factoring relationship is no longer active. This timestamp must be after the effectiveFrom timestamp. If not specified, null will be used (effective indefinitely).

Responses

Response Schema: application/json
qid
required
string <qid>

Qualified unique identifier.

createdAt
required
string <utc-timestamp>
revisionNumber
required
number
revisionCreatedAt
required
string <utc-timestamp>
carrierOrganizationQid
required
string <qid>

Qualified unique identifier of the carrier organization.

factorOrganizationQid
required
string <qid>

Qualified unique identifier of the factoring organization.

effectiveFrom
required
string or null <utc-timestamp>

Timestamp indicating when the factoring relationship is effective.

effectiveTo
required
string or null <utc-timestamp>

Timestamp indicating when the factoring relationship is no longer effective.

Response Schema: application/json
qid
required
string <qid>

Qualified unique identifier.

createdAt
required
string <utc-timestamp>
revisionNumber
required
number
revisionCreatedAt
required
string <utc-timestamp>
carrierOrganizationQid
required
string <qid>

Qualified unique identifier of the carrier organization.

factorOrganizationQid
required
string <qid>

Qualified unique identifier of the factoring organization.

effectiveFrom
required
string or null <utc-timestamp>

Timestamp indicating when the factoring relationship is effective.

effectiveTo
required
string or null <utc-timestamp>

Timestamp indicating when the factoring relationship is no longer effective.

Request samples

Content type
application/json
{
  • "carrierOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "factorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "effectiveFrom": "2025-05-01T00:00:00.000Z",
  • "effectiveTo": "2025-06-01T00:00:00.000Z"
}

Response samples

Content type
application/json
{
  • "qid": "qid::factoring_relationship:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "revisionNumber": 1,
  • "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
  • "carrierOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "factorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "effectiveFrom": "2025-05-01T00:00:00.000Z",
  • "effectiveTo": "2025-06-01T00:00:00.000Z"
}

List factoring relationships

Returns a list of factoring relationships.

Authorizations:
bearer
query Parameters
revisedAfter
string <utc-timestamp>
Example: revisedAfter=2020-01-01T00:00:00.000Z

Filter to only results that have been revised after this timestamp. This can be a UTC timestamp or a floating date. If a floating date is passed, the timestamp used will be the beginning (midnight UTC) of the date.

revisedBefore
string <utc-timestamp>
Example: revisedBefore=2020-01-01T00:00:00.000Z

Filter to only results that have been revised before this timestamp. This can be a UTC timestamp or a floating date. If a floating date is passed, the timestamp used will be the beginning (midnight UTC) of the date.

first
number

The number of results to return. Default value is 10. Any custom value specified must lie between 0 and 100, inclusive.

after
string

The cursor to start returning results from

factorOrganizationQid
string <qid>
Example: factorOrganizationQid=qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c5

The factor organization QID to filter by

carrierOrganizationQid
string <qid>
Example: carrierOrganizationQid=qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c5

The carrier organization QID to filter by

Responses

Response Schema: application/json
Array of objects (FactoringRelationship)
object

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "qid": "qid::factoring_relationship:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "createdAt": "2023-01-01T00:00:00.000Z",
      • "revisionNumber": 1,
      • "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
      • "carrierOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "factorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "effectiveFrom": "2025-05-01T00:00:00.000Z",
      • "effectiveTo": "2025-06-01T00:00:00.000Z"
      }
    ],
  • "pageInfo": {
    • "hasPreviousPage": true,
    • "hasNextPage": true,
    • "startCursor": "string",
    • "endCursor": "string"
    }
}

Retrieve a factoring relationship

Returns the factoring relationship with the specified QID.

Authorizations:
bearer
path Parameters
qid
required
string <qid>
Example: qid::factoring_relationship:0ca6f700-4137-4d09-b44a-43bb8d7900c5

QID of the entity to retrieve

Responses

Response Schema: application/json
qid
required
string <qid>

Qualified unique identifier.

createdAt
required
string <utc-timestamp>
revisionNumber
required
number
revisionCreatedAt
required
string <utc-timestamp>
carrierOrganizationQid
required
string <qid>

Qualified unique identifier of the carrier organization.

factorOrganizationQid
required
string <qid>

Qualified unique identifier of the factoring organization.

effectiveFrom
required
string or null <utc-timestamp>

Timestamp indicating when the factoring relationship is effective.

effectiveTo
required
string or null <utc-timestamp>

Timestamp indicating when the factoring relationship is no longer effective.

Response samples

Content type
application/json
{
  • "qid": "qid::factoring_relationship:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "revisionNumber": 1,
  • "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
  • "carrierOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "factorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "effectiveFrom": "2025-05-01T00:00:00.000Z",
  • "effectiveTo": "2025-06-01T00:00:00.000Z"
}

invoicing-relationships

Upsert an invoicing relationship

Creates or updates a bilateral invoicing relationship between a payee and payor organization, or a default invoicing relationship for a payee or payor organization if the other is not specified.

If an invoicing relationship is currently active for the passed payee and payor organizations, the existing invoicing relationship will be merged with the passed invoicing relationship.

Authorizations:
bearer
Request Body schema: application/json
payeeOrganizationQid
required
string or null <qid>

Qualified unique identifier.

payorOrganizationQid
required
string or null <qid>

Qualified unique identifier.

daysToPay
required
number or null

Number of days until the invoice is due.

daysToPayFrom
required
string or null
Enum: "ISSUE_DATE" "RECEIPT_DATE"

The anchor date from which we determine the invoice due date.

effectiveFrom
string or null <utc-timestamp>

Timestamp indicating when the invoicing relationship becomes active. This timestamp must be in the future. If not specified, the current timestamp will be used (effective immediately).

effectiveTo
string or null <utc-timestamp>

Timestamp indicating when the invoicing relationship is no longer active. This timestamp must be after the effectiveFrom timestamp. If not specified, null will be used (effective indefinitely).

Responses

Response Schema: application/json
qid
required
string <qid>

Qualified unique identifier.

createdAt
required
string <utc-timestamp>
revisionNumber
required
number
revisionCreatedAt
required
string <utc-timestamp>
payeeOrganizationQid
required
string or null <qid>

Qualified unique identifier.

payorOrganizationQid
required
string or null <qid>

Qualified unique identifier.

daysToPay
required
number or null

Number of days until the invoice is due.

daysToPayFrom
required
string
Enum: "ISSUE_DATE" "RECEIPT_DATE"

The anchor date from which we determine the invoice due date.

effectiveFrom
required
string <utc-timestamp>

Timestamp indicating when the invoicing relationship is effective.

effectiveTo
required
string or null <utc-timestamp>

Timestamp indicating when the invoicing relationship is no longer effective.

Response Schema: application/json
qid
required
string <qid>

Qualified unique identifier.

createdAt
required
string <utc-timestamp>
revisionNumber
required
number
revisionCreatedAt
required
string <utc-timestamp>
payeeOrganizationQid
required
string or null <qid>

Qualified unique identifier.

payorOrganizationQid
required
string or null <qid>

Qualified unique identifier.

daysToPay
required
number or null

Number of days until the invoice is due.

daysToPayFrom
required
string
Enum: "ISSUE_DATE" "RECEIPT_DATE"

The anchor date from which we determine the invoice due date.

effectiveFrom
required
string <utc-timestamp>

Timestamp indicating when the invoicing relationship is effective.

effectiveTo
required
string or null <utc-timestamp>

Timestamp indicating when the invoicing relationship is no longer effective.

Request samples

Content type
application/json
{
  • "payeeOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "payorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "daysToPay": 30,
  • "daysToPayFrom": "ISSUE_DATE",
  • "effectiveFrom": "2025-05-01T00:00:00.000Z",
  • "effectiveTo": "2025-06-01T00:00:00.000Z"
}

Response samples

Content type
application/json
{
  • "qid": "qid::invoicing_relationship:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "revisionNumber": 1,
  • "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
  • "payeeOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "payorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "daysToPay": 30,
  • "daysToPayFrom": "ISSUE_DATE",
  • "effectiveFrom": "2025-05-01T00:00:00.000Z",
  • "effectiveTo": "2025-06-01T00:00:00.000Z"
}

List invoicing relationships

Returns a list of invoicing relationships.

Authorizations:
bearer
query Parameters
revisedAfter
string <utc-timestamp>
Example: revisedAfter=2020-01-01T00:00:00.000Z

Filter to only results that have been revised after this timestamp. This can be a UTC timestamp or a floating date. If a floating date is passed, the timestamp used will be the beginning (midnight UTC) of the date.

revisedBefore
string <utc-timestamp>
Example: revisedBefore=2020-01-01T00:00:00.000Z

Filter to only results that have been revised before this timestamp. This can be a UTC timestamp or a floating date. If a floating date is passed, the timestamp used will be the beginning (midnight UTC) of the date.

first
number

The number of results to return. Default value is 10. Any custom value specified must lie between 0 and 100, inclusive.

after
string

The cursor to start returning results from

payorOrganizationQid
string <qid>
Example: payorOrganizationQid=qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c5

The payor organization QID to filter by

payeeOrganizationQid
string <qid>
Example: payeeOrganizationQid=qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c5

The payee organization QID to filter by

Responses

Response Schema: application/json
Array of objects (InvoicingRelationship)
object

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "qid": "qid::invoicing_relationship:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "createdAt": "2023-01-01T00:00:00.000Z",
      • "revisionNumber": 1,
      • "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
      • "payeeOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "payorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "daysToPay": 30,
      • "daysToPayFrom": "ISSUE_DATE",
      • "effectiveFrom": "2025-05-01T00:00:00.000Z",
      • "effectiveTo": "2025-06-01T00:00:00.000Z"
      }
    ],
  • "pageInfo": {
    • "hasPreviousPage": true,
    • "hasNextPage": true,
    • "startCursor": "string",
    • "endCursor": "string"
    }
}

Retrieve an invoicing relationship

Returns the invoicing relationship with the specified QID.

Authorizations:
bearer
path Parameters
qid
required
string <qid>
Example: qid::invoicing_relationship:0ca6f700-4137-4d09-b44a-43bb8d7900c5

QID of the entity to retrieve

Responses

Response Schema: application/json
qid
required
string <qid>

Qualified unique identifier.

createdAt
required
string <utc-timestamp>
revisionNumber
required
number
revisionCreatedAt
required
string <utc-timestamp>
payeeOrganizationQid
required
string or null <qid>

Qualified unique identifier.

payorOrganizationQid
required
string or null <qid>

Qualified unique identifier.

daysToPay
required
number or null

Number of days until the invoice is due.

daysToPayFrom
required
string
Enum: "ISSUE_DATE" "RECEIPT_DATE"

The anchor date from which we determine the invoice due date.

effectiveFrom
required
string <utc-timestamp>

Timestamp indicating when the invoicing relationship is effective.

effectiveTo
required
string or null <utc-timestamp>

Timestamp indicating when the invoicing relationship is no longer effective.

Response samples

Content type
application/json
{
  • "qid": "qid::invoicing_relationship:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "revisionNumber": 1,
  • "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
  • "payeeOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "payorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "daysToPay": 30,
  • "daysToPayFrom": "ISSUE_DATE",
  • "effectiveFrom": "2025-05-01T00:00:00.000Z",
  • "effectiveTo": "2025-06-01T00:00:00.000Z"
}

organizations

Create an organization

Create an organization

Authorizations:
bearer
query Parameters
expand
Array of strings
Items Enum: "tags" "truckingCarrierInfo.factorOrganizationQid"
Request Body schema: application/json
displayName
required
string

Name of the organization.

legalName
string or null

Legal name of the organization, if defined.

tradeNames
Array of strings or null

Array of trade names (also known as DBA names) for the organization.

websiteUrl
string or null

Website of the organization.

parentOrganizationQid
string or null <qid>

Qualified unique identifier of the parent organization.

tags
object or null

Entity tags assigned to the organization.

object or null

Customer information, if relevant to the organization.

object or null

Trucking carrier information, if relevant to the organization.

factorInfo
object or null

Factor information, if relevant to the organization. The presence of an empty object here will create the organization as a factor.

brokerageInfo
object or null

Brokerage information, if relevant to the organization. The presence of an empty object here will create the organization as a brokerage.

object

Information applicable when this organization is the payee on a payable invoice, such as payment terms.

object

Information applicable when this organization is the payor on a receivable invoice.

Responses

Response Schema: application/json
qid
required
string <qid>

Qualified unique identifier.

createdAt
required
string <utc-timestamp>
revisionNumber
required
number
revisionCreatedAt
required
string <utc-timestamp>
displayName
required
string

Name of the organization.

legalName
required
string or null

Legal name of the organization, if defined.

websiteUrl
required
string or null

Website of the organization.

parentOrganizationQid
required
string or null <qid>

Qualified unique identifier of the parent organization.

required
object or null

Customer information, if relevant to the organization.

required
object or null

Trucking carrier information, if relevant to the organization.

factorInfo
required
object or null

Factor information, if relevant to the organization.

brokerageInfo
required
object or null

Brokerage information, if relevant to the organization.

tags
object

Entity tags assigned to the organization.

Request samples

Content type
application/json
{
  • "displayName": "ACME",
  • "legalName": "ACME Inc.",
  • "tradeNames": [
    • "ACME Trucking",
    • "ACME Group"
    ],
  • "websiteUrl": "https://example.com",
  • "parentOrganizationQid": "qid::organization:9bafb1b4-3bdf-4326-bc0d-2d0ff9d616a8",
  • "tags": {
    • "accountNumber": "AC-123",
    • "externalId": "123456789"
    },
  • "customerInfo": {
    • "billingEmails": [
      • "billing@customer.com"
      ],
    • "invoiceDeliveryMethod": "EMAIL"
    },
  • "truckingCarrierInfo": {
    • "mcNumber": "179059",
    • "scac": "FDEB",
    • "usdotNumber": "265752"
    },
  • "factorInfo": { },
  • "brokerageInfo": { },
  • "asPayee": {
    • "invoicing": {
      • "daysToPay": 30,
      • "daysToPayFrom": "ISSUE_DATE"
      },
    • "quickPay": {
      • "daysToPay": 1,
      • "discountPercentage": "0.02"
      }
    },
  • "asPayor": {
    • "invoicing": {
      • "daysToPay": 30
      },
    • "primaryBillingAddress": {
      • "addressLine1": "123 Main Street",
      • "addressLine2": "Suite 456",
      • "city": "Chicago",
      • "state": "IL",
      • "postalCode": "60601",
      • "country": "US"
      }
    }
}

Response samples

Content type
application/json
{
  • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "revisionNumber": 1,
  • "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
  • "displayName": "ACME",
  • "legalName": "ACME Inc.",
  • "websiteUrl": "https://example.com",
  • "parentOrganizationQid": "qid::organization:9bafb1b4-3bdf-4326-bc0d-2d0ff9d616a8",
  • "customerInfo": {
    • "billingEmails": [
      • "billing@customer.com"
      ],
    • "invoiceDeliveryMethod": "EMAIL"
    },
  • "truckingCarrierInfo": {
    • "mcNumber": "179059",
    • "scac": "FDEB",
    • "usdotNumber": "265752"
    },
  • "factorInfo": { },
  • "brokerageInfo": { },
  • "tags": {
    • "accountNumber": "AC-123",
    • "externalId": "123456789"
    }
}

Retrieve an organization

Returns the organization with the specified tag

Authorizations:
bearer
path Parameters
tagType
required
string
Example: externalId
tagTypeValue
required
string
Example: 123456789
query Parameters
expand
Array of strings
Items Enum: "tags" "truckingCarrierInfo.factorOrganizationQid"

Responses

Response Schema: application/json
qid
required
string <qid>

Qualified unique identifier.

createdAt
required
string <utc-timestamp>
revisionNumber
required
number
revisionCreatedAt
required
string <utc-timestamp>
displayName
required
string

Name of the organization.

legalName
required
string or null

Legal name of the organization, if defined.

websiteUrl
required
string or null

Website of the organization.

parentOrganizationQid
required
string or null <qid>

Qualified unique identifier of the parent organization.

required
object or null

Customer information, if relevant to the organization.

required
object or null

Trucking carrier information, if relevant to the organization.

factorInfo
required
object or null

Factor information, if relevant to the organization.

brokerageInfo
required
object or null

Brokerage information, if relevant to the organization.

tags
object

Entity tags assigned to the organization.

Response samples

Content type
application/json
{
  • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "revisionNumber": 1,
  • "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
  • "displayName": "ACME",
  • "legalName": "ACME Inc.",
  • "websiteUrl": "https://example.com",
  • "parentOrganizationQid": "qid::organization:9bafb1b4-3bdf-4326-bc0d-2d0ff9d616a8",
  • "customerInfo": {
    • "billingEmails": [
      • "billing@customer.com"
      ],
    • "invoiceDeliveryMethod": "EMAIL"
    },
  • "truckingCarrierInfo": {
    • "mcNumber": "179059",
    • "scac": "FDEB",
    • "usdotNumber": "265752"
    },
  • "factorInfo": { },
  • "brokerageInfo": { },
  • "tags": {
    • "accountNumber": "AC-123",
    • "externalId": "123456789"
    }
}

Retrieve an organization

Returns the organization with the specified QID

Authorizations:
bearer
path Parameters
qid
required
string <qid>
Example: qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c5

QID of the entity to retrieve

query Parameters
expand
Array of strings
Items Enum: "tags" "truckingCarrierInfo.factorOrganizationQid"

Responses

Response Schema: application/json
qid
required
string <qid>

Qualified unique identifier.

createdAt
required
string <utc-timestamp>
revisionNumber
required
number
revisionCreatedAt
required
string <utc-timestamp>
displayName
required
string

Name of the organization.

legalName
required
string or null

Legal name of the organization, if defined.

websiteUrl
required
string or null

Website of the organization.

parentOrganizationQid
required
string or null <qid>

Qualified unique identifier of the parent organization.

required
object or null

Customer information, if relevant to the organization.

required
object or null

Trucking carrier information, if relevant to the organization.

factorInfo
required
object or null

Factor information, if relevant to the organization.

brokerageInfo
required
object or null

Brokerage information, if relevant to the organization.

tags
object

Entity tags assigned to the organization.

Response samples

Content type
application/json
{
  • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "revisionNumber": 1,
  • "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
  • "displayName": "ACME",
  • "legalName": "ACME Inc.",
  • "websiteUrl": "https://example.com",
  • "parentOrganizationQid": "qid::organization:9bafb1b4-3bdf-4326-bc0d-2d0ff9d616a8",
  • "customerInfo": {
    • "billingEmails": [
      • "billing@customer.com"
      ],
    • "invoiceDeliveryMethod": "EMAIL"
    },
  • "truckingCarrierInfo": {
    • "mcNumber": "179059",
    • "scac": "FDEB",
    • "usdotNumber": "265752"
    },
  • "factorInfo": { },
  • "brokerageInfo": { },
  • "tags": {
    • "accountNumber": "AC-123",
    • "externalId": "123456789"
    }
}

Update an organization

Update an organization

Authorizations:
bearer
path Parameters
qid
required
string <qid>
Example: qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c5

QID of the entity to retrieve

query Parameters
expand
Array of strings
Items Enum: "tags" "truckingCarrierInfo.factorOrganizationQid"
Request Body schema: application/json
displayName
string

Name of the organization.

legalName
string or null

Legal name of the organization, if defined.

tradeNames
Array of strings or null

Array of trade names (also known as DBA names) for the organization.

websiteUrl
string or null

Website of the organization.

parentOrganizationQid
string or null <qid>

Qualified unique identifier of the parent organization.

tags
object or null

Entity tags assigned to the organization.

object or null

Customer information, if relevant to the organization.

object or null

Trucking carrier information, if relevant to the organization.

factorInfo
object or null

Factor information, if relevant to the organization. The presence of an empty object here will create the organization as a factor.

object

Invoicing relationship information applicable when this organization is the payee on a payable invoice, such as payment terms.

object

Information applicable when this organization is the payor on a receivable invoice.

Responses

Response Schema: application/json
qid
required
string <qid>

Qualified unique identifier.

createdAt
required
string <utc-timestamp>
revisionNumber
required
number
revisionCreatedAt
required
string <utc-timestamp>
displayName
required
string

Name of the organization.

legalName
required
string or null

Legal name of the organization, if defined.

websiteUrl
required
string or null

Website of the organization.

parentOrganizationQid
required
string or null <qid>

Qualified unique identifier of the parent organization.

required
object or null

Customer information, if relevant to the organization.

required
object or null

Trucking carrier information, if relevant to the organization.

factorInfo
required
object or null

Factor information, if relevant to the organization.

brokerageInfo
required
object or null

Brokerage information, if relevant to the organization.

tags
object

Entity tags assigned to the organization.

Request samples

Content type
application/json
{
  • "displayName": "ACME",
  • "legalName": "ACME Inc.",
  • "tradeNames": [
    • "ACME Trucking",
    • "ACME Group"
    ],
  • "websiteUrl": "https://example.com",
  • "parentOrganizationQid": "qid::organization:9bafb1b4-3bdf-4326-bc0d-2d0ff9d616a8",
  • "tags": {
    • "tag1": "value1",
    • "tag2": "value2"
    },
  • "customerInfo": {
    • "billingEmails": [
      • "billing@customer.com"
      ],
    • "invoiceDeliveryMethod": "EMAIL"
    },
  • "truckingCarrierInfo": {
    • "mcNumber": "179059",
    • "scac": "FDEB",
    • "usdotNumber": "265752"
    },
  • "factorInfo": { },
  • "asPayee": {
    • "invoicing": {
      • "daysToPay": 30,
      • "daysToPayFrom": "ISSUE_DATE"
      },
    • "quickPay": {
      • "daysToPay": 1,
      • "discountPercentage": "0.02"
      }
    },
  • "asPayor": {
    • "invoicing": {
      • "daysToPay": 30
      },
    • "primaryBillingAddress": {
      • "addressLine1": "123 Main Street",
      • "addressLine2": "Suite 456",
      • "city": "Chicago",
      • "state": "IL",
      • "postalCode": "60601",
      • "country": "US"
      }
    }
}

Response samples

Content type
application/json
{
  • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "revisionNumber": 1,
  • "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
  • "displayName": "ACME",
  • "legalName": "ACME Inc.",
  • "websiteUrl": "https://example.com",
  • "parentOrganizationQid": "qid::organization:9bafb1b4-3bdf-4326-bc0d-2d0ff9d616a8",
  • "customerInfo": {
    • "billingEmails": [
      • "billing@customer.com"
      ],
    • "invoiceDeliveryMethod": "EMAIL"
    },
  • "truckingCarrierInfo": {
    • "mcNumber": "179059",
    • "scac": "FDEB",
    • "usdotNumber": "265752"
    },
  • "factorInfo": { },
  • "brokerageInfo": { },
  • "tags": {
    • "accountNumber": "AC-123",
    • "externalId": "123456789"
    }
}

payable-allocations

List payable allocations

Returns a list of payable allocations

Authorizations:
bearer
query Parameters
invoiceQids
string <qid>
Example: invoiceQids=qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c5

When provided, the result set will only include allocations related to the invoices matching the QIDs specified in this list.

first
number

The number of results to return. Default value is 10. Any custom value specified must lie between 0 and 100, inclusive.

after
string

The cursor to start returning results from

Responses

Response Schema: application/json
Array of objects (PayableAllocation)
object

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "qid": "qid::payable_allocation:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "createdAt": "2023-01-01T00:00:00.000Z",
      • "payableInvoiceQid": "qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "paymentQid": "qid::payment:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "amount": {
        • "amount": "3.50",
        • "currencyCode": "USD"
        }
      }
    ],
  • "pageInfo": {
    • "hasPreviousPage": true,
    • "hasNextPage": true,
    • "startCursor": "string",
    • "endCursor": "string"
    }
}

Retrieves a payable allocation

Returns the payable allocation with the specified QID

Authorizations:
bearer
path Parameters
qid
required
string <qid>
Example: qid::payable_allocation:0ca6f700-4137-4d09-b44a-43bb8d7900c5

QID of the entity to retrieve

Responses

Response Schema: application/json
qid
required
string <qid>

Qualified unique identifier.

createdAt
required
string <utc-timestamp>
payableInvoiceQid
required
string <qid>

The invoice where the cost was allocated to a GL code.

paymentQid
required
string <qid>

The payment that triggered the cost allocation.

required
object

The amount being allocated to this GL code.

Response samples

Content type
application/json
{
  • "qid": "qid::payable_allocation:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "payableInvoiceQid": "qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "paymentQid": "qid::payment:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "amount": {
    • "amount": "3.50",
    • "currencyCode": "USD"
    }
}

payable-invoice-reviews

List payable invoice reviews

Returns a list of payable invoice reviews

Authorizations:
bearer
query Parameters
expand
Array of strings
Items Enum: "exceptions" "expandRevisionCreatedAt" "lastApprovedBy" "lineItemGroupReviews.lineItemGroup" "lineItemGroupReviews.rateEngineRateItem" "lineItemGroupReviews.rateEngineRateItem.tags" "payableAllocationReviews" "payableInvoice" "payableInvoice.artifacts" "payableInvoice.organizations" "payableInvoice.shipmentJobs" "payableInvoice.shipmentJobs.addresses" "payableInvoice.shipmentJobs.artifacts" "payableInvoice.shipmentJobs.jobTypeInfo.address" "payableInvoice.shipmentJobs.jobTypeInfo.organizations"
expandRevisedBefore
string <utc-timestamp>
Example: expandRevisedBefore=2020-01-01T00:00:00.000Z

Filter to only results that have been revised (including any possible field expansion) before this timestamp. This can be a UTC timestamp or a floating date. If a floating date is passed, the timestamp used will be the beginning (midnight UTC) of the date.

expandRevisedAfter
string <utc-timestamp>
Example: expandRevisedAfter=2020-01-01T00:00:00.000Z

Filter to only results that have been revised (including any possible field expansion) after this timestamp. This can be a UTC timestamp or a floating date. If a floating date is passed, the timestamp used will be the beginning (midnight UTC) of the date.

revisedAfter
string <utc-timestamp>
Example: revisedAfter=2020-01-01T00:00:00.000Z

Filter to only results that have been revised after this timestamp. This can be a UTC timestamp or a floating date. If a floating date is passed, the timestamp used will be the beginning (midnight UTC) of the date.

revisedBefore
string <utc-timestamp>
Example: revisedBefore=2020-01-01T00:00:00.000Z

Filter to only results that have been revised before this timestamp. This can be a UTC timestamp or a floating date. If a floating date is passed, the timestamp used will be the beginning (midnight UTC) of the date.

first
number

The number of results to return. Default value is 10. Any custom value specified must lie between 0 and 100, inclusive.

after
string

The cursor to start returning results from

Responses

Response Schema: application/json
Array of objects (PayableInvoiceReview)
object

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "qid": "string",
      • "createdAt": "2023-01-01T00:00:00.000Z",
      • "revisionNumber": 1,
      • "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
      • "exceptions": [
        • {
          • "label": "string",
          • "resolvedAt": "2023-01-01T00:00:00.000Z",
          • "targetQid": "string"
          }
        ],
      • "payableInvoiceQid": "qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "payableInvoice": {
        • "qid": "qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "invoiceNumber": "555-555555",
        • "paymentDueDate": "2023-01-01",
        • "issueDate": "2023-01-01",
        • "invoicedTotal": {
          • "amount": "3.50",
          • "currencyCode": "USD"
          },
        • "shipmentJobQids": [
          • "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
          ],
        • "shipmentJobs": {
          • "qid": "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "createdAt": "2023-01-01T00:00:00.000Z",
          • "jobType": "FTL",
          • "jobTypeInfo": {
            • "freightChargeTerms": "COLLECT",
            • "billToAddressName": { },
            • "billToAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "billToAddress": {
              • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "addressLine1": "123 Main Street",
              • "addressLine2": "Suite 456",
              • "city": "Chicago",
              • "state": "IL",
              • "postalCode": "60601",
              • "country": "US"
              },
            • "carrierOrganizationName": { },
            • "carrierOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "firstOriginAddressName": { },
            • "firstOriginAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "firstOriginAddress": {
              • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "addressLine1": "123 Main Street",
              • "addressLine2": "Suite 456",
              • "city": "Chicago",
              • "state": "IL",
              • "postalCode": "60601",
              • "country": "US"
              },
            • "lastDestinationAddressName": { },
            • "lastDestinationAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "lastDestinationAddress": {
              • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "addressLine1": "123 Main Street",
              • "addressLine2": "Suite 456",
              • "city": "Chicago",
              • "state": "IL",
              • "postalCode": "60601",
              • "country": "US"
              },
            • "carrierOrganization": {
              • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "displayName": "ACME"
              },
            • "stops": [
              • {
                • "addressName": { },
                • "addressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                • "address": {
                  • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                  • "addressLine1": "123 Main Street",
                  • "addressLine2": "Suite 456",
                  • "city": "Chicago",
                  • "state": "IL",
                  • "postalCode": "60601",
                  • "country": "US"
                  },
                • "date": "2023-01-01",
                • "organizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                • "organization": {
                  • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                  • "displayName": "ACME"
                  },
                • "stopType": "DROP_OFF",
                • "articlesSummary": {
                  • "totalGrossWeight": {
                    • "amount": "20.2",
                    • "unit": "POUND"
                    },
                  • "totalPackageCount": {
                    • "amount": null,
                    • "unit": null
                    },
                  • "totalHandlingUnit": {
                    • "amount": null,
                    • "unit": null
                    }
                  },
                • "articles": [
                  • {
                    • "description": { },
                    • "dimensions": null,
                    • "grossWeight": null,
                    • "nmfcClass": null,
                    • "nmfcCode": null,
                    • "packageCount": null,
                    • "handlingUnit": null
                    }
                  ],
                • "referenceNumbers": [
                  • {
                    • "key": null,
                    • "value": null
                    }
                  ]
                }
              ]
            },
          • "addresses": [
            • {
              • "addressName": "string",
              • "addressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "address": {
                • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                • "addressLine1": "123 Main Street",
                • "addressLine2": "Suite 456",
                • "city": "Chicago",
                • "state": "IL",
                • "postalCode": "60601",
                • "country": "US"
                },
              • "addressType": "PICKUP"
              }
            ],
          • "referenceNumbers": {
            • "bolNumber": "BOL123456789X",
            • "externalIdentifier": "EXID987654321Z"
            },
          • "referenceNumbersList": [
            • {
              • "key": "PO_NUMBER",
              • "value": "123",
              • "label": "po"
              }
            ],
          • "artifacts": {
            • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "artifactType": "INVOICE",
            • "assessedTypes": [
              • "PROOF_OF_DELIVERY"
              ],
            • "receivedAt": "2023-01-01T00:00:00.000Z"
            }
          },
        • "artifactQids": [
          • "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
          ],
        • "artifacts": {
          • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "artifactType": "INVOICE"
          },
        • "payeeOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "payeeOrganization": {
          • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "displayName": "ACME"
          },
        • "payeeFboOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "payorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "payorOrganization": {
          • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "displayName": "ACME"
          },
        • "vendorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "vendorOrganization": {
          • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "displayName": "ACME"
          },
        • "receivedAt": "2023-01-01T00:00:00.000Z"
        },
      • "payableAllocationReviews": [
        • {
          • "generalLedgerCode": "GL123",
          • "generalLedgerDescription": "General Ledger 123",
          • "approved": {
            • "amount": "3.50",
            • "currencyCode": "USD"
            }
          }
        ],
      • "status": "COMPLETE",
      • "auditStatus": "PUBLISHED",
      • "outcome": "FULLY_APPROVED",
      • "approved": {
        • "amount": "3.50",
        • "currencyCode": "USD"
        },
      • "lastApprovedAt": "2023-01-01T00:00:00.000Z",
      • "lastApprovedBy": {
        • "firstName": "string",
        • "lastName": "string",
        • "email": "string"
        },
      • "expected": {
        • "amount": "3.50",
        • "currencyCode": "USD"
        },
      • "lineItemGroupReviews": [
        • {
          • "approved": {
            • "amount": "3.50",
            • "currencyCode": "USD"
            },
          • "expected": {
            • "amount": "3.50",
            • "currencyCode": "USD"
            },
          • "lineItemGroupQid": "qid::payable_invoice_line_item_group:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "lineItemGroup": {
            • "qid": "qid::payable_invoice_line_item_group:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "name": "Linehaul",
            • "invoiced": {
              • "amount": "3.50",
              • "currencyCode": "USD"
              },
            • "payment": {
              • "amount": "3.50",
              • "currencyCode": "USD"
              },
            • "category": "LINEHAUL"
            },
          • "rateEngineRateItemQid": "qid::rate_engine_run_rate_item:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "rateEngineRateItem": {
            • "qid": "qid::rate_engine_run_rate_item:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "code": "660",
            • "description": "California Fuel Surcharge",
            • "tags": { }
            }
          }
        ],
      • "adjustmentReviews": [
        • {
          • "approved": {
            • "amount": "3.50",
            • "currencyCode": "USD"
            },
          • "appliedAmount": {
            • "amount": "3.50",
            • "currencyCode": "USD"
            },
          • "adjustmentQid": "qid::payable_invoice_adjustment:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "description": "QUICK_PAY_DISCOUNT",
          • "externalIdentifier": { }
          }
        ],
      • "expandRevisionCreatedAt": { }
      }
    ],
  • "pageInfo": {
    • "hasPreviousPage": true,
    • "hasNextPage": true,
    • "startCursor": "string",
    • "endCursor": "string"
    }
}

Retrieve a payable invoice review

Returns the payable invoice review for the specified payable invoice QID

Authorizations:
bearer
path Parameters
qid
required
string <qid>
Example: qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c5

QID of the entity to retrieve

query Parameters
expand
Array of strings
Items Enum: "exceptions" "expandRevisionCreatedAt" "lastApprovedBy" "lineItemGroupReviews.lineItemGroup" "lineItemGroupReviews.rateEngineRateItem" "lineItemGroupReviews.rateEngineRateItem.tags" "payableAllocationReviews" "payableInvoice" "payableInvoice.artifacts" "payableInvoice.organizations" "payableInvoice.shipmentJobs" "payableInvoice.shipmentJobs.addresses" "payableInvoice.shipmentJobs.artifacts" "payableInvoice.shipmentJobs.jobTypeInfo.address" "payableInvoice.shipmentJobs.jobTypeInfo.organizations"

Responses

Response Schema: application/json
qid
required
string <qid>

Qualified unique identifier.

createdAt
required
string <utc-timestamp>
revisionNumber
required
number
revisionCreatedAt
required
string <utc-timestamp>
Array of objects (BusinessException)

A list of exceptions related to the payable invoice. This is an expansion field. To include this field, you must include exceptions in the query parameters.

payableInvoiceQid
required
string <qid>

Qualified unique identifier.

object

The payable invoice. This is an expansion field. To include this field, you must include payableInvoice in the query parameters.

Array of objects (PayableAllocationReviewExpand)

The allocation information for this review. Includes general ledger information. This is an expansion field. To include this field, you must include payableAllocationReviews in the query parameters.

status
required
string
Enum: "INCOMPLETE" "COMPLETE" "NOT_ENABLED"
auditStatus
required
string
Enum: "IN_PROGRESS" "PUBLISHED" "IGNORED"
outcome
required
string or null
Enum: "FULLY_APPROVED" "PARTIALLY_APPROVED" "REJECTED"
required
object
lastApprovedAt
required
string or null <utc-timestamp>
object or null

The last user to approve the payable invoice. This is an expansion field. To include this field, you must include lastApprovedBy in the query parameters.

required
object
required
Array of objects (PayableInvoiceLineItemGroupReview)
required
Array of objects (PayableInvoiceAdjustmentReview)
expandRevisionCreatedAt
object

The most recent timestamp at which the payable invoice review or its related entities were revised. This field is automatically included if the expandRevisedAfter or expandRevisedBefore query parameter is provided. This is an expansion field. To include this field, you must include expandRevisionCreatedAt in the query parameters.

Response samples

Content type
application/json
{
  • "qid": "string",
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "revisionNumber": 1,
  • "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
  • "exceptions": [
    • {
      • "label": "string",
      • "resolvedAt": "2023-01-01T00:00:00.000Z",
      • "targetQid": "string"
      }
    ],
  • "payableInvoiceQid": "qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "payableInvoice": {
    • "qid": "qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
    • "invoiceNumber": "555-555555",
    • "paymentDueDate": "2023-01-01",
    • "issueDate": "2023-01-01",
    • "invoicedTotal": {
      • "amount": "3.50",
      • "currencyCode": "USD"
      },
    • "shipmentJobQids": [
      • "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
      ],
    • "shipmentJobs": {
      • "qid": "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "createdAt": "2023-01-01T00:00:00.000Z",
      • "jobType": "FTL",
      • "jobTypeInfo": {
        • "freightChargeTerms": "COLLECT",
        • "billToAddressName": { },
        • "billToAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "billToAddress": {
          • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "addressLine1": "123 Main Street",
          • "addressLine2": "Suite 456",
          • "city": "Chicago",
          • "state": "IL",
          • "postalCode": "60601",
          • "country": "US"
          },
        • "carrierOrganizationName": { },
        • "carrierOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "firstOriginAddressName": { },
        • "firstOriginAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "firstOriginAddress": {
          • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "addressLine1": "123 Main Street",
          • "addressLine2": "Suite 456",
          • "city": "Chicago",
          • "state": "IL",
          • "postalCode": "60601",
          • "country": "US"
          },
        • "lastDestinationAddressName": { },
        • "lastDestinationAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "lastDestinationAddress": {
          • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "addressLine1": "123 Main Street",
          • "addressLine2": "Suite 456",
          • "city": "Chicago",
          • "state": "IL",
          • "postalCode": "60601",
          • "country": "US"
          },
        • "carrierOrganization": {
          • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "displayName": "ACME"
          },
        • "stops": [
          • {
            • "addressName": { },
            • "addressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "address": {
              • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "addressLine1": "123 Main Street",
              • "addressLine2": "Suite 456",
              • "city": "Chicago",
              • "state": "IL",
              • "postalCode": "60601",
              • "country": "US"
              },
            • "date": "2023-01-01",
            • "organizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "organization": {
              • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "displayName": "ACME"
              },
            • "stopType": "DROP_OFF",
            • "articlesSummary": {
              • "totalGrossWeight": {
                • "amount": "20.2",
                • "unit": "POUND"
                },
              • "totalPackageCount": {
                • "amount": 8,
                • "unit": "CARTON"
                },
              • "totalHandlingUnit": {
                • "amount": 8,
                • "unit": "PALLET"
                }
              },
            • "articles": [
              • {
                • "description": { },
                • "dimensions": {
                  • "height": "2.8",
                  • "length": "12.1",
                  • "width": "1.5",
                  • "unit": "INCH"
                  },
                • "grossWeight": {
                  • "amount": "20.2",
                  • "unit": "POUND"
                  },
                • "nmfcClass": "50",
                • "nmfcCode": "87700",
                • "packageCount": {
                  • "amount": 8,
                  • "unit": "CARTON"
                  },
                • "handlingUnit": {
                  • "amount": 8,
                  • "unit": "PALLET"
                  }
                }
              ],
            • "referenceNumbers": [
              • {
                • "key": "PO_NUMBER",
                • "value": "123"
                }
              ]
            }
          ]
        },
      • "addresses": [
        • {
          • "addressName": "string",
          • "addressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "address": {
            • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "addressLine1": "123 Main Street",
            • "addressLine2": "Suite 456",
            • "city": "Chicago",
            • "state": "IL",
            • "postalCode": "60601",
            • "country": "US"
            },
          • "addressType": "PICKUP"
          }
        ],
      • "referenceNumbers": {
        • "bolNumber": "BOL123456789X",
        • "externalIdentifier": "EXID987654321Z"
        },
      • "referenceNumbersList": [
        • {
          • "key": "PO_NUMBER",
          • "value": "123",
          • "label": "po"
          }
        ],
      • "artifacts": {
        • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "artifactType": "INVOICE",
        • "assessedTypes": [
          • "PROOF_OF_DELIVERY"
          ],
        • "receivedAt": "2023-01-01T00:00:00.000Z"
        }
      },
    • "artifactQids": [
      • "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
      ],
    • "artifacts": {
      • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "artifactType": "INVOICE"
      },
    • "payeeOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
    • "payeeOrganization": {
      • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "displayName": "ACME"
      },
    • "payeeFboOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
    • "payorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
    • "payorOrganization": {
      • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "displayName": "ACME"
      },
    • "vendorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
    • "vendorOrganization": {
      • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "displayName": "ACME"
      },
    • "receivedAt": "2023-01-01T00:00:00.000Z"
    },
  • "payableAllocationReviews": [
    • {
      • "generalLedgerCode": "GL123",
      • "generalLedgerDescription": "General Ledger 123",
      • "approved": {
        • "amount": "3.50",
        • "currencyCode": "USD"
        }
      }
    ],
  • "status": "COMPLETE",
  • "auditStatus": "PUBLISHED",
  • "outcome": "FULLY_APPROVED",
  • "approved": {
    • "amount": "3.50",
    • "currencyCode": "USD"
    },
  • "lastApprovedAt": "2023-01-01T00:00:00.000Z",
  • "lastApprovedBy": {
    • "firstName": "string",
    • "lastName": "string",
    • "email": "string"
    },
  • "expected": {
    • "amount": "3.50",
    • "currencyCode": "USD"
    },
  • "lineItemGroupReviews": [
    • {
      • "approved": {
        • "amount": "3.50",
        • "currencyCode": "USD"
        },
      • "expected": {
        • "amount": "3.50",
        • "currencyCode": "USD"
        },
      • "lineItemGroupQid": "qid::payable_invoice_line_item_group:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "lineItemGroup": {
        • "qid": "qid::payable_invoice_line_item_group:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "name": "Linehaul",
        • "invoiced": {
          • "amount": "3.50",
          • "currencyCode": "USD"
          },
        • "payment": {
          • "amount": "3.50",
          • "currencyCode": "USD"
          },
        • "category": "LINEHAUL"
        },
      • "rateEngineRateItemQid": "qid::rate_engine_run_rate_item:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "rateEngineRateItem": {
        • "qid": "qid::rate_engine_run_rate_item:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "code": "660",
        • "description": "California Fuel Surcharge",
        • "tags": { }
        }
      }
    ],
  • "adjustmentReviews": [
    • {
      • "approved": {
        • "amount": "3.50",
        • "currencyCode": "USD"
        },
      • "appliedAmount": {
        • "amount": "3.50",
        • "currencyCode": "USD"
        },
      • "adjustmentQid": "qid::payable_invoice_adjustment:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "description": "QUICK_PAY_DISCOUNT",
      • "externalIdentifier": { }
      }
    ],
  • "expandRevisionCreatedAt": { }
}

payable-invoices

List payable invoices

Returns a list of payable invoices.

Authorizations:
bearer
query Parameters
expand
Array of strings
Items Enum: "shipmentJobs" "shipmentJobs.addresses" "shipmentJobs.artifacts" "shipmentJobs.jobTypeInfo.address" "shipmentJobs.jobTypeInfo.organizations" "organizations" "addresses"
revisedAfter
string <utc-timestamp>
Example: revisedAfter=2020-01-01T00:00:00.000Z

Filter to only results that have been revised after this timestamp. This can be a UTC timestamp or a floating date. If a floating date is passed, the timestamp used will be the beginning (midnight UTC) of the date.

revisedBefore
string <utc-timestamp>
Example: revisedBefore=2020-01-01T00:00:00.000Z

Filter to only results that have been revised before this timestamp. This can be a UTC timestamp or a floating date. If a floating date is passed, the timestamp used will be the beginning (midnight UTC) of the date.

first
number

The number of results to return. Default value is 10. Any custom value specified must lie between 0 and 100, inclusive.

after
string

The cursor to start returning results from

Responses

Response Schema: application/json
Array of objects (PayableInvoice)
object

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "qid": "qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "createdAt": "2023-01-01T00:00:00.000Z",
      • "revisionNumber": 1,
      • "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
      • "invoiceNumber": "555-555555",
      • "paymentDueDate": "2023-01-01",
      • "issueDate": "2023-01-01",
      • "invoicedTotal": {
        • "amount": "3.50",
        • "currencyCode": "USD"
        },
      • "lineItemGroups": [
        • {
          • "name": "Linehaul",
          • "lineItems": [
            • {
              • "description": "Linehaul",
              • "invoiced": {
                • "amount": "3.50",
                • "currencyCode": "USD"
                },
              • "payment": {
                • "amount": "3.50",
                • "currencyCode": "USD"
                },
              • "category": "LINEHAUL",
              • "classification": {
                • "name": "Detention",
                • "units": [
                  • {
                    • "unitType": null,
                    • "extractedUnit": null
                    }
                  ]
                }
              }
            ]
          }
        ],
      • "shipmentJobQids": [
        • "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
        ],
      • "shipmentJobs": [
        • {
          • "qid": "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "createdAt": "2023-01-01T00:00:00.000Z",
          • "jobType": "FTL",
          • "jobTypeInfo": {
            • "freightChargeTerms": "COLLECT",
            • "billToAddressName": { },
            • "billToAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "billToAddress": {
              • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "addressLine1": "123 Main Street",
              • "addressLine2": "Suite 456",
              • "city": "Chicago",
              • "state": "IL",
              • "postalCode": "60601",
              • "country": "US"
              },
            • "carrierOrganizationName": { },
            • "carrierOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "firstOriginAddressName": { },
            • "firstOriginAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "firstOriginAddress": {
              • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "addressLine1": "123 Main Street",
              • "addressLine2": "Suite 456",
              • "city": "Chicago",
              • "state": "IL",
              • "postalCode": "60601",
              • "country": "US"
              },
            • "lastDestinationAddressName": { },
            • "lastDestinationAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "lastDestinationAddress": {
              • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "addressLine1": "123 Main Street",
              • "addressLine2": "Suite 456",
              • "city": "Chicago",
              • "state": "IL",
              • "postalCode": "60601",
              • "country": "US"
              },
            • "carrierOrganization": {
              • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "displayName": "ACME"
              },
            • "stops": [
              • {
                • "addressName": { },
                • "addressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                • "address": {
                  • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                  • "addressLine1": "123 Main Street",
                  • "addressLine2": "Suite 456",
                  • "city": "Chicago",
                  • "state": "IL",
                  • "postalCode": "60601",
                  • "country": "US"
                  },
                • "date": "2023-01-01",
                • "organizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                • "organization": {
                  • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                  • "displayName": "ACME"
                  },
                • "stopType": "DROP_OFF",
                • "articlesSummary": {
                  • "totalGrossWeight": {
                    • "amount": "20.2",
                    • "unit": "POUND"
                    },
                  • "totalPackageCount": {
                    • "amount": null,
                    • "unit": null
                    },
                  • "totalHandlingUnit": {
                    • "amount": null,
                    • "unit": null
                    }
                  },
                • "articles": [
                  • {
                    • "description": { },
                    • "dimensions": null,
                    • "grossWeight": null,
                    • "nmfcClass": null,
                    • "nmfcCode": null,
                    • "packageCount": null,
                    • "handlingUnit": null
                    }
                  ],
                • "referenceNumbers": [
                  • {
                    • "key": null,
                    • "value": null
                    }
                  ]
                }
              ]
            },
          • "addresses": [
            • {
              • "addressName": "string",
              • "addressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "address": {
                • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                • "addressLine1": "123 Main Street",
                • "addressLine2": "Suite 456",
                • "city": "Chicago",
                • "state": "IL",
                • "postalCode": "60601",
                • "country": "US"
                },
              • "addressType": "PICKUP"
              }
            ],
          • "referenceNumbers": {
            • "bolNumber": "BOL123456789X",
            • "externalIdentifier": "EXID987654321Z"
            },
          • "referenceNumbersList": [
            • {
              • "key": "PO_NUMBER",
              • "value": "123",
              • "label": "po"
              }
            ],
          • "artifacts": {
            • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "artifactType": "INVOICE",
            • "assessedTypes": [
              • "PROOF_OF_DELIVERY"
              ],
            • "receivedAt": "2023-01-01T00:00:00.000Z"
            }
          }
        ],
      • "artifactQids": [
        • "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
        ],
      • "artifacts": [
        • {
          • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "artifactType": "INVOICE"
          }
        ],
      • "referenceNumbers": [
        • {
          • "key": "PO_NUMBER",
          • "value": "123",
          • "label": "po"
          }
        ],
      • "payeeOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "payeeOrganization": {
        • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "displayName": "ACME"
        },
      • "payeeAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "payeeAddress": {
        • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "addressLine1": "123 Main Street",
        • "addressLine2": "Suite 456",
        • "city": "Chicago",
        • "state": "IL",
        • "postalCode": "60601",
        • "country": "US"
        },
      • "payeeFboOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "payorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "payorOrganization": {
        • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "displayName": "ACME"
        },
      • "vendorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "vendorOrganization": {
        • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "displayName": "ACME"
        },
      • "vendorAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "vendorAddress": {
        • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "addressLine1": "123 Main Street",
        • "addressLine2": "Suite 456",
        • "city": "Chicago",
        • "state": "IL",
        • "postalCode": "60601",
        • "country": "US"
        },
      • "otherAddresses": [
        • {
          • "addressName": "string",
          • "addressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "address": {
            • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "addressLine1": "123 Main Street",
            • "addressLine2": "Suite 456",
            • "city": "Chicago",
            • "state": "IL",
            • "postalCode": "60601",
            • "country": "US"
            },
          • "addressType": "ORIGIN"
          }
        ],
      • "dates": [
        • {
          • "date": "2023-01-01",
          • "dateType": "PICKUP"
          }
        ],
      • "receivedAt": "2023-01-01T00:00:00.000Z",
      • "lineItemSummary": {
        • "totalGrossWeight": {
          • "amount": "20.2",
          • "unit": "POUND"
          }
        }
      }
    ],
  • "pageInfo": {
    • "hasPreviousPage": true,
    • "hasNextPage": true,
    • "startCursor": "string",
    • "endCursor": "string"
    }
}

Retrieve a payable invoice

Returns the payable invoice with the specified QID

Authorizations:
bearer
path Parameters
qid
required
string <qid>
Example: qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c5

QID of the entity to retrieve

query Parameters
expand
Array of strings
Items Enum: "shipmentJobs" "shipmentJobs.addresses" "shipmentJobs.artifacts" "shipmentJobs.jobTypeInfo.address" "shipmentJobs.jobTypeInfo.organizations" "organizations" "addresses"

Responses

Response Schema: application/json
qid
required
string <qid>

Qualified unique identifier.

createdAt
required
string <utc-timestamp>
revisionNumber
required
number
revisionCreatedAt
required
string <utc-timestamp>
invoiceNumber
required
string

The invoice number

paymentDueDate
required
string or null <floating-date>
issueDate
required
string or null <floating-date>
required
object

The total amount invoiced for the payable invoice

required
Array of objects (PayableInvoiceLineItemGroup)

The line items, grouped into categories like "Linehaul" and "Fuel surcharge"

shipmentJobQids
required
Array of strings <qid>

Qualified unique identifier.

Array of objects (ShipmentJobExpanded)
artifactQids
required
Array of strings <qid>

Qualified unique identifier.

Array of objects (ArtifactExpanded)
required
Array of objects (PayableInvoiceReferenceNumber)

The reference numbers associated with this invoice.

payeeOrganizationQid
required
string <qid>

Qualified unique identifier.

object

The payee associated with this invoice. This is an expansion field. To include this field, you must include organization in the query parameters.

payeeAddressQid
required
string or null <qid>

Qualified unique identifier.

object

The payee address of this invoice. This is an expansion field. To include this field, you must include address in the query parameters.

payeeFboOrganizationQid
required
string or null <qid>

Deprecated, prefer vendorOrganizationQid

payorOrganizationQid
required
string <qid>

Qualified unique identifier.

object

The payor associated with this invoice. This is an expansion field. To include this field, you must include organization in the query parameters.

vendorOrganizationQid
required
string <qid>

Qualified unique identifier.

object

The vendor associated with this invoice. This is an expansion field. To include this field, you must include organization in the query parameters.

vendorAddressQid
required
string or null <qid>

Qualified unique identifier.

object

The vendor address of this invoice. This is an expansion field. To include this field, you must include address in the query parameters.

required
Array of objects (PayableInvoiceAddress)

Other addresses associated with this invoice

required
Array of objects (PayableInvoiceDate)

Dates associated with this invoice

receivedAt
required
string or null <utc-timestamp>
required
object (PayableInvoiceLineItemSummary)

Response samples

Content type
application/json
{
  • "qid": "qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "revisionNumber": 1,
  • "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
  • "invoiceNumber": "555-555555",
  • "paymentDueDate": "2023-01-01",
  • "issueDate": "2023-01-01",
  • "invoicedTotal": {
    • "amount": "3.50",
    • "currencyCode": "USD"
    },
  • "lineItemGroups": [
    • {
      • "name": "Linehaul",
      • "lineItems": [
        • {
          • "description": "Linehaul",
          • "invoiced": {
            • "amount": "3.50",
            • "currencyCode": "USD"
            },
          • "payment": {
            • "amount": "3.50",
            • "currencyCode": "USD"
            },
          • "category": "LINEHAUL",
          • "classification": {
            • "name": "Detention",
            • "units": [
              • {
                • "unitType": "START_TIME",
                • "extractedUnit": "14:10"
                }
              ]
            }
          }
        ]
      }
    ],
  • "shipmentJobQids": [
    • "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
    ],
  • "shipmentJobs": [
    • {
      • "qid": "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "createdAt": "2023-01-01T00:00:00.000Z",
      • "jobType": "FTL",
      • "jobTypeInfo": {
        • "freightChargeTerms": "COLLECT",
        • "billToAddressName": { },
        • "billToAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "billToAddress": {
          • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "addressLine1": "123 Main Street",
          • "addressLine2": "Suite 456",
          • "city": "Chicago",
          • "state": "IL",
          • "postalCode": "60601",
          • "country": "US"
          },
        • "carrierOrganizationName": { },
        • "carrierOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "firstOriginAddressName": { },
        • "firstOriginAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "firstOriginAddress": {
          • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "addressLine1": "123 Main Street",
          • "addressLine2": "Suite 456",
          • "city": "Chicago",
          • "state": "IL",
          • "postalCode": "60601",
          • "country": "US"
          },
        • "lastDestinationAddressName": { },
        • "lastDestinationAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "lastDestinationAddress": {
          • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "addressLine1": "123 Main Street",
          • "addressLine2": "Suite 456",
          • "city": "Chicago",
          • "state": "IL",
          • "postalCode": "60601",
          • "country": "US"
          },
        • "carrierOrganization": {
          • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "displayName": "ACME"
          },
        • "stops": [
          • {
            • "addressName": { },
            • "addressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "address": {
              • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "addressLine1": "123 Main Street",
              • "addressLine2": "Suite 456",
              • "city": "Chicago",
              • "state": "IL",
              • "postalCode": "60601",
              • "country": "US"
              },
            • "date": "2023-01-01",
            • "organizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "organization": {
              • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "displayName": "ACME"
              },
            • "stopType": "DROP_OFF",
            • "articlesSummary": {
              • "totalGrossWeight": {
                • "amount": "20.2",
                • "unit": "POUND"
                },
              • "totalPackageCount": {
                • "amount": 8,
                • "unit": "CARTON"
                },
              • "totalHandlingUnit": {
                • "amount": 8,
                • "unit": "PALLET"
                }
              },
            • "articles": [
              • {
                • "description": { },
                • "dimensions": {
                  • "height": "2.8",
                  • "length": "12.1",
                  • "width": "1.5",
                  • "unit": "INCH"
                  },
                • "grossWeight": {
                  • "amount": "20.2",
                  • "unit": "POUND"
                  },
                • "nmfcClass": "50",
                • "nmfcCode": "87700",
                • "packageCount": {
                  • "amount": 8,
                  • "unit": "CARTON"
                  },
                • "handlingUnit": {
                  • "amount": 8,
                  • "unit": "PALLET"
                  }
                }
              ],
            • "referenceNumbers": [
              • {
                • "key": "PO_NUMBER",
                • "value": "123"
                }
              ]
            }
          ]
        },
      • "addresses": [
        • {
          • "addressName": "string",
          • "addressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "address": {
            • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "addressLine1": "123 Main Street",
            • "addressLine2": "Suite 456",
            • "city": "Chicago",
            • "state": "IL",
            • "postalCode": "60601",
            • "country": "US"
            },
          • "addressType": "PICKUP"
          }
        ],
      • "referenceNumbers": {
        • "bolNumber": "BOL123456789X",
        • "externalIdentifier": "EXID987654321Z"
        },
      • "referenceNumbersList": [
        • {
          • "key": "PO_NUMBER",
          • "value": "123",
          • "label": "po"
          }
        ],
      • "artifacts": {
        • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "artifactType": "INVOICE",
        • "assessedTypes": [
          • "PROOF_OF_DELIVERY"
          ],
        • "receivedAt": "2023-01-01T00:00:00.000Z"
        }
      }
    ],
  • "artifactQids": [
    • "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
    ],
  • "artifacts": [
    • {
      • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "artifactType": "INVOICE"
      }
    ],
  • "referenceNumbers": [
    • {
      • "key": "PO_NUMBER",
      • "value": "123",
      • "label": "po"
      }
    ],
  • "payeeOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "payeeOrganization": {
    • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
    • "displayName": "ACME"
    },
  • "payeeAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "payeeAddress": {
    • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
    • "addressLine1": "123 Main Street",
    • "addressLine2": "Suite 456",
    • "city": "Chicago",
    • "state": "IL",
    • "postalCode": "60601",
    • "country": "US"
    },
  • "payeeFboOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "payorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "payorOrganization": {
    • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
    • "displayName": "ACME"
    },
  • "vendorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "vendorOrganization": {
    • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
    • "displayName": "ACME"
    },
  • "vendorAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "vendorAddress": {
    • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
    • "addressLine1": "123 Main Street",
    • "addressLine2": "Suite 456",
    • "city": "Chicago",
    • "state": "IL",
    • "postalCode": "60601",
    • "country": "US"
    },
  • "otherAddresses": [
    • {
      • "addressName": "string",
      • "addressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "address": {
        • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "addressLine1": "123 Main Street",
        • "addressLine2": "Suite 456",
        • "city": "Chicago",
        • "state": "IL",
        • "postalCode": "60601",
        • "country": "US"
        },
      • "addressType": "ORIGIN"
      }
    ],
  • "dates": [
    • {
      • "date": "2023-01-01",
      • "dateType": "PICKUP"
      }
    ],
  • "receivedAt": "2023-01-01T00:00:00.000Z",
  • "lineItemSummary": {
    • "totalGrossWeight": {
      • "amount": "20.2",
      • "unit": "POUND"
      }
    }
}

payments

List payments

Returns a list of payments completed in the given time range

Authorizations:
bearer
query Parameters
expand
Array of strings
Items Enum: "payableInvoiceSummaries" "payableInvoiceSummaries.invoice" "payableInvoiceSummaries.invoice.artifacts" "payableInvoiceSummaries.invoice.organizations" "payableInvoiceSummaries.invoice.shipmentJobs" "payableInvoiceSummaries.invoice.shipmentJobs.addresses" "payableInvoiceSummaries.invoice.shipmentJobs.artifacts" "payableInvoiceSummaries.invoice.shipmentJobs.jobTypeInfo.address" "payableInvoiceSummaries.invoice.shipmentJobs.jobTypeInfo.organizations"
initiatedBefore
string <utc-timestamp>
Example: initiatedBefore=2020-01-01T00:00:00.000Z

Filter to only results that have been initiated before this timestamp. This can be a UTC timestamp or a floating date. If a floating date is passed, the timestamp used will be the beginning (midnight UTC) of the date.

initiatedAfter
string <utc-timestamp>
Example: initiatedAfter=2020-01-01T00:00:00.000Z

Filter to only results that have been initiated after this timestamp. This can be a UTC timestamp or a floating date. If a floating date is passed, the timestamp used will be the beginning (midnight UTC) of the date.

completedBefore
string <utc-timestamp>
Example: completedBefore=2020-01-01T00:00:00.000Z

Filter to only results that have been complete before this timestamp. This can be a UTC timestamp or a floating date. If a floating date is passed, the timestamp used will be the beginning (midnight UTC) of the date.

completedAfter
string <utc-timestamp>
Example: completedAfter=2020-01-01T00:00:00.000Z

Filter to only results that have been complete after this timestamp. This can be a UTC timestamp or a floating date. If a floating date is passed, the timestamp used will be the beginning (midnight UTC) of the date.

first
number

The number of results to return. Default value is 10. Any custom value specified must lie between 0 and 100, inclusive.

after
string

The cursor to start returning results from

Responses

Response Schema: application/json
Array of objects (Payment)
object

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "qid": "qid::payment:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "displayId": "LP12345678",
      • "initiatedAt": "2023-01-01T00:00:00.000Z",
      • "completedAt": "2023-01-01T00:00:00.000Z",
      • "total": {
        • "amount": "3.50",
        • "currencyCode": "USD"
        },
      • "payorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "payeeOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "paymentStatus": "PAID",
      • "payableInvoiceSummaries": [
        • {
          • "invoiceQid": "qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "paymentTotal": {
            • "amount": "3.50",
            • "currencyCode": "USD"
            },
          • "groupedAmounts": [
            • {
              • "groupKey": "LINEHAUL",
              • "paymentAmount": {
                • "amount": "3.50",
                • "currencyCode": "USD"
                }
              }
            ],
          • "invoice": {
            • "qid": "qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "invoiceNumber": "555-555555",
            • "paymentDueDate": "2023-01-01",
            • "issueDate": "2023-01-01",
            • "invoicedTotal": {
              • "amount": "3.50",
              • "currencyCode": "USD"
              },
            • "shipmentJobQids": [
              • "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
              ],
            • "shipmentJobs": {
              • "qid": "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "createdAt": "2023-01-01T00:00:00.000Z",
              • "jobType": "FTL",
              • "jobTypeInfo": {
                • "freightChargeTerms": "COLLECT",
                • "billToAddressName": { },
                • "billToAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                • "billToAddress": {
                  • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                  • "addressLine1": "123 Main Street",
                  • "addressLine2": "Suite 456",
                  • "city": "Chicago",
                  • "state": "IL",
                  • "postalCode": "60601",
                  • "country": "US"
                  },
                • "carrierOrganizationName": { },
                • "carrierOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                • "firstOriginAddressName": { },
                • "firstOriginAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                • "firstOriginAddress": {
                  • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                  • "addressLine1": "123 Main Street",
                  • "addressLine2": "Suite 456",
                  • "city": "Chicago",
                  • "state": "IL",
                  • "postalCode": "60601",
                  • "country": "US"
                  },
                • "lastDestinationAddressName": { },
                • "lastDestinationAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                • "lastDestinationAddress": {
                  • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                  • "addressLine1": "123 Main Street",
                  • "addressLine2": "Suite 456",
                  • "city": "Chicago",
                  • "state": "IL",
                  • "postalCode": "60601",
                  • "country": "US"
                  },
                • "carrierOrganization": {
                  • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                  • "displayName": "ACME"
                  },
                • "stops": [
                  • {
                    • "addressName": { },
                    • "addressQid": null,
                    • "address": null,
                    • "date": null,
                    • "organizationQid": null,
                    • "organization": null,
                    • "stopType": null,
                    • "articlesSummary": null,
                    • "articles": [ ],
                    • "referenceNumbers": [ ]
                    }
                  ]
                },
              • "addresses": [
                • {
                  • "addressName": "string",
                  • "addressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                  • "address": {
                    • "qid": null,
                    • "addressLine1": null,
                    • "addressLine2": null,
                    • "city": null,
                    • "state": null,
                    • "postalCode": null,
                    • "country": null
                    },
                  • "addressType": "PICKUP"
                  }
                ],
              • "referenceNumbers": {
                • "bolNumber": "BOL123456789X",
                • "externalIdentifier": "EXID987654321Z"
                },
              • "referenceNumbersList": [
                • {
                  • "key": "PO_NUMBER",
                  • "value": "123",
                  • "label": "po"
                  }
                ],
              • "artifacts": {
                • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                • "artifactType": "INVOICE",
                • "assessedTypes": [
                  • "PROOF_OF_DELIVERY"
                  ],
                • "receivedAt": "2023-01-01T00:00:00.000Z"
                }
              },
            • "artifactQids": [
              • "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
              ],
            • "artifacts": {
              • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "artifactType": "INVOICE"
              },
            • "payeeOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "payeeOrganization": {
              • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "displayName": "ACME"
              },
            • "payeeFboOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "payorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "payorOrganization": {
              • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "displayName": "ACME"
              },
            • "vendorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "vendorOrganization": {
              • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "displayName": "ACME"
              },
            • "receivedAt": "2023-01-01T00:00:00.000Z"
            }
          }
        ]
      }
    ],
  • "pageInfo": {
    • "hasPreviousPage": true,
    • "hasNextPage": true,
    • "startCursor": "string",
    • "endCursor": "string"
    }
}

Retrieve a payment

Returns the payment with the specified QID

Authorizations:
bearer
path Parameters
qid
required
string <qid>
Example: qid::payment:0ca6f700-4137-4d09-b44a-43bb8d7900c5

QID of the entity to retrieve

query Parameters
expand
Array of strings
Items Enum: "payableInvoiceSummaries" "payableInvoiceSummaries.invoice" "payableInvoiceSummaries.invoice.artifacts" "payableInvoiceSummaries.invoice.organizations" "payableInvoiceSummaries.invoice.shipmentJobs" "payableInvoiceSummaries.invoice.shipmentJobs.addresses" "payableInvoiceSummaries.invoice.shipmentJobs.artifacts" "payableInvoiceSummaries.invoice.shipmentJobs.jobTypeInfo.address" "payableInvoiceSummaries.invoice.shipmentJobs.jobTypeInfo.organizations"

Responses

Response Schema: application/json
qid
required
string <qid>

Qualified unique identifier.

displayId
required
string

The display ID. This is the payment number shown in app and is included in payment memos (e.g. ACH description).

initiatedAt
required
string <utc-timestamp>
completedAt
required
string <utc-timestamp>
required
object

The amount for this payment

payorOrganizationQid
required
string <qid>

Qualified unique identifier.

payeeOrganizationQid
required
string <qid>

Qualified unique identifier.

paymentStatus
required
string
Enum: "IN_PROGRESS" "PAID" "FAILED"

Payment status

Array of objects (PaymentPayableInvoiceSummary)

A summary of payments per payable invoice. This is an expansion field. To include this field, you must include payableInvoiceSummaries in the query parameters.

Response samples

Content type
application/json
{
  • "qid": "qid::payment:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "displayId": "LP12345678",
  • "initiatedAt": "2023-01-01T00:00:00.000Z",
  • "completedAt": "2023-01-01T00:00:00.000Z",
  • "total": {
    • "amount": "3.50",
    • "currencyCode": "USD"
    },
  • "payorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "payeeOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "paymentStatus": "PAID",
  • "payableInvoiceSummaries": [
    • {
      • "invoiceQid": "qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "paymentTotal": {
        • "amount": "3.50",
        • "currencyCode": "USD"
        },
      • "groupedAmounts": [
        • {
          • "groupKey": "LINEHAUL",
          • "paymentAmount": {
            • "amount": "3.50",
            • "currencyCode": "USD"
            }
          }
        ],
      • "invoice": {
        • "qid": "qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "invoiceNumber": "555-555555",
        • "paymentDueDate": "2023-01-01",
        • "issueDate": "2023-01-01",
        • "invoicedTotal": {
          • "amount": "3.50",
          • "currencyCode": "USD"
          },
        • "shipmentJobQids": [
          • "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
          ],
        • "shipmentJobs": {
          • "qid": "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "createdAt": "2023-01-01T00:00:00.000Z",
          • "jobType": "FTL",
          • "jobTypeInfo": {
            • "freightChargeTerms": "COLLECT",
            • "billToAddressName": { },
            • "billToAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "billToAddress": {
              • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "addressLine1": "123 Main Street",
              • "addressLine2": "Suite 456",
              • "city": "Chicago",
              • "state": "IL",
              • "postalCode": "60601",
              • "country": "US"
              },
            • "carrierOrganizationName": { },
            • "carrierOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "firstOriginAddressName": { },
            • "firstOriginAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "firstOriginAddress": {
              • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "addressLine1": "123 Main Street",
              • "addressLine2": "Suite 456",
              • "city": "Chicago",
              • "state": "IL",
              • "postalCode": "60601",
              • "country": "US"
              },
            • "lastDestinationAddressName": { },
            • "lastDestinationAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "lastDestinationAddress": {
              • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "addressLine1": "123 Main Street",
              • "addressLine2": "Suite 456",
              • "city": "Chicago",
              • "state": "IL",
              • "postalCode": "60601",
              • "country": "US"
              },
            • "carrierOrganization": {
              • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "displayName": "ACME"
              },
            • "stops": [
              • {
                • "addressName": { },
                • "addressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                • "address": {
                  • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                  • "addressLine1": "123 Main Street",
                  • "addressLine2": "Suite 456",
                  • "city": "Chicago",
                  • "state": "IL",
                  • "postalCode": "60601",
                  • "country": "US"
                  },
                • "date": "2023-01-01",
                • "organizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                • "organization": {
                  • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                  • "displayName": "ACME"
                  },
                • "stopType": "DROP_OFF",
                • "articlesSummary": {
                  • "totalGrossWeight": {
                    • "amount": "20.2",
                    • "unit": "POUND"
                    },
                  • "totalPackageCount": {
                    • "amount": null,
                    • "unit": null
                    },
                  • "totalHandlingUnit": {
                    • "amount": null,
                    • "unit": null
                    }
                  },
                • "articles": [
                  • {
                    • "description": { },
                    • "dimensions": null,
                    • "grossWeight": null,
                    • "nmfcClass": null,
                    • "nmfcCode": null,
                    • "packageCount": null,
                    • "handlingUnit": null
                    }
                  ],
                • "referenceNumbers": [
                  • {
                    • "key": null,
                    • "value": null
                    }
                  ]
                }
              ]
            },
          • "addresses": [
            • {
              • "addressName": "string",
              • "addressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "address": {
                • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                • "addressLine1": "123 Main Street",
                • "addressLine2": "Suite 456",
                • "city": "Chicago",
                • "state": "IL",
                • "postalCode": "60601",
                • "country": "US"
                },
              • "addressType": "PICKUP"
              }
            ],
          • "referenceNumbers": {
            • "bolNumber": "BOL123456789X",
            • "externalIdentifier": "EXID987654321Z"
            },
          • "referenceNumbersList": [
            • {
              • "key": "PO_NUMBER",
              • "value": "123",
              • "label": "po"
              }
            ],
          • "artifacts": {
            • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "artifactType": "INVOICE",
            • "assessedTypes": [
              • "PROOF_OF_DELIVERY"
              ],
            • "receivedAt": "2023-01-01T00:00:00.000Z"
            }
          },
        • "artifactQids": [
          • "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
          ],
        • "artifacts": {
          • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "artifactType": "INVOICE"
          },
        • "payeeOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "payeeOrganization": {
          • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "displayName": "ACME"
          },
        • "payeeFboOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "payorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "payorOrganization": {
          • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "displayName": "ACME"
          },
        • "vendorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "vendorOrganization": {
          • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "displayName": "ACME"
          },
        • "receivedAt": "2023-01-01T00:00:00.000Z"
        }
      }
    ]
}

ping

Send a ping

Authorizations:
bearer

Responses

Response Schema: application/json
pong
required
number
Default: 1

Response samples

Content type
application/json
{
  • "pong": 1
}

receivable-invoices

List receivable invoices

Returns a list of receivable invoices.

Authorizations:
bearer
query Parameters
expand
Array of strings
Items Enum: "supportingArtifacts" "lineItems.invoiceDeliveryMethod" "shipments" "shipments.shipmentJobs" "shipments.shipmentJobs.addresses" "shipments.shipmentJobs.artifacts" "shipments.shipmentJobs.jobTypeInfo.address" "shipments.shipmentJobs.jobTypeInfo.organizations"
status
Array of strings
Items Enum: "DRAFT" "OPEN" "VOID" "PAID"
revisedAfter
string <utc-timestamp>
Example: revisedAfter=2020-01-01T00:00:00.000Z

Filter to only results that have been revised after this timestamp. This can be a UTC timestamp or a floating date. If a floating date is passed, the timestamp used will be the beginning (midnight UTC) of the date.

revisedBefore
string <utc-timestamp>
Example: revisedBefore=2020-01-01T00:00:00.000Z

Filter to only results that have been revised before this timestamp. This can be a UTC timestamp or a floating date. If a floating date is passed, the timestamp used will be the beginning (midnight UTC) of the date.

first
number

The number of results to return. Default value is 10. Any custom value specified must lie between 0 and 100, inclusive.

after
string

The cursor to start returning results from

sort
string
Enum: "createdAt" "revisionCreatedAt"

The field used for sorting the results. If not provided, 'createdAt' will be used as the default sort field.

order
string
Enum: "asc" "desc"

The sort order used for the given sort field. If not provided, the default sort order is 'asc'.

issuedBefore
string <utc-timestamp>
Example: issuedBefore=2020-01-01T00:00:00.000Z

Filter to only results that have been issued (finalized and set to status OPEN) before this timestamp. This can be a UTC timestamp or a floating date. If a floating date is passed, the timestamp used will be the beginning (midnight UTC) of the date.

issuedAfter
string <utc-timestamp>
Example: issuedAfter=2020-01-01T00:00:00.000Z

Filter to only results that have been issued (finalized and set to status OPEN) after this timestamp. This can be a UTC timestamp or a floating date. If a floating date is passed, the timestamp used will be the beginning (midnight UTC) of the date.

Responses

Response Schema: application/json
Array of objects (ReceivableInvoice)
object

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "qid": "qid::receivable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "createdAt": "2023-01-01T00:00:00.000Z",
      • "revisionNumber": 1,
      • "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
      • "invoiceNumber": "555-555555",
      • "payorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "payeeOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "status": "DRAFT",
      • "noteToPayor": "The note to the payor.",
      • "issuedAt": "2023-01-01T00:00:00.000Z",
      • "dueDate": "2023-01-01",
      • "total": {
        • "amount": "3.50",
        • "currencyCode": "USD"
        },
      • "adjustmentSubtotal": {
        • "amount": "3.50",
        • "currencyCode": "USD"
        },
      • "lineItems": [
        • {
          • "description": "Linehaul",
          • "amount": {
            • "amount": "3.50",
            • "currencyCode": "USD"
            },
          • "kind": "ORIGINAL",
          • "invoiceDeliveryMethod": "EMAIL",
          • "externalChargeCode": "LH"
          }
        ],
      • "supportingArtifacts": {
        • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "artifactType": "INVOICE"
        },
      • "shipments": {
        • "qid": "qid::shipment:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "shipmentJobs": {
          • "qid": "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "createdAt": "2023-01-01T00:00:00.000Z",
          • "jobType": "FTL",
          • "jobTypeInfo": {
            • "freightChargeTerms": "COLLECT",
            • "billToAddressName": { },
            • "billToAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "billToAddress": {
              • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "addressLine1": "123 Main Street",
              • "addressLine2": "Suite 456",
              • "city": "Chicago",
              • "state": "IL",
              • "postalCode": "60601",
              • "country": "US"
              },
            • "carrierOrganizationName": { },
            • "carrierOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "firstOriginAddressName": { },
            • "firstOriginAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "firstOriginAddress": {
              • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "addressLine1": "123 Main Street",
              • "addressLine2": "Suite 456",
              • "city": "Chicago",
              • "state": "IL",
              • "postalCode": "60601",
              • "country": "US"
              },
            • "lastDestinationAddressName": { },
            • "lastDestinationAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "lastDestinationAddress": {
              • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "addressLine1": "123 Main Street",
              • "addressLine2": "Suite 456",
              • "city": "Chicago",
              • "state": "IL",
              • "postalCode": "60601",
              • "country": "US"
              },
            • "carrierOrganization": {
              • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "displayName": "ACME"
              },
            • "stops": [
              • {
                • "addressName": { },
                • "addressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                • "address": {
                  • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                  • "addressLine1": "123 Main Street",
                  • "addressLine2": "Suite 456",
                  • "city": "Chicago",
                  • "state": "IL",
                  • "postalCode": "60601",
                  • "country": "US"
                  },
                • "date": "2023-01-01",
                • "organizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                • "organization": {
                  • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                  • "displayName": "ACME"
                  },
                • "stopType": "DROP_OFF",
                • "articlesSummary": {
                  • "totalGrossWeight": {
                    • "amount": "20.2",
                    • "unit": "POUND"
                    },
                  • "totalPackageCount": {
                    • "amount": null,
                    • "unit": null
                    },
                  • "totalHandlingUnit": {
                    • "amount": null,
                    • "unit": null
                    }
                  },
                • "articles": [
                  • {
                    • "description": { },
                    • "dimensions": null,
                    • "grossWeight": null,
                    • "nmfcClass": null,
                    • "nmfcCode": null,
                    • "packageCount": null,
                    • "handlingUnit": null
                    }
                  ],
                • "referenceNumbers": [
                  • {
                    • "key": null,
                    • "value": null
                    }
                  ]
                }
              ]
            },
          • "addresses": [
            • {
              • "addressName": "string",
              • "addressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "address": {
                • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                • "addressLine1": "123 Main Street",
                • "addressLine2": "Suite 456",
                • "city": "Chicago",
                • "state": "IL",
                • "postalCode": "60601",
                • "country": "US"
                },
              • "addressType": "PICKUP"
              }
            ],
          • "referenceNumbers": {
            • "bolNumber": "BOL123456789X",
            • "externalIdentifier": "EXID987654321Z"
            },
          • "referenceNumbersList": [
            • {
              • "key": "PO_NUMBER",
              • "value": "123",
              • "label": "po"
              }
            ],
          • "artifacts": {
            • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "artifactType": "INVOICE",
            • "assessedTypes": [
              • "PROOF_OF_DELIVERY"
              ],
            • "receivedAt": "2023-01-01T00:00:00.000Z"
            }
          }
        }
      }
    ],
  • "pageInfo": {
    • "hasPreviousPage": true,
    • "hasNextPage": true,
    • "startCursor": "string",
    • "endCursor": "string"
    }
}

Retrieve a receivable invoice

Returns the receivable invoice with the specified QID.

Authorizations:
bearer
path Parameters
qid
required
string <qid>
Example: qid::receivable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c5

QID of the entity to retrieve

query Parameters
expand
Array of strings
Items Enum: "supportingArtifacts" "lineItems.invoiceDeliveryMethod" "shipments" "shipments.shipmentJobs" "shipments.shipmentJobs.addresses" "shipments.shipmentJobs.artifacts" "shipments.shipmentJobs.jobTypeInfo.address" "shipments.shipmentJobs.jobTypeInfo.organizations"

Responses

Response Schema: application/json
qid
required
string <qid>

Qualified unique identifier.

createdAt
required
string <utc-timestamp>
revisionNumber
required
number
revisionCreatedAt
required
string <utc-timestamp>
invoiceNumber
required
string

The invoice number

payorOrganizationQid
required
string <qid>

Qualified unique identifier.

payeeOrganizationQid
required
string <qid>

Qualified unique identifier.

status
required
string
Enum: "DRAFT" "OPEN" "VOID" "PAID"
noteToPayor
required
string
issuedAt
required
string or null <utc-timestamp>

When the draft version of this invoice was finalized.

dueDate
required
string or null <floating-date>

The date the invoice is due.

required
object

The total amount invoiced.

required
object

The total amount invoiced from ADJUSTMENT line items.

required
Array of objects (ReceivableInvoiceLineItem)
object

Supporting artifacts attached to the receivable invoice. This is an expansion field. To include this field, you must include supportingArtifacts in the query parameters.

object

Shipments related to the receivable invoice. This is an expansion field. To include this field, you must include shipments in the query parameters.

Response samples

Content type
application/json
{
  • "qid": "qid::receivable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "revisionNumber": 1,
  • "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
  • "invoiceNumber": "555-555555",
  • "payorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "payeeOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "status": "DRAFT",
  • "noteToPayor": "The note to the payor.",
  • "issuedAt": "2023-01-01T00:00:00.000Z",
  • "dueDate": "2023-01-01",
  • "total": {
    • "amount": "3.50",
    • "currencyCode": "USD"
    },
  • "adjustmentSubtotal": {
    • "amount": "3.50",
    • "currencyCode": "USD"
    },
  • "lineItems": [
    • {
      • "description": "Linehaul",
      • "amount": {
        • "amount": "3.50",
        • "currencyCode": "USD"
        },
      • "kind": "ORIGINAL",
      • "invoiceDeliveryMethod": "EMAIL",
      • "externalChargeCode": "LH"
      }
    ],
  • "supportingArtifacts": {
    • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
    • "artifactType": "INVOICE"
    },
  • "shipments": {
    • "qid": "qid::shipment:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
    • "shipmentJobs": {
      • "qid": "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "createdAt": "2023-01-01T00:00:00.000Z",
      • "jobType": "FTL",
      • "jobTypeInfo": {
        • "freightChargeTerms": "COLLECT",
        • "billToAddressName": { },
        • "billToAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "billToAddress": {
          • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "addressLine1": "123 Main Street",
          • "addressLine2": "Suite 456",
          • "city": "Chicago",
          • "state": "IL",
          • "postalCode": "60601",
          • "country": "US"
          },
        • "carrierOrganizationName": { },
        • "carrierOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "firstOriginAddressName": { },
        • "firstOriginAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "firstOriginAddress": {
          • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "addressLine1": "123 Main Street",
          • "addressLine2": "Suite 456",
          • "city": "Chicago",
          • "state": "IL",
          • "postalCode": "60601",
          • "country": "US"
          },
        • "lastDestinationAddressName": { },
        • "lastDestinationAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "lastDestinationAddress": {
          • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "addressLine1": "123 Main Street",
          • "addressLine2": "Suite 456",
          • "city": "Chicago",
          • "state": "IL",
          • "postalCode": "60601",
          • "country": "US"
          },
        • "carrierOrganization": {
          • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "displayName": "ACME"
          },
        • "stops": [
          • {
            • "addressName": { },
            • "addressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "address": {
              • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "addressLine1": "123 Main Street",
              • "addressLine2": "Suite 456",
              • "city": "Chicago",
              • "state": "IL",
              • "postalCode": "60601",
              • "country": "US"
              },
            • "date": "2023-01-01",
            • "organizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "organization": {
              • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "displayName": "ACME"
              },
            • "stopType": "DROP_OFF",
            • "articlesSummary": {
              • "totalGrossWeight": {
                • "amount": "20.2",
                • "unit": "POUND"
                },
              • "totalPackageCount": {
                • "amount": 8,
                • "unit": "CARTON"
                },
              • "totalHandlingUnit": {
                • "amount": 8,
                • "unit": "PALLET"
                }
              },
            • "articles": [
              • {
                • "description": { },
                • "dimensions": {
                  • "height": "2.8",
                  • "length": "12.1",
                  • "width": "1.5",
                  • "unit": "INCH"
                  },
                • "grossWeight": {
                  • "amount": "20.2",
                  • "unit": "POUND"
                  },
                • "nmfcClass": "50",
                • "nmfcCode": "87700",
                • "packageCount": {
                  • "amount": 8,
                  • "unit": "CARTON"
                  },
                • "handlingUnit": {
                  • "amount": 8,
                  • "unit": "PALLET"
                  }
                }
              ],
            • "referenceNumbers": [
              • {
                • "key": "PO_NUMBER",
                • "value": "123"
                }
              ]
            }
          ]
        },
      • "addresses": [
        • {
          • "addressName": "string",
          • "addressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "address": {
            • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "addressLine1": "123 Main Street",
            • "addressLine2": "Suite 456",
            • "city": "Chicago",
            • "state": "IL",
            • "postalCode": "60601",
            • "country": "US"
            },
          • "addressType": "PICKUP"
          }
        ],
      • "referenceNumbers": {
        • "bolNumber": "BOL123456789X",
        • "externalIdentifier": "EXID987654321Z"
        },
      • "referenceNumbersList": [
        • {
          • "key": "PO_NUMBER",
          • "value": "123",
          • "label": "po"
          }
        ],
      • "artifacts": {
        • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "artifactType": "INVOICE",
        • "assessedTypes": [
          • "PROOF_OF_DELIVERY"
          ],
        • "receivedAt": "2023-01-01T00:00:00.000Z"
        }
      }
    }
}

Delete a draft receivable invoice

Delete a draft receivable invoice. The operation will succeed if the invoice was already deleted or there is no AR invoice identified by the QID.

Authorizations:
bearer
path Parameters
qid
required
string <qid>
Example: qid::receivable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c5

QID of the entity to delete

Responses

Void an open receivable invoice

Void an open receivable invoice. The operation will succeed if the invoice is already void.

Authorizations:
bearer
path Parameters
qid
required
string <qid>
Example: qid::receivable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c5

QID of the entity to void

query Parameters
expand
Array of strings
Items Enum: "supportingArtifacts" "lineItems.invoiceDeliveryMethod" "shipments" "shipments.shipmentJobs" "shipments.shipmentJobs.addresses" "shipments.shipmentJobs.artifacts" "shipments.shipmentJobs.jobTypeInfo.address" "shipments.shipmentJobs.jobTypeInfo.organizations"

Responses

Response Schema: application/json
qid
required
string <qid>

Qualified unique identifier.

createdAt
required
string <utc-timestamp>
revisionNumber
required
number
revisionCreatedAt
required
string <utc-timestamp>
invoiceNumber
required
string

The invoice number

payorOrganizationQid
required
string <qid>

Qualified unique identifier.

payeeOrganizationQid
required
string <qid>

Qualified unique identifier.

status
required
string
Enum: "DRAFT" "OPEN" "VOID" "PAID"
noteToPayor
required
string
issuedAt
required
string or null <utc-timestamp>

When the draft version of this invoice was finalized.

dueDate
required
string or null <floating-date>

The date the invoice is due.

required
object

The total amount invoiced.

required
object

The total amount invoiced from ADJUSTMENT line items.

required
Array of objects (ReceivableInvoiceLineItem)
object

Supporting artifacts attached to the receivable invoice. This is an expansion field. To include this field, you must include supportingArtifacts in the query parameters.

object

Shipments related to the receivable invoice. This is an expansion field. To include this field, you must include shipments in the query parameters.

Response samples

Content type
application/json
{
  • "qid": "qid::receivable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "revisionNumber": 1,
  • "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
  • "invoiceNumber": "555-555555",
  • "payorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "payeeOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "status": "DRAFT",
  • "noteToPayor": "The note to the payor.",
  • "issuedAt": "2023-01-01T00:00:00.000Z",
  • "dueDate": "2023-01-01",
  • "total": {
    • "amount": "3.50",
    • "currencyCode": "USD"
    },
  • "adjustmentSubtotal": {
    • "amount": "3.50",
    • "currencyCode": "USD"
    },
  • "lineItems": [
    • {
      • "description": "Linehaul",
      • "amount": {
        • "amount": "3.50",
        • "currencyCode": "USD"
        },
      • "kind": "ORIGINAL",
      • "invoiceDeliveryMethod": "EMAIL",
      • "externalChargeCode": "LH"
      }
    ],
  • "supportingArtifacts": {
    • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
    • "artifactType": "INVOICE"
    },
  • "shipments": {
    • "qid": "qid::shipment:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
    • "shipmentJobs": {
      • "qid": "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "createdAt": "2023-01-01T00:00:00.000Z",
      • "jobType": "FTL",
      • "jobTypeInfo": {
        • "freightChargeTerms": "COLLECT",
        • "billToAddressName": { },
        • "billToAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "billToAddress": {
          • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "addressLine1": "123 Main Street",
          • "addressLine2": "Suite 456",
          • "city": "Chicago",
          • "state": "IL",
          • "postalCode": "60601",
          • "country": "US"
          },
        • "carrierOrganizationName": { },
        • "carrierOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "firstOriginAddressName": { },
        • "firstOriginAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "firstOriginAddress": {
          • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "addressLine1": "123 Main Street",
          • "addressLine2": "Suite 456",
          • "city": "Chicago",
          • "state": "IL",
          • "postalCode": "60601",
          • "country": "US"
          },
        • "lastDestinationAddressName": { },
        • "lastDestinationAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "lastDestinationAddress": {
          • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "addressLine1": "123 Main Street",
          • "addressLine2": "Suite 456",
          • "city": "Chicago",
          • "state": "IL",
          • "postalCode": "60601",
          • "country": "US"
          },
        • "carrierOrganization": {
          • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "displayName": "ACME"
          },
        • "stops": [
          • {
            • "addressName": { },
            • "addressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "address": {
              • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "addressLine1": "123 Main Street",
              • "addressLine2": "Suite 456",
              • "city": "Chicago",
              • "state": "IL",
              • "postalCode": "60601",
              • "country": "US"
              },
            • "date": "2023-01-01",
            • "organizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "organization": {
              • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "displayName": "ACME"
              },
            • "stopType": "DROP_OFF",
            • "articlesSummary": {
              • "totalGrossWeight": {
                • "amount": "20.2",
                • "unit": "POUND"
                },
              • "totalPackageCount": {
                • "amount": 8,
                • "unit": "CARTON"
                },
              • "totalHandlingUnit": {
                • "amount": 8,
                • "unit": "PALLET"
                }
              },
            • "articles": [
              • {
                • "description": { },
                • "dimensions": {
                  • "height": "2.8",
                  • "length": "12.1",
                  • "width": "1.5",
                  • "unit": "INCH"
                  },
                • "grossWeight": {
                  • "amount": "20.2",
                  • "unit": "POUND"
                  },
                • "nmfcClass": "50",
                • "nmfcCode": "87700",
                • "packageCount": {
                  • "amount": 8,
                  • "unit": "CARTON"
                  },
                • "handlingUnit": {
                  • "amount": 8,
                  • "unit": "PALLET"
                  }
                }
              ],
            • "referenceNumbers": [
              • {
                • "key": "PO_NUMBER",
                • "value": "123"
                }
              ]
            }
          ]
        },
      • "addresses": [
        • {
          • "addressName": "string",
          • "addressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "address": {
            • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "addressLine1": "123 Main Street",
            • "addressLine2": "Suite 456",
            • "city": "Chicago",
            • "state": "IL",
            • "postalCode": "60601",
            • "country": "US"
            },
          • "addressType": "PICKUP"
          }
        ],
      • "referenceNumbers": {
        • "bolNumber": "BOL123456789X",
        • "externalIdentifier": "EXID987654321Z"
        },
      • "referenceNumbersList": [
        • {
          • "key": "PO_NUMBER",
          • "value": "123",
          • "label": "po"
          }
        ],
      • "artifacts": {
        • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "artifactType": "INVOICE",
        • "assessedTypes": [
          • "PROOF_OF_DELIVERY"
          ],
        • "receivedAt": "2023-01-01T00:00:00.000Z"
        }
      }
    }
}

shipment-jobs

List shipment jobs

Returns a list of shipment jobs.

Authorizations:
bearer
query Parameters
expand
Array of strings
Items Enum: "addresses" "artifacts" "billingStatus" "payableInvoices" "payableInvoices.artifacts" "payableInvoices.organizations" "payableInvoices.shipmentJobs" "payableInvoices.shipmentJobs.addresses" "payableInvoices.shipmentJobs.artifacts" "payableInvoices.shipmentJobs.jobTypeInfo.address" "payableInvoices.shipmentJobs.jobTypeInfo.organizations" "jobTypeInfo.address" "jobTypeInfo.organizations"
jobType
Array of strings
Items Enum: "FTL" "GENERIC_V1" "LTL" "TONU" "TO_BE_DETERMINED" "UNKNOWN"

A set of job types to filter to.

externalIdentifier
string
revisedAfter
string <utc-timestamp>
Example: revisedAfter=2020-01-01T00:00:00.000Z

Filter to only results that have been revised after this timestamp. This can be a UTC timestamp or a floating date. If a floating date is passed, the timestamp used will be the beginning (midnight UTC) of the date.

revisedBefore
string <utc-timestamp>
Example: revisedBefore=2020-01-01T00:00:00.000Z

Filter to only results that have been revised before this timestamp. This can be a UTC timestamp or a floating date. If a floating date is passed, the timestamp used will be the beginning (midnight UTC) of the date.

first
number

The number of results to return. Default value is 10. Any custom value specified must lie between 0 and 100, inclusive.

after
string

The cursor to start returning results from

artifactQid
string <qid>
Example: artifactQid=qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c5

QID of the artifact

Responses

Response Schema: application/json
Array of objects (ShipmentJob)
object

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "qid": "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "createdAt": "2023-01-01T00:00:00.000Z",
      • "revisionNumber": 1,
      • "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
      • "jobType": "FTL",
      • "jobTypeInfo": {
        • "freightChargeTerms": "COLLECT",
        • "billToAddressName": { },
        • "billToAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "billToAddress": {
          • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "addressLine1": "123 Main Street",
          • "addressLine2": "Suite 456",
          • "city": "Chicago",
          • "state": "IL",
          • "postalCode": "60601",
          • "country": "US"
          },
        • "carrierOrganizationName": { },
        • "carrierOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "firstOriginAddressName": { },
        • "firstOriginAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "firstOriginAddress": {
          • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "addressLine1": "123 Main Street",
          • "addressLine2": "Suite 456",
          • "city": "Chicago",
          • "state": "IL",
          • "postalCode": "60601",
          • "country": "US"
          },
        • "lastDestinationAddressName": { },
        • "lastDestinationAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "lastDestinationAddress": {
          • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "addressLine1": "123 Main Street",
          • "addressLine2": "Suite 456",
          • "city": "Chicago",
          • "state": "IL",
          • "postalCode": "60601",
          • "country": "US"
          },
        • "carrierOrganization": {
          • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "displayName": "ACME"
          },
        • "stops": [
          • {
            • "addressName": { },
            • "addressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "address": {
              • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "addressLine1": "123 Main Street",
              • "addressLine2": "Suite 456",
              • "city": "Chicago",
              • "state": "IL",
              • "postalCode": "60601",
              • "country": "US"
              },
            • "date": "2023-01-01",
            • "organizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "organization": {
              • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "displayName": "ACME"
              },
            • "stopType": "DROP_OFF",
            • "articlesSummary": {
              • "totalGrossWeight": {
                • "amount": "20.2",
                • "unit": "POUND"
                },
              • "totalPackageCount": {
                • "amount": 8,
                • "unit": "CARTON"
                },
              • "totalHandlingUnit": {
                • "amount": 8,
                • "unit": "PALLET"
                }
              },
            • "articles": [
              • {
                • "description": { },
                • "dimensions": {
                  • "height": "2.8",
                  • "length": "12.1",
                  • "width": "1.5",
                  • "unit": "INCH"
                  },
                • "grossWeight": {
                  • "amount": "20.2",
                  • "unit": "POUND"
                  },
                • "nmfcClass": "50",
                • "nmfcCode": "87700",
                • "packageCount": {
                  • "amount": 8,
                  • "unit": "CARTON"
                  },
                • "handlingUnit": {
                  • "amount": 8,
                  • "unit": "PALLET"
                  }
                }
              ],
            • "referenceNumbers": [
              • {
                • "key": "PO_NUMBER",
                • "value": "123"
                }
              ]
            }
          ]
        },
      • "artifactQids": [
        • "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
        ],
      • "artifacts": {
        • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "artifactType": "INVOICE",
        • "assessedTypes": [
          • "PROOF_OF_DELIVERY"
          ],
        • "receivedAt": "2023-01-01T00:00:00.000Z"
        },
      • "billingStatus": "COMPLETE",
      • "payableInvoices": {
        • "qid": "qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "invoiceNumber": "555-555555",
        • "paymentDueDate": "2023-01-01",
        • "issueDate": "2023-01-01",
        • "invoicedTotal": {
          • "amount": "3.50",
          • "currencyCode": "USD"
          },
        • "shipmentJobQids": [
          • "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
          ],
        • "shipmentJobs": {
          • "qid": "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "createdAt": "2023-01-01T00:00:00.000Z",
          • "jobType": "FTL",
          • "jobTypeInfo": {
            • "freightChargeTerms": "COLLECT",
            • "billToAddressName": { },
            • "billToAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "billToAddress": {
              • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "addressLine1": "123 Main Street",
              • "addressLine2": "Suite 456",
              • "city": "Chicago",
              • "state": "IL",
              • "postalCode": "60601",
              • "country": "US"
              },
            • "carrierOrganizationName": { },
            • "carrierOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "firstOriginAddressName": { },
            • "firstOriginAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "firstOriginAddress": {
              • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "addressLine1": "123 Main Street",
              • "addressLine2": "Suite 456",
              • "city": "Chicago",
              • "state": "IL",
              • "postalCode": "60601",
              • "country": "US"
              },
            • "lastDestinationAddressName": { },
            • "lastDestinationAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "lastDestinationAddress": {
              • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "addressLine1": "123 Main Street",
              • "addressLine2": "Suite 456",
              • "city": "Chicago",
              • "state": "IL",
              • "postalCode": "60601",
              • "country": "US"
              },
            • "carrierOrganization": {
              • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "displayName": "ACME"
              },
            • "stops": [
              • {
                • "addressName": { },
                • "addressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                • "address": {
                  • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                  • "addressLine1": "123 Main Street",
                  • "addressLine2": "Suite 456",
                  • "city": "Chicago",
                  • "state": "IL",
                  • "postalCode": "60601",
                  • "country": "US"
                  },
                • "date": "2023-01-01",
                • "organizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                • "organization": {
                  • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                  • "displayName": "ACME"
                  },
                • "stopType": "DROP_OFF",
                • "articlesSummary": {
                  • "totalGrossWeight": {
                    • "amount": "20.2",
                    • "unit": "POUND"
                    },
                  • "totalPackageCount": {
                    • "amount": null,
                    • "unit": null
                    },
                  • "totalHandlingUnit": {
                    • "amount": null,
                    • "unit": null
                    }
                  },
                • "articles": [
                  • {
                    • "description": { },
                    • "dimensions": null,
                    • "grossWeight": null,
                    • "nmfcClass": null,
                    • "nmfcCode": null,
                    • "packageCount": null,
                    • "handlingUnit": null
                    }
                  ],
                • "referenceNumbers": [
                  • {
                    • "key": null,
                    • "value": null
                    }
                  ]
                }
              ]
            },
          • "addresses": [
            • {
              • "addressName": "string",
              • "addressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "address": {
                • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
                • "addressLine1": "123 Main Street",
                • "addressLine2": "Suite 456",
                • "city": "Chicago",
                • "state": "IL",
                • "postalCode": "60601",
                • "country": "US"
                },
              • "addressType": "PICKUP"
              }
            ],
          • "referenceNumbers": {
            • "bolNumber": "BOL123456789X",
            • "externalIdentifier": "EXID987654321Z"
            },
          • "referenceNumbersList": [
            • {
              • "key": "PO_NUMBER",
              • "value": "123",
              • "label": "po"
              }
            ],
          • "artifacts": {
            • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "artifactType": "INVOICE",
            • "assessedTypes": [
              • "PROOF_OF_DELIVERY"
              ],
            • "receivedAt": "2023-01-01T00:00:00.000Z"
            }
          },
        • "artifactQids": [
          • "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
          ],
        • "artifacts": {
          • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "artifactType": "INVOICE"
          },
        • "payeeOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "payeeOrganization": {
          • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "displayName": "ACME"
          },
        • "payeeFboOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "payorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "payorOrganization": {
          • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "displayName": "ACME"
          },
        • "vendorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "vendorOrganization": {
          • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "displayName": "ACME"
          },
        • "receivedAt": "2023-01-01T00:00:00.000Z"
        },
      • "addresses": [
        • {
          • "addressName": "string",
          • "addressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "address": {
            • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "addressLine1": "123 Main Street",
            • "addressLine2": "Suite 456",
            • "city": "Chicago",
            • "state": "IL",
            • "postalCode": "60601",
            • "country": "US"
            },
          • "addressType": "PICKUP"
          }
        ],
      • "referenceNumbers": {
        • "bolNumber": "BOL123456789X",
        • "externalIdentifier": "EXID987654321Z"
        },
      • "referenceNumbersList": [
        • {
          • "key": "PO_NUMBER",
          • "value": "123",
          • "label": "po"
          }
        ]
      }
    ],
  • "pageInfo": {
    • "hasPreviousPage": true,
    • "hasNextPage": true,
    • "startCursor": "string",
    • "endCursor": "string"
    }
}

Retrieve a shipment job

Returns the shipment job with the specified QID

Authorizations:
bearer
path Parameters
qid
required
string <qid>
Example: qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c5

QID of the entity to retrieve

query Parameters
expand
Array of strings
Items Enum: "addresses" "artifacts" "billingStatus" "payableInvoices" "payableInvoices.artifacts" "payableInvoices.organizations" "payableInvoices.shipmentJobs" "payableInvoices.shipmentJobs.addresses" "payableInvoices.shipmentJobs.artifacts" "payableInvoices.shipmentJobs.jobTypeInfo.address" "payableInvoices.shipmentJobs.jobTypeInfo.organizations" "jobTypeInfo.address" "jobTypeInfo.organizations"

Responses

Response Schema: application/json
qid
required
string <qid>

Qualified unique identifier.

createdAt
required
string <utc-timestamp>
revisionNumber
required
number
revisionCreatedAt
required
string <utc-timestamp>
jobType
required
string
Enum: "FTL" "GENERIC_V1" "LTL" "TONU" "TO_BE_DETERMINED" "UNKNOWN"
required
(ShipmentJobFtlInfo (object or null)) or (ShipmentJobLtlInfo (object or null)) or (ShipmentJobTonuInfo (object or null)) or (ShipmentJobUnknownInfo (object or null))

The job type info, if applicable.

artifactQids
required
Array of strings <qid>

Qualified unique identifier.

object

The shipment job artifacts This is an expansion field. To include this field, you must include artifacts in the query parameters.

billingStatus
string
Enum: "COMPLETE" "INCOMPLETE"

The shipment job's billing status This is an expansion field. To include this field, you must include billingStatus in the query parameters.

object

The payable invoices associated with the shipment job. This is an expansion field. To include this field, you must include payableInvoices in the query parameters.

required
Array of objects (ShipmentJobAddress)

Addresses associated with this shipment job.

required
object

The shipment job's reference numbers

required
Array of objects (ShipmentReferenceNumber)

All of the shipment job's reference numbers.

Response samples

Content type
application/json
{
  • "qid": "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "revisionNumber": 1,
  • "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
  • "jobType": "FTL",
  • "jobTypeInfo": {
    • "freightChargeTerms": "COLLECT",
    • "billToAddressName": { },
    • "billToAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
    • "billToAddress": {
      • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "addressLine1": "123 Main Street",
      • "addressLine2": "Suite 456",
      • "city": "Chicago",
      • "state": "IL",
      • "postalCode": "60601",
      • "country": "US"
      },
    • "carrierOrganizationName": { },
    • "carrierOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
    • "firstOriginAddressName": { },
    • "firstOriginAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
    • "firstOriginAddress": {
      • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "addressLine1": "123 Main Street",
      • "addressLine2": "Suite 456",
      • "city": "Chicago",
      • "state": "IL",
      • "postalCode": "60601",
      • "country": "US"
      },
    • "lastDestinationAddressName": { },
    • "lastDestinationAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
    • "lastDestinationAddress": {
      • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "addressLine1": "123 Main Street",
      • "addressLine2": "Suite 456",
      • "city": "Chicago",
      • "state": "IL",
      • "postalCode": "60601",
      • "country": "US"
      },
    • "carrierOrganization": {
      • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "displayName": "ACME"
      },
    • "stops": [
      • {
        • "addressName": { },
        • "addressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "address": {
          • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "addressLine1": "123 Main Street",
          • "addressLine2": "Suite 456",
          • "city": "Chicago",
          • "state": "IL",
          • "postalCode": "60601",
          • "country": "US"
          },
        • "date": "2023-01-01",
        • "organizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "organization": {
          • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "displayName": "ACME"
          },
        • "stopType": "DROP_OFF",
        • "articlesSummary": {
          • "totalGrossWeight": {
            • "amount": "20.2",
            • "unit": "POUND"
            },
          • "totalPackageCount": {
            • "amount": 8,
            • "unit": "CARTON"
            },
          • "totalHandlingUnit": {
            • "amount": 8,
            • "unit": "PALLET"
            }
          },
        • "articles": [
          • {
            • "description": { },
            • "dimensions": {
              • "height": "2.8",
              • "length": "12.1",
              • "width": "1.5",
              • "unit": "INCH"
              },
            • "grossWeight": {
              • "amount": "20.2",
              • "unit": "POUND"
              },
            • "nmfcClass": "50",
            • "nmfcCode": "87700",
            • "packageCount": {
              • "amount": 8,
              • "unit": "CARTON"
              },
            • "handlingUnit": {
              • "amount": 8,
              • "unit": "PALLET"
              }
            }
          ],
        • "referenceNumbers": [
          • {
            • "key": "PO_NUMBER",
            • "value": "123"
            }
          ]
        }
      ]
    },
  • "artifactQids": [
    • "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
    ],
  • "artifacts": {
    • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
    • "artifactType": "INVOICE",
    • "assessedTypes": [
      • "PROOF_OF_DELIVERY"
      ],
    • "receivedAt": "2023-01-01T00:00:00.000Z"
    },
  • "billingStatus": "COMPLETE",
  • "payableInvoices": {
    • "qid": "qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
    • "invoiceNumber": "555-555555",
    • "paymentDueDate": "2023-01-01",
    • "issueDate": "2023-01-01",
    • "invoicedTotal": {
      • "amount": "3.50",
      • "currencyCode": "USD"
      },
    • "shipmentJobQids": [
      • "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
      ],
    • "shipmentJobs": {
      • "qid": "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "createdAt": "2023-01-01T00:00:00.000Z",
      • "jobType": "FTL",
      • "jobTypeInfo": {
        • "freightChargeTerms": "COLLECT",
        • "billToAddressName": { },
        • "billToAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "billToAddress": {
          • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "addressLine1": "123 Main Street",
          • "addressLine2": "Suite 456",
          • "city": "Chicago",
          • "state": "IL",
          • "postalCode": "60601",
          • "country": "US"
          },
        • "carrierOrganizationName": { },
        • "carrierOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "firstOriginAddressName": { },
        • "firstOriginAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "firstOriginAddress": {
          • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "addressLine1": "123 Main Street",
          • "addressLine2": "Suite 456",
          • "city": "Chicago",
          • "state": "IL",
          • "postalCode": "60601",
          • "country": "US"
          },
        • "lastDestinationAddressName": { },
        • "lastDestinationAddressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "lastDestinationAddress": {
          • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "addressLine1": "123 Main Street",
          • "addressLine2": "Suite 456",
          • "city": "Chicago",
          • "state": "IL",
          • "postalCode": "60601",
          • "country": "US"
          },
        • "carrierOrganization": {
          • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "displayName": "ACME"
          },
        • "stops": [
          • {
            • "addressName": { },
            • "addressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "address": {
              • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "addressLine1": "123 Main Street",
              • "addressLine2": "Suite 456",
              • "city": "Chicago",
              • "state": "IL",
              • "postalCode": "60601",
              • "country": "US"
              },
            • "date": "2023-01-01",
            • "organizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "organization": {
              • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
              • "displayName": "ACME"
              },
            • "stopType": "DROP_OFF",
            • "articlesSummary": {
              • "totalGrossWeight": {
                • "amount": "20.2",
                • "unit": "POUND"
                },
              • "totalPackageCount": {
                • "amount": 8,
                • "unit": "CARTON"
                },
              • "totalHandlingUnit": {
                • "amount": 8,
                • "unit": "PALLET"
                }
              },
            • "articles": [
              • {
                • "description": { },
                • "dimensions": {
                  • "height": "2.8",
                  • "length": "12.1",
                  • "width": "1.5",
                  • "unit": "INCH"
                  },
                • "grossWeight": {
                  • "amount": "20.2",
                  • "unit": "POUND"
                  },
                • "nmfcClass": "50",
                • "nmfcCode": "87700",
                • "packageCount": {
                  • "amount": 8,
                  • "unit": "CARTON"
                  },
                • "handlingUnit": {
                  • "amount": 8,
                  • "unit": "PALLET"
                  }
                }
              ],
            • "referenceNumbers": [
              • {
                • "key": "PO_NUMBER",
                • "value": "123"
                }
              ]
            }
          ]
        },
      • "addresses": [
        • {
          • "addressName": "string",
          • "addressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
          • "address": {
            • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
            • "addressLine1": "123 Main Street",
            • "addressLine2": "Suite 456",
            • "city": "Chicago",
            • "state": "IL",
            • "postalCode": "60601",
            • "country": "US"
            },
          • "addressType": "PICKUP"
          }
        ],
      • "referenceNumbers": {
        • "bolNumber": "BOL123456789X",
        • "externalIdentifier": "EXID987654321Z"
        },
      • "referenceNumbersList": [
        • {
          • "key": "PO_NUMBER",
          • "value": "123",
          • "label": "po"
          }
        ],
      • "artifacts": {
        • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "artifactType": "INVOICE",
        • "assessedTypes": [
          • "PROOF_OF_DELIVERY"
          ],
        • "receivedAt": "2023-01-01T00:00:00.000Z"
        }
      },
    • "artifactQids": [
      • "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
      ],
    • "artifacts": {
      • "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "artifactType": "INVOICE"
      },
    • "payeeOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
    • "payeeOrganization": {
      • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "displayName": "ACME"
      },
    • "payeeFboOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
    • "payorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
    • "payorOrganization": {
      • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "displayName": "ACME"
      },
    • "vendorOrganizationQid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
    • "vendorOrganization": {
      • "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "displayName": "ACME"
      },
    • "receivedAt": "2023-01-01T00:00:00.000Z"
    },
  • "addresses": [
    • {
      • "addressName": "string",
      • "addressQid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      • "address": {
        • "qid": "qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
        • "addressLine1": "123 Main Street",
        • "addressLine2": "Suite 456",
        • "city": "Chicago",
        • "state": "IL",
        • "postalCode": "60601",
        • "country": "US"
        },
      • "addressType": "PICKUP"
      }
    ],
  • "referenceNumbers": {
    • "bolNumber": "BOL123456789X",
    • "externalIdentifier": "EXID987654321Z"
    },
  • "referenceNumbersList": [
    • {
      • "key": "PO_NUMBER",
      • "value": "123",
      • "label": "po"
      }
    ]
}