Introdução
Essa documentação tem por objetivo descrever o serviço que será criado para atender as requisições de manutenção do DAV pelo Storex, que surgiu devido às requisições do TTD-707 para o estado de SC.
Será disponibilizada API para criação e atualização do DAV.
Requisitos
- A aplicação responsável pela geração de pedidos e orçamentos deve estar apta ao uso da API disponibilizada para geração do DAV.
- O Storex-Cloud estar apto a receber as informações necessárias para geração do DAV.
- Deverão constar na base de dados relacional a estrutura e procedimentos para correto atendimento dos dados relacionados ao DAV.
- Quando houver indisponibilidade do serviço o sistema que consome o serviço deverá manter uma fila para envio quando houver o retorno e não impactar na operação.
Principais definições
- A aplicação responsável pela geração de pedidos e orçamentos deve realizar requisições ao Storex-Cloud a cada criação e atualização dos mesmos para geração e manutenção do DAV.
- O Storex-Cloud deve realizar o processo de geração do DAV conforme regra de formação e persistir em base relacional os dados recebidos, juntamente com o DAV gerado que também será retornado para o sistema que requisitou.
- Serão realizados procedimentos na base de dados relacional para cruzamento das informações e geração dos arquivos necessários para atendimento do TTD-707.
- Quando requisitados os arquivos necessários para atendimento do TTD-707 pelo PDV as informações devem estar disponíveis por meio de procedimentos na base relacional e retornado o arquivo necessário pelo Storex-Cloud.
- As informações dos itens ficam sob responsabilidade da aplicação que consome o serviço. Portanto, alterações devem obedecer a sequência do item da criação (sequenceId como chave) e será sempre enviada a lista completa dos itens do DAV.
- A API será responsável pela validação da atualização dos itens para não gerar logs de inclusão, alteração ou exclusão indevidamente.
Definição dos dados
Objeto | Dados | Tipo | Descrição | |
---|---|---|---|---|
DAV | CNPJ_ESTABELECIMENTO | Number | CNPJ do estabelecimento usuário do PAF- NFC-e | |
NUMERO_DAV | String | Número do DAV emitido | ||
NUMERO_EXTERNO | String | Número do Pedido gerado no cliente | ||
DATA_EMISSAO | Date | Data de emissão do DAV | ||
TITULO_DAV | String | Título atribuído ao DAV de acordo com sua função (ex: Orçamento, Pedido, etc.) | ||
VALOR_DAV | Number | Valor total do DAV emitido, com duas casas decimais | ||
NOME_CLIENTE | String | Nome do Cliente | ||
DOCUMENTO_CLIENTE | Number | CPF ou CNPJ do adquirente |
Objeto | Dados | Tipo | Descrição | |
---|---|---|---|---|
DAV_DETALHE | NUMERO_DAV | String | Número do DAV onde está contido este item | |
DATA_CRIACAO | Date | Data de inclusão do item no DAV | ||
NUMERO_ITEM | Number | Número sequencial do item registrado no documento | ||
CODIGO_PRODUTO | String | Código do produto ou serviço registrado no documento. | ||
DESCRICAO | String | Descrição do produto ou serviço constante no DANFE | ||
QUANTIDADE | Number | Quantidade, sem a separação das casas decimais | ||
UNIDADE | String | Unidade de medida | ||
VALOR_UNITARIO | Number | Valor unitário do produto ou serviço, sem a separação das casas decimais | ||
SITUACAO_TRIBUTARIA | String | Código da Situação Tributaria conforme Tabela constante no item 6.3.1.5 | ||
ALIQUOTA | Number | Alíquota, conforme Item 6.7.1.4 |
Objeto | Dados | Tipo | Descrição | |
---|---|---|---|---|
DAV_DETALHE_LOG | NUMERO_DAV | String | Número do DAV onde está contido este item | |
DATA_CRIACAO | Date | Data de inclusão do item no DAV | ||
NUMERO_ITEM | Number | Número sequencial do item registrado no documento | ||
CODIGO_PRODUTO | String | Código do produto ou serviço registrado no documento. | ||
DESCRICAO | String | Descrição do produto ou serviço constante no DANFE | ||
QUANTIDADE | Number | Quantidade, sem a separação das casas decimais | ||
UNIDADE | String | Unidade de medida | ||
VALOR_UNITARIO | Number | Valor unitário do produto ou serviço, sem a separação das casas decimais | ||
SITUACAO_TRIBUTARIA | String | Código da Situação Tributaria conforme Tabela constante no item 6.3.1.5 | ||
ALIQUOTA | Number | Alíquota, conforme Item 6.7.1.4 | ||
CANCELADO | String | Informar "S" ou "N", conforme tenha ocorrido ou não, a marcação do cancelamento do item no documento auxiliar de venda | ||
TIPO_ALTERACAO | String | “A” para alteração, “E” para exclusão e “I” para inclusão |
Definições de apis
/v1/paf/dav/create
CreateREQUISICAO: { "storeDocument": "00000000000000", "externalNumber": "923746734", "date": "", "totalValue": 100.00, "title": "Orçamento", "customer": { "name": "JOSE", "document": "11122233396" }, items: [ { "sequenceId": 1, "code": "74737", "description": "PRODUTO X", "unitQuantity": 1.00, "saleUnit": "UN", "unitValue": 100.00, "taxType": "T", "taxPercentage": 17.00 } ] } RESPOSTA: { "dav": "00000000000000", "externalNumber": "923746734" } RESPOSTA ERRO: { "code": 500, "uuid": "8868dbb1-92ad-4b7b-a816-d6a07c6673c2", "message": "Erro ao persistir informações do DAV na base de dados!" }
/v1/paf/dav/update
UpdateREQUISICAO: { "davNumber": "000000000000001", "storeDocument": "00000000000000", "externalNumber": "923746734", "date": "", "totalValue": 100.00, "title": "Orçamento", "customer": { "name": "JOSE", "document": "11122233396" }, items: [ { "sequenceId": 1, "code": "74737", "description": "PRODUTO X", "unitQuantity": 1.00, "saleUnit": "UN", "unitValue": 100.00, "taxType": "T", "taxPercentage": 17.00, "cancelled": true } ] } RESPOSTA: { "dav": "00000000000000", "externalNumber": "923746734" } RESPOSTA ERRO: { "code": 500, "uuid": "8868dbb1-92ad-4b7b-a816-d6a07c6673c2", "message": "Erro ao persistir informações do DAV na base de dados!" }