Escolar Documentos
Profissional Documentos
Cultura Documentos
Pesquisa
Seguir
Os Webhooks permitem que sejam enviadas notificações via HTTP em tempo real de
informações para o F360 Finanças, como por exemplo, notificação para acrescentar um registro
de venda, entrada de cupons, entre outros. Com isso não há a necessidade de preencher certas
informações manualmente, bastando apenas a chamada do Webhook para inserção do registro
trazendo agilidade ao processo de integração.
Primeiros Passos
Inicialmente, você deverá entrar em contato com o usuário da plataforma F360 Finanças e
solicitar a URL para o qual serão enviadas as mensagens. Esse processo é importante para
mantermos a segurança dos nossos processos e identificarmos corretamente cada um de
nossos parceiros. O cliente pode consultar esse processo na nossa Documentação Técnica.
Na prática, foi desenvolvido um único endpoint para todos os fornecedores de dados que
desejam enviar informações via Webhook, onde será possível enviar todas as informações
necessárias, logo as informações abaixo são de extrema importância.
Modelo de endereço disponibilizado:
webhook.f360.com.br/identificador-unico-do-servico/servico-consumido
É possível realizar a consulta de status de todos os serviços disponíveis, para isso você pode
utilizar a URL abaixo:
webhook.f360.com.br/IDENTIFICADOR-UNICO-DO-SERVICO/f360-cupom-fiscal
A request deve ser enviada por meio de solicitação HTTP POST e é obrigatório que o corpo da
requisição seja um JSON válido, e contenha todos os dados que descrevem o cupom fiscal ou
período de vendas. Detalharemos mais à frente os campos obrigatórios e opcionais desse
corpo.
Exemplo:
Por se tratar de uma requisição assíncrona não retornamos o status da operação realizada no
F360 Finanças, logo, o processamento da informação enviada da requisição deve ser verificado
na própria plataforma do F360 Finanças. Caso o sistema não localize a ‘CNPJEmitente’
cadastrado, o sistema irá descartar a mensagem.
*CNPJEmitente (string): Número do CNPJ da loja cadastrado no F360 Finanças e deve ser
apresentado sem traço e sem pontos.
Cliente (object): Nesse campo devem ser informados Nome e CPF do cliente do cupom.
VendaCancelada (bool): O campo deve ser preenchido com um valor booleano (true/false) e
caso não seja preenchido, o valor será considerado como false. Se o valor for preenchido como
true, então a venda será buscada no sistema, e depois será cancelada. Se a venda não for
encontrada, ela não será cancelada.
*MeioPagamento (array): Nesse campo deve ser detalhado as diversas formas de pagamento
do cupom fiscal, ele é um array que deve conter os campos abaixo.
*Valor (double, ‘0.00’): Valor liquido pago naquela forma de pagamento, nas vendas em dinheiro,
comum ter troco, seria o resultado depois do valor recebido menos o troco, descrito no campo
acima,
Bandeira (string): Bandeira do cartão utilizado para pagamento, ver ‘Tabela 1’.
QtdParcelas (int): Quantidade de parcelas em que a forma de pagamento foi efetuada. Caso
essa informação não esteja presente no arquivo, iremos considerar o valor de 1 parcela.
Parcelas (array): O campo não é obrigatório, mas é possível informar os detalhes de cada
parcela separadamente, desde que as informações sejam consistentes. Caso o campo não seja
preenchido, o parcelamento da venda será calculado automaticamente através do valor,
vencimento e quantidade de parcelas informadas. Os campos do objeto de parcela são os
seguintes:
Campos marcados com * são campos obrigatórios, porém o envio das informações adicionais
traz benefícios à conciliação e rastreabilidade dos cupons fiscais.
A request deve ser enviada por meio de solicitação HTTP POST e é obrigatório que o corpo da
requisição seja um JSON válido, e contenha todos os dados que descrevem os títulos.
Detalharemos mais à frente os campos obrigatórios e opcionais desse corpo.
Tanto contas a pagar e a receber são tratados como Títulos no sistema, então este webhook
pode ser usado para envio de ambos.
Esta operação pode ser utilizada apenas para inserir novos registros. Não é possível realizar
operação de "alteração" ou "exclusão" nesta integração.
Abaixo há um exemplo de requisição para o webhook de títulos. A URL contém campos que
variam para cada cadastro do webhook, realizado na tela de webservice. Os campos variáveis
estão envolvidos por “{ }”. A URL completa é obtida na tela de webservices, após a criação do
webservice deste webhook.
Exemplo:
Campos marcados com (*) são de preenchimento obrigatório e caso não sejam preenchidos o
registro será ignorado.
Objeto Titulo
*tipoTitulo (string): Deve ser preenchido com uma das seguintes opções:
Pagar
Receber
*emissao (string, formato “yyyy-MM-dd”) : Deve ser preenchido com a data de emissão do título.
*valor (double, formato “0.00”) : Deve ser preenchido com o valor total do título.
*tipoDocumento (string) : Deve ser preenchido com uma das opções abaixo:
Duplicata
Boleto
Nota Fiscal
Nota De Débito
Conta De Consumo
Cupom Fiscal
Outros
Previsão
*contaBancaria (string) : Deve ser preenchido com o nome de uma conta bancária já cadastrada
no sistema.
*meioPagamento (string) : Deve ser preenchido com uma das opções abaixo:
Boleto
Dinheiro
Cheque
DDA
DOC/TED
Depósito em Conta
Transferência Bancária
Débito Automático
Cartão de Crédito / Débito
Outros
historico (string) : Esta informação é opcional, e se trata de uma descrição que pode ser
adicionada ao título.
remessaCnab (boolean) : Este campo é opcional e está relacionado com a origem do título,
podendo ser da importação comum de títulos (false) ou gerado pelo CNAB (true). Caso não seja
preenchido no body, o valor do campo será false.
receitaDeCaixa (boolean) : Este campo é opcional e está relacionado ao título ser mostrado ou
não na tela de fechamento de caixa. Caso não seja preenchido no body, o valor do campo será
false.
*parcelas (array de objetos) : Deve ser preenchido com os detalhes de cada parcela do título, no
formato do “Objeto Parcela” descrito neste artigo. Qualquer título, mesmo que não seja
parcelado, terá pelo menos uma parcela, com número “1”, para que seja informado o
vencimento, e a possível liquidação.
*rateios (array de objetos) : Deve ser preenchido com os detalhes do rateio do título, no formato
“Objeto Rateio” descrito neste artigo. Qualquer título, mesmo que não seja rateado, terá pelo
menos um rateio, para que seja informado centro de custo, e plano de contas.
Objeto Parcela
*vencimento (string, formato “yyyy-MM-dd”) : Deve ser preenchido com a data de vencimento da
parcela.
*valor (double, formato “0.00”) : Deve ser preenchido com o valor da parcela.
liquidacao (string, formato “yyyy-MM-dd”) : O campo é opcional. Caso não seja preenchido a
parcela será considerada como não liquidada, mas caso seja preenchido, a parcela será
liquidada, com a data informada.
codigoDeBarras (string) : O campo é opcional.
Objeto Rateio
*competencia (string, formato “MM-dd”) : Deve ser preenchido com a data de competência deste
rateio.
centroDeCusto (string) : Deve ser preenchido com o nome do centro de custo cadastrado no
sistema, que será relacionado ao rateio. Caso o campo não seja preenchido, será utilizado o
centro de custo padrão. Os centros de custo disponíveis podem ser obtidos na API pública, no
seguinte endpoint da documentação: F360 Finanças (getpostman.com)
*planoDeContas (string) : Deve ser preenchido com um plano de contas cadastrado no sistema,
que será relacionado ao rateio. Os planos de contas disponíveis podem ser obtidos na API
pública, no seguinte endpoint da documentação: F360 Finanças (getpostman.com)
*numeroParcela (short) : Deve ser preenchido com o número da parcela à qual este rateio faz
referência.
*valor (double, formato “0.00”) : Deve ser preenchido com o valor do rateio.
Regras de Leitura
Tabelas
Um grande abraço,
Equipe F360°
Sim Não
Voltar ao topo
Artigos relacionados
Como criar uma URL para envio de mensagens via WebHook para integração com o módulo
F360 Finanças
Como criar uma chave de API para integração com o módulo F360 Finanças
Diagnóstico
Comentários
0 comentário
Por favor, entre para comentar.
F360
Powered by Zendesk