Sign in
Invoices

Create a standalone invoice

Creates a standalone invoice for selling physical goods, services or other items on a non-recurring basis to your subscription customers.

To use this operation, you must have the Modify Invoice and at least one of the Create Standalone Invoice With Product Catalog or Create Standalone Invoice Without Product Catalog user permissions. See <a href="https://docs.zuora.com?resourceId=platform-billing-roles" target="_blank">Billing Roles</a> for more information.

post/v1/invoices

Headers

Idempotency-Keystring

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Request body

accountIdstring

The ID of the account associated with the invoice.

You must specify either accountNumber or accountId for a customer account. If both of them are specified, they must refer to the same customer account.

accountNumberstring

The Number of the account associated with the invoice. You must specify either accountNumber or accountId for a customer account. If both of them are specified, they must refer to the same customer account.

autoPayboolean

Whether invoices are automatically picked up for processing in the corresponding payment run.

billToContactIdstring

The ID of the bill-to contact associated with the invoice. This field is mutually exclusive with the billToContact field.

Note: If you have the <a href="https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body.

commentsstring

Comments about the invoice.

communicationProfileIdstring

The ID of the communication profile associated with the invoice.

currencystring

The code of a currency as defined in Billing Settings through the Zuora UI.

If you do not specify a currency during standalone invoice creation, the default account currency is applied. The currency that you specify in the request must be configured and activated in Billing Settings. Note: This field is available only if you have the <a href="https://docs.zuora.com?resourceId=billing-multiple-currencies-overview" target="_blank">Multiple Currencies</a> feature enabled.

dueDatestring date

The date by which the payment for this invoice is due, in yyyy-mm-dd format.

invoiceDatestring date required

The date that appears on the invoice being created, in yyyy-mm-dd format. The value cannot fall in a closed accounting period.

invoiceNumberstring

A customized invoice number with the following format requirements:

  • Max length: 32 characters
  • Acceptable characters: a-z,A-Z,0-9,-,_,

Purely numerical prefixes or prefixes ending with a number are supported for standalone invoices. For example, you can use 202310000300, 2003, INV202310000300, or 2023-09-100009785 as invoice numbers.

The value must be unique in the system, otherwise it may cause issues with bill runs and subscribe/amend. Check out things to note and troubleshooting steps.

paymentTermstring

The ID or name of the payment term associated with the invoice. For example, Net 30. The payment term determines the due dates of invoices.

Note: If you have the <a href="https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body.

sequenceSetstring

The ID or name of the sequence set associated with the invoice.

Note: If you have the <a href="https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body.

shipToContactIdstring

The ID of the ship-to contact associated with the invoice. This field is mutually exclusive with the shipToContact field. Note: If you have the <a href="https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body.

shipToSameAsBillToboolean

Whether the ship-to contact and bill-to contact are the same entity. This field is mutually exclusive with the shipToContact and shipToContactId fields.

The created invoice has the same bill-to contact and ship-to contact entity only when all the following conditions are met in the request body:

  • This field is set to true.
  • A bill-to contact or bill-to contact ID is specified.
  • Neither ship-to contact nor ship-to contact ID is specified.

Note: If you have the <a href="https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body.

soldToContactIdstring

The ID of the sold-to contact associated with the invoice. This field is mutually exclusive with the soldToContact field.

Note: If you have the <a href="https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body.

soldToSameAsBillToboolean

Whether the sold-to contact and bill-to contact are the same entity. This field is mutually exclusive with the soldToContact and soldToContactId fields.

The created invoice has the same bill-to contact and sold-to contact entity only when all the following conditions are met in the request body:

  • This field is set to true.
  • A bill-to contact or bill-to contact ID is specified.
  • Neither sold-to contact nor sold-to contact ID is specified.

Note: If you have the <a href="https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body.

status'Draft' | 'Posted'

The status of invoice. By default, the invoice status is Draft.

When creating an invoice, if you set this field to Posted, the invoice is created and posted directly.

templateIdstring

The ID of the invoice template associated with the invoice.

Note: If you have the <a href="https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body.

transferredToAccounting'Processing' | 'Error' | 'Ignore' | 'Yes' | 'No'
IntegrationId__NSstring

ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

IntegrationStatus__NSstring

Status of the invoice's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

SyncDate__NSstring

Date when the invoice was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Example request

{
  "accountId": "8ad09be48db5aba7018db604776d4854",
  "invoiceDate": "2024-07-30",
  "invoiceItems": [
    {
      "amount": 100,
      "serviceStartDate": "2024-07-11",
      "productRatePlanChargeId": "8ad097b4909708e001909b41bb085d38"
    }
  ]
}

Response

OK

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 nullable

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 nullable

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 nullable

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'

The status of the invoice.

successboolean

Returns true if the request was processed successfully.

targetDatestring date nullable

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.

taxAmountnumber

The amount of taxation.

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.

IntegrationId__NSstring

ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

IntegrationStatus__NSstring

Status of the invoice's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

SyncDate__NSstring

Date when the invoice was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Changes