FieldEx Developer
developer notes

Patch Customer

The PartialUpdate API allows you to update a subset of the fields in the customer record. This is useful in cases where you need to update a customer without having to update all of the fields.

Method Endpoint
PATCH {{endpoint}}/api/ext/customers

Headers

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

Example Request

{
    "name": "customer15",
    "email": "customer@custella.com",
    "phone": "0987654321",
    "phone2": "1234567890",
    "contactPersonName": "customer15",
    "area": "400",
    "customerReferenceNo": "000015",
    "fax": "1234567890",
    "website": "customer.com",
    "industry": {
        "industryName": "Advertising"
    },
    "noOfEmployees": "20 - 50 Employees",
    "billingStreet": null,
    "billingCity": null,
    "billingState": null,
    "billingPostcode": null,
    "billingCountry": null,
    "shippingStreet": null,
    "shippingCity": null,
    "shippingState": null,
    "shippingPostcode": null,
    "shippingCountry": null,
    "description": "business customer",
    "customerType": "Customer",
    "paymentTerm": "Immediate payment",
    "serviceZone": null,
    "categoryType": {
        "code": "Category A"
    },
    "customerExternalId": "ARFA1",
    "customerSecondExternalId": "customer1Ext2",
    "customerSfExternalId": null,
    "customerSector": {
        "code": "sector 1"
    },
    "customerSubSector": {
        "code": "sub sector 1"
    },
    "geoFence": {
        "geoFenceName": "brickfields"
    },
    "generateLoadingBay": false,
    "customersType": {
        "name": "Personal"
    }
}

Example Response

//Example response - Status 200
{
    "name": "CusNameValue",
    "email": "CusEmail@custella.com",
    "phone": "0123456789",
    "phone2": "0123456789",
    "contactPersonName": "CusContactName",
    "area": "CusAreaValue",
    "customerReferenceNo": "CusReferenceNo",
    "fax": "0123456789",
    "website": "www.cuswebsite.com",
    "industry": {
        "industryName": "Advertising"
    },
    "noOfEmployees": "0 - 20 Employees",
    "billingStreet": "cusBillingStreetValue",
    "billingCity": "cusBillingCityValue",
    "billingState": "cusBillingStateValue",
    "billingPostcode": "cusBillingPostcodeValue",
    "billingCountry": "Afghanistan",
    "billingPlaceId": null,
    "billingLatitude": 3.1056527540724863,
    "billingLongitude": 101.59605593068765,
    "shippingStreet": null,
    "shippingCity": null,
    "shippingState": null,
    "shippingPostcode": null,
    "shippingCountry": null,
    "shippingPlaceId": null,
    "shippingLatitude": null,
    "shippingLongitude": null,
    "description": "CusDescriptionValue",
    "customerType": "Customer",
    "paymentTerm": "CusPaymentTermValue",
    "state": null,
    "systemUsed": null,
    "patientRentalTvs": null,
    "fixedRentalTvs": null,
    "serviceZone": {
        "id": 6,
        "name": "AssetServiceZone"
    },
    "categoryType": {
        "id": 14,
        "name": "tljkgiaelu"
    },
    "terminalCount": null,
    "customerExternalId": "CusExternalIdValue",
    "customerSecondExternalId": "CusExternalId2Value",
    "customerSector": {
        "id": 1,
        "name": "sector updasted"
    },
    "customerSubSector": {
        "id": 1,
        "name": "sub sector A"
    },
    "geoFence": null,
    "generateLoadingBay": false,
    "customersType": {
        "name": "Business"
    },
    "id": "57679"
}