Sign in
Bank - Admin

Api List Bank Rows

List filtered bank rows.

status is one of todos | conciliado | parcial | nao | ignorado. only_ignored=True is the older spelling of status="ignorado".

limit=0 (the default) returns every match, preserving the original behaviour. Pass limit>0 to page; the total for the SAME filters comes back in the X-Total-Count header so the body stays a plain list.

search is free text over description, amount and linked invoice number. Dates are a range filter (start/end), never a substring match. It applies BEFORE paging and is counted the same way, so a search returns the matches in the whole account, not just those on the current page.

get/api/bank_rows

Query parameters

statusstring
startstring date nullable
endstring date nullable
metodo_pagamento_idinteger nullable
ponto_venda_idinteger nullable
only_ignoredboolean
searchstring nullable
pageinteger
limitinteger

Headers

x-api-tokenstring nullable

Response

Successful Response

idinteger required
metodo_pagamento_idinteger required
ponto_venda_idinteger required
date_valuestring date required
descriptionstring required
amountstring required
reconciledstring required
reconciled_amountstring nullable required
ignoredboolean
ignored_reasonstring nullable
ignored_byinteger nullable
ignored_atstring date-time nullable
statement_idinteger nullable
seqinteger nullable
sign_verifiedboolean

Changes