Endpoint DAVs (v1)
Descrição Geral
Manipulação de DAVS (orçamentos, pré-vendas, pedidos de venda, pedidos de faturamento)
URL
“/public-api/v1/davs“
Verbos suportados
POST, GET, DELETE
Status HTTP
200 = OK, 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes
JSON Exemplo
{“dav”: {“codigo”: “101”, “tipoDocumento”: 1,”data”:”2020-08-01″,”itens”:[{“produto”:”97″,”quantidade”:1,”precoUnitario”:12.34}]}}
Exemplos
curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –data “${json}” –request “POST” “${endereco_do_servidor}/public-api/v1/davs”
curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/davs/${codigo}”
curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/davs”
curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “DELETE” “${endereco_do_servidor}/public-api/v1/davs/${codigo}”
Lista dos campos do JSON
Identificador | Descrição | Obrigatório | Tipo | Tamanho | Decimais | Observações |
---|---|---|---|---|---|---|
bairroEntrega | Bairro da entrega | Caractere | 50 | |||
cepEntrega | CEP da entrega | Caractere | 9 | |||
cidadeEntrega | Cidade da entrega | Caractere | 100 | |||
cliente | Cliente | Caractere | 14 | Código do cliente (entidade) | ||
codigo | Código | Sim | Inteiro | Código do documento ou se deixar em branco o sistema gera um sequencial | ||
codigoIdentificacao | Código alternativo de identificação | Caractere | 20 | Associa outro código identificador no prév-vendas | ||
codigoPauta | Número da pauta de preços | Caractere | 1 | |||
codigoTipoFrete | Código do tipo de frete | Caractere | 1 | 0=Destinatário 1=Emitente 2=Sem frete 9=Terceiros | ||
codigoTransportadora | Código da transportadora | Caractere | 14 | Código da transportadora (entidade) | ||
complementoEntrega | Complemento da entrega | Caractere | 50 | |||
condicaoPagamento | Condição de pagamento | Caractere | 6 | Código da condição de pagamento | ||
data | Data | Sim | Data | |||
desconto | Desconto no sub-total | Decimal | 12 | 2 | ||
enderecoEntrega | Endereço da entrega | Caractere | 50 | |||
estadoEntrega | Estado da entrega | Caractere | 2 | |||
extra1 | Campo extra 1 | Caractere | 512 | |||
extra2 | Campo extra 2 | Caractere | 512 | |||
filial | Filial | Caractere | 4 | Código da filial | ||
numeroEntrega | Número do endereço da entrega | Caractere | 6 | |||
observacao | Observação | Caractere | 4096 | |||
percentualDescontoSubtotal | Percentual Desconto Subtotal | Decimal | 12 | 2 | ||
status | Status da DAV | Inteiro | 1=Fechado 2=PDV 3=Cancelado 4=Nota fiscal gerada 5=Pré-venda gerada 6=Duplicado 7=Faturado parcialmente 8=Pedido gerado 9=Incluído por cliente 10=Mesclado | |||
tipoDocumento | Tipo do DAV | Sim | Inteiro | 1=Pré-vendas 2=Orçamento 4=Pedido de venda 6=Pedido de faturamento | ||
tipoDocumentoFinanceiro | Tipo de documento financeiro | Inteiro | ||||
valor | Valor | Decimal | 12 | 3 | Valor total do DAV, sendo igual ao valor total dos itens manos o desconto de sub-total.Caso não for informado, será calculado pelo valor total de todos os itens | |
valorDescontoItens | Valor do desconto dos itens | Decimal | 12 | 2 | ||
valorFrete | Valor do frete | Decimal | 12 | 2 | ||
vendedor | Vendedor | Caractere | 14 | Código do vendedor (entidade) | ||
codigoECommerce | Código do pedido do e-commerce | Caractere | 50 |
Identificador | Descrição | Obrigatório | Tipo | Tamanho | Decimais | Observações |
codigoDAV | Codigo do DAV | Inteiro | ||||
codigoUnidadeMedida | Unidade de medida | Caractere | 3 | Código da unidade de medida | ||
desconto | Desconto | Decimal | ||||
isBrinde | Brinde | Inteiro | 0=Não 1=Sim | |||
nrItem | Número do item | Inteiro | ||||
numeroSerie | Número de série | Caractere | 20 | |||
precoTotal | Preco total | Decimal | 12 | |||
precoUnitario | Preco unitário | Decimal | 12 | |||
produto | Produto | Sim | Caractere | 14 | Código do produto | |
quantidade | Quantidade | Sim | Decimal | 12 | ||
tipoDesconto | Tipo de desconto | Sim | Caractere | 1 | 0=Percentual 1=Valor | |
informacaoAdicional | Informações adicionais | Caractere | 500 |
variacoes | ||||||
---|---|---|---|---|---|---|
Identificador | Descrição | Obrigatório | Tipo | Tamanho | Decimais | Observações |
variacao | Código da Variação | Inteiro | ||||
quantidade | Quantidade da variação | Inteiro |
Conteúdo Relacionado
Os artigos listados abaixo estão relacionados ao que você acabou de ler:
• API Rest (WEB)
• Antes de Falar com o Suporte Técnico
• Obtendo suporte técnico e ajuda