Get multiple invoices

Returns a paged list of all invoices that match the provided criteria.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200Success

application/json

Body

Example

[
    {
        "apId": 0,
        "carrierName": "string",
        "carrierScac": "string",
        "clientName": "string",
        "clientReferenceNumber": "string",
        "currencyCode": "string",
        "invoiceStatusCode": "string",
        "invoiceType": "string",
        "netAmountDue": 0,
        "totalCharges": 0,
        "vendorId": 0,
        "vendorName": "string",
        "ediType": "string",
        "ediBillToAccountCode": "string",
        "hasException": true,
        "shipmentCreatedFromInvoice": true,
        "createdDate": "2019-08-24T14:15:22Z",
        "exportedDate": "2019-08-24T14:15:22Z",
        "billingDate": "2019-08-24T14:15:22Z",
        "pickupDate": "2019-08-24T14:15:22Z",
        "deliveryDate": "2019-08-24T14:15:22Z",
        "bolAvailable": true,
        "podAvailable": true,
        "batchDetails": {
            "batchId": "string",
            "batchDate": "2019-08-24T14:15:22Z",
            "user": "string"
        },
        "shipmentDetails": {
            "bolNumber": "string",
            "customerPo": "string",
            "proNumber": "string",
            "loadId": 0,
            "externalLoadId": "13555740-d3ec-49f8-b62c-32a6b8e8f7db",
            "payType": "string",
            "totalPieces": 0,
            "totalWeight": 0,
            "weightUnitOfMeasure": "string"
        },
        "quoteDetails": {
            "quoteNumber": "string",
            "date": "2019-08-24T14:15:22Z",
            "interline": true,
            "carrierName": "string",
            "carrierScac": "string",
            "discountAmount": 0,
            "discountPercent": 0,
            "freightCharge": 0,
            "grossCharge": 0,
            "fuelSurcharge": 0,
            "minimum": 0,
            "totalAccessorialCharges": 0,
            "totalOtherCharges": 0,
            "totalCharge": 0,
            "variance": 0
        },
        "lineItems": [
            {
                "carrierChargeCode": "string",
                "charge": 0,
                "description": "string",
                "extension": "string",
                "freightClass": "string",
                "normalizedChargeCode": "string",
                "packagingCode": "string",
                "quantity": 0,
                "weight": 0,
                "ratedAsQuantity": 0,
                "ratedAsQualifier": "string"
            }
        ],
        "payments": [
            {
                "amount": 0,
                "batchId": "string",
                "identifier": "string",
                "type": "string",
                "user": "string",
                "date": "2019-08-24T14:15:22Z"
            }
        ],
        "addresses": [
            {
                "lineOne": "string",
                "lineTwo": "string",
                "city": "string",
                "stateCode": "string",
                "postalCode": "string",
                "countryCode": "string",
                "glCode": "string",
                "idCode": "string",
                "name": "string",
                "type": "string"
            }
        ]
    }
]

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠429Too Many Requests

Returns a paged list of all invoices that match the provided criteria.#

Request

Request samples

Responses

Returns a paged list of all invoices that match the provided criteria.