checkout

Graphql fields and variables for the checkout mutation

Pay a Quote or an Invoice

Scope required: standard:write

mutation checkout ($payableId: ID!, $invoiceId: ID!, $quoteId: ID!, $paymentMethodId: ID!, $paymentMethodData: CheckoutPaymentMethodAttributes!) {
  checkout (payableId: $payableId, invoiceId: $invoiceId, quoteId: $quoteId, paymentMethodId: $paymentMethodId, paymentMethodData: $paymentMethodData) {
      invoice {
        accountId
        amount
        amountDue
        amountPaid
        baseCurrencyId
        baseCurrencyTotal
        couponApplied
        createdAt
        credits
        currencyId
        description
        dueAt
        hasPaymentMethod
        id
        isLegacy
        issuedAt
        kind
        netPaymentDays
        notes
        number
        paidAt
        payableId
        poNumber
        portalUrl
        quoteId
        smallUnitAmountDue
        subtotal
        taxAmount
        taxRate
        updatedAt
        url
        uuid
      }
      payment {
        accountId
        amount
        amountUnapplied
        baseCurrencyCash
        baseCurrencyId
        completedAt
        conversionRate
        createdAt
        currencyId
        description
        errorCode
        errorMessage
        fees
        id
        isLegacy
        memo
        paymentProcessor
        receivedAt
        remoteTransactionId
        startedAt
        updatedAt
      }
      paymentApplication {
        amount
        createdAt
        currencyId
        id
        invoiceId
        memo
        paymentId
        paymentType
        updatedAt
      }
      transaction {
        accountId
        amount
        createdAt
        currencyId
        description
        id
        state
        transactionableId
      }
  }
}

Arguments

{
  "payableId": "456123",
  "invoiceId": "456123",
  "quoteId": "456123",
  "paymentMethodId": "456123",
  "paymentMethodData": {
    "pluginGuid": "456123",
    "token": "",
    "metadata": "JSON",
    "savePaymentMethod": true
  }
}