paymentApplyToInvoice

Graphql fields and variables for the paymentApplyToInvoice mutation

Apply a payment to an invoice

Scope required: billing:write

mutation paymentApplyToInvoice ($paymentId: ID!, $invoiceId: ID!) {
  paymentApplyToInvoice (paymentId: $paymentId, invoiceId: $invoiceId) {
      errors
      invoice {
        accountId
        amount
        amountDue
        amountPaid
        baseCurrencyId
        couponApplied
        createdAt
        credits
        currencyId
        description
        dueAt
        hasPaymentMethod
        id
        isLegacy
        issuedAt
        kind
        netPaymentDays
        notes
        number
        paidAt
        payableId
        poNumber
        portalUrl
        quoteId
        smallUnitAmountDue
        subtotal
        taxAmount
        updatedAt
        url
        uuid
      }
      payment {
        accountId
        amount
        amountUnapplied
        baseCurrencyCash
        baseCurrencyId
        completedAt
        createdAt
        currencyId
        description
        errorCode
        errorMessage
        id
        isLegacy
        memo
        receivedAt
        remoteTransactionId
        updatedAt
      }
  }
}

Arguments

{
  "paymentId": "456123",
  "invoiceId": "456123"
}

Name	Type	Description
paymentId	ID
invoiceId	ID

Response

Name	Type	Description
errors	List (String)
invoice	Invoice
payment	Payment