AlphaAlpha Docs
API Reference

C R M Customer

API calls for CRM customer management

Get customers by owner

GET
/crm/customers/by-owner/{ownerId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

ownerId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/customers/by-owner/string"
[
  {
    "avatar": {
      "blobId": "string",
      "height": 0,
      "thumbnailBlobId": "string",
      "width": 0
    },
    "billingAddress": {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    },
    "btw": "string",
    "contacts": [
      {
        "department": "string",
        "email": "string",
        "firstName": "string",
        "id": "string",
        "lastName": "string",
        "phone": "string"
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "crmStatus": "LEAD",
    "deliveryAddresses": [
      {
        "city": "string",
        "country": "string",
        "houseNumber": "string",
        "id": "string",
        "latitude": 0.1,
        "longitude": 0.1,
        "postalCode": "string",
        "street": "string"
      }
    ],
    "email": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "industry": "string",
    "kvk": "string",
    "leadSource": "string",
    "name": "string",
    "nextAction": "string",
    "nextActionDueDate": "2019-08-24T14:15:22Z",
    "ownerId": "string",
    "phone": "string",
    "preferredLanguage": "string",
    "region": "string",
    "subsidiaryId": "string",
    "tags": [
      "string"
    ],
    "tenantId": "string",
    "type": "PERSON",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "userId": "string",
    "visits": [
      {
        "frequency": 0,
        "ip": "string",
        "time": "2019-08-24T14:15:22Z"
      }
    ],
    "website": "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"
}

Get customers by status

GET
/crm/customers/by-status/{status}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

status*string
Value in"LEAD" | "PROSPECT" | "ACTIVE" | "CUSTOMER" | "INACTIVE" | "CHURNED"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/customers/by-status/LEAD"
[
  {
    "avatar": {
      "blobId": "string",
      "height": 0,
      "thumbnailBlobId": "string",
      "width": 0
    },
    "billingAddress": {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    },
    "btw": "string",
    "contacts": [
      {
        "department": "string",
        "email": "string",
        "firstName": "string",
        "id": "string",
        "lastName": "string",
        "phone": "string"
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "crmStatus": "LEAD",
    "deliveryAddresses": [
      {
        "city": "string",
        "country": "string",
        "houseNumber": "string",
        "id": "string",
        "latitude": 0.1,
        "longitude": 0.1,
        "postalCode": "string",
        "street": "string"
      }
    ],
    "email": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "industry": "string",
    "kvk": "string",
    "leadSource": "string",
    "name": "string",
    "nextAction": "string",
    "nextActionDueDate": "2019-08-24T14:15:22Z",
    "ownerId": "string",
    "phone": "string",
    "preferredLanguage": "string",
    "region": "string",
    "subsidiaryId": "string",
    "tags": [
      "string"
    ],
    "tenantId": "string",
    "type": "PERSON",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "userId": "string",
    "visits": [
      {
        "frequency": 0,
        "ip": "string",
        "time": "2019-08-24T14:15:22Z"
      }
    ],
    "website": "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"
}

Get my customers

GET
/crm/customers/my

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/customers/my"
[
  {
    "avatar": {
      "blobId": "string",
      "height": 0,
      "thumbnailBlobId": "string",
      "width": 0
    },
    "billingAddress": {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    },
    "btw": "string",
    "contacts": [
      {
        "department": "string",
        "email": "string",
        "firstName": "string",
        "id": "string",
        "lastName": "string",
        "phone": "string"
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "crmStatus": "LEAD",
    "deliveryAddresses": [
      {
        "city": "string",
        "country": "string",
        "houseNumber": "string",
        "id": "string",
        "latitude": 0.1,
        "longitude": 0.1,
        "postalCode": "string",
        "street": "string"
      }
    ],
    "email": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "industry": "string",
    "kvk": "string",
    "leadSource": "string",
    "name": "string",
    "nextAction": "string",
    "nextActionDueDate": "2019-08-24T14:15:22Z",
    "ownerId": "string",
    "phone": "string",
    "preferredLanguage": "string",
    "region": "string",
    "subsidiaryId": "string",
    "tags": [
      "string"
    ],
    "tenantId": "string",
    "type": "PERSON",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "userId": "string",
    "visits": [
      {
        "frequency": 0,
        "ip": "string",
        "time": "2019-08-24T14:15:22Z"
      }
    ],
    "website": "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"
}

Get customers with overdue actions

GET
/crm/customers/overdue-actions

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/customers/overdue-actions"
[
  {
    "avatar": {
      "blobId": "string",
      "height": 0,
      "thumbnailBlobId": "string",
      "width": 0
    },
    "billingAddress": {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    },
    "btw": "string",
    "contacts": [
      {
        "department": "string",
        "email": "string",
        "firstName": "string",
        "id": "string",
        "lastName": "string",
        "phone": "string"
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "crmStatus": "LEAD",
    "deliveryAddresses": [
      {
        "city": "string",
        "country": "string",
        "houseNumber": "string",
        "id": "string",
        "latitude": 0.1,
        "longitude": 0.1,
        "postalCode": "string",
        "street": "string"
      }
    ],
    "email": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "industry": "string",
    "kvk": "string",
    "leadSource": "string",
    "name": "string",
    "nextAction": "string",
    "nextActionDueDate": "2019-08-24T14:15:22Z",
    "ownerId": "string",
    "phone": "string",
    "preferredLanguage": "string",
    "region": "string",
    "subsidiaryId": "string",
    "tags": [
      "string"
    ],
    "tenantId": "string",
    "type": "PERSON",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "userId": "string",
    "visits": [
      {
        "frequency": 0,
        "ip": "string",
        "time": "2019-08-24T14:15:22Z"
      }
    ],
    "website": "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"
}

Get enriched customer

GET
/crm/customers/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/customers/string"
{
  "avatar": {
    "blobId": "string",
    "height": 0,
    "thumbnailBlobId": "string",
    "width": 0
  },
  "billingAddress": {
    "city": "string",
    "country": "string",
    "houseNumber": "string",
    "id": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "postalCode": "string",
    "street": "string"
  },
  "btw": "string",
  "contacts": [
    {
      "department": "string",
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "phone": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "crmStatus": "LEAD",
  "deliveryAddresses": [
    {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    }
  ],
  "email": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "industry": "string",
  "kvk": "string",
  "leadSource": "string",
  "name": "string",
  "nextAction": "string",
  "nextActionDueDate": "2019-08-24T14:15:22Z",
  "opportunities": [
    {
      "changeOrders": [
        {
          "amount": 0.1,
          "category": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string"
        }
      ],
      "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",
      "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"
        }
      ],
      "probability": 0,
      "productIds": [
        "string"
      ],
      "scheduledEndDate": "2019-08-24",
      "scheduledStartDate": "2019-08-24",
      "source": "string",
      "status": "NEW",
      "tags": [
        "string"
      ],
      "teamId": "string",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "value": 0.1
    }
  ],
  "owner": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "ownerId": "string",
  "phone": "string",
  "recentActivities": [
    {
      "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",
      "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"
    }
  ],
  "region": "string",
  "subsidiaryId": "string",
  "tags": [
    "string"
  ],
  "tenantId": "string",
  "type": "PERSON",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "userId": "string",
  "website": "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 CRM status

PATCH
/crm/customers/{id}/crm-status

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/crm/customers/string/crm-status" \  -H "Content-Type: application/json" \  -d '{    "crmStatus": "LEAD"  }'
{
  "avatar": {
    "blobId": "string",
    "height": 0,
    "thumbnailBlobId": "string",
    "width": 0
  },
  "billingAddress": {
    "city": "string",
    "country": "string",
    "houseNumber": "string",
    "id": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "postalCode": "string",
    "street": "string"
  },
  "btw": "string",
  "contacts": [
    {
      "department": "string",
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "phone": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "crmStatus": "LEAD",
  "deliveryAddresses": [
    {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    }
  ],
  "email": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "industry": "string",
  "kvk": "string",
  "leadSource": "string",
  "name": "string",
  "nextAction": "string",
  "nextActionDueDate": "2019-08-24T14:15:22Z",
  "opportunities": [
    {
      "changeOrders": [
        {
          "amount": 0.1,
          "category": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string"
        }
      ],
      "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",
      "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"
        }
      ],
      "probability": 0,
      "productIds": [
        "string"
      ],
      "scheduledEndDate": "2019-08-24",
      "scheduledStartDate": "2019-08-24",
      "source": "string",
      "status": "NEW",
      "tags": [
        "string"
      ],
      "teamId": "string",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "value": 0.1
    }
  ],
  "owner": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "ownerId": "string",
  "phone": "string",
  "recentActivities": [
    {
      "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",
      "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"
    }
  ],
  "region": "string",
  "subsidiaryId": "string",
  "tags": [
    "string"
  ],
  "tenantId": "string",
  "type": "PERSON",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "userId": "string",
  "website": "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 next action

PATCH
/crm/customers/{id}/next-action

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/crm/customers/string/next-action" \  -H "Content-Type: application/json" \  -d '{}'
{
  "avatar": {
    "blobId": "string",
    "height": 0,
    "thumbnailBlobId": "string",
    "width": 0
  },
  "billingAddress": {
    "city": "string",
    "country": "string",
    "houseNumber": "string",
    "id": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "postalCode": "string",
    "street": "string"
  },
  "btw": "string",
  "contacts": [
    {
      "department": "string",
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "phone": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "crmStatus": "LEAD",
  "deliveryAddresses": [
    {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    }
  ],
  "email": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "industry": "string",
  "kvk": "string",
  "leadSource": "string",
  "name": "string",
  "nextAction": "string",
  "nextActionDueDate": "2019-08-24T14:15:22Z",
  "opportunities": [
    {
      "changeOrders": [
        {
          "amount": 0.1,
          "category": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string"
        }
      ],
      "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",
      "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"
        }
      ],
      "probability": 0,
      "productIds": [
        "string"
      ],
      "scheduledEndDate": "2019-08-24",
      "scheduledStartDate": "2019-08-24",
      "source": "string",
      "status": "NEW",
      "tags": [
        "string"
      ],
      "teamId": "string",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "value": 0.1
    }
  ],
  "owner": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "ownerId": "string",
  "phone": "string",
  "recentActivities": [
    {
      "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",
      "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"
    }
  ],
  "region": "string",
  "subsidiaryId": "string",
  "tags": [
    "string"
  ],
  "tenantId": "string",
  "type": "PERSON",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "userId": "string",
  "website": "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"
}

Remove owner

DELETE
/crm/customers/{id}/owner

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/crm/customers/string/owner"
{
  "avatar": {
    "blobId": "string",
    "height": 0,
    "thumbnailBlobId": "string",
    "width": 0
  },
  "billingAddress": {
    "city": "string",
    "country": "string",
    "houseNumber": "string",
    "id": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "postalCode": "string",
    "street": "string"
  },
  "btw": "string",
  "contacts": [
    {
      "department": "string",
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "phone": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "crmStatus": "LEAD",
  "deliveryAddresses": [
    {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    }
  ],
  "email": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "industry": "string",
  "kvk": "string",
  "leadSource": "string",
  "name": "string",
  "nextAction": "string",
  "nextActionDueDate": "2019-08-24T14:15:22Z",
  "opportunities": [
    {
      "changeOrders": [
        {
          "amount": 0.1,
          "category": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string"
        }
      ],
      "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",
      "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"
        }
      ],
      "probability": 0,
      "productIds": [
        "string"
      ],
      "scheduledEndDate": "2019-08-24",
      "scheduledStartDate": "2019-08-24",
      "source": "string",
      "status": "NEW",
      "tags": [
        "string"
      ],
      "teamId": "string",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "value": 0.1
    }
  ],
  "owner": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "ownerId": "string",
  "phone": "string",
  "recentActivities": [
    {
      "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",
      "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"
    }
  ],
  "region": "string",
  "subsidiaryId": "string",
  "tags": [
    "string"
  ],
  "tenantId": "string",
  "type": "PERSON",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "userId": "string",
  "website": "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"
}

Assign owner

PATCH
/crm/customers/{id}/owner/{ownerId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string
ownerId*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/crm/customers/string/owner/string"
{
  "avatar": {
    "blobId": "string",
    "height": 0,
    "thumbnailBlobId": "string",
    "width": 0
  },
  "billingAddress": {
    "city": "string",
    "country": "string",
    "houseNumber": "string",
    "id": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "postalCode": "string",
    "street": "string"
  },
  "btw": "string",
  "contacts": [
    {
      "department": "string",
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "phone": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "crmStatus": "LEAD",
  "deliveryAddresses": [
    {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    }
  ],
  "email": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "industry": "string",
  "kvk": "string",
  "leadSource": "string",
  "name": "string",
  "nextAction": "string",
  "nextActionDueDate": "2019-08-24T14:15:22Z",
  "opportunities": [
    {
      "changeOrders": [
        {
          "amount": 0.1,
          "category": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string"
        }
      ],
      "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",
      "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"
        }
      ],
      "probability": 0,
      "productIds": [
        "string"
      ],
      "scheduledEndDate": "2019-08-24",
      "scheduledStartDate": "2019-08-24",
      "source": "string",
      "status": "NEW",
      "tags": [
        "string"
      ],
      "teamId": "string",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "value": 0.1
    }
  ],
  "owner": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "ownerId": "string",
  "phone": "string",
  "recentActivities": [
    {
      "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",
      "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"
    }
  ],
  "region": "string",
  "subsidiaryId": "string",
  "tags": [
    "string"
  ],
  "tenantId": "string",
  "type": "PERSON",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "userId": "string",
  "website": "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"
}

Add tag

POST
/crm/customers/{id}/tags/{tag}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string
tag*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/crm/customers/string/tags/string"
{
  "avatar": {
    "blobId": "string",
    "height": 0,
    "thumbnailBlobId": "string",
    "width": 0
  },
  "billingAddress": {
    "city": "string",
    "country": "string",
    "houseNumber": "string",
    "id": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "postalCode": "string",
    "street": "string"
  },
  "btw": "string",
  "contacts": [
    {
      "department": "string",
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "phone": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "crmStatus": "LEAD",
  "deliveryAddresses": [
    {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    }
  ],
  "email": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "industry": "string",
  "kvk": "string",
  "leadSource": "string",
  "name": "string",
  "nextAction": "string",
  "nextActionDueDate": "2019-08-24T14:15:22Z",
  "opportunities": [
    {
      "changeOrders": [
        {
          "amount": 0.1,
          "category": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string"
        }
      ],
      "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",
      "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"
        }
      ],
      "probability": 0,
      "productIds": [
        "string"
      ],
      "scheduledEndDate": "2019-08-24",
      "scheduledStartDate": "2019-08-24",
      "source": "string",
      "status": "NEW",
      "tags": [
        "string"
      ],
      "teamId": "string",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "value": 0.1
    }
  ],
  "owner": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "ownerId": "string",
  "phone": "string",
  "recentActivities": [
    {
      "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",
      "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"
    }
  ],
  "region": "string",
  "subsidiaryId": "string",
  "tags": [
    "string"
  ],
  "tenantId": "string",
  "type": "PERSON",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "userId": "string",
  "website": "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"
}

Remove tag

DELETE
/crm/customers/{id}/tags/{tag}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string
tag*string

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/crm/customers/string/tags/string"
{
  "avatar": {
    "blobId": "string",
    "height": 0,
    "thumbnailBlobId": "string",
    "width": 0
  },
  "billingAddress": {
    "city": "string",
    "country": "string",
    "houseNumber": "string",
    "id": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "postalCode": "string",
    "street": "string"
  },
  "btw": "string",
  "contacts": [
    {
      "department": "string",
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "phone": "string"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "crmStatus": "LEAD",
  "deliveryAddresses": [
    {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    }
  ],
  "email": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "industry": "string",
  "kvk": "string",
  "leadSource": "string",
  "name": "string",
  "nextAction": "string",
  "nextActionDueDate": "2019-08-24T14:15:22Z",
  "opportunities": [
    {
      "changeOrders": [
        {
          "amount": 0.1,
          "category": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string"
        }
      ],
      "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",
      "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"
        }
      ],
      "probability": 0,
      "productIds": [
        "string"
      ],
      "scheduledEndDate": "2019-08-24",
      "scheduledStartDate": "2019-08-24",
      "source": "string",
      "status": "NEW",
      "tags": [
        "string"
      ],
      "teamId": "string",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "value": 0.1
    }
  ],
  "owner": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "ownerId": "string",
  "phone": "string",
  "recentActivities": [
    {
      "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",
      "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"
    }
  ],
  "region": "string",
  "subsidiaryId": "string",
  "tags": [
    "string"
  ],
  "tenantId": "string",
  "type": "PERSON",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "userId": "string",
  "website": "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"
}

C R M Activity

Previous Page

C R M Dashboard

Next Page