developer notes

Create Customer

The CustomerCreate API allows you to create a new customer record. The request body includes information such as the customer name, email address, phone number, as well as other relevant information.

Method	Endpoint
POST	`{{endpoint}}/api/ext/customers`

‍

Header

‍

Key	Value
Content-Type	`application/json`
Authorization	`Bearer {{token}}`

‍

Example Response

‍

{
    "name": "ABC Company",
    "email": "abccompany@gmail.com",
    "phone": "60378859720",
    "phone2": "60378859720",
    "contactPersonName": "John Smith",
    "area": null,
    "fax": "",
    "website": "",
    "industry": {
        "industryName": "Construction"
    },
    "noOfEmployees": "",
    "billingStreet": "Orange Ave",
    "billingCity": "Daytona Beach",
    "billingState": "Florida",
    "billingPostcode": "5133",
    "billingCountry": "USA",
    "billingPlaceId": null,
    "billingLatitude": 3.183005199999999,
    "billingLongitude": 101.74618,
    "shippingStreet": "Orange Ave",
    "shippingCity": "Daytona Beach",
    "shippingState": "Florida",
    "shippingPostcode": "54200",
    "shippingCountry": "USA",
    "shippingPlaceId": null,
    "description": "This is the ABC Company",
    "customerType": "Business",
    "paymentTerm": " ",
    "customerExternalId": ""
}

‍

Example Request

‍

{
    "createdBy": "demo@aut.fieldex.com",
    "createdDate": "2023-11-14T08:28:03Z",
    "lastModifiedBy": "demo@aut.fieldex.com",
    "lastModifiedDate": "2023-11-14T08:28:03Z",
    "id": 13,
    "name": "customer15",
    "phone": "0987654321",
    "email": "customer@custella.com",
    "company": null,
    "officeAddress": null,
    "role": null,
    "imageUrl": null,
    "billingCity": null,
    "billingCountry": null,
    "billingPostcode": null,
    "billingState": null,
    "billingStreet": null,
    "shippingCity": null,
    "shippingCountry": null,
    "shippingPostcode": null,
    "shippingState": null,
    "shippingStreet": null,
    "customerExternalId": "customer1EXT",
    "customerSecondExternalId": "customer1Ext2",
    "customerSfExternalId": null,
    "customerNumber": "C-000013",
    "customerSource": null,
    "description": "business customer",
    "paymentTerm": "Immediate payment",
    "phone2": "1234567890",
    "contactPersonName": "customer15",
    "area": "400",
    "noOfEmployees": "20 - 50 Employees",
    "fax": "1234567890",
    "customerType": "Customer",
    "website": "customer.com",
    "isDeleted": "N",
    "shippingPlaceId": null,
    "billingPlaceId": null,
    "createdByFullName": "Admin User",
    "modifiedByFullName": "Admin User",
    "imageUrlOfCreator": "",
    "imageUrlOfModifier": "",
    "billingLatitude": null,
    "billingLongitude": null,
    "state": null,
    "systemUsed": null,
    "patientRentalTvs": null,
    "fixedRentalTvs": null,
    "customerReferenceNo": "000015",
    "terminalCount": null,
    "shippingLatitude": null,
    "shippingLongitude": null,
    "industry": {
        "id": 1,
        "industryName": "Advertising"
    },
    "customersType": {
        "id": 2,
        "name": "Personal",
        "label": null,
        "order": null,
        "isDefault": null,
        "active": null,
        "systemValue": null,
        "code": null
    },
    "geoFence": null,
    "customerSector": {
        "createdBy": null,
        "createdDate": "2023-11-14T08:28:03Z",
        "lastModifiedBy": null,
        "lastModifiedDate": "2023-11-14T08:28:03Z",
        "id": 1,
        "name": null,
        "label": null,
        "code": null,
        "order": null,
        "isDefault": null,
        "active": null,
        "systemValue": null
    },
    "customerSubSector": {
        "createdBy": null,
        "createdDate": "2023-11-14T08:28:03Z",
        "lastModifiedBy": null,
        "lastModifiedDate": "2023-11-14T08:28:03Z",
        "id": 1,
        "name": null,
        "label": null,
        "code": null,
        "order": null,
        "isDefault": null,
        "active": null,
        "systemValue": null,
        "customerSector": null
    },
    "serviceZone": null,
    "categoryType": {
        "id": 1,
        "name": null,
        "code": null,
        "active": null,
        "order": null,
        "isDefault": null,
        "systemValue": null,
        "label": null
    },
    "customerChannel": null,
    "attachments": [],
    "createdByUserId": 1,
    "createdByUser": null,
    "modifiedByUserId": 1
}