Documentation

Fields

• accountPurchaseAcquisition :: Maybe AccountAcquisitionUpdate

  acquisition

• accountPurchaseAddress :: Maybe Address

  address

• accountPurchaseBill_to :: Maybe AccountPurchaseBill_to

  bill_to: An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.

  Constraints:

  • Maximum length of 6
• accountPurchaseBilling_info :: Maybe BillingInfoCreate

  billing_info

• accountPurchaseCc_emails :: Maybe Text

  cc_emails: Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the `email` field also receives.

  Constraints:

  • Maximum length of 255
• accountPurchaseCode :: Text

  code: The unique identifier of the account. This cannot be changed once the account is created.

  Constraints:

  • Maximum length of 50
• accountPurchaseCompany :: Maybe Text

  company

  Constraints:

  • Maximum length of 100
• accountPurchaseCustom_fields :: Maybe CustomFields

  custom_fields: The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.

• accountPurchaseDunning_campaign_id :: Maybe Text

  dunning_campaign_id: Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.

• accountPurchaseEmail :: Maybe Text

  email: The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.

  Constraints:

  • Maximum length of 255
• accountPurchaseEntity_use_code :: Maybe Text

  entity_use_code: The Avalara AvaTax value that can be passed to identify the customer type for tax purposes. The range of values can be A - R (more info at Avalara). Value is case-sensitive.

• accountPurchaseExemption_certificate :: Maybe Text

  exemption_certificate: The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.

  Constraints:

  • Maximum length of 30
• accountPurchaseFirst_name :: Maybe Text

  first_name

  Constraints:

  • Maximum length of 255
• accountPurchaseId :: Maybe Text

  id: Optional, but if present allows an existing account to be used and updated as part of the purchase.

  Constraints:

  • Maximum length of 13
• accountPurchaseInvoice_template_id :: Maybe Text

  invoice_template_id: Unique ID to identify an invoice template. Available when the site is on a Pro or Elite plan. Used to specify which invoice template, if any, should be used to generate invoices for the account.

• accountPurchaseLast_name :: Maybe Text

  last_name

  Constraints:

  • Maximum length of 255
• accountPurchaseOverride_business_entity_id :: Maybe Text

  override_business_entity_id: Unique ID to identify the business entity assigned to the account. Available when the `Multiple Business Entities` feature is enabled.

• accountPurchaseParent_account_code :: Maybe Text

  parent_account_code: The account code of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.

  Constraints:

  • Maximum length of 50
• accountPurchaseParent_account_id :: Maybe Text

  parent_account_id: The UUID of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.

  Constraints:

  • Maximum length of 13
• accountPurchasePreferred_locale :: Maybe AccountPurchasePreferred_locale

  preferred_locale: Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.

• accountPurchasePreferred_time_zone :: Maybe Text

  preferred_time_zone: Used to determine the time zone of emails sent on behalf of the merchant to the customer. Must be a supported IANA time zone name

• accountPurchaseTax_exempt :: Maybe Bool

  tax_exempt: The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.

• accountPurchaseTransaction_type :: Maybe AccountPurchaseTransaction_type

  transaction_type: An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.

• accountPurchaseUsername :: Maybe Text

  username: A secondary value for the account.

  Constraints:

  • Maximum length of 255
• accountPurchaseVat_number :: Maybe Text

  vat_number: The VAT number of the account (to avoid having the VAT applied). This is only used for manually collected invoices.

  Constraints:

  • Maximum length of 20