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

Citation

(en) Citation (pt) (Fundamentação Legal):

Parameters
codeOptional
string

(en) Citation Code (pt) Código de citação

externalIdOptional
string

(en) External identification code created by another system that controls the citations, on TaxAdviser it means the details code. (pt) Código de identificação externo criado por outro sistema que controla as citações, no TaxAdviser significa o código de detalhes.

scopeOptional
string

(en) Scope Types

  • 'OPERATION'
  • 'GOODS'
  • 'SERVICE'
  • 'GENERIC'
  • 'GOODSSERVICES' (pt) Tipos de escopo
  • 'OPERAÇÃO'
  • 'MERCADORIAS'
  • 'SERVIÇO'
  • 'GENÉRICA'
  • 'MERCADORIASSERVICOS'
Enum: OPERATION, GOODS, SERVICE, GENERIC, GOODSSERVICES
externalCitationIdOptional
string

(en) Parent citation Id reference, use to group all related detailed citation in one line. on TaxAdviser it means the fundamental code. (pt) Referência de ID de citação pai, use para agrupar todas as citações detalhadas relacionadas em uma linha. no TaxAdviser significa o código fundamental.

externalReplacedIdOptional
string

(en) When a new citation is only an update of another actual citation without change the main features (for example changing the only rate or exempt code or CST) then it will replace automatically the other citation identified by this attribute. (pt) Quando uma nova citação é apenas uma atualização de outra citação real sem alterar as características principais (por exemplo, alterar a única taxa ou código de isenção ou CST), ela substituirá automaticamente a outra citação identificada por este atributo.

citationRequired
string

(en) Citation text used in electronic invoices to justify special tributary scenarios. (pt) Texto de citação usado em notas fiscais eletrônicas para justificar cenários tributários especiais.

descriptionOptional
string

(en) Full legal text for this citation. (pt) Texto legal completo para esta citação.

typeOptional
TaxClassEnum
typeGroupOptional
CitationTypeGroupEnum
hsCodesOptional
array

(en) List of harmonized code covered by this citation. (pt) Lista de códigos harmonizados abrangidos por esta citação.

referencesOptional
array

(en) List of referenced text document (pt) Lista de documentos de texto referenciados

fileReferencesOptional
array

(en) File references for Citation (pt) Referências de arquivo para citação

jurisdictionTypeRequired
string

(en) Types of jurisdiction

  • 'NONE'
  • 'City'
  • 'State'
  • 'Country'
  • 'All'
  • 'StateCity' (pt) Tipos de jurisdição
  • 'NENHUMA'
  • 'Cidade'
  • 'Estado'
  • 'País'
  • 'Todas'
  • 'EstadoCidade'
Enum: NONE, City, State, Country, All, StateCity
startDateOptional
string

(en) This start date in ISO 8601 format, creates a transaction date. (pt) Esta data de início no formato ISO 8601, cria a data de transação.

expirationDateOptional
string

(en) Expiration date (pt) Data de expiração do produto Usage purpose: Invoice

benefitCodeOptional
string

(en) Standardized benefit code according to Jurisdiction and Tax Type, for example, IPI Class Code. (pt) Código de benefício padronizado de acordo com Jurisdição e Tipo de Imposto, por exemplo, Código de Classe IPI.

accountIdOptional
string

(en) If present, this citation is scoped to the account (company and branches). (pt) Se presente, essa citação tem como escopo a conta (empresa e filiais).

constraintOptional
Citation_constraint
activeOptional
boolean
warningOptional
string

(en) This attribute informs that this citation has constraints not available in the payload as capital goods. (pt) Este atributo informa que a citation possui restrições relacionadas a informações não disponíveis no payload, exemplo: Bens de Capital.

eventDateOptional
string

(en) This attribute reports an event date used to identify an update to Citation (pt) Este atributo informa uma data de evento utilizado para identificar uma atualização para Citation