FD
V1 V2

V2 · Core resources

Applications

Read finance applications scoped to a single enterprise.

An application represents a finance application processed inside FinDesk. In V2 this resource is read-only — listing and retrieval are the only endpoints exposed via routes/api.php.

Attributes

The shape returned by App\Http\Resources\V2\ApplicationResource::toArray():

Attribute Type Description
id string (UUID) Stable public identifier (uuid column).
enterprise_id string (UUID) UUID of the owning enterprise (Team) — derived via Team::find($team_id)->uuid.
settlement_date_actual string | null (date) Actual settlement date (maps to the settlement column).
contract_number string | null Number of the associated contract (contract->number).
source_of_business string | null Referrer type label (referrerType->name).
asset_type string | null Asset-type name from the active quote's calculation.
asset_description string | null Description from the active quote's calculation.
financier string | null Financier name from the active quote's calculation.
total_finance_amount string | null Total financed amount from the active quote (calculation->finance_total).
hubspot_deal_id string | null HubSpot deal id (hubspotDeal->hubspot_id) if linked.
created_at string (ISO 8601) Record creation timestamp.
updated_at string (ISO 8601) Record updated timestamp.

Note — asset_type, asset_description, financier, and total_finance_amount are sourced from the application's active quote. If the application has no active quote, all four are null.

List applications

GET /api/v2/applications

Returns a paginated list of applications belonging to the enterprise identified by the X-Enterprise-Id header. Page size is fixed at 100 — see Pagination.

Request headers

Header Required Description
Authorization Yes Bearer {token} from POST /api/v2/login.
Accept Yes Must be application/json.
X-Enterprise-Id Yes UUID of the enterprise whose applications you want to list.

Query parameters

None. Page size is fixed server-side. Use the cursors in the links block to paginate.

Responses

  • 200 — paginated ApplicationsResource collection (envelope: data, links, meta).
  • 403 Forbidden — token belongs to a user who is not a member of the enterprise identified by X-Enterprise-Id.

Retrieve an application

GET /api/v2/applications/{application:uuid}

The {application} path parameter is the application's uuid. Route-model binding resolves on the uuid column.

Path parameters

Parameter Type Description
application string (UUID) UUID of the application to retrieve.

Responses

  • 200 — single ApplicationResource (envelope: data).
  • 403 Forbidden — caller is not a member of the enterprise in X-Enterprise-Id, or the application's team_id does not match.

V2 differences — Request bodies sent to other V2 endpoints pass through App\Http\Middleware\NormalizeApiInput, which recursively rewrites PascalCase / camelCase keys to snake_case (see Authentication for details). Because the application endpoints are read-only, the middleware is effectively a no-op here.