# Consultar Conciliação Financeira

## Consultar Conciliação Financeira

<mark style="color:blue;">`GET`</mark> `https://api-hlg.blu.com.br/b2b/payment-collections/v2/reconciliation`&#x20;

Retorna a conciliação financeira, ou seja, todos os pagamentos efetuados na determinada data (`"date": "aaaa-mm-dd"`); e ou determinado pedido/cobrança (`"document_number": "xxx-xx"`); e ou determinado número de documento de faturamento (`"invoice_number": "xxxx-xxxx-xxxx"`), que foram enviados para a consulta. Caso não seja informado nenhum dos parâmetros, será retornado todos os pagamentos efetuados na data do dia da consulta menos um, ou seja D-1. É importante salientar que, a consulta sempre será ao passado, considerando o dia atual menos um (D-1)  em diante.

#### Query Parameters

| Name             | Type   | Description                            |
| ---------------- | ------ | -------------------------------------- |
| document\_number | string | Número do pedido/cobrança.             |
| invoice\_number  | string | Número do documento de faturamento.    |
| date             | string | Data do pagamento. Formato AAAA-MM-DD. |

#### Headers

| Name          | Type   | Description   |
| ------------- | ------ | ------------- |
| Authorization | string | Bearer token. |

{% tabs %}
{% tab title="200 OK" %}
{% tabs %}
{% tab title="OK" %}

```javascript
[
    {
        "payment_id": "<identificador-parcela>",
        "transaction_id": "<identificador-transacao>",
        "document_number": "XXXX-XX",
        "invoice_number": "XXXXXX-XXXXXX-XXXXX",
        "charged": "000.000.000-00",
        "date": "aaaa-mm-dd"
        "value": "0.00",
        "monetary_paidout": "0.00",
        "monetary_anticipation": "0.00",
        "standard_rate_value": "0.00"
    }
]
```

{% endtab %}

{% tab title="NOK" %}

```javascript
{
    "message": "Nenhuma informação encontrada para os dados informados."
}
```

{% endtab %}
{% endtabs %}
{% endtab %}

{% tab title="401: Unauthorized Token inválido e parâmetros não informados" %}

```javascript
{
    "mensagem": "Usuário não encontrado para o token informado."
}
```

{% endtab %}

{% tab title="404: Not Found Parâmetros não informados" %}

```javascript
{
    "mensagem": "Nenhuma informação encontrada para os dados informados."
}
```

{% endtab %}

{% tab title="422: Unprocessable Entity Data fora do padrão YYYY-MM-DD" %}

```javascript
{
    "mensagem": "A data deve ser no formato: YYYY-MM-DD"
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
A unicidade de uma parcela é garantida pelos campos **payment\_id, transaction\_id e invoice\_number em conjunto**. Se duas parcelas são pagas no mesmo dia somente utilizando os três campos será possível garantir a unicidade para conciliação.
{% endhint %}

Exemplo de chamada:

{% tabs %}
{% tab title="cURL" %}

```javascript
curl --location --request GET 'https://api-hlg.blu.com.br/b2b/payment-collections/v2/reconciliation?document_number=&date=AAAA-MM-DD&invoice_number=' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXX'
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://api-hlg.blu.com.br/b2b/payment-collections/v2/reconciliation?document_number=&date=AAAA-MM-DD&invoice_number=',
  'headers': {
    'Authorization': 'Bearer XXXXXXXXXXXXXXXXXXXXXXX',
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

```

{% endtab %}
{% endtabs %}

#### Descrição dos campos de retorno da conciliação financeira

| Campo                  | Data Type | Descrição                             |
| ---------------------- | --------- | ------------------------------------- |
| payment\_id            | string    | Identificador único da parcela.       |
| transaction\_id        | string    | Identificador único da transação.     |
| invoice\_number        | string    | Número do documento de faturamento.   |
| charged                | string    | CNPJ/CPF do lojista/cobrado.          |
| date                   | string    | Data do pagamento.                    |
| value                  | string    | Valor bruto da parcela.               |
| monetary\_paidout      | string    | Valor líquido da parcela.             |
| monetary\_anticipation | string    | Valor pago pela antecipação.          |
| standart\_rate\_value  | string    | Valor pago pelo seguro inadimplência. |

## Download Collection Postman (pacote de APIs)

{% hint style="info" %}

> Segue abaixo o link para download da coleção de APIs no [Postman](https://www.postman.com/).
> {% endhint %}

{% file src="/files/tN2d1Vaa4YYESnnW4szn" %}


---

# 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/fornecedores-apis/sobre-apis/sobre-apis-6.md?ask=<question>
```

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.