FD
V1 V2

V1 · Core resources

Applications

Read finance applications scoped to a single enterprise.

An application represents a finance application processed inside FinDesk. In V1 this resource is read-only — only index and show are wired in routes/api.php.

Attributes

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

Attribute Type Description
ID string (UUID) Stable public identifier (uuid column).
EnterpriseID string (UUID) UUID of the owning enterprise (Team) — derived via Team::find($team_id)->uuid.
SettlementDateActual string | null (date) Actual settlement date (maps to the settlement column).
ContractNumber string | null Number of the associated contract (contract->number).
SourceOfBusiness string | null Referrer type label (referrerType->name).
AssetType string | null Asset-type name from the active quote's calculation.
AssetDescription string | null Description from the active quote's calculation.
Financier string | null Financier name from the active quote's calculation.
TotalFinanceAmount string | null Total financed amount from the active quote (calculation->finance_total).
HubspotDealID string | null HubSpot deal id (hubspotDeal->hubspot_id) if linked.
CreatedAt string (ISO 8601) Record creation timestamp.
UpdatedAt string (ISO 8601) Record updated timestamp.

Note — AssetType, AssetDescription, Financier, and TotalFinanceAmount are sourced from the application's active quote. If the application has no active quote, all four are null.

List applications

GET /api/v1/applications

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

Request headers

Header Required Description
Authorization Yes Bearer {token} from POST /api/v1/login.
Accept Yes Must be application/json.
EnterpriseID 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 EnterpriseID.

Retrieve an application

GET /api/v1/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 EnterpriseID, or the application's team_id does not match.