# API de Antecipações A **API de Antecipações** permite consultar as antecipações realizadas e as parcelas utilizadas em cada operação. Na Blu, para antecipar, informa-se apenas o valor. A Blu seleciona automaticamente os recebíveis que compõem a operação. A API exibe o resultado dessa seleção com as parcelas liquidadas, valores e datas, oferecendo transparência e facilitando a conciliação. **O que entrega** * Lista de **antecipações** no período consultado; * Detalhe das **parcelas liquidadas** (bruto, líquido, taxas); * Dados prontos para **conciliação.** ## Orientações * Os dados devem ser consultados em **D-1** (dia anterior). * As informações ficam disponíveis diariamente às **9h**. * A API retorna **somente as vendas antecipadas**. * É possível consultar dados de [produção](#endpoints-da-api) ou [homologação](#antecipacoes-homologacao). * Em caso de antecipação parcial: * A parte **antecipada** aparece nesta API. * A parte liquidada na data original aparece na **API de Conciliação de Crédito**. {% hint style="info" %} Para uma visão completa da conciliação, recomenda-se o uso conjunto das APIs de Liquidações: **Antecipações,** [**Débito**](/varejo-apis/api-conciliacao-de-debito.md) **e** [**Crédito**](/varejo-apis/api-conciliacao-de-credito.md). {% endhint %} ## Autenticação O acesso exige um token de autenticação, fornecido pelo time de Integração da Blu mediante solicitação ao seu executivo de contas. ```http Authorization: Bearer ``` *** ## Endpoints da API ### \[V1] Consultar Antecipações **GET** `https://api.blu.com.br/conciliations/anticipations/installments` Retorna uma lista de antecipações realizadas e suas respectivas parcelas liquidadas. #### Query parameters: | Parâmetro | Obrigatório | Descrição | | ----------- | ----------- | ------------------------------------ | | `beginDate` | Sim | Data inicial no formato `YYYY-MM-DD` | | `endDate` | Sim | Data final no formato `YYYY-MM-DD` | | `cpfCnpj` | Não | Documento do cliente (CNPJ ou CPF) | {% hint style="danger" %} Se os parâmetros **begindate** e **endDate** não forem informados, a API retornará todos os pagamentos realizados até **D-1**. {% endhint %} #### Headers: ```http Authorization: Bearer ``` #### Exemplo de requisição: ```bash curl --location --request GET 'https://api.blu.com.br/conciliations/anticipations/installments?cpfCnpj=00000000000000&beginDate=AAAA-MM-DD&endDate=AAAA-MM-DD' \ --header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXX' ``` #### Exemplo de resposta de sucesso: ✔ {% tabs %} {% tab title="200: OK " %} ```json [ { "client_id": "xxxxxx", "cpf_cnpj": "xxxxxxxxxxxxxx", "client_name": "Razão Social", "id": "xxxxxxxx", "transaction_category_id": "0000", "transaction_category": "Tipo de Antecipação", "released_at": "aaaa-mm-dd", "gross_value": "00.00", "net_value": "00.00", "rate_value": "00.00", "liquidated_installments": [ { "nsu_code": "000000000000", "authorization_code": "000000", "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx", "gross_value": "00.00", "net_value": "00.00", "liquidated_gross_value": "00.00", "liquidated_net_value": "00.00", "installment_rate": "00.00", "proportional_mdr": "00.00" }, { "nsu_code": "000000000000", "authorization_code": "000000", "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "gross_value": "00.00", "net_value": "00.00", "liquidated_gross_value": "00.00", "liquidated_net_value": "00.00", "installment_rate": "00.00", "proportional_mdr": "00.00" }, { "nsu_code": "000000000000", "authorization_code": "000000", "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx", "gross_value": "00.00", "net_value": "00.00", "liquidated_gross_value": "00.00", "liquidated_net_value": "00.00", "installment_rate": "00.00", "proportional_mdr": "00.00" } ] } ] ``` {% endtab %} {% endtabs %} 🔗 [Acesse a descrição dos campos ](/varejo-apis/relatorios/descricao-dos-campos-da-api-de-antecipacoes.md) \ **Exemplo de respostas de erro: ❌** {% tabs %} {% tab title="415: Unsupported Media Type " %} ```json // erro no formato do parâmetro { "message": "A data deve ser no formato: YYYY-MM-DD." } ``` {% endtab %} {% tab title="401: Unauthorized " %} ```json // Validação do token { "message": "Usuário não encontrado para o token informado." } ``` {% endtab %} {% tab title="422: Unprocessable Entity " %} ```json // erro na regra da requisição "message": "Não é possível realizar consultas com a data maior ou igual a ``` {% endtab %} {% tab title="204: No Content" %} ```json // Parâmetros não encontrados ``` {% endtab %} {% endtabs %} {% tabs %} {% tab title="415: Unsupported Media Type " %} ```json // erro no formato do parâmetro { "message": "A data deve ser no formato: YYYY-MM-DD." } ``` {% endtab %} {% tab title="401: Unauthorized " %} ```json // Validação do token { "message": "Usuário não encontrado para o token informado." } ``` {% endtab %} {% tab title="422: Unprocessable Entity " %} ```json // erro na regra da requisição "message": "Não é possível realizar consultas com a data maior ou igual a ``` {% endtab %} {% tab title="204: No Content" %} ```json // Parâmetros não encontrados ``` {% endtab %} {% endtabs %} #### Observações Técnicas * O retorno é sempre em formato **JSON**. * O campo `liquidated_installments` contém todas as parcelas que compuseram a antecipação. * O campo `id` de cada parcela deve ser relacionado com o `id_transaction` da **API Movimento de Vendas** para dar match com a parcela original. *** ### \[V2] Consultar antecipações **GET** `https://api.blu.com.br/conciliations/anticipations/installments` A **V2 da API de Antecipações** mantém o funcionamento da [versão anterior](#v1-consultar-antecipacoes), mas agora oferece **paginação** para consultas com grandes volumes de recebíveis. Com esse recurso, as informações podem ser recuperadas em lotes (ex.: milhares de recebíveis em uma única antecipação), de forma organizada e eficiente, sem sobrecarregar a integração. #### Headers ```http authorization: version: 2 ``` **Parâmetros de Query** | Parâmetro | Obrigatório | Descrição | | ----------- | ----------- | ---------------------------------------------------- | | `beginDate` | Não | Data inicial `YYYY-MM-DD` (*ou enviada no header*). | | `endDate` | Não | Data final `YYYY-MM-DD` (*ou enviada no header*). | | `cpfCnpj` | Não | Documento do cliente (CNPJ/CPF). | | `page` | Não | Página a consultar (ex: 1) | | `per_page` | Não | Quantidade de registro por página (**máx**: `4000`). | {% hint style="danger" %} **Observação**\ • Se `beginDate` e `endDate` **não** forem informados, a API retorna os pagamentos realizados até **D-1**.\ • Se `page` **não** for informado, será considerado **`1`** (primeira página).\ • Se `per_page` **não** for informado, será considerado **`1000`** itens por página. {% endhint %} #### Exemplo de requisição ```bash curl --location --request GET 'https://api.blu.com.br/conciliations/anticipations/installments?beginDate=2025-08-01&endDate=2025-08-25&page=1&per_page=1000' \ --header 'authorization: ' \ --header 'version: 2' ``` #### Resposta de sucesso: ✔ {% tabs %} {% tab title="200: OK " %} ```json { "page": 1, "per_page": 1000, "itemsPerPage": 3, "total_items": 3, "has_more": false, "items": [ { "client_id": "xxxxxx", "cpf_cnpj": "xxxxxxxxxxxxxx", "client_name": "Razão Social", "id": "xxxxxxxx", "transaction_category_id": "0000", "transaction_category": "Tipo de Antecipação", "released_at": "aaaa-mm-dd", "gross_value": "00.00", "net_value": "00.00", "rate_value": "00.00", "liquidated_installments": [ { "nsu_code": "000000000000", "authorization_code": "000000", "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx", "gross_value": "00.00", "net_value": "00.00", "liquidated_gross_value": "00.00", "liquidated_net_value": "00.00", "installment_rate": "00.00", "proportional_mdr": "00.00" }, { "nsu_code": "000000000000", "authorization_code": "000000", "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "gross_value": "00.00", "net_value": "00.00", "liquidated_gross_value": "00.00", "liquidated_net_value": "00.00", "installment_rate": "00.00", "proportional_mdr": "00.00" }, { "nsu_code": "000000000000", "authorization_code": "000000", "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx", "gross_value": "00.00", "net_value": "00.00", "liquidated_gross_value": "00.00", "liquidated_net_value": "00.00", "installment_rate": "00.00", "proportional_mdr": "00.00" } ] } ] } ``` {% endtab %} {% endtabs %} **Descrição dos campos**
CampoO que éObservações / Exemplos
pageNúmero da página retornada.Vem do parâmetro de query page (padrão: 1).
per_pageQuantidade solicitada de itens por página.Vem do parâmetro de query per_page (ex.: 1000).
itemsPerPageQuantidade efetivamente retornada nesta página.Pode ser menor que per_page
total_itemsTotal de registros que atendem ao filtro.
has_moreIndica se existe próxima página.
itemsLista de antecipações da página atual.
🔗 [Acesse a descrição dos outros campos ](/varejo-apis/relatorios/descricao-dos-campos-da-api-de-antecipacoes.md) #### Respostas de erro: ❌ {% tabs %} {% tab title="415: Unsupported Media Type " %} ```json // erro no formato do parâmetro { "message": "A data deve ser no formato: YYYY-MM-DD." } ``` {% endtab %} {% tab title="401: Unauthorized " %} ```json // Validação do token { "message": "Usuário não encontrado para o token informado." } ``` {% endtab %} {% tab title="422: Unprocessable Entity " %} ```json // erro na regra da requisição "message": "Não é possível realizar consultas com a data maior ou igual a ``` {% endtab %} {% tab title="204: No Content" %} ```json // Parâmetros não encontrados ``` {% endtab %} {% tab title="422:Unprocessable Entity " %} 

{
	"message": "O campo per_page não pode ser maior que 4000"
}
{% endtab %} {% endtabs %} ### Antecipações - Homologação A API Antecipações pode ser consultada diretamente no [ambiente de produção](#endpoints-da-api) caso já existam antecipações para o CNPJ cadastrado no Portal Blu. Caso ainda não existam antecipações é possível realizar a consulta em homologação. {% hint style="warning" %} **Atenção!** Os dados retornados na API Antecipações - Homologação são mockados, anonimizados e sem uso de CNPJs reais. O retorno dessa API só é positivo na data de 01/12/2025, que constará no cURL. {% endhint %} `GET` `https://api-hlg.blu.com.br/conciliations/anticipations/installments` #### Headers | Name | Type | Description | | --------------------------------------- | ------ | ------------------------------------------- | | token\* | string | Bearer token de identificação do fornecedor | #### Query Parameters | Parâmetro | Obrigatório | Descrição | | ----------- | ----------- | ------------------------------------ | | `beginDate` | Sim | Data inicial no formato `YYYY-MM-DD` | | `endDate` | Sim | Data final no formato `YYYY-MM-DD` | {% hint style="danger" %} Se os parâmetros **begindate** e **endDate** não forem informados, a API retornará todos os pagamentos realizados até **D-1**. {% endhint %} {% tabs %} {% tab title="200: Ok" %} ```json [ { "client_id": "xxxxxx", "cpf_cnpj": "xxxxxxxxxxxxxx", "client_name": "Razão Social", "id": "xxxxxxxx", "transaction_category_id": "0000", "transaction_category": "Tipo de Antecipação", "released_at": "aaaa-mm-dd", "gross_value": "00.00", "net_value": "00.00", "rate_value": "00.00", "liquidated_installments": [ { "nsu_code": "000000000000", "authorization_code": "000000", "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx", "gross_value": "00.00", "net_value": "00.00", "liquidated_gross_value": "00.00", "liquidated_net_value": "00.00", "installment_rate": "00.00", "proportional_mdr": "00.00" }, { "nsu_code": "000000000000", "authorization_code": "000000", "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "gross_value": "00.00", "net_value": "00.00", "liquidated_gross_value": "00.00", "liquidated_net_value": "00.00", "installment_rate": "00.00", "proportional_mdr": "00.00" }, { "nsu_code": "000000000000", "authorization_code": "000000", "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx", "gross_value": "00.00", "net_value": "00.00", "liquidated_gross_value": "00.00", "liquidated_net_value": "00.00", "installment_rate": "00.00", "proportional_mdr": "00.00" } ] } ] ``` {% endtab %} {% tab title="422: Unprocessable Entity " %} ```json // erro no formato do parâmetro { "message": "A data deve ser no formato: YYYY-MM-DD." } ``` {% endtab %} {% tab title="401: Unauthorized " %} ```json // Validação do token { "message": "Usuário não encontrado para o token informado." } ``` {% endtab %} {% tab title="422: Unprocessable Entity " %} ```json // erro na regra da requisição "message": "Não é possível realizar consultas com a data maior ou igual a ``` {% endtab %} {% tab title="204: No Content" %} ```json // Parâmetros não encontrados ``` {% endtab %} {% endtabs %} O retorno desta consulta é um arquivo JSON, contendo um conjunto (Array) das transações do período informado. Detalhes dos campos retornados podem ser vistos na [página com suas descrições](/varejo-apis/relatorios/descricao-dos-campos-da-api-de-antecipacoes.md). O cURL para executar a consulta já com a data 01/12/2025 é o exibido abaixo, bem como a collection com todas as APIs para ser importada no Postman está em anexo na página com o nome Varejo HLG - Antecipações ou APIs Varejo HLG. ``` curl --location 'https://api-hlg.blu.com.br/conciliations/anticipations/installments?beginDate=2025-12-01&endDate=2025-12-01' \ --header 'Authorization: XXXXXXXXXXXXXXXXXXXXXXXXX' \ ``` {% file src="/files/Z5ZgMAGTEkEqf4AERxLn" %} {% file src="/files/zQUouYJCrtHKdmI6fMfm" %} {% file src="/files/JQXLknsUzJEZ64k8ywh4" %} {% file src="/files/B3ARIOs7WpRfCHzWWXbe" %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://integracao.useblu.com.br/varejo-apis/relatorios.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.