Retornar Relatório de Faturamento

get

https://apis.fixpay.com.br/v1/signature/billingreport/{groupId}

Retorna os relatórios de faturamento.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Retornar Relatório de Faturamento

Retorna os dados do faturamento de cada assinatura.

É necessário passar o token gerado no momento em que o usuário realiza o login no header "Authorization".

Abaixo temos um exemplo de como inserir essa informação usando JSON.

{
  "Authorization": "eyXXXXXXXXXXXXXXXXXXXXXXXXXXXXw0"
}

Path Params

groupId

int32

required

Id do grupo. Ex.: 123

Query Params

estabelecimento_id

int32

Id do estabelecimento. Ex.: 123

cliente_id

int32

Id do cliente. Ex.: 123

plano_id

int32

Id do plano. Ex.: 1234

captura_id

int32

Id da captura. Ex.: 16 (Cartão), 23 (Boleto) ou 24 (Pix).

adimplente

string

Cumpriu as obrigações financeiras. Ex.: ADIMPLENTE ou INADIMPLENTE

ativo

string

Situação da assinatura. Ex.: ATIVO, PENDENTE ou EXPIRADO.

data_criacao_inicial

string

Data de criação inicial. Ex.: 12/03/2023

data_criacao_final

string

Data de criação final. Ex.: 12/06/2023

data_primeira_cobranca_inicial

string

Data da primeira cobrança inicial. Ex.: 12/03/2023

data_primeira_cobranca_final

string

Data da primeira cobrança final. Ex.: 12/06/2023

data_expiracao_inicial

string

Data de expiração inicial. Ex.: 12/03/2023

data_expiracao_final

string

Data de expiração final. Ex.: 12/06/2023

Headers

Authorization

string

required

Token gerado no momento em que o usuário realiza o login no portal. Formato: eyXXXXXXXXXXXXXXXXXXXXXXXXXXXXw0

Responses

Retornar Relatório de Faturamento

200200

400400