v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Spreadsheet

Find spreadsheets by query filters.

Retrieve spreadsheets based on query parameters

Recuperar planilhas com base nos parâmetros de consulta

get/spreadsheets

Query parameters

namestring

Name of the spreadsheet

Nome da planilha

card_networkstring

CardNetwork of the spreadsheet (Ex: MASTERCARD, VISA)

Bandeira da planilha (Ex: MASTERCARD, VISA)

acquirer_company_idinteger[]

AcquirerCompanyID of the spreadsheets

CompanyID do adquirente da planilha

created_greater_or_equal_thanstring

Created date greater or equal to (YYYY-MM-DD)

Data de criação maior ou igual a (AAAA-MM-DD)

created_less_or_equal_thanstring

Created date less or equal to (YYYY-MM-DD)

Data de criação menor ou igual a (AAAA-MM-DD)

Response

List of users matching the filters | Lista de usuários que correspondem aos filtros

limitinteger

pageinteger

sortstring

total_pagesinteger

total_rowsinteger

Example response

{
  "limit": 10,
  "page": 1,
  "rows": [
    {
      "created_at": "2020-01-01 12:00:00",
      "id": 1,
      "receivables": [
        {
          "card_network": "MASTERCARD",
          "company_id": 1,
          "compound_key": "testeCompany/MASTERCARD/Emissor2/2025-02-05 00:00:00 -0300 -03/Installment",
          "created_at": "2020-01-01 12:00:00",
          "due_date": "2025-02-11T00:00:00-03:00",
          "id": 1,
          "issuer": "Emissor2",
          "spreadsheet_id": 62,
          "status": "AVAILABLE",
          "transactions_number": 69,
          "transactions_number_available": 69,
          "updated_at": "2020-01-01 12:00:00",
          "value": 32500.8,
          "value_available": 32500.8
        }
      ],
      "updated_at": "2020-01-01 12:00:00"
    }
  ],
  "sort": "created_at desc",
  "total_pages": 1,
  "total_rows": 1
}