> For the complete documentation index, see [llms.txt](https://docs.fidelimax.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fidelimax.com.br/pontuacao/pontuar/extrato.md).

# Extrato

## ExtratoConsumidor

<mark style="color:green;">`POST`</mark> `https://api.fidelimax.com.br/api/Integracao/ExtratoConsumidor`

Exemplo no POSTMAN - <https://www.postman.com/fidelimax/workspace/fidelimax-api-1-0/request/18773698-38957e68-b41c-471e-bfe3-848cc25d4828><br>

#### Headers

| Name                                        | Type   | Description                                                                                                    |
| ------------------------------------------- | ------ | -------------------------------------------------------------------------------------------------------------- |
| AuthToken<mark style="color:red;">\*</mark> | string | Token de integração que esta na sua plataforma de controle em Integrações > API da Fidelimax > Quero Integrar. |
| Content-Type                                | String | application/json                                                                                               |

#### Request Body

| Name         | Type    | Description                                                                                                                                                                                                 |
| ------------ | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| cpf          | string  | CPF do Consumidor                                                                                                                                                                                           |
| telefone     | string  | Telefone do Consumidor, formato (11)99999-9999                                                                                                                                                              |
| dias\_filtro | integer | Quantidade de dias atrás que será a data de inicio do filtro para o extrato de pontos. Exemplo é se você necessita listar os extratos de pontos dos últimos 5 dias é só informar o valor 5 neste parâmetro. |
| skip         | integer | Quantidade de registros para pular                                                                                                                                                                          |
| take         | integer | Quantidade de registros para retornar                                                                                                                                                                       |

{% tabs %}
{% tab title="200
total - Quantidade de registros no extrato completo do consumidor
saldo - Saldo em pontos do consumidor
CodigoResposta - Identificação numérica da resposta
MensagemErro - Mensagem retornada pela API, quando há uma resposta diferente de OK
extrato - Array de objetos contendo informações do extrato
extrato.credito -  Pontos creditados no saldo do consumidor
extrato.debito - Pontos debitados no saldo do consumidor
extrato.premio\_nome - Nome do prêmio resgatado pelo consumidor
extrato.premio\_identificador - Identificador vinculado ao prêmio do consumidor
extrato.voucher - Voucher vinculado em cada resgate de prêmio
extrato.voucher\_resgatado - Voucher já foi resgatado pelo consumidor
extrato.data\_pontuacao - Data em que a pontuação foi realizada
extrato.data\_expiracao - Data em que a pontuação irá expirar
extrato.verificador - Verificador associado a uma pontuação de crédito
extrato.tipo\_compra - Descrição do tipo de crédito associado a pontuação
extrato.loja  - Nome da loja em que foi realizada a operação de pontuação
extrato.tipo\_pontuacao - Verificar valores na seção "Mapeamento Tipos Pontuações API"" %}

```
{    
    "total": 2,
    "saldo": 500,
    "extrato": [
     {
       "credito": 0
       "debito": 100
       "premio_nome": "Premio 1",
       "premio_identificador": "PRXX1",
       "voucher": "VD574AE",
       "voucher_resgatado": true,
       "data_pontuacao": "2017-08-03T15:11:33",
       "data_expiracao": "2018-08-03T15:11:33",
       "verificador": null,
       "tipo_compra": null,
       "loja": "Loja 1",
       "tipo_pontuacao": 206
     },
     {
       "credito": 500
       "debito": 0
       "premio_nome": null,
       "premio_identificador": null,
       "voucher": null,
       "voucher_resgatado": false,
       "data_pontuacao": "2017-08-04T15:11:33",
       "data_expiracao": "2018-08-04T15:11:33",
       "verificador": "fd7892",
       "tipo_compra": "Compras no Atacado",
       "loja": "Loja 2",
       "tipo_pontuacao": 205
     },
   ],
    "CodigoResposta": 100,
    "MensagemErro": ""
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.fidelimax.com.br/pontuacao/pontuar/extrato.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
