Preview

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

voidCreditMemo

Void a credit memo

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 VoidCreditMemoInput! PREVIEW

    VoidCreditMemoInput fields

    creditMemoId ID!

    UUID of the credit memo to void

    Return Fields

    creditMemo CreditMemo PREVIEW

    The credit memo that was voided.

    operationStatus BalanceOperationStatus PREVIEW

    Status of the balance operation (SUCCEEDED or FAILED) when the void is attempted. Null when the request terminates with a user error.

    userErrors [VoidCreditMemoError!] PREVIEW

    User errors in the void credit memo 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.