Update Customer

Testing Env

https://benzine.telcoinabox.com/tiab/api

PATCH

/v1/group/{groupno}/customer/{custno}

This API can be used to update the details of an existing Customer Account.

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Path Params

Body Params application/json

Example

{
    "customerStatus": "ACT",
    "notes": "string",
    "customerIdentity": {
        "customerType": "B",
        "company": "string",
        "legalEntity": "string",
        "abn": "string",
        "acn": "string",
        "customerSalutation": "MR",
        "customerGivenNames": "string",
        "customerSurname": "string",
        "customerDob": "string"
    },
    "creditProfile": {
        "customerCreditStatus": "string"
    },
    "address": {
        "addressLine1": "string",
        "addressLine2": "string",
        "suburb": "string",
        "state": "string",
        "postcode": "string",
        "countryCode": "AU"
    },
    "contactMedium": [
        {
            "contactType": "PHONE",
            "contactDestination": "string"
        }
    ],
    "customerAgreement": {
        "planNo": 0,
        "contractTerm": 0
    },
    "settings": {
        "language": "EN",
        "currency": "AUD",
        "portalAccess": true,
        "altCustId": "string",
        "expectedCallSpend": 0,
        "accountManager": "st"
    },
    "relatedParty": [
        {
            "type": "Agent",
            "id": 0
        }
    ],
    "authorisedPerson": {
        "authName": "string",
        "authPhone": "string",
        "authMobile": "string",
        "authEmail": "string",
        "authEmailAlt": "string",
        "highRisk": true
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://benzine.telcoinabox.com/tiab/api/v1/group/123/customer/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "customerStatus": "ACT",
    "notes": "string",
    "customerIdentity": {
        "customerType": "B",
        "company": "string",
        "legalEntity": "string",
        "abn": "string",
        "acn": "string",
        "customerSalutation": "MR",
        "customerGivenNames": "string",
        "customerSurname": "string",
        "customerDob": "string"
    },
    "creditProfile": {
        "customerCreditStatus": "string"
    },
    "address": {
        "addressLine1": "string",
        "addressLine2": "string",
        "suburb": "string",
        "state": "string",
        "postcode": "string",
        "countryCode": "AU"
    },
    "contactMedium": [
        {
            "contactType": "PHONE",
            "contactDestination": "string"
        }
    ],
    "customerAgreement": {
        "planNo": 0,
        "contractTerm": 0
    },
    "settings": {
        "language": "EN",
        "currency": "AUD",
        "portalAccess": true,
        "altCustId": "string",
        "expectedCallSpend": 0,
        "accountManager": "st"
    },
    "relatedParty": [
        {
            "type": "Agent",
            "id": 0
        }
    ],
    "authorisedPerson": {
        "authName": "string",
        "authPhone": "string",
        "authMobile": "string",
        "authEmail": "string",
        "authEmailAlt": "string",
        "highRisk": true
    }
}'

Responses

🟢200OK

application/json

Body

Example

{
    "custNo": 0,
    "customerStatus": "ACT",
    "customerStatusDesc": "Active",
    "href": "/group/{groupno}/customer/{custno}",
    "notes": "string",
    "dateAdded": "string",
    "userAdded": "string",
    "dateModified": "2019-08-24T14:15:22Z",
    "userModified": "string",
    "group": {
        "id": 0,
        "name": "string",
        "href": "string"
    },
    "customerIdentity": {
        "customerType": "B",
        "company": "string",
        "legalEntity": "string",
        "abn": "string",
        "acn": "string",
        "customerSalutation": "MR",
        "customerGivenNames": "string",
        "customerSurname": "string",
        "customerDob": "2019-08-24T14:15:22Z"
    },
    "creditProfile": {
        "customerCreditStatus": "NRM",
        "customerCreditStatusDesc": "string"
    },
    "address": {
        "addressLine1": "string",
        "addressLine2": "string",
        "suburb": "string",
        "state": "string",
        "postcode": "string",
        "countryCode": "AU"
    },
    "contactMedium": [
        {
            "contactType": "PHONE",
            "contactDestination": "string"
        }
    ],
    "customerAgreement": {
        "planNo": 0,
        "planName": "string",
        "contractTerm": 1,
        "dateContractStart": "2019-08-24T14:15:22Z",
        "dateContractEnd": "2019-08-24T14:15:22Z"
    },
    "settings": {
        "language": "EN",
        "currency": "AUD",
        "portalAccess": true,
        "altCustId": "string",
        "expectedCallSpend": 0,
        "accountManager": "st"
    },
    "billingAccount": {
        "cycleNo": 1,
        "currBalance": 0,
        "amtLastStmt": 0,
        "dateLastStmt": "2019-08-24T14:15:22Z",
        "dateSuspendBilling": "2019-08-24T14:15:22Z",
        "noLatePaymentFee": true
    },
    "relatedParty": [
        {
            "type": "Agent",
            "id": 0,
            "name": "string",
            "href": "string"
        }
    ],
    "authorisedPerson": {
        "authName": "Jack Inabox",
        "authPhone": "0300000000",
        "authMobile": "0400000000",
        "authEmail": "user@example.com",
        "authEmailAlt": "user@example.com",
        "dateAdded": "2019-08-24T14:15:22Z",
        "userAdded": "tiab.user",
        "dateModified": "2019-08-24T14:15:22Z",
        "userModified": "string",
        "highRisk": true,
        "highRiskUpdatedBy": "tiab.user",
        "highRiskUpdatedDate": "2019-08-24T14:15:22Z"
    },
    "directDebit": {
        "directDebitType": "STANDARD_DIRECT_DEBIT",
        "ddNotificationFlag": "Y",
        "ddNotificationEmail": "string",
        "ddPaymentDay": "string",
        "ddSpecialPaymentPeriod": "wk",
        "ddSpecialPaymentMethod": "ST",
        "ddSpecialPaymentAmount": 0,
        "ddSpecialDayOfWeek": 1,
        "ddSpecialEndType": "EA",
        "ddSpecialStartDate": "2019-08-24T14:15:22Z",
        "ddSpecialEndDate": "2019-08-24T14:15:22Z",
        "ddSpecialRequiredCount": 0,
        "ddSpecialCurrentCount": 0
    }
}

🟠403Invalid access

Modified at 2024-07-29 07:03:08

List Customers

Set Customer Direct Debit