URL
Need help?
Alcance novos públicos e converta mais usuários conectando-se fácil e seguramente aos dados financeiros deles, entendendo seu comportamento e possibilitando pagamentos instantâneos com open finance. Através da nossa API, você pode acessar:
A Belvo é uma API de open banking para a América Latina que permite que empresas acessem informações bancárias e fiscais de maneira segura e ágil.
Através da nossa API, você pode acessar:
Você também pode usar nossa API para realizar pagamentos em:
Se você deseja a documentação de resposta em formato Excel ou CSV, por favor, faça o download a partir do nosso Repositório Público no GitHub: Belvo Open Finance Data Dictionaries.
Nossos arquivos EXCEL e CSV estão adicionalmente localizados em Espanhol e Português (Brasil).
Disponível para:
Use nosso ambiente Sandbox para construir sua integração. Oferecemos dados fictícios que imitam casos de uso do mundo real, o que significa que você pode testar todos os endpoints, usar o widget e implementar webhooks - exatamente como faria com dados reais!
Tudo o que você precisa para começar com o ambiente Sandbox é obter suas chaves de API. Recomendamos fortemente que você comece a criar sua integração neste ambiente.
Disponível para:
Depois de testar sua integração no ambiente Sandbox e estar pronto para entrar em operação, você precisará solicitar acesso ao nosso ambiente de Produção. Após solicitar o acesso, nossa equipe de Vendas entrará em contato para agendar uma reunião apenas para garantir que suas necessidades sejam atendidas, e então você precisará passar por um processo de certificação com um de nossos engenheiros para garantir que sua integração esteja funcionando de forma otimizada. Para se preparar para a reunião de certificação, basta seguir nossa lista de verificação de Integração.
Uma vez que sua integração esteja certificada, tudo o que você precisará fazer é:
sandbox.belvo.com para api.belvo.com.Usamos o seguinte código de status HTTP na resposta, dependendo do sucesso ou falha:
| Código de Status | Descrição |
|---|---|
200 | ✅ Sucesso - O conteúdo está disponível no corpo da resposta. |
201 | ✅ Sucesso - O conteúdo foi criado com sucesso na Belvo. |
204 | ✅ Sucesso - Nenhum conteúdo para retornar. |
400 | ❌ Erro de Solicitação Inválida - A solicitação retornou um erro, detalhe no conteúdo. |
401 | ❌ Não Autorizado - As credenciais da Belvo fornecidas não são válidas. |
404 | ❌ Não Encontrado - O recurso que você tentou acessar não pode ser encontrado. |
405 | ❌ Método Não Permitido - O método HTTP que você está usando não é aceito para este recurso. |
408 | ❌ Tempo de Solicitação Esgotado - A solicitação expirou e foi encerrada pelo servidor. |
428 | ❌ Token MFA Necessário - O token MFA foi exigido pela instituição para conectar. |
500 | ❌ Erro Interno do Servidor - O detalhe do erro está disponível no corpo da resposta. |
Os erros da API Belvo são retornados em formato JSON. Por exemplo, um erro pode ser assim:
[
{
"request_id": "a6e1c493d7a29d91aed4338e6fcf077d",
"message": "Este campo é obrigatório.",
"code": "required",
"field": "link"
}
]Normalmente, uma resposta de erro terá os seguintes parâmetros:
request_id: um ID único para a solicitação, você deve compartilhá-lo com a equipe de suporte da Belvo para investigações.message: descrição legível do erro.code: um código único para o erro. Verifique a tabela abaixo para ver como lidar com cada código de erro.field (opcional): O campo específico no corpo da solicitação que tem um problema.Quando você precisar de ajuda com um erro específico, inclua o identificador de solicitação (request_id) em sua mensagem para a equipe de suporte da Belvo. Isso acelerará as investigações e fará com que você volte a funcionar rapidamente.
Para uma lista completa de erros e como solucioná-los, consulte nosso artigo dedicado Tratamento de Erros.
Implemente uma repetição automática exponencial de até cinco tentativas. Recomendamos usar um intervalo base de três segundos com um fator de dois. Por exemplo, a primeira repetição deve ser após três segundos, a segunda repetição após seis segundos (2 * 3), a terceira repetição após 12 segundos (2 * 6), a quarta repetição após 24 segundos (2 * 12) e a quinta repetição após 48 segundos (2 * 24).
Você não deve tentar novamente fazer solicitações se receber uma resposta 40x, pois isso é um erro do cliente.
A única exceção é o erro "Muitas Sessões", pois isso significa que seu usuário final está acessando a conta de outro navegador ao mesmo tempo. Nesse caso, implemente a mesma política de repetição que para erros 50x.
Em nosso esquema, você pode ver que um campo foi marcado como deprecated. Isso significa que este campo não é mais mantido pela equipe da Belvo. Você ainda pode receber dados para este campo dependendo da instituição, no entanto, você não deve confiar neste campo.
Em nossa especificação de API, você verá que alguns parâmetros de resposta terão uma anotação required. De acordo com a especificação OpenAPI, quando um parâmetro de resposta é marcado como required, isso significa que a chave de resposta deve ser retornada. No entanto, o valor desse parâmetro de resposta pode ser null.
📘 Informação
Em resumo, qualquer parâmetro de resposta marcado como obrigatório será retornado pela nossa API, mas o valor pode ser definido como nulo.
https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/
https://sandbox.belvo.com/
Uma instituição é uma entidade da qual a Belvo pode acessar informações. Pode ser uma:
Um Link é um conjunto de credenciais associado ao acesso de um usuário final a uma instituição. Você precisará registrar um Link antes de acessar informações desse usuário final específico, como detalhes de conta ou transações.
Recomendamos usar o Belvo Hosted Widget para gerenciar o processo de conexão.
Um proprietário representa a pessoa que tem acesso a um Link e é o proprietário de todas as contas dentro do Link.
Você pode usar este endpoint para obter informações úteis sobre seu cliente, como:
Uma conta é a representação de uma conta bancária dentro de uma instituição financeira. Um usuário pode ter uma ou mais contas em uma instituição.
Por exemplo, um usuário (ou link) pode ter uma conta corrente, vários cartões de crédito e uma conta de empréstimo.
Consultar as informações da conta de um usuário é útil, pois você pode obter informações sobre:
Nosso recurso de empregos para o Brasil permite que você obtenha uma visão abrangente do histórico de emprego atual e das informações salariais do seu usuário.
Para cada usuário, nós retornamos:
No momento, o recurso de empregos está disponível para:
Nosso recurso de registros de emprego para o México permite que você obtenha uma visão abrangente das contribuições atuais para a seguridade social e do histórico de emprego do seu usuário.
Com o recurso de registros de emprego da Belvo para o México, você pode acessar informações sobre as contribuições atuais para a seguridade social e o histórico de emprego do seu usuário. Para cada usuário, retornamos:
No momento, o recurso de registros de emprego está disponível para:
Recupere informações de faturas a partir de um link fiscal específico.
📘 Informação
Você pode solicitar até um ano (365 dias) de faturas por solicitação. Se precisar de faturas por mais de um ano, basta fazer outra solicitação.
🚧 Aviso
Este recurso pode retornar campos obsoletos. Por favor, verifique a documentação da resposta para mais informações.
Omitir certos campos de serem retornados na resposta. Para mais informações, consulte nosso artigo Filtrando respostas no DevPortal.
Retorne apenas os campos especificados na resposta. Para mais informações, consulte nosso artigo no DevPortal Filtrando respostas.
Parâmetro de cabeçalho recomendado para tornar sua solicitação POST assíncrona (evitando timeouts e melhorando o fluxo de dados).
Quando você faz uma solicitação assíncrona, a Belvo responde com um payload 202 - Accepted, incluindo o request_id. Assim que tivermos recuperado as informações solicitadas, você receberá um webhook com o link e os IDs de solicitação.
O link.id para o qual você deseja recuperar informações.
A data a partir da qual você deseja começar a obter dados, no formato YYYY-MM-DD.
⚠️ O valor de date_from não pode ser maior que date_to.
A data em que você deseja parar de receber dados, no formato YYYY-MM-DD.
⚠️ O valor de date_to não pode ser maior que a data de hoje (ou seja, não são permitidas datas futuras).
A direção da fatura (do ponto de vista do proprietário do Link).
OUTFLOW indica uma fatura enviada.INFLOW indica uma fatura recebida.Quando definido como true, você receberá a fatura XML na resposta.
https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/api/invoices/
https://sandbox.belvo.com/api/invoices/
curl -i -X POST \
-u <username>:<password> \
'https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/api/invoices/?fields=string&omit=string' \
-H 'Content-Type: application/json' \
-H 'X-Belvo-Request-Mode: async' \
-d '{
"link": "c81a1dea-6dd6-4999-8b9f-541ee8197058",
"date_from": "2020-08-05",
"date_to": "2020-10-05",
"type": "INFLOW",
"attach_xml": false,
"save_data": true
}'Ok (quando save_data=false)
Identificador único da Belvo para o item atual.
O link.id ao qual os dados pertencem.
O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.
O ID único da instituição fiscal para a fatura.
O status da fatura. Pode ser Vigente (válido) ou Cancelado (cancelado).
A classificação da fatura pela instituição fiscal.
Para o SAT do México, retornamos um dos seguintes valores:
EgresoIngresoNóminaPagoTrasladoA direção da fatura (do ponto de vista do proprietário do Link).
OUTFLOW indica uma fatura enviada.INFLOW indica uma fatura recebida.O regime tributário do remetente, conforme definido pela pessoa jurídica no país.
Indica se o remetente está ou não na lista de fraude fiscal do SAT por ter enviado dados incorretos, ter pagamentos pendentes ou ter realizado negócios que violam os regulamentos da instituição fiscal.
O SAT atualiza a lista de fraude fiscal a cada três meses.
Para mais informações sobre os motivos pelos quais um contribuinte pode ser incluído na lista de fraude fiscal, consulte o Artigo 69 e o Artigo 69-B do Código Fiscal da Federação do México.
Os status possíveis são:
INVESTIGATING DISMISSED CONFIRMED OVERTURNED NO_TAX_FRAUD_STATUS O regime tributário do recebedor, conforme definido pela pessoa jurídica no país.
Indica se o destinatário está ou não na lista de fraude fiscal do SAT por ter enviado dados incorretos, ter pagamentos pendentes ou ter realizado negócios que violam os regulamentos da instituição fiscal.
O SAT atualiza a lista de fraude fiscal a cada três meses.
Para mais informações sobre os motivos pelos quais um contribuinte pode ser incluído na lista de fraude fiscal, consulte o Artigo 69 e o Artigo 69-B do Código Fiscal da Federação do México.
Os status possíveis são:
INVESTIGATING DISMISSED CONFIRMED OVERTURNED NO_TAX_FRAUD_STATUS Se a fatura for cancelada, este campo indica o status do cancelamento.
A data do cancelamento da fatura, no formato YYYY-MM-DD.
A data da certificação fiscal, no formato YYYY-MM-DD.
O ID fiscal do provedor de certificação.
O código do tipo de pagamento usado para esta fatura, conforme definido pela entidade legal do país.
O código do método de pagamento usado para esta fatura, conforme definido pela entidade legal do país.
PUE, PPD ou null.O código de uso da fatura, conforme definido pela entidade legal do país.
Uma lista de descrições para cada item (produto comprado ou serviço prestado) na fatura.
O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
A descrição do item da fatura (uma fatura pode ter um ou mais itens).
O código de identificação do produto ou serviço, conforme definido pela entidade legal no país.\n- \U0001F1F2\U0001F1FD México.
A unidade de medida, conforme definida pela entidade legal no país. \n- \U0001F1F2\U0001F1FD México referência do catálogo SAT.
A descrição do item, conforme definido pela entidade legal no país.\n- \U0001F1F2\U0001F1FD México referência do catálogo SAT.
O preço total deste item antes da aplicação de impostos é (quantity x unit_amount).
O valor do imposto para este item da fatura (pre_tax_amount x tax_percentage).
O preço total para este item da fatura (pre_tax_amount + tax_amount).
A moeda da fatura. Por exemplo:
O valor antes dos impostos desta fatura (soma do pre_tax_amount de cada item).
A taxa de câmbio utilizada nesta fatura para a moeda.
O valor do imposto para esta fatura (soma do tax_amount de cada item).
O valor total da fatura (subtotal_amount + tax_amount - discount_amount)
Uma lista detalhando todos os pagamentos de faturas.
Carimbo de data/hora ISO-8601 quando o pagamento foi realizado.
Código do tipo de pagamento usado para esta fatura, conforme definido pela entidade legal do país.
A moeda do pagamento. Por exemplo:
Por favor, note que outras moedas além das listadas acima podem ser retornadas.
A taxa de câmbio de currency para MXN no momento em que o pagamento foi realizado.
O valor da fatura, na moeda da fatura original.
O identificador interno da instituição fiscal para a operação.
O número da conta bancária do beneficiário do pagamento.
O número da conta bancária do emissor do pagamento.
A instituição bancária que foi utilizada pelo emissor do pagamento.
Uma lista de todas as faturas diferidas relacionadas afetadas pelo pagamento.
O ID exclusivo da instituição fiscal para a fatura diferida relacionada.
A moeda da fatura relacionada. Por exemplo:
Por favor, note que outras moedas além das listadas acima podem ser retornadas.
O valor da fatura antes do pagamento.
Detalhes sobre o pagamento da folha de pagamento. Aplicável apenas para faturas de folha de pagamento.
O tipo de folha de pagamento, conforme definido pela entidade legal do país.
A data de início do período de pagamento, no formato YYYY-MM-DD.
A data de término do período de pagamento, no formato YYYY-MM-DD.
O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
A data de pagamento, no formato YYYY-MM-DD.
Com que frequência o pagamento da folha de pagamento é realizado.
Para o SAT do México, retornamos um dos seguintes valores:
DAILYWEEKLYTENTH_DAYFOURTEENTH_DAYFIFTEENTH_DAYMONTHLYBIMONTHLYPER_TASKCOMMISSIONONE_OFFOTHER_PERIODICITYUma análise detalhada dos ganhos para o pagamento da folha de pagamento.
Uma análise das deduções fiscais no pagamento da folha de pagamento.
O número de controle interno que o contribuinte atribui à nota fiscal.
O tipo de exportação da fatura, conforme definido pela entidade legal no país. Para mais informações, consulte nosso artigo de referência do catálogo SAT.
Objeto contendo informações sobre quaisquer avisos relacionados a esta fatura.
Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.
Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.
A descrição do método de pagamento utilizado para esta fatura.
Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados. Por favor, use sender_tax_fraud_status em vez disso.
Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados. Por favor, use receiver_tax_fraud_status em vez disso.
Exemplo de uma fatura do tipo Igreso.
[ { "id": "90d90e38-0087-4b6d-b6dc-94ea561bb9cb", "link": "1bd948f7-245d-4313-b604-34d1044cb908", "collected_at": "2022-02-09T08:45:50.406032Z", "created_at": "2022-02-09T08:46:20.406032Z", "invoice_identification": "862B9918-3K6H-4E0B-NAI9-2BE2D833B840", "invoice_date": "2020-12-24", "status": "Vigente", "invoice_type": "Ingreso", "type": "OUTFLOW", "sender_id": "GHTF980303F7", "sender_name": "Roberto Martinez Diaz", "sender_tax_fraud_status": "NO_TAX_FRAUD_STATUS", "receiver_id": "MNMK3203409H1", "receiver_name": "ACNE SA DE CV", "receiver_tax_fraud_status": "NO_TAX_FRAUD_STATUS", "cancelation_status": null, "cancelation_update_date": null, "certification_date": "2020-12-24", "certification_authority": "FGV330542BG6", "payment_type": "04", "payment_type_description": null, "payment_method": "PUE", "usage": "G03", "place_of_issue": "11000", "version": "3.3", "invoice_details": [ … ], "currency": "MXN", "subtotal_amount": 25, "exchange_rate": 1, "tax_amount": 4, "discount_amount": 0, "total_amount": 29, "payments": [], "payroll": null, "folio": "28", "xml": "=XML-STRING=", "warnings": { … } } ]
Omitir certos campos de serem retornados na resposta. Para mais informações, consulte nosso artigo Filtrando respostas no DevPortal.
Retorne apenas os campos especificados na resposta. Para mais informações, consulte nosso artigo no DevPortal Filtrando respostas.
A sessão que você deseja retomar. Você precisa usar o valor session que é fornecido na resposta 428 Token Required que você recebe após fazer sua solicitação POST.
O token MFA gerado pela instituição, que é necessário para continuar uma sessão.
O link.id que você deseja retomar. Deve ser o mesmo link.id que você recebe na resposta 428 Token Required que contém o ID da session.
https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/api/invoices/
https://sandbox.belvo.com/api/invoices/
curl -i -X PATCH \
-u <username>:<password> \
'https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/api/invoices/?fields=string&omit=string' \
-H 'Content-Type: application/json' \
-d '{
"session": "6e7b283c6efa449c9c028a16b5c249fa",
"token": "1234ab",
"link": "683005d6-f45c-4adb-b289-f1a12f50f80c",
"save_data": true
}'Ok (quando save_data=false)
Identificador único da Belvo para o item atual.
O link.id ao qual os dados pertencem.
O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.
O ID único da instituição fiscal para a fatura.
O status da fatura. Pode ser Vigente (válido) ou Cancelado (cancelado).
A classificação da fatura pela instituição fiscal.
Para o SAT do México, retornamos um dos seguintes valores:
EgresoIngresoNóminaPagoTrasladoA direção da fatura (do ponto de vista do proprietário do Link).
OUTFLOW indica uma fatura enviada.INFLOW indica uma fatura recebida.O regime tributário do remetente, conforme definido pela pessoa jurídica no país.
Indica se o remetente está ou não na lista de fraude fiscal do SAT por ter enviado dados incorretos, ter pagamentos pendentes ou ter realizado negócios que violam os regulamentos da instituição fiscal.
O SAT atualiza a lista de fraude fiscal a cada três meses.
Para mais informações sobre os motivos pelos quais um contribuinte pode ser incluído na lista de fraude fiscal, consulte o Artigo 69 e o Artigo 69-B do Código Fiscal da Federação do México.
Os status possíveis são:
INVESTIGATING DISMISSED CONFIRMED OVERTURNED NO_TAX_FRAUD_STATUS O regime tributário do recebedor, conforme definido pela pessoa jurídica no país.
Indica se o destinatário está ou não na lista de fraude fiscal do SAT por ter enviado dados incorretos, ter pagamentos pendentes ou ter realizado negócios que violam os regulamentos da instituição fiscal.
O SAT atualiza a lista de fraude fiscal a cada três meses.
Para mais informações sobre os motivos pelos quais um contribuinte pode ser incluído na lista de fraude fiscal, consulte o Artigo 69 e o Artigo 69-B do Código Fiscal da Federação do México.
Os status possíveis são:
INVESTIGATING DISMISSED CONFIRMED OVERTURNED NO_TAX_FRAUD_STATUS Se a fatura for cancelada, este campo indica o status do cancelamento.
A data do cancelamento da fatura, no formato YYYY-MM-DD.
A data da certificação fiscal, no formato YYYY-MM-DD.
O ID fiscal do provedor de certificação.
O código do tipo de pagamento usado para esta fatura, conforme definido pela entidade legal do país.
O código do método de pagamento usado para esta fatura, conforme definido pela entidade legal do país.
PUE, PPD ou null.O código de uso da fatura, conforme definido pela entidade legal do país.
Uma lista de descrições para cada item (produto comprado ou serviço prestado) na fatura.
O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
A descrição do item da fatura (uma fatura pode ter um ou mais itens).
O código de identificação do produto ou serviço, conforme definido pela entidade legal no país.\n- \U0001F1F2\U0001F1FD México.
A unidade de medida, conforme definida pela entidade legal no país. \n- \U0001F1F2\U0001F1FD México referência do catálogo SAT.
A descrição do item, conforme definido pela entidade legal no país.\n- \U0001F1F2\U0001F1FD México referência do catálogo SAT.
O preço total deste item antes da aplicação de impostos é (quantity x unit_amount).
O valor do imposto para este item da fatura (pre_tax_amount x tax_percentage).
O preço total para este item da fatura (pre_tax_amount + tax_amount).
A moeda da fatura. Por exemplo:
O valor antes dos impostos desta fatura (soma do pre_tax_amount de cada item).
A taxa de câmbio utilizada nesta fatura para a moeda.
O valor do imposto para esta fatura (soma do tax_amount de cada item).
O valor total da fatura (subtotal_amount + tax_amount - discount_amount)
Uma lista detalhando todos os pagamentos de faturas.
Carimbo de data/hora ISO-8601 quando o pagamento foi realizado.
Código do tipo de pagamento usado para esta fatura, conforme definido pela entidade legal do país.
A moeda do pagamento. Por exemplo:
Por favor, note que outras moedas além das listadas acima podem ser retornadas.
A taxa de câmbio de currency para MXN no momento em que o pagamento foi realizado.
O valor da fatura, na moeda da fatura original.
O identificador interno da instituição fiscal para a operação.
O número da conta bancária do beneficiário do pagamento.
O número da conta bancária do emissor do pagamento.
A instituição bancária que foi utilizada pelo emissor do pagamento.
Uma lista de todas as faturas diferidas relacionadas afetadas pelo pagamento.
O ID exclusivo da instituição fiscal para a fatura diferida relacionada.
A moeda da fatura relacionada. Por exemplo:
Por favor, note que outras moedas além das listadas acima podem ser retornadas.
O valor da fatura antes do pagamento.
Detalhes sobre o pagamento da folha de pagamento. Aplicável apenas para faturas de folha de pagamento.
O tipo de folha de pagamento, conforme definido pela entidade legal do país.
A data de início do período de pagamento, no formato YYYY-MM-DD.
A data de término do período de pagamento, no formato YYYY-MM-DD.
O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
A data de pagamento, no formato YYYY-MM-DD.
Com que frequência o pagamento da folha de pagamento é realizado.
Para o SAT do México, retornamos um dos seguintes valores:
DAILYWEEKLYTENTH_DAYFOURTEENTH_DAYFIFTEENTH_DAYMONTHLYBIMONTHLYPER_TASKCOMMISSIONONE_OFFOTHER_PERIODICITYUma análise detalhada dos ganhos para o pagamento da folha de pagamento.
Uma análise das deduções fiscais no pagamento da folha de pagamento.
O número de controle interno que o contribuinte atribui à nota fiscal.
O tipo de exportação da fatura, conforme definido pela entidade legal no país. Para mais informações, consulte nosso artigo de referência do catálogo SAT.
Objeto contendo informações sobre quaisquer avisos relacionados a esta fatura.
Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.
Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.
A descrição do método de pagamento utilizado para esta fatura.
Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados. Por favor, use sender_tax_fraud_status em vez disso.
Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados. Por favor, use receiver_tax_fraud_status em vez disso.
[ { "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "link": "30cb4806-6e00-48a4-91c9-ca55968576c8", "collected_at": "2022-02-09T08:45:50.406032Z", "created_at": "2022-02-09T08:45:50.406032Z", "invoice_identification": "A1A1A1A1-2B2B-3C33-D44D-555555E55EE", "invoice_date": "2019-12-01", "status": "Vigente", "invoice_type": "Ingreso", "type": "INFLOW", "tax_details": { … }, "sender_id": "AAA111111AA11", "sender_fiscal_regime": "601", "sender_name": "ACME CORP", "sender_tax_fraud_status": "NO_TAX_FRAUD_STATUS", "receiver_id": "BBB222222BB22", "receiver_postal_code": "11560", "receiver_fiscal_regime": "601", "receiver_name": "BELVO CORP", "receiver_tax_fraud_status": "NO_TAX_FRAUD_STATUS", "cancelation_status": "string", "cancelation_update_date": "2019-12-02", "certification_date": "2019-12-01", "certification_authority": "CCC333333CC33", "payment_type": "99", "payment_type_description": null, "payment_method": "PUE", "payment_method_description": null, "usage": "P01", "version": "3.3", "place_of_issue": "01165", "invoice_details": [ … ], "currency": "MXN", "subtotal_amount": 400, "exchange_rate": 0.052, "tax_amount": 64, "discount_amount": 10, "total_amount": 454, "related_invoices": [ … ], "payments": [ … ], "payroll": { … }, "folio": "26", "export_type": "01", "xml": "string", "warnings": { … }, "sender_blacklist_status": null, "receiver_blacklist_status": null } ]
Omitir certos campos de serem retornados na resposta. Para mais informações, consulte nosso artigo Filtrando respostas no DevPortal.
Retorne apenas os campos especificados na resposta. Para mais informações, consulte nosso artigo no DevPortal Filtrando respostas.
https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/api/invoices/{id}/
https://sandbox.belvo.com/api/invoices/{id}/
curl -i -X GET \
-u <username>:<password> \
'https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/api/invoices/{id}/?fields=string&omit=string'Ok
Identificador único da Belvo para o item atual.
O link.id ao qual os dados pertencem.
O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.
O ID único da instituição fiscal para a fatura.
O status da fatura. Pode ser Vigente (válido) ou Cancelado (cancelado).
A classificação da fatura pela instituição fiscal.
Para o SAT do México, retornamos um dos seguintes valores:
EgresoIngresoNóminaPagoTrasladoA direção da fatura (do ponto de vista do proprietário do Link).
OUTFLOW indica uma fatura enviada.INFLOW indica uma fatura recebida.O regime tributário do remetente, conforme definido pela pessoa jurídica no país.
Indica se o remetente está ou não na lista de fraude fiscal do SAT por ter enviado dados incorretos, ter pagamentos pendentes ou ter realizado negócios que violam os regulamentos da instituição fiscal.
O SAT atualiza a lista de fraude fiscal a cada três meses.
Para mais informações sobre os motivos pelos quais um contribuinte pode ser incluído na lista de fraude fiscal, consulte o Artigo 69 e o Artigo 69-B do Código Fiscal da Federação do México.
Os status possíveis são:
INVESTIGATING DISMISSED CONFIRMED OVERTURNED NO_TAX_FRAUD_STATUS O regime tributário do recebedor, conforme definido pela pessoa jurídica no país.
Indica se o destinatário está ou não na lista de fraude fiscal do SAT por ter enviado dados incorretos, ter pagamentos pendentes ou ter realizado negócios que violam os regulamentos da instituição fiscal.
O SAT atualiza a lista de fraude fiscal a cada três meses.
Para mais informações sobre os motivos pelos quais um contribuinte pode ser incluído na lista de fraude fiscal, consulte o Artigo 69 e o Artigo 69-B do Código Fiscal da Federação do México.
Os status possíveis são:
INVESTIGATING DISMISSED CONFIRMED OVERTURNED NO_TAX_FRAUD_STATUS Se a fatura for cancelada, este campo indica o status do cancelamento.
A data do cancelamento da fatura, no formato YYYY-MM-DD.
A data da certificação fiscal, no formato YYYY-MM-DD.
O ID fiscal do provedor de certificação.
O código do tipo de pagamento usado para esta fatura, conforme definido pela entidade legal do país.
O código do método de pagamento usado para esta fatura, conforme definido pela entidade legal do país.
PUE, PPD ou null.O código de uso da fatura, conforme definido pela entidade legal do país.
Uma lista de descrições para cada item (produto comprado ou serviço prestado) na fatura.
O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
A descrição do item da fatura (uma fatura pode ter um ou mais itens).
O código de identificação do produto ou serviço, conforme definido pela entidade legal no país.\n- \U0001F1F2\U0001F1FD México.
A unidade de medida, conforme definida pela entidade legal no país. \n- \U0001F1F2\U0001F1FD México referência do catálogo SAT.
A descrição do item, conforme definido pela entidade legal no país.\n- \U0001F1F2\U0001F1FD México referência do catálogo SAT.
O preço total deste item antes da aplicação de impostos é (quantity x unit_amount).
O valor do imposto para este item da fatura (pre_tax_amount x tax_percentage).
O preço total para este item da fatura (pre_tax_amount + tax_amount).
A moeda da fatura. Por exemplo:
O valor antes dos impostos desta fatura (soma do pre_tax_amount de cada item).
A taxa de câmbio utilizada nesta fatura para a moeda.
O valor do imposto para esta fatura (soma do tax_amount de cada item).
O valor total da fatura (subtotal_amount + tax_amount - discount_amount)
Uma lista detalhando todos os pagamentos de faturas.
Carimbo de data/hora ISO-8601 quando o pagamento foi realizado.
Código do tipo de pagamento usado para esta fatura, conforme definido pela entidade legal do país.
A moeda do pagamento. Por exemplo:
Por favor, note que outras moedas além das listadas acima podem ser retornadas.
A taxa de câmbio de currency para MXN no momento em que o pagamento foi realizado.
O valor da fatura, na moeda da fatura original.
O identificador interno da instituição fiscal para a operação.
O número da conta bancária do beneficiário do pagamento.
O número da conta bancária do emissor do pagamento.
A instituição bancária que foi utilizada pelo emissor do pagamento.
Uma lista de todas as faturas diferidas relacionadas afetadas pelo pagamento.
O ID exclusivo da instituição fiscal para a fatura diferida relacionada.
A moeda da fatura relacionada. Por exemplo:
Por favor, note que outras moedas além das listadas acima podem ser retornadas.
O valor da fatura antes do pagamento.
Detalhes sobre o pagamento da folha de pagamento. Aplicável apenas para faturas de folha de pagamento.
O tipo de folha de pagamento, conforme definido pela entidade legal do país.
A data de início do período de pagamento, no formato YYYY-MM-DD.
A data de término do período de pagamento, no formato YYYY-MM-DD.
O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
A data de pagamento, no formato YYYY-MM-DD.
Com que frequência o pagamento da folha de pagamento é realizado.
Para o SAT do México, retornamos um dos seguintes valores:
DAILYWEEKLYTENTH_DAYFOURTEENTH_DAYFIFTEENTH_DAYMONTHLYBIMONTHLYPER_TASKCOMMISSIONONE_OFFOTHER_PERIODICITYUma análise detalhada dos ganhos para o pagamento da folha de pagamento.
Uma análise das deduções fiscais no pagamento da folha de pagamento.
O número de controle interno que o contribuinte atribui à nota fiscal.
O tipo de exportação da fatura, conforme definido pela entidade legal no país. Para mais informações, consulte nosso artigo de referência do catálogo SAT.
Objeto contendo informações sobre quaisquer avisos relacionados a esta fatura.
Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.
Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.
A descrição do método de pagamento utilizado para esta fatura.
Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados. Por favor, use sender_tax_fraud_status em vez disso.
Exemplo de uma fatura do tipo Igreso.
{ "id": "90d90e38-0087-4b6d-b6dc-94ea561bb9cb", "link": "1bd948f7-245d-4313-b604-34d1044cb908", "collected_at": "2022-02-09T08:45:50.406032Z", "created_at": "2022-02-09T08:46:20.406032Z", "invoice_identification": "862B9918-3K6H-4E0B-NAI9-2BE2D833B840", "invoice_date": "2020-12-24", "status": "Vigente", "invoice_type": "Ingreso", "type": "OUTFLOW", "sender_id": "GHTF980303F7", "sender_name": "Roberto Martinez Diaz", "sender_tax_fraud_status": "NO_TAX_FRAUD_STATUS", "receiver_id": "MNMK3203409H1", "receiver_name": "ACNE SA DE CV", "receiver_tax_fraud_status": "NO_TAX_FRAUD_STATUS", "cancelation_status": null, "cancelation_update_date": null, "certification_date": "2020-12-24", "certification_authority": "FGV330542BG6", "payment_type": "04", "payment_type_description": null, "payment_method": "PUE", "usage": "G03", "place_of_issue": "11000", "version": "3.3", "invoice_details": [ { … } ], "currency": "MXN", "subtotal_amount": 25, "exchange_rate": 1, "tax_amount": 4, "discount_amount": 0, "total_amount": 29, "payments": [], "payroll": null, "folio": "28", "xml": "=XML-STRING=", "warnings": { "code": "warning_code", "message": "warning message" } }
Use o endpoint Incomes para obter insights sobre as fontes de renda de uma conta nos últimos 365 dias. O endpoint é particularmente útil quando você deseja verificar a renda de uma pessoa.
📘 Info
O recurso incomes está disponível apenas para contas Corrente e Poupança associadas a links bancários.
A API de Despesas Recorrentes da Belvo permite que você identifique os pagamentos regulares de um usuário para serviços de assinatura, como Netflix ou assinaturas de academia, bem como pagamentos de serviços públicos, como contas de eletricidade ou telefone. Nós retornamos informações de até 365 dias.
📘 Informação
O recurso de despesas recorrentes está disponível apenas para contas Corrente, Poupança e de Cartão de Crédito associadas a links bancários.
Para receber pagamentos de entrada na conta bancária da sua organização, você deve registrar as contas bancárias (individuais e empresariais) usando a Payments API da Belvo.
Um payment intent é um ponto único de acesso para criar pagamentos usando qualquer método de pagamento oferecido pela Belvo.
Um payment intent captura todas as informações de pagamento (como o valor a ser cobrado, a descrição do pagamento, o provedor, etc.) e guia seus clientes através do fluxo de pagamento.
Nota: Para instituições que exigem o
username_typeno arrayform_fields, você deve enviar esse valor na sua solicitação PATCH.