Listar Faturas

A listagem de faturas retornará todas as faturas de uma carteira específica que se enquadrarem nos query parameters enviados na request.

Request

ENDPOINT

/wallet/WALLET_KEY/invoices

MÉTODO

GET

Path Parameters

Campo	Tipo	Descrição	Caracteres
wallet_key	uuidv4	Chave única da carteira no formato UUID v4	36

Query Parameters

Campo	Tipo	Descrição	Caracteres
invoice_status *	string	Status da fatura	Enumeradores invoice_status
page	integer	Número da página para paginação	-
page_size	integer	Quantidade de itens por página	-

Validações

• Paginação: Valores de página e tamanho devem ser inteiros válidos
• Tamanho da página: Máximo de 100 itens por página

Enumeradores invoice_status

Enumerador	Descrição
opened	Fatura aberta
processing_closing	Processando fechamento
processing_expiration	Processando expiração
closed	Fatura fechada
processing_payment	Aguardando pagamento
paid	Fatura paga

Response

STATUS

200

Response Body: Lista de faturas

{
  "data": [
    {
      "invoice_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
      "due_date": "2024-02-15",
      "closing_date": "2024-01-31",
      "invoice_status": "opened",
      "total_amount": 350.00,
      "paid_amount": 0.00,
      "created_at": "2024-01-15T10:30:00Z"
    },
    {
      "invoice_key": "9db81efb-0ac1-5b79-0683-00b8395a9e7",
      "due_date": "2024-01-15",
      "closing_date": "2023-12-31",
      "invoice_status": "opened",
      "total_amount": 500.00,
      "paid_amount": 0.00,
      "created_at": "2024-01-14T14:45:00Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "rows_per_page": 100
  }
}

Response Body Params

Campo	Tipo	Descrição	Caracteres
data *	object array	Faturas	Objeto invoice
pagination *	object	Informações de paginação	Objeto pagination

Objeto invoice

Campo	Tipo	Descrição	Caracteres
invoice_key *	uuidv4	Chave única de identificação da fatura no formato uuid v4	36
due_date *	string	Data de vencimento da fatura (formato YYYY-MM-DD)	10
closing_date *	string	Data de fechamento da fatura (formato YYYY-MM-DD)	10
invoice_status *	string	Status da fatura	Enumeradores invoice_status
total_amount *	number	Valor total da fatura	-
paid_amount *	number	Valor pago da fatura	-
created_at *	string	Data de criação (formato ISO 8601 UTC)	-

Objeto pagination

Campo	Tipo	Descrição	Caracteres
current_page *	integer	Página atual	-
rows_per_page *	integer	Itens por página	-

Error Response

STATUS

4xx

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}

Código HTTP status	Código QI code	Título title	Descrição (eng) description	Descrição (pt-br) translation
400	CIN000069	Bad Request	Invalid integer value for page or size query string parameters	Valor inválido para parâmetros de página ou tamanho de página
400	CIN000079	Bad Request	Invalid query invoice status	Status de consulta de fatura inválido
404	CIN000007	Wallet not Found	Wallet with key: abeca0d0-a09d-4b3b-a495-40b553422ced was not found	Carteira com a chave: abeca0d0-a09d-4b3b-a495-40b553422ced não foi encontrado