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


  1. 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.
  2. O Storex-Cloud estar apto a receber as informações necessárias para geração do DAV.
  3. Deverão constar na base de dados relacional a estrutura e procedimentos para correto atendimento dos dados relacionados ao DAV.
  4. 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

  1. 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.
  2. 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.
  3. 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.
  4. 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.
  5. 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.
  6. 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


ObjetoDadosTipoDescrição
DAVCNPJ_ESTABELECIMENTONumberCNPJ do estabelecimento usuário do PAF- NFC-e
NUMERO_DAVStringNúmero do DAV emitido
NUMERO_EXTERNOStringNúmero do Pedido gerado no cliente
DATA_EMISSAODateData de emissão do DAV
TITULO_DAVStringTítulo atribuído ao DAV de acordo com sua função (ex: Orçamento, Pedido, etc.)
VALOR_DAVNumberValor total do DAV emitido, com duas casas decimais
NOME_CLIENTEStringNome do Cliente
DOCUMENTO_CLIENTENumberCPF ou CNPJ do adquirente
ObjetoDadosTipoDescrição
DAV_DETALHENUMERO_DAVStringNúmero do DAV onde está contido este item
DATA_CRIACAODateData de inclusão do item no DAV
NUMERO_ITEMNumberNúmero sequencial do item registrado no documento
CODIGO_PRODUTOStringCódigo do produto ou serviço registrado no documento.
DESCRICAOStringDescrição do produto ou serviço constante no DANFE
QUANTIDADENumberQuantidade, sem a separação das casas decimais
UNIDADEStringUnidade de medida
VALOR_UNITARIONumberValor unitário do produto ou serviço, sem a separação das casas decimais
SITUACAO_TRIBUTARIAStringCódigo da Situação Tributaria conforme Tabela constante no item 6.3.1.5
ALIQUOTANumberAlíquota, conforme Item 6.7.1.4


ObjetoDadosTipoDescrição
DAV_DETALHE_LOGNUMERO_DAVStringNúmero do DAV onde está contido este item
DATA_CRIACAODateData de inclusão do item no DAV
NUMERO_ITEMNumberNúmero sequencial do item registrado no documento
CODIGO_PRODUTOStringCódigo do produto ou serviço registrado no documento.
DESCRICAOStringDescrição do produto ou serviço constante no DANFE
QUANTIDADENumberQuantidade, sem a separação das casas decimais
UNIDADEStringUnidade de medida
VALOR_UNITARIONumberValor unitário do produto ou serviço, sem a separação das casas decimais
SITUACAO_TRIBUTARIAStringCódigo da Situação Tributaria conforme Tabela constante no item 6.3.1.5
ALIQUOTANumberAlíquota, conforme Item 6.7.1.4
CANCELADOStringInformar "S" ou "N", conforme tenha ocorrido ou não, a marcação do cancelamento do item no documento auxiliar de venda
TIPO_ALTERACAOString“A” para alteração, “E” para exclusão e “I” para inclusão

Definições de apis

  • /v1/paf/dav/create

    Create
    REQUISICAO:
    
    { 
    	"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

    Update
    REQUISICAO:
    
    { 
    	"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!"
    }
  • Sem rótulos