creditNotes

Graphql fields and variables for the creditNotes query

Scope required: billing:read

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

query creditNotes ($after: String, $before: String, $first: Int, $last: Int, $filter: String, $sort: String, $viewId: ID, $format: String) {
  creditNotes (after: $after, before: $before, first: $first, last: $last, filter: $filter, sort: $sort, viewId: $viewId, format: $format) {
    edges {
      cursor
      node {
        accountId
        amount
        amountApplied
        amountUnapplied
        createdAt
        creditedInvoiceId
        currencyId
        description
        disputeId
        disputeReasonId
        entityId
        id
        isCredit
        isLegacy
        issuedAt
        number
        subtotal
        taxAmount
        updatedAt
        uuid
        warrenId
      }
    }
    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
sort	String
viewId	ID
format	String

Response

• CreditNoteConnection