paymentApplyToInvoices

Graphql fields and variables for the paymentApplyToInvoices mutation

Apply a payment to one or more invoices

Scope required: billing:write

mutation paymentApplyToInvoices ($paymentId: ID!, $invoiceIds: [ID!]!) {
  paymentApplyToInvoices (paymentId: $paymentId, invoiceIds: $invoiceIds) {
      errors
      paidInvoices
      payment {
        accountId
        amount
        amountUnapplied
        baseCurrencyCash
        baseCurrencyId
        completedAt
        conversionRate
        createdAt
        currencyId
        description
        errorCode
        errorMessage
        fees
        id
        isLegacy
        memo
        paymentProcessor
        receivedAt
        remoteTransactionId
        startedAt
        updatedAt
      }
      paymentApplications
      removedInvoices
  }
}

Arguments

{
  "paymentId": "456123",
  "invoiceIds": [
    "456123"
  ]
}

Name	Type	Description
paymentId	ID
invoiceIds	List (ID)

Response

Name	Type	Description
errors	List (String)
paidInvoices	List (Invoice)
payment	Payment
paymentApplications	List (PaymentApplication)
removedInvoices	List (Invoice)