accountIdstring
The ID of the customer account associated with the invoice.
adjustmentAmountnumber
The amount of the invoice adjustments associated with the invoice.
amountnumber
The total amount of the invoice.
amountWithoutTaxnumber
The invoice amount excluding tax.
autoPayboolean
Whether invoices are automatically picked up for processing in the corresponding payment run.
balancenumber
The remaining balance of the invoice after all payments, adjustments, and refunds are applied.
billRunIdstring
The id of bill run if the invoice is generated by a bill run.
billToContactIdstring nullable
The ID of the bill-to contact associated with the invoice.
billToContactSnapshotIdstring nullable
The ID of the bill-to contact snapshot associated with the invoice.
commentsstring
Comments about the invoice.
createdByIdstring
The user ID of the person who created the invoice. If a bill run generated the invoice, then the value is the user ID of person who created the bill run.
createdDatestring
The date and time when the invoice was created, in yyyy-mm-dd hh:mm:ss format. For example, 2017-03-01 15:31:10.
creditBalanceAdjustmentAmountnumber
The currency amount of the adjustment applied to the customer's credit balance.
Note: This field is only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled.
creditMemoAmountnumber
The currency amount of all credit memos applied to this invoice.
Note: This field is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.
currencystring nullable
The currency of the invoice.
Note: By default, the currency on a billing document matches the default currency set on the associated account.
However, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency.
For more information, see <a href="https://docs.zuora.com?resourceId=billing-multiple-currencies-overview" target="_blank">Multiple Currency</a>.
discountnumber
the invoice discount amount.
dueDatestring date
The date by which the payment for this invoice is due, in yyyy-mm-dd format.
einvoiceErrorCodestring
The error code when status is "Failed". This code can either be a Zuora-generated error code or one returned by a third-party e-invoice vendor.
einvoiceErrorMessagestring
The error message when status is "Failed". This message can either be a Zuora-generated error code or one returned by a third-party e-invoice vendor.
einvoiceFileIdstring
The ID of the e-invoice file.
einvoiceStatus'Processing' | 'RetrieveTimeOut' | 'Generated' | 'Success' | 'Failed' | 'ConditionalSuccess' | 'ApprovedByAuthority' | 'Rejected'
The status of the e-invoice file generation for the invoice.
- If e-invoicing file generation succeeds, this field is either Generated or Success, and both the error code and message are empty, and the eInvoiceField fieldstores the ID of the generated e-inoice file.
- If the responses from tax vendors such as Sovos or Avalara are taking too long, this field becomes RetrieveTimeOut. Once the vendor responds successfully, you can use the 'Resync E-Invoice Status' action to update the status automatically. You can view these updates in System Health telemetry.
- If a failure occurs during e-invoice file generation, this field is Failed and error code and an error message are returned respectively in the einvoiceErrorCode and einvoiceErrorMessage fields.
- If e-invoice file generation conditionally succeeds, this field is ConditionalSuccess and an error code and an error message are returned respectively in the einvoiceErrorCode and einvoiceErrorMessage fields.
- If the e-invoice file has been approved by the tax authority, this field is ApprovedByAuthority. The next status will be either Success or Rejected.
- If the e-invoice file has been rejected by the government, this field is Rejected. You cannot resend this e-invoice; you must create a new invoice instead.
Note: This field is available only if you have the <a href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview" target="_blank">E-Invoicing</a> feature in Early Adopter phase enabled.
idstring
The unique ID of the invoice.
includesOneTimeboolean
Specifies whether the invoice includes one-time charges.
includesRecurringboolean
Specifies whether the invoice includes recurring charges.
includesUsageboolean
Specifies whether the invoice includes usage charges.
invoiceDatestring date
The date that appears on the invoice being created.
invoiceGroupNumberstring nullable
The number of the invoice group associated with the invoice.
The value of this field is null if you have the Flexible Billing Attributes feature disabled.
invoiceNumberstring
The unique identification number of the invoice.
lastEmailSentDatestring nullable
The date when the invoice was last emailed.
organizationLabelstring
The organization that this object belongs to.
Note: This field is available only when the Multi-Org feature is enabled.
paymentAmountnumber
The amount of payments applied to the invoice.
paymentTermstring nullable
The name of payment term associated with the invoice.
postedBystring nullable
The user ID of the person who moved the invoice to Posted status.
postedDatestring date nullable
The date when the invoice was posted.
refundAmountnumber
Specifies the amount of a refund that was applied against an earlier payment on the invoice.
sequenceSetIdstring nullable
The ID of the sequence set associated with the invoice.
communicationProfileIdstring nullable
The ID of the communication profile associated with the invoice.
shipToContactIdstring nullable
The ID of the ship-to contact associated with the invoice.
shipToContactSnapshotIdstring
The ID of the ship-to contact snapshot associated with the invoice.
soldToContactIdstring nullable
The ID of the sold-to contact associated with the invoice.
soldToContactSnapshotIdstring nullable
The ID of the sold-to contact snapshot associated with the invoice.
source'BillRun' | 'API' | 'ApiSubscribe' | 'ApiAmend'
The source of the invoice.
sourceIdstring
The ID of the invoice source.
If an invoice is generated from a bill run, the value is the number of the corresponding bill run.Otherwise, the value is null.
sourceType'Subscription' | 'Standalone' | 'Order' | 'Consolidation'
The type of the invoice source.
status'Draft' | 'Posted' | 'Canceled' | 'Error' | 'Split'
The status of the invoice.
Note:
-
The Split status is applicable only when you use <a href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/invoice-management/split-invoices/split-invoices-overview"
target="_blank">Split Invoice feature</a>.
-
When an invoice is split, its status changes from Draft to Split, and the newly created invoices retain a reference to the original invoice.
successboolean
Returns true if the request was processed successfully.
targetDatestring date
This date is used to determine which charges are to be billed. All charges that are to be billed on this date or prior will be included in this bill run.
taxExemptAmountnumber
The calculated tax amount excluded due to the exemption.
taxMessagestring nullable
The message that the tax engine return if it calculates the taxes of this invoice fails.
taxStatus'Complete' | 'Error' | 'UnknownError' | 'DuplicateDoc' | 'InvalidRequest' | 'InvalidResponse' | 'TaxEngineError' | 'ConcurrentModify' | 'InternalServerError' | 'TaxCodeTemplateError' | 'Voided'
The status that the tax engine return after it calculates the taxes of this invoice.
Note: This field is only applicable to tax calculation by third-party tax engines. The Voided status indicates that the tax transaction is successfully canceled on the tax vendor's side. If a tax transaction was successfully committed to the third-party tax engine but the invoice failed to post, Zuora automatically detects the issue and voids the tax transaction on the vendor's side.
templateIdstring nullable
The ID of the invoice template.
- If you have the <a href="https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing" target="_blank">Flexible Billing Attributes</a> feature enabled, the value of this field depends on the configuration of the invoice template.
- If you specify an invoice template at the subscription level, the value of this field is automatically populated from the corresponding subscription.
- If you do not specify any invoice template at the subscription level, the value of this field is automatically populated from the corresponding account.
- If you have the Flexible Billing Attributes feature disabled, the value of this field is null.
transferredToAccounting'Processing' | 'Error' | 'Ignore' | 'Yes' | 'No' nullable
Whether the invoice was transferred to an external accounting system.
updatedByIdstring
The ID of the Zuora user who last updated the invoice.
updatedDatestring
The date when the invoice was last updated.
IntegrationStatus__NSstring