# AvaTax Brazil The Avatax-Brazil API exposes the most commonly services available for interacting with the AvaTax-Brazil services, allowing calculation of taxes, issuing electronic invoice documents and modifying existing transactions when allowed by tax authorities. This API is exclusively for use by business with a physical presence in Brazil. Source: https://developer.avalara.com/products/avatax-brazil/api/ **Version:** 3.0 **Base URL:** https://avataxbr.sandbox.avalarabrasil.com.br --- ## Endpoints ### Subscription Citations #### (en) Lists All Custom Taxes Citations (pt) Lista todas as ci ... `GET /v3/subscriptions/citations` (en) Lists All Custom Taxes Citations (pt) Lista todas as citações de impostos personalizados **Parameters:** | Name | Type | In | Required | Description | |---|---|---|---|---| | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | #### (en) Inserts a Custom Tax Citation (pt) Insere uma fudamenta ... `POST /v3/subscriptions/citations` (en) Inserts a Custom Tax Citation (pt) Insere uma fudamentação legal personalizada #### (en) Gets Information from a Custom Tax Citation (pt) Obtém ... `GET /v3/subscriptions/citations/{id}` (en) Gets Information from a Custom Tax Citation (pt) Obtém informações de uma fudamentação legal personalizada #### Insert or Update a Custom Tax Citation `PUT /v3/subscriptions/citations/{id}` Insert or Update a Custom Tax Citation #### (en) Removes a Custom Tax Citation (pt) Remove uma fudamenta ... `DELETE /v3/subscriptions/citations/{id}` (en) Removes a Custom Tax Citation (pt) Remove uma fudamentação legal personalizada #### (en) Gets the NCMs Information from a Tax Citation (pt) Obté ... `GET /v3/subscriptions/citations/{id}/ncms` (en) Gets the NCMs Information from a Tax Citation (pt) Obtém informações das NCMs de uma fudamentação legal **Parameters:** | Name | Type | In | Required | Description | |---|---|---|---|---| | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | #### (en) Updates the NCMs Information for a Tax Citation (pt) At ... `PUT /v3/subscriptions/citations/{id}/ncms` (en) Updates the NCMs Information for a Tax Citation (pt) Atualiza informações das NCMs de uma fundamentação legal #### (en) Lists the Rules associated with Citation (pt) Lista as ... `GET /v3/subscriptions/citations/{id}/rules` (en) Lists the Rules associated with Citation (pt) Lista as regras associadas à citação **Parameters:** | Name | Type | In | Required | Description | |---|---|---|---|---| | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | #### (en) Inserts or Updates a Set Rule (pt) Insere ou atualiza u ... `PUT /v3/subscriptions/citations/{id}/rules` (en) Inserts or Updates a Set Rule (pt) Insere ou atualiza uma regra definida ### Subscription Location #### (en) This operation returns all locations (pt) Esta operação ... `GET /v3/subscriptions/locations` (en) This operation returns all locations (pt) Esta operação retorna todos os locais **Parameters:** | Name | Type | In | Required | Description | |---|---|---|---|---| | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | #### (en) This operation returns location (pt) Esta operação reto ... `GET /v3/subscriptions/locations/{id}` (en) This operation returns location (pt) Esta operação retorna os locais ### Subscription Rule Set #### (en) Lists All Rules Sets (pt) Lista todos os conjuntos de r ... `GET /v3/subscriptions/rules` (en) Lists All Rules Sets (pt) Lista todos os conjuntos de regras **Parameters:** | Name | Type | In | Required | Description | |---|---|---|---|---| | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | #### (en) Inserts a Set Rule (pt) Insere uma regra definida `POST /v3/subscriptions/rules` (en) Inserts a Set Rule (pt) Insere uma regra definida #### (en) Gets Information from a Set Rule (pt) Obtém informações ... `GET /v3/subscriptions/rules/{id}` (en) Gets Information from a Set Rule (pt) Obtém informações de uma regra definida #### (en) Inserts or Updates a Set Rule (pt) Insere ou atualiza u ... `PUT /v3/subscriptions/rules/{id}` (en) Inserts or Updates a Set Rule (pt) Insere ou atualiza uma regra definida #### (en) Removes a Set Rule (pt) Remove uma regra definida `DELETE /v3/subscriptions/rules/{id}` (en) Removes a Set Rule (pt) Remove uma regra definida #### (en) Lists the Subscription Rules associated with citations ... `GET /v3/subscriptions/rules/ncm/{code}` (en) Lists the Subscription Rules associated with citations that have the given NCM code (partial match) (pt) Lista as regras de assinatura associadas às citações que possuem o código NCM informado (correspondência parcial) **Parameters:** | Name | Type | In | Required | Description | |---|---|---|---|---| | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | #### (en) Lists the Subscription Rules associated with citations ... `GET /v3/subscriptions/rules/nbs/{code}` (en) Lists the Subscription Rules associated with citations that have the given NBS code (partial match) (pt) Lista as regras de assinatura associadas às citações que possuem o código NBS informado (correspondência parcial) **Parameters:** | Name | Type | In | Required | Description | |---|---|---|---|---| | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | #### (en) Lists the Subscription Rules associated with citations ... `GET /v3/subscriptions/rules/cclass/{code}` (en) Lists the Subscription Rules associated with citations that have the given cClass code (contains match) (pt) Lista as regras de assinatura associadas às citações que possuem o código cClass informado (correspondência por conteúdo) **Parameters:** | Name | Type | In | Required | Description | |---|---|---|---|---| | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | ### Subscription Analysis #### (en) Lists the Citations associated with Item Analysis (pt) ... `GET /v3/subscriptions/rules/{id}/citations` (en) Lists the Citations associated with Item Analysis (pt) Lista as citações associadas à análise do item **Parameters:** | Name | Type | In | Required | Description | |---|---|---|---|---| | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | #### (en) Sets rule for a specific Citation associated with Item ... `POST /v3/subscriptions/rules/{id}/citations` (en) Sets rule for a specific Citation associated with Item Analysis (pt) Define a regra para uma Citação específica associada à Análise do Item #### (en) Removes rule for a specific Citation (pt) Remove regra ... `DELETE /v3/subscriptions/rules/{id}/citations/{citationId}` (en) Removes rule for a specific Citation (pt) Remove regra para uma Citação específica ### Filter Subscription Rule Set List #### filterSubscriptionRulesList `GET /v3/subscriptions/rules/list/filter` **Parameters:** | Name | Type | In | Required | Description | |---|---|---|---|---| | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | ### Subscription Operation Type #### (en) Retrieves subscription operation types from database (p ... `GET /v3/subscriptions/operations` (en) Retrieves subscription operation types from database (pt) Obtém operações customizadas do banco **Parameters:** | Name | Type | In | Required | Description | |---|---|---|---|---| | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | #### (en) Inserts or Updates a custom operation type (pt) Insere ... `PUT /v3/subscriptions/operations` (en) Inserts or Updates a custom operation type (pt) Insere ou atualiza uma operação customizada #### Get a subscription operation from the database by id `GET /v3/subscriptions/operations/{id}` Get a subscription operation from the database by id #### Remove a subscription operation from the database by id `DELETE /v3/subscriptions/operations/{id}` Remove a subscription operation from the database by id ### Subscription Usage #### Get Usage Data `GET /v3/subscriptions/usage` (en) Get Subscription Usage Consumption (pt) Obter informações de uso/consumo das APIs de cálculo e mensageria. **Parameters:** | Name | Type | In | Required | Description | |---|---|---|---|---| | `undefined` | | | No | | ### Generic Rules #### List Generic Rules `GET /v3/subscriptions/generic-rules` (en) Lists all generic rules with their enable/disable status for the subscription (pt) Lista todas as regras genéricas com seu status de habilitação/desabilitação para a assinatura **Parameters:** | Name | Type | In | Required | Description | |---|---|---|---|---| | `undefined` | | | No | | | `undefined` | | | No | | #### Update Generic Rule Ignore Status `PATCH /v3/subscriptions/generic-rules/{ruleSetId}` (en) Updates the ignore status of a generic rule for the subscription. Set ignore=true to disable the rule, ignore=false to enable it. (pt) Atualiza o status de ignorar de uma regra genérica para a assinatura. Defina ignore=true para desabilitar a regra, ignore=false para habilitá-la. ### Calculations #### Simulation Method `POST /v3/simulations` (en) This operation uses a minimum set of attributes to simulate the calculation of taxes. (pt) Esta operação usa um conjunto mínimo de atributos para simular o cálculo dos impostos. #### Calculation Method `POST /v3/calculations` (en) Complete calculation (pt) Cálculo completo #### Transaction Method `POST /v3/transactions` (en) The full calculation, starting the process to transform this request into a transaction (for NFe, NFCe, NFSe need government authorization). (pt) O cálculo completo, iniciando o processo para transformar esta solicitação em uma transação (para NFe, NFCe, NFSe precisam de autorização do governo). #### Retrieve transactions `GET /v3/transactions/{messageType}` (en) Retrieve a list of transactions (pt) Recupera uma lista de transações **Parameters:** | Name | Type | In | Required | Description | |---|---|---|---|---| | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | #### Retrieve transactions `GET /v3/transactions/{messageType}/{documentCode}` (en) Retrieves a single transaction (pt) Recupera uma única transação ### Batch Calculations #### Batch Simulate Method (dryrun) `POST /v3/batch/calculations` (en) This operation uses a minimum set of attributes to calculate the taxes in batch. (pt) Esta operação usa um conjunto mínimo de atributos para calcular os impostos em lote. #### Retrieve transactions `GET /v3/batch/calculations/{batchId}` (en) Retrieves a batch of transactions (pt) Recupera um lote de transações ### PING #### Retrieve Status of AvaTax Brazil Server `GET /v3/ping` (en) Retrieves Status of AvaTax Brazil Server (pt) Recupera Status do Servidor AvaTax Brasil #### Retrieve Status of AvaTax Brazil Server - Invoicy Server `GET /v3/ping/invoicy` (en) Retrieves Status of AvaTax Brazil Server - Invoice Server (pt) Recupera Status do AvaTax Brazil Server - Servidor de fatura ### Invoice Goods #### Send an e-Invoice `POST /v3/invoices/goods` (en) Sends an e-invoice to SEFAZ (pt) Envia uma nota fiscal eletrônica para a SEFAZ #### Disable Range e-Invoice `DELETE /v3/invoices/goods` (en) Sends disable range of NFes to SEFAZ (pt) Envia intervalo de desativação de NFes para SEFAZ **Parameters:** | Name | Type | In | Required | Description | |---|---|---|---|---| | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | | `undefined` | | | No | | #### Retrieve invoice `GET /v3/invoices/goods/{key}` (en) Retrieves the invoice (pt) Recupera a fatura #### Fix Letter `PUT /v3/invoices/goods/{key}` (en) Fix Letter (pt) Carta de correção #### Cancel invoice `DELETE /v3/invoices/goods/{key}` (en) Cancel the invoice (pt) Cancelar a fatura **Parameters:** | Name | Type | In | Required | Description | |---|---|---|---|---| | `message` | string | query | No | | | `timeZone` | string | query | Yes | | #### Postpone invoice `POST /v3/invoices/goods/{key}/postpone` (en) Postpone the invoice or cancel postpone (pt) Adie a fatura ou cancele o adiamento #### Get Manifest invoice `GET /v3/invoices/goods/{key}/manifest` (en) Gets Manifest the invoice (pt) Obtém o manifesto da fatura #### Send Manifest invoice `POST /v3/invoices/goods/{key}/manifest` (en) Sends Manifest the invoice (pt) Envia o manifesto da fatura #### Retrieve JSON `GET /v3/invoices/goods/{key}/json` (en) Retrieves JSON (pt) Recupera JSON #### Retrieve DANFe `GET /v3/invoices/goods/{key}/pdf` (en) Retrieves DANFe (pt) Recupera DANFe #### Retrieve XML `GET /v3/invoices/goods/{key}/xml` (en) Retrieves XML (pt) Recupera XML #### Retrieve Invoices `GET /v3/invoices/goods/{serie}/{startNumber}/{endNumber}/{model}` (en) Retrieves Invoices (pt) Recupera as faturas #### Report Outbound of an Invoice `POST /v3/invoices/goods/{key}/outboundReport` #### Send NFe delivery receipt `POST /v3/invoices/goods/{key}/deliveryReceipt` #### Cancel e-Invoice delivery receipt `POST /v3/invoices/goods/{key}/deliveryReceipt/cancel` (en) Cancel e-Invoice delivery receipt (pt) Cancela recibo de entrega da nota fiscal eletrônica #### Send NFe delivery failure `POST /v3/invoices/goods/{key}/deliveryFailure` #### Cancel NFe delivery failure `POST /v3/invoices/goods/{key}/deliveryFailure/cancel` (en) Cancel of Failure in Delivery of NF-e (pt) Cancelamento do Insucesso na Entrega da NF-e #### Import Sefaz Nfe `POST /v3/invoices/goods-import` (en) Imports SEFAZ NFe/NFCe (pt) Importa SEFAZ NFe / NFCe #### Parse Sefaz Nfe `POST /v3/invoices/goods-parse` (en) Parse SEFAZ NFe/NFCe (pt) Analisar SEFAZ NFe / NFCe #### Send a Interested Actor `POST /v3/invoices/goods/{key}/interested` (en) Sends an Interested Actor (pt) Envia um ator interessado #### Send NFe Event Type 112110 (en) Function: Allows the NFe issuer to report full payment in order to release the purchaser’s presumed credit. (pt) Função: Permitir que o emitente da NFe informe o efetivo pagamento integral a fim de liberar crédito presumido do adquirente `POST /v3/invoices/goods/{key}/credit-presumptions-payment-confirmations` #### Send NFe Event Type 211110 (en) Function: Allows the NFe issuer to report full payment in order to release the purchaser’s presumed credit. (pt) Função: Evento a ser gerado pelo adquirente em relação às notas fiscais de aquisição de emissão de terceiros e que lhe gerem o direito à apropriação de crédito presumido. `POST /v3/invoices/goods/{key}/credit-presumptions-appropriation-requests` #### Send NFe Event Type 211120 (en) Function: Enables the purchaser to indicate when an acquisition is intended for the personal consumption of a natural person, a situation in which no credit appropriation is allowed. This event must be recorded after the invoice for goods destined for personal use and consumption has been issued. A single acquisition NFe may receive multiple events of this type, each with a different nSeqEvento (cumulative events). (pt) Função: Permitir ao adquirente informar quando uma aquisição for destinada para o consumo de pessoa física, hipótese em que não haverá direito à apropriação de crédito. Evento a ser registrado após a emissão da nota de bens destinados para uso e consumo pessoal. Uma mesma NFe de aquisição pode receber vários Eventos desse tipo, com nSeqEvento diferentes (eventos cumulativos). `POST /v3/invoices/goods/{key}/items-personal-consumption` #### Send NFe Event Type 211124 (en) Function: Allow the purchaser to report when an acquisition is subject to theft, loss, robbery or deterioration. Note: The current event is related to goods that were subject to deterioration, loss, robbery or deterioration in transit, in supplies with FOB freight. (pt) Função: Permitir ao adquirente informar quando uma aquisição for objeto de roubo, perda, furto ou perecimento. Observação: O evento atual está relacionado aos bens que foram objeto de perecimento, perda, roubo ou furto em trânsito, em fornecimentos com frete FOB. `POST /v3/invoices/goods/{key}/customer-carrier-loss` #### Send NFe Event Type 112130 (en) Function: The current event is related to movable material assets that were subject to perishing, loss, theft or robbery in transit, in supplies with CIF freight. (pt) Função: O evento atual está relacionado aos bens móveis materiais que foram objeto de perecimento, perda, roubo ou furto em trânsito, em fornecimentos com frete CIF `POST /v3/invoices/goods/{key}/supplier-carrier-loss` #### Send NFe Event Type 112140 (en) Function: Allows the supplier to inform that an advance payment has not been delivered. (pt) Função: Permitir ao fornecedor informar que um pagamento antecipado não teve o respectivo fornecimento realizado. `POST /v3/invoices/goods/{key}/non-supply-advance-payment` #### Send NFe Event Type 112150 (en) Function: Allows the supplier to update the estimated delivery date or availability of the good to the purchaser, in order to remove the debt from the month in which it was initially forecast. (pt) Função: Permitir ao fornecedor atualizar a data da previsão de entrega ou disponibilização do bem ao adquirente, de forma a remover o débito do mês em que foi previsto inicialmente. `POST /v3/invoices/goods/{key}/expected-delivery-update` #### Send NFe Event Type 112120 (en) Allow the purchaser from incentivized regions (ALC/ZFM) to report that the import tax was not converted into an exemption for a given item because it did not meet the conditions of the legislation. (pt) Permitir que o adquirente das regiões incentivadas (ALC/ZFM) informe que a tributação na importação não se converteu em isenção de um determinado item por não atender as condições da legislação. `POST /v3/invoices/goods/{key}/alc-zfm-import-no-exemption` #### Send NFe Event Type 211128 (en) Allow the recipient to declare that they agree with the amounts shown on the credit note issued by either the supplier or the purchaser, which will be recorded as a debit in the assisted assessment of IBS and CBS. (pt) Permitir ao destinatário informar que concorda com os valores constantes em nota de crédito emitida pelo fornecedor ou pelo adquirente que serão lançados a débito na apuração assistida de IBS e CBS `POST /v3/invoices/goods/{key}/debit-notes-acceptance` #### Send NFe Event Type 211130 (en) Event to be generated by the purchaser of a good when it is incorporated into their fixed assets, so that the tax-administration systems can properly identify the deadline for reviewing any reimbursement claims for the corresponding credit, under Article 40, I of Complementary Law 214/2025. (pt) Evento a ser gerado pelo adquirente de bem, quando este for integrado ao seu ativo imobilizado, a fim de viabilizar a adequada identificação, pelos sistemas da administração tributária, de prazo-limite para apreciação de eventuais pedidos de ressarcimento do respectivo crédito, nos termos do art. 40, I da LC 214/2025. `POST /v3/invoices/goods/{key}/items-immobilizations` #### Send NFe Event Type 211140 (en) Event to be generated by the purchaser of fuel listed in Article 172 of Complementary Law 214/2025 who is part of that fuel’s production chain, in order to request the appropriation of credit for the portion consumed in their commercial activity. (pt) Evento a ser gerado pelo adquirente de combustível listado no art. 172 da LC 214/2025 e que pertença à cadeia produtiva desses combustíveis, para solicitar a apropriação de crédito referente à parcela que for consumida em sua atividade comercial. `POST /v3/invoices/goods/{key}/fuel-credit-appropriation-requests` #### Send NFe Event Type 211150 (en) Event to be generated by the acquirer for appropriation of credit for goods and services that depend on its activity (pt) Evento a ser gerado pelo adquirente para apropriação de crédito de bens e serviços que dependam da sua atividade `POST /v3/invoices/goods/{key}/activity-dependent-credits-appropriation-requests` #### Send NFe Event Type 212110 (en) Event to be generated by the successor in relation to the credit transfer invoices of another successor of the same company succeeded to inform acceptance of the IBS credit transfer. (pt) Evento a ser gerado pela sucessora em relação às notas fiscais de transferência de crédito de outra sucessora da mesma empresa sucedida para informar aceite da transferência de crédito de IBS. `POST /v3/invoices/goods/{key}/ibs-credit-transfers-manifestations` #### Send NFe Event Type 212120 (en) Event to be generated by the successor in relation to the credit transfer invoices of another successor of the same company succeeded to inform acceptance of the CBS credit transfer. (pt) Evento a ser gerado pela sucessora em relação às notas fiscais de transferência de crédito de outra sucessora da mesma empresa sucedida para informar aceite da transferência de crédito de CBS. `POST /v3/invoices/goods/{key}/cbs-credit-transfers-manifestations` #### Send NFe Event Type 110001 (en) Allow the author of an already authorized Event to proceed with its cancellation (pt) Permitir que o autor de um Evento já autorizado possa proceder o seu cancelamento `POST /v3/invoices/goods/{key}/event-cancellation` ### Invoice Service #### Send an e-Invoice Service `POST /v3/invoices/services` (en) Sends a invoice (pt) Envia uma fatura #### Retrieve e-Invoice Service `GET /v3/invoices/services/{serie}/{number}` (en) Retrieves the invoice (pt) Recupera a fatura #### Cancel e-Invoice Service `DELETE /v3/invoices/services/{serie}/{number}` (en) Cancel the invoice (pt) Cancela a fatura **Parameters:** | Name | Type | In | Required | Description | |---|---|---|---|---| | `nfseCancelReason` | number | query | No | | | `nfseNumber` | number | query | No | | #### Retrieve Invoices `GET /v3/invoices/services/{serie}/{startNumber}/{endNumber}/{model}` (en) Retrieves Invoices (pt) Retorna faturas #### Retrieve JSON `GET /v3/invoices/services/{serie}/{number}/json` (en) Retrieves JSON (pt) Retorna JSON #### Retrieve PDF `GET /v3/invoices/services/{serie}/{number}/pdf` (en) Retrieves PDF (pt) Retorna PDF #### Retrieve XML `GET /v3/invoices/services/{serie}/{number}/xml` (en) Retrieves XML (pt) Retorna XML #### Send an event of a service invoice national model `POST /v3/invoices/services/natnfse/event` (en) Send an event of a service invoice national model (pt) Enviar um evento de NFse modelo nacional ### Invoice Settings #### Invoice Settigns `GET /v3/invoices/settings` (en) Gets Environment Settings (pt) Obtém configurações de ambiente ### Other #### Process File `POST /v3/invoices/process/file` (en) Process File (pt) Arquivo de Processo --- ## Models ### Subscription | Property | Type | Description | |---|---|---| | `code` | string | (en) The string is a code maintained by the client application to uniquely identify the company for which this transaction is being recorded. It is unique within the context of an Account. It will be limited to 60 characters when creating a Company. (pt) A string é um código mantido pelo aplicativo cliente para identificar exclusivamente a empresa para a qual essa transação está sendo registrada. É único no contexto de uma conta. Será limitado a 60 caracteres ao criar uma empresa. | ### Location ### SubscriptionOperationType ### RuleSet (en) Transaction Message (pt) Mensagem de transação ### TaxCitation (en) Transaction Message (pt) Mensagem de transação ### StateEnum (en/pt) State Abreviation/Abreviação do estado: - 'AC' - 'AL' - 'AP' - 'AM' - 'BA' - 'CE' - 'DF' - 'ES' - 'GO' - 'MA' - 'MT' - 'MS' - 'MG' - 'PA' - 'PB' - 'PR' - 'PE' - 'PI' - 'RJ' - 'RN' - 'RS' - 'RO' - 'RR' - 'SC' - 'SP' - 'SE' - 'TO' ### TaxClassEnum (en) Tax Rate Note: AR - "to collect" (service) (pt) Taxa de imposto Obs: AR - "a recolher" (serviço) ### CitationUpshot | Property | Type | Description | |---|---|---| | `name` | string | (en) Avalara Tax Code Name (pt) Nome do código fiscal da Avalara | | `subscriptionId` | string | (en) Subscription ID (pt) ID de Inscrição | | `citationId` | string | (en) TaxCitation Id Configuration (pt) Configuração do ID TaxCitation | | `ruleSetId` | string | (en) Rule Set ID, if the evaluation returns 'true', this citation is chose. If has no rule set, then this citation is the default. (pt) ID do conjunto de regras, se a avaliação retornar 'true', esta citação é escolhida. Se não houver um conjunto de regras, essa citação será o padrão. | | `ignore` | boolean | (en) Ignores the citation. (pt) Ignora a citação. | | `active` | boolean | (en) If is 'true', the upshot can be used. (pt) Se for 'true', o resultado pode ser usado. | ### GenericRuleSet (en) Set of evaluation rules to identify a scenario. (pt) Conjunto de regras de avaliação para identificar um cenário. | Property | Type | Description | |---|---|---| | `code` | string | (en) Rule Set Code (pt) Código do conjunto de regras | | `name` | string | (en) Rule name, used to identify it. (pt) Nome da regra, usado para identificá-la. | | `conditions` | RuleSet_condition | | | `active` | boolean | | | `scope` | string | | | `constraintMode` | string | | | `creationDate` | string | | | `startDate` | string | | | `expirationDate` | string | | | `user` | string | | ### GenericCitationUpshot | Property | Type | Description | |---|---|---| | `name` | string | (en) Avalara Tax Code Name (pt) Nome do código fiscal da Avalara | | `ruleSetId` | string | (en) Rule Set ID, if the evaluation returns 'true', this citation is chose. If has no rule set, then this citation is the default. (pt) ID do conjunto de regras, se a avaliação retornar 'true', esta citação é escolhida. Se não houver um conjunto de regras, essa citação será o padrão. | | `ignore` | boolean | (en) Ignores the citation. (pt) Ignora a citação. | | `active` | boolean | (en) If is 'true', the upshot can be used. (pt) Se for 'true', o resultado pode ser usado. | | `citationExternalId` | string | (en) External citation ID from the rule system (pt) ID externo da citação do sistema de regras | ### SubCitation_putHsCode ### Usage | Property | Type | Description | |---|---|---| | `subscription` | string | (en) Subscription Id (pt) Código da Assinatura | | `locationCode` | string | (en) Location Code (pt) Código do estabelecimento | | `locationName` | string | (en) Location Name (pt) Nome do estabelecimento | | `date` | string | (en) Transaction Date (pt) Data da Transação (quando o request foi feito) | | `numberOfTransactions` | string | (en) Number of transactions (pt) Número de transações no dia | | `type` | string | (en) Transaction Type (pt) Tipo da transação | ### TraceError | Property | Type | Description | |---|---|---| | `code` | string | | | `message` | string | | | `innerError` | array | | ### ValidationError | Property | Type | Description | |---|---|---| | `code` | string | | | `message` | string | | | `innerError` | array | | ### MemoryError | Property | Type | Description | |---|---|---| | `code` | string | | | `message` | string | | | `lineIndex` | number | | | `lineCode` | string | (en) This line item in the transaction (pt) Número da linha da transação por item Usage Purpose: Calculation/Invoice | | `itemCode` | string | (en) Item code inside ERP (pt) Código do item dentro do ERP Usage Purpose: Calculation/Invoice | | `where` | MemoryWhereError | | | `list` | array | | ### MemoryCitationError | Property | Type | Description | |---|---|---| | `id` | string | | | `citation` | string | | | `rate` | number | (en) Tax rate (pt) Alíquota Usage Purpose Calculation/Invoice | | `cst` | string | (en) Tax status code (rule of taxation) (pt) Código de situação tributária Usage Purpose: Calculation/Invoice/Do not apply for services | ### MemoryWhereError | Property | Type | Description | |---|---|---| | `type` | string | | | `hsCodes.codeType` | string | | | `hsCodes.code` | string | | | `hsCodes.ex` | string | | | `hsCodes.cest` | string | | | `stateFrom` | string | | | `stateTo` | string | | | `serviceCode` | string | (en) City service code where the service will be executed. (pt) Código de serviço da cidade onde o serviço será executado. Usage purpose: Calculation/Invoice | | `cityCode` | number | | ### AJVError | Property | Type | Description | |---|---|---| | `code` | string | | | `message` | string | | | `field` | string | | | `value` | string | | | `in` | string | | ### Message | Property | Type | Description | |---|---|---| | `message` | string | | ### Address | Property | Type | Description | |---|---|---| | `street` | string | (en) Street Name (pt) Nome da rua Usage purpose: Calculation/Invoice | | `neighborhood` | string | (en) Neighborhood Name (pt) Nome do bairro Usage purpose: Invoice | | `zipcode` | string | (en) Zip Code (pt) Código postal Usage purpose: Calculation/Invoice | | `cityCode` | string | (en) City Code (pt) Código da cidade Usage purpose: Invoice | | `cityName` | string | (en) City Name (pt) Nome da cidade Usage purpose: Invoice | | `state` | string | (en) State Code (pt) Código do estado Usage purpose: Invoice | | `countryCode` | string | (en) Country Code (pt) Código do país Usage purpose: Invoice | | `country` | string | (en) Use ISO 3166-1 alpha-3 codes (pt) Usar os códigos ISO 3166-1 alpha-3 Usage purpose: Calculation/Invoice | | `number` | string | (en) House number (pt) Número da casa Usage purpose: Invoice | | `complement` | string | (en) Any other information about the address (Room, Suite, Floor, etc) (pt) Quaisquer outras informações sobre o endereço (Quarto, Suíte, Andar, etc) Usage purpose: Invoice | | `phone` | string | (en) Phone number (pt) Número de telefone Usage purpose: Invoice | ### CompanyConfiguration | Property | Type | Description | |---|---|---| | `certificate` | string | (en) Digital certificate A1 model, p12, encoded by base64 (pt) Certificado digital modelo A1, p12, codificado por base64 | | `certificateS3Key` | string | (en) Digital Certificate key in AWS S3 (pt) Chave do Certificado Digital na AWS S3 | | `certificatePassword` | string | (en) Certificate password (pt) Senha do certificado | | `certificateExpiration` | string | (en) The expiration date of this certificate (pt) A data de expiração deste certificado | | `logo` | string | (en) Company logo image encoded by base64 (pt) Imagem do logotipo da empresa codificada por base64 | | `logoExtension` | string | (en) Logo image extension (pt) Imagem do logotipo da empresa codificada por base64 | | `tpImpNFe` | string | (en) How the document is printed - '0' # without DANFE - '1' # DANFE Letter - '2' # DANFE Landscape (pt) Como o documento é impresso - '0' # sem DANFE - '1' # Carta DANFE - '2' # Paisagem DANFE Usage purpose: Invoice | | `tpImpNFCe` | string | (en) How the document is printed - '0' # without DANFE - '4' # DANFe NFC-e - '5' # DANFe NFC-e e-mail (pt) Como o documento é impresso - '0' # sem DANFE - '4' # DANFE NFC-e - '5' # DANFE NFC-e-mail Usage purpose: Invoice | ### TaxManager | Property | Type | Description | |---|---|---| | `entityType` | EntityType | | | `federalTaxRegime` | FederalTaxRegime | | | `pisCofinsISSTaxReliefOut` | boolean | (en) Exempts the ISS tax amount from the pis/cofins calc base. Does not apply to the PIS/COFINS credit amount (pt) Reduz o valor do ISS da base de cálculo do pis / cofins, nao afetando creditos de nas entradas Usage purpose: Calculation | | `pisFopag` | boolean | (en) PIS on Payroll (pt) O PIS sobre a folha de pagamento. Usage Purpose: Calculation | | `pisSubjectTo` | SubjectTaxEnum | | | `cofinsSubjectTo` | SubjectTaxEnum | | | `csllSubjectTo` | SubjectTaxEnum | | | `receiptsAreFullNoCumulativePisCofins` | boolean | (en) Purchase on Free Zones, PIS/COFINS non cumulative rate. When the company is REAL PROFIT usually operates under a Non-Cumulative PIS/COFINS regime. But there are some services that are always under the cumulative regime. If the company has all receipts from Non-Cumulative services this flag is set to True. This flag informs special conditions to credit of PIS/COFINS when this company is out of Free zone and purchases from Free Zone Company. Compras na ZFM, PIS/COFINS com alícota específica. Quando uma empresa fora da Zona Franca adquire uma produto ou serviço de uma empresa situada na Zona Franca de Manaus, o crédito de PIS E COFINS segue estas aliquotas diferenciadas. Fundamentação, art. 5º da Instrução Normativa SRF nº 546/2005; art. 3º, § 12 da Lei nº 10.637/2002; art. 3º, § 17 da Lei nº 10.833/2003; art. 4º da Lei nº 11.307/2006. DESTINATÁRIO ALÍQUOTAS. PIS COFINS. a) Venda efetuada a pessoa jurídica estabelecida fora da Zona Franca de Manaus, que apure a Contribuição para o PIS/PASEP no regime de não-cumulatividade débito 0,65% 3% crédito 1% 4,6%. b) Venda efetuada a pessoa jurídica estabelecida fora da Zona Franca de Manaus, que apure o imposto de renda com base no lucro real e que tenha sua receita, total ou parcialmente, excluída do regime de incidência não-cumulativa da Contribuição para o PIS/PASEP débito 1,3% 6% crédito 1,65% 7,6%. Usage Purpose: Calculation | | `inssWithholdSubjectTo` | boolean | (en) On a purchase transaction to force withholding INSS, this Flag can be set to True. (pt) Em uma transação de compra para forçar a retenção do INSS, a flag pode ser definida como verdadeira. | | `issWithholdSubjectTo` | boolean | (en) (Deprecated, use taxForItem.issBehavior='forcedWitholding' instead.) On purchase transaction, to force withhold ISS this Flag can be set to True. (pt) (Obsoleto, usar taxForItem.issBehavior = 'forçadoWitholding'.) Na transação de compra, para forçar a retenção do ISS, esta flag pode ser definida como Verdadeira. | | `irrfWithholdSubjectTo` | boolean | (en) On purchase transaction, if this flag is FALSE, the system will not withhold IRRF. if this flag is TRUE the system will analise other rules to define if will have witholding | | `icmsRateForSimplestaxregime` | number | Actual ICMS Rate for this company (if the company is Tax Regime Simplified). Aliquota de ICMS da companhia caso Optante do Simples | | `issRfRateForSimplesTaxregime` | number | Actual ISS RF Rate for this company (if the company is Tax Regime Simplified). Aliquota de ISS da companhia caso Optante do Simples | | `isExemptByGrossRevenueForSimplestaxregime` | boolean | (en) ICMS Exempt when Tax Regime is Simplified because total gross revenue is bellow amount defined by state (see PARANÁ State). (pt) Isenção do ICMS no Simples Nacional para faixa de receita bruta. (Ver estado do PARANÁ) | | `subjectToPayrollTaxRelief` | boolean | (en) Subject to payroll exemption (pt) Sujeito à desoneração de folha de pagamento. Usage purpose: Calculation | | `pisCofinsIcmsTaxReliefMode` | object | | | `pisCofinsIcmsTaxCreditReliefMode` | object | | | `ignoreOtherCostOnImportationIpiBase` | boolean | (en) Indicator to ignore other costs importation of IPI calculation base (pt) Indicador para ignorar outros custos de importação na base de cálculo do IPI Usage Purpose: Calculation | | `calcINSSCPRB` | boolean | (en) Enables Calculation of INSS CPRB. (pt) Habilita Cálculo do INSS CPRB. | | `usesINSSCPRBtoGrossValue` | boolean | (en) Uses the INSS CPRB to calc gross value when amountCalcType=net. (pt) Considera o INSS CPRB no cálculo do valor bruto para amountCalcType=net. Usage purpose: Calculation | | `reduceIcmsTaxReliefToIPIBase` | boolean | (en) The company can interpret the -Resolucao n 1, de 2017- and it can reduce the ICMS tax relief amount to IPI base. (pt) A empresa pode em sua interpretação da Resolucao n 1, de 2017 decidir que pode reduzir a esoneração do ICMS da base do IPI. Usage purpose: Calculation | | `pisCofinsIcmsTaxRelief` | boolean | (en) Reduces the ICMS tax amount from PIS and COFINS calculation base. (pt) Exclusão do ICMS da base do PIS e COFINS. Usage purpose: Calculation | | `pisCofinsIcmsTaxCreditRelief` | boolean | (en) Reduces the ICMS tax amount from PIS and COFINS calculation base on entrance. (pt) Exclusão do ICMS da base do PIS e COFINS na entrada. Usage purpose: Calculation | | `pisCofinsReliefZF` | boolean | (en) For outbound to Free Zone is optional to apply for tax relief, reducing from the total invoice amount the PIS/COFINS Tax Amount. PISCOFINS Tax relief at free zone. (pt) Para saída para Zona Franca é opcional a aplicação de desoneração tributária, reduzindo do valor total da fatura o Valor do PIS/COFINS. Desoneração de PISCOFINS na zona Franca. Usage purpose: Calculation | | `pisCofinsReliefZFLikeUDisc` | boolean | (en) This interpretation the discount is applied like a unconditional discount and its is reduced of ICMS and ICMS-ST bases (pt) Esta interpretação do desconto é aplicada como um desconto incondicional e é reduzida das bases de cálculo do ICMS e ICMS-ST. Usage purpose: Calculation | | `pisCofinsAssetCalcBase` | PisCofinsAssetCalcBaseEnum | | | `nationalNFSe` | boolean | (en) Indicates that the company is in a city with an issuer following the national NFS-e standard. (pt) Indica que a empresa está em cidade com emissor seguindo ao padrão nacional da NFS-e. Usage purpose: Invoice | | `roundingServiceByItem` | number | (en) Tax amount rounding by service item - 2 ROUNDING OF DECIMAL PLACES TO TWO DECIMAL PLACES - 4 ROUNDING OF DECIMAL PLACES TO FOUR DECIMAL PLACES (pt) Arredondamento do valor do imposto por item de serviço - 2 ARREDONDAMENTO DE CASAS DECIMAIS PARA DUAS CASAS DECIMAIS - 4 ARREDONDAMENTO DE CASAS DECIMAIS PARA QUATRO CASAS DECIMAIS Usage Purpose: Calculation/Invoice | | `roundingModeForServices` | string | (en) Método de arredondamento - 'A' # Norma ABNT - 'C' # Round up (ceiling) - 'F' # Round down (floor) (pt) Método de arredondamento - 'A' # Norma ABNT - 'C' # Arredondamento para cima (teto) - 'F' # Arredondamento para baixo (base) Usage Purpose: Calculation/Invoice | ### MailServer | Property | Type | Description | |---|---|---| | `user` | string | (en) User for login on the email server (pt) Usuário para login no servidor de e-mail | | `password` | string | (en) Password to login on the email server (pt) Senha para logar no servidor de e-mail | | `smtpAddress` | string | (en) SMTP address to the email server (pt) Endereço SMTP para o servidor de e-mail | | `port` | integer | (en) Port (pt) Porta | | `emailFrom` | string | (en) Email address to identify the sender email, to send an XML and DANFE (pt) Endereço de e-mail para identificar o e-mail do remetente, para enviar um XML e DANFE Usage purpose: Invoice | | `protocol` | string | (en) Protocol SSL or TLS (pt) Protocolo SSL ou TLS | | `templatemessageToEmail` | string | (en) Message to add to email body (pt) Mensagem para adicionar ao corpo do e-mail | ### TechnicalManager | Property | Type | Description | |---|---|---| | `federalTaxId` | string | (en) Technical Manager's federal tax id (CNPJ) (pt) ID fiscal federal do gerente técnico (CNPJ) Usage purpose: Invoice | | `contactName` | string | (en) Contact Name (pt) Nome de contato Usage purpose: Invoice | | `email` | string | (en) Email (pt) E-mail Usage purpose: Invoice | | `phone` | string | (en) Phone number (pt) Número de telefone Usage purpose: Invoice | | `csrt` | TechnicalManager_csrt | | ### TechnicalManager_csrt | Property | Type | Description | |---|---|---| | `nfe` | object | | | `ncfe` | object | | ### EntityType (en) Entity Type (business, individual, federalGovernment, stateGovernment, cityGovernment, foreign, mixedCapital, work cooperative) (pt) Tipo de entidade (empresa, indivíduo, governo federal, governo estadual, governo municipal, estrangeiro, capital misto, cooperativa de trabalho) ### FederalTaxRegime (en) Federal tax regime: - realProfit # Real Profit - estimatedProfit # Estimated Profit - simplified # Simplified - simplifiedHybrid # Simples Nacional, but which operates under a hybrid regime, that is, it remains subject to regular CBS and IBS taxation - simplifiedOverGrossthreshold # Simplified over Gross Threshold - simplifiedEntrepreneur # Simplified Entrepreneur - notApplicable # Not Applicable - individual # Individual - variable # Variable (pt) Regime tributário federal: - realProfit # Lucro Real - estimatedProfit # Lucro presumido - simplified # Optante do SIMPLES - simplifiedHybrid # Simples Nacional, mas que opera em regime híbrido, ou seja, continua sujeita à tributação regular de CBS e IBS - simplifiedOverGrossthreshold # Simples Nacional – excesso de sublimite de receita bruta - simplifiedEntrepreneur # Micro Empreendedor Individual - notApplicable # Não Aplicável - individual # Indivíduo - variable # Variável ### SubjectTaxEnum (en) This flag informs if this company is subject to this tax. The default value for this property is TAXABLE when set to TAXABLE (it doesn't mean that all transactions are going to be TAXABLE). The system analyses other rules to identify exemptions/exceptions. When set to 'NOT TAXABLE or EXEMPT', the system will not analyze other rules. (pt) Esta flag informa se esta empresa está sujeita a este imposto. O valor padrão para esta propriedade é TRIBUTÁVEL (TAXABLE) quando definido como TRIBUTÁVEL (TAXABLE) (isso não significa que todas as transações serão TRIBUTÁVEIS (TAXABLE). O sistema analisa outras regras para identificar isenções/exceções. Quando definido como 'NÃO TRIBUTÁVEL ou ISENTO'/NOT TAXABLE/EXEMPT, o sistema não analisará outras regras. ### PisCofinsAssetCalcBaseEnum (en) There are different understandings about what makes up the PIS/COFINS base in case of credit - 'D' # IPI is added to PIS/COFINS calc base when IPI CST is 49 UNTIL 01-01-2024 - 'I' # item value without IPI following RFB Nº 2121, DE 15 DE DEZEMBRO DE 2022 - 'S' # Add ICMS ST amount - 'N' # value that contributes to the total value of the eInvoice (pt) Existem diferentes entendimentos sobre o que compoe a base de PIS/COFINS em caso de crédito - 'D' # IPI compoe base PIS/COFINS caso CST 49 ATE 01-01-2024 - 'I' # Valor do Item sem IPI conforme INSTRUÇÃO NORMATIVA RFB Nº 2121, DE 15 DE DEZEMBRO DE 2022 - 'S' # Adiciona valor do ICMS ST a base do PIS E COFINS - 'N' # Adiciona todos os valores que contribuem para o valor total da Nota Fiscal Eletrônica Usage Purpose: Calculation ### OperationType | Property | Type | Description | |---|---|---| | `source` | string | | | `externalId` | 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. | | `code` | string | | | `parent` | string | | | `name` | string | (en) Operation Type name to Identify this configuration (pt) Nome do Tipo de Operação para identificar esta configuração | | `infAdFisco` | string | (en) Additional Information of Interest to the NF-e Tax Authorities (pt) Informações Adicionais de Interesse do Fisco da NF-e | | `infCpl` | string | (en) Additional Information for Taxpayer Interest (pt) Informações complementares de interesse do Contribuinte | | `group` | string | (en) Operation type group (pt) Grupo do tipo de operação | | `roleFrom` | string | (pt) Papel do gerador da operação | | `roleTo` | string | (pt) Papel do destinatário/remetente da operação | | `lookupIPIFromReferencedDoc` | boolean | | | `startDate` | string | | | `endDate` | string | | | `creationDate` | string | | | `creationUser` | string | | | `updateDate` | string | | | `updateUser` | number | | | `status` | number | | | `wayType` | string | (en) Informs if the transaction is an operation to internalizing (receive) an item or value (pt) Informa se a transação é uma operação para internalizar (receber) um item ou valor | | `goal` | GoalEnum | | | `trOperationType` | string | (en) Linking attribute in the current operations model for specific operations defined in the tax reform (bridge between the models) (pt) Atributo ligação no modelo atual de operações para operações especificas definidos na reforma tributária (ponte entre os modelos) | | `donationInd` | boolean | (en) Indicates the nature of the donation operation, guiding the calculation and generation of debts or refunds depending on the scenario. (pt) Indica a natureza da operação de doação, orientando a apuração e a geração de débitos ou estornos conforme o cenário Usage purpose: Calculation/Invoice | | `taxationIPI` | IpiTaxationEnum | | | `taxationPIS` | PisCofinsTaxationEnum | | | `taxationCOFINS` | PisCofinsTaxationEnum | | | `taxationIPICb` | IpiTaxationCbEnum | | | `taxationPISCb` | PisCofinsTaxationCbEnum | | | `taxationCOFINSCb` | PisCofinsTaxationCbEnum | | | `taxationIICb` | IITaxationEnum | | | `cfops` | array | | | `grossWithFullTaxOperation` | boolean | (pt) Quando o modo de cálculo for por valor liquido, caso esta propriedade seja true, o sistema deve considerar as seguintes propriedades de cada imposto como Taxable icmsCST, cstIPI,accruablePISTaxation, accruableCOFINSTaxation, para calcular o valor bruto (com impostos embutidos). (en) When calc mode is net, in case this property is true, the system uses the Taxable for all this properties icmsCST, cstIPI,accruablePISTaxation, accruableCOFINSTaxation, to calculate gross amount. | | `idCitationVat` | string | ID Citation for IBS/CBS/IS | | `idCitationPIS` | string | ID Citation for PIS | | `idCitationCOFINS` | string | ID Citation for COFINS | | `idCitationIPI` | string | ID Citation for IPI | | `idCitationPISCb` | string | ID Citation for PIS | | `idCitationCOFINSCb` | string | ID Citation for COFINS | | `idCitationIPICb` | string | ID Citation for IPI | | `idCitationIICb` | string | ID Citation for II | | `externalIdCitationVat` | 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. | | `externalIdCitationPIS` | 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. | | `externalIdCitationCOFINS` | 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. | | `externalIdCitationIPI` | 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. | | `externalIdCitationPISCb` | 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. | | `externalIdCitationCOFINSCb` | 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. | | `externalIdCitationIPICb` | 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. | | `externalIdCitationIICb` | 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. | | `icmsTaxation` | array | (pt) Comportameto de tributação estadual (ICMS) | | `refNFeSigStates` | array | | ### IpiTaxationEnum (en) Informs if this process is subject to IPI taxation on the output process. - 'T' # TAXABLE - 'E' # EXEMPT - 'H' # SUSPENDED - 'N' # NO TAXABLE - 'I' # IMMUNE - 'O' # OTHER 90 - 'OZ' # OTHER WITH RATE=0.00 - 'R' # RETURN OF IPI - 'NS' # NOT SUBJECT (pt) (pt) Informa se este processo está sujeito à tributação de IPI no processo de saída. - 'T' # TRIBUTÁVEL - 'E' # ISENTO - 'H' # SUSPENSO - 'N' # NÃO TAXÁVEL - 'I' # IMUNE - 'O' # OUTROS - 'OZ' # OUTROS COM TAXA = 0,00 - 'R' # IPI Retorno - 'NS' # Não sujeita à IPI ### IpiTaxationCbEnum (en) Informs if this process is subject to IPI taxation on the output process. - 'T' # TAXABLE - 'E' # EXEMPT - 'H' # SUSPENDED - 'N' # NO TAXABLE - 'I' # IMMUNE - 'O' # OTHER 90 - 'OZ' # OTHER WITH RATE=0.00 - 'R' # RETURN OF IPI - 'NS' # NOT SUBJECT - null # Empty (pt) (pt) Informa se este processo está sujeito à tributação de IPI no processo de saída. - 'T' # TRIBUTÁVEL - 'E' # ISENTO - 'H' # SUSPENSO - 'N' # NÃO TAXÁVEL - 'I' # IMUNE - 'O' # OUTROS - 'OZ' # OUTROS COM TAXA = 0,00 - 'R' # IPI Retorno - 'NS' # Não sujeita à IPI - null # Vazio ### PisCofinsTaxationEnum (en) Informs if this item by nature is subject to PIS OR COFINS taxation. - 'T' # TAXABLE - 'E' # EXEMPT - 'H' # SUSPENDED - 'N' # NO TAXABLE - 'OZ' # OTHER WITH RATE=0.00 (pt) Informa se este item por natureza está sujeito à tributação de PIS OU COFINS. - 'T' # TRIBUTÁVEL - 'E' # ISENTO - 'H' # SUSPENSO - 'N' # NÃO TAXÁVEL - 'OZ' # OUTROS COM TAXA = 0,00 ### PisCofinsTaxationCbEnum (en) Informs if this item by nature is subject to PIS OR COFINS taxation. - 'T' # TAXABLE - 'E' # EXEMPT - 'H' # SUSPENDED - 'N' # NO TAXABLE - 'OZ' # OTHER WITH RATE=0.00 - null # Empty (pt) Informa se este item por natureza está sujeito à tributação de PIS OU COFINS. - 'T' # TRIBUTÁVEL - 'E' # ISENTO - 'H' # SUSPENSO - 'N' # NÃO TAXÁVEL - 'OZ' # OUTROS COM TAXA = 0,00 - null # Vazio ### CfopItem | Property | Type | Description | |---|---|---| | `cfopId` | string | Id de configuração da CFOP | | `cfopExternalId` | 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. | | `natOp` | string | Natureza de operação apresentada na nota | ### IcmsCSTEnum (en)The Tax Code "CST" was established with the purpose of identifying the tax situation by the ICMS of the merchandise in the operation practiced. (pt) O Codigo de Situação Tributária "CST" foi instituído com a finalidade de identificar a situação tributária pelo ICMS da mercadoria na operação praticada. (en/pt) - 'T' # TAXABLE 00-Tributada - 'R' # TAXABLE WITH BASE REDUCTION - 20 -Tributada com redução de base - 'E' # EXEMPT 40-Isenta - 'H' # SUSPENDED 50-Suspensão - 'D' # DEFERMENT 51-Diferimento - 'N' # NO TAXABLE 41-Nao tributada - 'O' # OTHER 90-Outras - 'OZ' # OTHER AND ZERO VALUES 90-Outras ### IITaxationEnum (en) Informs if this item by nature is subject to PIS OR COFINS taxation. - 'T' # TAXABLE - 'E' # EXEMPT - 'H' # SUSPENDED - 'N' # NO TAXABLE - 'OZ' # OTHER WITH RATE=0.00 (pt) Informa se este item por natureza está sujeito à tributação de PIS OU COFINS. - 'T' # TRIBUTÁVEL - 'E' # ISENTO - 'H' # SUSPENSO - 'N' # NÃO TAXÁVEL - 'OZ' # OUTROS COM TAXA = 0,00 ### GoalEnum (en/pt) - 'Normal' # 1-Normal - 'Complementary' # 2-Complemento de Valores - 'Voided' # Anulação - 'Replacement' # Substituto - 'Reverse' # Estorno - 'TransferBack' # 1-Retorno - 'Return' # 4-Devolução - 'Adjustment' # 3-Ajuste - 'Shipping' # Remessa - 'TaxCreditNote' # 5-Nota de crédito - 'TaxDebitNote' # 6-Nota de débito ### RuleSet_condition | Property | Type | Description | |---|---|---| | `logical` | boolean | | | `all` | array | | | `any` | array | | ### RuleSet_condition_1 ### RuleSet_condition_2 ### RuleSet_condition_3 ### RuleSet_element | Property | Type | Description | |---|---|---| | `id` | string | (en) 'Element Id' (pt) 'ID do elemento' | | `logical` | boolean | | | `element` | RuleSet_elementTypes | | | `attr` | string | (en) 'Element Attribute' (pt) 'Atributo do elemento' | | `operator` | RuleSet_operator | | | `value` | string | (en) 'Element Value' (pt) 'Valor do elemento' | | `subElement` | string | (en) 'Element specifier' (pt) 'Especificador de elemento' | | `subAttribute` | string | (en) 'Attribute specifier' (pt) 'Especificador do atributo' | ### RuleSet_elementTypes (en) / (pt) - 'location' # (pt) Estabelecimento - 'location.address' # (pt) Endereço do estabelecimento - 'entity' # (pt) Fornecedor/Destinatário - 'entity.address' # (pt) Endereço do Fornecedor/Destinatário - 'rendered.address' # (pt) Endereço prestação do serviço - 'deliveryRendered' # (pt) Entrega/Prestação (Tax Reform) - 'deliveryRendered.address' # (pt) Endereço Entrega/Prestação (Tax Reform) - 'pickup' # (pt) Retirada (Tax Reform) - 'pickup.address' # (pt) Endereço de Retirada (Tax Reform) - 'item' # (pt) Item Geral - 'item.goods' # (pt) Item de Mercadoria/Produto - 'item.services' # (pt) Item de Serviço - 'head' # (pt) Transação - 'header' # (pt) Transação - 'line' # (pt) Linha ### RuleSet_operator (en) / (pt) - 'eq' # (pt) Igual a - 'sw' # (pt) Começa com - 'ne' # (pt) Diferente de - 'in' # (pt) Contém - 'ni' # (pt) Não contém - 'gt' # (pt) Maior que - 'ge' # (pt) Maior ou igual a - 'lt' # (pt) Menor que - 'le' # (pt) Menor ou igual a - 'il' # (pt) Na lista - 'nl' # (pt) Não na lista ### IBPT ### ICMS ### ICMS_Deferral ### ICMS_Inter_Deferral ### ICMS_FCP ### ICMS_Inter ### ICMS_Reduction ### ICMS_Inter_Reduction ### ICMS_ST ### ICMS_ST_Inter ### ICMS_ST_Reduction ### ICMS_Suspended ### ICMS_PartialExemption ### ICMS_Inter_PartialExemption ### II ### FUST_FUNTTEL ### INSSAR_CPRB ### INSSRF_CPRBRF ### IPI ### IRRF ### ISS ### PIS_COFINS ### CPRB_GOODS ### CBS ### IBS ### IBS_UF ### IBS_Mun ### CBSIBS ### IS ### CBS_CASHBACK ### IBS_CASHBACK ### CBSIBS_GOV ### CBS_PRESUMED ### IBS_PRESUMED ### PIS_COFINS_CSLL_RF ### CalcModeEnum (en) Informs how this ICMS is calculed for itens linked to this configuration. (pt) Informa como esse ICMS é calculado para itens vinculados a esta configuração. ### Citation (en) Citation (pt) (Fundamentação Legal): | Property | Type | Description | |---|---|---| | `code` | string | (en) Citation Code (pt) Código de citação | | `externalId` | 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. | | `scope` | string | (en) Scope Types - 'OPERATION' - 'GOODS' - 'SERVICE' - 'GENERIC' - 'GOODSSERVICES' (pt) Tipos de escopo - 'OPERAÇÃO' - 'MERCADORIAS' - 'SERVIÇO' - 'GENÉRICA' - 'MERCADORIASSERVICOS' | | `externalCitationId` | 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. | | `externalReplacedId` | 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. | | `citation` | 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. | | `description` | string | (en) Full legal text for this citation. (pt) Texto legal completo para esta citação. | | `type` | TaxClassEnum | | | `typeGroup` | CitationTypeGroupEnum | | | `hsCodes` | array | (en) List of harmonized code covered by this citation. (pt) Lista de códigos harmonizados abrangidos por esta citação. | | `references` | array | (en) List of referenced text document (pt) Lista de documentos de texto referenciados | | `fileReferences` | array | (en) File references for Citation (pt) Referências de arquivo para citação | | `jurisdictionType` | string | (en) Types of jurisdiction - 'NONE' - 'City' - 'State' - 'Country' - 'All' - 'StateCity' (pt) Tipos de jurisdição - 'NENHUMA' - 'Cidade' - 'Estado' - 'País' - 'Todas' - 'EstadoCidade' | | `startDate` | 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. | | `expirationDate` | string | (en) Expiration date (pt) Data de expiração do produto Usage purpose: Invoice | | `benefitCode` | 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. | | `accountId` | 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). | | `constraint` | Citation_constraint | | | `active` | boolean | | | `warning` | 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. | | `eventDate` | 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 | ### DifaBenefit (en) Scope of application of the benefit, it can be general, state, interDifa general when it is applied for both inState and interDifa not DIFA when the benefit is not applied on DIFA calculation only DIFA when the benefit is applied only for DIFA calculation (pt) Escopo de aplicação do benefício, ele pode ser geral, dentro do estado ou DIFA iterestadual general quando é aplicado tanto dentro de estado quanto em operações interestaduais no calculo do DIFA not DIFA quando o benefício so é aplicado em operações dentro do estado e nao calculo de DIFA only DIFA quando o benefício só é aplicado em operações interestaduais no cálculo do DIFA Usage purpose: Calculation /Do not apply for services ### Citation_constraint | Property | Type | Description | |---|---|---| | `itemList` | array | (en) List of names of the product or types of product that are covered by this citation (pt) Lista de nome de produtos ou tipo de produtos que são abrangidos pela fundamentação Tax Reform/Reforma Tributária | | `item` | string | (en) Citation Item (pt) Item da Fundamentação | | `unit` | string | (en) Sales unit measure - 'kg' # Kg - 'kgg' # gross Kg - 'l' # Liter - 'ti' # TI - index of radioactive transport - 'units' (pt) Unidade de medida de vendas 'kg' # Kg - 'kgg' # kg bruto - 'l' # litro - 'ti' # TI - índice de transporte radioativo - 'unidades' Usage purpose: Calculation/Invoice/Do not apply for services | | `lowerLimitAmount` | number | (en) Lower amount citation constraint rule in comexUnit. (pt) Regra de restrição de citação de menor valor em comexUnit. | | `upperLimitAmout` | number | (en) Upper amount citation constraint rule in comexUnit. (pt) Regra de restrição de citação de valor superior em comexUnit. | | `source` | ItemSourceGoodsEnum | | | `fiscalType` | SpedFiscalProductType | | | `activitySectorListEmitter` | array | (en) Activity sector constraint list for Emitter (pt) Lista de restrições do setor de atividade para o Emissor | | `activitySectorListReceiver` | array | (en) Activity sector constraint list for Receiver (pt) Lista de restrições do setor de atividade para o receptor | | `packaging` | string | (en) Packaging, this attribute can be a parameter to discover ICMS-ST amount by SRP. (pt) Embalagem, este atributo pode ser um parâmetro para descobrir o valor do ICMS-ST pelo SRP. | | `supplementaryInformation` | string | (en) Additional information (pt) Informação adicional | | `specialProductClass` | SpecialProductClassEnum | | | `ceanTax` | string | (en) GTIN (Global Trade Item Number) of taxable unit (pt) GTIN (número de item comercial global) da unidade tributável Usage purpose: Calculation/Invoice | | `icmsTaxPayer` | boolean | (en) Informs if the entity is ICMS tax payer (pt) Informa se a entidade é contribuinte do ICMS Usage Purpose: | Calculation/Invoice | | `entityTypeListReceiver` | array | (en) Entity Type, used for withholding PIS, COFINS, CSLL, IR (pt) Utilizado para retenção de PIS, COFINS, CSLL, IR | | `subjectPayrollTaxRelief` | boolean | (en) Item subject to Payroll Tax Relief - INSSRF (pt) Item sujeito à desoneração de folha de pagamento - INSSRF | | `federalTaxRegimeListReceiver` | array | (en) Entity Type, used for withholding PIS, COFINS, CSLL, IR (pt) Utilizado para retenção de PIS, COFINS, CSLL, IR | | `federalTaxRegimeListEmitter` | array | (en) Entity Type, used for withholding PIS, COFINS, CSLL, IR (pt) Tipo de Entidade, utilizado para retenção de PIS, COFINS, CSLL, IR | | `useType` | UseType | | ### Citation_hsCode | Property | Type | Description | |---|---|---| | `codeType` | CodeTypeEnum | | | `code` | string | (en) Harmonized code, NCM or LC 116 or NBS (pt) Código harmonizado, NCM ou LC 116 ou NBS | | `maskedCode` | string | (en) Citation Code with Mask (pt) Código de citação com máscara | | `ex` | string | (en) HSCODE exception (ex) for IPI tax (pt) Código ex para casos de isenção do IPI Usage purpose Calculation/Invoice | | `cest` | object | | | `detailDescription` | string | (en) This attribute helps the end-user to identify some specific type of product of the NCM or LC (pt) Este atributo ajuda o usuário final a identificar algum tipo específico de produto do NCM ou LC | | `detailDescriptionSubItem` | array | (en) List of product names covered in sub-item (pt) Lista dos nomes dos produtos contemplado no sub item | | `expirationDate` | string | (en) Expiration date (pt) Data de expiração do produto Usage purpose: Invoice | ### Citation_hsCode_cest (en) Tax substitution classification code. (pt) Código classificador de substituição tributária. Usage purpose: Calculation/Invoice/Do not apply for services ### Citation_references | Property | Type | Description | |---|---|---| | `id` | string | | | `citation` | string | | | `description` | string | | ### Citation_file_references | Property | Type | Description | |---|---|---| | `name` | string | (en) File name (pt) Nome do arquivo | | `uploadDate` | string | (en) Upload date (pt) Data de upload | | `binaryFile` | string | | ### CodeTypeEnum ### ComexUnit ### ItemSourceGoodsEnum (en) - '0' # National goods - except those treated in codes 3,4, 5 and 8 - '1' # Foreign goods - Imported directly by seller, except those in code 6 - '2' # Foreign goods - Acquired in the internal market (inside Brazil), except those in code 7 - '3' # National goods - Merchandise or goods with imported content above 40% and with less than or equal to 70% - '4' # National goods from production following 'standard basic processes' as stablished by legislation (standard basic processes are devised to separate simple assembly from manufaturing processes) - '5' # National goods - Merchandise or goods with imported content equal or below 40% - '6' # Foreign goods - Directly imported by Seller, without a National Equivalent as listed by Comex and natural gas - '7' # Foreign goods - Acquired inside Brazil, without a National Equivalent as listed by Comex and natural gas - '8' # National goods - Merchandise or goods with imported content above 70% (pt) - '0' # Bens nacionais - exceto aqueles tratados nos códigos 3,4, 5 e 8 - '1' # Bens estrangeiros - Importados diretamente pelo vendedor, exceto aqueles no código 6 - '2' # Bens estrangeiros - Adquiridos no mercado interno (dentro do Brasil), exceto os do código 7 - '3' # Bens nacionais - Mercadoria ou bens com conteúdo importado acima de 40% e com valor igual ou inferior a 70% - '4' # Bens nacionais de produção seguindo 'processos básicos padrão', conforme estabelecido pela legislação (processos básicos padrão são concebidos para separar a montagem simples dos processos de manufatura) - '5' # Bens nacionais - Mercadoria ou bens com conteúdo importado igual ou inferior a 40% - '6' # Bens estrangeiros - Importados diretamente pelo Vendedor, sem Equivalente Nacional conforme listado pelo Comex e gás natural - '7' # Mercadoria estrangeira - Adquirida dentro do Brasil, sem Equivalente Nacional na lista do Comex e gás natural - '8' # Bens nacionais - Mercadoria ou bens com conteúdo importado acima de 70% ### SpedFiscalProductType (en) Fiscal product type according to SPED list table: - 'FOR PRODUCT' # 04 - 'FOR MERCHANDISE' # 00 - 'NO RESTRICTION' # 99 - 'SERVICE' # 09 - 'FEEDSTOCK' # 01 - 'FIXED ASSETS' # 08 - 'PACKAGING' # 02 - 'PRODUCT IN PROCESS' # 03 - 'SUBPRODUCT' # 05 - 'INTERMEDIATE PRODUCT' # 06 - 'MATERIAL FOR USAGE AND CONSUMPTION' # 07 - 'OTHER INPUTS' # 10 (pt) Tipo fiscal do produto segundo tabela SPED: - 'FOR PRODUCT' # 04 (pt) Produto Acabado - 'FOR MERCHANDISE' # 00 (pt) Mercadoria para Revenda - 'NO RESTRICTION' # 99 (pt) Outras - 'SERVICE' # 09 (pt) Serviços - 'FEEDSTOCK' # 01 (pt) Matéria-Prima - 'FIXED ASSETS' # 08 (pt) Ativo Imobilizado - 'PACKAGING' # 02 (pt) Embalagem - 'PRODUCT IN PROCESS' # 03 (pt) Produto em Processo - 'SUBPRODUCT' # 05 (pt) Subproduto - 'INTERMEDIATE PRODUCT' # 06 (pt) Produto Intermediário - 'MATERIAL FOR USAGE AND CONSUMPTION' # 07 (pt) Material de Uso e Consumo - 'OTHER INPUTS' # 10 (pt) Outros insumos ### ActivitySector ### CitationTypeGroupEnum ### SpecialProductClassEnum (en) This attribute informs the category of the item type, such as automotive, beverages, etc. (pt) Este atributo informa a categoria do tipo de item, como automotivo, bebidas, etc. ### UseType (en) This is an enumeration following the table for the incoming process, the table is # WHEN PROCESS WAY IS OUT - 'use or consumption' - 'resale' - 'agricultural production' - 'production' - 'use or consumption on business establishment' - 'use or consumption on transporter service establishment' - 'use or consumption on communication service establishment' - 'use or consumption on demand by contract' - 'use or consumption on energy supplier establishment' - 'use or consumption of fuel transaction type exportation' - 'use or consumption on services subject to iss' - 'use or consumption on services subject to icms' - 'fixed assets' - 'resale export' # usado na devolução de mercadoria que tem como finalidade exportanção - 'resale icms exempt' - 'resale buyer under the same icmsSt tax rule' - "transport of goods that don't need invoice (nf)" # WHEN PROCESS WAY IS IN - 'for production' # 04 produto acabado - 'resale' # 00 mercadoria para revenda - 'service' # 09 serviços - 'feedstock' # 01 matéria-prima - 'fixed assets' # 08 ativo imobilizado - 'packaging' # 02 embalagem - 'product in process' # 03 produto em processo - 'subproduct' # 05 subproduto - 'intermediate product' # 06 produto intermediário - 'use or consumption' # 07 material de uso e consumo - 'other inputs' # 10 outros insumos - 'other' # 99 outras - 'notApplicable' (pt) Esta é uma enumeração que segue a tabela para o processo de entrada, a tabela é QUANDO O PROCESSO OCORRER POR FORA - 'uso ou consumo' - 'revenda' - 'produção agrícola' - 'produção' - 'uso ou consumo em estabelecimento comercial' - 'uso ou consumo em estabelecimento de serviço de transporte' - 'uso ou consumo em estabelecimento de serviço de comunicação' - 'uso ou consumo sob demanda por contrato' - 'uso ou consumo no estabelecimento fornecedor de energia' - 'exportação de tipo de transação de uso ou consumo de combustível' - 'uso ou consumo em serviços sujeitos a iss' - 'uso ou consumo em serviços sujeitos a icms' - 'ativo permanente' - 'exportação de revenda' # usado na devolução de mercadoria que tem como exportanção - 'isenção de icms de revenda' - 'comprador de revenda sob a mesma regra de imposto icmsSt' - "transporte de mercadorias que não necessitem de nota fiscal (nf)" # QUANDO A MANEIRA DO PROCESSO ESTÁ EM - 'para produção' # 04 produto acabado - 'revenda' # 00 mercadoria para revenda - 'serviço' # 09 serviços - 'matéria-prima' # 01 matéria-prima - 'imobilizado' # 08 ativo imobilizado - 'embalagem' # 02 embalagem - 'produto em processo' # 03 produto em processo - 'subproduto' # 05 subproduto - 'produto intermediário' # 06 produto intermediário - 'uso ou consumo' # 07 material de uso e consumo - 'outras entradas' # 10 outros insumos - 'outro' # 99 outras - 'não aplicável' ### CitationItemList | Property | Type | Description | |---|---|---| | `item` | string | (en) Item number (pt) Número do Item | | `subItem` | string | (en) SubItem Number (pt) Numero do SubItem | ### ActivitySector_ActivityLineList | Property | Type | Description | |---|---|---| | `type` | string | (en) Optional: indicates the chosen "activitysector" - 'activityLine' # Ramo de atividade (pt) Opcional: indica qual é o "activitysector" método escolhido. Ex: "activitylinelist". Usage purpose: Calculation | | `code` | ActivitySectorCode | | ### ActivitySector_CNAE | Property | Type | Description | |---|---|---| | `type` | string | (en) Optional: Indicates the chosen "cnae". (pt) Opcional: Indica qual é o método "cnae" escolhido. Ex: "cnae". - 'cnae' # Código CNAE 2.0 Usage purpose: Calculation | | `code` | string | (en) CNAE code (pt) Código CNAE | ### ActivitySector_CNAESegment | Property | Type | Description | |---|---|---| | `type` | string | (en) Optional: indicates the chosen "cnaesegment". (pt) Opcional: indicar qual é o "cnaesegment" método escolhido. Ex: "cnaesegment" - 'cnaeSegment' # Código de Segmento CNAE 2.0 Usage purpose: Calculation | | `code` | string | (en) - '01' # AGRICULTURE, LIVESTOCK AND RELATED SERVICES - '02' # FOREST PRODUCTION - '03' # FISHING AND AQUACULTURE - '05' # MINERAL COAL EXTRACTION - '06' # OIL AND NATURAL GAS EXTRACTION - '07' # METAL MINERALS EXTRACTION - '08' # NON-METALLIC MINERALS EXTRACTION - '09' # ACTIVITIES SUPPORTING THE EXTRACTION OF MINERALS - '10' # MANUFACTURE OF FOOD PRODUCTS - '11' # DRINK MANUFACTURE - '12' # MANUFACTURE OF SMOKE PRODUCTS - '13' # MANUFACTURE OF TEXTILE PRODUCTS - '14' # CLOTHING AND ACCESSORIES - CLOTHING MANUFACTURE - '15' # LEATHER PREPARATION AND MANUFACTURE OF LEATHER ARTICLES, TRAVEL ITEMS AND FOOTWEAR - '16' # MANUFACTURE OF WOOD PRODUCTS - '17' # MANUFACTURE OF CELLULOSE, PAPER AND PAPER PRODUCTS - '18' # PRINTING AND REPRODUCTION OF RECORDINGS - '19' # MANUFACTURE OF COKE, OIL DERIVATIVE PRODUCTS AND BIOFUELS - '20' # MANUFACTURE OF CHEMICALS - '21' # MANUFACTURE OF PHARMACEUTICAL AND PHARMACEUTICAL PRODUCTS - '22' # MANUFACTURE OF RUBBER PRODUCTS AND PLASTIC MATERIAL - '23' # MANUFACTURE OF NON-METALLIC MINERAL PRODUCTS - '24' # METALLURGY - '25' # MANUFACTURE OF METAL PRODUCTS, EXCEPT MACHINERY AND EQUIPMENT - '26' # MANUFACTURE OF COMPUTER EQUIPMENT, ELECTRONIC AND OPTICAL PRODUCTS - '27' # MANUFACTURE OF MACHINERY, APPLIANCES AND ELECTRICAL MATERIALS - '28' # MACHINERY AND EQUIPMENT MANUFACTURING - '29' # MANUFACTURE OF MOTOR VEHICLES, TRAILERS AND BODYWORKS - '30' # MANUFACTURE OF OTHER TRANSPORT EQUIPMENT, EXCEPT MOTOR VEHICLES - '31' # FABRICATION OF FURNITURE - '32' # MANUFACTURE OF MISCELLANEOUS PRODUCTS - '33' # MAINTENANCE, REPAIR AND INSTALLATION OF MACHINERY AND EQUIPMENT - '35' # ELECTRICITY, GAS AND OTHER UTILITIES - '36' # WATER COLLECTION, TREATMENT AND DISTRIBUTION - '37' # SEWAGE AND RELATED ACTIVITIES - '38' # WASTE COLLECTION, TREATMENT AND DISPOSAL; MATERIAL RECOVERY - '39' # DECONTAMINATION AND OTHER WASTE MANAGEMENT SERVICES - '41' # BUILDING CONSTRUCTION - '42' # INFRASTRUCTURE WORKS - '43' # SPECIALIZED CONSTRUCTION SERVICES - '45' # TRADE AND REPAIR OF MOTOR VEHICLES AND MOTORCYCLES - '46' # WHOLESALE TRADE, EXCEPT MOTOR VEHICLES AND MOTORCYCLES - '47' # RETAILER TRADE - '49' # LAND TRANSPORT - '50' # WATER TRANSPORT - '51' # AIR TRANSPORT - '52' # STORAGE AND AUXILIARY TRANSPORT ACTIVITIES - '53' # MAIL AND OTHER DELIVERY ACTIVITIES - '55' # ACCOMMODATION - '56' # FOOD - '58' # EDITING AND EDITING INTEGRATED WITH PRINTING - '59' # CINEMATOGRAPHIC ACTIVITIES, VIDEO PRODUCTION AND TELEVISION PROGRAMS; SOUND RECORDING AND MUSIC EDITING - '60' # RADIO AND TELEVISION ACTIVITIES - '61' # TELECOMMUNICATIONS - '62' # ACTIVITIES OF INFORMATION TECHNOLOGY SERVICES - '63' # ACTIVITIES FOR THE PROVISION OF INFORMATION SERVICES - '64' # FINANCIAL SERVICE ACTIVITIES - '65' # INSURANCE, REINSURANCE, COMPLEMENTARY PENSION AND HEALTH PLANS - '66' # AUXILIARY ACTIVITIES IN FINANCIAL SERVICES, INSURANCE, COMPLEMENTARY PENSION AND HEALTH PLANS - '68' # REAL ESTATE ACTIVITIES - '69' # LEGAL, ACCOUNTING AND AUDITING ACTIVITIES - '70' # BUSINESS HEADQUARTERS AND BUSINESS MANAGEMENT CONSULTING ACTIVITIES - '71' # ARCHITECTURE AND ENGINEERING SERVICES; TECHNICAL TESTS AND ANALYSIS - '72' # RESEARCH AND SCIENTIFIC DEVELOPMENT - '73' # ADVERTISING AND MARKET RESEARCH - '74' # OTHER PROFESSIONAL, SCIENTIFIC AND TECHNICAL ACTIVITIES - '75' # VETERINARY ACTIVITIES - '77' # NON-REAL ESTATE RENTALS AND MANAGEMENT OF NON-FINANCIAL INTANGIBLE ASSETS - '78' # SELECTION, MANAGEMENT AND LEASE OF LABOR - '79' # TRAVEL AGENCIES, TOUR OPERATORS AND RESERVATION SERVICES - '80' # SURVEILLANCE, SECURITY AND INVESTIGATION ACTIVITIES - '81' # SERVICES FOR BUILDINGS AND LANDSCAPE ACTIVITIES - '82' # OFFICE SERVICES, ADMINISTRATIVE SUPPORT AND OTHER SERVICES PROVIDED TO COMPANIES - '84' ​​# PUBLIC ADMINISTRATION, DEFENSE AND SOCIAL SECURITY - '85' # EDUCATION - '86' # HUMAN HEALTH CARE ACTIVITIES - '87' # HUMAN HEALTH CARE ACTIVITIES INTEGRATED WITH SOCIAL ASSISTANCE, PROVIDED IN COLLECTIVE AND PRIVATE RESIDENCES - '88' # ASSISTANCE SERVICES (pt) - '01' # AGRICULTURA, PECUÁRIA E SERVIÇOS RELACIONADOS - '02' # PRODUÇÃO FLORESTAL - '03' # PESCA E AQÜICULTURA - '05' # EXTRAÇÃO DE CARVÃO MINERAL - '06' # EXTRAÇÃO DE PETRÓLEO E GÁS NATURAL - '07' # EXTRAÇÃO DE MINERAIS METÁLICOS - '08' # EXTRAÇÃO DE MINERAIS NÃO-METÁLICOS - '09' # ATIVIDADES DE APOIO À EXTRAÇÃO DE MINERAIS - '10' # FABRICAÇÃO DE PRODUTOS ALIMENTÍCIOS - '11' # FABRICAÇÃO DE BEBIDAS - '12' # FABRICAÇÃO DE PRODUTOS DO FUMO - '13' # FABRICAÇÃO DE PRODUTOS TÊXTEIS - '14' # CONFECÇÃO DE ARTIGOS DO VESTUÁRIO E ACESSÓRIOS - '15' # PREPARAÇÃO DE COUROS E FABRICAÇÃO DE ARTEFATOS DE COURO, ARTIGOS PARA VIAGEM E CALÇADOS - '16' # FABRICAÇÃO DE PRODUTOS DE MADEIRA - '17' # FABRICAÇÃO DE CELULOSE, PAPEL E PRODUTOS DE PAPEL - '18' # IMPRESSÃO E REPRODUÇÃO DE GRAVAÇÕES - '19' # FABRICAÇÃO DE COQUE, DE PRODUTOS DERIVADOS DO PETRÓLEO E DE BIOCOMBUSTÍVEIS - '20' # FABRICAÇÃO DE PRODUTOS QUÍMICOS - '21' # FABRICAÇÃO DE PRODUTOS FARMOQUÍMICOS E FARMACÊUTICOS - '22' # FABRICAÇÃO DE PRODUTOS DE BORRACHA E DE MATERIAL PLÁSTICO - '23' # FABRICAÇÃO DE PRODUTOS DE MINERAIS NÃO-METÁLICOS - '24' # METALURGIA - '25' # FABRICAÇÃO DE PRODUTOS DE METAL, EXCETO MÁQUINAS E EQUIPAMENTOS - '26' # FABRICAÇÃO DE EQUIPAMENTOS DE INFORMÁTICA, PRODUTOS ELETRÔNICOS E ÓPTICOS - '27' # FABRICAÇÃO DE MÁQUINAS, APARELHOS E MATERIAIS ELÉTRICOS - '28' # FABRICAÇÃO DE MÁQUINAS E EQUIPAMENTOS - '29' # FABRICAÇÃO DE VEÍCULOS AUTOMOTORES, REBOQUES E CARROCERIAS - '30' # FABRICAÇÃO DE OUTROS EQUIPAMENTOS DE TRANSPORTE, EXCETO VEÍCULOS AUTOMOTORES - '31' # FABRICAÇÃO DE MÓVEIS - '32' # FABRICAÇÃO DE PRODUTOS DIVERSOS - '33' # MANUTENÇÃO, REPARAÇÃO E INSTALAÇÃO DE MÁQUINAS E EQUIPAMENTOS - '35' # ELETRICIDADE, GÁS E OUTRAS UTILIDADES - '36' # CAPTAÇÃO, TRATAMENTO E DISTRIBUIÇÃO DE ÁGUA - '37' # ESGOTO E ATIVIDADES RELACIONADAS - '38' # COLETA, TRATAMENTO E DISPOSIÇÃO DE RESÍDUOS; RECUPERAÇÃO DE MATERIAIS - '39' # DESCONTAMINAÇÃO E OUTROS SERVIÇOS DE GESTÃO DE RESÍDUOS - '41' # CONSTRUÇÃO DE EDIFÍCIOS - '42' # OBRAS DE INFRA-ESTRUTURA - '43' # SERVIÇOS ESPECIALIZADOS PARA CONSTRUÇÃO - '45' # COMÉRCIO E REPARAÇÃO DE VEÍCULOS AUTOMOTORES E MOTOCICLETAS - '46' # COMÉRCIO POR ATACADO, EXCETO VEÍCULOS AUTOMOTORES E MOTOCICLETAS - '47' # COMÉRCIO VAREJISTA - '49' # TRANSPORTE TERRESTRE - '50' # TRANSPORTE AQUAVIÁRIO - '51' # TRANSPORTE AÉREO - '52' # ARMAZENAMENTO E ATIVIDADES AUXILIARES DOS TRANSPORTES - '53' # CORREIO E OUTRAS ATIVIDADES DE ENTREGA - '55' # ALOJAMENTO - '56' # ALIMENTAÇÃO - '58' # EDIÇÃO E EDIÇÃO INTEGRADA À IMPRESSÃO - '59' # ATIVIDADES CINEMATOGRÁFICAS, PRODUÇÃO DE VÍDEOS E DE PROGRAMAS DE TELEVISÃO; GRAVAÇÃO DE SOM E EDIÇÃO DE MÚSICA - '60' # ATIVIDADES DE RÁDIO E DE TELEVISÃO - '61' # TELECOMUNICAÇÕES - '62' # ATIVIDADES DOS SERVIÇOS DE TECNOLOGIA DA INFORMAÇÃO - '63' # ATIVIDADES DE PRESTAÇÃO DE SERVIÇOS DE INFORMAÇÃO - '64' # ATIVIDADES DE SERVIÇOS FINANCEIROS - '65' # SEGUROS, RESSEGUROS, PREVIDÊNCIA COMPLEMENTAR E PLANOS DE SAÚDE - '66' # ATIVIDADES AUXILIARES DOS SERVIÇOS FINANCEIROS, SEGUROS, PREVIDÊNCIA COMPLEMENTAR E PLANOS DE SAÚDE - '68' # ATIVIDADES IMOBILIÁRIAS - '69' # ATIVIDADES JURÍDICAS, DE CONTABILIDADE E DE AUDITORIA - '70' # ATIVIDADES DE SEDES DE EMPRESAS E DE CONSULTORIA EM GESTÃO EMPRESARIAL - '71' # SERVIÇOS DE ARQUITETURA E ENGENHARIA; TESTES E ANÁLISES TÉCNICAS - '72' # PESQUISA E DESENVOLVIMENTO CIENTÍFICO - '73' # PUBLICIDADE E PESQUISA DE MERCADO - '74' # OUTRAS ATIVIDADES PROFISSIONAIS, CIENTÍFICAS E TÉCNICAS - '75' # ATIVIDADES VETERINÁRIAS - '77' # ALUGUÉIS NÃO-IMOBILIÁRIOS E GESTÃO DE ATIVOS INTANGÍVEIS NÃO-FINANCEIROS - '78' # SELEÇÃO, AGENCIAMENTO E LOCAÇÃO DE MÃO-DE-OBRA - '79' # AGÊNCIAS DE VIAGENS, OPERADORES TURÍSTICOS E SERVIÇOS DE RESERVAS - '80' # ATIVIDADES DE VIGILÂNCIA, SEGURANÇA E INVESTIGAÇÃO - '81' # SERVIÇOS PARA EDIFÍCIOS E ATIVIDADES PAISAGÍSTICAS - '82' # SERVIÇOS DE ESCRITÓRIO, DE APOIO ADMINISTRATIVO E OUTROS SERVIÇOS PRESTADOS ÀS EMPRESAS - '84' # ADMINISTRAÇÃO PÚBLICA, DEFESA E SEGURIDADE SOCIAL - '85' # EDUCAÇÃO - '86' # ATIVIDADES DE ATENÇÃO À SAÚDE HUMANA - '87' # ATIVIDADES DE ATENÇÃO À SAÚDE HUMANA INTEGRADAS COM ASSISTÊNCIA SOCIAL, PRESTADAS EM RESIDÊNCIAS COLETIVAS E PARTICULARES - '88' # SERVIÇOS DE ASSISTÊNCIA SOCIAL SEM ALOJAMENTO - '90' # ATIVIDADES ARTÍSTICAS, CRIATIVAS E DE ESPETÁCULOS - '91' # ATIVIDADES LIGADAS AO PATRIMÔNIO CULTURAL E AMBIENTAL - '92' # ATIVIDADES DE EXPLORAÇÃO DE JOGOS DE AZAR E APOSTAS - '93' # ATIVIDADES ESPORTIVAS E DE RECREAÇÃO E LAZER - '94' # ATIVIDADES DE ORGANIZAÇÕES ASSOCIATIVAS - '95' # REPARAÇÃO E MANUTENÇÃO DE EQUIPAMENTOS DE INFORMÁTICA E COMUNICAÇÃO E DE OBJETOS PESSOAIS E DOMÉSTICOS - '96' # OUTRAS ATIVIDADES DE SERVIÇOS PESSOAIS - '97' # SERVIÇOS DOMÉSTICOS - '99' # ORGANISMOS INTERNACIONAIS E OUTRAS INSTITUIÇÕES EXTRATERRITORIAIS | ### ActivitySectorCode (en/pt) - 'armedForces' # (en) Armed Forces | (pt) Forças Armadas - 'auctioneer' # (en) Auctioneer | (pt) Leiloeiro - 'audiovisualIndustry' # (en) Audiovisual Industry | (pt) Audiovisual - 'bondedWarehouse' # (en) Bonded Warehouse | (pt) Depósito alfandegado - 'broadcastingIndustry' # (en) Broadcasting Industry | (pt) Radiodifusão - 'construction' # (en) Construction | (pt) Construção civil - 'coops' # (en) Coops | (pt) Cooperativa - 'distributor' # (en) Distributor | (pt) Distribuidor - 'distributionCenter' # (en) Distribution Center | (pt) Centro de Distribuição - 'electricityDistributor' # (en) Electricity Distributor | (pt) Distribuidor de Energia Elétrica - 'energyGeneration' # (en) Energy Generation | (pt) Gerador e Produtor De Energia Elétrica - 'extractor' # (en) Extractor | (pt) Extrator - 'farmCoop' # (en) Farm Coop | (pt) Cooperativa de Produtores - 'filmIndustry' # (en) Film Industry | (pt) Indústria Cinematográfica - 'finalConsumer' # (en) Final Consumer | (pt) Consumidor Final - 'fuelDistributor' # (en) Fuel Distributor | (pt) Distribuidor de Combustível - 'generalWarehouse' # (en) General Warehouse | (pt) Armazem geral - 'importer' # (en) Importer | (pt) Importadora - 'industry' # (en) Industry | (pt) Industria - 'itaipubiNacional' # (en) Itaipubi Nacional | (pt) Itaipu Binacional - 'maritimeService' # (en) Maritime Service | (pt) Serviço Marítimo - 'mealSupplier' # (en) Meal Supplier | (pt) Fornecedor de Refeição - 'nonProfitEntity' # (en) Non Profit Entity | (pt) Entidades sem fins lucrativos - 'pharmaDistributor' # (en) Pharma Distributor | (pt) Distribuidor de Medicamento - 'publicAgency' # (en) Public Agency | (pt) Orgão Publico - 'religiousEstablishment' # (en) Religious Establishment | (pt) Templos de Qualquer Culto - 'retail' # (en) Retail | (pt) Varejo - 'ruralProducer' # (en) Rural Producer | (pt) Produtor Rural - 'securityPublicAgency' # (en) Brazilian Security Public Agency | (pt) Agência Pública de Segurança Brasileira - 'service' # (en) Service | (pt) Serviço - 'stockWarehouse' # (en) Stock Warehouse | (pt) Depósito Fechado - 'telco' # (en) Telco | (pt) Serviço de Comunicação - 'transporter' # (en) Transporter | (pt) Transportador/Serviço de Transportadora - 'waterDistributor' # (en) Water Distributor | (pt) Distribuidor de Água - 'wholesale' # (en) Wholesale | (pt) Atacado - 'commerce' # (en) Commerce | (pt) Comercio - 'incentivizedCollectors' # (en) Incentivized Collectors | (pt) Coletores Incentivados - 'barsRestaurantsSnackBars' # (en) Bars, Restaurants and Snack Bars | (pt) Bares, Restaurantes e Lanchonetes - 'condominiumAssociation' # (en) Condominium Association | (pt) Condomínio Edilício - 'laborUnions' # (en) Labor Unions | (pt) Entidades Sindicais - 'politicalParties' # (en) Political Parties | (pt) Partidos Políticos - 'rerefinerOrAuthCollector' # (en) Re-refiner or Authorized Collector | (pt) Rerrefinador ou Coletor Autorizado - 'independentFreightTransp' # (en) Independent Freight Transporter | (pt) Transportador Autônomo de Carga - 'rbtConcessionaires' # (en) Highway, Bridge, Tunnel Concessionaires and Related Services | (pt) Concessionárias de rodovias, pontes, túneis e serviços relacionados - 'sportsAssocClubs' (en) Sports Associations and Clubs | (pt) Associações e Clubes Esportivos ### IcmsTaxReliefReasonEnum (en/pt) - '0' # (en) No ICMS tax relief / (pt) Sem Desoneração - '1' # (en) Taxi / (pt) Táxi - '3' # (en) Agricultural Production / (pt) Produtor Agropecuário - '4' # (en) Fleet Owners / (pt) Frotista/Locadora - '5' # (en) Diplomatic Missions / (pt) Diplomático/Consular - '6' # (en) Vehicle and motorcycle of free zone area and ocidental Amazon / (pt) Utilitários e Motocicletas da Amazônia Ocidental e Áreas de Livre Comércio (Resolução 714/88 e 790/94 – CONTRAN e suas alterações) - '7' # (en) SUFRAMA / (pt) SUFRAMA - '8' # (en) Sales to Government / (pt) Venda a órgão Público - '9' # (en) Others / (pt) Outros - '10' # (en) Disabled person driver / (pt) Deficiente Condutor - '11' # (en) Disabled person not driver / (pt) Deficiente não condutor - '12' # (pt) Fomento agropecuário - '16' # (en) Rio 2016 Summer Olympics / (pt) Olimpíadas Rio 2016 - '90' # (pt) Solicitado pelo Fisco ### CalcModeFullEnum (en) Informs how this ICMS is calculed for itens linked to this configuration. (pt) Informa como esse ICMS é calculado para itens vinculados a esta configuração. ### IcmsSt_rateCitation | Property | Type | Description | |---|---|---| | `id` | string | (en) External identification code created by another system that control the citations, like Tax Advisor (pt) Código de identificação externo criado por outro sistema que controla as citações, como Consultor Fiscal | | `replaceId` | string | (en) When a new citation is only a update of another actual citation without change the main features (example changing only rate or exempt code or CST) then it will replace automaticly the other citation identified by this attribute. (pt) Quando uma nova citation é apenas uma atualização de outra citation vigente sem mudar as suas características (exemplo alíquota, código de isenção ou CST) ela automaticamente substitui a citation identificada por este atributo. | | `citation` | string | (en) Citation text used in eletronic invoices to justify special tributary scenario. (pt) Texto de citação utilizado nas notas fiscais eletrônicas para justificar o cenário tributário especial. | | `description` | string | (en) Legal reason textual description. (pt) Descrição textual do motivo legal. | | `references` | array | (en) List of referenced text document (pt) Lista de documentos de texto referenciados | ### ICMSPartialExemptionRates | Property | Type | Description | |---|---|---| | `exemptionRate` | number | (en) Percentage of base tax reduction (pt) Percentual de redução de imposto base | | `icmsRate` | number | (en) Percentage of base tax reduction (pt) Percentual de redução de imposto base | ### IpiCSTEnum (en) Informs if this process is subject to IPI taxation on the output process. - 'T' # TAXABLE - 'Z' # TAXABLE WITH RATE=0.00 - 'E' # EXEMPT - 'H' # SUSPENDED - 'N' # NO TAXABLE - 'I' # IMMUNE - 'O' # OTHER - 'OZ' # OTHER WITH RATE=0.00 (pt) (pt) Informa se este processo está sujeito à tributação de IPI no processo de saída. - 'T' # TRIBUTÁVEL - 'Z' # TRIBUTÁVEL COM TAXA = 0,00 - 'E' # ISENTO - 'H' # SUSPENSO - 'N' # NÃO TAXÁVEL - 'I' # IMUNE - 'O' # OUTROS - 'OZ' # OUTROS COM TAXA = 0,00 ### IssCSTEnum (en) - 'T' # TAXABLE - 'E' # TAXABLE WITH EXEMPTION FOR EXPORTS - 'F' # EXEMPT - 'A' # SUSPENDED FOR ADMINISTRATIVE REASON - 'L' # SUSPENDED FOR LEGAL DECISION - 'I' # IMMUNE - 'N' # NO TAXABLE (pt) - 'T' # TRIBUTÁVEL INCLUSIVE PARA EXPORTAÇÃO' - 'E' # ISENTO PARA SERVIÇOS PRESTADOS AO EXTERIOR (DEFAULT) - 'F' # ISENTO - 'A' # SUSPENSO POR MOTIVO ADMINISTRATIVO - 'L' # SUSPENSO POR DECISÃO LEGAL - 'I' # IMUNE - 'N' # NAO TRIBUTÁVEL ### PisCofinsCSTEnum (en) Informs if this item by nature is subject to PIS OR COFINS taxation. - 'T' # TAXABLE - 'Z' # TAXABLE WITH RATE=0.00 - 'E' # EXEMPT - 'H' # SUSPENDED - 'N' # NO TAXABLE - 'R' # BASE REDUCTION - 'I' # IMMUNE (pt) Informa se este item por natureza está sujeito à tributação de PIS OU COFINS. - 'T' # TRIBUTÁVEL - 'Z' # TRIBUTÁVEL COM TAXA = 0,00 - 'E' # ISENTO - 'H' # SUSPENSO - 'N' # NÃO TAXÁVEL - 'R' # REDUÇÃO DE BASE - 'I' # IMUNE ### CPRBCSTEnum (en) Informs if this item by nature is subject to PIS OR COFINS taxation. - 'T' # TAXABLE (pt) Informa se este item por natureza está sujeito à tributação de PIS OU COFINS. - 'T' # TRIBUTÁVEL ### CSTISEnum (en) Informs if this process is subject to IPI taxation on the output process. - 'T' # 0 TAXABLE - 'I' # 10 IMMMUNE - 'N' # 2 NON-OCCURRENCE OF THE GENERATING EVENT - 'S' # 4 SUSPENDED - 'Z' # 5 ZERO RATE - 'R' # 3 RETURN (pt) (pt) Informa se este processo estA sujeito A tributaCAo de IPI no processo de saída. - 'T' # 0 TRIBUTAVEL - 'I' # 10 IMUNE - 'N' # 2 NAO OCORRENCIA DE FATO GERADOR - 'S' # 4 SUSPENSO - 'Z' # 5 ALIQUOTA ZERO - 'R' # 3 DEVOLUÇÃO ### TransactionBase ### TransactionFull ### BatchTransactionFull | Property | Type | Description | |---|---|---| | `documentCode` | string | (en) Identifier of a batch calculation request. (pt) Identificador de uma solicitação de cálculo em lote. Usage purpose: Calculation/Invoice | ### BatchTransactionForGoodsResultsOut ### TransactionBaseForGoods | Property | Type | Description | |---|---|---| | `header` | HeaderBaseForGoods | | | `lines` | array | | | `version` | string | (en) Payload Model Version (pt) Versão modelo do payload | ### TransactionBaseForServices | Property | Type | Description | |---|---|---| | `header` | HeaderBaseForServices | | | `lines` | array | | | `version` | string | (en) Payload Model Version (pt) Versão modelo do payload | ### HeaderBaseForGoods ### LineBaseForGoods ### HeaderBase | Property | Type | Description | |---|---|---| | `enableCitationWarnings` | boolean | (en) When true, the calculation result includes, per line, a list of potential legal bases (citations) related to tax benefits applicable to that line’s hsCode. For informational use to support audit/review; it does not validate eligibility or guarantee completeness, and may increase response size/latency. (pt) Quando true, o resultado do cálculo passa a incluir, por linha, uma lista de possíveis fundamentações legais relacionadas a benefícios tributários aplicáveis ao hsCode daquela linha. Uso informativo para apoio à auditoria/revisão; não valida elegibilidade nem garante exaustividade e pode aumentar o tamanho/latência da resposta. Usage purpose: Calculation/Invoice | | `eDocCreatorType` | string | (en) Informs whether the location used in the calculation as the issue of the document is establishment (self) or entity (other). Default is: self. (pt) Informa se a localidade utilizada no cálculo como emitente do documento fiscal é o próprio estabelecimento (self) ou a entidade participante (other). Valor padrão é: self. Usage purpose: Calculation/Invoice | | `eDocCreatorPerspective` | boolean | (en) Used in case of return transactions: "True": The system calculates the invoice reversal amounts only related to credits and debits (bookkeeping) "False": The system generates amounts and quantities related to the return invoice generation. (pt) Utilizado em casos emissão de nota de devolução: “True”: O sistema calcula os valores de estorno da nota apenas relacionados a créditos e débitos (escrituração). “False”: O sistema gera valores e quantidades relacionados a geração de nota fiscal de devolução. Usage purpose: Calculation/Invoice | | `operationType` | string | (en) Operation type per transaction. If informed in the line, the system ignores the header information. (pt) Tipo de operação por transação. Caso informado na linha, o sistema ignorará a informação do header. Usage purpose: Calculation/Invoice | | `amountCalcType` | AmountCalcTypeEnum | | | `companyLocation` | string | (en) External identifier of the company in the branch record of the Avalara Portal. (pt) Identificador externo da companhia no cadastro de matriz/filial do Portal Avalara. | | `transactionDate` | string | (en) This string follows the transaction date format according to ISO 8601. Format YYYY-MM-DDTHH:mm:ssZ. The date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z. (pt) Esta string segue o formato de data da transação de acordo com a ISO 8601. Formato AAAA-MM-DDTHH: mm: ssZ. A notação de data e hora é definida pela RFC 3339, seção 5.6, por exemplo, 2017-07-21T17: 32: 28Z. | | `documentCode` | string | (en) This string is a code maintained by the client application to uniquely identify a document. It will typically be an invoice number, sales order, receipt number, returned merchandise authorization number, etc. (pt) Esta string é um código mantido pelo aplicativo cliente para identificar exclusivamente um documento. Normalmente será um número de fatura, pedido de venda, número de recibo, número de autorização de mercadoria devolvida, etc. Usage purpose: Calculation/Invoice | ### HeaderGoodsGroup | Property | Type | Description | |---|---|---| | `model` | TransactionModel | | | `class` | string | (en) Describes the type of this transaction (pt) Natureza da operação Usage purpose: Invoice | | `tpImp` | string | (en) How the document will be printed - '0' # without DANFE; - '1' # DANFe Letter; - '2' # DANFe Landscape; - '3' # DANFe Simplified; - '4' # DANFe NFC-e; - '5' # DANFe NFC-e e-mail (pt) Como o documento será impresso - '1' # Carta DANFe; - '2' # Paisagem DANFe; - '3' # DANFe simplificado; - '4' # DANFe NFC-e; - '5' # DANFe NFC-e-mail Usage purpose: Invoice | | `indFinal` | integer | (en) This flag informs whether the operation is to an end user (0 - No; 1- End User). If the calculation request receives the value 1, the system changes in all lines [n] the useType attribute to 'use or consumption' when the type of operation is OUTBOUND (ATTRIBUTE way=OUT). - 0 # NO - 1 # END USER (pt) O marcador indica se a operação é com consumidor final (0-Não;1-Consumidor Final). Se a solicitação de cálculo receber o valor 1, o sistema altera em todas as linhas [n] o atributo useType para 'uso ou consumo' quando o tipo de operação for saída (ATRIBUTO way = OUT). - 0 # NÃO - 1 # USUÁRIO FINAL Usage purpose: Invoice | | `idDest` | integer | (en) This indicator informs the transaction target place, when is AUTOMATIC the company address and entity address are analyzed to identify type of transaction target place. Exist some cases where is necessary to force this situation for example when the buyer from another state buy something in loco, the address are from different states, but the transaction is not. - 0 AUTOMATIC - DEFAULT - 1 Same state; - 2 Interstate; - 3 International (pt) Identificador de Local de destino da operação, na opção AUTOMÁTICA endereços da Companhia e da entidade destino são analisados para saber se é uma operação dentro do mesmo estado, interestadual ou com o exterior. Há situações onde é necessário forçar este indicador como por exemplo: quando uma pessoa possui endereço em outro estado, compra uma mercadoria de forma presencial, é uma operação interna apesar dos endereços dos envolvidos estarem em estados distintos. - 0 # AUTOMATICA - PADRÃO - 1 # Interna; - 2 # Interestadual; - 3 # Exterior Usage purpose: Invoice | | `indPres` | string | (en) Presence indicator on the transaction - '0' # Not applicable - '1' # Presential; - '2' # Remote, internet; - '3' # Remote, phone; - '4' # NFC-e home delivery; - '5' # In-person operation, for establishment (v3) - '9' # Remote, others (pt) Indicador de presença na transação - '0' # Não aplicável - '1' # Presencial; - '2' # Remoto, internet; - '3' # Remoto, telefone; - '4' # Entrega em domicílio NFC-e; - '5' # Operação presencial, para estabelecimento (v3) - '9' # Remoto, outros Usage purpose: Invoice | | `cMunFGIBS` | integer | (en) IBGE city code of consumption, triggering event for IBS and CBS (pt) Código do Município de consumo, fato gerador do IBS e CBS Usage Purpose: Calculation/Invoice/Do not apply for services | | `finNFe` | string | (en) Purpose of NF-e issuing - '0' # AUTOMATIC - DEFAULT - '1' # NFe normal - '2' # NFe complementary - '3' # NFe adjustment - '4' # Return - '5' # Credit eInvoice - '6' # Debit eInvoice (pt) Finalidade da emissão da NF-e - '0' # AUTOMATICA - PADRÃO - '1' # NFe normal - '2' # NFe complementar - '3' # NFe de ajuste - '4' # Devolução/Retorno - '5' # Nota de crédito; - '6' # Nota de débito; | | `debitInvoiceType` | string | (en) Debit Invoice Type - '01' # Transfer of credits to Cooperatives; - '02' # Cancellation of Credit for Exempt/Immune Outputs; - '03' # Debts from invoices not processed in the calculation; - '04' # Fine and interest; - '05' # Transfer of succession credit; - '06' # Advance payment - '07' # Inventory loss - '08' # Exclusion from the Simples Nacional regime (pt) Tipo de Nota de Débito - '01' # Transferência de créditos para Cooperativas; - '02' # Anulação de Crédito por Saídas Imunes/Isentas; - '03' # Débitos de notas fiscais não processadas na apuração; - '04' # Multa e juros; - '05' # Transferência de crédito de sucessão; - '06' # Pagamento antecipado - '07' # Perda em estoque - '08' # Desenquadramento do SN; | | `creditInvoiceType` | string | (en) Credit Invoice Type - '01' # Fines and interest - '02' # Appropriation of presumed IBS credit on the outstanding balance in the Manaus Free Trade Zone (Art. 450, § 1, Complementary Law 214/25) - '03' # Return due to refusal of delivery or failure to locate the recipient upon attempted delivery; - '04' # Value reduction - '05' # Credit transfer in succession (pt) Tipo de Nota de Crédito - '01' # Multa e juros - '02' # Apropriação de crédito presumido de IBS sobre o saldo devedor na ZFM (art. 450, § 1º, LC 214/25) - '03' # Retorno por recusa na entrega ou por não localização do destinatário na tentativa de entrega; - '04' # Redução de valores; - '05' # Transferência de crédito na sucessão; | | `tpEmis` | string | (en) Invoice Issue Type 1 - (en) Normal; 2 - (en) FS contingency 3 - (en) SCAN contingency 4 - (en) DPEC contingency 5 - (en) FSDA contingency 6 - (en) SVC Contingency - AN 7 - (en) SVC - RS contingency 9 - (en) NFC-e offline contingency (pt) Tipo de emissão da nota fiscal 1 - (pt) Normal; 2 - (pt) Contingência FS 3 - (pt) Contingência SCAN 4 - (pt) Contingência DPEC 5 - (pt) Contingência FSDA 6 - (pt) Contingência SVC - AN 7 - (pt) Contingência SVC - RS 9 - (pt) Contingência off-line NFC-e Usage purpose: Invoice | | `xJust` | string | (en) Contingency reason, must inform when tpEmis is contingency. (pt) Razão de contingência, deve informar quando tpEmis é contingência. Usage purpose: Invoice | | `dhCont` | string | (en) This string is the transaction date in ISO 8601 format, contingency date/time, must be informed when tpEmis is contingency. (pt) Esta string é a data da transação no formato ISO 8601, data/hora de contingência, deve ser informada quando tpEmis é contingência. Usage purpose: Invoice | | `nfceQrCode` | string | (en) QR code of NFC-E printed on DANFE. (pt) Código QR da NFC-E impresso no DANFE. Usage purpose: Invoice | | `urlKey` | string | (en) Only for NFC-e. Informs the URL link to consult the invoice access key. The same URL that must be informed in DANFE NFC-e for access key query. (pt) Apenas para NFC-e. Informa a URL para consultar a chave de acesso da nota. A mesma URL que deve estar informada no DANFE NFC-e para consulta por chave de acesso. Usage purpose: Invoice | | `transport` | TransportInfo | | | `purchaseInfo` | PurchaseInfo | | | `exportInfo` | ExportInfo | | | `technicalManager` | TechnicalManagerInfo | | | `goal` | GoalEnum | | | `indIntermed` | string | (en) Broker/Marketplace Indicator - '0' # (en) Operation without an intermediary (on website or own platform) - '1' # (en) Operation on third party website or platform (intermediaries / marketplace) (pt) Indicador de intermediador/marketplace - '0' # (pt) Operação sem intermediador (em site ou plataforma própria) - '1' # (pt) Operação em site ou plataforma de terceiros (intermediadores/marketplace) Usage purpose: Invoice | | `infIntermed` | object | (en) Transaction Broker Information Group (pt) Grupo de Informações do Intermediador da Transação Usage purpose: Invoice | | `inboundInvoiceIssuance` | boolean | (en) Usually inbound calculations are used only to book invoices, but some times the goal is calculate to inbound Invoice Issuance, changing rules (pt) Normalmente os cálculos de entrada são usados ​​apenas para escriturar documentos fiscais, mas algumas vezes o objetivo é calcular para emissão de documentos fiscais de entrada, NFe, alterando as regras Usage purpose: Calculation | | `agriculture` | Agriculture | | | `govProcurement` | object | (en) Government Procurement Group (pt) Grupo de Compras Governamentais | | `advancePayment` | object | (en) Informed to deduct the advance payment installments, according to Art. 10. § 4º (pt) Informado para abater as parcelas de antecipação de pagamento, conforme Art. 10. § 4º | | `enableCalcICBS` | boolean | (en) Attribute used to enable CBS/IBS calculation, if each Transaction is greater than the Start Date of SEFAZ environments (pt) Atributo usado para habilitar calculo CBS/IBS, caso cada Transação maior que a Data de Inicio dos ambientes do SEFAZ Usage purpose: Calculation | ### LocationForGoods (en) List of transaction participants, Emitter, Receiver, and Transporter (pt) Lista de participantes da transação, emissor, receptor e transportador | Property | Type | Description | |---|---|---| | `entity` | EntityFullDataForGoods | | | `establishment` | EntityFullDataForGoods | | | `transporter` | EntityInfoData | | | `delivery` | EntityInfoData | | | `pickup` | EntityInfoData | | | `sender` | EntityInfoData | | | `recipient` | EntityInfoData | | ### NRef | Property | Type | Description | |---|---|---| | `type` | string | (en) Referenced Invoices. The invoice can be one of these types: - 'refNFe - Eletronic Invoice' - 'refNFeSig - Electronic Invoice access key with 0 replacing the code to keep secrecy the referenced invoice' - 'refCTE - Transport Invoice' - 'refECF - Retail Cupom' - 'refNF - Invoice model 1 or 1A' - 'refFarmerNF - farmer invoice' (pt) Faturas Referenciadas. A fatura pode ser um destes tipos: - 'refNFe - Nota Fiscal Eletrônica' - 'refNFeSig - Nota Fiscal Eletrônica Chave de Acesso com código numérico zerado,permitindo manter o sigilo da NF-e referenciada.' - 'refCTE - Nota Fiscal de Transporte' - 'refECF - Cupom de varejo' - 'refNF - Fatura modelo 1 ou 1A' - 'refFarmerNF - fatura do agricultor' | | `found` | boolean | (en) Indicated if the Invoice was found in our database. This property is auto-filled by system. (pt) Indicado se a Nota Fiscal foi encontrada no banco de dados. Esta propriedade é preenchida automaticamente pelo sistema. | | `documentCode` | string | (en) Code Maintained by the client to uniquely identify a transaction (invoice number, sales order, receipt number, RMA) in their system. When present, the transaction will be saved. (pt) Código único no sistema do cliente que identifica a transação (números de fatura, pedido, recibo, etc). Quando informado, a transação será salva. Usage purpose: Calculation/Invoice | | `refNFe` | string | (en) Reference originating transaction. (Reference the NF-e) (pt) Transação de origem de referência. (Referenciar a NF-e). | | `refNFeSig` | string | (en) Electronic Invoice access key with 0 replacing the code to keep secrecy the referenced invoice (pt) Nota Fiscal Eletrônica Chave de Acesso com código numérico zerado,permitindo manter o sigilo da NF-e referenciada. | | `refCTe` | string | (en) Reference originating transaction. (pt) Transação de origem de referência. (Referenciar a CT-e). | | `refECF` | object | | | `refNF` | object | | | `refFarmerNF` | object | | ### HeaderPaymentForGoods | Property | Type | Description | |---|---|---| | `installmentTerms` | PaymentTerms | | | `bill` | PaymentBill | | | `installment` | array | (en) Installments (pt) Parcelas do pagamento Usage purpose: Invoice | | `paymentInfo` | object | | ### AdditionalInformationForGoods | Property | Type | Description | |---|---|---| | `fiscalInfo` | string | (en) Additional information of fiscal interest (pt) Informação adicional de interesse fiscal | | `complementaryInfo` | string | (en) Additional information of user interest (pt) Informação adicional de interesse do usuário | | `otherInfo` | string | (en) Any additional information to print on the service invoice (pt) Qualquer informação adicional para imprimir na fatura de serviço | | `iest` | string | (en) State Tax Id for ST (pt) ID de imposto estadual para ST | | `procRef` | array | (en) Referenced Process (pt) Processo referenciado | ### AddressInfo | Property | Type | Description | |---|---|---| | `street` | string | (en) Street Name (pt) Nome da rua Usage purpose: Calculation/Invoice | | `neighborhood` | string | (en) Neighborhood Name (pt) Nome do bairro Usage purpose: Invoice | | `zipcode` | string | (en) Zip Code (pt) Código postal Usage purpose: Calculation/Invoice | | `cityCode` | string | (en) City Code (pt) Código da cidade Usage purpose: Invoice | | `cityName` | string | (en) City Name (pt) Nome da cidade Usage purpose: Invoice | | `state` | string | (en) State Code (pt) Código do estado Usage purpose: Invoice | | `countryCode` | string | (en) Country Code (pt) Código do país Usage purpose: Invoice | | `country` | string | (en) Use ISO 3166-1 alpha-3 codes (pt) Usar os códigos ISO 3166-1 alpha-3 Usage purpose: Calculation/Invoice | | `number` | string | (en) House number (pt) Número da casa Usage purpose: Invoice | | `complement` | string | (en) Any other information about the address (Room, Suite, Floor, etc) (pt) Quaisquer outras informações sobre o endereço (Quarto, Suíte, Andar, etc) Usage purpose: Invoice | | `phone` | string | (en) Phone number (pt) Número de telefone Usage purpose: Invoice | | `email` | string | (en) Entity Email (pt) Email da Entidade Usage purpose: Invoice | | `addressNotInformed` | boolean | (en) (Optional) Indicates that the entity address was not informed in request. If not filled it will be considered false. (pt) (Opcional) Indica que o endereço da entidade não foi informado na request. Se não for preenchido será considerado false. Usage Purpose: Invoice | ### AmountCalcTypeEnum (en) Whether it is a transaction in gross or net weight. (pt) Se a transação é em peso bruto ou líquido. ### ExportInfo (en) Export information (pt) Informações de exportação | Property | Type | Description | |---|---|---| | `shippingState` | StateEnum | | | `place` | string | (en) Shipping place (pt) Local de envio Usage purpose: Invoice | | `placeDescription` | string | (en) Description of shipping place (pt) Descrição do local de envio Usage purpose: Invoice | ### PurchaseInfo | Property | Type | Description | |---|---|---| | `governmentOrder` | string | (en) Invoice information for government purchase orders. (pt) Informação da Notas fiscais de compras públicas/para o governo. Usage Purpose: Invoice | | `orderNumber` | string | (en) Order info (pt) Informação do pedido Usage Purpose: Calculation/Invoice/New attribute | | `contractNumber` | string | (en) Agreement info (pt) Informação do contrato | ### TechnicalManagerInfo (en) Technical Manager information (pt) Informações do gerente técnico | Property | Type | Description | |---|---|---| | `federalTaxId` | string | (en) Technical Manager's federal tax id (CNPJ) (pt) ID fiscal federal do gerente técnico (CNPJ) Usage purpose: Invoice | | `contactName` | string | (en) Contact Name (pt) Nome de contato Usage purpose: Invoice | | `email` | string | (en/pt) Email Usage purpose: Invoice | | `phone` | string | (en) Telephone number (pt) Número de telefone Usage purpose: Invoice | | `idCSRT` | string | (en) CSRT identifier. Technical manager id. (pt) Identificador CSRT. Id do responsável técnico. Usage purpose: Invoice | | `hashCSRT` | string | (en) CSRT Hash. Hashcsrt is the csrt code encrypted using the sha-1 base 64 algorithm. (pt) O hashcsrt é o código de segurança do responsável técnico criptografado usando o algoritimo sha-1 base 64. Usage purpose: Invoice | ### TransactionModel (en) - '01' # Invoice 1 / 1A - '1B' # Single invoice - '02' # In-Consumer Sales Invoice - '2D' # Tax Coupon - '2E' # Tax Coupon-Ticket - '04' # Invoice from Producer - '06' # Nota Fiscal / Electricity Bill - '07' # Invoice for Transport Service - '08' # Bill of Lading - '8B' # Loose Bill of Lading - '09' # Bill of Lading - '10' # Aircraft Knowledge - '11' # Bill of Lading - '13' # Road Ticket - '14' # Waterway Ticket - '15' # e-Baggage Ticket - '16' # Rail Ticket - '18' # Daily Movement Summary - '21' # Invoice for de-Communication Service - '22' # Invoice for Telecommunication Service - '26' # Bill of Lading Multimodal Transport - '27' # Invoice for Rail Transport De-Cargo - '28' # Invoice / Gas Supply Channel Account - '29' # Invoice / Water Supply Account - '55' # Electronic Invoice (NF-e) - '57' # Electronic Bill of Lading (CT-e) - '58' # Electronic Manifesto of Tax Documents (MDF-e) - '59' # Electronic Tax Coupon (CF-e-SAT) - '60' # Electronic Tax Coupon (CF-e-ECF) - '65' # Electronic Invoice to the Final Consumer (NFC-e) (pt) - '01' # Nota Fiscal 1/1A - '1B' # Nota Fiscal Avulsa - '02' # Nota Fiscal de Venda a-Consumidor - '2D' # Cupom Fiscal - '2E' # Cupom Fiscal-Bilhete de Passagem - '04' # Nota Fiscal de Produtor - '06' # Nota Fiscal/Conta de Energia Elétrica - '07' # Nota Fiscal de Serviço de Transporte - '08' # Conhecimento de Transporte Rodoviário de-Cargas - '8B' # Conhecimento de Transporte de-Cargas Avulso - '09' # Conhecimento de Transporte Aquaviário de-Cargas - '10' # Conhecimento Aéreo - '11' # Conhecimento de Transporte Ferroviário de-Cargas - '13' # Bilhete de Passagem Rodoviário - '14' # Bilhete de Passagem Aquaviário - '15' # Bilhete de Passagem e-Nota de-Bagagem - '16' # Bilhete de Passagem Ferroviário - '18' # Resumo de Movimento Diário - '21' # Nota Fiscal de Serviço de-Comunicação - '22' # Nota Fiscal de Serviço de Telecomunicação - '26' # Conhecimento de Transporte Multimodal de-Cargas - '27' # Nota Fiscal De Transporte Ferroviário De-Carga - '28' # Nota Fiscal/Conta de Fornecimento de Gás-Canalizado - '29' # Nota Fiscal/Conta de Fornecimento de Água-Canalizada - '55' # Nota Fiscal Eletrônica (NF-e) - '57' # Conhecimento de Transporte Eletrônico (CT-e) - '58' # Manifesto Eletrônico de Documentos Fiscais (MDF-e) - '59' # Cupom Fiscal Eletrônico (CF-e-SAT) - '60' # Cupom Fiscal Eletrônico (CF-e-ECF) - '65' # Nota Fiscal Eletrônica ao-Consumidor Final (NFC-e) ### TransportInfo | Property | Type | Description | |---|---|---| | `modFreight` | string | (en) Freight model - 'CIF' 0 - Freight contracting on behalf of the Sender (CIF); - 'FOB' 1 - Contracting of freight on behalf of the recipient/sender (FOB); - 'Thirdparty' 2 - Contracting Freight on behalf of third parties; - 'SenderVehicle' 3 - Own transport on behalf of the sender; - 'ReceiverVehicle' 4 - Own transport on behalf of the recipient; - 'FreeShipping' 9 - Free shipping when 9 - Free shipping, the fields below will be ignored if present (transport, withholdICMSTransport, volumes, vehicle) (pt) Modelo de frete - 'CIF' 0 - Contratação de frete por conta do remetente (CIF); - 'FOB' 1 - Contratação de frete por conta do destinatário / remetente (FOB); - 'Terceiro' 2 - Contratação de Frete por conta de terceiros; - 'SenderVehicle' 3 - Transporte próprio por conta do remetente; - 'ReceiverVehicle' 4 - Transporte próprio por conta do destinatário; - 'FreeShipping' 9 - Frete grátis quando 9 - Frete grátis, os campos abaixo serão ignorados se presentes (transporte, reter ICMSTransporte, volumes, veículo) Usage purpose: Invoice | | `volumes` | array | (en) Packaging: used to identify ICMS-ST by statutory price. (pt) Embalagem: usada para identificar ICMS-ST por pauta. Usage purpose: Invoice | | `vehicle` | VehicleTransp | | ### Agriculture (en) Agricultural (Animal, Vegetable and Forestry) Products (pt) Produtos Agropecurários Animais, Vegetais e Florestais Usage Purpose: Invoice | Property | Type | Description | |---|---|---| | `defensive` | array | (en) Agricultural pesticide or pesticide (pt) Defensivo Agrícola ou Agrotóxico Usage Purpose: Invoice | | `transitForm` | object | (en) Transit Forms for animal, vegetable and forestry agricultural products. (pt) Guias De Trânsito de produtos agropecurários animais, vegetais e de origem florestal. Usage Purpose: Invoice | ### VehicleTransp (en) Identify the type of vehicle used to transport. The attributes, except attribute type, follow rule oneOf then only one of these attributes is informed. (pt) Identifique o tipo de veículo utilizado para o transporte. Os atributos, exceto o tipo de atributo, seguem a regra oneOf então apenas um desses atributos é informado. | Property | Type | Description | |---|---|---| | `type` | string | | | `automobile` | VehicleID | | | `trailer` | array | (en/pt) Trailer | | `wagon` | string | | | `ferry` | string | (en) Ferry (pt) Balsa | ### VehicleID | Property | Type | Description | |---|---|---| | `licensePlate` | string | | | `stateCode` | StateEnum | | | `rtnc` | string | (en) Cargo National Land Transportation Agency (pt) Agência Nacional de Transportes Terrestres (ANTT) | ### EntityInfoData | Property | Type | Description | |---|---|---| | `name` | string | (en) Entity name, official name (pt) Nome da entidade, nome oficial (Razão Social) Usage purpose: Calculation/Invoice | | `businessName` | string | (en) DBA - Used to identify branches/subsidiaries with the same name (pt) Nome Fantasia, Usado para identificar filiais / subsidiárias com o mesmo nome Usage purpose: Invoice | | `type` | EntityType | | | `federalTaxId` | string | (en) CNPJ/CPF of Sales Buyer, if CPF pattern is '[0-9]{11}' if CNPJ pattern is '[0-9]{14}' (pt) CNPJ/CPF do comprador, se o padrão do CPF for '[0-9] {11}' se o padrão do CNPJ for '[0-9] {14}' Usage purpose: Invoice | | `cityTaxId` | string | (en) City Tax ID (pt) ID do imposto municipal Usage Purpose: Invoice | | `stateTaxId` | string | (en) State Tax ID (pt) Identificação do imposto estadual Usage Purpose: | Invoice | | `suframa` | string | (en) SUFRAMA ID (Manaus Free Trade Zone Superintendence). 8 to 9 digit code. (pt) SUFRAMA (Superintendência da Zona Franca de Manaus). Código de 8 à 9 dígitos. | | `taxRegime` | FederalTaxRegime | | | `address` | AddressInfo | | ### EntityFullData | Property | Type | Description | |---|---|---| | `name` | string | (en) Entity name, official name (Razão Social) (pt) Nome da entidade, nome oficial (Razão Social) | | `businessName` | string | (en) DBA - name used to identify branches/subsidiaries with same name. (pt) DBA - Nome fantasia. | | `type` | EntityType | | | `federalTaxId` | string | (en) CNPJ/CPF of Sales Buyer, if CPF pattern is '[0-9]{11}' if CNPJ pattern is '[0-9]{14}' (pt) CNPJ / CPF do comprador da venda, se o padrão do CPF for '[0-9] {11}' se o padrão do CNPJ for '[0-9] {14}' Usage purpose: Invoice | | `cityTaxId` | string | (en) City Tax ID (pt) ID do imposto municipal Usage Purpose: | Invoice | | `stateTaxId` | string | (en) State Tax ID (pt) Identificação do imposto estadual Usage Purpose: | Invoice | | `suframa` | string | (en) SUFRAMA ID (Manaus Free Trade Zone Superintendence). 8 to 9 digit code. (pt) SUFRAMA (Superintendência da Zona Franca de Manaus). Código de 8 à 9 dígitos. | | `incentiveArea` | string | (en) The general law provides specific benefits for what we call "Incentivized Areas," such as Free Trade Zones, special customs regimes, transit, storage, temporary transfer or improvement, and export processing zones. See the predefined list of incentivized areas to locate the benefit. (pt) A lei geral traz benefícios específicos para o que denominamos “Áreas Incentivadas” como Zona Franca, Regimes aduaneiros especiais, de trânsito, depósito, permanência temporária ou aperfeiçoamento, zonas de processamento de exportação. Ver lista predefinida de áreas incentivadas para localização do benefício | | `taxRegime` | FederalTaxRegime | | | `taxesSettings` | TaxesSettings | | | `address` | AddressInfo | | | `activitySector` | ActivitySector | | ### EntityFullDataForGoods ### TaxesSettingsForGoods | Property | Type | Description | |---|---|---| | `pisCofinsAssetCalcBase` | string | (en) There are different understandings about what makes up the PIS/COFINS base in case of credit - 'D' # DEFAULT - 'I' # item value without IPI following RFB Nº 2121, DE 15 DE DEZEMBRO DE 2022 - 'S' # Add ICMS ST amount - 'N' # value that contributes to the total value of the eInvoice (pt) Existem diferentes entendimentos sobre o que compoe a base de PIS/COFINS em caso de crédito - 'D' # DEFAULT - 'I' # Valor do Item sem IPI conforme INSTRUÇÃO NORMATIVA RFB Nº 2121, DE 15 DE DEZEMBRO DE 2022 - 'S' # Adiciona valor do ICMS ST a base do PIS E COFINS - 'N' # Adiciona todos os valores que contribuem para o valor total da Nota Fiscal Eletrônica Usage Purpose: Calculation | | `taxReformInterDependentModel` | boolean | (en) Informs if the entity is CBS and IBS tax payer (pt) Informa se CBS e IBS compõe base de cálculo de ICMS OU ISS Usage Purpose: | Calculation/Invoice | | `notCbsIbsTaxPayer` | boolean | (en) Informs if the entity is CBS and IBS tax payer (pt) Informa se a entidade é contribuinte do CBS e IBS Usage Purpose: | Calculation/Invoice | | `applyCashback` | boolean | (en) Informs that cashback is applicable (pt) Informa que cashback é aplicavel á entidade Usage Purpose: | Calculation/Invoice | | `icmsTaxPayer` | boolean | (en) Informs if the entity is ICMS tax payer (pt) Informa se a entidade é contribuinte do ICMS Usage Purpose: | Calculation/Invoice | | `pisCofinsReliefZF` | boolean | (en) For outbound to Free Zone is optional to apply for tax relief, reducing from the total invoice amount the PIS/COFINS Tax Amount. PISCOFINS Tax relief at free zone. (pt) Para saída para Zona Franca é opcional a aplicação de desoneração tributária, reduzindo do valor total da fatura o Valor do PIS/COFINS. Desoneração de PISCOFINS na zona Franca. Usage purpose: Calculation | | `pisCofinsReliefZFLikeUDisc` | boolean | (en) This interpretation the discount is applied like a unconditional discount and its is reduced of ICMS and ICMS-ST bases (pt) Esta interpretação do desconto é aplicada como um desconto incondicional e é reduzida das bases de cálculo do ICMS e ICMS-ST. Usage purpose: Calculation | | `cofinsSubjectTo` | string | (en) There are cases where both Seller, Buyer, and items are taxable but a special situation still exists that forces the transaction to be exempt especially for PIS and COFINS. This attribute will allow users to identify such scenarios and trigger the exemption in spite of all other settings. - 'T' # TAXABLE - 'N' # NOT TAXABLE - 'Z' # TAXABLE WITH RATE=0.00 - 'E' # EXEMPT - 'H' # SUSPENDED (pt) Existem casos em que Vendedor, Comprador e itens são tributáveis, mas ainda existe uma situação especial que obriga a operação a ficar isenta principalmente de PIS e COFINS. Este atributo permitirá que os usuários identifiquem esses cenários e acionem a isenção, apesar de todas as outras configurações. - 'T' # TAXÁVEL - 'N' # NÃO TAXÁVEL - 'Z' # TRIBUTÁVEL COM TAXA = 0,00 - 'E' # ISENTO - 'H' # SUSPENSO Usage Purpose: Calculation | | `csllSubjectTo` | string | (en) There are cases where both Seller, Buyer, and items are taxable but a special situation still exists that forces the transaction to be CSLL exempt. This attribute will allow users to identify such scenarios and trigger the exemption in spite of all other settings. - T TAXABLE - E EXEMPT (pt) Existem casos em que o Vendedor, o Comprador e os itens são tributáveis, mas ainda existe uma situação especial que obriga a transação a ser isenta da CSLL. Este atributo permitirá que os usuários identifiquem esses cenários e acionem a isenção, apesar de todas as outras configurações. - TAXÁVEL - E ISENTO Usage Purpose: Calculation | | `pisSubjectTo` | string | (en) There are cases where both Seller, Buyer, and items are taxable but a special situation still exists that forces the transaction to be exempt especially for PIS and COFINS. This attribute will allow users to identify such scenarios and trigger the exemption in spite of all other settings. - 'T' # TAXABLE - 'N' # NOT TAXABLE - 'Z' # TAXABLE WITH RATE=0.00 - 'E' # EXEMPT - 'H' # SUSPENDED (pt) Existem casos em que Vendedor, Comprador e itens são tributáveis, mas ainda existe uma situação especial que obriga a operação a ficar isenta principalmente de PIS e COFINS. Este atributo permitirá que os usuários identifiquem esses cenários e acionem a isenção, apesar de todas as outras configurações. - 'T' # TAXÁVEL - 'N' # NÃO TAXÁVEL - 'Z' # TRIBUTÁVEL COM TAXA = 0,00 - 'E' # ISENTO - 'H' # SUSPENSO Usage Purpose: Calculation | | `pCredSN` | number | (en) ICMS rate for company that is tax regime simplified. (pt) Alíquota de ICMS caso a empresa seja optante do simples. Usage purpose: Calculation/Invoice | | `pCredCBSSN` | number | (en) CBS rate for company that is tax regime simplified. (pt) Alíquota de CBS caso a empresa seja optante do simples. Usage purpose: Calculation/Invoice | | `pCredIBSSN` | number | (en) IBS rate for company that is tax regime simplified. (pt) Alíquota de IBS caso a empresa seja optante do simples. Usage purpose: Calculation/Invoice | | `withholdICMSTransport` | boolean | (en) Informs if the service transport amount has icms withhold. (pt) Informar se existe retenção do icms no serviço de transporte. Usage purpose: Calculation | | `pisCofinsIcmsTaxRelief` | boolean | (en) Exempts the ICMS tax amount from the pis/cofins calc base. br /> (pt) Isenta o valor do ICMS da base de cálculo pis / cofins. Usage purpose: Calculation | | `pisCofinsIcmsTaxReliefMode` | object | | | `pisCofinsIcmsTaxCreditRelief` | boolean | (en) Exempts the ICMS tax amount from the pis/cofins calc base for inbounds br /> (pt) Isenta o valor do ICMS da base de cálculo pis / cofins for inbounds. Usage purpose: Calculation | | `pisCofinsIcmsTaxCreditReliefMode` | object | | | `enableCprb` | boolean | (en) Informs if enables Calculation of INSS CPRB. (pt) Informa se habilita Cálculo do INSS CPRB. Usage purpose: Calculation | | `reduceIcmsTaxReliefToIPIBase` | boolean | (en) The company can interpret the -Resolucao n. 1, de 2017- and it can reduce the ICMS tax relief amount to IPI base. (pt) A empresa pode interpretar a -Resolucao n. 1, de 2017- e pode reduzir o valor da desoneração do ICMS à base do IPI. | ### TaxesSettings | Property | Type | Description | |---|---|---| | `icmsTaxPayer` | boolean | (en) Informs if the entity is ICMS tax payer (pt) Informa se a entidade é contribuinte do ICMS Usage Purpose: | Calculation/Invoice | | `subjectToPayrollTaxRelief` | boolean | (en) Subject to payroll exemption (pt) Sujeito à desoneração de folha de pagamento Usage purpose: Calculation | | `roundingServiceByItem` | number | (en) Tax amount rounding by service item - 2 ROUNDING OF DECIMAL PLACES TO TWO DECIMAL PLACES - 4 ROUNDING OF DECIMAL PLACES TO FOUR DECIMAL PLACES (pt) Arredondamento do valor do imposto por item de serviço - 2 ARREDONDAMENTO DE CASAS DECIMAIS PARA DUAS CASAS DECIMAIS - 4 ARREDONDAMENTO DE CASAS DECIMAIS PARA QUATRO CASAS DECIMAIS Usage Purpose: Calculation/Invoice | | `pisFopag` | boolean | (en) PIS on Payroll (pt) O PIS sobre a folha de pagamento. Usage Purpose: | Calculation | | `pisCofinsReliefZF` | boolean | (en) For outbound to Free Zone is optional to apply for tax relief, reducing from the total invoice amount the PIS/COFINS Tax Amount. PISCOFINS Tax relief at free zone. (pt) Para saída para Zona Franca é opcional a aplicação de desoneração tributária, reduzindo do valor total da fatura o Valor do PIS/COFINS. Desoneração de PISCOFINS na zona Franca. Usage purpose: Calculation | | `cofinsSubjectTo` | string | (en) There are cases where both Seller, Buyer, and items are taxable but a special situation still exists that forces the transaction to be exempt especially for PIS and COFINS. This attribute will allow users to identify such scenarios and trigger the exemption in spite of all other settings. - 'T' # TAXABLE - 'N' # NOT TAXABLE - 'Z' # TAXABLE WITH RATE=0.00 - 'E' # EXEMPT - 'H' # SUSPENDED (pt) Existem casos em que Vendedor, Comprador e itens são tributáveis, mas ainda existe uma situação especial que obriga a operação a ficar isenta principalmente de PIS e COFINS. Este atributo permitirá que os usuários identifiquem esses cenários e acionem a isenção, apesar de todas as outras configurações. - 'T' # TAXÁVEL - 'N' # NÃO TAXÁVEL - 'Z' # TRIBUTÁVEL COM TAXA = 0,00 - 'E' # ISENTO - 'H' # SUSPENSO Usage Purpose: Calculation | | `csllSubjectTo` | string | (en) There are cases where both Seller, Buyer, and items are taxable but a special situation still exists that forces the transaction to be CSLL exempt. This attribute will allow users to identify such scenarios and trigger the exemption in spite of all other settings. - T TAXABLE - E EXEMPT (pt) Existem casos em que o Vendedor, o Comprador e os itens são tributáveis, mas ainda existe uma situação especial que obriga a transação a ser isenta da CSLL. Este atributo permitirá que os usuários identifiquem esses cenários e acionem a isenção, apesar de todas as outras configurações. - TAXÁVEL - E ISENTO Usage purpose: Calculation | | `pisSubjectTo` | string | (en) There are cases where both Seller, Buyer, and items are taxable but a special situation still exists that forces the transaction to be exempt especially for PIS and COFINS. This attribute will allow users to identify such scenarios and trigger the exemption in spite of all other settings. - 'T' # TAXABLE - 'N' # NOT TAXABLE - 'Z' # TAXABLE WITH RATE=0.00 - 'E' # EXEMPT - 'H' # SUSPENDED (pt) Existem casos em que Vendedor, Comprador e itens são tributáveis, mas ainda existe uma situação especial que obriga a operação a ficar isenta principalmente de PIS e COFINS. Este atributo permitirá que os usuários identifiquem esses cenários e acionem a isenção, apesar de todas as outras configurações. - 'T' # TAXÁVEL - 'N' # NÃO TAXÁVEL - 'Z' # TRIBUTÁVEL COM TAXA = 0,00 - 'E' # ISENTO - 'H' # SUSPENSO Usage purpose: Calculation | | `receiptsAreFullNoCumulativePisCofins` | boolean | (en) Purchase on Free Zones, PIS/COFINS non cumulative rate. (pt) Compras na ZFM, PIS/COFINS com alícota específica. Usage purpose: Calculation | | `issRfRateForSimplesTaxRegime` | number | (en) When the Seller is in a Simples regime, the seller needs to send an RF rate. (pt) Quando o vendedor está em regime do Simples Nacional, o vendedor precisa enviar a alíquota. Usage purpose: Calculation/Invoice | | `pCredSN` | number | (en) ICMS rate for company that is tax regime simplified. (pt) Alíquota de ICMS caso a empresa seja optante do simples. Usage purpose: Calculation/Invoice | | `enableCprb` | boolean | (en) Informs if enables calculation of INSS CPRB. (pt) Informa se habilita cálculo do INSS CPRB. Usage purpose: Calculation | | `usesInssCprbToGrossValue` | boolean | (en) Uses the INSS CPRB to calc gross value when amountCalcType=net. (pt) Considera o INSS CPRB no cálculo do valor bruto para amountCalcType=net. Usage purpose: Calculation | | `notWithHoldIRForPublicAgency` | boolean | (en) Payments from federal Public Agency are subject to Withholding, with some exceptions like SESC, SENAI, - IR. (pt) Pagamentos de Órgão Público Federal estão sujeitos a Retenção na Fonte, com algumas exceções como SESC, SENAI, - RI. | | `withholdICMSTransport` | boolean | (en) Informs if the service transport amount has icms withhold. (pt) Informar se existe retenção do icms no serviço de transporte. Usage purpose: Calculation | | `pisCofinsIcmsTaxRelief` | boolean | (en) Reduces the ICMS tax amount from PIS and COFINS calculation base. (pt) Exclusão do ICMS da base do PIS e COFINS. | ### StateCodeEnum (en) State Code: North region 11-Rondônia/RO 12-Acre/AC 13-Amazonas/AM 14-Roraima/RR 15-Pará/PA 16-Amapá/AP 17-Tocantins/TO Northeast Region 21-Maranhão/MA 22-Piauí/PI 23-Ceará/CE 24-Rio Grande do Norte/RN 25-Paraíba/PB 26-Pernambuco/PE 27-Alagoas/AL 28-Sergipe/SE 29-Bahia/BA Southeast region 31-Minas Gerais/MG 32-Espírito Santo/ES 33-Rio de Janeiro/RJ 35-São Paulo/SP South region 41-Paraná/PR 42-Santa Catarina/SC 43-Rio Grande do Sul/RS Midwest region 50-Mato Grosso do Sul/MS 51-Mato Grosso/MT 52-Goiás/GO 53-Distrito Federal/DF (pt) Código do Estado: Região Norte 11-Rondônia/RO 12-Acre/AC 13-Amazonas/AM 14-Roraima/RR 15-Pará/PA 16-Amapá/AP 17-Tocantins/TO Região Nordeste 21-Maranhão/MA 22-Piauí/PI 23-Ceará/CE 24-Rio Grande do Norte/RN 25-Paraíba/PB 26-Pernambuco/PE 27-Alagoas/AL 28-Sergipe/SE 29-Bahia/BA Região Sudeste 31-Minas Gerais/MG 32-Espírito Santo/ES 33-Rio de Janeiro/RJ 35-São Paulo/SP Região Sul 41-Paraná/PR 42-Santa Catarina/SC 43-Rio Grande do Sul/RS Região Centro-Oeste 50-Mato Grosso do Sul/MS 51-Mato Grosso/MT 52-Goiás/GO 53-Distrito Federal/DF ### InstallmentComplete | Property | Type | Description | |---|---|---| | `documentNumber` | string | (en) Doc number/ document ID for this transaction. (pt) Número do documento/ID do documento para esta transação. Usage purpose: Calculation/Invoice | | `date` | string | (en) Installment due date (pt) Data de vencimento das parcelas Usage purpose: Calculation/Invoice | | `grossValue` | number | (en) Installment gross amount (pt) Valor bruto da parcela Usage purpose: Calculation/Invoice | | `netValue` | number | (en) Installment net amount (pt) Valor líquido da parcela Usage purpose: Calculation | | `withholdingMode` | WithholdingMode | | | `withholdingPIS` | number | (en) Returns PIS-RF tax for this installment. (pt) Retorna o tributo PIS-RF dessa parcela. Usage purpose: Calculation | | `withholdingCOFINS` | number | (en) Returns COFINS-RF tax for this installment. (pt) Retorna a tributo COFINS-RF para esta parcela. Usage purpose: Calculation | | `withholdingCSLL` | number | (en) Returns CSLL-RF tax for this installment. (pt) Retorna imposto CSLL-RF para este pagamento. Usage purpose: Calculation | ### PaymentBill | Property | Type | Description | |---|---|---| | `nFat` | string | (en) Bill identifier (pt) Número da fatura Usage purpose: Invoice | | `vOrig` | number | (en) Original value (pt) Valor original Usage purpose: Invoice | | `vDiscount` | number | (en) Discount (pt) Desconto Usage purpose: Invoice | | `vNet` | number | (en) Net value (pt) Valor líquido Usage purpose: Invoice | ### PaymentMode | Property | Type | Description | |---|---|---| | `mode` | 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 | | `modeDescription` | 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 | | `value` | number | (en) Payment value (pt) Valor do pagamento Usage purpose: Invoice | | `cardTpIntegration` | 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 | | `cardCNPJ` | 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 | | `cardBrand` | 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 | | `cardAuthorization` | 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 | | `paymentDate` | string | (en) Payment date, Format YYYY-MM-DD (pt) Data do pagamento, Formato AAAA-MM-DD Usage purpose: Invoice | | `federalTaxIdBeneficiary` | string | (en) Inform the CNPJ of the establishment receiving the payment (pt) Informar o CNPJ do estabelecimento beneficiário do pagamento Usage purpose: Invoice | | `idTermPag` | string | (en) Payment terminal identifier (pt) Identificador do terminal de pagamento Usage purpose: Invoice | | `paymentLocation` | object | | ### PaymentTerms (en) Payment Terms: - 1 # Specific Date - 2 # Presentation - 3 # In Cash - 4 # Other - 5 # Term - 6 # Credit Card - 7 # Debit Card (pt) Condições de pagamento: - 1 # Data Específica - 2 # Apresentação - 3 # À vista - 4 # Outros - 5 # À prazo - 6 # Cartão de Crédito - 7 # Cartão de Débito Usage purpose: Invoice ### WithholdingMode (en) Each position represents a tribute withheld in the following sequence: PIS (P), COFINS (C) and CSLL (C). If an x appears in the position of one of the tributes, it means that this tribute will not be retained. (pt) Cada posição representa um tributo retido na seguinte sequência: PIS (P), COFINS (C) e CSLL (C). Caso apareça um x na posição de um dos tributos, significa que esse tributo não será retido. - 'xxx' - 'PCC' - 'PCx' - 'PxC' - 'Pxx' - 'xCC' - 'xxC' - 'xCx' Usage purpose: Calculation ### ItemDescriptorForGoods | Property | Type | Description | |---|---|---| | `description` | string | (en) Item Description (pt) Descrição do item | | `legalReference` | string | (en) Legal Reference/Detail (pt) Referência Legal/Detalhe | | `taxCode` | string | (en) Auxiliary code for determination and legal citation of the item. (pt) Código auxiliar para determinação e fundamentação legal do item. Usage purpose: Calculation/Invoice | | `hsCode` | string | (en) (HC) Harmonized code for goods or LC116 code for services. (pt) Código NCM ou código de serviço de acordo com a LC116. Usage purpose: Calculation/Invoice | | `ex` | string | (en) HSCODE exception (ex) for IPI tax (pt) Código ex para casos de isenção do IPI Usage purpose Calculation/Invoice | | `cest` | string | (en) Tax substitution classification code. (pt) Código classificador de substituição tributária. Usage purpose: Calculation/Invoice/Do not apply for services | | `cean` | string | (en) GTIN NUMBER (Global Trade Item Number) (pt) Número GTIN (Número global de item comercial) Usage purpose: | Calculation/Invoice | | `ceanTax` | string | (en) GTIN (Global Trade Item Number) of taxable unit (pt) GTIN (número de item comercial global) da unidade tributável Usage purpose: Calculation/Invoice | | `cBar` | string | (pt) Código de Barras próprio ou de terceiros, que seja diferente do padrão GTIN, para que um contribuinte possa informar simultaneamente o código de barras utilizado por seu fornecedor e o seu (do contribuinte) código interno. (en) Own or third party Bar Code, which is different from the GTIN standard, so that a taxpayer can simultaneously inform the bar code used by his supplier and his (the taxpayer's) internal code. | | `cBarraTrib` | string | (pt) Código de Barras da unidade tributável que seja diferente do padrão GTIN, Código de Barras próprio ou de terceiros, que seja diferente do padrão GTIN, correspondente àquele da menor unidade comercializável identificado por Código de Barras (en) Barcode of the taxable unit that is different from the GTIN standard, own or third party Barcode, which is different from the GTIN standard, corresponding to that of the smallest tradable unit identified by Barcode | | `nveList` | array | (en) NVE - extension code for customs and statistical Value Nomenclature. (pt) Nomenclatura de Valor aduaneiro e Estatístico. Usage purpose: Calculation/Invoice/Do not apply for services | | `nve` | string | (en) NVE - extension code for customs and statistical Value Nomenclature. (pt) Nomenclatura de Valor aduaneiro e Estatístico. Usage purpose: | Calculation/Invoice/Do not apply for services | | `unit` | string | (en) Sales Unit of measure (pt) Unidade de medida de venda Usage purpose: | Calculation/Invoice/Do not apply for services | | `unitTaxable` | string | (en) Taxable Unit od measure (pt) Unidade de medida tributável Usage purpose: Calculation/Invoice/Do not apply for services | | `package` | string | (en) Packaging: used to identify ICMS-ST by statutory price (pt) Embalagem: usada para identificar o ICMS-ST por pauta | | `isIcmsStSubstitute` | boolean | (en) ICMS substitute flag identifies wholesaler, retailer, distributor role. (pt) Indica empresa sujeita ao ICMS ST por substituto tributário (distribuidor, varejista e atacadista). Usage purpose: Calculation/Invoice | | `source` | ItemSourceGoodsEnum | | | `productType` | SpedFiscalProductType | | | `manufacturerEquivalent` | boolean | (en) Item is merchandise but will be considered as a product (pt) O item é uma mercadoria, mas será considerado um produto Usage purpose: Calculation | | `notSubjectToIcmsSt` | boolean | (en) Item is not subject to ICMS ST, even though it has CEST, example fixed asset, used products like cars (pt) Item não sujeito ao ICMS ST, mesmo tendo um CEST associado a ele, exemplo, venda de ativo ou revenda de itens usados como carros. Usage purpose: Calculation | | `sealCode` | string | (en) Seal Code for IPI tax control (pt) Código do selo para controle de IPI Usage purpose: Invoice | | `sealQuantity` | string | (en) Seal Code for ipi tax control (pt) Código do selo para controle de IPI Usage purpose: Calculation/Invoice/Do not apply for services | | `cnpjProd` | string | (en) CNPJ/CPF of Sales Buyer, if CPF pattern is '[0-9]{11}' if CNPJ pattern is '[0-9]{14}'. Federal tax ID of real manufacturer, only for exportation. (pt) CNPJ/CPF do comprador da venda, se o padrão do CPF for '[0-9] {11}' se o padrão do CNPJ for '[0-9] {14}'. CPF/CNPJ do fabricante real, somente para exportação. Usage purpose: Calculation/Invoice/Do not apply for services | | `nFCI` | string | (en) Importation content form number (pt) Número de controle da FCI - Ficha de Conteúdo de Importação | | `appropriateCBSIBScreditWhenInBound` | boolean | (en) Informs that this item will have rights to appropriate CBS and IBS credit (pt) Informa que este item terá direito ao crédito de CBS and IBS | | `appropriateIPIcreditWhenInGoing` | boolean | (en) Informs that this item will have rights to appropriate IPI credit (pt) Informa que este item terá direito ao crédito de IPI apropriado | | `appropriateICMScreditWhenInGoing` | boolean | (en) Informs that this item will have rights to appropriate ICMS credit (pt) Informa que este item terá direito à apropriação do crédito de ICMS | | `appropriatePISCOFINScreditWhenInGoing` | boolean | (en) Subject to appropriate PIS/COFINS credit, when is NON-CUMULATIVE (pt) Sujeito ao devido crédito de PIS/COFINS, quando NÃO CUMULATIVO | | `isPisCofinsEstimatedCredit` | boolean | (en) The credit PIS/COFINS is subject to purchase from companies, but exist some exceptions, when the credit will be an estimated amount # see http://www.portaltributario.com.br/artigos/credito-presumido-pis-cofins-origem-animal.htm (pt) O crédito do PIS/COFINS está sujeito à aquisição de empresas, mas existem algumas exceções, quando o crédito será em valor estimado # ver http://www.portaltributario.com.br/artigos/credito-presumido-pis-cofins-origem -animal.htm Usage purpose: Calculation | | `piscofinsRevenueType` | PisCofinsRevenueType | | | `unitIPIfactor` | number | (en) Factor to convert sales quantity to IPI taxable quantity when it is by SRF Statutory Retail Price (Pauta). (pt) Fator de conversão da quantidade vendida em quantidade tributável de IPI quando for pela SRF Preço Legal de Varejo (Pauta). Usage purpose: Calculation/Invoice/Do not apply for services | | `unitIcmsfactor` | number | (en) Factor to convert sales quantity to ICMS taxable quantity when it is by SRF Statutory Retail Price (Pauta). (pt) Fator para converter a quantidade de vendas em quantidade tributável de ICMS quando for pelo Preço Legal de Varejo SRF (Pauta). Usage purpose: Calculation/Invoice/Do not apply for services | | `unitIcmsStfactor` | number | (en) Factor to convert sales quantity to ICMS-ST taxable quantity when it is by SRF Statutory Retail Price (Pauta). (pt) Fator de conversão da quantidade vendida em quantidade tributável de ICMS-ST quando for pelo Preço Legal de Varejo SRF (Pauta). Usage purpose: Calculation/Invoice/Do not apply for services | | `unitPisCofinsfactor` | number | (en) Factor to convert sales quantity to PIS/COFINS taxable quantity when it is by SRF Statutory Retail Price (Pauta). (pt) Fator para converter a quantidade vendida em quantidade tributável de PIS / COFINS quando for pela SRF Preço Legal de Varejo (Pauta). Usage purpose: Calculation/Invoice/Do not apply for services | | `comexTaxUnitFactor` | number | (en) Factor to convert sales quantity to comexTaxUnit (pt) Fator para converter a quantidade de vendas em comexTaxUnit Usage purpose: Calculation/Invoice/Do not apply for services | | `cbsIbsUnitFactor` | number | (en) Factor to convert the quantity for calculating CBS OR IBS taxes in cases of AdRem taxation (pt) Fator para converter a quantidade para cálculo de tributos CBS OU IBS nos casos de tritutação AdRem Usage purpose: Calculation/Invoice/Do not apply for services | | `isUnitFactor` | number | (en) Factor to convert the quantity for calculating CBS OR IBS taxes in cases of AdRem taxation (pt) Fator para converter a quantidade para cálculo de tributos CBS OU IBS nos casos de tritutação AdRem Usage purpose: Calculation/Invoice/Do not apply for services | | `iiExTaxCode` | string | (en) NCM exception for import operations (pt) Exceção de NCM para operações de importação Usage purpose: Calculation | | `glAccountCode` | string | (en) GL accounting code (pt) Código da conta contábil Usage purpose: Calculation/Invoice | | `scaleInfoForIcmsSt` | object | (en) Indicates if the product is produced on a relevant scale, according to ICMS Agreement 52/17, which grants exemption from the Tax Replacement regime to taxpayers who meet the conditions (v3). (pt) Indicador de produção em escala relevante conforme Convênio ICMS 52/17, que concede isenção do regime de Substituição Tributária aos contribuintes que atenderem as condições (v3). Usage purpose: Calculation/Invoice/Do not apply for services | | `specialProductClass` | SpecialProductClass | | | `tpCredPresIBSZFM` | TpCredPresIBSZFMEnum | | | `usedMovableSupplyInd` | boolean | (en) Indicates whether the supplied movable good is used (pt) Indicador de fornecimento de bem móvel usado: True - Bem Móvel Usado Usage purpose: Calculation/Invoice | ### LineBase | Property | Type | Description | |---|---|---| | `lineCode` | integer | (en) This line item in the transaction (pt) Número da linha da transação por item Usage Purpose: | Calculation/Invoice | | `itemCode` | string | (en) Item code inside ERP (pt) Código do item dentro do ERP Usage purpose: Calculation/Invoice | | `itemDescriptor` | object | (en) Item description (pt) Descrição do item Usage purpose: Calculation/Invoice | | `numberOfItems` | number | (en) Number of items. (pt) Número de itens. Usage purpose: Calculation/Invoice | | `lineUnitPrice` | number | (en) Unit price. This decimal of 11 integers and 1 to 10 decimals captures the unit price of this line (pt) Valor unitário. Este decimal de 11 inteiros e 1 a 10 decimais captura o preço unitário desta linha Usage purpose: Calculation/Invoice | | `lineAmount` | number | (en) In its simplest form lineAmount = (item price * numberOfItems). If has included taxes then lineAmount = (item price * numberOfItems + tax). (pt) Em sua forma mais simples, lineAmount = (preço do item * numberOfItems). Se incluiu impostos, lineAmount = (preço do item * numberOfItems + imposto). Usage purpose: Calculation/Invoice | | `lineNetUnitPrice` | number | (en) Response_payload only for cases where the calculation mode is "NET". This decimal 11 integers and 1 to 10 decimals captures the unit price of this line. (pt) Casos onde o modo de cálculo é "NET". Este decimal 11 inteiros e 1 a 10 decimais captura o preço unitário desta linha. Usage purpose: Calculation/Invoice | | `lineNetAmount` | number | RESPONSE_PAYLOAD ONLY (en) Response_palyoad only for services calculation, where the response will be (invoice amount - retentions). This decimal captures the total cost of this line. In its simplest form lineNetAmount = (lineAmount - discountTaxable - [sum of withholdings]) - for services. (pt) Para cálculo de serviços, onde a resposta será (total da nota - retenções). Este decimal captura o custo total desta linha. Em sua forma mais simples, lineNetAmount = (lineAmount - discountTaxable - [soma das retenções]) - para serviços. Usage Purpose: Calculation/Invoice | | `lineNetFigure` | number | RESPONSE_PAYLOAD ONLY (en) When the calculation mode is "GROSSVALUE", the "NETVALUE" is saved in this tag. (pt) Quando o modo de cálculo é "GROSSVALUE", o "NET" é salvo nesta tag. Usage purpose: Calculation/Invoice | | `lineTaxedDiscount` | number | (en) Discount amount by transaction line calculated. (pt) Valor do desconto por linha de transação calculada. Usage purpose: Calculation/Invoice | | `lineUnTaxedDiscount` | number | (en) Untaxed discount amount by transaction line calculated. (pt) Valor do desconto condicionado por linha de transação calculada. Usage purpose: Calculation/Invoice | | `customProperties` | array | (en) List of extended custom properties (pt) Lista de propriedades personalizadas estendidas | | `useType` | UseTypeEnum | | | `usagePurpose` | string | (en) Its is a extension for useType, where the useType attribute contains use purpose groups and usagePurpose contains details of this purpose. For example: "useType": "use or consumption" , "usagePurpose":"services subject to ISS". It's free text that helps create rules to choice the correct taxation. (pt) É uma extensão para useType, em que o atributo useType contém grupos de finalidade de uso e usagePurpose contém detalhes dessa finalidade. Por exemplo: "useType": "use ou consumo", "usagePurpose": "serviços sujeitos a ISS". É um texto livre que ajuda a criar regras para escolha da tributação correta. Usage purpose: Calculation | | `operationType` | string | (en) Operation type per transaction. Reference to process configurantion of this transaction, this property is used only if eDocCreator=self or eDocCreator=others and eDocCreatorPerspective=true. (pt) Tipo de operação por transação. Referência à configuração do processo desta transação, esta propriedade é usada apenas se eDocCreator = self ou eDocCreator = others e eDocCreatorPerspective = true. Usage purpose: Calculation | | `cfop` | integer | (en) Tax Code of Operations and Installments, returned by Avatax as part of the determination of taxes from the type of operation. (pt) Código Fiscal de Operações e Prestações, retornado pelo Avatax como parte da determinação dos tributos a partir do tipo de operação. Usage purpose: Calculation/Invoice/Do not apply for services | | `overwrite` | string | (en) - 'no' - [DEFAULT] AvaTax executes calc as normal - 'all' - No calc is performed - 'cfop' - All attributes but CFOP must be sent, AvaTax determines the CFOP - 'amount' - Must send CFOP and CST, AvaTax will calc amount - 'proportional' - [RESPONSE ONLY] In case os partial returns (amounts are proportional to originating document) (pt) - 'no' - AvaTax realiza o cálculo completo - All - Não é realizado o cálculo - 'cfop' - Todos os atributos devem ser enviados e o AvaTax determina o CFOP - 'amount' - Enviar o CFOP e CST para realização do cálculo - 'proportional' - [RESPONSE ONLY] Casos de devolução parcial (valores são proporcionais aos do documento original) | | `orderNumber` | string | (en) Order number, information used for B2B control process. (pt) Número do pedido, informações usadas para o processo de controle B2B. Usage Purpose: | Calculation/Invoice/New attribute | | `orderItemNumber` | string | (en) Number of the item from order number, information used for B2B control process (pt) Número do item a partir do número do pedido, informações usadas para o processo de controle B2B Usage Purpose: | Calculation/Invoice/New attribute | ### LineGoodsGroup | Property | Type | Description | |---|---|---| | `notSubjectToIsTax` | boolean | (en) Attribute indicating whether the transaction is not a triggering event for IS tax. (pt) Atributo que indica se a transação não é fato gerador de IS. Usage purpose: Calculation | | `returnedPercentageAmount` | number | (en) In return operations, this field informs the percentage of returned items. decimal max 3 integers and 2 decimals, v >=0.00 and v (pt) Nas operações de devolução, este campo informa a porcentagem de itens devolvidos. decimal máx. 3 inteiros e 2 decimais, v> = 0,00 ev Usage purpose: Calculation/Invoice | | `subjectToIPIonInbound` | boolean | PURCHASE - COMPRAS (en) Inform if the product is subject to IPI. This field indicates that for this item in this line the vendor is manufactory or manufacturer equivalent. When this field is not present the default value is a true case entity.activitySector is INDUSTRY OR (WHOLESALE AND IMPORTED). | INDUSTRY IS entity.activitySector.code=' industry' or entity.activitySector.code starts with 10 until 33. WHOLESALE IS entity.activitySector.code='wholesale' or entity.activitySector.code starts with 46 or entity.activitySector.code is [35131, 45111, 45412]. IMPORTED IS itemDescriptor.source == '2' of if note present item.source == '2'. (pt) Informar se o produto é sujeito a IPI. Este campo indica que, para este item nesta linha, o fornecedor é fabricante ou equiparado à industria para IPI. Quando este campo não está presente, o valor padrão é um caso verdadeiro. Entity.activitySector é INDUSTRIA OU (ATACADO OU IMPORTADO). | INDUSTRIA É entity.activitySector.code=' industry' ou entity.activitySector.code inicia com 10 até 33. ATACADO É entity.activitySector.code='wholesale' ou entity.activitySector.code inicia com 46 ou entity.activitySector.code é [35131, 45111, 45412]. IMPORTADO É itemDescriptor.source == '2' de nota se estiver presente item.source == '2'. Usage purpose: Calculation | | `entityOwnProduction` | boolean | (en) This attribute is used only on Entries Scenarios, and when present the item is considered an own Production of the Entity (Example: Vendor). (pt) Este atributo é utilizado apenas em Cenários de Entradas, e quando presente o item é considerado uma Produção Própria da Entidade (Exemplo: Vendedor). Usage purpose: Calculation | | `indTotType` | boolean | (en) Indicator if the item should be included on the invoice amount. (pt) Indicador se o total do item deve ser incluso no total da nota Usage purpose: Calculation/Invoice/Do not apply for services | | `isTransportIcmsWithheld` | boolean | (en) Informs that this item has ICMS withheld for transport value service (pt) Informa que neste item há retenção de ICMS para valor de transporte de serviço Usage purpose: Calculation/Invoice | | `customsCapitalRegimeIndicator` | string | (en) Customs or Capital Goods Regime, used only for rules to lookup citations (pt) Regime Aduaneiro ou de Bens de Capital, usado no mecanismo de pesquisa de fundamentações Usage purpose: Calculation | | `recopiNumber` | string | (en) RECOPI number (Registration and control system for operations with immune paper). (pt) Número RECOPI (Sistema de registro e controle das operações com papel imune). Usage purpose: Invoice | | `trace` | LineBase_trace | | | `vehicleDetails` | VehicleDetails | | | `medicineDetails` | MedicineDetails | | | `weaponDetails` | WeaponDetails | | | `fuelDetails` | FuelDetails | | | `exportDetails` | array | (en) Exportation detail (pt) Detalhe da Exportação Usage purpose: Invoice | | `importDetails` | array | (en) Import declaration (pt) Declaração de Importação Usage purpose: Invoice | | `entityIcmsStSubstitute` | string | (en) Force the entity play or not a tax collector role for ICMS-ST Substitute - 'default' - Normal - 'yes' - Entity is ICMS ST Substitute - 'no' - Entity is ICMS ST Substitute (pt) Forçar a entidade a desempenhar ou não papel de responsável pelo recolhimento de ICMS-ST Substituto - 'default' - Normal - 'yes' - Entidade é ICMS ST substituto - 'no' - Entidade é substituto do ICMS ST Usage purpose: Calculation | | `donationInd` | boolean | (en) Indicates the nature of the donation operation, guiding the calculation and generation of debts or refunds depending on the scenario. (pt) Indica a natureza da operação de doação, orientando a apuração e a geração de débitos ou estornos conforme o cenário Usage purpose: Calculation/Invoice | | `itemType` | string | (en) Informs the item class. (pt) Informa a classe do item. Usage Purpose: Calculation/Invoice | | `itemObs` | ItemObs | | | `icmsEstimated` | array | (en) Optional group for Estimated Credit information. (pt) Grupo opcional para informações do Crédito Presumido. | | `referencedItem` | LineReferencedItem | | ### PisCofinsRevenueType (en) - '01' # (en) Exclusively linked to Internal Market taxed revenue. - '02' # (en) Exclusively untaxed revenue in the domestic market. - '03' # (en) Export revenue exclusively. - '04' # (en) Linked to taxed and non-taxed revenue in the internal market. - '05' # (en) Linked to taxed revenue in the domestic and export market. - '06' # (en) Linked to untaxed revenue in the domestic and export market. - '07' # (en) Linked to taxed and untaxed revenue in the internal market. (pt) - '01' # Vinculada Exclusivamente à Receita Tributada no Mercado Interno. - '02' # Exclusivamente a Receita Não Tributada no Mercado Interno. - '03' # Exclusivamente a Receita de Exportação. - '04' # Vinculada a Receitas Tributadas e Não-Tributadas no Mercado Interno. - '05' # Vinculada a Receitas Tributadas no Mercado Interno e de Exportação. - '06' # Vinculada a Receitas Não-Tributadas no Mercado Interno e de Exportação. - '07' # Vinculada a Receitas Tributadas e Não-Tributadas no Mercado Interno, e de Exportação. ### SpecialProductClass (en) This attribute informs the category of the item type, such as automotive, beverages, etc. (pt) Este atributo informa a categoria do tipo de item, como automotivo, bebidas, etc. ### TpCredPresIBSZFMEnum (en) Classification type according to art. 450, § 1, of LC 214/25 for calculating the presumed credit in the ZFM - '0' # Without Presumed Credit - '1' # Final Consumer Goods (55%) - '2' # Capital Goods (75%) - '3' # Intermediate Goods (90.25%) - '4' # IT Goods and Others Defined by Legislation (100%) (pt) Tipo de classificação de acordo com o art. 450, § 1º, da LC 214/25 para o cálculo do crédito presumido na ZFM - '0' # Sem Crédito Presumido - '1' # Bens de consumo final (55%) - '2' # Bens de capital (75%) - '3' # Bens intermediários (90,25%) - '4' # Bens de informática e outros definidos em legislação (100%) Usage purpose: Calculation/Invoices ### LineBase_properties | Property | Type | Description | |---|---|---| | `name` | string | (en) User-defined property (pt) Propriedade definida pelo usuário | | `value` | string | (en) User-defined content for property (pt) Conteúdo definido pelo usuário para propriedade | ### UseTypeEnum (en) This is an enumeration following the table for the incoming process, the table is # FOR SALES PROCESS - 'use or consumption' - 'resale' - 'agricultural production' - 'production' - 'fixed assets' - 'notApplicable' # FOR OTHER PROCESS - 'notApplicable' (pt) Esta é uma enumeração que segue a tabela. Para o processo de entrada, a tabela é: # PARA PROCESSO DE VENDAS - 'uso ou consumo' - 'revenda' - 'produção agrícola' - 'Produção' - 'ativo permanente' - 'não aplicável' # PARA OUTRO PROCESSO - 'não aplicável' ### LineBase_goods_exportDetails | Property | Type | Description | |---|---|---| | `drawbackNumber` | string | (en) The Suspension Granting Act number must be filled in with 11 digits (AAAANNNNNND) and the Drawback Waiver Granting Act number must be filled in with 9 digits (AANNNNNND). (Note included in NT 2013/005 v. 1.10). (pt) O número do Ato Concessório de Suspensão deve ser preenchido com 11 dígitos (AAAANNNNNND) e o número do Ato Concessório de Drawback Isenção deve ser preenchido com 9 dígitos (AANNNNNND). (Observação incluída na NT 2013/005 v. 1.10) Usage purpose: Invoice | | `indExport` | object | (en) Indirect exportation (pt) Exportação indireta Usage purpose: Invoice | ### LineBase_goods_importDetails | Property | Type | Description | |---|---|---| | `customsValue` | number | (en) Customs value (II Block of the NFe) (pt) Valor aduaneiro (II Bloco da NFe) Usage purpose: Invoice | | `diNumber` | string | (en) Import declaration number, DI/DSI/DA/DRI-E (DI/DSI/DA/DRI-E) (pt) Número da declaração de importação, DI/DSI/DA/DRI-E (DI/DSI/DA/DRI-E) Usage purpose: Invoice | | `registerDateDI` | string | (en) Registered date of import declaration number, Format YYYY-MM-DD (pt) Data registrada do número da declaração de importação, formato AAAA-MM-DD Usage purpose: Invoice | | `clearanceSite` | string | (en) Clerance Site (pt) Local do desembaraço aduaneiro Usage purpose: Invoice | | `clearanceState` | StateEnum | | | `clearanceDate` | string | (en) Clerance date (pt) Data em que ocorreu o desembaraço aduaneiro Usage purpose: Invoice | | `transportDIType` | string | (en) Types of transportation - '1' # Maritime - '2' # Waterway - '3' # Lacustrine - '4' # Air - '5' # Postcard - '6' # Railway - '7' # Highway - '8' # Conduit - '9' # Own Means - '10' # Input / Output - '11' # Courier - '12' # In Hands - '13' # By Trailer (pt) Tipos de transporte - '1' # Marítima - '2' # Fluvial - '3' # Lacustre - '4' # Aerea - '5' # Postal - '6' # Ferroviaria - '7' # Rodoviaria - '8' # Conduto - '9' # Meios Proprios - '10' # Entrada/Saida Ficta - '11' # Correio - '12' # Em Mãos - '13' # Por Reboque Usage purpose: Invoice | | `afrmmValue` | number | (en) Special tax to merchant navy. (pt) Taxa especial para a marinha mercante. Usage purpose: Calculation/Invoice/Do not apply for services | | `intermediateType` | string | (en/pt) - '1' # On One's Own [1-por conta propria] - '2' # On Behalf And Order [2-por conta e ordem] - '3' # Order [3-encomenda] Usage purpose: Invoice | | `buyerFederalTaxID` | string | (en) Buyer federal Tax ID (pt) CNPJ/CPF do comprador ou encomendante Usage purpose: Invoice | | `buyerState` | StateEnum | | | `exporterCode` | string | (en) Exporter code (pt) Código exportador Usage purpose: Invoice | | `adi` | array | (en) Aditional import declaration. (pt) Declaração de importação adicional. Usage purpose: Invoice | ### LineBase_trace (en) The traceability of the product is the operation that seeks to follow the trail of manufacture of this. In this field, information such as lot number and date of manufacture/production of the products will be recorded. It can be said that the traceability of the product will serve to accompany it from its manufacturing or production to its use by the end consumer, registered by the NFCe. This functionality applies mainly to products subject to sanitary regulations, recovery/recall cases, agricultural pesticides, veterinary products, dentistry, medicines, beverages, bottled waters, packaging, etc. (v3). (pt) A rastreabilidade do produto é a operação que busca seguir a trilha de fabricação deste. Neste campo serão registradas informações como número do lote e data de fabricação / produção dos produtos. Pode-se dizer que a rastreabilidade do produto servirá para acompanhá-lo desde a sua fabricação ou produção até a sua utilização pelo consumidor final, cadastrado na NFCe. Esta funcionalidade aplica-se principalmente a produtos sujeitos a regulamentações sanitárias, casos de recuperação / recall, pesticidas agrícolas, produtos veterinários, odontologia, medicamentos, bebidas, águas engarrafadas, embalagens, etc. (v3). Usage purpose: Invoice ### FuelDetails | Property | Type | Description | |---|---|---| | `prodANPCode` | string | | | `descANP` | string | (en) Product Description as ANP. Use the Product Description of the Product Movement Information System - - SIMP (http://www.anp.gov.br/simp/). (pt) Descrição do Produto conforme ANP. Utilizar a descrição de produtos do Sistema de Informações de Movimentação de Produtos - SIMP (http://www.anp.gov.br/simp/). Usage Purpose: Invoice | | `pGLP` | number | (en) Percentage of LPG derived from petroleum in the LPG product. 3 Integers 4 descimal max 100. (pt) Percentual do GLP derivado do petróleo no produto GLP (cProdANP=210203001). Informar em número decimal o percentual do GLP derivado de petróleo no produto GLP. Valores 0 a 100. Usage Purpose: Invoice | | `pGNn` | number | (en) Percentage of national natural gas - GLGNn for LPG product. 3 Intergers 4 descimal max 100. (pt) Percentual de gás natural nacional - GLGNn para o produto GLP (cProdANP=210203001). Informar em número decimal o percentual do Gás Natural Nacional - GLGNn para o produto GLP. Valores de 0 a 100. Usage Purpose: Invoice | | `pGNi` | number | (en) Percentage of imported natural gas GLGNi for the LPG product 3 Intergers 4 descimal max 100. (pt) Percentual de gás natural importado GLGNi para o produto GLP (cProdANP=210203001). Informar em número deciaml o percentual do Gás Natural Importado - GLGNi para o produto GLP. Valores de 0 a 100. Usage Purpose: Invoice | | `vPart` | number | (en) Starting value (cProdANP = 210203001). The amount per kilogram without ICMS must be reported in this field. 13 Integers and 2 decimals. (pt) Valor de partida (cProdANP=210203001). Deve ser informado neste campo o valor por quilograma sem ICMS. Usage Purpose: Invoice | | `authorizationCodeCODIF` | string | (en) Cofid authorization code (pt) Código de autorização do cofid Usage Purpose: Invoice | | `quantityOnRoomTemperature` | number | (en) This decimal 12 Integers and 0 to 4 decimals. Amount of fuel billed at room temperature. Informs when the invoiced quantity entered in the qCom field (I10) has been adjusted to a temperature different than the environment's temperature. (pt) Este decimal 12 inteiros e 0 a 4 decimais. Quantidade de combustível faturada à temperatura ambiente. Informa quando a quantidade faturada informada no campo qCom (I10) tiver sido ajustada para uma temperatura diferente da ambiente. Usage Purpose: Invoice | | `stateCodeOfUndUser` | StateEnum | | | `cide` | object | (en) Percentage of natural gas in quantity (pt) Percentual de gás natural em quantidade Usage Purpose: Invoice | | `pumpNumber` | object | | ### MedicineDetails | Property | Type | Description | |---|---|---| | `cProdANVISA` | string | (en) ANVISA (Brazilian Health Regulatory Agency) Code. Use the product registration number of the CMED (Medicine Market Regulation Chamber). (pt) Código de Produto da ANVISA (Agência Nacional de Vigilância Sanitária). Utilizar o número do registro do produto da Câmara de Regulação do Mercado de Medicamento – CMED. Usage Purpose: Invoice | | `maxValueToEndUser` | number | (en) Maximum price to end user. This is a decimal type with 15 digits including 2 decimal positions. (pt) Preço Máximo ao Consumidor final. Este é um tipo decimal com 15 dígitos incluindo 2 casas decimais. Usage Purpose: Invoice | | `exemptReason` | string | (en) For ANVISA-exempt drug, inform the number of the decision that exempts it, such as the number of the Resolution of the Board of Directors of ANVISA (RDC). (pt) Para medicamento isento de registro na ANVISA, informar o número da decisão que o isenta, como por exemplo o número da Resolução da Diretoria Colegiada da ANVISA (RDC). Usage Purpose: Invoice | ### VehicleDetails | Property | Type | Description | |---|---|---| | `tpOp` | integer | (en) - 1 # Sales by car dealership - 2 # Direct billing - 3 # Direct sales - 0 # Other (pt) - 1 # Vendas por concessionária de automóveis - 2 # Faturamento direto - 3 # Vendas diretas - 0 # outro Usage Purpose: Invoice | | `chassisNumber` | string | (en) Chassi number (pt) Número do Chassi Usage Purpose: Invoice | | `colorCode` | string | (en) Color code used by the factory (pt) Código de cores usado pela fábrica Usage Purpose: Invoice | | `colorName` | string | (en) Color name (pt) Nome da cor Usage Purpose: Invoice | | `cvPower` | string | (en) Power using CV unit (pt) Energia usando unidade CV Usage Purpose: Invoice | | `cylinderVolumCC` | string | (en) Engine size in cubic centimeters (pt) Tamanho do motor em centímetros cúbicos Usage Purpose: Invoice | | `netWeight` | string | (en) Net weight (pt) Peso líquido Usage Purpose: Invoice | | `grossWeight` | string | (en) Gross weight (pt) Peso bruto Usage Purpose: Invoice | | `serialNumber` | string | (en) Serial number (pt) Número de série Usage Purpose: Invoice | | `fuelType` | string | (en)Fuel type - '01' # Alcohol - '02' # Gas - '03' # Diesel - '16' # Alcohol/Gas - '17' # Gas/Alcohol/GNV - '18' # Gas/Electric (pt) Tipo de combustivel - '01' # Álcool - '02' # Gas - '03' # Diesel - '16' # Álcool/Gás - '17' # Gas/Álcool/GNV - '18' # Gás/Elétrico Usage Purpose: Invoice | | `engineNumber` | string | (en) Engine number (pt) Número do motor Usage Purpose: Invoice | | `cmt` | string | (en) Traction capacity, tonne (pt) Capacidade de tração, tonelada Usage Purpose: Invoice | | `lengthBetweenAxis` | string | (en) Length between axis (pt) Comprimento entre o eixo Usage Purpose: Invoice | | `modelYear` | string | (en) Model year (pt) Ano do modelo Usage Purpose: Invoice | | `manufactoryYear` | string | (en) Year of fabrication (pt) Ano de fabricação Usage Purpose: Invoice | | `paintType` | string | (en) Paint type (pt) Tipo da tinta Usage Purpose: Invoice | | `vehicleRENAVAMType` | string | (en) Vehicle renavam type (pt) Tipo do renavan do veiculo Usage Purpose: Invoice | | `specieRENAVAMType` | string | (en) Specie renavam type (pt) Espécie do tipo de renavam Usage Purpose: Invoice | | `modelRENAVAMCode` | string | (en) Renavam code (pt) Código renavam Usage Purpose: Invoice | | `colorDENATRANCode` | string | (en) - '01' # YELLOW - '02' # BLUE - '03' # BEIGE - '04' # WHITE - '05' # GRAY - '06' # GOLDEN - '07' # GRENA - '08' # ORANGE - '09' # BROWN - '10' # SILVER - '11' # BLACK - '12' # PINK - '13' # PURPLE - '14' # GREEN - '15' # RED - '16' # FANTASY (pt) - '01' # AMARELO - '02' # AZUL - '03' # BEGE - '04' # BRANCO - '05' # GREY - '06' # DOURADO - '07' # GRENA - '08' # LARANJA - '09' # MARROM - '10' # PRATA - '11' # PRETO - '12' # ROSA - '13' # ROXO - '14' # VERDE - '15' # VERMELHO - '16' # FANTASIA Usage Purpose: Invoice | | `vin` | string | (en) Chassis condition - original or modified (pt) Condição do chassis - original ou modificado(remarcado) Usage Purpose: Invoice | | `vehicleManufactoryStatus` | string | (en) - '1' # Finished(Done) - '2' # Not finished - '3' # Semi-finished (pt) - '1' # Concluído - '2' # Não concluído - '3' # Semi-acabado Usage Purpose: Invoice | | `maxOccupantsQuantity` | string | (en) Limited occupancy of sit occupants (pt) Ocupação limitada de ocupantes sentados Usage Purpose: Invoice | | `restrictionType` | string | (en) Line/restriction type - '0' # No one; - '1' # Alienação Fiduciária; - '2' # Arrendamento Mercantil; - '3' # Reserva de Domínio; - '4' # Penhor de Veículos; - '9' # Other. (pt) Linha/tipo de restrição - '0' # Ninguém; - '1' # Alienação Fiduciária; - '2' # Arrendamento Mercantil; - '3' # Reserva de Domínio; - '4' # Penhor de Veículos; - '9' # Outro. Usage Purpose: Invoice | ### WeaponDetails | Property | Type | Description | |---|---|---| | `weaponRestrictionType` | string | (en) - '0' # restrict use - '1' # public use (pt) - '0' # uso restrito - '1' # uso público Usage Purpose: Invoice | | `serieNumber` | string | (en) Serial number (pt) Número de serie Usage Purpose: Invoice | | `gunBarrelSerieNumber` | string | (en) Barrel's serial number (pt) Número de série do cano Usage Purpose: Invoice | | `weaponDescription` | string | (en) Weapon description (pt) Descrição da arma Usage Purpose: Invoice | ### IcmsEstimated | Property | Type | Description | |---|---|---| | `creditCode` | string | (en) Estimated Credit Tax Benefit Code used by UF, applied to the item. (pt) Código de Benefício Fiscal de Crédito Presumido utilizado pela UF, aplicado ao item Usage Purpose: Invoice | | `creditRate` | number | (en) Percentage of estimated credit relative to the presumed credit code informed. (pt) Percentual do crédito presumido relativo ao código do crédito presumido informado. Usage Purpose: Invoice | | `creditAmount` | number | (en) Amount of estimated credit relative to the presumed credit code informed. (pt) valor do crédito presumido relativo ao código do crédito presumido informado. Usage Purpose: Invoice | ### ItemObs | Property | Type | Description | |---|---|---| | `obsIcmsTaxPayer` | object | (en) Field for use of Icms Tax Payer. Fill it with name of the field and the free text (pt) Campo de uso livre do Contribuinte para o item da NF-e. Informar o nome do campo no atributo xCampo e o conteúdo do campo no xTexto. | | `obsFisco` | object | (en) Field for use of Government agency. Fill it with name of the field and the free text (pt) Campo de uso livre do Fisco para o item da NF-e. Informar o nome do campo no atributo xCampo e o conteúdo do campo no xTexto. | ### LineReferencedItem (en) Order number, information used for B2B control process (pt) Número do pedido, informações usadas para o processo de controle B2B | Property | Type | Description | |---|---|---| | `documentCode` | string | (en) This string is a code maintained by the client application to uniquely identify a document in the client's systems. It will typically be an invoice number, sales order, receipt number, returned merchandise authorization number, etc. When it has this field, the transaction is stored. (pt) Esta string é um código mantido pelo aplicativo cliente para identificar exclusivamente um documento nos sistemas do cliente. Normalmente será um número de fatura, pedido de venda, número de recibo, número de autorização de devolução de mercadoria, etc. Quando possui este campo, a transação é armazenada. Usage purpose: Calculation/Invoice | | `invoiceAccessKey` | string | (en) Invoice key. This is the public NF id. With this number is possible to get invoice information directly from the government. (pt) Chave da nota fiscal. Este é o ID público da NF. Com este número é possível obter informações da fatura diretamente do governo. Usage purpose: Invoice | | `lineCode` | integer | (en) This line item in the transaction (pt) Número da linha da transação por item Usage Purpose: | Calculation/Invoice | ### HeaderBaseForServices ### LineBaseForServices ### HeaderServicesGroup | Property | Type | Description | |---|---|---| | `competenceDate` | string | (en) Format YYYY-MM-DDTHH:mm:ssZ. The competence date is the day on which the service was provided. This is one of the particularities that vary from prefecture to prefecture. Most prefectures work with the competence date and the date of issue. So, it's important to note that it's possible to send an invoice to the city hall now, but with an earlier competence date — from last month, for example. When municipalities do not work with the competence date, only the date of issue is considered. In some cases, municipal bodies allow the use of the competence date up to 10 days apart from the current date, that is, only within the month itsel (pt) Format YYYY-MM-DDTHH:mm:ssZ. A data de competência é o dia em que o serviço foi prestado. Essa é uma das particularidades que variam de prefeitura para prefeitura. A maioria das prefeituras trabalha com a data de competência e a data de emissão. Então, é importante observar que é possível enviar uma nota fiscal à prefeitura agora, mas com uma data de competência anterior — do mês passado, por exemplo. Quando as prefeituras não trabalham com a data de competência, somente a data de emissão é considerada. Em alguns casos, os órgãos municipais permitem a utilização de data de competência em até 10 dias de diferença com o data atual, ou seja, apenas dentro do próprio mês. | | `purchaseOrderNumber` | string | (en) The number of Purchase Order (pt) O número do pedido de compra Usage purpose: Invoice | | `rpsSubsNumber` | integer | (en) For municipalities which do not allow cancellation, the rps number of the reference of the service invoice that is being replaced must be informed. (pt) Para prefeituras que não permitem cancelamento, deve-se informar o numero da rps de referência da nota de serviço que está sendo substituida. Usage purpose: Invoice | | `rpsSubsSerie` | string | (en) For municipalities which do not allow cancellation, the serie number of the reference of the service invoice that is being replaced must be informed. (pt) Para prefeituras que não permitem cancelamento, deve-se informar o numero de serie da nota referencia de serviço que esta sendo substituída. Usage purpose: Invoice | | `rpsNFSeSubsNumber` | integer | (en) For municipalities which do not allow cancellation, the NFS-E number of the service invoice which is being replaced must be informed. (pt) Para prefeituras que não permitem cancelamento, deve-se informar o número da NFS-E da nota referência de serviço que está sendo substituída. Usage purpose: Invoice | | `rpsNFSeSubsCode` | string | (en) Justification code for NFS-e replacement - '01' # Disqualification of NFS-e from Simples Nacional; - '02' # Qualification of NFS-e under Simples Nacional; - '03' # Retroactive Inclusion of Immunity/Exemption for NFS-e; - '04' # Retroactive Removal of Immunity/Exemption for NFS-e; - '05' # Rejection of NFS-e by the service taker or by the intermediary if responsible for tax collection; - '99' # Other; (pt) Código de justificativa para substituição de NFS-e - '01' # Desenquadramento de NFS-e do Simples Nacional; - '02' # Enquadramento de NFS-e no Simples Nacional; - '03' # Inclusão Retroativa de Imunidade/Isenção para NFS-e; - '04' # Exclusão Retroativa de Imunidade/Isenção para NFS-e; - '05' # Rejeição de NFS-e pelo tomador ou pelo intermediário se responsável pelo recolhimento do tributo; - '99' # Outros; | | `rpsNFSeSubsReason` | string | (en) Justification for NFS-e replacement (pt) Justificativa para substituição de NFS-e | | `rpsNFSeSubsDate` | string | (en) For municipalities which do not allow cancellation, inform the reference nfs-e issue date that will be replaced. (pt) Para prefeituras que não permitem cancelamento, deve-se informar data de emissão da NFS-E referência de serviço que está sendo substituída. Usage purpose: Invoice | | `indPres` | string | (en) Presence indicator on the transaction - '1' # Presential; - '2' # Not Presential; (pt) Indicador de presença na transação - '1' # Presencial; - '2' # Não Presencial Usage purpose: Invoice | | `cMunFGIBS` | integer | (en) IBGE city code of consumption, triggering event for IBS and CBS (pt) Código do Município de consumo, fato gerador do IBS e CBS Usage Purpose: Calculation/Invoice/Do not apply for services | | `publicWayServices` | string | (en) Only for Barueri county. Informs if the service provided was performed in a public highway. (pt) Apenas para o município de barueri. Informa se o serviço prestado foi realizado em via pública. Usage purpose: Invoice | | `specialSituation` | SpecialSituation | | | `culturalPromoter` | boolean | (en) Cultural Promoter, sponsorship of cultural projects, using ISS tax waiver resources (pt) Incentivador Cultural, patrocínio a projetos culturais, utilizando recursos de renúncia fiscal do ISS Usage purpose: Invoice | | `adminProcess` | string | (en) Process number to iss suspended for administrative process. (pt) Número do processo para ISS suspenso em processo administrativo. Usage purpose: Invoice | | `class` | string | (en) Describes the type of this transaction (pt) Natureza da operação Usage purpose: Invoice | | `intTrade` | InternationalServiceTrade | | | `lsadppu` | Lsadppu | | | `build` | Build | | | `eventAtv` | EventAtv | | | `enableCalcICBS` | boolean | (en) Attribute used to enable CBS/IBS calculation, if each Transaction is greater than the Start Date of SEFAZ environments (pt) Atributo usado para habilitar calculo CBS/IBS, caso cada Transação maior que a Data de Inicio dos ambientes do SEFAZ Usage purpose: Calculation | | `refDocuments` | array | (en) Document information group used for deduction/reduction of the calculation base value (service value) (pt) Grupo de informações de documento utilizado para dedução/redução do valor da base de cálculo (valor do serviço) | | `indOp` | string | (en) Supply operation indicator, referring to the "código indicador de operação" table. (pt) Indicador da operação de fornecimento, referente a tabela "código indicador de operação" | | `govProcurement` | object | (en) Government Procurement Group (pt) Grupo de Compras Governamentais | ### LocationForServices (en) List of transaction participants, Seller, Buyer, Carrier (pt) Lista de participantes da transação, vendedor, comprador, operadora | Property | Type | Description | |---|---|---| | `entity` | EntityFullDataForServices | | | `establishment` | EntityFullDataForServices | | | `recipient` | EntityFullDataForServices | | | `rendered` | EntityFullDataForServices | | | `intermediary` | EntityFullDataForServices | | | `propertySite` | EntityAddrData | | | `eventSite` | EntityAddrData | | ### HeaderPaymentForServices | Property | Type | Description | |---|---|---| | `upfrontPayment` | boolean | (en) Up front payment indicator, used in messaging for the São Paulo municipal e-invoice (NFS-e) standard. (pt) Indicador de pagametno antecipado, usado em mensageria para padrão da NFS Paulistana | | `installmentTerms` | PaymentTerms | | | `bill` | PaymentBill | | | `withholdingMode` | WithholdingMode | | | `installment` | array | (en) Installments/payment type (pt) Tipos de pagamentos Usage purpose: Invoice | | `paymentInfo` | object | | ### AdditionalInformationForServices | Property | Type | Description | |---|---|---| | `complementaryInfo` | string | (en) Additional information of user interest (pt) Informação adicional de interesse do usuário | | `otherInfo` | string | (en) Any additional information to print on the service invoice (pt) Qualquer informação adicional para imprimir na fatura de serviço | | `tpAto` | string | (en) When indProc is 0, is mandatory this information (indProc=0). (pt) Para origem do Processo na SEFAZ (indProc=0), informar o tipo de ato concessório: - '08' # Termo de Acordo; - '10' # Regime Especial; - '12' # Autorização específica; Usage purpose: Invoice | | `idDocTec` | string | (en) Technical Responsibility Document Identifier: ART, RRT, DRT, Others. (pt) Identificador de Documento de Responsabilidade Técnica: ART, RRT, DRT, Outros. | | `docRef` | string | (en) Invoice key, invoice identification number, contract number or other document identifier issued by the service provider, which supports the issuance of this invoice by the service recipient or intermediary (mandatory field if the invoice is being issued by the Service Recipient or intermediary). (pt) Chave da nota, número identificador da nota, número do contrato ou outro identificador de documento emitido pelo prestador de serviços, que subsidia a emissão dessa nota pelo tomador do serviço ou intermediário (preenchimento obrigatório caso a nota esteja sendo emitida pelo Tomador ou intermediário do serviço). | | `orderNumber` | string | (en) Number of the purchase order, service order, or project that authorizes the provision of the service in B2B operations. This information is relevant to the service recipient for negotiation control and management. (pt) xPed, Número do pedido/ordem de compra ou ordem de serviço ou projeto que autorize a prestação do serviço em operações B2B - Informação de interesse do tomador do serviço para controle e gestão da Negociação | | `orderItems` | string | (en) Group of items within the purchase order, service order, or project (pt) gItemPed, Grupo de itens do pedido ou ordem de compra ou ordem de serviço ou projeto. | | `orderItemNumber` | string | (en) Item number within the purchase order, service order, or project — identifies the specific item referenced in orderNumber (pt) xItemPed, Número do item do pedido ou ordem de compra ou ordem de serviço ou projeto - Identificação do número do item do pedido ou ordem de compra destacado e xPed | ### payment | Property | Type | Description | |---|---|---| | `upfrontPayment` | boolean | (en) Up front payment indicator, used in messaging for the São Paulo municipal e-invoice (NFS-e) standard. (pt) Indicador de pagametno antecipado, usado em mensageria para padrão da NFS Paulistana | | `installmentTerms` | PaymentTerms | | | `bill` | PaymentBill | | | `withholdingMode` | WithholdingMode | | | `installment` | array | (en) Installments/payment type (pt) Tipos de pagamentos Usage purpose: Invoice | | `paymentInfo` | object | | ### SpecialSituation (en) - '1' # SUS - '2' # Executive Branch - '3' # Banks - '4' # Trade/Industry - '5' # Legislative/Judiciary - '0' # Other (pt) - '1' # SUS - '2' # Órgão do Poder Executivo - '3' # Bancos - '4' # Comércio/Indústria - '5' # Poder Legislativo/Judiciário - '0' # Outro ### InternationalServiceTrade (en) comExt – Data group related to service export/import operations (pt) comExt - Grupo de informações relativas à exportação/importação do serviço prestado Usage purpose: Invoice | Property | Type | Description | |---|---|---| | `serviceMode` | string | (en) Service mode - '0' # Unknown (type not specified in the invoice) - '1' # Cross-border - '2' # Consumption in Brazil - '3' # Commercial Presence Abroad - '4' # Temporary Movement of Natural Persons (pt) Modo de Prestação: - '0' # Desconhecido (tipo não informado na nota) - '1' # Transfronteiriço; - '2' # Consumo no Brasil; - '3' # Presença Comercial no Exterior; - '4' # Movimento Temporário de Pessoas Físicas; Usage purpose: Invoice | | `businessRelationship` | string | (en) Item Description - '0' # No relationship with the service provider/recipient - '1' # Subsidiary - '2' # Parent company - '3' # Affiliate - '4' # Headquarters - '5' # Branch or subsidiary - '6' # Other relationship (pt) Descrição do item - '0' # Sem vínculo com o tomador/ Prestado - '1' # Controlada - '2' # Controladora - '3' # Coligada - '4' # Matriz - '5' # Filial ou sucursal - '6' # Outro vínculo Usage purpose: Invoice | | `currencyCode` | string | (en) Currency of the trade transaction. (pt) Moeda da transação comercial. Usage purpose: Invoice | | `amountInCurrencyCode` | number | (en) Value of service provided expressed in foreign currency specified in: currencyCode. (pt) Valor do serviço prestado expresso em moeda estrangeira especificada em: currencyCode. Usage purpose: Invoice | | `mecAFComexP` | string | (en) Support/incentive mechanism for Foreign Trade used by the service provider: - '00' # Unknown (type not specified in the original invoice) - '01' # None - '02' # ACC – Advance on Exchange Contract – IR and IOF Tax Reduction to Zero - '03' # ACE – Advance on Delivered Exchange – IR and IOF Tax Reduction to Zero - '04' # BNDES-Exim Post-Shipment – Services - '05' # BNDES-Exim Pre-Shipment – Services - '06' # FGE – Export Guarantee Fund - '07' # PROEX – Interest Equalization - '08' # PROEX – Financing (pt) Mecanismo de apoio/fomento ao Comércio Exterior utilizado pelo prestador do serviço: - '00' # Unknown (type not specified in the original invoice) - '01' # None - '02' # ACC – Advance on Exchange Contract – IR and IOF Tax Reduction to Zero - '03' # ACE – Advance on Delivered Exchange – IR and IOF Tax Reduction to Zero - '04' # BNDES-Exim Post-Shipment – Services - '05' # BNDES-Exim Pre-Shipment – Services - '06' # FGE – Export Guarantee Fund - '07' # PROEX – Interest Equalization - '08' # PROEX – Financing Usage purpose: Invoice | | `mecAFComexT` | string | (en) Support/incentive mechanism for Foreign Trade used by the service recipient: - '00' # Unknown (type not specified in the original invoice) - '01' # None - '02' # Public Administration and International Representation - '03' # Rental and Leasing of Machinery, Equipment, Vessels, and Aircraft - '04' # Aircraft Leasing for Public Air Transport Companies - '05' # Commission to Foreign Agents for Export Operations - '06' # Storage, Handling, and Cargo Transportation Expenses Abroad - '07' # FIFA Events (subsidiary) - '08' # FIFA Events - '09' # Freight, Vessel or Aircraft Leasing, and Others - '10' # Aeronautical Material - '11' # Promotion of Goods Abroad - '12' # Promotion of Brazilian Tourist Destinations - '13' # Promotion of Brazil Abroad - '14' # Promotion of Services Abroad - '15' # RECINE (Special Tax Regime for the Cinema Industry) - '16' # RECOPA (Special Tax Regime for 2014 World Cup Infrastructure) - '17' # Registration and Maintenance of Trademarks, Patents, and Plant Varieties - '18' # REICOMP (Special Tax Regime for Computing Industry) - '19' # REIDI (Special Tax Regime for Infrastructure Development) - '20' # REPENEC (Special Regime for Oil, Natural Gas, and Mining Industries) - '21' # REPES (Special Regime for Export-Oriented Software Services) - '22' # RETAERO (Special Regime for the Aeronautics Industry) - '23' # RETID (Special Regime for the Semiconductor Industry) - '24' # Royalties, Technical, Scientific Assistance, and Related Services - '25' # Conformity Assessment Services under WTO Agreements - '26' # ZPE (Export Processing Zone) (pt) Mecanismo de apoio/fomento ao Comércio Exterior utilizado pelo tomador do serviço: - '00' # Desconhecido (tipo não informado na nota de origem); - '01' # Nenhum; - '02' # Adm. Pública e Repr. Internacional; - '03' # Alugueis e Arrend. Mercantil de maquinas, equip., embarc. e aeronaves; - '04' # Arrendamento Mercantil de aeronave para empresa de transporte aéreo público; - '05' # Comissão a agentes externos na exportação; - '06' # Despesas de armazenagem, mov. e transporte de carga no exterior; - '07' # Eventos FIFA (subsidiária); - '08' # Eventos FIFA; - '09' # Fretes, arrendamentos de embarcações ou aeronaves e outros; - '10' # Material Aeronáutico; - '11' # Promoção de Bens no Exterior; - '12' # Promoção de Dest. Turísticos Brasileiros; - '13' # Promoção do Brasil no Exterior; - '14' # Promoção Serviços no Exterior; - '15' # RECINE; - '16' # RECOPA; - '17' # Registro e Manutenção de marcas, patentes e cultivares; - '18' # REICOMP; - '19' # REIDI; - '20' # REPENEC; - '21' # REPES; - '22' # RETAERO; - '23' # RETID; - '24' # Royalties, Assistência Técnica, Científica e Assemelhados; - '25' # Serviços de avaliação da conformidade vinculados aos Acordos da OMC; - '26' # ZPE; Usage purpose: Invoice | | `tempMoveGoods` | string | (en) Link between the Operation and the Temporary Movement of Goods: - '0' # Unknown (type not specified in the original invoice) - '1' # No - '2' # Linked – Import Declaration - '3' # Linked – Export Declaration (pt) Vínculo da Operação à Movimentação Temporária de Bens: - '0' # Desconhecido (tipo não informado na nota de origem); - '1' # Não; - '2' # Vinculada - Declaração de Importação; - '3' # Vinculada - Declaração de Exportação; Usage purpose: Invoice | | `nDI` | string | (en) Import Declaration Number (DI/DSI/DA/DRI-E) endorsed. (pt) Número da Declaração de Importação (DI/DSI/DA/DRI-E) averbado. Usage purpose: Invoice | | `nRE` | string | (en) Export Registration Number (RE) endorsed. (pt) Número do Registro de Exportação (RE) averbado. | | `mdic` | string | (en) Indicator of whether the NFS-e should be made available to the MDIC. - '0' # Do not send to MDIC; - '1' # Send to MDIC; (pt) Indicador se a NFS-e deverá ser disponibilizada ao MDIC. - '0' # Não enviar para o MDIC; - '1' # Enviar para o MDIC; | ### Lsadppu | Property | Type | Description | |---|---|---| | `categ` | string | (en) Service Categories - '1' # Lease - '2' # Sublease - '3' # Leasing - '4' # Right of Way - '5' # Usage Permission (pt) Categorias do serviço - '1' # Locação; - '2' # sublocação; - '3' # arrendamento; - '4' # direito de passagem; - '5' # permissão de uso; Usage purpose: Invoice | | `object` | string | (en) Type of objects of lease, sublease, lease, right of way or permission to use: - '1' # Railway - '2' # Highway - '3' # Poles - '4' # Cables - '5' # Pipelines - '6' # Other relationship (pt) Tipo de objetos da locação, sublocação, arrendamento, direito de passagem ou permissão de uso: - '1' # Ferrovia - '2' # Rodovia - '3' # Postes - '4' # Cabos - '5' # Dutos Usage purpose: Invoice | | `totalLength` | integer | (en) Total length of railway, highway, cables, pipelines and conduits. (pt) Extensão total da ferrovia, rodovia, cabos, dutos ou condutos. Usage purpose: Invoice | | `nPoles` | integer | (en) Poles quantity (pt) Número total de postes. Usage purpose: Invoice | ### Build | Property | Type | Description | |---|---|---| | `cCIB` | string | (en) Property registration. Mandatory for civil construction. (pt) Cadastro de imóveis. Obrigatório para construção civil. Usage purpose: Invoice | | `code` | string | (en) Business code (pt) Código da OBRA Usage purpose: Invoice | | `art` | string | (en) Technical note. Technical liability note-ART, estabelece que todos os contratos referentes à execu\u00e7\u00e3o de servi\u00e7os ou obras de Engenharia, Agronomia, Geologia, Geografia ou Meteorologia dever\u00e3o ser objeto de anota\u00e7\u00e3o no Conselho Regional de Engenharia e Agronomia. (pt) Nota técnica. Anotação de responsabilidade técnica - ART, estabelece que todos os contratos referentes à execu\u00e7\u00e3o de servi\u00e7os ou obras de Engenharia, Agronomia, Geologia, Geografia ou Meteorologia dever\u00e3o ser objeto de anota\u00e7\u00e3o no Conselho Regional de Engenharia e Agronomia Usage purpose: Invoice | | `cei` | string | (en) CEI Work identification number. National Works Registry (CNO) or INSS Specific Registry (CEI). (pt) CEI Número de identificação da obra. Cadastro Nacional de Obras (CNO) ou Cadastro Específico do INSS (CEI). Usage purpose: Invoice | | `number` | string | (en) Work Registration Number, Tax Property Registration, (code provided by the City Hall to identify the work or for IPTU collection purposes) (pt) Número de Matrícula da Obra, Inscrição imobiliária fiscal, (código fornecido pela Prefeitura Municipal para a identificação da obra ou para fins de recolhimento do IPTU) | | `encapsulationNumber` | string | (en) Encapsulation number of deductibles invoices (pt) Código do encapsulamento de notas dedutoras | ### EventAtv | Property | Type | Description | |---|---|---| | `name` | string | (en) Name of the event Artistic, Cultural, Sporting, ... (pt) Nome do evento Artístico, Cultural, Esportivo, ... Usage purpose: Invoice | | `startDate` | string | (en) Start date of th event activities (pt) Data de início da atividade de evento. Usage purpose: Invoice | | `endDate` | string | (en) End date of the event activities (pt) Data de fim da atividade de evento. Usage purpose: Invoice | | `idAtvEv` | string | (en) Event Activity Identification. Event identification code determined by the Municipal Tax Administration (pt) Identificação da Atividade de Evento. Código identificador de evento determinado pela Administração Tributária Municipal Usage purpose: Invoice | ### RefDocument | Property | Type | Description | |---|---|---| | `docType` | string | (en) Referenced Invoices. The invoice can be one of these types: - 'refNFe' # NF-e access code - 'refNSFe' # NFS-e access key (national standard) - 'NFSeMun' # Municipal electronic invoice issued outside the national standard - 'NFNFS' # NF or NFS information group (non-electronic model) (pt) Notas Fiscais Referenciadas. A NF pode ser um destes tipos: - 'refNFe' # Chave de acesso da NF-e - 'refNSFe' # Chave de acesso da NFS-e (padrão nacional) - 'NFSeMun' # Nota eletrônica municipal emitida fora do padrão nacional - 'NFNFS' # Grupo de informações de NF ou NFS Modelo não eletrônico) | | `dfe` | object | | | `nfseMun` | object | | | `nfnfs` | object | | | `nDocFisc` | string | (en) Tax document identifier different from the others in the group. (pt) Identificador de documento fiscal diferente dos demais do grupo. Usage purpose: Invoice | | `nDoc` | string | (en) Non-tax document identifier different from the others in the group. (pt) Identificador de documento não fiscal diferente dos demais do grupo. Usage purpose: Invoice | | `tpDedRed` | string | (en) Type of Deduction/Reduction - '01' # Food and beverages/minibar; - '02' # Materials; - '03' # External production; - '04' # Reimbursement of expenses; - '05' # Consortium transfer; - '06' # Health plan transfer; - '07' # Services; - '08' # Subcontracting of labor; - '99' # Other deductions; (pt) Tipo da Dedução/Redução - '01' # Alimentação e bebidas/frigobar; - '02' # Materiais; - '03' # Produção externa; - '04' # Reembolso de despesas; - '05' # Repasse consorciado; - '06' # Repasse plano de saúde; - '07' # Serviços; - '08' # Subempreitada de mão de obra; - '99' # Outras deduções; Usage purpose: Calculation/Invoice | | `xDescOutDed` | string | (en) Description of Deduction/Reduction when the option is "99 – Other Deductions". (pt) Descrição da Dedução/Redução quando a opção é "99 – Outras Deduções". Usage purpose: Invoice | | `dtEmiDoc` | string | (en) Date of issuance of the deductible document. Year, month and day (YYYY-MM-DD) (pt) Data da emissão do documento dedutível. Ano, mês e dia (AAAA-MM-DD) | | `dtAcrualDoc` | string | (en) Accrual date of the deductible document. Year, month and day (YYYY-MM-DD) (pt) Data da competência do documento dedutível. Ano, mês e dia (AAAA-MM-DD) | | `vDeductibleReducible` | number | (en) Total deductible/reducible monetary value in the document provided (R$). This is the total amount in the document provided that is subject to deduction/reduction. (pt) Valor monetário total dedutível/redutível no documento informado (R$). Este é o valor total no documento informado que é passível de dedução/redução. | | `vDeductionReduction` | number | (en) Monetary value used to deduct/reduce the value of the NFS-e service being issued (R$). Must be less than or equal to the deductible/reducible value (vDeductibleReducible). (pt) Valor monetário utilizado para dedução/redução do valor do serviço da NFS-e que está sendo emitida (R$). Deve ser menor ou igual ao valor deduzível/redutível (vDeductibleReducible). | | `vendor` | Vendor | | ### Vendor ### EntityAddrData | Property | Type | Description | |---|---|---| | `address` | AddressInfo | | ### EntityFullDataForServices ### TaxesSettingsForServices | Property | Type | Description | |---|---|---| | `taxReformInterDependentModel` | boolean | (en) Informs if the entity is CBS and IBS tax payer (pt) Informa se CBS e IBS compõe base de cálculo de ICMS OU ISS Usage Purpose: | Calculation/Invoice | | `notCbsIbsTaxPayer` | boolean | (en) Informs if the entity is CBS and IBS tax payer (pt) Informa se a entidade é contribuinte do CBS e IBS Usage Purpose: | Calculation/Invoice | | `applyCashback` | boolean | (en) Informs that cashback is applicable (pt) Informa que cashback é aplicavel á entidade Usage Purpose: | Calculation/Invoice | | `subjectToPayrollTaxRelief` | boolean | (en) Subject to payroll exemption. (pt) Sujeito à desoneração de folha de pagamento. Usage purpose: Calculation | | `pisCofinsISSTaxReliefOut` | boolean | (en) Exempts the ISS tax amount from the pis/cofins calc base. Does not apply to the PIS/COFINS credit amount (pt) Reduz o valor do ISS da base de cálculo do pis / cofins, nao afetando creditos de nas entradas Usage purpose: Calculation | | `pisFopag` | boolean | (en) PIS on Payroll. (pt) O PIS sobre a folha de pagamento. Usage Purpose: | Calculation | | `cofinsSubjectTo` | string | (en) There are cases where both seller, buyer, and items are taxable but a special situation forces the transaction to be exempt especially for PIS and COFINS. This attribute allows users to identify such scenarios and trigger the exemption despite all other settings. - 'T' # TAXABLE - 'N' # NOT TAXABLE - 'Z' # TAXABLE WITH RATE=0.00 - 'E' # EXEMPT - 'H' # SUSPENDED (pt) Há casos em que o vendedor, o comprador e os itens são tributáveis, mas uma situação especial obriga a operação a ser isenta especialmente de PIS e COFINS. Esse atributo permite que os usuários identifiquem esses cenários e acionem a isenção apesar de todas as outras configurações. - 'T' # TAXÁVEL - 'N' # NÃO TAXÁVEL - 'Z' # TRIBUTÁVEL COM TAXA = 0,00 - 'E' # ISENTO - 'H' # SUSPENSO Usage Purpose: Calculation | | `csllSubjectTo` | string | (en) There are cases where both seller, buyer, and items are taxable but a special situation forces the transaction to be CSLL exempt. This attribute allows users to identify such scenarios and trigger the exemption despite all other settings. - T TAXABLE - E EXEMPT (pt) Há casos em que o vendedor, o comprador e os itens são tributáveis, mas uma situação especial obriga a transação a ser isenta de CSLL. Esse atributo permite que os usuários identifiquem esses cenários e acionem a isenção apesar de todas as outras configurações. - T TAXÁVEL - E ISENTO Usage Purpose: Calculation | | `pisSubjectTo` | string | (en) There are cases where both seller, buyer, and items are taxable but a special situation forces the transaction to be exempt especially for PIS and COFINS. This attribute allows users to identify such scenarios and trigger the exemption despite all other settings. - 'T' # TAXABLE - 'N' # NOT TAXABLE - 'Z' # TAXABLE WITH RATE=0.00 - 'E' # EXEMPT - 'H' # SUSPENDED (pt) Há casos em que tanto o vendedor quanto o comprador e os itens são tributados, mas uma situação especial obriga a operação a ser isenta especialmente de PIS e COFINS. Esse atributo permite que os usuários identifiquem esses cenários e acionem a isenção apesar de todas as outras configurações. - 'T' # TAXÁVEL - 'N' # NÃO TAXÁVEL - 'Z' # TRIBUTÁVEL COM TAXA = 0,00 - 'E' # ISENTO - 'H' # SUSPENSO Usage Purpose: Calculation | | `receiptsAreFullNoCumulativePisCofins` | boolean | (en) Purchase on Free Zones, PIS/COFINS non cumulative rate. (pt) Compras na ZFM, PIS/COFINS com alícota específica. Usage Purpose: Calculation | | `issRfRateForSimplesTaxRegime` | number | (en) When the seller is in the Simples Nacional Regime, the seller needs to send an RF rate. (pt) Quando o vendedor está em regime do Simples Nacional, o vendedor precisa enviar a alíquota. Usage purpose: Calculation/Invoice | | `pCredCBSSN` | number | (en) CBS rate for company that is tax regime simplified. (pt) Alíquota de CBS caso a empresa seja optante do simples. Usage purpose: Calculation/Invoice | | `pCredIBSSN` | number | (en) IBS rate for company that is tax regime simplified. (pt) Alíquota de IBS caso a empresa seja optante do simples. Usage purpose: Calculation/Invoice | | `enableCprb` | boolean | (en) Informs if enables Calculation of INSS CPRB. (pt) Informa se habilita Cálculo do INSS CPRB. Usage purpose: Calculation | | `usesInssCprbToGrossValue` | boolean | (en) Uses the INSS CPRB to calc gross value when amountCalcType=net. (pt) Considera o INSS CPRB no cálculo do valor bruto para amountCalcType=net. Usage purpose: Calculation | | `notWithHoldIRForPublicAgency` | boolean | (en) Payments from federal Public Agency are subject to Withholding, with some exceptions like SESC, SENAI, - IR. (pt) Pagamentos de Órgão Público Federal estão sujeitos a Retenção na Fonte, com algumas exceções como SESC, SENAI, - IR. | | `pisCofinsWhISSTaxRelief` | boolean | (en) Exempts the ISS tax amount from the pis-rf/cofins-rf calc base. Does not apply to the PIS/COFINS credit amount (pt) Reduz o valor do ISS da base de cálculo do pis-rf / cofins-rf, nao afetando créditos nas entradas. Usage purpose: Calculation | | `roundingServiceByItem` | number | (en) Tax amount rounding by service item - 2 ROUNDING OF DECIMAL PLACES TO TWO DECIMAL PLACES - 4 ROUNDING OF DECIMAL PLACES TO FOUR DECIMAL PLACES (pt) Arredondamento do valor do imposto por item de serviço - 2 ARREDONDAMENTO DE CASAS DECIMAIS PARA DUAS CASAS DECIMAIS - 4 ARREDONDAMENTO DE CASAS DECIMAIS PARA QUATRO CASAS DECIMAIS Usage Purpose: Calculation/Invoice | | `roundingModeForServices` | string | (en) Método de arredondamento - 'A' # Norma ABNT - 'C' # Round up (ceiling) - 'F' # Round down (floor) (pt) Método de arredondamento - 'A' # Norma ABNT - 'C' # Arredondamento para cima (teto) - 'F' # Arredondamento para baixo (base) Usage Purpose: Calculation/Invoice | | `nationalNFSe` | boolean | (en) Indicates that the company is based in a city whose issuer complies with the national NFS-e standard. (pt) Indica que empresa está em cidade com emissor seguindo ao padrão nacional da NFS-e Invoice | ### SpecialCityTaxRegime (en) - '1' # Municipal Microenterprise - '2' # Estimate - '3' # Professional Partnership - '4' # Cooperative - '5' # Individual Microentrepreneur (MEI) - '6' # Microenterprise and Small Business (ME EPP) - '7' # Opting for the Simples Nacional regime (Exclusive to Elotech and GLC Consultoria 2.0) - '8' # Standard Taxation (Exclusive to E&L) - '9' # Self-Employed (Exclusive to E&L) - '10' # Variable (Exclusive to GLC Consultoria 2.0) - '11' # Actual Profit (Exclusive to Digifred) - '12' # Presumed Profit (Exclusive to Digifred) - '13' # Professional Partnership as Legal Entity (Exclusive to SEMFAZ) - '14' # No (Exclusive to NF-Eletrônica) - '15' # Summary Invoices (Exclusive to NF-Eletrônica) - '16' # Registered in PRODEVAL (Exclusive to NF-Eletrônica) (pt) - '1' # Microempresa municipal - '2' # Estimativa - '3' # Sociedade de profissionais - '4' # Cooperativa - '5' # Microempresário Individual (MEI) - '6' # Microempresário e Empresa de Pequeno Porte (ME EPP) - '7' # Optante pelo Simples Nacional (Exclusivo Elotech e GLC Consultoria 2.0) - '8' # Tributação Normal (Exclusivo E&L) - '9' # Autônomo (Exclusivo E&L) - '10' # Variável (Exclusivo GLC Consultoria 2.0) - '11' # Lucro Real (Exclusivo Digifred) - '12' # Lucro Presumido (Exclusivo Digifred) - '13' # Sociedade de Profissionais Pessoa Jurídica (Exclusivo SEMFAZ) - '14' # Não (Exclusivo NF-Eletrônica) - '15' # Notas Totalizadoras (Exclusivo NF-Eletrônica) - '16' # Inscrito no PRODEVAL (Exclusivo NF-Eletrônica) ### ItemDescriptorForServices | Property | Type | Description | |---|---|---| | `description` | string | (en) Item Description (pt) Descrição do item | | `legalReference` | string | (en) Legal Reference/Detail (pt) Referência Legal/Detalhe | | `taxCode` | string | (en) Auxiliary code for determination and legal citation of the item. (pt) Código auxiliar para determinação e fundamentação legal do item. Usage purpose: Calculation/Invoice | | `hsCode` | string | (en) (HC) Harmonized code for goods or NBS code for services. (pt) Código NCM ou código de serviço de acordo com a NBS. Usage purpose: Calculation/Invoice | | `lc116Code` | string | (en) (HC) Harmonized code for goods or LC116 code for services. (pt) Código NCM ou código de serviço de acordo com a LC116. Usage purpose: Calculation/Invoice | | `subjectToIRRFAuto` | boolean | (en) The service taker is responsible for paying the service at the gross amount, that is, without any deduction of tax withheld, thus characterizing a hypothesis of "self-withholding". In this case, amounts paid directly or transferred to radio and television companies, newspapers and magazines, attributed to the paying legal entity and to the beneficiary joint and several liability for proof of the effective performance of the services (Law No. 7,450, 1985 , article 53, sole paragraph). (pt) Na contratação do serviço de propaganda e publicidade não haverá por parte do tomador do serviço (anunciante) nenhum recolhimento a ser efetuado, pois o recolhimento do IRRF cabe ao próprio prestador do serviço (Agência), cabendo ao anunciante o pagamento do serviço pelo valor bruto, ou seja, sem nenhum desconto de tributo retido, caracterizando, assim, uma hipótese de “autoretenção”. Neste caso excluem-se da base de cálculo as importâncias pagas diretamente ou repassadas a empresas de rádio e televisão, jornais e revistas, atribuída à pessoa jurídica pagadora e à beneficiária responsabilidade solidária pela comprovação da efetiva realização dos serviços (Lei nº 7.450, de 1985, art. 53, parágrafo único). | | `piscofinsRevenueType` | PisCofinsRevenueType | | | `serviceCode` | string | (en) City service code where the service will be executed. (pt) Código de serviço da cidade onde o serviço será executado. Usage purpose: Calculation/Invoice | | `serviceCodeOrigin` | string | (en) City service code where the provider is registered. When this information isn't available the rates for ISS are zero. (pt) Código de serviço da cidade onde o prestador está registrado. Quando essa informação não está disponível, as taxas de ISS são zero. Usage purpose: Calculation/Invoice | | `withLaborAssignment` | boolean | (en) Service with labor assignment (pt) Serviço com atribuição de mão de obra Usage purpose: Calculation | | `notSubjectToInssWhenPerson` | boolean | (en) Do not calculate the INSS when emitter is a person (pt) Força o sistema a não calcular o INSS quando o emitente for Pessoa Física | | `issBehavior` | IssBehaviorEnum | | | `issTaxableIndicator` | string | (en) Indicative of presence of iss or issRf tax amount. (pt) Indicativo da presença de valor de imposto iss ou issRf | | `cnae` | string | (en) Subclass CNAE (pt) Subclasse CNAE | | `glAccountCode` | string | (en) GL accounting code (pt) Código da conta contábil Usage purpose: Calculation/Invoice | | `appropriatePISCOFINScredit` | boolean | (en) Subject to appropriate PIS/COFINS credit, when NO CUMULATIVE (pt) Sujeito ao devido crédito de PIS/COFINS, quando NÃO CUMULATIVO Usage purpose: Calculation | | `appropriateCBSIBScreditWhenInBound` | boolean | (en) Informs that this item will have rights to appropriate CBS and IBS credit (pt) Informa que este item terá direito ao crédito de CBS and IBS | | `isPisCofinsEstimatedCredit` | boolean | (en) The credit PIS/COFINS is subject to purchase form companies, but exist some exceptions, when the credit will be a estimated amount # see http://www.portaltributario.com.br/artigos/credito-presumido-pis-cofins-origem-animal.htm. (pt) O crédito do PIS/COFINS está sujeito à forma de compra das empresas, mas existem algumas exceções, quando o crédito será em valor estimado # ver http://www.portaltributario.com.br/artigos/credito-presumido-pis-cofins-origem -animal.htm. Usage purpose: Calculation | | `thresholdBehavior` | ThresholdBehaviorEnum | | ### LineServicesGroup | Property | Type | Description | |---|---|---| | `issDueAtDestination` | boolean | (en) For service items with City Jurisdiction, inform where the ISS tax is due (pt) Para itens de serviço com Foro Municipal informar onde é devido o ISS Usage purpose: Invoice | | `withLaborAssignment` | boolean | (en) Service with labor assignment (pt) Serviço com atribuição de mão de obra Usage purpose: Calculation | | `hasCpom` | boolean | (en) Informs if the provider has cepom (pt) Informa se o prestador tem cepom Usage purpose: Calculation | ### IssBehaviorEnum (en) Options: - 'normal' # the system follow the context rules - 'forcedWithholding' # it forces the withholding of ISS - 'forcedNoWithholding' # it forces the no withholding of ISS - 'exempt' # Linked to Taxed and Non-Taxed Revenue in the internal Market (pt) Opções: - 'normal' # o sistema segue as regras de contexto -'forceWithholding '# força a retenção de ISS -'forceNoWithholding '# força a não retenção de ISS - 'isento' # Vinculada a Receitas Tributadas e Não-Tributadas no Mercado Interno ### ThresholdBehaviorEnum (en) Options: - 'normal' # Avatax will use threshold of R$10,00 to decide whether or not there is withholding - 'noCsrf' # Avatax will use threshold of R$10,00 to decide whether or not there is withholding other than CSRF (PCC) - 'noInss' # Avatax will use threshold of R$10,00 to decide whether or not there is withholding other than INSS - 'noIrrf' # Avatax will use threshold of R$10,00 to decide whether or not there is withholding other than IRRF - 'noCsrfInss' # Avatax will use threshold of R$10,00 to decide whether or not there is withholding other than CSRF and INSS - 'noCsrfIrrf' # Avatax will use threshold of R$10,00 to decide whether or not there is withholding other than CSRF and IRRF - 'noInssIrrf' # Avatax will use threshold of R$10,00 to decide whether or not there is withholding other than INSS and IRRF - 'noThreshold' # Avatax will not use threshold of R$10,00 (pt) Opções: - 'normal' # Avatax usará limite de R$ 10,00 para decidir se há ou não retenção - 'noCsrf' # Avatax usará limite de R$ 10,00 para decidir se há ou não retenção exceto CSRF (PCC) - 'noInss' # Avatax usará limite de R$ 10,00 para decidir se há ou não retenção exceto INSS - 'noIrrf' # Avatax usará limite de R$ 10,00 para decidir se há ou não retenção exceto IRRF - 'noCsrfInss' # Avatax usará limite de R$ 10,00 para decidir se há ou não retenção exceto CSRF and INSS - 'noCsrfIrrf' # Avatax usará limite de R$ 10,00 para decidir se há ou não retenção exceto CSRF and IRRF - 'noInssIrrf' # Avatax usará limite de R$ 10,00 para decidir se há ou não retenção exceto INSS and IRRF - 'noThreshold' # Avatax não usará limite de R$ 10,00 para decidir se há ou não retenção ### TransactionFullForGoods | Property | Type | Description | |---|---|---| | `header` | HeaderFullForGoods | | | `lines` | array | | | `summary` | SummaryForGoods | | | `processingInfo` | ProcessingInfo | | | `version` | string | (en) Payload Model Version (pt) Versão modelo do payload | ### TransactionFullForServices | Property | Type | Description | |---|---|---| | `header` | HeaderFullForServices | | | `lines` | array | | | `summary` | SummaryForServices | | | `processingInfo` | ProcessingInfo | | | `version` | string | (en) Payload Model Version (pt) Versão modelo do payload | ### HeaderFullForGoods ### LineFullForGoods ### SummaryForGoods | Property | Type | Description | |---|---|---| | `numberOfLines` | integer | (en) Count of lines (pt) Contagem de linhas Usage purpose: Calculation/Invoice | | `totalLineAmounts` | number | | | `totalTaxedDiscounts` | number | | | `totalUntaxedDiscounts` | number | | | `totalInsurances` | number | | | `totalFreights` | number | | | `totalOtherCosts` | number | | | `totalUnTaxedOtherCosts` | number | | | `totalInvoice` | number | (en) Total Invoice, used only for Invoice SEFAZ. (pt) Fatura Total, utilizada apenas para Fatura SEFAZ. | | `totalInvoiceIbsCbsIs` | number | (en) Total Invoice, used only for Invoice SEFAZ with VAT (pt) Fatura Total, utilizada apenas para Fatura SEFAZ com VAT | | `taxByType` | TaxByTypeForGoods | | | `taxImpactHighlights` | TaxImpactHighlights | | ### ProcessingInfo | Property | Type | Description | |---|---|---| | `versionId` | string | | | `duration` | number | | | `message` | object | | ### DetailsTaxForGoods ### LineFull | Property | Type | Description | |---|---|---| | `warnings` | array | | ### DetailTaxBase | Property | Type | Description | |---|---|---| | `jurisdictionName` | string | (en) Jurisdiction used for the calc tax amount (pt) Jurisdição usada para calcular o valor do imposto | | `jurisdictionType` | string | (en) Type of jurisdiction (country is a default option) - 'City' - 'State' - 'Country' (pt) Tipo de jurisdição (país é uma opção predefinida) - 'Cidade' - 'Estado' - 'País' | | `taxImpact` | DetailsCalculatedTaxImpact | | | `taxType` | string | Identificador do tipo de imposto/Tax type identifier - 'icms' (en) Tax on operations related to the circulation of Goods and Services of Interstate and Inter-municipal Transport, and Communication Services. (pt) Imposto sobre Operações relativas à Circulação de Mercadorias e sobre Prestações de Serviços de Transporte Interestadual e Intermunicipal e de Comunicação. - 'icmsFCP' (en) FCP (Fund to Combat the Poverty) is a complement to the ICMS, levied on commercial transactions, in accordance with the legislation of each state. (pt) O FCP (Fundo de Combate à Pobreza) é um complemento do ICMS, incidindo sobre transações comerciais, de acordo com a legislação de cada estado. - 'icmsSt' (en) ICMS due for tax substitution (when the ICMS is fully paid in advance, and it is not necessary to charge it again in future transactions of goods.) (pt) ICMS devido por substituição tributária (quando o ICMS é pago em seu valor total de forma antecipada, não sendo necessário cobrá-lo novamente em próximas transações de uma mercadoria.). - 'icmsStFCP' (en) ICMS complement (FCP - Fund to Combat the Poverty) related to Tax Substitution. (pt) Complemento do ICMS (FCP - Fundo de Combate à pobreza) relativo à Substituição Tributária. - 'icmsPart' (en) ICMS sharing. (pt) Partilha de ICMS. - 'icmsStPart' (en) ICMS due for tax substitution with ICMS sharing. (pt) ICMS devido por substituição tributária com partilha de ICMS. - 'icmsStFCPPart' (en) ICMS complement (FCP - Fund to Combat the Poverty) related to Tax Substitution with ICMS sharing. (pt) Complemento do ICMS (FCP - Fundo de Combate à pobreza) relativo à Substituição Tributária com partilha de ICMS. - 'icmsStSd' (en) ICMS related to tax substitution in the Substitution condition (CST 60). (pt) ICMS relativo à substituição tributária na condição de Substituído (CST 60). - 'icmsStSdFCP' (en)ICMS related to tax substitution in the Substitution condition (CST 60) with additional FCP to the ICMS. (pt)ICMS relativo à substituição tributária na condição de Substituído (CST 60) com adicional FCP ao ICMS. - 'icmsDifaFCP' (en) ICMS Difal (ICMS rate differential, when the purchase of goods/services is interstate;) is the Tax on the Circulation of Goods and Services with additional FCP to the ICMS. (pt) ICMS Difal (Diferencial de alíquota do ICMS, quando a compra da mercadoria/serviço é feita de forma interestadual) é o Imposto sobre Circulação de Mercadorias e Serviços com adicional FCP ao ICMS. - 'icmsDifaDest' (en) ICMS rate differential attributed to the final consumer recipient. (If the recipient is a non-taxpayer, then he is necessarily a final consumer and then there will be ICMS dest, in which the calculation is basically the difference in rates. If the recipient is a taxpayer, there will be no ICMS dest.) (pt) Diferencial de alíquota do ICMS atribuída ao destinatário consumidor final. (Se o destinatário é não-contribuinte, então necessariamente é consumidor final e então haverá ICMS dest, em que o cálculo é basicamente a diferença de alíquotas. Se o destinatário é contribuinte, não haverá ICMS dest.) - 'icmsDifaRemet' (en) ICMS rate differential attributed to the sender. (The responsibility for collection is assigned to the sender when the recipient is not a tax payer.) (pt) Diferencial de alíquota do ICMS atribuída ao remetente. (A responsabilidade pelo recolhimento é atribuída ao remetente, quando o destinatário não for contribuinte do imposto.) - 'icmsRf' (en) ICMS to be withheld over Service Freight value. (pt) ICMS a ser retido sobre o valor do Serviço de Frete. - 'icmsDeson' (en) ICMS tax relief, consists of a tax discount corresponding to the amount of tax waived in exempt, non-taxed or suspended operations, where all ICMS is exempted. (pt) O ICMS desonerado consiste em um desconto tributário correspondente ao valor do imposto dispensado nas operações com redução de base, isentas, não tributadas ou suspensas, onde todo o ICMS é desonerado. - 'icmsCredsn' (en) The ICMS credit system allows tax compensation (guarantees the right to credit the tax that was previously charged on operations involving the entry of goods to those who receive the goods or products) for those opting for the Simples Nacional regime, a tax regime exclusive for micro and small companies. (pt) O sistema de crédito do ICMS permite que haja compensação do imposto (garante a àquele que recebe as mercadorias ou produtos o direito de se creditar do imposto que foi anteriormente cobrado em operações envolvendo a entrada de mercadorias) aos optantes do regime Simples Nacional, regime tributário exclusivo para micro e pequenas empresas. - 'icmsEff' (en) The Effective ICMS is the reimbursement of the difference in the amount paid (if it is the highest) by the industry, when sold to the final consumer. (pt) O ICMS Efetivo é o ressarcimento da diferença do valor pago (caso for a maior) pela indústria, quando vendido para consumidor final. - 'icmsOwnPayer' (en) ICMS of the substitute charged in a previous operation. This amount is only received, it is not calculated. (pt) ICMS próprio do substituto cobrado em operação anterior. Este valor é apenas recebido, não é calculado. - 'pis' (en) Social Integration Program (pt) Programa de Integração Social - 'pisRf' (en) Process of withholding PIS at source for taxes involving legal entities. (CST 5979) (pt) Processo de retenção do PIS na fonte para tributos que envolvem pessoa jurídica. (CST 5979) - 'pisSt' (en) PIS due for tax substitution. (pt) PIS devido por substituição tributária. - 'pisDeson' (en) PIS tax relief. (pt) PIS desonerado. - 'cofins' (en) Contribution to Social Security Financing. (pt) Contribuição para o Financiamento da Seguridade Social. - 'cofinsRf' (en) COFINS withholding process for taxes involving legal entities. (CST 5960) (pt) Processo de retenção do COFINS na fonte para tributos que envolvem pessoa jurídica. (CST 5960) - 'cofinsSt' (en) COFINS due for tax substitution. (pt) COFINS devido por substituição tributária. - 'cofinsDeson' (en) COFINS tax relief. (pt) COFINS desonerado. - 'csllRf' (en) CSLL withholding for taxes involving legal entities. (CST 5987). (pt) CSLL retido na fonte para tributos que envolvem pessoa jurídica. (CST 5987). - 'irrf' (en) Withholding income tax. This is a tax liability for the Federal Revenue and is charged from individuals (PF) and legal entities (PJ). (pt) Imposto de Renda Retido na Fonte. Essa é uma obrigação tributária destinada à Receita Federal e é cobrada de pessoas físicas (PF) e pessoas jurídicas (PJ). - 'cprb' (en) Social Security Contribution on Gross Revenue. It is based on the Article 195 of the Federal Constitution. It states: “social security will be financed by the whole society, directly and indirectly, under the terms of the law”. (pt) Contribuição Previdenciária sobre a Receita Bruta. É baseada no artigo 195 da Constituição Federal. Nela, afirma-se: “a seguridade social será financiada por toda a sociedade, de forma direta e indireta, nos termos da lei”. - 'cprbRf' (en) CPRB withholding process. (pt) Processo de retenção do CPRB na fonte. - 'inssAr' (en) INSS to be collected. In MEI services, for example, INSS is not withheld but 20% must be collected. (pt) INSS a Recolher. Em tomadas de serviço de MEI por exemplo, não se retêm INSS, mas 20% deve ser recolhido. - 'inssRf' (en) INSS withholding process. (pt) Processo de retenção do INSS na fonte. - 'iss' (en) Tax over services. It is a tax applicable to companies and self-employed professionals who provide services. (pt) Imposto sobre Serviços. É um tributo aplicável a empresas e profissionais autônomos que realizam prestação de serviços. - 'issRf' (en) ISS withholding process. (pt) ISS retido na fonte. - 'ipi' (en) Taxes over industrialized products. (pt) Imposto sobre Produtos Industrializados. - 'ipiReturned' (en) IPI returned. (pt) IPI devolvido. - 'ii' (en) Tax on the importation of foreign products and is levied on the importation of foreign goods and on the luggage of travelers coming from abroad. In the case of foreign goods, the calculation basis is the customs value, and the rate is indicated in the Common External Tariff (TEC). (pt) Imposto sobre a importação de produtos estrangeiros e incide sobre a importação de mercadorias estrangeiras e sobre a bagagem de viajante procedente do exterior. No caso de mercadorias estrangeiras, a base de cálculo é o valor aduaneiro e a alíquota está indicada na Tarifa Externa Comum (TEC). - 'iof' (en) Financial transaction tax. This tax is levied on financial operations such as credit, exchange, and insurance. (pt) Imposto sobre Operações Financeiras. Esse imposto é cobrado em operações financeiras como crédito, câmbio e seguros. - 'fust' (en) Fund for the Universalization of Telecommunications Services. Its purpose is to bring telephony and internet access to isolated regions, with inadequate or non-existent infrastructure. (pt) Fundo de Universalização dos Serviços de Telecomunicações. Tem a finalidade de levar acesso à telefonia e internet para regiões isoladas, com infraestrutura inadequada ou inexistente. - 'funttel' (en) Fund for the Technological Development of Telecommunications. It is an accounting fund with the objective of stimulating the process of technological innovation, encouraging the training of human resources, fostering job creation and promoting access to resources for small and medium-sized companies. (pt) Fundo para o Desenvolvimento Tecnológico das Telecomunicações. É um fundo de natureza contábil com o objetivo de estimular o processo de inovação tecnológica, incentivar a capacitação de recursos humanos, fomentar a geração de empregos e promover o acesso de pequenas e médias empresas a recursos. - 'aproxtrib' (en) Approximate Tax Value is the information on the average value of taxes that influence the price of a product or service. (pt) Valor aproximado dos Tributos é a informação sobre o valor médio dos impostos que influenciam o preço de um produto ou serviço. - 'aproxtribCity' (en) Approximate value of Municipal Taxes. (pt) Valor aproximado dos Tributos Municipais. - 'aproxtribState' (en) Approximate value of State Taxes. (pt) Valor aproximado dos Tributos Estaduais. - 'aproxtribFed' (en) Approximate value of Federal Taxes. (pt)Valor aproximado dos Tributos federais. - 'cprb' (en) Social Security Contribution on Gross Revenue (pt) Contribuição Previdenciária sobre a Receita Bruta - 'is' (en) Selective Tax (pt) Imposto Seletivo - 'isSpecific' (en) Specific Selective Tax (pt) Imposto Seletivo Específico - 'cbs' (en) Contribution on Goods and Services (pt) Contribuição sobre Bens e Serviços - 'ibs' (en) IBS Goods and Services Tax (pt) IBS Imposto sobre Bens e Serviços - 'ibsUf' (en) IBS State Jurisdiction (pt) IBS Juristição Estadual - 'ibsMun' (en) IBSMunicipal Jurisdiction (pt) IBS Juristição Municipal - 'cbsPresumed' (en) Presumed CBS Credit (pt) Crédito Presumido de CBS - 'ibsPresumed' (en) Presumed IBS Credit (pt) Crédito Presumido de IBS - 'cbsPresSusCond' (en) Presumed Under Suspensive Condition CBS Credit (pt) Crédito Presumido em condição Suspensiva de CBS - 'ibsPresSusCond' (en) Presumed Under Suspensive Condition IBS Credit (pt) Crédito Presumido em condição Suspensiva de IBS - 'cbsRegular' (en) CBS Regular (pt) CBS Regular - 'ibsUfRegular' (en) IBS Regular, State Jurisdiction (pt) IBS Regular, Jurisdição Estadual - 'ibsMunRegular' (en) IBS Regular, Municipal Jurisdiction (pt) IBS Regular, Jurisdição Municipal - 'cbsDeferred' (en) CBS Deferred (pt) CBS Diferido - 'ibsUfDeferred' (en) IBS Defered State Jurisdiction (pt) IBS Diferido Jurisdiçao Estadual - 'ibsMunDeferred' (en) IBS Defered Municipal Jurisdiction (pt) IBS Diferido Jurisdiçao Municipal - 'ibsDeferred' (en) IBS Defered Monofasico (pt) IBS Diferido Monofasico - 'cbsSbjWh' (en) CBS single-phase subject to withholding (pt) CBS monofásico sujeito a retenção - 'ibsSbjWh' (en) IBS single-phase subject to withholding (pt) IBS monofásico sujeito a retenção - 'cbsPrvWh' (en) CBS single-phase previously withheld (pt) CBS monofásico retido anteriormente - 'ibsPrvWh' (en) IBS single-phase previously withheld (pt) IBS monofásico retido anteriormente - 'cbsTaxReturn' (en) Cashback discount on CBS (pt) Cashback abatimento no CBS - 'ibsUfTaxReturn' (en) Cashback discount on IBS State Jurisdiction (pt) Cashback abatimento no IBS Jurisdiçao Estadual - 'ibsMunTaxReturn' (en) Cashback discount on IBS Municipal Jurisdiction (pt) Cashback abatimento no IBS Jurisdiçao Municipal - 'cbsGovTaxComp' (en) Information on the participation of CBS in the composition of the value of IBS and CBS in government purchases, which would be due to the municipality, without the application of Art. 473 of LC 214/2025 (pt) Informações da participação do CBS na composição do valor do IBS e da CBS em compras governamentais, que seria devido ao município, sem aplicação do Art. 473. da LC 214/2025 - 'ibsUfGovTaxComp' (en) Information on the participation of IBS UF in the composition of the value of IBS and CBS in government purchases, which would be due to the municipality, without the application of Art. 473 of LC 214/2025 (pt) Informações da participação do IBS UF na composição do valor do IBS e da CBS em compras governamentais, que seria devido ao município, sem aplicação do Art. 473. da LC 214/2025 - 'ibsMunGovTaxComp' (en) Information on the participation of IBS Mun in the composition of the value of IBS and CBS in government purchases, which would be due to the municipality, without the application of Art. 473 of LC 214/2025 (pt) Informações da participação do IBS Mun na composição do valor do IBS e da CBS em compras governamentais, que seria devido ao município, sem aplicação do Art. 473. da LC 214/2025 - 'cbsTranferCred' (en) IBS amount to be transferred (pt) Valor do CBS a ser transferido - 'ibsTranferCred' (en) IBS amount to be transferred (pt) Valor do IBS a ser transferido - 'ibsPresCredZFM' (en) Information on presumed IBS credit for supplies from the ZFM (pt) Informações do crédito presumido de IBS para fornecimentos a partir da ZFM - 'ibsSettlementAdj' (en) IBS for settlement period (pt) CBS de ajuste de competência - 'cbsSettlementAdj' (en) CBS for settlement period (pt) CBS de ajuste de competência - 'ibsCreditReversal' (en) IBS Credit REversal (pt) Estorno de Crédito de IBS - 'cbsCreditReversal' (en) CBS Credit REversal (pt) Estorno de Crédito de CBS Usage purpose: Calculation/Invoice/Do not apply for services | | `citation` | string | (en) This string captures the transaction scenario used to calculate the tax for this tax type. Scenarios are specific to the tax type. This field provides information about how the tax engine interpreted the transaction information that was passed in. (pt) Esta sequência captura o cenário de transação usado para calcular o imposto para este tipo de imposto. Os cenários são específicos para o tipo de imposto. Este campo fornece informações sobre como o mecanismo fiscal interpretou as informações da transação que foram repassadas. Usage purpose: Calculation/Invoice/Do not apply for services | | `citationId` | string | (en) Citation Id for this tax scenario. (pt) Id de citação para este cenário de imposto. Usage purpose: Calculation/Invoice/Do not apply for services | | `isCustomCitation` | boolean | (en) This attribute informs that the citation is custom. (pt) Este atributo informa que a citação é customizada. Usage purpose: Calculation/Invoice/Do not apply for services | | `ruleId` | string | (en) Rule Id used to identify the Citation. (pt) Id de regra usado para identificar a citação. Usage purpose: Calculation/Invoice/Do not apply for services | | `ruleCode` | string | (en) Rule Code used to identify the Citation. (pt) Código de regra usado para identificar a citação. Usage purpose: Calculation/Invoice/Do not apply for services | | `subtotalTaxable` | number | (en) This decimal captures how much of the lineAmount was taxable by this tax, calc base. (pt) Este decimal captura quanto do valor do item (em linha) era tributável por este imposto, base de cálculo. Usage purpose: Calculation/Invoice/Do not apply for services | | `rate` | number | (en) Tax rate (pt) Alíquota Usage purpose: Calculation/Invoice/Do not apply for services | | `tax` | number | (en) Tax amount. (pt) Valor do imposto. Usage purpose: Calculation/Invoice | | `exemptionCode` | string | (en) Official Benefit Code (pt) Código de benefício oficial | | `traceCode` | string | (en) Trace code of the reason for this result. (pt) Código de rastreamento do motivo para esse resultado. Usage purpose: Calculation/Invoice/Do not apply for services | ### ICMS_DetailTax ### ICMS_St_DetailTax ### ICMS_Part_DetailTax ### ICMS_St_Part_DetailTax ### ICMS_DifaDest_DetailTax (en) This is the block used to inform the difference of icms between states when the customer is not icms taxable on purchase operations the DIFA. The value of the tax will be tax due. (pt) Este é o bloco utilizado para informar a diferença de icms entre estados quando o cliente não é icms tributável nas operações de compra do DIFA. O valor do imposto será o imposto devido. ### ICMS_DifaRemet_DetailTax (en) This is the block used to inform the difference of ICMS between states when the customer is not icms taxable on purchase operations the DIFA. The value of the tax will be tax due. (pt) Este é o bloco utilizado para informar a diferença de icms entre estados quando o cliente não é icms tributável nas operações de compra do DIFA. O valor do imposto será o imposto devido. ### ICMS_Rf_DetailTax (en) This ICMS is the ICMS to be withheld over Service Freight value. (pt) Este ICMS é o ICMS a ser retido sobre o valor do Frete de Serviço. ### ICMS_Deson_DetailTax (en) This ICMS is a discount that needs to be applied to the end amount of the invoice due to the ICMS exemption. (pt) Este ICMS é um desconto que deve ser aplicado ao valor final da fatura devido ao exemplo do icms. ### ICMS_Credsn_DetailTax (en) This is the ICMS that can be used as tax credit with transactions against companies with tax regime Simples. (pt) Esse é o ICMS que pode ser utilizado como crédito tributário nas operações contra empresas com regime tributário Simples ### ICMS_Eff_DetailTax (en) This is the effective ICMS, calculated for this operation. (pt) Este é o ICMS efetivo, calculado para esta operação. ### PIS_COFINS_DetailTax ### PIS_COFINS_St_DetailTax ### IPI_DetailTax (en) IPI Tax (pt) Impposto IPI ### IPI_Returned_DetailTax (en) IPI value on return transactions (pt) Valor de IPI em transações de retorno ### CBSIBS_DetailTax (en) CBS, IBS Tax TYPES (pt) Estrutura para tributos CBS, IBS ### IS_DetailTax (en) IS ansd IS Specific Tax TYPES (pt) Estrutura para tributos IS. IS Specific ### IBSPresCredZFM_DetailTax (en) IPI Tax (pt) Impposto IPI ### CBSIBS_SettlementAdj_DetailTax (en) IPI Tax (pt) Impposto IPI ### DetailsCalculatedTaxImpact | Property | Type | Description | |---|---|---| | `impactOnFinalPrice` | DetailsTaxImpactEnum | | | `impactOnNetAmount` | DetailsTaxImpactEnum | | | `accounting` | DetailsTaxAccountingEnum | | ### DetailsTaxImpactEnum (en) Informs impact on final price. ADD - These are the taxes that are added in to the transaction total. Ex: IPI, ICMS-ST, ICMS-DIFAL. INCLUDED - These are taxes that are calculated and provisioned but they do not change the amount of the transaction. They are included in the price of the goods or services. Ex: ICMS, ISS, PIS and COFINS. SUBCRACTED - These are taxes that are deducted from the transaction usually due to withholdings (retenções na fonte). Ex: IRRF, INSS, ISS-RETIDO, PIS-RETIDO NA FONTE, COFINS-RETIDO NA FONTE and CSLL-RETIDO NA FONTE. INFORMATIVE - These are taxes that are only informative in nature. They do not generate a liability nor a credit and must be disclosed for information purposes only. Ex: IBPT Federal, IBPT Estadual and IBPT Municipal." (pt) Informa impacto no valor líquido. ADD - Impostos que são adicionados ao valor total da transações: Ex: IPI, ICMS-ST, ICMS-DIFAL. INCLUDED - Impostos que são calculados e provisionados, mas que não impactam ou alteram o valor total da transação. Ex: ICMS, ISS, PIS and COFINS. SUBCRACTED - Impostos que são reduzidos da transação, geralmente devido a retenções na fonte. Ex: IRRF, INSS, ISS-RETIDO, PIS-RETIDO NA FONTE, COFINS-RETIDO NA FONTE and CSLL-RETIDO NA FONTE. INFORMATIVE - Impostos apenas informativos, que não geram crédito ou débito, mas precisam ser destacados/informados. Ex: IBPT Federal, IBPT Estadual and IBPT Municipal." Usage purpose: Calculation ### DetailsTaxAccountingEnum (en) Bookkeeping (pt) Escrituração ### CSTTableBEnum (en) Used to determine how the tax is applicable and calculated. It may define and exemption, a tax base reduction, identifies that a special rate is applicable (not the rate itself). - '00' # Taxed in its totality - '10' # Taxed and subject to tax substitution (ICMS ST) - '20' # Taxed with Tax Base Reduction - '30' # Exempt /Not Taxed and subject to tax Substitution (ICMS#ST) - '40' # Tax free - '41' # Not Taxed - '50' # Taxes Suspended - '51' # Deferred taxes - '60' # ICMS Tax already collected through Substituition (ICMS ST) - '70' # Taxed with Tax Base Reduction and subject to Tax Subsititution (ICMS ST) - '90' # Others - '101' # Taxed by Simples Nacional with credit permission - '102' # Taxed by Simples Nacional without credit permission - '103' # Exemption from ICMS in Simples Nacional for gross revenue range - '201' # Taxed by Simples Nacional with credit permission and ICMS collection for tax substitution - '202' # Taxed by Simples Nacional without credit permission and with ICMS charge for tax substitution - '203' # Exemption from ICMS in Simples Nacional for gross revenue range and with collection of ICMS for tax substitution - '300' # Immune - '400' # Not taxed by Simples Nacional - '500' # ICMS enabled for tax substitution (replaced) or in advance - '900' # Others (pt) Usado para determinar como o imposto é aplicádo e calculado. Pode definir uma isenção, uma redução da base tributária, identifica que uma taxa especial é aplicável (não a própria taxa). - '00' # Tributado em sua totalidade - '10' # Tributado e sujeito a substituição tributária (ICMS ST) - '20' # Tributado com Redução da Base Fiscal - '30' # Isento / Não Tributado e sujeito a Substituição Tributária (ICMS # ST) - '40' # Isento de imposto - '41' # Não tributado - '50' # Impostos suspensos - '51' # Impostos diferidos - '60' # ICMS Imposto já recolhido através da Substituição (ICMS ST) - '70' # Tributado com Redução da Base de Dados Fiscal e sujeito a Substituição Tributária (ICMS ST) - '90' # Outros - '101' # Tributada pelo Simples Nacional com permissão de crédito - '102' # Tributada pelo Simples Nacional sem permissão de crédito - '103' # Isenção do ICMS no Simples Nacional para faixa de receita bruta - '201' # Tributada pelo Simples Nacional com permissão de crédito e com cobrança do ICMS para substituição tributária - '202' # Tributada pelo Simples Nacional sem permissão de crédito e com cobrança do ICMS para substituição tributária - '203' # Isenção do ICMS no Simples Nacional para faixa de receita bruta e com cobrança do ICMS por substituição tributária - '300' # Imune - '400' # Não tributada pelo Simples Nacional - '500' # ICMS habilitado para substituição tributária (substituído) ou por antecipação - '900' # Outros ### ICMSSTDesonReason (en) - '3' # AGRICULTURAL PRODUCTION - '9' # OTHERS - '12' # AGRICULTURAL FUNDING (pt) - '3' # PRODUÇÃO AGRÍCOLA - '9' # OUTROS - '12' # FOMENTO AGROPECUÁRIO ### CSTPistCofinsEnum (en) Determines how the tax is applicable and calculated. It may define an exemption, a tax base reduction, identifies that a special rate is applicable (not the rate itself). - '01' # Taxable Operation with Basic Rate - '02' # Taxable Operation with Differentiated Rate - '03' # Taxable Operation with Rate per Product Unit of Measure - '04' # Single-Phase Taxable Operation - 'Resale at Zero Rate - '05' # Taxable Operation by Tax Replacement - '06' # Taxable Operation at Zero Rate - '07' # Operation Exempt from Contribution - '08' # Operation without Incidence of Contribution - '09' # Operation with Suspension of Contribution - '49' # Other Outbound Operations - '50' # Transaction with the Right to Credit - 'Exclusively Linked to Taxed Revenue in the Domestic Market - '51' # Operation with the Right to Credit - Exclusively Linked to Untaxed Revenue in the Domestic Market - '52' # Operation with the Right to Credit - 'Exclusively Linked to Export Revenue - '53' # Transaction with the Right to Credit - 'Linked to Taxed and Non-Taxed Revenue in the Internal Market - '54' # Transaction with the Right to Credit - 'Linked to Taxed Revenues in the Domestic and Export Markets - '55' # Operation with the Right to Credit - 'Linked to Untaxed Revenue in the Domestic and Export Markets - '56' # Operation with the Right to Credit - 'Linked to Taxed and Non-Taxed Revenue in the Internal Market, and Export - '60' # Presumed Credit - 'Acquisition Operation Linked Exclusively to Taxed Revenue in the Domestic Market - '61' # Presumed Credit - 'Acquisition Operation Linked Exclusively to Untaxed Revenue in the Domestic Market - '62' # Presumed Credit - 'Acquisition Operation Linked Exclusively to Export Revenue - '63' # Presumed Credit - 'Acquisition Operation Linked to Taxed and Non-Taxed Revenue in the Domestic Market - '64' # Presumed Credit - 'Acquisition Operation Linked to Taxed Revenues in the Domestic and Export Markets - '65' # Presumed Credit - 'Acquisition Operation Linked to Untaxed Revenue in the Domestic and Export Markets - '66' # Presumed Credit - 'Acquisition Operation Linked to Taxed and Non-Taxed Revenue in the Domestic Market, and Export - '67' # Presumed Credit - 'Other Operations - '70' # Acquisition Operation without Right to Credit - '71' # Acquisition Operation with Exemption - '72' # Suspension Acquisition Operation - '73' # Zero Rate Acquisition Operation - '74' # Acquisition Operation without Incidence of Contribution - '75' # Tax Substitution Acquisition Operation - '98' # Other Inbound Operations - '99' # Other Operations (pt) Determina como o imposto é aplicável e calculado. Pode definir uma isenção, uma redução da base tributária, identifica que uma taxa especial é aplicável (não a própria taxa). - '01' # Operação Tributável com Taxa Básica - '02' # Operação Tributável com Taxa Diferenciada - '03' # Operação tributável com taxa por unidade de medida do produto - '04' # Operação tributável monofásica - 'Revenda à taxa zero - '05' # Operação Tributável por Substituição Tributária - '06' # Operação tributável à taxa zero - '07' # Operação Isenta de Contribuição - '08' # Operação sem Incidência de Contribuição - '09' # Operação com Suspensão de Contribuição - '49' # Outras Operações de Saída - '50' # Transação com Direito ao Crédito - 'Vinculada Exclusivamente à Receita Tributada no Mercado Nacional - '51' # Operação com Direito a Crédito - Vinculada Exclusivamente à Receita Não Tributada no Mercado Nacional - '52' # Operação com Direito a Crédito - 'Vinculada Exclusivamente à Receita de Exportação - '53' # Operação com Direito ao Crédito - 'Vinculada a Receitas Tributadas e Não Tributadas no Mercado Interno - '54' # Transação com Direito a Crédito - 'Vinculada a Receitas Tributadas no Mercado Interno e Exportador - '55' # Operação com Direito a Crédito - 'Vinculada à Receita Não Tributada no Mercado Interno e Exportador - '56' # Operação com Direito a Crédito - 'Vinculada a Receita Tributada e Não Tributada no Mercado Interno, e Exportação - '60' # Crédito Presumido - 'Operação de Aquisição Vinculada Exclusivamente à Receita Tributada no Mercado Nacional - '61' # Crédito Presumido - 'Operação de Aquisição Vinculada Exclusivamente a Receita Não Tributada no Mercado Interno - '62' # Crédito Presumido - 'Operação de Aquisição Vinculada Exclusivamente à Receita de Exportação - '63' # Crédito Presumido - 'Operação de Aquisição Vinculada a Receita Tributada e Não Tributada no Mercado Nacional - '64' # Crédito Presumido - 'Operação de Aquisição Vinculada a Receitas Tributadas no Mercado Interno e Exportador - '65' # Crédito Presumido - 'Operação de Aquisição Vinculada a Receita Não Tributada no Mercado Interno e Exportação - '66' # Crédito Presumido - 'Operação de Aquisição Vinculada a Receita Tributada e Não Tributada no Mercado Nacional, e Exportação - '67' # Crédito Presumido - 'Outras Operações - '70' # Operação de Aquisição sem Direito a Crédito - '71' # Operação de aquisição com isenção - '72' # Operação de Aquisição de Suspensão - '73' # Operação de aquisição de taxa zero - '74' # Operação de aquisição sem incidência de contribuição - '75' # Operação de Aquisição de Substituição Fiscal - '98' # Outras operações de entrada - '99' # Outras Operações ### CalcModeDetailEnum ### CSTIpiEnum (en) Tax status code (rule of taxation) - '00' # Entry with Credit Recovery - '01' # Taxable Entry with Zero Rate - '02' # Free Entry - '03' # Untaxed Entry - '04' # Immune Entry - '05' # Entrance with Suspension - '49' # Other Entries - '50' # Taxed Output - '51' # Taxable Output with Zero Rate - '52' # Exit Exit - '53' # Untaxed Output - '54' # Immune Output - '55' # Suspension Output - '99' # Other Exits (pt) Código de situação tributária - '00' # Entrada com Recuperação de Crédito - '01' # Entrada Tributável com Alíquota Zero - '02' # Entrada Isenta - '03' # Entrada Não-Tributada - '04' # Entrada Imune - '05' # Entrada com Suspensão - '49' # Outras Entradas - '50' # Saída Tributada - '51' # Saída Tributável com Alíquota Zero - '52' # Saída Isenta - '53' # Saída Não-Tributada - '54' # Saída Imune - '55' # Saída com Suspensão - '99' # Outras Saídas Usage Purpose: Calculation/Invoice/Do not apply for services ### LineWarning | Property | Type | Description | |---|---|---| | `id` | string | | | `code` | string | | | `citation` | string | | | `description` | string | (en) Description of the alert (Subject to PIS Benefits, PIS, Constituição Federal de 1988, Artigo 150, Inciso VI, Alínea) (pt) Descrição do alerta (Subject to PIS Benefits, PIS, Constituição Federal de 1988, Artigo 150, Inciso VI, Alínea) | | `isCustomCitation` | string | | ### TaxByTypeForGoods | Property | Type | Description | |---|---|---| | `icms` | TaxByTypeSummary | | | `icmsFCP` | TaxByTypeSummary | | | `icmsSt` | TaxByTypeSummary | | | `icmsStFCP` | TaxByTypeSummary | | | `icmsStSd` | TaxByTypeSummary | | | `icmsStSdFCP` | TaxByTypeSummary | | | `icmsPart` | TaxByTypeSummary | | | `icmsStPart` | TaxByTypeSummary | | | `icmsStFCPPart` | TaxByTypeSummary | | | `icmsDifaFCP` | TaxByTypeSummary | | | `icmsDifaDest` | TaxByTypeSummary | | | `icmsDifaRemet` | TaxByTypeSummary | | | `icmsRf` | TaxByTypeSummary | | | `icmsDeson` | TaxByTypeSummary | | | `icmsCredsn` | TaxByTypeSummary | | | `icmsEff` | TaxByTypeSummary | | | `icmsOwnPayer` | TaxByTypeSummary | | | `pis` | TaxByTypeSummary | | | `pisSt` | TaxByTypeSummary | | | `pisDeson` | TaxByTypeSummary | | | `cofins` | TaxByTypeSummary | | | `cofinsSt` | TaxByTypeSummary | | | `cofinsDeson` | TaxByTypeSummary | | | `cofinsSurcharge` | TaxByTypeSummary | | | `ipi` | TaxByTypeSummary | | | `ipiReturned` | TaxByTypeSummary | | | `ii` | TaxByTypeSummary | | | `iof` | TaxByTypeSummary | | | `aproxtribState` | TaxByTypeSummary | | | `aproxtribFed` | TaxByTypeSummary | | | `cprb` | TaxByTypeSummary | | | `is` | TaxByTypeSummary | | | `isSpecific` | TaxByTypeSummary | | | `cbs` | TaxByTypeSummary | | | `ibs` | TaxByTypeSummary | | | `ibsUf` | TaxByTypeSummary | | | `ibsMun` | TaxByTypeSummary | | | `cbsPresumed` | TaxByTypeSummary | | | `ibsPresumed` | TaxByTypeSummary | | | `cbsPresSusCond` | TaxByTypeSummary | | | `ibsPresSusCond` | TaxByTypeSummary | | | `cbsRegular` | TaxByTypeSummary | | | `ibsUfRegular` | TaxByTypeSummary | | | `ibsMunRegular` | TaxByTypeSummary | | | `cbsDeferred` | TaxByTypeSummary | | | `ibsUfDeferred` | TaxByTypeSummary | | | `ibsMunDeferred` | TaxByTypeSummary | | | `cbsSbjWh` | TaxByTypeSummary | | | `cbsPrvWh` | TaxByTypeSummary | | | `ibsSbjWh` | TaxByTypeSummary | | | `ibsPrvWh` | TaxByTypeSummary | | | `cbsTaxReturn` | TaxByTypeSummary | | | `ibsUfTaxReturn` | TaxByTypeSummary | | | `ibsMunTaxReturn` | TaxByTypeSummary | | | `cbsSinglePhase` | TaxByTypeSummary | | | `ibsSinglePhase` | TaxByTypeSummary | | | `cbsGovTaxComp` | TaxByTypeSummary | | | `ibsUfGovTaxComp` | TaxByTypeSummary | | | `ibsMunGovTaxComp` | TaxByTypeSummary | | | `ibsSettlementAdj` | TaxByTypeSummary | | | `cbsSettlementAdj` | TaxByTypeSummary | | | `ibsCreditReversal` | TaxByTypeSummary | | | `cbsCreditReversal` | TaxByTypeSummary | | ### TaxImpactHighlights | Property | Type | Description | |---|---|---| | `included` | TaxImpactHighlightDetail | | | `added` | TaxImpactHighlightDetail | | | `subtracted` | TaxImpactHighlightDetail | | | `withheld` | TaxImpactHighlightDetail | | | `informative` | TaxImpactHighlightDetail | | ### TaxByTypeSummary (en) Summary of all taxes (pt) Resumo de todos os impostos | Property | Type | Description | |---|---|---| | `subtotalTaxable` | number | (en) This decimal captures how much of the lineAmount was taxable by this tax, calc base (pt) Este decimal captura quanto do valor do item (em linha) era tributável por este imposto, base de cálculo Usage Purpose: Calculation/Invoice/Do not apply for services | | `tax` | number | (en) Tax amount. (pt) Valor do imposto. Usage Purpose: Calculation/Invoice | | `details` | array | | ### TaxByTypeSummary_details | Property | Type | Description | |---|---|---| | `jurisdictionName` | string | (en) Jurisdiction used for the calc tax amount (pt) Jurisdição usada para calcular o valor do imposto | | `jurisdictionType` | string | (en) Type of jurisdiction - 'City' - 'State' - 'Country' (pt) Tipo de jurisdição - 'Cidade' - 'Estado' - 'País' | | `taxImpacts` | array | (en) Informs impact on final price. ADD - These are the taxes that are added in to the transaction total. Ex: IPI, ICMS-ST, ICMS-DIFAL. INCLUDED - These are taxes that are calculated and provisioned but they do not change the amount of the transaction. They are included in the price of the goods or services. Ex: ICMS, ISS, PIS and COFINS. SUBCRACTED - These are taxes that are deducted from the transaction usually due to withholdings (retenções na fonte). Ex: IRRF, INSS, ISS-RETIDO, PIS-RETIDO NA FONTE, COFINS-RETIDO NA FONTE and CSLL-RETIDO NA FONTE. INFORMATIVE - These are taxes that are only informative in nature. They do not generate a liability nor a credit and must be disclosed for information purposes only. Ex: IBPT Federal, IBPT Estadual and IBPT Municipal." (pt) Informa impacto no valor líquido. ADD - Impostos que são adicionados ao valor total da transações: Ex: IPI, ICMS-ST, ICMS-DIFAL. INCLUDED - Impostos que são calculados e provisionados, mas que não impactam ou alteram o valor total da transação. Ex: ICMS, ISS, PIS and COFINS. SUBCRACTED - Impostos que são reduzidos da transação, geralmente devido a retenções na fonte. Ex: IRRF, INSS, ISS-RETIDO, PIS-RETIDO NA FONTE, COFINS-RETIDO NA FONTE and CSLL-RETIDO NA FONTE. INFORMATIVE - Impostos apenas informativos, que não geram crédito ou débito, mas precisam ser destacados/informados. Ex: IBPT Federal, IBPT Estadual and IBPT Municipal." Usage purpose: Calculation | | `tax` | number | (en) Tax amount. (pt) Valor do imposto. Usage Purpose: Calculation/Invoice | | `subtotalTaxable` | number | (en) This decimal captures how much of the lineAmount was taxable by this tax, calc base (pt) Este decimal captura quanto do valor do item (em linha) era tributável por este imposto, base de cálculo Usage Purpose: Calculation/Invoice/Do not apply for services | ### TaxImpactHighlightDetail ### HeaderFullForServices ### LineFullForServices ### SummaryForServices | Property | Type | Description | |---|---|---| | `numberOfLines` | integer | (en) Count of lines (pt) Contagem de linhas | | `totalLineAmounts` | number | | | `totalLineNetAmounts` | number | | | `totalTaxedDiscounts` | number | | | `totalUntaxedDiscounts` | number | | | `totalInsurances` | number | | | `totalFreights` | number | | | `totalOtherCosts` | number | | | `totalInvoice` | number | (en) Total Invoice, used only for Invoice SEFAZ. (pt) Fatura Total, utilizada apenas para Fatura SEFAZ. | | `totalInvoiceIbsCbsIs` | number | (en) Total Invoice, used only for Invoice SEFAZ with VAT (pt) Fatura Total, utilizada apenas para Fatura SEFAZ com VAT | | `taxByType` | TaxByTypeForServices | | | `taxImpactHighlights` | TaxImpactHighlights | | ### DetailsTaxForServices ### INSS_DetailTax ### IRRF_DetailTax ### ISS_DetailTax ### ISS_Rf_DetailTax ### CSTIssEnum (en) - '01' # Due at service provider address - '02' # Due at service provider address but Exempt - '03' # Due at service provider address but Immune - '04' # Due at service provider address but No Taxable - '08' # Due at service provider address but Suspended by court decision - '09' # Due at service provider address but Suspended by administrative process - '21' # Due at service rendered address - '22' # Due at service rendered address but Exempt - '23' # Due at service rendered address but Immune - '24' # Due at service rendered address but Not Taxable - '28' # Due at service rendered address but Suspended by court decision - '29' # Due at service rendered address but Suspended by administrative process - '40' # Immune Export (pt) - '01' # Devido no endereço do prestador - '02' # Devido no endereço do prestador mas Isento - '03' # Devido no endereço do prestador mas Imune - '04' # Devido no endereço do prestador mas Não Tributável - '08' # Devido no endereço do prestador mas Suspenso por decisão judicial - '09' # Devido no endereço do prestador mas Suspenso por processo administrativo - '21' # Devido no endereço de prestação - '22' # Devido no endereço de prestação mas Isento - '23' # Devido no endereço de prestação mas Imune - '24' # Devido no endereço de prestação mas Não Tributável - '28' # Devido no endereço de prestação mas Suspenso por decisão judicial - '29' # Devido no endereço de prestação mas Suspenso por processo administrativo - '40' # Exportação Imune ### CSTIssRfEnum (en) - '61' # Standard withholding - '62' # Standard withholding but Exempt - '63' # Standard withholding but Immune - '64' # Standard withholding but Not Taxable - '68' # Standard withholding but Suspended by court decision - '69' # Standard withholding but Suspended by administrative process - '70' # Forced withholding - '71' # Forced withholding but Exempt Retention - '72' # Forced withholding but Immune Retention - '73' # Forced withholding but Not Taxable - '78' # Forced withholding but Suspended by court decision - '79' # Forced withholding but Suspended by administrative process - '80' # Without withholding - '81' # Export without withholding - '99' # No Destination Information (pt) - '61' # Retenção Padrão - '62' # Retenção Padrão mas Isento - '63' # Retenção Padrão mas Imune - '64' # Retenção Padrão mas Não Tributavel - '68' # Retenção Padrão mas Suspenso por decisão judicial - '69' # Retenção Padrão mas Suspenso por processo administrativo - '70' # Retenção Forçada - '71' # Retenção Forçada mas Isento - '72' # Retenção Forçada mas Imune - '73' # Retenção Forçada mas Não Tributavel - '78' # Retenção Forçada mas Suspenso por decisão judicial - '79' # Retenção Forçada mas Suspenso por processo administrativo - '80' # Sem Retenção - '81' # Exportação Sem Retenção - '99' # Sem Informação do Destino ### TaxByTypeForServices | Property | Type | Description | |---|---|---| | `aproxtribCity` | TaxByTypeSummary | | | `aproxtribFed` | TaxByTypeSummary | | | `pis` | TaxByTypeSummary | | | `pisRf` | TaxByTypeSummary | | | `cofins` | TaxByTypeSummary | | | `cofinsRf` | TaxByTypeSummary | | | `csll` | TaxByTypeSummary | | | `csllRf` | TaxByTypeSummary | | | `iss` | TaxByTypeSummary | | | `issRf` | TaxByTypeSummary | | | `irpj` | TaxByTypeSummary | | | `irrf` | TaxByTypeSummary | | | `cprb` | TaxByTypeSummary | | | `cprbRf` | TaxByTypeSummary | | | `inssAr` | TaxByTypeSummary | | | `inssRf` | TaxByTypeSummary | | | `is` | TaxByTypeSummary | | | `cbs` | TaxByTypeSummary | | | `ibsUf` | TaxByTypeSummary | | | `ibsMun` | TaxByTypeSummary | | | `cbsPresumed` | TaxByTypeSummary | | | `ibsPresumed` | TaxByTypeSummary | | | `cbsPresSusCond` | TaxByTypeSummary | | | `ibsPresSusCond` | TaxByTypeSummary | | | `cbsRegular` | TaxByTypeSummary | | | `ibsUfRegular` | TaxByTypeSummary | | | `ibsMunRegular` | TaxByTypeSummary | | | `cbsDeferred` | TaxByTypeSummary | | | `ibsUfDeferred` | TaxByTypeSummary | | | `ibsMunDeferred` | TaxByTypeSummary | | | `cbsSbjWh` | TaxByTypeSummary | | | `cbsPrvWh` | TaxByTypeSummary | | | `ibsSbjWh` | TaxByTypeSummary | | | `ibsPrvWh` | TaxByTypeSummary | | | `cbsTaxReturn` | TaxByTypeSummary | | | `ibsUfTaxReturn` | TaxByTypeSummary | | | `ibsMunTaxReturn` | TaxByTypeSummary | | | `cbsSinglePhase` | TaxByTypeSummary | | | `ibsSinglePhase` | TaxByTypeSummary | | | `cbsGovTaxComp` | TaxByTypeSummary | | | `ibsUfGovTaxComp` | TaxByTypeSummary | | | `ibsMunGovTaxComp` | TaxByTypeSummary | | ### TransactionForGoodsOut | Property | Type | Description | |---|---|---| | `header` | HeaderForGoods | | | `lines` | array | | | `calculatedTaxSummary` | CalculatedTaxSummaryForGoods | | | `processingInfo` | ProcessingInfo | | | `version` | string | (en) Payload Model Version (pt) Versão modelo do Payload | ### HeaderForGoods ### LineForGoods ### CalculatedTaxSummaryForGoods | Property | Type | Description | |---|---|---| | `numberOfLines` | integer | (en) Count of lines (pt) Contagem de linhas Usage Purpose: Calculation/Invoice | | `taxedDiscount` | number | (en) The sum of all line taxed discounts. (pt) Soma de todos os descontos de linha tributados. | | `untaxedDiscount` | number | (en) The sum of all line untaxed discounts. (pt) A soma de todos os descontos de linha não tributados. | | `subtotal` | number | (en) The sum of all line lineAmount attribute. (pt) A soma de todos os atributos de linha lineAmount. | | `totalTax` | number | (en) The sum of all line tax attribute (except 'taxImpact.impactOnFinalPrice=="Informative'). (pt) A soma de todos os atributos de imposto em linha (exceto 'taxImpact.impactOnFinalPrice=="Informative'). | | `grandTotal` | number | (en) The sum of all line lineAmount attribute + The sum of all line tax attribute not VAT (taxImpact.impactOnFinalPrice=="Add") - The sum of all line tax attribute not VAT (taxImpact.impactOnFinalPrice=="Subtracted") - The sum of all line lineTaxedDiscount attribute (pt) A soma de todos os atributos lineAmount + A soma de todos os atributos de impostos em linha, não VAT (taxImpact.impactOnFinalPrice == "Adicionar") - A soma de todos os atributos de imposto em linha não VAT (taxImpact.impactOnFinalPrice == "Subtraído") - A soma de todos os atributos lineTaxedDiscount | | `taxByType` | object | | ### HeaderForGoodsBase | Property | Type | Description | |---|---|---| | `participants` | object | (en) List of transaction participants, Seller, Buyer, Carrier (pt) Lista de participantes da transação, vendedor, comprador, operadora | | `eDocCreatorType` | string | (en) Indicates the calculation perspective. Other: vendor/supplier perspective. Self-calculation. This string indicates the type of transaction for which tax should be calculated. (pt) Indica a perspectiva do cálculo para validar cálculo de notas de entrada - cálculo na perspectiva do fornecedor. Cálculo próprio. Esta string indica o tipo de transação para a qual o imposto deve ser calculado. Usage purpose: Calculation | | `eDocCreatorPerspective` | boolean | (en) Used in case of return transactions: "True": the system calculates the values related to the credit and debit return transaction. "False": the system generates values and quantities related to the generation of return invoice. This flag is used only when eDocCreatorType is other and the return show Taxes using eDocCreator perspective or self-perspective. (pt) Utilizado em casos de emissão de nota de devolução: “True”: o sistema calcula os valores de estorno da nota apenas relacionados a créditos e débitos (escrituração). “False”: o sistema gera valores e quantidades relacionados a geração de nota fiscal de devolução. Cálculo próprio. Este sinalizador é usado apenas quando eDocCreatorType é outro e a devolução mostra Impostos usando a perspectiva eDocCreator ou perspectiva própria. Usage purpose: Calculation | | `amountCalcType` | AmountCalcTypeEnum | | | `companyLocation` | string | (en) Calculation type. The net value calculation method considers the price of the item sent for the calculation to be the price of the net product, not including taxes. thus, the result of the calculation will return a new unit value that takes into account the taxes levied on the transaction. when ipi is incurred, this value is highlighted outside and added to the net value of the item, as well as the other taxes that add to the transaction value (icms-st, icms-difal). Gross - the gross value calculation method considers the price of the item sent for the calculation to be the final price of the product including all taxes classified as cost of the product, such as icms, pis, cofins, and without taxes highlighted as ipi. Final - the method of calculating the final value considers that the price of the item sent for calculation is the price of the net product, including taxes usually reported outside, such as the tax type ipi. attention icms-st is not considered included in the final price, as it is an anticipated tax due by the customer. (pt) Tipo de cálculo. A metodologia de cálculo do valor líquido considera que o preço do item enviado para cálculo é o preço líquido do produto, não incluindo os impostos. assim, o resultado do cálculo retornará um novo valor unitário que leva em consideração os tributos incidentes sobre a transação. quando o ipi é incorrido, esse valor é destacado externamente e adicionado ao valor líquido do item, assim como os demais impostos que agregam ao valor da transação (icms-st, icms-difal). Bruto - o método de cálculo do valor bruto considera o preço do item enviado para cálculo como o preço final do produto incluindo todos os impostos classificados como custo do produto, como icms, pis, cofins, e sem os impostos destacados como ipi. Final - a forma de cálculo do valor final considera que o preço do item enviado para cálculo é o preço do produto líquido, incluindo os impostos normalmente declarados externamente, como o tipo de imposto ipi. atenção icms-st não é considerada incluída no preço final, por se tratar de uma taxa antecipada devida pelo cliente. Usage purpose: Calculation/Invoice | | `transactionDate` | string | (en) This string follows the transaction date format according to ISO 8601. Format YYYY-MM-DDTHH:mm:ssZ. The date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z. (pt) Esta string segue o formato da data da transação de acordo com a ISO 8601. Formato AAAA-MM-DDTHH: mm: ssZ. A notação de data e hora é definida pela RFC 3339, seção 5.6, por exemplo, 2017-07-21T17: 32: 28Z. Usage purpose: Calculation/Invoice | | `defaultLocations` | DefaultLocations | | | `nfRef` | array | (en) Transactions or other referenced invoices. (pt) Transações ou outras faturas referenciadas | ### EntityForGoods ### Payment | Property | Type | Description | |---|---|---| | `installmentsTerms` | PaymentTerms | | | `terms` | PaymentTerms | | | `bill` | PaymentBill | | | `withholdingMode` | WithholdingMode | | | `installment` | array | (en) Installments (pt) Parcelas do pagamento Usage purpose: Invoice | | `paymentInfo` | object | | ### Transport | Property | Type | Description | |---|---|---| | `modFreight` | string | (en) Freight model - 'CIF' 0 - Freight contracting on behalf of the Sender (CIF); - 'FOB' 1 - Contracting of freight on behalf of the recipient/sender (FOB); - 'Thirdparty' 2 - Contracting Freight on behalf of third parties; - 'SenderVehicle' 3 - Own transport on behalf of the sender; - 'ReceiverVehicle' 4 - Own transport on behalf of the recipient; - 'FreeShipping' 9 - Free shipping when 9 - Free shipping, these fields are ignored if present (transport, withholdICMSTransport, volumes, vehicle). (pt) Modelo de frete - 'CIF' 0 - Contratação do Frete por conta do Remetente (CIF); - 'FOB' 1 - Contratação do Frete por conta do destinatário/remetente (FOB); - 'Thirdparty' 2 - Contratação do Frete por conta de terceiros; - 'SenderVehicle' 3 - Transporte próprio por conta do remetente; - 'ReceiverVehicle' 4 - Transporte próprio por conta do destinatário; - 'FreeShipping' 9 - Frete grátis quando 9 - Frete grátis, os seguintes campos serão ignorados se presentes (transporte, reter ICMSTransporte, volumes, veículo). Usage purpose: Invoice | | `withholdICMSTransport` | boolean | (en) Informs if the service transport amount has icms withhold. (pt) Informar se existe retenção do icms no serviço de transporte. Usage purpose: Calculation | | `volumes` | array | (en) Packaging: used to identify ICMS-ST by statutory price. (pt) Embalagem: usada para identificar ICMS-ST por pauta. Usage purpose: Invoice | | `vehicle` | VehicleTransp | | ### AdditionalInformation | Property | Type | Description | |---|---|---| | `fiscalInfo` | string | (en) Additional information of fiscal interest (pt) Informação adicional de interesse fiscal | | `complementaryInfo` | string | (en) Additional information of user interest (pt) Informação adicional de interesse do usuário | | `otherInfo` | string | (en) Any additional information to print on the service invoice (pt) Qualquer informação adicional para imprimir na fatura de serviço | | `iest` | string | (en) State Tax Id for ST (pt) ID de imposto estadual para ST | | `procRef` | array | (en) Referenced Process (pt) Processo referenciado | ### DefaultLocations (en) This element contains a dictionary of locations such as the origin and destination addresses to be associated with this transaction. These locations may be overridden within each line item. The key for each location in the dictionary is the location 'purpose'. Valid locations purposes are 'ShipFrom', 'ShipTo', 'POS', 'POM', 'POO', 'BillingLocation', 'CallPlaced', 'CallReceived', 'ServiceRendered', 'POA' and 'FirstUse'. There can only be one location of a given purpose in the dictionary. (pt) Este elemento contém um dicionário de locais, como os endereços de origem e destino, a serem associados a esta transação. Esses locais podem ser substituídos em cada item de linha. A chave para cada local no dicionário é o 'propósito' do local. Os objetivos dos locais válidos são 'ShipFrom', 'ShipTo', 'POS', 'POM', 'POO', 'BillingLocation', 'CallPlaced', 'CallReceived', 'ServiceRendered', 'POA' e 'FirstUse'. Só pode haver um local para um determinado propósito no dicionário. | Property | Type | Description | |---|---|---| | `entity` | EntityLocation | | | `establishment` | EntityLocation | | | `transporter` | EntityLocation | | | `deliveryLocation` | EntityLocation | | | `pickupLocation` | EntityLocation | | ### Establishment ### EntityLocation | Property | Type | Description | |---|---|---| | `street` | string | (en) Street Name (pt) Nome da rua Usage purpose: Calculation/Invoice | | `neighborhood` | string | (en) Neighborhood Name (pt) Nome do bairro Usage purpose: Invoice | | `zipcode` | string | (en) Zip Code (pt) Código postal Usage purpose: Calculation/Invoice | | `cityCode` | string | (en) City Code (pt) Código da cidade Usage purpose: Invoice | | `cityName` | string | (en) City Name (pt) Nome da cidade Usage purpose: Invoice | | `state` | string | (en) State Code (pt) Código do estado Usage purpose: Invoice | | `countryCode` | string | (en) Country Code (pt) Código do país Usage purpose: Invoice | | `country` | string | (en) Use ISO 3166-1 alpha-3 codes (pt) Usar os códigos ISO 3166-1 alpha-3 Usage purpose: Calculation/Invoice | | `number` | string | (en) House number (pt) Número da casa Usage purpose: Invoice | | `complement` | string | (en) Any other information about the address (Room, Suite, Floor, etc) (pt) Quaisquer outras informações sobre o endereço (Quarto, Suíte, Andar, etc) Usage purpose: Invoice | | `phone` | string | (en) Phone number (pt) Número de telefone Usage purpose: Invoice | ### Entity ### EntityBase | Property | Type | Description | |---|---|---| | `name` | string | (en) Entity name, official name (pt) Razão Social Usage purpose: Calculation/Invoice | | `businessName` | string | (en) DBA, used to identify branches/subsidiaries with same name. (pt) Nome fantasia, usado para identificar filiais/subsidiárias com o mesmo nome. Usage purpose: Invoice | | `federalTaxId` | string | (en) CNPJ/CPF of Sales Buyer, if CPF pattern is '[0-9]{11}' if CNPJ pattern is '[0-9]{14}' (pt) CNPJ / CPF do comprador da venda, se o padrão do CPF for '[0-9] {11}' se o padrão do CNPJ for '[0-9] {14}' Usage purpose: Invoice | | `cityTaxId` | string | (en) City Tax ID (pt) ID do imposto municipal Usage Purpose: | Invoice | | `stateTaxId` | string | (en) State Tax ID (pt) Inscrição de imposto estadual Usage Purpose: | Invoice | | `suframa` | string | (en) Suframa ID (Manaus Free Trade Zone Superintendence). 8 to 9 digit code. (pt) SUFRAMA (Superintendência da Zona Franca de Manaus). Código de 8 à 9 dígitos. | | `phone` | string | (en) Entity Phone (pt) Telefone da entidade Usage purpose: Invoice | | `taxRegime` | FederalTaxRegime | | | `activitySector` | ActivitySector | | | `email` | string | (en) Entity Email (pt) E-mail da entidade Usage purpose: Invoice | | `subjectToPayrollTaxRelief` | boolean | (en) Subject to payroll exemption (pt) Sujeito à desoneração de folha de pagamento Usage purpose: Calculation | | `icmsTaxPayer` | boolean | (en) Informs if the entity is ICMS taxpayer (pt) Informa se a entidade é contribuinte do ICMS Usage Purpose: | Calculation/Invoice | | `pisFopag` | boolean | (en) PIS on Payroll (pt) O PIS sobre a folha de pagamento Usage purpose: Calculation | | `pisCofinsReliefZF` | boolean | (en) For outbound to Free Zone is optional to apply for tax relief, reducing from the total invoice amount the PIS/COFINS Tax Amount. (pt) Para saída para Zona Franca é facultativo o pedido de isenção tributária, reduzindo do valor total da fatura o Valor do PIS / COFINS. Usage purpose: Calculation | | `reduceIcmsTaxReliefToIPIBase` | boolean | (en) The company can interpret the -Resolucao n 1, de 2017- and it can reduce the ICMS tax relief amount to IPI base. (pt) A empresa pode em sua interpretação da Resolucao n 1, de 2017 decidir que pode reduzir a esoneração do ICMS da base do IPI. | ### LineForGoodsBase | Property | Type | Description | |---|---|---| | `lineCode` | integer | (en) This line item in the transaction (pt) Número da linha da transação por item Usage Purpose: Calculation/Invoice | | `itemCode` | string | (en) Item code inside ERP (pt) Código do item dentro do ERP Usage Purpose: Calculation/Invoice | | `itemDescription` | string | (en) This string captures the description of the item represented by this line (pt) Esta string captura a descrição do item representado por esta linha | | `itemDescriptor` | ItemGoodsDescriptor | | | `numberOfItems` | number | (en) Number of items. (pt) Número de itens. Usage Purpose: Calculation/Invoice | | `lineUnitPrice` | number | (en) Unit price. This decimal of 11 integers and 1 to 10 decimals captures the unit price of this line (pt) Valor unitário. Este decimal de 11 inteiros e 1 a 10 decimais captura o preço unitário desta linha Usage purpose: Calculation/Invoice | | `lineAmount` | number | (en) In its simplest form lineAmount = (item price * numberOfItems). If taxIncluded is 'true', lineAmount = (item price * numberOfItems + tax). (pt) Em sua forma mais simples, valor do item em linha = (preço do item * numberOfItems). Se taxIncluded for 'true', lineAmount = (preço do item * numberOfItems + imposto). Usage purpose: Calculation/Invoice | | `lineNetUnitPrice` | number | RESPONSE_PAYLOAD ONLY. (en) Cases where the calculation mode is "net". (pt) Casos onde o modo de cálculo é "net". Usage purpose: Calculation/Invoice | | `lineNetFigure` | number | RESPONSE_PAYLOAD ONLY (en) When the calculation mode is "GROSSVALUE", the "NETVALUE" is saved in this tag. (pt) Quando o modo de cálculo é "GROSSVALUE", o "NET" é salvo nesta tag. Usage purpose: Calculation/Invoice | | `lineTaxedDiscount` | number | (en) Discount amount by transaction line calculated. (pt) Valor do desconto por linha de transação calculada. Usage purpose: Calculation/Invoice | | `lineUntaxedDiscount` | number | (en) Discount conditional, This decimal 13 integers and 0 to 2 decimals (pt) Desconto incondicional, este decimal 13 inteiros e 0 a 2 decimais | | `lineUnitTaxablePrice` | number | | | `customProperties` | array | (en) List of extended custom properties (pt) Lista de propriedades personalizadas estendidas | | `useType` | UseType | | | `processScenario` | string | (en) Reference to process configurantion of this transaction, See ProcessScenario definition. This property is used only if eDocCreator=self or eDocCreator=others and eDocCreatorPerspective=true. (pt) Referência à configuração do processo desta transação, consulte a definição do ProcessScenario. Esta propriedade é usada apenas se eDocCreator =self ou eDocCreator =others e eDocCreatorPerspective=true. | | `operationTypeReceiptMap` | string | (en) Mapping table used to discover the CFOP when execute the Tax receipt in function of CFOP Received and Item Type. This property is used only if eDocCreator=others and eDocCreatorPerspective=false. (pt) Tabela de mapeamento utilizada para descobrir o CFOP ao executar o recebimento de Imposto na função de CFOP Recebido e Tipo de Item. Esta propriedade é usada apenas se eDocCreator = others e eDocCreatorPerspective = false. | | `freightAmount` | number | (en) Freight amount (pt) Valor do frete Usage Purpose: Calculation/Invoice/Do not apply for services | | `insuranceAmount` | number | (en) Insurance amount (pt) Valor do seguro Usage Purpose: Calculation/Invoice/Do not apply for services | | `otherCostAmount` | number | (en) Value of other costs (pt) Valor de outros custos Usage Purpose: Calculation/Invoice/Do not apply for services | | `isTransportIcmsWithheld` | boolean | (en) Informs that this item has ICMS withheld for transport value service. (pt) Informa que neste item há retenção de ICMS por valor de transporte de serviço. Usage Purpose: Calculation/Invoice | | `taxableQtUnit` | number | (en) Taxable quantity of the line. (pt) Quantidade tributável da linha Usage Purpose: Calculation/Invoice/Do not apply for services | | `icmsTaxRelief` | object | | | `unTaxedOtherCostAmount` | number | (en) This attribute is used to add amounts that are not considered in any tax base, but are added to otherCostAmount when generating the Invoice and compounds the totalInvoice. (pt) Este atributo é usado para adicionar valores que não são considerados em nenhuma base tributária, mas são adicionados a otherCostAmount na geração da Fatura e compõe o total da Fatura. | ### LineForGoods_di | Property | Type | Description | |---|---|---| | `customsValue` | number | (en) Customs value (II Block of NFe) (pt) Valor aduaneiro (II Block of NFe) Usage Purpose: Invoice | | `diNumber` | string | (en) Import declaration number, DI/DSI/DA/DRI-E (DI/DSI/DA/DRI-E) (pt) Número da declaração de importação, DI/DSI/DA/DRI-E(DI/DSI/DA/DRI-E) Usage Purpose: Invoice | | `registerDateDI` | string | (en) Registered date of import declaration number, DI/DSI/DA/DRI-E (DI/DSI/DA/DRI-E) (pt) Data registrada do número da declaração de importação, DI/DSI/DA/DRI-E(DI/DSI/DA/DRI-E) Usage Purpose: Invoice | | `clearanceSite` | string | (en) Clerance Site (pt) Local do desembaraço aduaneiro Usage Purpose: Invoice | | `clearanceState` | StateEnum | | | `clearanceDate` | string | (en) Clerance date (pt) Data do desembaraço aduaneiro Usage Purpose: Invoice | | `transportDIType` | string | (en) Transport type: - '1' # Maritime - '2' # Fluvial - '3' # Lacustrine - '4' # Air - '5' # Postcard - '6' # Railway - '7' # Highway - '8' # Conduit - '9' # Own Means - '10' # Input / Output Ficta - '11' # Courier - '12' # In Hands - '13' # By Trailer (pt) Tipos de transporte: - '1' # Maritima - '2' # Fluvial - '3' # Lacustre - '4' # Aerea - '5' # Postal - '6' # Ferroviaria - '7' # Rodoviaria - '8' # Conduto - '9' # Meios Proprios - '10' # Entrada/Saida Ficta - '10' # Entrada/Saida Ficta - '11' # Correio - '12' # Em Mãos - '13' # Por Reboque Usage Purpose: Invoice | | `afrmmValue` | number | (en) Special tax to merchant navy. (pt) Taxa especial para a marinha mercante. Usage Purpose: Calculation/Invoice/Do not apply for services | | `intermediateType` | string | (en/pt) - '1' # On One's Own [1-por conta propria] - '2' # On Behalf And Order [2-por conta e ordem] - '3' # Order [3-encomenda] Usage Purpose: Invoice | | `buyerFederalTaxID` | string | (en) Buyer federal tax id (pt) CNPJ do comprador ou encomendante Usage purpose: Invoice | | `buyerState` | StateEnum | | | `exporterCode` | string | (en) Exporter code (pt) Código exportador Usage Purpose: Invoice | | `adi` | array | (en) Additional import declaration (pt) Declaração de importação adicional Usage Purpose: Invoice | ### LineForGoods_export | Property | Type | Description | |---|---|---| | `drawbackNumber` | string | (en) Drawback number, format AAAANNNNNND when tax suspending, AANNNNNND when it is exemption (pt) O número do Ato Concessório de Suspensão deve ser preenchido com 11 dígitos (AAAANNNNNND) e o número do Ato Concessório de Drawback Isenção deve ser preenchido com 9 dígitos (AANNNNNND). (Observação incluída na NT 2013/005 v. 1.10) | | `indExport` | object | (en) Indirect exportation (pt) Exportação indireta Usage Purpose: Invoice | ### LineForGoods_taxByType | Property | Type | Description | |---|---|---| | `icms` | TaxByTypeTax | | | `icmsFCP` | TaxByTypeTax | | | `icmsSt` | TaxByTypeTax | | | `icmsStFCP` | TaxByTypeTax | | | `icmsStSd` | TaxByTypeTax | | | `icmsStSdFCP` | TaxByTypeTax | | | `icmsPart` | TaxByTypeTax | | | `icmsStPart` | TaxByTypeTax | | | `icmsStFCPPart` | TaxByTypeTax | | | `icmsDifaFCP` | TaxByTypeTax | | | `icmsDifaDest` | TaxByTypeTax | | | `icmsDifaRemet` | TaxByTypeTax | | | `icmsRf` | TaxByTypeTax | | | `icmsDeson` | TaxByTypeTax | | | `icmsCredsn` | TaxByTypeTax | | | `pis` | TaxByTypeTax | | | `pisSt` | TaxByTypeTax | | | `pisDeson` | TaxByTypeTax | | | `cofins` | TaxByTypeTax | | | `cofinsSt` | TaxByTypeTax | | | `cofinsDeson` | TaxByTypeTax | | | `cofinsSurcharge` | TaxByTypeTax | | | `ipi` | TaxByTypeTax | | | `ipiReturned` | object | | | `ii` | TaxByTypeTax | | | `iof` | TaxByTypeTax | | | `fust` | TaxByTypeTax | | | `funttel` | TaxByTypeTax | | | `aproxtribState` | TaxByTypeTax | | | `aproxtribFed` | TaxByTypeTax | | ### DetailsCalculatedTaxGoods_Item ### TaxByTypeTax | Property | Type | Description | |---|---|---| | `tax` | number | (en) Tax amount (pt) Valor do imposto Usage Purpose: Calculation/Invoice | ### Vehicle | Property | Type | Description | |---|---|---| | `tpOp` | integer | (en) - 1 # Sales by car dealership - 2 # Direct billing - 3 # Direct sales - 0 # Other (pt) - 1 # Vendas por concessionária de automóveis - 2 # Faturamento direto - 3 # Vendas diretas - 0 # outro Usage Purpose: Invoice | | `chassisNumber` | string | (en) Chassi number (pt) Número do Chassi Usage Purpose: Invoice | | `colorCode` | string | (en) Color code used by the factory (pt) Código de cores usado pela fábrica Usage Purpose: Invoice | | `colorName` | string | (en) Color name (pt) Nome da cor Usage Purpose: Invoice | | `cvPower` | string | (en) Power using CV unit (pt) Energia usando unidade CV Usage Purpose: Invoice | | `cylinderVolumCC` | string | (en) Engine size in cubic centimeters (pt) Tamanho do motor em centímetros cúbicos Usage Purpose: Invoice | | `netWeight` | string | (en) Net weight (pt) Peso líquido Usage Purpose: Invoice | | `grossWeight` | string | (en) Gross weight (pt) Peso bruto Usage Purpose: Invoice | | `serialNumber` | string | (en) Serial number (pt) Número de série Usage Purpose: Invoice | | `fuelType` | string | (en)Fuel type - '01' # Alcohol - '02' # Gas - '03' # Diesel - '16' # Alcohol/Gas - '17' # Gas/Alcohol/GNV - '18' # Gas/Electric (pt) Tipo de combustivel - '01' # Álcool - '02' # Gas - '03' # Diesel - '16' # Álcool/Gás - '17' # Gas/Álcool/GNV - '18' # Gás/Elétrico Usage Purpose: Invoice | | `engineNumber` | string | (en) Engine number (pt) Número do motor Usage Purpose: Invoice | | `cmt` | string | (en) Traction capacity, tonne (pt) Capacidade de tração, tonelada Usage Purpose: Invoice | | `lengthBetweenAxis` | string | (en) Length between axis (pt) Comprimento entre o eixo Usage Purpose: Invoice | | `modelYear` | string | (en) Model year (pt) Ano do modelo Usage Purpose: Invoice | | `manufactoryYear` | string | (en) Year of fabrication (pt) Ano de fabricação Usage Purpose: Invoice | | `paintType` | string | (en) Paint type (pt) Tipo da tinta Usage Purpose: Invoice | | `vehicleRENAVAMType` | string | (en) Vehicle renavam type (pt) Tipo do renavan do veiculo Usage Purpose: Invoice | | `specieRENAVAMType` | string | (en) Specie renavam type (pt) Espécie do tipo de renavam Usage Purpose: Invoice | | `modelRENAVAMCode` | string | (en) Renavam code (pt) Código renavam Usage Purpose: Invoice | | `colorDENATRANCode` | string | (en) - '01' # YELLOW - '02' # BLUE - '03' # BEIGE - '04' # WHITE - '05' # GRAY - '06' # GOLDEN - '07' # GRENA - '08' # ORANGE - '09' # BROWN - '10' # SILVER - '11' # BLACK - '12' # PINK - '13' # PURPLE - '14' # GREEN - '15' # RED - '16' # FANTASY (pt) - '01' # AMARELO - '02' # AZUL - '03' # BEGE - '04' # BRANCO - '05' # GREY - '06' # DOURADO - '07' # GRENA - '08' # LARANJA - '09' # MARROM - '10' # PRATA - '11' # PRETO - '12' # ROSA - '13' # ROXO - '14' # VERDE - '15' # VERMELHO - '16' # FANTASIA Usage Purpose: Invoice | | `vin` | string | (en) Chassis condition - original or modified (pt) Condição do chassis - original ou modificado(remarcado) Usage Purpose: Invoice | | `vehicleManufactoryStatus` | string | (en) - '1' # Finished(Done) - '2' # Not finished - '3' # Semi-finished (pt) - '1' # Concluído - '2' # Não concluído - '3' # Semi-acabado Usage Purpose: Invoice | | `maxOccupantsQuantity` | string | (en) Limited occupancy of sit occupants (pt) Ocupação limitada de ocupantes sentados Usage Purpose: Invoice | | `restrictionType` | string | (en) Line/restriction type - '0' # No one; - '1' # Alienação Fiduciária; - '2' # Arrendamento Mercantil; - '3' # Reserva de Domínio; - '4' # Penhor de Veículos; - '9' # Other. (pt) Linha/tipo de restrição - '0' # Ninguém; - '1' # Alienação Fiduciária; - '2' # Arrendamento Mercantil; - '3' # Reserva de Domínio; - '4' # Penhor de Veículos; - '9' # Outro. Usage Purpose: Invoice | ### Medicine | Property | Type | Description | |---|---|---| | `cProdANVISA` | string | (en) ANVISA (Brazilian Health Regulatory Agency) Code. Use the product registration number of the CMED (Medicine Market Regulation Chamber). (pt) Código de Produto da ANVISA (Agência Nacional de Vigilância Sanitária). Utilizar o número do registro do produto da Câmara de Regulação do Mercado de Medicamento – CMED. Usage Purpose: Invoice | | `maxValueToEndUser` | number | (en) Maximum price to end user. This is a decimal type with 15 digits including 2 decimal positions. (pt) Preço Máximo ao Consumidor final. Este é um tipo decimal com 15 dígitos incluindo 2 casas decimais. Usage Purpose: Invoice | | `exemptReason` | string | (en) For ANVISA-exempt drug, inform the number of the decision that exempts it, such as the number of the Resolution of the Board of Directors of ANVISA (RDC). (pt) Para medicamento isento de registro na ANVISA, informar o número da decisão que o isenta, como por exemplo o número da Resolução da Diretoria Colegiada da ANVISA (RDC). Usage Purpose: Invoice | ### Weapon | Property | Type | Description | |---|---|---| | `weaponRestrictionType` | string | (en) - '0' # restrict use - '1' # public use (pt) - '0' # uso restrito - '1' # uso público Usage Purpose: Invoice | | `serieNumber` | string | (en) Serial number (pt) Número de serie Usage Purpose: Invoice | | `gunBarrelSerieNumber` | string | (en) Barrel's serial number (pt) Número de série do cano Usage Purpose: Invoice | | `weaponDescription` | string | (en) Weapon description (pt) Descrição da arma Usage Purpose: Invoice | ### Fuel | Property | Type | Description | |---|---|---| | `prodANPCode` | string | | | `descANP` | string | (en) Product Description as ANP. Use the Product Description of the Product Movement Information System - - SIMP (http://www.anp.gov.br/simp/). (pt) Descrição do Produto conforme ANP. Utilizar a descrição de produtos do Sistema de Informações de Movimentação de Produtos - SIMP (http://www.anp.gov.br/simp/). Usage Purpose: Invoice | | `pGLP` | number | (en) Percentage of LPG derived from petroleum in the LPG product. 3 Integers 4 descimal max 100. (pt) Percentual do GLP derivado do petróleo no produto GLP (cProdANP=210203001). Informar em número decimal o percentual do GLP derivado de petróleo no produto GLP. Valores 0 a 100. Usage Purpose: Invoice | | `pGNn` | number | (en) Percentage of national natural gas - GLGNn for LPG product. 3 Intergers 4 descimal max 100. (pt) Percentual de gás natural nacional - GLGNn para o produto GLP (cProdANP=210203001). Informar em número decimal o percentual do Gás Natural Nacional - GLGNn para o produto GLP. Valores de 0 a 100. Usage Purpose: Invoice | | `pGNi` | number | (en) Percentage of imported natural gas GLGNi for the LPG product 3 Intergers 4 descimal max 100. (pt) Percentual de gás natural importado GLGNi para o produto GLP (cProdANP=210203001). Informar em número deciaml o percentual do Gás Natural Importado - GLGNi para o produto GLP. Valores de 0 a 100. Usage Purpose: Invoice | | `vPart` | number | (en) Starting value (cProdANP = 210203001). The amount per kilogram without ICMS must be reported in this field. 13 Integers and 2 decimals. (pt) Valor de partida (cProdANP=210203001). Deve ser informado neste campo o valor por quilograma sem ICMS. Usage Purpose: Invoice | | `authorizationCodeCODIF` | string | (en) Cofid authorization code (pt) Código de autorização do cofid Usage Purpose: Invoice | | `quantityOnRoomTemperature` | number | (en) This decimal 12 Integers and 0 to 4 decimals. Amount of fuel billed at room temperature. Informs when the invoiced quantity entered in the qCom field (I10) has been adjusted to a temperature different than the environment's temperature. (pt) Este decimal 12 inteiros e 0 a 4 decimais. Quantidade de combustível faturada à temperatura ambiente. Informa quando a quantidade faturada informada no campo qCom (I10) tiver sido ajustada para uma temperatura diferente da ambiente. Usage Purpose: Invoice | | `stateCodeOfUndUser` | StateEnum | | | `cide` | object | (en) Percentage of natural gas in quantity (pt) Percentual de gás natural em quantidade Usage Purpose: Invoice | | `pumpNumber` | object | | ### ItemGoodsDescriptor | Property | Type | Description | |---|---|---| | `code` | string | (en) ERP Code (pt) Código ERP | | `description` | string | (en) Item Description (pt) Descrição do item | | `agastCode` | string | (en) Goods Agast code for this item, the Goods AGAST code has Federal Jurisdiction. (pt) Código Agast de Mercadorias para este item, o código AGAST de Mercadorias tem Jurisdição Federal. | | `hsCode` | string | (en) (HC) Harmonized code for goods or LC116 code for services. (pt) Código NCM ou código de serviço de acordo com a LC116. Usage purpose: Calculation/Invoice | | `ex` | integer | (en) hsCode Exception for IPI tax (pt) Exceção do hsCode para imposto IPI Usage Purpose: Calculation/Invoice | | `cest` | string | (en) Tax substitution classification code. (pt) Código classificador de substituição tributária. Usage Purpose: Calculation/Invoice/Do not apply for services | | `cean` | string | (en) GTIN NUMBER (Global Trade Item Number) (pt) Número GTIN (número de item comercial global) Usage purpose: Calculation/Invoice | | `ceanTax` | string | (en) GTIN (Global Trade Item Number) of taxable unit. (pt) GTIN (número de item comercial global) da unidade tributável. Usage purpose: Calculation/Invoice | | `cBar` | string | (pt) Código de Barras próprio ou de terceiros, que seja diferente do padrão GTIN, para que um contribuinte possa informar simultaneamente o código de barras utilizado por seu fornecedor e o seu (do contribuinte) código interno. (en) Own or third party Bar Code, which is different from the GTIN standard, so that a taxpayer can simultaneously inform the bar code used by his supplier and his (the taxpayer's) internal code. | | `cBarraTrib` | string | (pt) Código de Barras da unidade tributável que seja diferente do padrão GTIN, Código de Barras próprio ou de terceiros, que seja diferente do padrão GTIN, correspondente àquele da menor unidade comercializável identificado por Código de Barras. (en) Barcode of the taxable unit that is different from the GTIN standard, own or third party Barcode, which is different from the GTIN standard, corresponding to that of the smallest tradable unit identified by Barcode. | | `specialProductClass` | SpecialProductClassEnum | | | `nveList` | array | (en) NVE - extension code for customs and statistical Value Nomenclature. (pt) Nomenclatura de Valor aduaneiro e Estatístico. Usage purpose: Calculation/Invoice/Do not apply for services | | `nve` | string | (en) NVE - extension code for customs and statistical Value Nomenclature. (pt) Nomenclatura de Valor aduaneiro e Estatístico. Usage purpose: Calculation/Invoice/Do not apply for services | | `unit` | string | (en) Sales unit measure - 'kg' # Kg - 'kgg' # gross Kg - 'l' # Liter - 'ti' # TI - index of radioactive transport - 'units' (pt) Unidade de medida de vendas - 'kg' # Kg - 'kgg' # kg bruto - 'l' # litro - 'ti' # TI - índice de transporte radioativo - 'unidades' Usage purpose: Calculation/Invoice/Do not apply for services | | `package` | string | (en) Packaging, this attribute can be a parameter to discover ICMS-ST amount by SRP. (pt) Embalagem, este atributo pode ser um parâmetro para descobrir o valor do ICMS-ST pelo SRP. | | `isIcmsStSubstitute` | boolean | (en) ICMS substitute flag identifies wholesaler, retailer, distributor role. (pt) Indica empresa sujeita ao ICMS ST por substituto tributário (distribuidor, varejista e atacadista). Usage Purpose: Calculation/Invoice | | `source` | ItemSourceGoodsEnum | | | `productType` | SpedFiscalProductType | | | `manufacturerEquivalent` | boolean | (en) Item is merchandise but will be considered a product. (pt) O item é mercadoria, mas será considerado um produto Usage Purpose: Calculation | | `notSubjectToIcmsSt` | boolean | (en) Item is not subject to ICMS ST, even though it has CEST, example fixed asset, used products like cars (pt) Item não sujeito ao ICMS ST, mesmo tendo um CEST associado a ele, exemplo, venda de ativo ou revenda de itens usados como carros. Usage purpose: Calculation | | `sealCode` | string | (en) Seal Code for IPI tax control. (pt) Código do selo para controle de IPI. Calculation Invoice | | `nFCI` | string | (en) Importation content form number (pt) Número de controle da FCI - Ficha de Conteúdo de Importação | | `pCredSN` | number | (en) ICMS rate for company that is tax regime simplified. (pt) Alíquota de ICMS caso a empresa seja optante do simples. Usage purpose: Calculation/Invoice | | `appropriateIPIcreditWhenInGoing` | boolean | (en) Informs that this item will have rights to appropriate IPI credit (pt) Informa que este item terá direito ao crédito de IPI apropriado | | `appropriateICMScreditWhenInGoing` | boolean | (en) Informs that this item will have rights to aprropriate ICMS credit (pt) Informa que este item terá direito ao crédito de ICMS apropriado | | `usuallyAppropriatePISCOFINSCredit` | boolean | (en) Subject to appropriate PIS/COFINS credit, when NO CUMULATIVE (pt) Sujeito ao devido crédito de PIS / COFINS, quando NÃO CUMULATIVO | | `isPisCofinsEstimatedCredit` | boolean | (en) The credit PIS/COFINS is subject to purchase from companies, but exist some exceptions, when the credit will be an estimated amount # see http://www.portaltributario.com.br/artigos/credito-presumido-pis-cofins-origem-animal.htm. (pt) O crédito do PIS / COFINS está sujeito à aquisição de empresas, mas existem algumas exceções, quando o crédito será de valor estimado # ver http://www.portaltributario.com.br/artigos/credito-presumido-pis-cofins-origem -animal.htm. Usage Purpose: Calculation | | `piscofinsRevenueType` | PisCofinsRevenueType | | | `unitIPIfactor` | number | (en) Factor to convert sales quantity to IPI taxable quantity when it is by SRF Statutory Retail Price (Pauta). (pt) Fator de conversão da quantidade vendida em quantidade tributável de IPI quando for pelo Preço Legal de Revenda SRF (Pauta). Usage Purpose: Calculation/Invoice/Do not apply for services | | `unitIcmsfactor` | number | (en) Factor to convert sales quantity to ICMS taxable quantity when it is by SRF Statutory Retail Price (Pauta). (pt) Fator para converter a quantidade vendida em quantidade tributável de ICMS quando for pelo Preço Legal de Varejo SRF (Pauta). Usage Purpose: Calculation/Invoice/Do not apply for services | | `unitIcmsStfactor` | number | (en) Factor to convert sales quantity to ICMS-ST taxable quantity when it is by SRF Statutory Retail Price (Pauta). (pt) Fator para converter a quantidade vendida em quantidade tributável de ICMS-ST quando for pelo Preço Legal de Varejo SRF (Pauta). Usage Purpose: Calculation/Invoice/Do not apply for services | | `unitPisCofinsfactor` | number | (en) Factor to convert sales quantity to PIS/COFINS taxable quantity when it is by SRF Statutory Retail Price (Pauta). (pt) Fator para converter a quantidade vendida em quantidade tributável de PIS/COFINS quando for pelo Preço Legal de Varejo SRF (Pauta). Usage Purpose: Calculation/Invoice/Do not apply for services | | `comexTaxUnitFactor` | number | (en) Factor to convert sales quantity to comexTaxUnit (pt) Fator para converter a quantidade de vendas em comexTaxUnit Usage purpose: Calculation/Invoice/Do not apply for services | | `iiExTaxCode` | string | (en) NCM exception for import operations (pt) Exceção de NCM para operações de importação Usage Purpose: Calculation | | `ignoreOtherCostOnImportationIpiBase` | boolean | (en) Indicator to ignore other costs importation of IPI calculation base (pt) Indicador para ignorar outros custos de importação na base de cálculo do IPI Usage Purpose: Calculation | | `glAccountCode` | string | (en) GL accounting code (pt) Código da conta contábil Usage purpose: Calculation/Invoice | | `propertyName` | string | (en) Item property name (pt) Nome da propriedade do item | | `propertyValue` | string | (en) Item property value (pt) Valor da propriedade do item | | `properties` | array | (en) Properties detail (pt) Detalhe de propriedades | ### LineForGoods_properties | Property | Type | Description | |---|---|---| | `name` | string | (en) Property name, for example usagePurpose (pt) Nome da propriedade, por exemplo usagePurpose | | `value` | string | (en) Value to this property The attribute can be used to identify an Avalara TaxCode or to define a specialization at useType property when the property usagePurpose has one of this values: - 'on-demand by contract' # USED FOR ENERGY - 'use or consumption of fuel transaction type exportation' - 'use or consumption on services subject to ISS' - 'use or consumption on services subject to ICMS' - 'resale export' # usado na devolução de mercadoria que tem como finalidade exportação - 'resale icms exempt' - 'resale buyer under the same icmsSt tax rule' - "transport of goods that don't need an invoice (nf)" (pt) Valor para esta propriedade O atributo pode ser usado para identificar um Avalara TaxCode ou para definir um especialização na propriedade useType quando a propriedade usagePurpose tem um desses valores - 'sob demanda por contrato' # USADO PARA ENERGIA - 'exportação de tipo de transação de uso ou consumo de combustível' - 'uso ou consumo em serviços sujeitos a ISS' - 'uso ou consumo em serviços sujeitos a ICMS' - 'exportação de revenda' # usado na devolução de mercadoria que tem como exportação - 'isenção de icms de revenda' - 'comprador de revenda sob a mesma regra de imposto icmsSt' - "transporte de mercadorias que não necessitem de nota fiscal (nf) | ### DetailsCalculatedTaxGoods | Property | Type | Description | |---|---|---| | `locationType` | string | (en) This string captures the applicable location type. Location of the buyer/seller is used for calculation purposes. (pt) Esta string captura o tipo de local aplicável. A localização do comprador/vendedor é usada para fins de cálculo. | | `jurisdictionName` | string | (en) Jurisdiction used to calculate the tax amount. (pt) Jurisdição usada para calcular o valor do imposto. | | `jurisdictionType` | string | (en) Type of jurisdiction - 'City' - 'State' - 'Country' (pt) Tipo de jurisdição - 'Cidade' - 'Estado' - 'País' | | `taxImpact` | DetailsCalculatedTaxImpact | | | `taxType` | string | Identificador do tipo de imposto/Tax type identifier - 'icms' (en) Tax on operations related to the circulation of Goods and Services of Interstate and Inter-municipal Transport, and Communication Services. (pt) Imposto sobre Operações relativas à Circulação de Mercadorias e sobre Prestações de Serviços de Transporte Interestadual e Intermunicipal e de Comunicação. - 'icmsFCP' (en) FCP (Fund to Combat the Poverty) is a complement to the ICMS, levied on commercial transactions, in accordance with the legislation of each state. (pt) O FCP (Fundo de Combate à Pobreza) é um complemento do ICMS, incidindo sobre transações comerciais, de acordo com a legislação de cada estado. - 'icmsSt' (en) ICMS due for tax substitution (when the ICMS is fully paid in advance, and it is not necessary to charge it again in future transactions of goods.) (pt) ICMS devido por substituição tributária (quando o ICMS é pago em seu valor total de forma antecipada, não sendo necessário cobrá-lo novamente em próximas transações de uma mercadoria.). - 'icmsStFCP' (en) ICMS complement (FCP - Fund to Combat the Poverty) related to Tax Substitution. (pt) Complemento do ICMS (FCP - Fundo de Combate à pobreza) relativo à Substituição Tributária. - 'icmsPart' (en) ICMS sharing. (pt) Partilha de ICMS. - 'icmsStPart' (en) ICMS due for tax substitution with ICMS sharing. (pt) ICMS devido por substituição tributária com partilha de ICMS. - 'icmsStFCPPart' (en) ICMS complement (FCP - Fund to Combat the Poverty) related to Tax Substitution with ICMS sharing. (pt) Complemento do ICMS (FCP - Fundo de Combate à pobreza) relativo à Substituição Tributária com partilha de ICMS. - 'icmsStSd' (en) ICMS related to tax substitution in the Substitution condition (CST 60). (pt) ICMS relativo à substituição tributária na condição de Substituído (CST 60). - 'icmsStSdFCP' (en)ICMS related to tax substitution in the Substitution condition (CST 60) with additional FCP to the ICMS. (pt)ICMS relativo à substituição tributária na condição de Substituído (CST 60) com adicional FCP ao ICMS. - 'icmsDifaFCP' (en) ICMS Difal (ICMS rate differential, when the purchase of goods/services is interstate;) is the Tax on the Circulation of Goods and Services with additional FCP to the ICMS. (pt) ICMS Difal (Diferencial de alíquota do ICMS, quando a compra da mercadoria/serviço é feita de forma interestadual) é o Imposto sobre Circulação de Mercadorias e Serviços com adicional FCP ao ICMS. - 'icmsDifaDest' (en) ICMS rate differential attributed to the final consumer recipient. (If the recipient is a non-taxpayer, then he is necessarily a final consumer and then there will be ICMS dest, in which the calculation is basically the difference in rates. If the recipient is a taxpayer, there will be no ICMS dest.) (pt) Diferencial de alíquota do ICMS atribuída ao destinatário consumidor final. (Se o destinatário é não-contribuinte, então necessariamente é consumidor final e então haverá ICMS dest, em que o cálculo é basicamente a diferença de alíquotas. Se o destinatário é contribuinte, não haverá ICMS dest.) - 'icmsDifaRemet' (en) ICMS rate differential attributed to the sender. (The responsibility for collection is assigned to the sender when the recipient is not a tax payer.) (pt) Diferencial de alíquota do ICMS atribuída ao remetente. (A responsabilidade pelo recolhimento é atribuída ao remetente, quando o destinatário não for contribuinte do imposto.) - 'icmsRf' (en) ICMS to be withheld over Service Freight value. (pt) ICMS a ser retido sobre o valor do Serviço de Frete. - 'icmsDeson' (en) ICMS tax relief, consists of a tax discount corresponding to the amount of tax waived in exempt, non-taxed or suspended operations, where all ICMS is exempted. (pt) O ICMS desonerado consiste em um desconto tributário correspondente ao valor do imposto dispensado nas operações com redução de base, isentas, não tributadas ou suspensas, onde todo o ICMS é desonerado. - 'icmsCredsn' (en) The ICMS credit system allows tax compensation (guarantees the right to credit the tax that was previously charged on operations involving the entry of goods to those who receive the goods or products) for those opting for the Simples Nacional regime, a tax regime exclusive for micro and small companies. (pt) O sistema de crédito do ICMS permite que haja compensação do imposto (garante a àquele que recebe as mercadorias ou produtos o direito de se creditar do imposto que foi anteriormente cobrado em operações envolvendo a entrada de mercadorias) aos optantes do regime Simples Nacional, regime tributário exclusivo para micro e pequenas empresas. - 'icmsEff' (en) The Effective ICMS is the reimbursement of the difference in the amount paid (if it is the highest) by the industry, when sold to the final consumer. (pt) O ICMS Efetivo é o ressarcimento da diferença do valor pago (caso for a maior) pela indústria, quando vendido para consumidor final. - 'icmsOwnPayer' (en) ICMS of the substitute charged in a previous operation. This amount is only received, it is not calculated. (pt) ICMS próprio do substituto cobrado em operação anterior. Este valor é apenas recebido, não é calculado. - 'pis' (en) Social Integration Program (pt) Programa de Integração Social - 'pisRf' (en) Process of withholding PIS at source for taxes involving legal entities. (CST 5979) (pt) Processo de retenção do PIS na fonte para tributos que envolvem pessoa jurídica. (CST 5979) - 'pisSt' (en) PIS due for tax substitution. (pt) PIS devido por substituição tributária. - 'pisDeson' (en) PIS tax relief. (pt) PIS desonerado. - 'cofins' (en) Contribution to Social Security Financing. (pt) Contribuição para o Financiamento da Seguridade Social. - 'cofinsRf' (en) COFINS withholding process for taxes involving legal entities. (CST 5960) (pt) Processo de retenção do COFINS na fonte para tributos que envolvem pessoa jurídica. (CST 5960) - 'cofinsSt' (en) COFINS due for tax substitution. (pt) COFINS devido por substituição tributária. - 'cofinsDeson' (en) COFINS tax relief. (pt) COFINS desonerado. - 'cofinsSurcharge' (en) COFINS SURCHARGE tax (pt) Imposto COFINS SURCHARGE - 'csllRf' (en) CSLL withholding for taxes involving legal entities. (CST 5987). (pt) CSLL retido na fonte para tributos que envolvem pessoa jurídica. (CST 5987). - 'irrf' (en) Withholding income tax. This is a tax liability for the Federal Revenue and is charged from individuals (PF) and legal entities (PJ). (pt) Imposto de Renda Retido na Fonte. Essa é uma obrigação tributária destinada à Receita Federal e é cobrada de pessoas físicas (PF) e pessoas jurídicas (PJ). - 'cprb' (en) Social Security Contribution on Gross Revenue. It is based on the Article 195 of the Federal Constitution. It states: “social security will be financed by the whole society, directly and indirectly, under the terms of the law”. (pt) Contribuição Previdenciária sobre a Receita Bruta. É baseada no artigo 195 da Constituição Federal. Nela, afirma-se: “a seguridade social será financiada por toda a sociedade, de forma direta e indireta, nos termos da lei”. - 'cprbRf' (en) CPRB withholding process. (pt) Processo de retenção do CPRB na fonte. - 'inssAr' (en) INSS to be collected. In MEI services, for example, INSS is not withheld but 20% must be collected. (pt) INSS a Recolher. Em tomadas de serviço de MEI por exemplo, não se retêm INSS, mas 20% deve ser recolhido. - 'inssRf' (en) INSS withholding process. (pt) Processo de retenção do INSS na fonte. - 'iss' (en) Tax over services. It is a tax applicable to companies and self-employed professionals who provide services. (pt) Imposto sobre Serviços. É um tributo aplicável a empresas e profissionais autônomos que realizam prestação de serviços. - 'issRf' (en) ISS withholding process. (pt) ISS retido na fonte. - 'ipi' (en) Taxes over industrialized products. (pt) Imposto sobre Produtos Industrializados. - 'ipiReturned' (en) IPI returned. (pt) IPI devolvido. - 'ii' (en) Tax on the importation of foreign products and is levied on the importation of foreign goods and on the luggage of travelers coming from abroad. In the case of foreign goods, the calculation basis is the customs value and the rate is indicated in the Common External Tariff (TEC). (pt) Imposto sobre a importação de produtos estrangeiros e incide sobre a importação de mercadorias estrangeiras e sobre a bagagem de viajante procedente do exterior. No caso de mercadorias estrangeiras, a base de cálculo é o valor aduaneiro e a alíquota está indicada na Tarifa Externa Comum (TEC). - 'iof' (en) Financial transaction tax. This tax is levied on financial operations such as credit, exchange, and insurance. (pt) Imposto sobre Operações Financeiras. Esse imposto é cobrado em operações financeiras como crédito, câmbio e seguros. - 'fust' (en) Fund for the Universalization of Telecommunications Services. Its purpose is to bring telephony and internet access to isolated regions, with inadequate or non-existent infrastructure. (pt) Fundo de Universalização dos Serviços de Telecomunicações. Tem a finalidade de levar acesso à telefonia e internet para regiões isoladas, com infraestrutura inadequada ou inexistente. - 'funttel' (en) Fund for the Technological Development of Telecommunications. It is an accounting fund with the objective of stimulating the process of technological innovation, encouraging the training of human resources, fostering job creation and promoting access to resources for small and medium-sized companies. (pt) Fundo para o Desenvolvimento Tecnológico das Telecomunicações. É um fundo de natureza contábil com o objetivo de estimular o processo de inovação tecnológica, incentivar a capacitação de recursos humanos, fomentar a geração de empregos e promover o acesso de pequenas e médias empresas a recursos. - 'aproxtrib' (en) Approximate Tax Value is the information on the average value of taxes that influence the price of a product or service. (pt) Valor aproximado dos Tributos é a informação sobre o valor médio dos impostos que influenciam o preço de um produto ou serviço. - 'aproxtribCity' (en) Approximate value of Municipal Taxes. (pt) Valor aproximado dos Tributos Municipais. - 'aproxtribState' (en) Approximate value of State Taxes. (pt) Valor aproximado dos Tributos Estaduais. - 'aproxtribFed' (en) Approximate value of Federal Taxes. (pt)Valor aproximado dos Tributos federais. - aproxtrib (en) Approximate value of Taxes. (pt) Valor aproximado de tributos. Usage purpose: Calculation/Invoice/Do not apply for services | | `rateType` | string | (en) Name of the configuration rate (pt) Nome da taxa de configuração | | `scenario` | string | (en) This string captures the transaction scenario used to calculate this tax. Scenarios are specific to each tax type. This field provides information about how the tax engine interpreted the transaction information that was passed in. (pt) Esta string captura o cenário da transação usado para calcular esse imposto. Os cenários são específicos para cada tipo de imposto. Este campo fornece informações sobre como o mecanismo fiscal interpretou as informações da transação que foram repassadas. | | `scenarioCode` | string | (en) Legal Reason Code for this tax scenario (pt) Código de razão legal para este cenário fiscal | | `subtotalTaxable` | number | (en) This decimal captures how much of the lineAmount was taxable by this tax, calc base. (pt) Este decimal captura quanto do valor do item (em linha) era tributável para esse imposto, base de cálculo. Usage Purpose: Calculation/Invoice/Do not apply for services | | `rate` | number | (en) Tax rate (pt) Alíquota Usage Purpose: Calculation/Invoice | | `tax` | number | (en) Tax amount (pt) Valor do imposto Usage Purpose: Calculation/Invoice | | `legalReason` | string | (en) Legal reason for this tax scenario (pt) Razão legal para este cenário fiscal | | `significantLocations` | array | (en) This element captures the list of locations that contributed to the tax determination. The address of the buyer and seller is needed for the service. (pt) Este elemento captura a lista de locais que contribuíram para a determinação do imposto. O endereço do comprador e do vendedor é necessário para o serviço. | | `taxRuleType` | string | (en) This string has the type of rule (pt) Esse campo possui o tipo de regra | | `exemptionCode` | string | (en) Benefit Code, official (pt) Código de benefício (oficial) | | `traceCode` | string | (en) Trace code with the reason for this result. (pt) Código de rastreamento com o motivo para esse resultado. | ### TaxByTypeSummaryForGoods (en) Summary of all taxes (pt) Resumo de todos os impostos | Property | Type | Description | |---|---|---| | `calcBase` | number | (en) Summary of all lines calcBase (pt) Resumo de todas as linhas de base de cálculo | | `tax` | number | (en) Tax amount. (pt) Valor do imposto. Usage Purpose: Calculation/Invoice | | `jurisdictions` | array | | ### TaxByTypeSummaryJurisdictionForGoods | Property | Type | Description | |---|---|---| | `jurisdictionName` | string | (en) Jurisdiction used for calctax amount (pt) Jurisdição usada para quantidade de cálculo | | `jurisdictionType` | string | (en) Type of jurisdiction - 'City' - 'State' - 'Country' (pt) Tipo de jurisdição - 'Cidade' - 'Estado' - 'País' | | `tax` | number | (en) Tax amount. (pt) Valor do imposto. Usage Purpose: Calculation/Invoice | ### eInvoiceReturnStatus | Property | Type | Description | |---|---|---| | `desc` | string | | | `code` | string | | | `protocol` | string | | | `nfseNumber` | string | | | `nfseVerifyCode` | string | | | `authorizationDateTime` | string | | ### manifestReturnStatus | Property | Type | Description | |---|---|---| | `desc` | string | | | `code` | string | | ### sendManifestReturnObj | Property | Type | Description | |---|---|---| | `key` | string | | | `subscriptionId` | string | | | `eventType` | string | | | `status` | object | | | `pdf` | eInvoiceReturnObj | | | `xml` | eInvoiceReturnObj | | ### getManifestReturnObj | Property | Type | Description | |---|---|---| | `status` | manifestReturnStatus | | | `manifests` | array | | | `xml` | eInvoiceReturnObj | | | `json` | object | | ### eInvoiceReturnObj | Property | Type | Description | |---|---|---| | `base64` | string | | | `link` | string | | | `cityLink` | string | | | `s3Key` | string | | ### eInvoiceReturnPdf | Property | Type | Description | |---|---|---| | `status` | eInvoiceReturnStatus | | | `pdf` | eInvoiceReturnObj | | ### eInvoiceReturnXml | Property | Type | Description | |---|---|---| | `status` | eInvoiceReturnStatus | | | `xml` | eInvoiceReturnObj | | ### eInvoiceReturnAll | Property | Type | Description | |---|---|---| | `status` | eInvoiceReturnStatus | | | `pdf` | eInvoiceReturnObj | | | `xml` | eInvoiceReturnObj | | ### eServiceReturnGet ### ImportXmlInvoice | Property | Type | Description | |---|---|---| | `xml` | string | | | `json` | object | | ### ParseXmlInvoice | Property | Type | Description | |---|---|---| | `xml` | string | | | `type` | string | | ### SefazDisablementIn | Property | Type | Description | |---|---|---| | `model` | string | | | `serie` | integer | Invoice number, sequential unique by invoice serial (Número da nota fiscal) | | `companyLocation` | string | (en) This string contains a previously configured company code which may also have codes needed for tax return purposes. These codes are maintained through the customer portal. Main company address identity. (pt) Esta string contém um código de empresa configurado anteriormente que também pode ter códigos necessários para fins de declaração de impostos. Esses códigos são mantidos por meio do portal do cliente. Identidade do endereço principal da empresa. | | `message` | string | | | `init` | number | (en) The first number of disabled range (pt) O primeiro número do intervalo desativado | | `end` | number | (en) Last number of disabled range (pt) O último número do intervalo desativado | ### SefazItPutIn | Property | Type | Description | |---|---|---| | `seq` | number | | | `message` | string | | | `timeZone` | string | | ### SefazItDeleteIn | Property | Type | Description | |---|---|---| | `message` | string | | | `timeZone` | string | | ### NFSENumber | Property | Type | Description | |---|---|---| | `nfseNumber` | number | | ### SefazItManifestIn | Property | Type | Description | |---|---|---| | `code` | string | (en) - '210200' # 'Operation Confirmation', - '210210' # 'Ciencia da Operacao', - '210220' # 'Unaware of the Operation', - '210240' # 'Operation not performed' (pt) - '210200' # 'Confirmacao da Operacao', - '210210' # 'Ciencia da Operacao', - '210220' # 'Desconhecimento da Operacao', - '210240' # 'Operacao nao Realizada' | | `seq` | number | | | `message` | string | | | `timeZone` | string | | ### SefazPostponeIn | Property | Type | Description | |---|---|---| | `code` | string | (en) - '111500' # 'Event requested extension 1. deadline', - '111501' # 'Event requested for 2nd extension. deadline', - '111502' # 'Event Cancellation of 1st Extension Request. Deadline', - '111503' # '2 ° Extension Request Cancellation Event. Deadline' (pt) - '111500' # 'Evento pedido de prorrogação 1º. prazo', - '111501' # 'Evento pedido de prorrogação 2º. prazo', - '111502' # 'Evento Cancelamento de Pedido de Prorrogação 1º. Prazo', - '111503' # 'Evento Cancelamento de Pedido de Prorrogação 2°. Prazo' | | `message` | string | | | `timeZone` | string | | | `postponeItems` | array | | | `eventProtocol` | string | (en) A number of the Authorization Protocol for the Extension Request to be canceled. Mandatory to inform for the event of cancellation of extension request (111502 or 111503). (pt) Número do Protocolo de Autorização do Pedido de Prorrogação a ser cancelado. Obrigatório informar para evento de cancelamento de pedido de prorrogação (111502 ou 111503). | ### TransactionInvoiceForGoods | Property | Type | Description | |---|---|---| | `header` | HeaderInvoiceForGoods | | | `lines` | array | | | `summary` | SummaryInvoiceForGoods | | | `processingInfo` | ProcessingInfo | | | `version` | string | (en) Payload Model Version (pt) Versão modelo do payload | ### SefazOutboundReportIn | Property | Type | Description | |---|---|---| | `datetimeOutbound` | string | | | `stateCode` | StateEnum | | | `licensePlate` | string | | ### PostponeItems | Property | Type | Description | |---|---|---| | `itemNumber` | number | (en) The item number of the NF-e. Mandatory to inform for extension request event (111500 or 111501). (pt) Número do item da NF-e. Obrigatório informar para evento de pedido de prorrogação (111500 ou 111501). | | `itemQuantity` | number | (en) Quantity of the item you want to extend. Mandatory to inform for extension request event (111500 or 111501). (pt) Quantidade do item que deseja prorrogar. Obrigatório informar para evento de pedido de prorrogação (111500 ou 111501). | ### InvoiceData | Property | Type | Description | |---|---|---| | `invoiceModel` | string | | | `invoiceNumber` | string | | | `invoiceSerie` | string | | | `invoiceKey` | string | | | `invoiceProtocol` | string | | | `status` | eInvoiceReturnStatus | | | `nfseNumber` | string | | | `nfseVerifyCode` | string | | | `pdf` | eInvoiceReturnObj | | | `xml` | eInvoiceReturnObj | | ### InterestedActor | Property | Type | Description | |---|---|---| | `authorState` | StateEnum | | | `authorType` | string | (en) Authorization role for the transaction 1 = Generation of the Event by the Issuer; 2 = Generation of the Event by the Recipient; 3 = Generation of the Event by the Carrier (pt) Papel do Autorizador na transação 1=Geração do Evento pelo Emitente; 2=Geração do Evento pelo Destinatário; 3=Geração do Evento pelo Transportador | | `federalTaxId` | string | (en) CNPJ/CPF of Sales Buyer, if CPF pattern is '[0-9]{11}' if CNPJ pattern is '[0-9]{14}' (pt) CNPJ/CPF do comprador da venda, se o padrão do CPF for '[0-9] {11}' se o padrão do CNPJ for '[0-9] {14}' Usage purpose: Invoice | | `authorizationType` | string | (en) Authorization type - '0' # It is not allowed to re-pass the permission - '1' # It is allowed to re-pass the permission (pt) Tipo de autorização - '0' # Não permite repassar a permissão - '1' # Permite o transportador repassar a permissão | ### NFeDeliveryReceiptIn | Property | Type | Description | |---|---|---| | `companyLocation` | string | (en) This string contains a previously configured company code which may also have codes needed for tax return purposes. These codes are maintained through the customer portal. Main company address identity. (pt) Essa string contém um código de empresa configurado anteriormente que também pode ter códigos necessários para fins de declaração de imposto. Esses códigos são mantidos através do portal do cliente. Identidade do endereço principal da empresa. | | `seq` | number | | | `dateTime` | string | (en) Event Date and Time, UTC format (YYYY-MM-DDThh:mm:ssTZD). (pt) Data e Hora do Evento, formato UTC (AAAA-MM-DDThh:mm:ssTZD). | | `evCENFe` | object | | ### NFeCancelDeliveryReceiptIn | Property | Type | Description | |---|---|---| | `companyLocation` | string | (en) This string contains a previously configured company code which may also have codes needed for tax return purposes. These codes are maintained through the customer portal. Main company address identity. (pt) Essa string contém um código de empresa configurado anteriormente que também pode ter códigos necessários para fins de declaração de imposto. Esses códigos são mantidos através do portal do cliente. Identidade do endereço principal da empresa | | `seq` | number | | | `dateTime` | string | (en) Event Date and Time, UTC format (YYYY-MM-DDThh:mm:ssTZD) (pt) Data e Hora do Evento, formato UTC (AAAA-MM-DDThh:mm:ssTZD) | | `evCancNFe` | object | | ### NFeDeliveryFailureEv | Property | Type | Description | |---|---|---| | `seq` | number | | | `descEvento` | string | (en) Event code 110192 - Failure to deliver the NF-e (pt) Código do evento 110192 - Insucesso na Entrega da NF-e Usage purpose: Invoice | | `dhAttemptedDelivery` | string | (en) Date and time of attempted delivery Format= YYYY-MM-DDTHH:MM:SS TZD (pt) Data e hora da tentativa de entrega Formato= AAAA-MM-DDTHH:MM:SS TZD Usage purpose: Invoice | | `nAttempts` | string | (en) Number of unsuccessful delivery attempt (pt) Número da tentativa de entrega que não teve sucesso Usage purpose: Invoice | | `tpReason` | string | (en) Reason for failure (pt) Motivo do insucesso Usage purpose: Invoice | | `justification` | string | (en) Justification of the reason for failure. Just inform for tpReason=4 (pt) Justificativa do motivo do insucesso. Informar apenas para tpReason=4 Usage purpose: Invoice | | `latGPS` | string | (en) Delivery point latitude (pt) Latitude do ponto de entrega ([-]2v6) Usage purpose: Invoice | | `longGPS` | string | (en) Longitude of delivery point (pt) Longitude do ponto de entrega ([-]3v6) Usage purpose: Invoice | | `hashAttemptedDelivery` | string | (en) SHA-1 Hash, in Base64 format, resulting from the concatenation of the NF-e Access Key + Base64 of the image captured during the delivery attempt (pt) Hash SHA-1, no formato Base64, resultante da concatenação de Chave de Acesso da NF-e + Base64 da imagem capturada na tentativa da entrega Usage purpose: Invoice | | `dhHashAttemptedDelivery` | string | (en) Date and time when the delivery attempt hash was generated. Format AAAA-MMDDThh:mm:ssTZD. (pt) Data e hora da geração do hash da tentativa de entrega. Formato AAAA-MMDDThh:mm:ssTZD. Usage purpose: Invoice | ### NFeDeliveryFailureCancelEv | Property | Type | Description | |---|---|---| | `seq` | number | | | `descEvento` | string | (en) Event code 110193 - Cancellation of Unsuccessful NF-e Delivery (pt) Código do evento 110193 - Cancelamento do Insucesso na Entrega da NF-e Usage purpose: Invoice | | `eventProtocol` | string | (en) Inform the number of the NF-e Event Authorization Protocol to which this cancellation refers (pt) Informar o número do Protocolo de Autorização do Evento da NF-e a que se refere este cancelamento Usage purpose: Invoice | ### nfeEvt_110001 (en) Allow the author of an already authorized Event to proceed with its cancellation (pt) Permitir que o autor de um Evento já autorizado possa proceder o seu cancelamento | Property | Type | Description | |---|---|---| | `companyLocation` | string | (en) This string contains a previously configured company code which may also have codes needed for tax return purposes. These codes are maintained through the customer portal. Main company address identity. (pt) Essa string contém um código de empresa configurado anteriormente que também pode ter códigos necessários para fins de declaração de imposto. Esses códigos são mantidos através do portal do cliente. Identidade do endereço principal da empresa. | | `dateTime` | string | (en) Event Date and Time, UTC format (YYYY-MM-DDThh:mm:ssTZD). (pt) Data e Hora do Evento, formato UTC (AAAA-MM-DDThh:mm:ssTZD). | | `tpEvent` | string | | | `seq` | number | | | `detEvent` | object | | ### nfeEvt_112110 (en) Function: Allows the NFe issuer to report full payment in order to release the purchaser’s presumed credit. (pt) Função: Permitir que o emitente da NFe informe o efetivo pagamento integral a fim de liberar crédito presumido do adquirente | Property | Type | Description | |---|---|---| | `companyLocation` | string | (en) This string contains a previously configured company code which may also have codes needed for tax return purposes. These codes are maintained through the customer portal. Main company address identity. (pt) Essa string contém um código de empresa configurado anteriormente que também pode ter códigos necessários para fins de declaração de imposto. Esses códigos são mantidos através do portal do cliente. Identidade do endereço principal da empresa. | | `dateTime` | string | (en) Event Date and Time, UTC format (YYYY-MM-DDThh:mm:ssTZD). (pt) Data e Hora do Evento, formato UTC (AAAA-MM-DDThh:mm:ssTZD). | | `tpEvent` | string | | | `seq` | number | | | `detEvent` | object | | ### nfeEvt_112120 (en) Allow the purchaser from incentivized regions (ALC/ZFM) to report that the import tax was not converted into an exemption for a given item because it did not meet the conditions of the legislation. (pt) Permitir que o adquirente das regiões incentivadas (ALC/ZFM) informe que a tributação na importação não se converteu em isenção de um determinado item por não atender as condições da legislação. | Property | Type | Description | |---|---|---| | `companyLocation` | string | (en) This string contains a previously configured company code which may also have codes needed for tax return purposes. These codes are maintained through the customer portal. Main company address identity. (pt) Essa string contém um código de empresa configurado anteriormente que também pode ter códigos necessários para fins de declaração de imposto. Esses códigos são mantidos através do portal do cliente. Identidade do endereço principal da empresa. | | `dateTime` | string | (en) Event Date and Time, UTC format (YYYY-MM-DDThh:mm:ssTZD). (pt) Data e Hora do Evento, formato UTC (AAAA-MM-DDThh:mm:ssTZD). | | `tpEvent` | string | | | `seq` | number | | | `detEvent` | object | | ### nfeEvt_211110 (en) Function: Allows the NFe issuer to report full payment in order to release the purchaser’s presumed credit. (pt) Função: Evento a ser gerado pelo adquirente em relação às notas fiscais de aquisição de emissão de terceiros e que lhe gerem o direito à apropriação de crédito presumido. | Property | Type | Description | |---|---|---| | `companyLocation` | string | (en) This string contains a previously configured company code which may also have codes needed for tax return purposes. These codes are maintained through the customer portal. Main company address identity. (pt) Essa string contém um código de empresa configurado anteriormente que também pode ter códigos necessários para fins de declaração de imposto. Esses códigos são mantidos através do portal do cliente. Identidade do endereço principal da empresa. | | `dateTime` | string | (en) Event Date and Time, UTC format (YYYY-MM-DDThh:mm:ssTZD). (pt) Data e Hora do Evento, formato UTC (AAAA-MM-DDThh:mm:ssTZD). | | `tpEvent` | string | | | `seq` | number | | | `detEvent` | object | | ### nfeEvt_211120 (en) Function: Enables the purchaser to indicate when an acquisition is intended for the personal consumption of a natural person, a situation in which no credit appropriation is allowed. This event must be recorded after the invoice for goods destined for personal use and consumption has been issued. A single acquisition NFe may receive multiple events of this type, each with a different nSeqEvento (cumulative events). (pt) Função: Permitir ao adquirente informar quando uma aquisição for destinada para o consumo de pessoa física, hipótese em que não haverá direito à apropriação de crédito. Evento a ser registrado após a emissão da nota de bens destinados para uso e consumo pessoal. Uma mesma NFe de aquisição pode receber vários Eventos desse tipo, com nSeqEvento diferentes (eventos cumulativos). | Property | Type | Description | |---|---|---| | `companyLocation` | string | (en) This string contains a previously configured company code which may also have codes needed for tax return purposes. These codes are maintained through the customer portal. Main company address identity. (pt) Essa string contém um código de empresa configurado anteriormente que também pode ter códigos necessários para fins de declaração de imposto. Esses códigos são mantidos através do portal do cliente. Identidade do endereço principal da empresa. | | `dateTime` | string | (en) Event Date and Time, UTC format (YYYY-MM-DDThh:mm:ssTZD). (pt) Data e Hora do Evento, formato UTC (AAAA-MM-DDThh:mm:ssTZD). | | `tpEvent` | string | | | `seq` | number | | | `detEvent` | object | | ### nfeEvt_211124 (en) Function: Allow the purchaser to report when an acquisition is subject to theft, loss, robbery or deterioration. Note: The current event is related to goods that were subject to deterioration, loss, robbery or deterioration in transit, in supplies with FOB freight. (pt) Função: Permitir ao adquirente informar quando uma aquisição for objeto de roubo, perda, furto ou perecimento. Observação: O evento atual está relacionado aos bens que foram objeto de perecimento, perda, roubo ou furto em trânsito, em fornecimentos com frete FOB. | Property | Type | Description | |---|---|---| | `companyLocation` | string | (en) This string contains a previously configured company code which may also have codes needed for tax return purposes. These codes are maintained through the customer portal. Main company address identity. (pt) Essa string contém um código de empresa configurado anteriormente que também pode ter códigos necessários para fins de declaração de imposto. Esses códigos são mantidos através do portal do cliente. Identidade do endereço principal da empresa. | | `dateTime` | string | (en) Event Date and Time, UTC format (YYYY-MM-DDThh:mm:ssTZD). (pt) Data e Hora do Evento, formato UTC (AAAA-MM-DDThh:mm:ssTZD). | | `tpEvent` | string | | | `seq` | number | | | `detEvent` | object | | ### nfeEvt_112130 (en) Function: The current event is related to movable material assets that were subject to perishing, loss, theft or robbery in transit, in supplies with CIF freight. (pt) Função: O evento atual está relacionado aos bens móveis materiais que foram objeto de perecimento, perda, roubo ou furto em trânsito, em fornecimentos com frete CIF | Property | Type | Description | |---|---|---| | `companyLocation` | string | (en) This string contains a previously configured company code which may also have codes needed for tax return purposes. These codes are maintained through the customer portal. Main company address identity. (pt) Essa string contém um código de empresa configurado anteriormente que também pode ter códigos necessários para fins de declaração de imposto. Esses códigos são mantidos através do portal do cliente. Identidade do endereço principal da empresa. | | `dateTime` | string | (en) Event Date and Time, UTC format (YYYY-MM-DDThh:mm:ssTZD). (pt) Data e Hora do Evento, formato UTC (AAAA-MM-DDThh:mm:ssTZD). | | `tpEvent` | string | | | `seq` | number | | | `detEvent` | object | | ### nfeEvt_112140 (en) Function: Delivery not made with advance payment (pt) Função: Fornecimento não realizado com pagamento antecipado | Property | Type | Description | |---|---|---| | `companyLocation` | string | (en) This string contains a previously configured company code which may also have codes needed for tax return purposes. These codes are maintained through the customer portal. Main company address identity. (pt) Essa string contém um código de empresa configurado anteriormente que também pode ter códigos necessários para fins de declaração de imposto. Esses códigos são mantidos através do portal do cliente. Identidade do endereço principal da empresa. | | `dateTime` | string | (en) Event Date and Time, UTC format (YYYY-MM-DDThh:mm:ssTZD). (pt) Data e Hora do Evento, formato UTC (AAAA-MM-DDThh:mm:ssTZD). | | `tpEvent` | string | | | `seq` | number | | | `detEvent` | object | | ### nfeEvt_112150 (en) Event that allows the supplier to update the estimated delivery date or availability of the good to the purchaser, in order to remove the debt from the month in which it was initially forecast. (pt) Evento que permite ao fornecedor atualizar a data da previsão de entrega ou disponibilização do bem ao adquirente, de forma a remover o débito do mês em que foi previsto inicialmente. | Property | Type | Description | |---|---|---| | `companyLocation` | string | (en) This string contains a previously configured company code which may also have codes needed for tax return purposes. These codes are maintained through the customer portal. Main company address identity. (pt) Essa string contém um código de empresa configurado anteriormente que também pode ter códigos necessários para fins de declaração de imposto. Esses códigos são mantidos através do portal do cliente. Identidade do endereço principal da empresa. | | `dateTime` | string | (en) Event Date and Time, UTC format (YYYY-MM-DDThh:mm:ssTZD). (pt) Data e Hora do Evento, formato UTC (AAAA-MM-DDThh:mm:ssTZD). | | `tpEvent` | string | | | `seq` | number | | | `detEvent` | object | | ### nfeEvt_211128 (en) Allow the recipient to declare that they agree with the amounts shown on the credit note issued by either the supplier or the purchaser, which will be recorded as a debit in the assisted assessment of IBS and CBS. (pt) Permitir ao destinatário informar que concorda com os valores constantes em nota de crédito emitida pelo fornecedor ou pelo adquirente que serão lançados a débito na apuração assistida de IBS e CBS | Property | Type | Description | |---|---|---| | `companyLocation` | string | (en) This string contains a previously configured company code which may also have codes needed for tax return purposes. These codes are maintained through the customer portal. Main company address identity. (pt) Essa string contém um código de empresa configurado anteriormente que também pode ter códigos necessários para fins de declaração de imposto. Esses códigos são mantidos através do portal do cliente. Identidade do endereço principal da empresa. | | `dateTime` | string | (en) Event Date and Time, UTC format (YYYY-MM-DDThh:mm:ssTZD). (pt) Data e Hora do Evento, formato UTC (AAAA-MM-DDThh:mm:ssTZD). | | `tpEvent` | string | | | `seq` | number | | | `detEvent` | object | | ### nfeEvt_211130 (en) Event to be generated by the purchaser of a good when it is incorporated into their fixed assets, so that the tax-administration systems can properly identify the deadline for reviewing any reimbursement claims for the corresponding credit, under Article 40, I of Complementary Law 214/2025. (pt) Evento a ser gerado pelo adquirente de bem, quando este for integrado ao seu ativo imobilizado, a fim de viabilizar a adequada identificação, pelos sistemas da administração tributária, de prazo-limite para apreciação de eventuais pedidos de ressarcimento do respectivo crédito, nos termos do art. 40, I da LC 214/2025. | Property | Type | Description | |---|---|---| | `companyLocation` | string | (en) This string contains a previously configured company code which may also have codes needed for tax return purposes. These codes are maintained through the customer portal. Main company address identity. (pt) Essa string contém um código de empresa configurado anteriormente que também pode ter códigos necessários para fins de declaração de imposto. Esses códigos são mantidos através do portal do cliente. Identidade do endereço principal da empresa. | | `dateTime` | string | (en) Event Date and Time, UTC format (YYYY-MM-DDThh:mm:ssTZD). (pt) Data e Hora do Evento, formato UTC (AAAA-MM-DDThh:mm:ssTZD). | | `tpEvent` | string | | | `seq` | number | | | `detEvent` | object | | ### nfeEvt_211140 (en) Event to be generated by the purchaser of fuel listed in Article 172 of Complementary Law 214/2025 who is part of that fuel’s production chain, in order to request the appropriation of credit for the portion consumed in their commercial activity. (pt) Evento a ser gerado pelo adquirente de combustível listado no art. 172 da LC 214/2025 e que pertença à cadeia produtiva desses combustíveis, para solicitar a apropriação de crédito referente à parcela que for consumida em sua atividade comercial. | Property | Type | Description | |---|---|---| | `companyLocation` | string | (en) This string contains a previously configured company code which may also have codes needed for tax return purposes. These codes are maintained through the customer portal. Main company address identity. (pt) Essa string contém um código de empresa configurado anteriormente que também pode ter códigos necessários para fins de declaração de imposto. Esses códigos são mantidos através do portal do cliente. Identidade do endereço principal da empresa. | | `dateTime` | string | (en) Event Date and Time, UTC format (YYYY-MM-DDThh:mm:ssTZD). (pt) Data e Hora do Evento, formato UTC (AAAA-MM-DDThh:mm:ssTZD). | | `tpEvent` | string | | | `seq` | number | | | `detEvent` | object | | ### nfeEvt_211150 (en) Event to be generated by the acquirer for appropriation of credit for goods and services that depend on its activity (pt) Evento a ser gerado pelo adquirente para apropriação de crédito de bens e serviços que dependam da sua atividade | Property | Type | Description | |---|---|---| | `companyLocation` | string | (en) This string contains a previously configured company code which may also have codes needed for tax return purposes. These codes are maintained through the customer portal. Main company address identity. (pt) Essa string contém um código de empresa configurado anteriormente que também pode ter códigos necessários para fins de declaração de imposto. Esses códigos são mantidos através do portal do cliente. Identidade do endereço principal da empresa. | | `dateTime` | string | (en) Event Date and Time, UTC format (YYYY-MM-DDThh:mm:ssTZD). (pt) Data e Hora do Evento, formato UTC (AAAA-MM-DDThh:mm:ssTZD). | | `tpEvent` | string | | | `seq` | number | | | `detEvent` | object | | ### nfeEvt_212110 (en) Event to be generated by the successor in relation to the credit transfer invoices of another successor of the same company succeeded to inform acceptance of the IBS credit transfer. (pt) Evento a ser gerado pela sucessora em relação às notas fiscais de transferência de crédito de outra sucessora da mesma empresa sucedida para informar aceite da transferência de crédito de IBS. | Property | Type | Description | |---|---|---| | `companyLocation` | string | (en) This string contains a previously configured company code which may also have codes needed for tax return purposes. These codes are maintained through the customer portal. Main company address identity. (pt) Essa string contém um código de empresa configurado anteriormente que também pode ter códigos necessários para fins de declaração de imposto. Esses códigos são mantidos através do portal do cliente. Identidade do endereço principal da empresa. | | `dateTime` | string | (en) Event Date and Time, UTC format (YYYY-MM-DDThh:mm:ssTZD). (pt) Data e Hora do Evento, formato UTC (AAAA-MM-DDThh:mm:ssTZD). | | `tpEvent` | string | | | `seq` | number | | | `detEvent` | object | | ### nfeEvt_212120 (en) Event to be generated by the successor in relation to the credit transfer invoices of another successor of the same company succeeded to inform acceptance of the CBS credit transfer. (pt) Evento a ser gerado pela sucessora em relação às notas fiscais de transferência de crédito de outra sucessora da mesma empresa sucedida para informar aceite da transferência de crédito de CBS. | Property | Type | Description | |---|---|---| | `companyLocation` | string | (en) This string contains a previously configured company code which may also have codes needed for tax return purposes. These codes are maintained through the customer portal. Main company address identity. (pt) Essa string contém um código de empresa configurado anteriormente que também pode ter códigos necessários para fins de declaração de imposto. Esses códigos são mantidos através do portal do cliente. Identidade do endereço principal da empresa. | | `dateTime` | string | (en) Event Date and Time, UTC format (YYYY-MM-DDThh:mm:ssTZD). (pt) Data e Hora do Evento, formato UTC (AAAA-MM-DDThh:mm:ssTZD). | | `tpEvent` | string | | | `seq` | number | | | `detEvent` | object | | ### EventForNfse | Property | Type | Description | |---|---|---| | `companyLocation` | string | (en) This string contains a previously configured company code which may also have codes needed for tax return purposes. These codes are maintained through the customer portal. Main company address identity. (pt) Essa string contém um código de empresa configurado anteriormente que também pode ter códigos necessários para fins de declaração de imposto. Esses códigos são mantidos através do portal do cliente. Identidade do endereço principal da empresa | | `dateTime` | string | (en) Timestamp of when this event is fired. AAAA-MM-DDThh:mm:ssTZD (pt) Carimbo de data/hora de quando este evento é disparado. AAAA-MM-DDThh:mm:ssTZD" | | `seq` | string | (en) Each action type has a sequence number, if not informed, is defined by the engine. (pt) Cada tipo de evento possui um número de sequência, caso não seja informado, é assumido 001 | | `eventInfo` | object | (en) Event Registration Request Information Group (pt) Grupo de informações do pedido de registro do evento | ### HeaderInvoiceForGoods ### LineInvoiceForGoods ### SummaryInvoiceForGoods ### HeaderInvoiceServicesGroup | Property | Type | Description | |---|---|---| | `natOp` | string | (en) Fiscal description of what will be done with the product or service (pt) Descrição fiscal do que será feito com o produto ou serviço Calculation/Invoice | | `cRegTrib` | string | (pt) Código do Regime Especial de Tributação 1 - Microempresa Municipal; 2 - Estimativa 3 - Sociedade de Profissionais 4 - Cooperativa 5 - Microempresário Individual (MEI) 6 - Microempresário e Empresa de Pequeno Porte (ME/EPP) | ### DetailsTaxInvoiceForGoods ### LineBaseInvoiceForGoods ### CPRB_DetailTax ### CSTCPRBEnum (en) Informs if this item by nature is subject to PIS OR COFINS taxation. - 'T' # TAXABLE (pt) Informa se este item por natureza está sujeito à tributação de PIS OU COFINS. - 'T' # TRIBUTÁVEL ### ItemDescriptorInvoiceForGoods ### TaxByTypeInvoiceForGoods