Welcome to Zuora Product Documentation

Explore our rich library of product information

Invoice API Generator Template Fields

This section provides an explanation of each field in the Invoice API Generator template, detailing their requirements, types, and usage.

To facilitate your understanding of the template, the explanation for each field in the template is provided in the following table:

FieldRequired?TypeValueCharacter LimitDescription
Invoice.AccountIdConditionalzns:ID32

The account ID of the invoice owner.

This field is required if Invoice.AccountNumber is not specified.

Invoice.AccountNumberConditionalzns:ID32

Unique account number assigned to the account.

This field is required if Invoice.AccountId is not specified.

Invoice.IncludesOneTimeNobooleanTRUE, FALSE5Specifies whether the invoice includes one-time charges. You can use this field only with the generate() call for the Invoice object.
Invoice.IncludesRecurringNobooleanTRUE, FALSE5Specifies whether the invoice includes recurring charges. You can use this field only with the generate() call for the Invoice object.
Invoice.IncludesUsageNobooleanTRUE, FALSE5Specifies whether the invoice includes usage charges. You can use this field only with the generate() call for the Invoice object.
Invoice.DateNodate29

The format should align with the value for the Date Format field in the Invoice API Generator.

If not specified, the value for Invoice.TargetDate will be used.

Invoice.TargetDateYesdate29

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.

The format should align with the value for the Date Format field in the Invoice API Generator.

Invoice.PostYesbooleanTRUE, FALSE5Specifies whether to post this invoice. The default value is FALSE.