invoiceRefund

Graphql fields and variables for the invoiceRefund mutation

Refund an invoice

Scope required: billing:write

mutation invoiceRefund ($invoiceId: ID!, $disputeReasonId: ID!) {
  invoiceRefund (invoiceId: $invoiceId, disputeReasonId: $disputeReasonId) {
      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"
}

Name	Type	Description
invoiceId	ID
disputeReasonId	ID

Response

Name	Type	Description
creditNote	CreditNote
errors	List (String)