List Invoices

import requests
url = "https://api-b2b.bigcommerce.com/api/v3/io/ip/invoices"
headers = {"X-Auth-Token": "<apiKey>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "code": 200,
  "data": [
    {
      "customerId": "3",
      "originalBalance": {
        "code": "USD",
        "value": "400.0000"
      },
      "openBalance": {
        "code": "USD",
        "value": "400.0000"
      },
      "id": 33,
      "externalCustomerId": "123",
      "externalId": "123",
      "invoiceNumber": "00000033",
      "type": "Invoice on Shipment",
      "dueDate": 1619826907,
      "status": 0,
      "orderNumber": "132",
      "purchaseOrderNumber": "123",
      "details": {
        "type": "StandardInvoiceDetails",
        "header": {
          "costLines": [
            {
              "amount": {
                "code": "USD",
                "value": "400.0000"
              },
              "description": "Subtotal"
            },
            {
              "amount": {
                "code": "USD",
                "value": "0.0000"
              },
              "description": "Freight"
            },
            {
              "amount": {
                "code": "USD",
                "value": "0.0000"
              },
              "description": "Sales Tax"
            }
          ],
          "orderDate": 1618246864,
          "billingAddress": {
            "city": "montreal",
            "state": "California",
            "country": "United States",
            "street1": "test",
            "street2": "test",
            "zipCode": "111111",
            "lastName": "test",
            "firstName": "test",
            "customFields": {}
          },
          "shippingAddresses": [
            {
              "city": "montreal",
              "state": "California",
              "country": "United States",
              "street1": "test",
              "street2": "test",
              "zipCode": "111111",
              "lastName": "test",
              "firstName": "test",
              "customFields": {}
            }
          ],
          "customerFields": {}
        },
        "details": {
          "lineItems": [
            {
              "sku": "CLC",
              "type": "physical",
              "comments": "item comments",
              "quantity": "2",
              "unitPrice": {
                "code": "USD",
                "value": "200.0000"
              },
              "description": "[Sample] Canvas Laundry Cart",
              "unitDiscount": {
                "code": "USD",
                "value": "0"
              },
              "customFields": {}
            }
          ],
          "shipments": [
            {
              "addressIndex": "string",
              "shipDate": "string",
              "shipVia": "string",
              "trackingNumber": "string",
              "comments": "string",
              "customFields": {}
            }
          ]
        }
      },
      "isPendingPayment": 1,
      "source": 0,
      "customerName": "ABC123",
      "channelId": "1",
      "channelName": "string"
    }
  ]
}

get invoices

Authentication

X-Auth-Tokenstring

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Authentication header

Header	Argument	Description
`X-Store-Hash`	`store_hash`	The unique store hash associated with a BigCommerce store that has B2B Edition enabled.

### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Store-Hash` | `store_hash` | The unique store hash associated with a BigCommerce store that has B2B Edition enabled. |

Query parameters

offsetdoubleOptional

limitdoubleOptional

orderByenumOptional

"DESC" or "ASC"

Allowed values:

sortByenumOptional

Sort by the field value

searchByenumOptional

Filter by a field

qstringOptional

You can perform keyword queries on fields corresponding to the value of "searchBy" or, if "searchBy" is empty, on all fields supported by "searchBy".

customerNamestringOptional

Query by invoice B2B Edition company name

customerIdstringOptional

Query by invoice B2B Edition company ID

statusenumOptional

Query by invoice status

Allowed values:

beginDateAtstringOptional

Query by the created timestamp, along with the "endDateAt" parameter

endDateAtstringOptional

Query by the created timestamp, along with the with the "beginDateAt" parameter

externalId[]list of doublesOptional

Query by the invoice external ID

isIncludeExtraFieldsenumOptional

Determine if extra fields should show in the response

Allowed values:

channelIdslist of doublesOptional

BigCommerce Channel IDs

Response

codedouble

datalist of objects

metaobject

Authentication

Authentication header

Further reading

Authentication header

Query parameters

Response

Authentication header

Further reading

Authentication header