LocationCreate

  • account_id
    Type: string
    required
  • address
    Type: nullable
    required

    Address for a create request. Supplied state, ZIP and country values must be valid. For a US address, use a two-letter state and a five-digit ZIP or ZIP+4. Country defaults to USA when omitted or null. Blank or omitted address details are accepted where the endpoint permits an incomplete address.

    Properties: 6
  • name
    Type: string
    required
  • country_code
    Type: stringnullable
  • currency
    Type: stringnullable
  • email
    Type: stringnullable
  • metadata
    Type: Metadatanullable
    Properties: 1
  • phone
    Type: stringnullable
  • processor_config_id
    Type: stringnullable
  • status
    Type: string
  • surcharge_basis
    Type: enumnullable

    Amount used to calculate percentage-based surcharges. total uses subtotal, tax and tip; subtotal uses subtotal only; subtotal_plus_tax includes tax; subtotal_plus_tip includes tip. The basis is resolved from location, then terminal, then account, skipping null values. The default is total when no level configures a basis.

    values
    totalsubtotalsubtotal_plus_taxsubtotal_plus_tip
  • surcharge_confirmation_required
    Type: booleannullable
  • surcharge_rate
    Type: numbernullable
  • tax_basis
    Type: enumnullable

    Amount used to calculate percentage-based tax. total uses subtotal plus tip; subtotal uses subtotal only. Configure the default percentage with tax_rate. The basis is resolved from location, then terminal, then account, skipping null values. The default is total when no level configures a basis.

    values
    totalsubtotal
  • tax_rate
    Type: numbernullable
  • terminal_id
    Type: stringnullable