AvaTax Brazil

Version v1
Batch Calculations
Calculations
Filter Subscription Rule Set List
Generic Rules
Invoice Goods
Invoice Service
Invoice Settings
PING
Subscription Analysis
Subscription Citations
Subscription Location
Subscription Operation Type
Subscription Rule Set
Subscription Usage
processFile

PaymentMode

Parameters
modeRequired
string

(en) Payment mode:

  • '01' # Money
  • '02' # Check
  • '03' # Credit Card
  • '04' # Debit Card
  • '05' # Store Credit
  • '10' # Food voucher
  • '11' # Meal Coupon
  • '12' # Gift certificate
  • '13' # Fuel Valley
  • '14' # Duplicate Mercantil
  • '15' # Boleto Bancario
  • '16' # Bank Deposit
  • '17' # Instant Payment (PIX)
  • '18' # Bank transfer, Digital Wallet
  • '19' # Loyalty program, Cashback, Virtual Credit
  • '20' # Instant Payment (PIX) – Static
  • '21' # Store Credit
  • '22' # Unspecified Electronic Payment – Issuer System Hardware Failure
  • '90' # No Payment
  • '91' # Deferred Payment
  • '99' # Others (pt) Modo de pagamento:
  • '01' # Dinheiro
  • '02' # Cheque
  • '03' # Cartão de Crédito
  • '04' # Cartão de Débito
  • '05' # Crédito Loja
  • '10' # Vale Alimentação
  • '11' # Vale Refeição
  • '12' # Vale Presente
  • '13' # Vale Combustível
  • '14' # Duplicata Mercantil
  • '15' # Boleto Bancario
  • '16' # Depósito Bancário
  • '17' # Pagamento Instantâneo (PIX)
  • '18' # Transferência bancária, Carteira Digital
  • '19' # Programa de fidelidade, Cashback, Crédito Virtual
  • '20' # Pagamento Instantâneo (PIX) - Estático
  • '21' # Crédito em Loja
  • '22' # Pagamento Eletrônico não Informado - falha de hardware do sistema emissor
  • '90' # Sem Pagamento
  • '91' # Pagamento Posterior
  • '99' # Outros Usage purpose: Invoice
Enum: 01, 02, 03, 04, 05, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 90, 91, 99
modeDescriptionOptional
string

(en) Fill out informing the payment method used when the payment method code is informed as 99 - others. (pt) Preencher informando o meio de pagamento utilizado quando o código do meio de pagamento for informado como 99 - outros. Usage purpose: Invoice

valueRequired
number

(en) Payment value (pt) Valor do pagamento Usage purpose: Invoice

cardTpIntegrationOptional
string

(en) Type of payment integration of the process with the company's automation system.

  • '1' # Payment integrated with the company's automation system. Ex. TEF equipment, eletronic commerce.
  • '2' # Payment not integrated with the company's automation system. Ex: POS equipment. (pt) Tipo de Integração do processo de pagamento com o sistema de automação da empresa.
  • '1' # Pagamento integrado com o sistema de automação da empresa Ex. equipamento TEF, Comércio Eletrônico.
  • '2' # Pagamento não integrado com o sistema de automação da empresa Ex: equipamento POS.
    Usage purpose: Invoice
Enum: 1, 2
cardCNPJOptional
string

(en) Informs the CNPJ of the payment institution, acquirer or sub-acquirer. If payment is processed by the intermediary of the transaction, informs the intermediary's CNPJ. (pt) Informa o CNPJ da instituição de pagamento, adquirente ou subadquirente. Caso o pagamento seja processado pelo intermediador da transação, informar o CNPJ do intermediador. Usage purpose: Invoice

cardBrandOptional
string

(en/pt) Card brand / Bandeira do cartão

  • '01' # Visa
  • '02' # Mastercard
  • '03' # American Express
  • '04' # Sorocred
  • '05' # Diners Club
  • '06' # Elo
  • '07' # Hipercard
  • '08' # Aura
  • '09' # Cabal
  • '10' # Alelo
  • '11' # Banes Card
  • '12' # CalCard
  • '13' # Credz
  • '14' # Discover
  • '15' # GoodCard
  • '16' # GreenCard
  • '17' # Hiper
  • '18' # JcB
  • '19' # Mais
  • '20' # MaxVan
  • '21' # Policard
  • '22' # RedeCompras
  • '23' # Sodexo
  • '24' # ValeCard
  • '25' # Verocheque
  • '26' # VR
  • '27' # Ticket
  • '99' # Other Usage purpose: Invoice
Enum: 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 99
cardAuthorizationOptional
string

(en) Credit/debit card transaction authorization number (pt) Número de autorização da operação cartão de crédito/débito Usage purpose: Invoice

paymentDateOptional
string

(en) Payment date, Format YYYY-MM-DD (pt) Data do pagamento, Formato AAAA-MM-DD Usage purpose: Invoice

federalTaxIdBeneficiaryOptional
string

(en) Inform the CNPJ of the establishment receiving the payment (pt) Informar o CNPJ do estabelecimento beneficiário do pagamento Usage purpose: Invoice

idTermPagOptional
string

(en) Payment terminal identifier (pt) Identificador do terminal de pagamento Usage purpose: Invoice

paymentLocationOptional
object