invoiceGenerateNextPeriod

Graphql fields and variables for the invoiceGenerateNextPeriod mutation

Generate an invoice for the next billing period

Scope required: billing:write

mutation invoiceGenerateNextPeriod ($accountId: ID!, $billUsageCharges: Boolean!) {
  invoiceGenerateNextPeriod (accountId: $accountId, billUsageCharges: $billUsageCharges) {
      errors
      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
        updatedAt
        url
        uuid
      }
  }
}

Arguments

{
  "accountId": "456123",
  "billUsageCharges": true
}

Name	Type	Description
accountId	ID
billUsageCharges	Boolean

Response

Name	Type	Description
errors	List (String)
invoice	Invoice