creditNoteCreate

Graphql fields and variables for the creditNoteCreate mutation

Create a credit note

Scope required: billing:write

mutation creditNoteCreate ($invoiceId: ID!, $disputeReasonId: ID!, $kind: CreditNoteKind!) {
  creditNoteCreate (invoiceId: $invoiceId, disputeReasonId: $disputeReasonId, kind: $kind) {
      creditNote {
        accountId
        amount
        amountApplied
        amountUnapplied
        createdAt
        creditedInvoiceId
        currencyId
        description
        disputeReasonId
        entityId
        id
        isCredit
        isLegacy
        issuedAt
        number
        subtotal
        taxAmount
        updatedAt
        uuid
        warrenId
      }
      errors
  }
}

Arguments

{
  "invoiceId": "456123",
  "disputeReasonId": "456123",
  "kind": "CreditNoteKind"
}

Name	Type	Description
invoiceId	ID
disputeReasonId	ID
kind	CreditNoteKind

Response

Name	Type	Description
creditNote	CreditNote
errors	List (String)