Listar Faturas

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

Retorna as faturas de um grupo.

Listar Faturas

Retorna uma lista com as faturas de um determinado grupo, podendo ser filtrado por estabelecimento, cliente, data de criação, data de pagamento, data de vencimento, status, captura e nome.

É 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

cliente_id

int32

Id do cliente. Ex.: 12

estabelecimento_id

int32

Id do estabelecimento. Ex.: 123

status_id

string

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/groupId \
3
     --header 'accept: application/json'

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

application/json

Listar Faturas

200200

400400