Retornar Totalizador de Faturas

get https://apis.fixpay.com.br/v1/signature/invoice/totalizer/{groupId}

Totalizador de faturas.

Retornar totalizador de faturas

Retorna a quantidade total de faturas, como também a quantidade de faturas que já foram pagas, já vencenceram, foram canceladas ou estão em aberto.

É 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.: 12

nome

string

Nome do cliente. Ex.: Maria José

status_id

int32

Id do status da fatura. Ex.: 11 (PAGO), 25 (VENCIDO), 26 (EM ABERTO) ou 29 (BAIXA MANUAL).

captura_id

int32

Id da captura. Ex.: 26 (FATURA BOLETO), 27 (FATURA CARTAO DE CREDITO) ou 28 (FATURA PIX).

data_criacao_inicial

string

Data de criação inicial. Ex.: 2023-01-01

data_criacao_final

string

Data de criação final. Ex.: 2023-06-01

data_pagamento_inicial

string

Data de pagamento inicial. Ex.: 2023-01-01

data_pagamento_final

string

Data de pagamento final. Ex.: 2023-06-01

data_vencimento

string

Data de vencimento da Fatura. Ex.: 2023-01-01

Headers

Authorization

string

required

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

Responses

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://apis.fixpay.com.br/v1/signature/invoice/totalizer/groupId \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Retornar totalizador de faturas

200200

400400