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": []
}

04. Payload Campos obrigatórios

Não há especificidades na listagem dessa tela, está sendo utilizada a combinação do componente dinâmico po-page-dynamic-search com uma po-table.

Na edição há dois formulários dinâmicos (po-dynamic-form), um formulário só visualização (po-dynamic-view) e um array de fields referentes a metadados de listagem de mensagens:

1. O array principal de fields contêm todos os campos principais que aparecem no início da tela: Evento / Módulo origem / Sequência / Chave de acesso / Estabelecimento;
2. Os campos que aparecem no folder "Dados complementares", agrupador "Documento fiscal eletrônico (DFE)" estão no array: fieldsDadosComplementares;
3. Os campos somente visualização que aparecem no folder "Dados complementares", agrupador "Evento DF-e" estão no array: fieldsDadosEventoDfe;
4. No array fieldsMessagesList constam as colunas que são visualizadas no folder "Mensagens".

Os arrays podem ser manipulados por uma UPC e retornados para a tela modificando ou adicionando campos.

05. Observações Gerais

Documentação de customização