API Antecipações

A API de Antecipações tem como objetivo registrar todas as antecipações realizadas e as parcelas que foram liquidadas para efetivação da mesma. Como as outras APIs voltadas para o varejo os dados devem ser buscados em D-1.

Esta API é essencial para que seja possível relacionar uma parcela que estava prevista para ser paga em uma data futura e foi antecipada. A operação de antecipação na Blu somente o valor que deseja ser antecipado é informado, sendo de responsabilidade da Blu gerenciar quais recebíveis serão antecipados. Desta forma, com o uso da API de Antecipações o cliente Blu tem visibilidade total dos recebíveis que fizeram parte de uma antecipação.

Vale frisar que esta API trata somente das vendas que foram antecipadas, vendas que serão pagas na data de liquidação prevista devem ser consultadas na API de Crédito. Para o caso de vendas antecipadas parcialmente a parte antecipada constará na API de Antecipações e a parte paga na data de liquidação original constará na API Conciliação de Crédito.

As APIs Liquidações (Antecipações, Débito e Crédito) devem ser utilizadas em conjunto para ser a visibilidade total da conciliação de vendas Blu.

Orientações

• Os dados devem ser buscados em D-1.

• Os dados são carregados todos os dias às 9h, a consulta deve ser feita após esse horário.

• A API registra somente as vendas que foram antecipadas.

• É necessário um token para ter acesso aos dados.

Esse token é disponibilizado pelo time de Integração da Blu, quando solicitado pelo executivo de contas. Além dele, outros campos podem ser preenchidos opcionalmente no header.

API

Fique atento! para visualizar os exemplos de retornos da API, clique no botão > para abrir o campo de leitura.

Consultar Antecipações

GET https://api.blu.com.br/conciliations/anticipations/installments

Esta API é responsável por retornar uma lista de antecipações realizadas e suas respectivas parcelas liquidadas.

Objetivo

Possibilitar aos nossos clientes uma rastreabilidade das liquidações de parcelas por antecipação.

Fique atento! para visualizar os exemplos dos responses abaixo, clique no botão > para abrir o campo de leitura.

Query Parameters

Name	Type	Description
endDate	String	Data final do período a ser consultado (aaaa-mm-dd)
beginDate	String	Data inicial do período a ser consultado (aaaa-mm-dd)
cpfCnpj	String	CNPJ exclusivo a ser consultado

Headers

Name	Type	Description
Authorization *	String	Token de operação

200: OK Retorno de sucesso

[
    {
        "client_id": "xxxxxx",
        "cpf_cnpj": "xxxxxxxxxxxxxx",
        "client_name": "Empresa Fulano de Tal S.A",
        "id": "xxxxxxxx",
        "transaction_category_id": "2",
        "transaction_category": "Antecipação de Recebíveis",
        "nsu_code": "xxxxxxxxxxxx",
        "authorization_code": "xxxxxx",
        "released_at": "2022-10-11",
        "gross_value": "4497.65",
        "net_value": "4289.49",
        "rate_value": "208.16",
        "liquidated_installments": [
            {
                "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
                "gross_value": "164.99",
                "net_value": "161.33",
                "liquidated_gross_value": "161.33",
                "liquidated_net_value": "157.62",
                "installment_rate": "3.71",
                "proportional_mdr": "3.36" 
            },
            {
                "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "gross_value": "29.99",
                "net_value": "29.33",
                "liquidated_gross_value": "29.33",
                "liquidated_net_value": "28.66",
                "installment_rate": "0.67",
                "proportional_mdr": "0.65" 
            },
            {
                "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
                "gross_value": "26.66",
                "net_value": "26.07",
                "liquidated_gross_value": "26.07",
                "liquidated_net_value": "24.89",
                "installment_rate": "1.18",
                "proportional_mdr": "1.03" 
            }
         ]
     }
 ]

401: Unauthorized Validação do token

{
   "message": "Usuário não encontrado para o token informado."
}

415: Unsupported Media Type Formato do parâmetro

{
    "message": "A data deve ser no formato: YYYY-MM-DD."
}

422: Unprocessable Entity Regra da requisição

{
     "message": "Não é possível realizar consultas com a data maior ou igual a data de hoje."
}

404: Not Found Parâmetros não encontrados

{
    "message": "Nenhuma informação encontrada para os parâmetros informados."
}

Os parâmetros beginDate e endDate se referem a data de ocorrência da transação e devem estar ambos preenchidos. Caso nenhum deles seja especificado, a resposta retornará todos os pagamentos realizados antes à data da consulta, ou seja, D-1.

O retorno desta consulta é um arquivo JSON, contendo um conjunto (Array) das antecipações do período informado. Abaixo vemos todos os campos que serão retornados:

Campos da transação	Data type	Descrição
cpf_cnpj	String	Registro que representa a empresa.
client_name	String	Nome da empresa.
id	String	Número identificador da transação.
transaction_category_id	String	Número identificador da categoria da transação.
nsu_code
authorization_code
transaction_category	String	Descrição da categoria da transação.
released_at	String	Data da liquidação.
gross_value	String	Valor bruto da transação.
net_value	String	Valor liquido da transação.
rate_value	String	Valor da taxa.
liquidated_installments	Array	Lista de parcelas liquidadas.

Campos da parcela	Data type	Descrição
id	String	Número identificador da parcela
gross_value	String	Valor bruto da parcela
net_value	String	Valor líquido da parcela
liquidated_gross_value	String	Valor bruto liquidado
liquidated_net_value	String	Valor líquido liquidado
installment_rate	String	Valor da taxa sobre a parcela
proportional_mdr	String	Valor proporcional da taxa mdr na parcela

O retorno desta consulta é um arquivo JSON, contendo um conjunto (Array) das transações do período informado. Abaixo vemos um exemplo de retorno da API para uma antecipação:

{
        "client_id": "00000",
        "cpf_cnpj": "00000000000000",
        "client_name": "Razão Social",
        "id": "00000000",
        "transaction_category_id": "0",
        "transaction_category": "Tipo de Transação",
        "nsu_code": "000000000000",
        "authorization_code": "000000",
        "released_at": "aaaa-mm-dd",
        "gross_value": "0.00",
        "net_value": "0.00",
        "rate_value": "0.00",
        "liquidated_installments": [
            {
                "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "gross_value": "0.00",
                "net_value": "0.00",
                "liquidated_gross_value": "0.00",
                "liquidated_net_value": "0.00",
                "installment_rate": "0.00",
                "proportional_mdr": "0.00" 
            },
            {
                "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "gross_value": "0.00",
                "net_value": "0.00",
                "liquidated_gross_value": "0.00",
                "liquidated_net_value": "0.00",
                "installment_rate": "0.00",
                "proportional_mdr": "0.00" 
            }
(...)

A API retorna todas as antecipações realizadas no período selecionado e o conjunto de dados liquidated_installments contém todas as parcelas bem como o montante que foi antecipado de cada uma delas. O campo id neste conjunto deve ser relacionado com o id_transaction presente na API Movimento de Vendas para dar match na parcela antecipada.

O cURL para executar a consulta é o exibido abaixo, bem como a collection com todas as APIs para ser importada no Postman está em anexo na página.

curl --location --request GET 'https://api.blu.com.br/conciliations/anticipations/installments?cpfCnpj=00000000000000&beginDate=AAAA-MM-DD&endDate=AAAA-MM-DD' \
--header 'Authorization: XXXXXXXXXXXXXXXXXXXXXXX' \

637B

Varejo - Antecipações.postman_collection.zip

archive

999B

APIs Varejo.postman_collection.zip

archive