invoices

Requires at least one of the permissions payments:invoice:list or purchase:purchase_invoice:list.

Lists invoices, sales and purchase, with optional filters and skip / take paging. A user restricted to their own customers sees only those customers' invoices, and purchase invoices need the purchase invoices feature on your plan. Sales invoices need the invoices list permission and purchase invoices the purchase invoices list permission; a caller holding one sees only that side.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query Invoices {
  invoices {
    total
    invoices {
      id
      invoiceNumber
      supplierCode
      supplierDisplayName
      supplierName
      status
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query Invoices {\n  invoices {\n    total\n    invoices {\n      id\n      invoiceNumber\n      supplierCode\n      supplierDisplayName\n      supplierName\n      status\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "invoices": {
      "total": 0,
      "invoices": [
        {
          "id": "id",
          "invoiceNumber": "string",
          "supplierCode": "string",
          "supplierDisplayName": "string",
          "supplierName": "string",
          "status": "APPROVED"
        }
      ]
    }
  }
}

invoices(
  filter: InvoiceFilterInput
  skip: Int
  take: Int
): InvoiceConnection!

Arguments

invoices.filter ● InvoiceFilterInput input

Optional filters.

invoices.skip ● Int scalar

Number of invoices to skip. Send with take for paging.

invoices.take ● Int scalar

Number of invoices to return.

Type

InvoiceConnection object

A page of invoices and the total number that match.