invoices

Graphql fields and variables for the invoices query

Scope required: billing:read

For a complete list of possible response fields see the InvoiceConnection type.

query invoices ($after: String, $before: String, $first: Int, $last: Int, $filter: String, $viewId: ID, $sort: String) {
  invoices (after: $after, before: $before, first: $first, last: $last, filter: $filter, viewId: $viewId, sort: $sort) {
    edges {
      cursor
      node {
        accountId
        amount
        amountDue
        amountPaid
        baseCurrencyId
        couponApplied
        createdAt
        credits
        currencyId
        description
        dueAt
        hasPaymentMethod
        id
        isLegacy
        issuedAt
        kind
        netPaymentDays
        notes
        number
        paidAt
        payableId
        poNumber
        portalUrl
        quoteId
        smallUnitAmountDue
        subtotal
        taxAmount
        updatedAt
        url
        uuid
      }
    }
    totalCount
    pageInfo {
      startCursor
      endCursor
      hasNextPage
      hasPreviousPage
    }
  }
}

Arguments

Name
Type
Description

after

String

Returns the elements in the list that come after the specified cursor.

before

String

Returns the elements in the list that come before the specified cursor.

first

Int

Returns the first n elements from the list.

last

Int

Returns the last n elements from the list.

filter

String

viewId

ID

sort

String

Response

Last updated

Was this helpful?