Retrieve expected receipts

Retrieve estimated pending receipts and the projected total balance.

GEThttps://api.raims.com/v1/balances/forecast

Retrieve estimated receipts for the period to track the financial projection in your system. The projected balance is an estimate and does not indicate how much can be withdrawn.

See the criteria and the difference between the forecast and balance in Expected receipts.

Query Params

periodstringoptional

The period for expected receipt dates, based on the São Paulo calendar. Includes today and previous days according to the selected option. It does not retrieve due dates or forecast the coming days.

last_7_days

Responses

For common errors, see HTTP response codes.

Updated 13 hours ago

Language

Credentials

Header

cURL Request

curl --request GET \
  --url https://api.raims.com/v1/balances/forecast \
  --header 'accept: application/json'

Response

Click Try it to send a request and see the response here. Or choose an example:

application/json

Retrieve expected receipts

Query Params

Responses

200OK

400Bad Request