Deals Guide

Understand when API workflows create dashboard deals and how to retrieve them.

A deal is the dashboard record your team can review inside B2 Systems.

InFlow and TrueSight can both create deals when create_deal is true.

There is no separate public create deal endpoint in the first version of the API. Create a deal through InFlow or TrueSight when you want dashboard visibility.

The organization associated with the API key owns the created deal. Broker API keys create broker-owned deals, while funder API keys create funder-owned deals.

When to Create a Deal

Set create_deal to true when:

  • Your team wants to review the application in the B2 Systems dashboard.
  • You want the parsed or matched data tied to a dashboard record.
  • You expect later workflow steps to happen inside B2 Systems.

Keep create_deal as false when:

  • You only need parsing results.
  • You only need matching results.
  • Your CRM remains the primary system of record.

Deal Creation From InFlow

When create_deal is true on POST /v1/inflow/parsing, B2 Systems creates a dashboard deal and returns deal_id.

After parsing completes, the deal is updated with parsed application and financial data.

Deal Creation From TrueSight

When create_deal is true on POST /v1/truesight/matching, B2 Systems creates or updates a dashboard deal with the supplied application, financials, and matching results.

If matching is run from a parsing_id that already created a deal, the existing deal is updated.

Matching results are stored separately from the deal record and linked to the deal as the active match run. That lets the dashboard and public API return the latest completed matching results without requiring the full deal record to carry every historical match payload.

Retrieve a Deal

curl https://api.b2systems.io/v1/deals/deal_01JZ8R4F31XQ5V1S3RGEQ2K5CN \
  -H "Authorization: Bearer $B2_API_KEY"

The deal response includes:

  • stage
  • application
  • financials
  • matched_funders
  • created_at
  • updated_at

matched_funders reflects the deal's latest active matching results. It can be empty when no matching run has completed for the deal yet.

Deal Stages

The public stage field describes the deal's general dashboard stage. Possible values are:

  • Potential
  • New submission
  • ISO review
  • Processing
  • Underwriting
  • Closed

The stage is intentionally broader than the funder-specific workflow shown in the dashboard. It does not identify an individual offer, information request, contract, or final-and-stips action.

Access Rules

An API key can only retrieve deals owned by the same organization as the key.

Broker API keys can retrieve broker-owned deals for their organization. Funder API keys can retrieve funder-owned deals for their organization.

If a deal is not visible to the organization, the API returns not_found.

Dashboard Workflow Boundary

Creating a deal through the public API does not automatically submit it to funders or create a linked deal for another organization.

Funder submission and the following funder-specific actions are managed in the B2 Systems dashboards and are not public API operations in this version:

  • Offers and offer acceptance
  • Information requests
  • Contract requests
  • Final and stips
  • External action links
  • Deal notes and supporting documents

GET /v1/deals/{deal_id} returns the general deal stage, application, financials, and latest matching results. It does not return the complete per-funder dashboard workflow.


Did this page help you?