v1

latestOpenAPI 3.1.02026-08-045026.6 KB

Consultar Lançamentos Financeiros

Através deste endpoint é possível consultar os Iançamentos financeiros de uma ou mais lojas vinculadas em um token

get/search_financial_transactions

Query parameters

p_date_column_filterstring

Indica a coluna que será utilizada para o filtro de período. Opções: date, created_at, updated_at, payment_date, issuance_date

p_filter_date_startstring date-time required

Data de inicio do período em que será feita a consulta

p_filter_date_endstring date-time required

Data de fim do período em que será feita a consulta

p_limitinteger

Limite de registros que serão retornados. O padrão é 300, mas pode ser alterado para até 1.000

p_offsetinteger

Indica a partir de qual registro a consulta deve começar a retornar resultados, importante para realizar a paginação dos dados

Headers

Authorizationstring

Token JWT gerado no sistema Saipos

Response

200

datestring

paidstring

{"stackTrail":"paths:/search_financial_transactions:get:responses:200:content:application/json:schema:items:properties:notes","oasType":"schema","type":"unknown"}

amountinteger

id_storeinteger

recurringstring

created_atstring

updated_atstring

conciliatedstring

installmentinteger

payment_datestring

issuance_datestring

{"stackTrail":"paths:/search_financial_transactions:get:responses:200:content:application/json:schema:items:properties:total_installments","oasType":"schema","type":"unknown"}

provider_trade_namestring

desc_store_bank_accountstring

id_store_fin_transactioninteger

desc_store_payment_methodstring

desc_store_fin_transactionstring

desc_store_category_financialstring

Example response

[
  {
    "date": "2025-05-08T12:00:00",
    "paid": "Y",
    "amount": -50,
    "children": [
      {
        "paid": "Y",
        "amount": 6548,
        "desc_store_fin_transaction": "Adiantamento motoboy dia 08/05/2025 | Caixa",
        "desc_store_category_financial": "Frente de Caixa"
      }
    ],
    "id_store": 74,
    "recurring": "N",
    "created_at": "2025-05-08T13:56:10",
    "updated_at": "2025-05-08T13:56:10",
    "conciliated": "N",
    "payment_date": "2025-05-08T12:00:00",
    "issuance_date": "2025-05-08T13:56:10",
    "desc_store_bank_account": "Cofre",
    "id_store_fin_transaction": 457851,
    "desc_store_fin_transaction": "Adiantamento motoboy dia 08/05/2025",
    "desc_store_category_financial": "Adiantamento Motoboy"
  }
]