VUZDevelopers

Get the deal control room — one aggregated read of deal, linked documents, client financial panel, and recent activity

GET
/crm/deals/{id}/control-room

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Path Parameters

id*string

Deal UUID

Response Body

application/json

curl -X GET "https://example.com/crm/deals/string/control-room"
{  "deal": {    "id": "string",    "businessId": "string",    "pipelineId": "string",    "pipelineName": "string",    "stageId": "string",    "stageName": "string",    "title": "string",    "clientId": "string",    "clientName": "string",    "client": {      "id": "string",      "name": "string",      "phone": "string",      "email": "string"    },    "assignedToUserId": "string",    "assignedToUserName": "string",    "description": "string",    "status": "open",    "value": 0,    "probability": 0,    "currency": "string",    "expectedCloseDate": "string",    "source": "string",    "lostReason": "string",    "closedAt": "2019-08-24T14:15:22Z",    "lineItems": [      {        "id": "string",        "dealId": "string",        "productId": "string",        "description": "string",        "quantity": 0,        "unitPrice": 0,        "discountType": "PERCENT",        "discountValue": 0,        "vatRate": 0,        "itemVatMode": "exempt",        "lineSubTotal": 0,        "lineVatTotal": 0,        "lineGrandTotal": 0,        "sortOrder": 0,        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    ],    "primaryQuoteStatus": "created",    "primaryQuoteViewCount": 0,    "primaryQuoteDocNumber": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "documents": [    {      "linkId": "string",      "role": "string",      "isPrimary": true,      "originEvent": "string",      "documentId": "string",      "docType": "order",      "docNumber": "string",      "grandTotal": 0,      "paymentStatus": "UNPAID",      "documentBalance": 0,      "publicViewCount": 0    }  ],  "clientPanel": {    "balance": {      "customerId": "550e8400-e29b-41d4-a716-446655440000",      "customerName": "ABC Company Ltd",      "currentBalance": 2500,      "currency": "ILS",      "summary": {        "totalDebit": 15000,        "totalCredit": 12500,        "openInvoicesCount": 3,        "overdueAmount": 1200,        "creditAvailable": 0      },      "aging": {        "current": 1300,        "days1to30": 800,        "days31to60": 400,        "days61to90": 0,        "over90": 0      },      "lastActivity": {        "lastInvoiceDate": "2025-01-15",        "lastPaymentDate": "2025-01-20",        "lastActivityDate": "2025-01-20"      }    },    "openItems": {      "data": [        {          "documentId": "550e8400-e29b-41d4-a716-446655440000",          "docNumber": "INV-60001",          "docType": "TAX_INVOICE",          "issueDate": "2025-01-15",          "dueDate": "2025-02-15",          "originalAmount": 1180,          "paidAmount": 500,          "remainingAmount": 680,          "daysOverdue": 5,          "status": "PARTIALLY_PAID",          "currency": "ILS",          "client": {}        }      ],      "summary": {}    },    "aggregates": {      "clientId": "string",      "totalRevenue": 0,      "revenueCurrentYear": 0,      "revenuePreviousYear": 0,      "revenueLast12Months": 0,      "yoyGrowth": 0,      "outstandingBalance": 0,      "overdueBalance": 0,      "creditBalance": 0,      "totalInvoices": 0,      "paidInvoices": 0,      "openInvoices": 0,      "overdueInvoices": 0,      "paymentRate": 0,      "totalQuotes": 0,      "convertedQuotes": 0,      "quoteConversionRate": 0,      "totalCreditNotes": 0,      "creditNotesAmount": 0,      "avgDaysToPayment": 0,      "onTimePaymentRate": 0,      "bouncedChecks": 0,      "firstTransactionDate": "2019-08-24T14:15:22Z",      "lastTransactionDate": "2019-08-24T14:15:22Z",      "lastPaymentDate": "2019-08-24T14:15:22Z",      "daysSinceLastActivity": 0,      "activeMonthsLast12": 0,      "avgInvoiceAmount": 0,      "largestInvoice": 0,      "lastFullRecalculation": "2019-08-24T14:15:22Z",      "lastIncrementalUpdate": "2019-08-24T14:15:22Z"    }  },  "recentActivities": [    {      "id": "string",      "dealId": "string",      "userId": "string",      "activityType": "string",      "description": "string",      "oldValue": {},      "newValue": {},      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "nextBestAction": {    "ruleId": "unpaid_invoice_no_payment_link",    "message": "שלח קישור תשלום",    "reason": "אין שום פעולה מתוכננת על העסקה הזו — עסקאות בלי צעד הבא נוטות להיתקע. קבע משימה או תזכורת.",    "actionType": "send_payment_link",    "actionLabel": "שלח קישור תשלום",    "actionUrl": "/app/crm/deals/550e8400-e29b-41d4-a716-446655440000"  }}