AlphaAlpha Docs
API ReferenceCrm dashboard

Get actions dashboard

Returns today's actions and overdue items

GET
/crm/dashboard/actions

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/dashboard/actions"
{
  "overdueActivities": [
    {
      "attendees": [
        "string"
      ],
      "completed": true,
      "completedAt": "2019-08-24T14:15:22Z",
      "contactEmail": "string",
      "contactName": "string",
      "contactPhone": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "customerId": "string",
      "description": "string",
      "dueDate": "2019-08-24T14:15:22Z",
      "dueNotifiedAt": "2019-08-24T14:15:22Z",
      "durationMinutes": 0,
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "isCompleted": true,
      "location": "string",
      "number": "string",
      "opportunityId": "string",
      "outcome": "string",
      "ownerId": "string",
      "priority": "LOW",
      "scheduledAt": "2019-08-24T14:15:22Z",
      "subject": "string",
      "tenantId": "string",
      "type": "CALL",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "overdueOpportunityActions": [
    {
      "changeOrders": [
        {
          "accessTokenHash": "string",
          "amount": 0.1,
          "approvedAt": "2019-08-24T14:15:22Z",
          "approvedBy": "string",
          "category": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "rejectedAt": "2019-08-24T14:15:22Z",
          "rejectionReason": "string",
          "sentAt": "2019-08-24T14:15:22Z",
          "sentBy": "string",
          "status": "DRAFT"
        }
      ],
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "customerId": "string",
      "description": "string",
      "estimateIds": [
        "string"
      ],
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "expectedCloseDate": "2019-08-24T14:15:22Z",
      "fulfillmentDate": "2019-08-24T14:15:22Z",
      "id": "string",
      "invoiceIds": [
        "string"
      ],
      "leadId": "string",
      "name": "string",
      "nextAction": "string",
      "nextActionDueDate": "2019-08-24T14:15:22Z",
      "notes": "string",
      "number": "string",
      "orderDate": "2019-08-24T14:15:22Z",
      "orderId": "string",
      "ownerId": "string",
      "paymentSchedule": [
        {
          "id": "string",
          "includeChangeOrders": true,
          "invoiceId": "string",
          "label": "string",
          "paymentDueDays": 0,
          "percentage": 0.1,
          "relativeDays": 0,
          "status": "PENDING",
          "triggerStatus": "NEW",
          "triggerType": "STATUS_CHANGE",
          "triggeredAt": "2019-08-24T14:15:22Z"
        }
      ],
      "planningBlocks": [
        {
          "endDate": "2019-08-24",
          "id": "string",
          "notes": "string",
          "startDate": "2019-08-24",
          "status": "PLANNED",
          "teamId": "string"
        }
      ],
      "probability": 0,
      "productIds": [
        "string"
      ],
      "questionnaire": [
        {
          "id": "string",
          "label": "string",
          "numberValue": 0.1,
          "options": [
            "string"
          ],
          "photoFileIds": [
            "string"
          ],
          "questionId": "string",
          "required": true,
          "selectedOption": "string",
          "sortOrder": 0,
          "textValue": "string",
          "type": "TEXT"
        }
      ],
      "scheduledEndDate": "2019-08-24",
      "scheduledStartDate": "2019-08-24",
      "source": "string",
      "status": "NEW",
      "subsidiaryId": "string",
      "tags": [
        "string"
      ],
      "teamId": "string",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "value": 0.1
    }
  ],
  "overdueTasks": [
    {
      "attendees": [
        "string"
      ],
      "completed": true,
      "completedAt": "2019-08-24T14:15:22Z",
      "contactEmail": "string",
      "contactName": "string",
      "contactPhone": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "customerId": "string",
      "description": "string",
      "dueDate": "2019-08-24T14:15:22Z",
      "dueNotifiedAt": "2019-08-24T14:15:22Z",
      "durationMinutes": 0,
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "isCompleted": true,
      "location": "string",
      "number": "string",
      "opportunityId": "string",
      "outcome": "string",
      "ownerId": "string",
      "priority": "LOW",
      "scheduledAt": "2019-08-24T14:15:22Z",
      "subject": "string",
      "tenantId": "string",
      "type": "CALL",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "plannedActivities": [
    {
      "attendees": [
        "string"
      ],
      "completed": true,
      "completedAt": "2019-08-24T14:15:22Z",
      "contactEmail": "string",
      "contactName": "string",
      "contactPhone": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "customerId": "string",
      "description": "string",
      "dueDate": "2019-08-24T14:15:22Z",
      "dueNotifiedAt": "2019-08-24T14:15:22Z",
      "durationMinutes": 0,
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "isCompleted": true,
      "location": "string",
      "number": "string",
      "opportunityId": "string",
      "outcome": "string",
      "ownerId": "string",
      "priority": "LOW",
      "scheduledAt": "2019-08-24T14:15:22Z",
      "subject": "string",
      "tenantId": "string",
      "type": "CALL",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "plannedOpportunityActions": [
    {
      "changeOrders": [
        {
          "accessTokenHash": "string",
          "amount": 0.1,
          "approvedAt": "2019-08-24T14:15:22Z",
          "approvedBy": "string",
          "category": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "rejectedAt": "2019-08-24T14:15:22Z",
          "rejectionReason": "string",
          "sentAt": "2019-08-24T14:15:22Z",
          "sentBy": "string",
          "status": "DRAFT"
        }
      ],
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "customerId": "string",
      "description": "string",
      "estimateIds": [
        "string"
      ],
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "expectedCloseDate": "2019-08-24T14:15:22Z",
      "fulfillmentDate": "2019-08-24T14:15:22Z",
      "id": "string",
      "invoiceIds": [
        "string"
      ],
      "leadId": "string",
      "name": "string",
      "nextAction": "string",
      "nextActionDueDate": "2019-08-24T14:15:22Z",
      "notes": "string",
      "number": "string",
      "orderDate": "2019-08-24T14:15:22Z",
      "orderId": "string",
      "ownerId": "string",
      "paymentSchedule": [
        {
          "id": "string",
          "includeChangeOrders": true,
          "invoiceId": "string",
          "label": "string",
          "paymentDueDays": 0,
          "percentage": 0.1,
          "relativeDays": 0,
          "status": "PENDING",
          "triggerStatus": "NEW",
          "triggerType": "STATUS_CHANGE",
          "triggeredAt": "2019-08-24T14:15:22Z"
        }
      ],
      "planningBlocks": [
        {
          "endDate": "2019-08-24",
          "id": "string",
          "notes": "string",
          "startDate": "2019-08-24",
          "status": "PLANNED",
          "teamId": "string"
        }
      ],
      "probability": 0,
      "productIds": [
        "string"
      ],
      "questionnaire": [
        {
          "id": "string",
          "label": "string",
          "numberValue": 0.1,
          "options": [
            "string"
          ],
          "photoFileIds": [
            "string"
          ],
          "questionId": "string",
          "required": true,
          "selectedOption": "string",
          "sortOrder": 0,
          "textValue": "string",
          "type": "TEXT"
        }
      ],
      "scheduledEndDate": "2019-08-24",
      "scheduledStartDate": "2019-08-24",
      "source": "string",
      "status": "NEW",
      "subsidiaryId": "string",
      "tags": [
        "string"
      ],
      "teamId": "string",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "value": 0.1
    }
  ],
  "todaysActivities": [
    {
      "attendees": [
        "string"
      ],
      "completed": true,
      "completedAt": "2019-08-24T14:15:22Z",
      "contactEmail": "string",
      "contactName": "string",
      "contactPhone": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "customerId": "string",
      "description": "string",
      "dueDate": "2019-08-24T14:15:22Z",
      "dueNotifiedAt": "2019-08-24T14:15:22Z",
      "durationMinutes": 0,
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "isCompleted": true,
      "location": "string",
      "number": "string",
      "opportunityId": "string",
      "outcome": "string",
      "ownerId": "string",
      "priority": "LOW",
      "scheduledAt": "2019-08-24T14:15:22Z",
      "subject": "string",
      "tenantId": "string",
      "type": "CALL",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "todaysOpportunityActions": [
    {
      "changeOrders": [
        {
          "accessTokenHash": "string",
          "amount": 0.1,
          "approvedAt": "2019-08-24T14:15:22Z",
          "approvedBy": "string",
          "category": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "rejectedAt": "2019-08-24T14:15:22Z",
          "rejectionReason": "string",
          "sentAt": "2019-08-24T14:15:22Z",
          "sentBy": "string",
          "status": "DRAFT"
        }
      ],
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "customerId": "string",
      "description": "string",
      "estimateIds": [
        "string"
      ],
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "expectedCloseDate": "2019-08-24T14:15:22Z",
      "fulfillmentDate": "2019-08-24T14:15:22Z",
      "id": "string",
      "invoiceIds": [
        "string"
      ],
      "leadId": "string",
      "name": "string",
      "nextAction": "string",
      "nextActionDueDate": "2019-08-24T14:15:22Z",
      "notes": "string",
      "number": "string",
      "orderDate": "2019-08-24T14:15:22Z",
      "orderId": "string",
      "ownerId": "string",
      "paymentSchedule": [
        {
          "id": "string",
          "includeChangeOrders": true,
          "invoiceId": "string",
          "label": "string",
          "paymentDueDays": 0,
          "percentage": 0.1,
          "relativeDays": 0,
          "status": "PENDING",
          "triggerStatus": "NEW",
          "triggerType": "STATUS_CHANGE",
          "triggeredAt": "2019-08-24T14:15:22Z"
        }
      ],
      "planningBlocks": [
        {
          "endDate": "2019-08-24",
          "id": "string",
          "notes": "string",
          "startDate": "2019-08-24",
          "status": "PLANNED",
          "teamId": "string"
        }
      ],
      "probability": 0,
      "productIds": [
        "string"
      ],
      "questionnaire": [
        {
          "id": "string",
          "label": "string",
          "numberValue": 0.1,
          "options": [
            "string"
          ],
          "photoFileIds": [
            "string"
          ],
          "questionId": "string",
          "required": true,
          "selectedOption": "string",
          "sortOrder": 0,
          "textValue": "string",
          "type": "TEXT"
        }
      ],
      "scheduledEndDate": "2019-08-24",
      "scheduledStartDate": "2019-08-24",
      "source": "string",
      "status": "NEW",
      "subsidiaryId": "string",
      "tags": [
        "string"
      ],
      "teamId": "string",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "value": 0.1
    }
  ],
  "unscheduledActivities": [
    {
      "attendees": [
        "string"
      ],
      "completed": true,
      "completedAt": "2019-08-24T14:15:22Z",
      "contactEmail": "string",
      "contactName": "string",
      "contactPhone": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "customerId": "string",
      "description": "string",
      "dueDate": "2019-08-24T14:15:22Z",
      "dueNotifiedAt": "2019-08-24T14:15:22Z",
      "durationMinutes": 0,
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "isCompleted": true,
      "location": "string",
      "number": "string",
      "opportunityId": "string",
      "outcome": "string",
      "ownerId": "string",
      "priority": "LOW",
      "scheduledAt": "2019-08-24T14:15:22Z",
      "subject": "string",
      "tenantId": "string",
      "type": "CALL",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ]
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Update preferred language

Previous Page

Get appointment cancellation stats

Next Page