v2

Reports

>>>

GET /reports/fiscal_breakdowns
Fiscal breakdowns report

Params

Param name Description
start_date
required

Start date (YYYY-MM-DD)

Validations:

  • Must be a String
end_date
required

End date (YYYY-MM-DD)

Validations:

  • Must be a String
funding_type
optional

Funding type filter

Validations:

  • Must be a String

Examples

Returns an .xlsx file download with the fiscal breakdowns report for the given date range.

Errors

Code Description
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
>>>

GET /reports/mail_logs
Mail logs report

Params

Param name Description
monthly_cut_id
required

Monthly cut ID

Validations:

  • Must be a String

Examples

Returns an .xlsx file download with mail delivery logs for the given monthly cut.

Errors

Code Description
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
>>>

GET /reports/movements_friends_family
Friends & family movements report

Params

Param name Description
start_date
required

Start date (YYYY-MM-DD)

Validations:

  • Must be a String
end_date
required

End date (YYYY-MM-DD)

Validations:

  • Must be a String

Examples

Returns an .xlsx file download with friends & family investor movements for the given date range.

Errors

Code Description
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
>>>

GET /reports/theoretical_debt
Theoretical debt report

Params

Param name Description
date
required

Reference date (YYYY-MM-DD)

Validations:

  • Must be a String

Examples

Returns an .xlsx file download with the projected debt (capital + interests) as of the given date.

Errors

Code Description
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
>>>

GET /reports/penalty_interests_by_resource
Penalty interests by resource report

Params

Param name Description
resource
required

Resource type: promissory_note, provision, simple_credit

Validations:

  • Must be a String
reports
required

Resource ID

Validations:

  • Must be a String
date
required

Reference date (YYYY-MM-DD)

Validations:

  • Must be a String

Examples

Returns an .xlsx file download with penalty interests for the specified resource as of the given date.

Errors

Code Description
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error