Skip to content

Latest commit

 

History

History
14 lines (11 loc) · 3.31 KB

POSTInvoiceCollectType.md

File metadata and controls

14 lines (11 loc) · 3.31 KB

Zuora::POSTInvoiceCollectType

Properties

Name Type Description Notes
account_key String Customer account ID or account number.
document_date Date The date that should appear on the invoice and credit memo being generated, in `yyyy-mm-dd` format. If this field is omitted and `invoiceId` is not specified, the current date is used by default. Note: The credit memo is only available if you have the Advanced AR Settlement feature enabled. This field is in Zuora REST API version control. Supported minor versions are `215.0` and later. To use this field in the method, you must set the `zuora-version` parameter to the minor version number in the request header. [optional]
invoice_date Date Note: This field has been replaced by the `documentDate` field in Zuora REST API version `215.0` and later. The `invoiceDate` field is only available for backward compatibility. The date that should appear on the invoice being generated, in `yyyy-mm-dd` format. If this field is omitted and `invoiceId` is not specified, the current date is used by default. This field is in Zuora REST API version control. Supported minor versions are `214.0` and earlier. [optional]
invoice_id String The ID of an existing invoice for which to collect payment using the account's default payment method. If this value is specified, no new invoice is generated, and the following fields are ignored: - `invoiceDate` and `invoiceTargetDate` (if the Zuora REST API version is 214.0 or earlier) - `documentDate` and `targetDate` (if the Zuora REST API version is 215.0 or later) [optional]
invoice_target_date Date Note: This field has been replaced by the `targetDate` field in Zuora REST API version `215.0` and later. The `invoiceTargetDate` field is only available for backward compatibility. The date through which to calculate charges on this account if an invoice is generated, in `yyyy-mm-dd` format. If this field is omitted and `invoiceId` is not specified, the current date is used by default. This field is in Zuora REST API version control. Supported minor versions are `214.0` and earlier. [optional]
payment_gateway String The name of the gateway that will be used for the payment. Must be a valid gateway name and the gateway must support the specific payment method. If a value is not specified, the default gateway on the Account will be used. [optional]
target_date Date The date through which to calculate charges on this account if an invoice or a credit memo is generated, in `yyyy-mm-dd` format. If this field is omitted and `invoiceId` is not specified, the current date is used by default. Note: The credit memo is only available if you have the Advanced AR Settlement feature enabled. This field is in Zuora REST API version control. Supported minor versions are `215.0` and later. To use this field in the method, you must set the `zuora-version` parameter to the minor version number in the request header. [optional]