Você está na página 1de 13

F360 > F360 Finanças > Integrações

Pesquisa

Artigos nessa seção

Integração F360º e outras plataformas


(Webhooks)
DEV
há 2 meses · Atualizado

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

"identificador-unico-do-servico": é um Id que nós geramos e enviamos mediante a solicitação


da empresa que irá fornecedor os dados.

"servico-consumido": é o endereço para o qual deveremos direcionar a request.

Consulta de disponibilidade de serviço

É 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

Criação de Cupons Fiscais - (Webhook F360 - PDV)

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:

curl --location --request POST 'https://webhook.f360.com.br/identificador-uni


cupom-fiscal' \
--header 'Content-Type: application/json' \
--data-raw '{
"NomeSistema": "Meu PDV",
"Values": [
{
"NumeroCupom": "123456",
"CNPJEmitente": "01234567000199",
"Cliente": {
"Nome": "João da Silva",
"Cpf": "123.456.789-10"
},
"MeioPagamento": [
{
"FormaPagamento": "Dinheiro",
"Valor": 71.12,
"Bandeira": "",
"Autorizacao": "",
"NSU": "",
"QtdParcelas": "1",
"Vencimento": "2022-05-26T15:08:26"
}
],
"Data": "2022-05-26T15:08:26"
},
{
"NumeroCupom": "123457",
"CNPJEmitente": "01234567000199",
"Cliente": {
"Nome": "Jorge da Silva",
"Cpf": "456.807.789-10"
},
"MeioPagamento": [
{
"FormaPagamento": "Cartao Parcelado",
"Valor": 38.40,
"Bandeira": "",
"Autorizacao": "A25V87",
"NSU": "123456",
"QtdParcelas": "2",
"Parcelas": [
{
"DataDeApresentacao": "2022-05-26",
"Valor": 19.2,
"NumeroDaParcela": "1",
"Vencimento": "2022-06-26"
},
{
"DataDeApresentacao": "2022-05-26",
"Valor": 19.2,
"NumeroDaParcela": "2",
"Vencimento": "2022-07-26"
}
]
},
{
"FormaPagamento": "Cartao Debito",
"Valor": 21.50,
"Bandeira": "",
"Autorizacao": "",
"NSU": "789654",
"QtdParcelas": "1",
"Vencimento": "2022-05-27T15:08:26"
}
],
"Data": "2022-05-26T15:08:26",
"VendaCancelada": true
}
]
}'

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.

Atenção: Apesar de aceitarmos mais de um cupom fiscal no mesmo corpo da request, é


importante observar que o ‘CNPJEmitente’ e o dia das datas das vendas devem ser únicos
dentro da mesma request. Já a informação da hora da venda (que complementa o campo ‘Data’)
pode ser diferente dentre os cupons fiscais.

Detalhamento dos campos

*NumeroCupom (long): Número do cupom da venda.

*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.

*Data (string, formato: “yyyy-MM-ddTHH:mm:ss”): Data em que a venda foi realizada.

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.

*FormaPagamento (string): Forma com que foi efetuada o pagamento

*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’.

Autorizacao (string): Informação que comprava a autenticidade do pagamento, e é gerado pela


adquirente contratada do cliente.

NSU (long): É código de rastreio do pagamento, e é gerado pela adquirente contratada do


cliente.

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.

Vencimento (string, formato: “yyyy-MM-ddTHH:mm:ss”): Data de vencimento do pagamento.

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:

DataDeApresentacao (string, formato: “yyyy-MM-dd”): Data de apresentação da parcela.


Valor (double, ‘0.00’): Valor da parcela
NumeroDaParcela (int): Numero da parcela
Vencimento (string, formato: “yyyy-MM-ddTHH:mm:ss”): Data de vencimento da parcela.

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.

Criação de Títulos (Contas a pagar/receber) - (Webhook F360 - Titulos)

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.

Algumas informações cadastradas no sistema, como Plano de Contas e Centro de Custo,


podem ser consultadas em nossa API pública, cada uma em seu respectivo endpoint, conforme
descrito na documentação, disponível no link a seguir: F360 Finanças (getpostman.com)

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:

curl --location 'https://webhook.f360.com.br/{identificador-unico-do-servico


--header 'Content-Type: application/json' \
--data '{
"titulos": [
{
"cnpj": "00.000.000/0000-00",
"tipoTitulo": "receber",
"numeroTitulo": "123456",
"clienteFornecedor": "João da Silva",
"emissao": "2023-02-14",
"valor": 150,
"tipoDocumento": "boleto",
"contaBancaria": "nome da conta bancária",
"meioPagamento": "boleto",
"historico": "",
"remessaCnab": false,
"receitaDeCaixa": false,
"parcelas": [{
"vencimento": "2023-03-14",
"valor": 150,
"numeroParcela": 1,
"liquidacao": null,
"codigoDeBarras" : null
}],
"rateio": [{
"competencia": "03-2022",
"centroDeCusto": "centro de custo",
"planoDeContas": "vendas de mercadorias",
"numeroParcela": 1,
"valor": 150
}]
}
]
}'

Detalhamento dos campos

Campos marcados com (*) são de preenchimento obrigatório e caso não sejam preenchidos o
registro será ignorado.

Objeto Titulo

*cnpj (string) : Deve ser preenchido com o CNPJ da empresa.

*tipoTitulo (string): Deve ser preenchido com uma das seguintes opções:

Pagar
Receber

*numeroTitulo (string) : Deve ser preenchido com o número do título

*clienteFornecedor (string) : Deve ser preenchido com o CPF/CNPJ ou nome do fornecedor em


contas a pagar, ou cliente em contas a receber. Caso a pessoa não exista no sistema, ela será
criada.

*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.

*numeroParcela (short) : Deve ser preenchido com o número 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

Todo título deve ter pelo menos uma parcela e um rateio


O rateio deve corresponder a uma parcela que foi preenchida
A soma do valor das parcelas deve corresponder ao valor do título
A soma dos valores dos rateios da mesma parcela, deve corresponder ao valor da parcela

Tabelas

Tabela 1 - Bandeiras de Cartão


99 Food Cabal Garantido ABC
Abastece Aí Cabal Alimentação Gift Card
Acqio CalCard Goias Card
Adiq Card System Golden Farma
Adyen Cartao Good Card Plus
Agiplan Cartão Confiança Goodcard
Alelo Cartão SupCard Grand Card
Alelo Alimentação Chefmio Granito
Alelo Cultura Chilli Match GreenCard
Alelo Refeição Cispay Hiper
Ame Digital CompreMax Hipercard
Amex Compro Card IBI Card
ASCIPAM Convenios Card IdealCard
Asu CooperCred IFood
Aura CornershopApp JamesDelivery
Avancard CrediShop JCB
BandCard CredNosso King Pay
Banescard Crednova Kredit
Banese Card CredPar Lagoacred
Banpara Credshop Libercard
Banquet CredSystem Linx Pay
Banri Card Credz Linx S.A.
BanriCompras Cros Card Losango
Banrisul DaCasa Maestro
Banrisul Cultura Delivery Center Magalu
Barra Cred Delivery Direto Mais
BCard Diners MasterCard
Ben Visa Vale Dinheiro Masterfarma
BigCard Discovery Maxxivan
Blu ECX Card Mercado Pago
BNBClube Electron Money Plus
Bônus CBA Elo Mooz Boleto
Bônus Cred Esplanada Mooz Omnichannel
Mooz Omnichannel
Borba Net Expers
Boleto
BR Card Fininvest Moreira Card
Bradesco FitCard - Prime Movile Pay
Brasil Card(.net) FitCard Link Benefícios MultMais Card
BrasilCard FitCard Neo Benefícios NutriCash
Braspag Flexocard Nutricash Cultura
Braspag Boleto FortBrasil Omni
C6 Pay Fortcard Pagar Me
PagarMe - Track&Field Sindcred ValeMulti
PagarMe Boleto Sipag Valorem Pay
PagoLivre Sodexo Vegas Card
Pagseguro Boleto Sodexo Alimentação VerdeCard
PagueLogo Sodexo Combustível Verocard
Pão de Açucar Sodexo Cultura VeroCheque
Payly Sodexo Gift Vinhecard
PayPal Sodexo Premium Visa
Personal Card Sodexo Refeição Visa Electron
Picpay Softcred Visa Vale
PitCard Solucard VR
PIX SoroCred VR Alimentação
PlanVale Stone VR Auto
PlanVale Alimentação Sysdata VR Cultura
PlanVale Combustível SysproCard VR Refeição
PlanVale Cultura System Farma Vuon Card
PlanVale Farmácia Tecard Westwing
PlanVale Refeição TerCRED Wirecard
PoliCard Ticket Wizeo
Policard Ticket Alimentação Zoop - Opatech
Quero2Pay Ticket Cultura  
Rappi Ticket Parceiro  
Rappi App Varejo Ticket Refeição  
Redconv Ticket Restaurante  
RedeMed TKS (Global Payments)  
RedeShop ToNoLucro  
Regicred Tricard Mais  
Repom Uber Eats  
Repom Abastecimento Unica  
Repom Saque UnionPay  
Resgate Fácil Up Brasil  
SafraDigital USA Card  
Sapore Usecred  
Sem Parar UVE  
Senff Vale Fácil  
Sertão Card Vale Mais  
Shippi Delivery ValeCard  
Sicredi ValeCard Cultura  
SideCard ValeConcard  
Sin Card ValeFrota  
 

Gostou desse artigo? Tem alguma dúvida ou sugestão?


Por favor, entre em contato com a gente pelo e-mail suporte@f360.com.br e compartilhe suas
experiências. Sua opinião é muito importante para nós.

Um grande abraço,

Equipe F360°

Esse artigo foi útil?

Sim Não

Usuários que acharam isso útil: 1 de 1

Tem mais dúvidas? Envie uma solicitação

Voltar ao topo

Artigos visualizados recentemente


Como criar uma chave de API para integração com o módulo F360 Finanças

Manual PDV Gestão Click via Webservice

Manual de exportação IfoodPay

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

Cadastro de taxas acordadas com a adquirente

Diagnóstico

Acesso as novidades F360°

Comentários
0 comentário
Por favor, entre para comentar.

F360

Powered by Zendesk

Você também pode gostar