List Financings

Retrieve the financings for a design.


Not specifying financing_option filter allows for the comparison between financings of different types on common attributes such as lifetime_savings or annual_cashflows.

To compare financings of the same type in depth, please specify a valid financing_option in the request URI. The response will include all the common attributes attributes and also type-specific attributes in addition, such as payback_period for cash financings and loan_principal or down_payment for loans. See below for the full list of possible financing_option values and additional response attributes that will be returned with it

Path Params
uuid
required

The ID of the tenant that the design is part of.

uuid
required

The ID of the design to retrieve the financings for.

Query Params
string
enum

Only show specific financing types. Some financing attributes are only populated by specifying a valid financing type here.

Allowed:
string
enum

Only shows the financings that was last selected in Sales Mode, when set to "true".

Allowed:
Responses

404

Not Found

Language
Credentials
Bearer
header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json