invoices | BigCommerce Developer Center

query ExampleQuery($companyIds: [Int], $offset: Int, $before: String, $after: String, $first: Int, $last: Int, $search: String, $orderBy: String, $invoiceNumber: String, $type: String, $orderNumber: String, $purchaseOrderNumber: String, $externalCustomerId: String, $storeHash: String, $externalId: String, $status: [String], $beginDateAt: Decimal, $endDateAt: Decimal, $idIn: String, $beginDueDateAt: Decimal, $endDueDateAt: Decimal) {
  invoices(companyIds: $companyIds, offset: $offset, before: $before, after: $after, first: $first, last: $last, search: $search, orderBy: $orderBy, invoiceNumber: $invoiceNumber, type: $type, orderNumber: $orderNumber, purchaseOrderNumber: $purchaseOrderNumber, externalCustomerId: $externalCustomerId, storeHash: $storeHash, externalId: $externalId, status: $status, beginDateAt: $beginDateAt, endDateAt: $endDateAt, idIn: $idIn, beginDueDateAt: $beginDueDateAt, endDueDateAt: $endDueDateAt) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    edges {
      node
      cursor
    }
    totalCount
  }
}

{
  "companyIds": [],
  "offset": 0,
  "before": "example",
  "after": "example",
  "first": 0,
  "last": 0,
  "search": "example",
  "orderBy": "example",
  "invoiceNumber": "example",
  "type": "example",
  "orderNumber": "example",
  "purchaseOrderNumber": "example",
  "externalCustomerId": "example",
  "storeHash": "example",
  "externalId": "example",
  "status": [
    "example"
  ],
  "beginDateAt": "Decimal",
  "endDateAt": "Decimal",
  "idIn": "example",
  "beginDueDateAt": "Decimal",
  "endDueDateAt": "Decimal"
}

{
  "data": {
    "invoices": {
      "pageInfo": {
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example",
        "endCursor": "example"
      },
      "edges": [
        {
          "node": {
            "id": null,
            "createdAt": null,
            "updatedAt": null,
            "storeHash": null,
            "customerId": null,
            "externalId": null,
            "externalCustomerId": null,
            "invoiceNumber": null,
            "type": null,
            "dueDate": null
          },
          "cursor": "example"
        }
      ],
      "totalCount": 0
    }
  }
}

Get the list of invoices. Requires IP authentication.

Arguments

companyIdslist of optional IntegersOptional

Filter by one or more company IDs.

offsetIntegerOptional

beforeStringOptional

afterStringOptional

firstIntegerOptional

lastIntegerOptional

searchStringOptional

orderByStringOptional

Ordering

invoiceNumberStringOptional

typeStringOptional

orderNumberStringOptional

purchaseOrderNumberStringOptional

externalCustomerIdStringOptional

storeHashStringOptional

externalIdStringOptional

statuslist of optional StringsOptional

beginDateAtDecimalOptional

endDateAtDecimalOptional

idInStringOptional

beginDueDateAtDecimalOptional

endDueDateAtDecimalOptional

Returns

an optional Object

pageInfoObject

Pagination data for this connection.

edgeslist of Objects

totalCountInteger

A total count of items in the collection.