get
https://sandbox-api.crmbonus.com/bonusVencer
Relatório de bônus a vencer
Campos específicosOs dados de cpf, email, birth e genero podem ou não aparecer na resposta a depender das configurações da loja.
Dicionário de Dados | Resposta
| Campo | Descrição |
|---|---|
| total_valor_avencer | Quantidade total de bônus a vencer no período filtrado. |
| list | Array de objetos com os dados referentes a cada registro de bônus gerado no período filtrado. |
| cliente | Objeto de dados pessoais do cliente. |
| cliente_id | ID do cliente. |
| cliente | Nome do cliente. |
| celular | Número de celular do cliente cadastrado. |
| cpf | Número de CPF do cliente. |
| Endereço de e-mail do cliente. | |
| birth | Data de nascimento do cliente |
| genero | Gênero do cliente. |
| bonus_id | ID do bônus. |
| ticket | Número do pedido/identificador da venda que gerou o bônus. |
| campaign_id | ID da campanha utilizada na geração do bônus. |
| loja_id | ID da loja em que o bônus foi utilizado. |
| loja_nome | Nome da loja onde o bônus foi gerado. |
| tipo_loja | Tipo de loja ("Franquia" ou "Própria", por exemplo). |
| cod_loja_interno | Código identificador da loja dentro da marca. |
| is_multi_resgate | Campo responsável por informar se a loja está com a configuração de multi-resgate habilitada. |
| lojas_multi_resgate | Array de lojas dentro da configuração de multi-resgate. |
| cnpj | CNPJ da loja onde o bônus foi gerado. |
| data | Data da geração bônus. |
| nome_vendedor | Nome do vendedor responsável pela geração deste bônus. |
| nf | Nota fiscal associada à venda que gerou este bônus. |
| bonus_vencer | Valor do bônus a vencer. |
| bonus_vencer_sms | Valor do bônus a vencer. |
| venda_minima_gerar_bonus | Valor de venda mínima configurada para geração do bônus. |
| validade_inicio | Data em que o bônus fica disponível para resgate. |
| validade_fim | Data em que o bônus deixará de estar disponível para resgate. |
| origin | Origem de geração do bônus. |