search
☰

Preview

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

closeCreditMemo

Close 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 CloseCreditMemoInput! PREVIEW

    CloseCreditMemoInput fields

    creditMemoId ID!

    UUID of the credit memo to close

    Return Fields

    creditMemo CreditMemo PREVIEW

    The credit memo that was closed.

    operationStatus BalanceOperationStatus PREVIEW

    Status of the operation, either SUCCEEDED or FAILED

    userErrors [CloseCreditMemoError!] PREVIEW

    User errors in the close 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.