Retrieve expected receipts
Retrieve estimated pending receipts and the projected total balance.
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
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.
Responses
Response Body
An estimate of payments still considered pending receipt during the period. The projected balance adds the estimate to the current total balance; it does not indicate the amount available for withdrawal.
Financial estimate for the period. Amounts do not prove bank settlement or availability for withdrawal.
Queried period, including today and previous days according to the option.
Inclusive start of the period, in Unix UTC seconds.
Exclusive end of the period, in Unix UTC seconds.
Estimate reference day: midnight today in São Paulo, in Unix UTC seconds.
Payments still expected to be received in the period, in Brazilian real cents. Does not include open charges that have not yet reached their due date.
Sum of the current total balance and expected receipts, in Brazilian real cents. May include blocked amounts; does not represent the balance available for withdrawal.
Last update of forecast data, in Unix UTC seconds, or null when unavailable.
Response Body
The period or query parameters are not accepted. Choose an available period and send it only once.
Code and explanation of the error returned by the API.
Stable error code.
Error explanation in English. For validation errors, it summarizes the category; details identify the corrections. Use the codes to handle the response.
Invalid fields or references submitted in the body, with the field, code and explanation. Omitted for general errors and when there is no field correction to indicate.
Public name of the JSON field, query parameter, path parameter or header related to the error. Nested fields and lists retain their path and index. $ represents the root of the JSON body.
Reason for the field error, such as REQUIRED, INVALID_TAXID, UNKNOWN_FIELD, DUPLICATE_FIELD or INVALID_TYPE.
Explanation in English of the problem with this field or parameter and the available correction. Do not use the text to determine your integration flow.
For common errors, see HTTP response codes.