creditNoteApplyToInvoices

Graphql fields and variables for the creditNoteApplyToInvoices mutation

Apply a credit note to invoices

Scope required: billing:write

mutation creditNoteApplyToInvoices ($creditNoteId: ID!, $invoiceIds: [ID!]!) {
  creditNoteApplyToInvoices (creditNoteId: $creditNoteId, invoiceIds: $invoiceIds) {
      creditNote {
        accountId
        amount
        amountApplied
        amountUnapplied
        createdAt
        creditedInvoiceId
        currencyId
        description
        disputeId
        disputeReasonId
        entityId
        id
        isCredit
        isLegacy
        issuedAt
        number
        subtotal
        taxAmount
        updatedAt
        uuid
        warrenId
      }
      errors
      paidInvoices
      paymentApplications
      removedInvoices
  }
}

Arguments

{
  "creditNoteId": "456123",
  "invoiceIds": [
    "456123"
  ]
}

Name	Type	Description
creditNoteId	ID
invoiceIds	List (ID)

Response

Name	Type	Description
creditNote	CreditNote
errors	List (String)
paidInvoices	List (Invoice)
paymentApplications	List (PaymentApplication)
removedInvoices	List (Invoice)