Exibir origem

CONTEÚDO

01. Visão Geral

Este documento tem como objetivo descrever as APIs usadas na tela HTML do programa Evento tributos (html.mcd.eventoTributos).

02. API e Rotas

API usada para a criação, atualização e deleção dos eventos do tributo

URL Base: cdp/api/v1/eventotributos.p

Chave do registro: <chave de acesso da nf>|<código do evento>|<estabelecimento>

exemplo: 35251253113791000122550010000190171785740117|112130|1

Manipulação de Dados
Método	Endpoint	Entrada	Expand	Observação
POST	URL Base	Payload*	N/A	Usado para criar um novo registro
PUT	URL Base/<chave do registro>	Payload*	N/A	Usado para atualizar um registro já existente.
DELETE	URL Base/<chave do registro>	PathParameter	N/A	Usado para deletar um registro.
GET	URL BASE/<chave do registro>	PathParameter	eventoTributosItem eventoTributosMensagem bensItensDocto	Usado para retornar os dados de um registro especifico.

03. Payload para criação/edição do registro

Cada evento possui pequenas diferenças em como é esperado o envio do payload para criar o registro, assim como também possuem validações especificação de alguns campos e suas obrigatoriedades ou não.

Evento 112130:

{
  "internalId": "",
  "codChaveAcesNfEletro": "35251253113791000122550010000190171785740117",
  "codEvento": "112130",
  "seqEvento": 0,
  "codVersaoEvento": "1.00",
  "nroDocto": "0019017",
  "serieDocto": "1",
  "codEstabel": "1",
  "codEmitente": 0,
  "idiSitEvento": 1,
  "idiTipDfe": 1,
  "idiTipAutor": 1,
  "moduloOrigInfo": "MFT",
  "codUsuarioInclusao": "",
  "codUsuarioEnvio": "",
  "logGeracAuto": false,
  "dtmInclusao": "",
  "dtmEnvio": "",
  "dtmRetorno": "",
  "idiIndAceitacao": null,
  "idiIndQuitacao": null,
  "codProtocolo": null,
  "codEventoACanc": null,
  "codProtocACanc": null,
  "codProtocoloCanc": null,
  "blbXmlEnvio": null,
  "blbXmlRetorno": null,
  "hasListItems": true,
  "eventoTributosItem": [
    {
      "valorCbsAquis": 0,
      "itCodigo": ".compras1",
      "internalId": "1",
      "seqItemNf": 1,
      "valorCbs": 0,
      "seqEvento": 0,
      "valorIbs": 0,
      "codEvento": "112130",
      "valorIbsAquis": 0,
      "codChaveAcesNfEletro": "35251253113791000122550010000190171785740117",
      "valorBase": 0,
      "unidMed": "pc",
      "quantidade": 15
    },
    {
      "valorCbsAquis": 0,
      "itCodigo": ".COMPRAS2",
      "internalId": "2",
      "seqItemNf": 2,
      "valorCbs": 0,
      "seqEvento": 0,
      "valorIbs": 0,
      "codEvento": "112130",
      "valorIbsAquis": 0,
      "codChaveAcesNfEletro": "35251253113791000122550010000190171785740117",
      "valorBase": 0,
      "unidMed": "UN",
      "quantidade": 15
    },
    {
      "valorCbsAquis": 0,
      "itCodigo": ".COMPRAS3",
      "internalId": "3",
      "seqItemNf": 3,
      "valorCbs": 0,
      "seqEvento": 0,
      "valorIbs": 0,
      "codEvento": "112130",
      "valorIbsAquis": 0,
      "codChaveAcesNfEletro": "35251253113791000122550010000190171785740117",
      "valorBase": 0,
      "unidMed": "UN",
      "quantidade": 60
    }
  ],
  "eventoTributosMensagem": []
}

Evento x

04. Descrição dos campos enviados no Payload para criação/edição do registro

Campo	Descrição	Tipo	Obrigatório (Envio)
`codChaveAcesNfEletro`	Chave de Acesso da Nota Fiscal Eletrônica (NFe, CTe, etc.) à qual o evento se refere.	String	Sim
`codEvento`	Código do Evento de Tributo conforme padrões (ex: 112130).	String	Sim
`codVersaoEvento`	Versão do layout ou esquema do evento.	String	Sim
`nroDocto`	Número do Documento Fiscal (NF) relacionado.	String	Sim
`serieDocto`	Série do Documento Fiscal relacionado.	String	Sim
`codEstabel`	Código do Estabelecimento (filial) que está realizando ou registrando o evento.	String	Sim
`idiTipDfe`	Indicador do Tipo de Documento Fiscal Eletrônico (DF-e). Ex: 1=NFe.	Integer	Sim
`idiTipAutor`	Indicador do Tipo de Autor do evento.	Integer	Sim
`moduloOrigInfo`	Módulo de Origem da Informação (Sistema que gerou o evento). Ex: MFT.	String	Sim
`logGeracAuto`	Indicador Booleano de Geração Automática. `true` se gerado automaticamente, `false` se manual.	Boolean	Sim
`hasListItems`	Indicador Booleano se há lista de itens do documento (`eventoTributosItem`).	Boolean	Sim
`seqEvento`	Número sequencial do evento. Normalmente 0 (zero) no envio inicial e preenchido pelo sistema no retorno.	Integer	Não (Preenchido pelo Sistema)
`codEmitente`	Código do Emitente.	Integer	Não (Depende da Regra)
`idiSitEvento`	Indicador da Situação do Evento (ex: 1=Pendente, 2=Enviado).	Integer	Não
`codUsuarioInclusao`	Código do Usuário que incluiu o registro.	String	Não
`codUsuarioEnvio`	Código do Usuário responsável pelo envio (se manual).	String	Não
`dtmInclusao`	Data/Hora da Inclusão do registro.	String	Não
`dtmEnvio`	Data/Hora do Envio ao órgão/sistema.	String	Não
`dtmRetorno`	Data/Hora do Retorno da Autorização/Processamento.	String	Não
`internalId`	Identificador interno do evento no sistema.	String	Não
`idiIndAceitacao`	Indicador de Aceitação (Retorno).	Integer	Não
`idiIndQuitacao`	Indicador de Quitação (Retorno).	Integer	Não
`codProtocolo`	Código do Protocolo de Autorização/Retorno.	String	Não
`codEventoACanc`	Código do Evento a ser cancelado (se for um evento de cancelamento).	String	Não
`codProtocACanc`	Protocolo do evento a ser cancelado (se for um evento de cancelamento).	String	Não
`codProtocoloCanc`	Protocolo de Cancelamento (Retorno).	String	Não
`blbXmlEnvio`	XML do Evento enviado.	Blob/String	Não
`blbXmlRetorno`	XML de Retorno/Autorização.	Blob/String	Não
`eventoTributosMensagem`	Lista de mensagens (erros ou sucesso) do processamento.	Array	Não
`eventoTributosItem`	Lista dos itens vinculados ao evento	Array	Não

eventoTributosItem

O grupo eventoTributosItem é obrigatório para os seguintes eventos: 112120, 112130, 112140, 211110, 211120, 211124, 211130, 211150, para os demais este grupo não deve ser enviado e será desconsiderado.

Campo	Descrição	Tipo	Obrigatório (Envio)
`codChaveAcesNfEletro`	Chave de Acesso do DF-e.	String	Sim
`codEvento`	Código do Evento.	String	Sim
`seqItemNf`	Número sequencial do item na Nota Fiscal original.	Integer	Sim
`itCodigo`	Código do Item.	String	Sim
`unidMed`	Unidade de Medida do Item.	String	Sim
`quantidade`	Quantidade do Item.	Decimal	Sim
`valorBase`	Valor base de cálculo para os tributos.	Decimal	Sim
`valorCbs`	Valor do tributo CBS (Contribuição sobre Bens e Serviços) devido.	Decimal	Sim
`valorIbs`	Valor do tributo IBS (Imposto sobre Bens e Serviços) devido.	Decimal	Sim
`valorCbsAquis`	Valor do CBS de Aquisição.	Decimal	Sim/Não (depende do evento)
`valorIbsAquis`	Valor do IBS de Aquisição.	Decimal	Sim/Não (depende do evento)
`internalId`	Identificador interno do registro de item.	String	Sim
`seqEvento`	Número sequencial do evento.	Integer	Sim