Histórico da Página
CONTEÚDO
- Visão Geral
- API x Pontos UPC Relacionados
- JSON de metadata
- e Rotas
- Campos do payload para criação/edição do registro
- Exemplo de payload e especificidade por eventoEspecificidades de customização
01. Visão Geral Âncora 1 1
| 1 | |
| 1 |
...
API usada para a criação, atualização e deleção dos eventos do tributo
...
Caminho Relativo: cdp/api/v1/eventotributos.p
URL Base: PORTA/dts/datasul-rest/resources/prg/cdp/v1/eventotributos
Chave do registro: <chave de acesso da nf>|<código do evento>|<estabelecimento>
...
| Informações |
|---|
A chave do registro deve ser enviada com URL Encode (ex: o pipe |
| 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 |
| Usado para retornar os dados de um registro especifico. Exemplo de Uso: |
03. Campos do Payload para criação/edição do registro Âncora 3 3
| 3 | |
| 3 |
...
| 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 que está realizando ou registrando o evento. | String | Sim | |||
idiTipDfe | Indicador do Tipo de Documento Fiscal Eletrônico (DF-e). 1 = NFe, 2 = CT-e. | Integer | Sim | |||
idiTipAutor | Indicador do Tipo de Autor do evento. | Integer | Sim | 1 = Empresa emitente, 2 = Empresa destinatária, 3 = Empresa, 5 = Fisco, 6 = RFB, 8 = Empresa sucessora, 9 = Outros órgãos | Integer | Sim |
moduloOrigInfo | Módulo de Origem da Informação ( | 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 | |||
codEmitente | Código do Emitente. | Integer | Não | |||
idiSitEvento | Indicador da Situação do Evento. 1 = Não enviado, 2 = Enviado, 3 = Autorizado, 4 = Rejeitado, 5 = Cancelado | 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 | |||
dtPrevEntrega | Data previsão de entrega (Formato: AAAA-MM-DD) | String | Sim/Não (depende do evento) | |||
internalId | Identificador interno do evento no sistema. | String | Não | |||
idiIndAceitacao | Indicador de Aceitação (Retorno). 0 = Não Aceite, 1 = Aceite | Integer | Não | |||
idiIndQuitacao | Indicador de Quitação (Retorno). 0 = Não Quitado, 1 = Quitado | Integer | Não codProtocolo | |||
natOper | Código | |||||
da Natureza da Operação. | String | Não | ||||
| Sim/Não (depende do evento) | ||||||
dtDocto | Data do Documento (Formato: AAAA-MM-DD). | String | Sim/Não (depende do evento) | |||
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 | |||
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 |
...
| Informações | ||
|---|---|---|
| ||
O grupo eventoTributosItem é obrigatório para os seguintes eventos: 112120, 112130, 112140, 211110, 211120, 211124, 211130, 211150, para . 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 |
codCredPresIbs | |||
| Código do Crédito Presumido IBS. | String | Sim | seqEvento | Número sequencial do evento. | Integer | Sim
| /Não (depende do evento) | |||
percCredPresIbs | Percentual do Crédito Presumido IBS. | Decimal | Sim/Não (depende do evento) |
codCredPresCbs | Código do Crédito Presumido CBS. | String | Sim/Não (depende do evento) |
percCredPresCbs | Percentual do Crédito Presumido CBS. | Decimal | Sim/Não (depende do evento) |
codChaveRefNf | Chave de Acesso da NF referenciada. | String | Sim/Não (depende do evento) |
seqItemRefNf | Sequência do item na NF referenciada. | Integer | Sim/Não (depende do evento) |
internalId | Identificador interno do registro de item. | String | Sim |
seqEvento | Número sequencial do evento. | Integer | Sim |
bensItensDocto
| Informações | ||
|---|---|---|
| ||
O grupo bensItensDocto é preenchido no evento: 211130. Para os demais este grupo não deve ser enviado e será desconsiderado. |
| Campo | Descrição | Tipo | Obrigatório (Envio) |
itemNumber | Número do item no documento de entrada. | Integer | Não (É possível informar um item sem vínculo com bem patrimonial) |
incorpDesc | Descrição da Incorporação do bem. | String | Não (É possível informar um item sem vínculo com bem patrimonial) |
assetAccount | Conta Patrimonial do bem. | String | Não (É possível informar um item sem vínculo com bem patrimonial) |
assetCode | Código do Bem Patrimonial. | Integer | Não (É possível informar um item sem vínculo com bem patrimonial) |
entryDocument | Número do Documento de Entrada. | String | Não (É possível informar um item sem vínculo com bem patrimonial) |
assetCodeSequence | Sequência do código do bem patrimonial. | Integer | Não (É possível informar um item sem vínculo com bem patrimonial) |
incorpNumber | Número da incorporação do bem patrimonial. | Integer | Não (É possível informar um item sem vínculo com bem patrimonial) |
branch | Código do Estabelecimento. | String | Não (É possível informar um item sem vínculo com bem patrimonial) |
eventCode | Código do Evento (ex: 211130). | String | Não (É possível informar um item sem vínculo com bem patrimonial) |
eventSeq | Número sequencial do evento. | Integer | Não (É possível informar um item sem vínculo com bem patrimonial) |
supplier | Código do Fornecedor. | Integer | Não (É possível informar um item sem vínculo com bem patrimonial) |
invoiceNumber | Série da Nota Fiscal / Documento. | String | Não (É possível informar um item sem vínculo com bem patrimonial) |
seqItemXml | Sequência do item no XML da nota. | Integer | Não (É possível informar um item sem vínculo com bem patrimonial) |
idBem | Identificador único do Bem Patrimonial. | Integer | Não (É possível informar um item sem vínculo com bem patrimonial) |
company | Código da Empresa. | String | Não (É possível informar um item sem vínculo com bem patrimonial) |
codChaveAcesNfEletro | Chave de Acesso do DF-e vinculado. | String | Não (É possível informar um item sem vínculo com bem patrimonial) |
itemDescription | Descrição do Item. | String | Não (É possível informar um item sem vínculo com bem patrimonial) |
natureOp | Código da Natureza de Operação. | String | Não (É possível informar um item sem vínculo com bem patrimonial) |
assetDesc | Descrição do Bem Patrimonial. | String | Não (É possível informar um item sem vínculo com bem patrimonial) |
04. Exemplo de payload e especificidade por evento Âncora 4 4
| 4 | |
| 4 |
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas