Skip to content

Latest commit

 

History

History
39 lines (36 loc) · 8.45 KB

POSTAccountType.md

File metadata and controls

39 lines (36 loc) · 8.45 KB

Zuora::POSTAccountType

Properties

Name Type Description Notes
account_number String A unique account number, up to 50 characters that do not begin with the default account number prefix. If no account number is specified, one is generated. [optional]
additional_email_addresses Array<String> A list of additional email addresses to receive emailed invoices. Use a comma to separate each email address. Note: Invoices are emailed to the email addresses specified in this field only when the `invoiceDeliveryPrefsEmail` field is `true`. [optional]
apply_credit_balance BOOLEAN Applies a credit balance to an invoice. If the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken. Prerequisite: `invoice` must be `true`. To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method. Note: - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`. - This field is deprecated if you have the Advanced AR Settlement feature enabled. [optional]
auto_pay BOOLEAN Specifies whether future payments are to be automatically billed when they are due. Possible values are: `true`, `false`. [optional]
batch String The alias name given to a batch. A string of 50 characters or less. [optional]
bill_cycle_day Integer The account's bill cycle day (BCD), when bill runs generate invoices for the account. Specify any day of the month (1-31, where 31 = end-of-month), or 0 for auto-set. Required if no subscription will be created. Optional if a subscription is created and defaults to the day-of-the-month of the subscription's `contractEffectiveDate`. [optional]
bill_to_contact POSTAccountTypeBillToContact
collect String Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account. If the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken. The default value is `true`. Prerequisite: invoice must be `true`. Note: This field is in Zuora REST API version control. Supported minor versions are 196.0 or 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]
communication_profile_id String The ID of a communication profile. [optional]
credit_card POSTAccountTypeCreditCard [optional]
crm_id String CRM account ID for the account, up to 100 characters. [optional]
currency String A currency as defined in Billing Settings in the Zuora UI.
custom_field__c String Any custom fields defined for this object. The custom field name is case-sensitive. [optional]
hpm_credit_card_payment_method_id String The ID of the HPM credit card payment method associated with this account. You must provide either this field or the `creditCard` structure, but not both. Note: Non-credit card payment methods are not supported. [optional]
invoice BOOLEAN Note: This field has been replaced by the `runBilling` field. The `invoice` field is only available for backward compatibility. Creates an invoice for a subscription. The invoice generated in this operation is only for this subscription, not for the entire customer account. If the value is `true`, an invoice is created. If the value is `false`, no action is taken. The default value is `true`. This field is in REST API minor version control. To use this field in the method, you can set the `zuora-version` parameter to the minor version number in the request header. Supported minor versions are `196.0` and `207.0`. [optional]
invoice_collect BOOLEAN Note: This field has been replaced by the `invoice` field and the `collect` field. `invoiceCollect` is available only for backward compatibility. If `true` (default), and a subscription is created, an invoice is generated at account creation time and payment is immediately collected using the account's default payment method. This field is in Zuora REST API version control. Supported minor versions are 186.0, 187.0, 188.0, 189.0, and 196.0. [optional]
invoice_delivery_prefs_email BOOLEAN Whether the customer wants to receive invoices through email. The default value is `false`. [optional]
invoice_delivery_prefs_print BOOLEAN Whether the customer wants to receive printed invoices, such as through postal mail. The default value is `false`. [optional]
invoice_target_date Date Note: This field has been replaced by the `targetDate` field. The `invoiceTargetDate` field is only available for backward compatibility. Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date. This field is in REST API minor version control. To use this field in the method, you can set the `zuora-version` parameter to the minor version number in the request header. Supported minor versions are `207.0` and earlier. [optional]
invoice_template_id String Invoice template ID, configured in Billing Settings in the Zuora UI. [optional]
name String Account name, up to 255 characters.
notes String A string of up to 65,535 characters. [optional]
parent_id String Identifier of the parent customer account for this Account object. The length is 32 characters. Use this field if you have customer hierarchy enabled. [optional]
payment_gateway String The name of the payment gateway instance. If null or left unassigned, the Account will use the Default Gateway. [optional]
payment_term String Payment terms for this account. Possible values are: `Due Upon Receipt`, `Net 30`, `Net 60`, `Net 90`. [optional]
run_billing BOOLEAN Creates an invoice for a subscription. If you have the Advanced AR Settlement feature enabled, a credit memo might also be created based on the invoice and credit memo generation rule.. The billing documents generated in this operation is only for this subscription, not for the entire customer account. Possible values: - `true`: An invoice is created. If you have the Advanced AR Settlement feature enabled, a credit memo might also be created. - `false`: No invoice is created. Note: This field is in Zuora REST API version control. Supported minor versions are `211.0` or 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] [default to true]
sales_rep String The name of the sales representative associated with this account, if applicable. Maximum of 50 characters. [optional]
sold_to_contact POSTAccountTypeSoldToContact [optional]
subscription POSTAccountTypeSubscription [optional]
tagging String [optional]
target_date Date Date through which to calculate charges if an invoice or a credit memo is generated, as yyyy-mm-dd. Default is current date. Note: The credit memo is only available only if you have the Avdanced AR Settlement feature enabled. This field is in Zuora REST API version control. Supported minor versions are `211.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]
tax_info POSTAccountTypeTaxInfo [optional]