search
☰

Preview

voidInvoice is in Preview status and is subject to change without notice. For more information about Preview status, see the GraphQL API policy.

voidInvoice

Void an invoice

This page contains

    Authorization Rules

    This request requires authorization with at least one of the following scopes:

    Scopes

    ROLE_CHANNEL_ADMIN

    ROLE_PARTNER

    billing.invoice.void.instance

    Arguments

    input VoidInvoiceInput! PREVIEW

    VoidInvoiceInput fields

    invoiceId ID!

    UUID of the invoice to void

    Return Fields

    invoice Invoice PREVIEW

    The invoice that was voided

    creditMemos [CreditMemo] PREVIEW

    The credit memos that were updated, either balance restored or voided.

    operationStatus BalanceOperationStatus PREVIEW

    Status of the balance operation, either SUCCEEDED or FAILED

    userErrors [VoidInvoiceError!] PREVIEW

    User errors in the void invoice request

    Interactive example

    This is an example mutation query. Use the embedded interactive tool below to edit the query.

    Hint: use Ctrl + Space for autocompleting fields.