Octane REST API
  1. Customer
Octane REST API
  • Getting Started
    • API Access & Authentication
    • API Rate Limiting
  • Integration Guides
    • Payment Integration
    • CDR Integration
    • Test Environment Data Sets
    • Mobile Flows
      • Activate Postpaid Mobile (New MSN - Physical SIM)
      • Activate Postpaid (Port MSN - Physical SIM)
      • Activate Postpaid Mobile (New MSN - eSIM)
      • Activate Postpaid (Port MSN - eSIM)
      • Reset eSIM Profile
      • Mobile Data Pool Flow
    • ConnectYou Flows
      • ConnectYou Business SIP Trunk Activate Flow
      • ConnectYou Business SIP Trunk Reactivate Direct Indials Flow
      • ConnectYou Unite Calling Activate Flow
    • NBN Flows
      • NBN Activate Flow
      • NBN Plan Change Flow
      • NBN Termination Flow
      • NBN Reschedule Appointment Flow
      • NBN Withdraw Order Flow
      • Run NBN Diagnostic Test Flow
      • Run NBN Service Health Check Flow
  • API Documentation
    • Customer
      • Add Customer
        POST
      • Get Customer Detail
        GET
      • List Customers
        GET
      • Update Customer
        PATCH
      • Set Customer Direct Debit
        POST
      • Send Welcome Email
        POST
    • Payment Method
      • List Payment Methods
      • Add Payment Method
      • Update Payment Method
      • Delete Payment Method
    • Transaction
      • List Transactions
      • Make Payment
      • Add Misc Adjustment
      • List Bounced Transactions
    • Plan
    • Service
      • List Services for a Customer
      • Get Service Detail by LineSeqNo
    • Mobile
      • Notification
        • Get Notification Settings
        • Update Notification Settings
      • Get Data Pool
      • Update Data Limit
      • Transfer Services to Another Pool
      • Disconnect a Data Pool
      • Get eSIM Details
      • Manage eSIM
    • Address
      • Search for an Address
      • Search for an Address V2
    • Service Qualification
      • Perform Service Qualification Check
    • Order
      • v1
        • Create Order (NBN Activation)
        • Create Order (NBN Modification)
        • Create Order (NBN Disconnection)
        • Cancel (NBN Activation) Order
        • Get Order Detail (NBN)
        • List Orders (NBN)
    • Enquiry
      • Create Enquiry (NBN Diagnostic Test / Service Health Check)
      • Get Enquiry Detail
      • List Enquiries
    • Appointment
      • Query Appointment Timeslots
      • Book Appointment
    • NBN
      • Get Available Diagnostic Tests
    • Attachment
  • API Documentation (Legacy APIs)
    • WSDL Summary
    • API Guide
      • Account Charges
        • Add a Recurring Charge
        • Get Recurring Charge Details
        • Add a Manual Charge
      • ConnectYou
        • Create a Number Reservation
        • Get Available Numbers
        • queryResiEndPointService
        • Query a Business SIP Trunk Service
        • Get Zone Detail
        • Get Number Detail
      • Contact Log
        • Get Contact Log Types
        • Add a Contact Log
        • Update a Contact Log
        • Query Contact Logs
      • Device
        • getSupplierStockDetail
        • getSupplierProduct
        • getSupplierFreightOption
        • orderDevice
      • Mobile
        • Get Mobile Provisioning Product Catalogue
        • Query a Mobile Service
        • Query Mobile Add Ons
        • Query Mobile Feature Settings
        • Query Mobile Balance
      • Notifications
        • createNotification
        • notificationManageTemplate
      • Pooled Resource
        • Reserve a Resource
        • Unreserve a Resource
        • Select a Resource
        • Query Resource
      • Order
        • Mobile Order
          • Create a Mobile Service (New Number)
          • Create a Mobile Service (Port In Number)
          • Create a Pre-Activation Mobile Order (New Number)
          • Bar/Unbar/Disconnect a Mobile Service
          • Change Mobile Rate Plan
          • Change a Mobile Number
          • Replace a SIM Card
          • Modify Mobile Feature(s)
          • Modify Mobile Feature Setting(s)
          • Change Excess Spend Limit
          • Add a Once-off Bolt On
          • Add a Recurring Bolt On Pack
          • Remove a Recurring Bolt On Pack
        • Mobile (Data Pool) Order
          • Create a Data Pool
          • Add Consumers to Data Pool
          • Remove Consumers from Data Pool
        • ConnectYou (SIP Trunk) Order
          • Create a New Business SIP Trunk
          • Bar/Unbar International Calls on a Business SIP Trunk
          • Suspend Business SIP Trunk
          • Unsuspend Business SIP Trunk
          • Deactivate Business SIP Trunk
          • Port Numbers to a Business SIP Trunk
          • Configure Business SIP Trunk
        • Other Rated Order
          • Create an Other Rated Service
          • Change Access of an Other Rated Service
        • Create an Order
        • Cancel an Order
        • Query an Order
        • Reset an Order
      • Statements & Billing
        • Get a List of Customer Bills
        • Get Charge Item Detail for a Bill
        • Get a Single Bill PDF for a Customer
        • Get a Summary of a Bill
      • Unbilled Calls
        • Query Summary of Unbilled Calls & Charges
        • Query Detail of Unbilled Calls & Charges
      • OTP
        • Manage OTP (Get & Verify OTP)
    • Reference Data
  1. Customer

Update Customer

Testing Env
https://benzine.telcoinabox.com/tiab/api
Testing Env
https://benzine.telcoinabox.com/tiab/api
PATCH
https://benzine.telcoinabox.com/tiab/api
/v1/group/{groupno}/customer/{custno}
customer
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
groupno
string 
required
Group Number. Users will have access only to specific Groups and must pass this ID when accessing any Resources via API.
Example:
123
custno
integer 
required
Unique identifer of the End Customer Account to retrieve details for.
Example:
123456
Body Params application/json
customerStatus
enum<string> 
optional
The Status Code for the Customer Account.
Allowed values:
ACTSUSTERDIS
notes
string 
optional
Additional notes added about this customer account.
customerIdentity
object 
optional
The identity of the Customer that owns this Account.
customerType
enum<string> 
optional
The type of Customer Account.
Allowed values:
BR
company
string 
optional
The Company Name (or Trading Name) of the Account.
>= 1 characters
legalEntity
string 
optional
The Legal Entity that the Company is under, as per ABR (Australia Business Registry).
abn
string 
optional
The ABN for the Company, as per ABR (Australian Business Registry)
<= 14 characters
acn
string 
optional
The ACN for the Company, as per ABR (Australian Business Registry)
<= 11 characters
customerSalutation
enum<string> 
optional
The Salutation of the main Account holder.
Allowed values:
MRMRSMISSMSDRMSTR
customerGivenNames
string 
optional
The Given Names of the main Account holder.
>= 1 characters
customerSurname
string 
optional
The Surname of the main Account holder.
>= 1 characters
customerDob
string 
optional
The Date Of Birth of the main Account holder.
creditProfile
object 
optional
The Credit Profile for the Customer
customerCreditStatus
string 
optional
The Customer's current credit status
address
object 
optional
The address on record for this customer
addressLine1
string 
optional
The first address line for this address
>= 1 characters
addressLine2
string 
optional
The second address line for this address
suburb
string 
optional
The Suburb this address is located in
>= 1 characters
state
string 
optional
The State this address is located in
>= 1 characters
postcode
string 
optional
The Postcode this address is located in
>= 1 characters
countryCode
enum<string> 
optional
The Country this address is located in
Allowed value:
AU
contactMedium
array [object {2}] 
optional
The different ways that this Customer can be contacted
contactType
enum<string> 
optional
The type of Contact
Allowed values:
PHONEMOBILEFAXEMAIL
contactDestination
string 
optional
The Destination Number or Email for the Contact
customerAgreement
object 
optional
Defines the Agreement in place with the Customer.
planNo
integer 
optional
The Plan No for the Customer Agreemenet. Customer accounts can be placed on a Retail Plan that will act as a catch-all plan for any rates that may not be configured at Service-level.
contractTerm
integer 
optional
Customer can be put on a Contract Term. Passing a value here on Update Customer will commence a new Contract Term from today's date. Octane does not enforce contract terms, and this is just informational for the SP.
settings
object 
optional
List of settings configured for this customer
language
enum<string> 
optional
The language to use for any Customer Communication.
Allowed value:
EN
currency
enum<string> 
optional
The currency that the customer’s bills will be produced and presented in.
Allowed value:
AUD
portalAccess
boolean 
optional
Indicator whether this Customer has access to the Customer Portal.
altCustId
string 
optional
An alternate Customer reference. Can be a customer reference from an external system.
expectedCallSpend
number 
optional
Customer can have an expected call spend configured manually to act as a guide for revenue prediction.
accountManager
string 
optional
The Account Manager that is responsible for this Customer Account
>= 2 characters<= 2 characters
relatedParty
array [object {2}] 
optional
A Related Party to this Customer
type
enum<string> 
optional
The actual type of the target instance when needed for disambiguation.
Allowed values:
AgentLinkedCustomer
id
integer 
optional
Unique identifier of a related entity.
authorisedPerson
object 
optional
3rd party authorised person on this account
authName
string 
optional
Authorised Person Name
authPhone
string 
optional
Authorised Person phone number
authMobile
string 
optional
Authorised Person mobile number
>= 1 characters<= 10 characters
authEmail
string 
optional
Authorised Person email
authEmailAlt
string 
optional
Authorised Person alternate email
highRisk
boolean 
optional
Indicates whether the authorised person has been tagged as high risk
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
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
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
custNo
integer 
read-onlyoptional
Unique identifer for the Customer Account.
customerStatus
enum<string> 
required
The Status Code for the Customer Account.
Allowed values:
ACTSUSTERDIS
customerStatusDesc
enum<string> 
read-onlyoptional
The Long Status Description of the Customer Account.
Allowed values:
ActiveSuspendedTerminatedDisconnected
href
string 
read-onlyoptional
The URL location to reference the customer.
Example:
/group/{groupno}/customer/{custno}
notes
string 
optional
Additional notes added about this customer account.
dateAdded
string 
read-onlyoptional
Timestamp of when this customer account was added.
userAdded
string 
read-onlyoptional
User that added this customer account.
dateModified
string <date-time>
read-onlyoptional
Timestamp of when this customer account was last modified.
userModified
string 
read-onlyoptional
User that last modified this customer account.
group
object 
read-onlyoptional
The Service Provider Group that this Customer belongs to.
id
integer 
required
The Unique Identifer for the Service Provider Group.
name
string 
required
The Name of the Service Provider Group
href
string 
required
The Resource Endpoint for the Service Provider Group
customerIdentity
object 
required
The identity of the Customer that owns this Account.
customerType
enum<string> 
optional
The type of Customer Account.
Allowed values:
BR
company
string 
optional
The Company Name (or Trading Name) of the Account.
legalEntity
string 
optional
The Legal Entity that the Company is under, as per ABR (Australia Business Registry).
abn
string 
optional
The ABN for the Company, as per ABR (Australian Business Registry)
>= 0 characters
acn
string 
optional
The ACN for the Company, as per ABR (Australian Business Registry)
customerSalutation
enum<string> 
optional
The Salutation of the main Account holder.
Allowed values:
MRMSMRSMISSMSTRDR
customerGivenNames
string 
optional
The Given Names of the main Account holder.
customerSurname
string 
optional
The Surname of the main Account holder.
customerDob
string <date-time>
optional
The Date Of Birth of the main Account holder.
creditProfile
object 
optional
The Credit Profile for the Customer
customerCreditStatus
enum<string> 
required
The Customer's current credit status
Allowed values:
NRMAREDDADSPDNCINCLGLOSCPMPWBDHRFH
customerCreditStatusDesc
string 
read-onlyrequired
The description of the current credit status
address
object 
required
The address on record for this Customer
addressLine1
string 
required
The first address line for this address
addressLine2
string 
optional
The second address line for this address
suburb
string  | null 
required
The Suburb this address is located in
state
string 
required
The State this address is located in
postcode
string 
required
The Postcode this address is located in
countryCode
enum<string> 
optional
The Country this address is located in
Allowed value:
AU
contactMedium
array [object {2}] 
required
The different ways that this Customer can be contacted
contactType
enum<string> 
required
The type of Contact
Allowed values:
PHONEMOBILEFAXEMAILALT_EMAILORDER_EMAIL
contactDestination
string  | null 
required
The Destination Number or Email for the Contact
customerAgreement
object 
optional
Defines the Agreement in place with the Customer.
planNo
integer <uint>
optional
The Plan No for the Customer Agreemenet. Customer accounts can be placed on a Retail Plan that will act as a catch-all plan for any rates that may not be configured at Service-level.
planName
string 
read-onlyoptional
The Plan Name for the Customer Agreemenet. Customer accounts can be placed on a Retail Plan that will act as a catch-all plan for any rates that may not be configured at Service-level.
contractTerm
enum<integer> <uint>
optional
Customer can be put on a Contract Term. Octane does not enforce contract terms, and this is just informational for the SP.
Allowed values:
1361224
dateContractStart
string <date-time>
optional
If customer is on a contract term, the Contract Start and End Dates will be returned as well.
dateContractEnd
string <date-time>
optional
If customer is on a contract term, the Contract Start and End Dates will be returned as well.
settings
object 
required
List of settings configured for this customer
language
enum<string> 
required
The language to use for any Customer Communication.
Allowed value:
EN
currency
enum<string> 
optional
The currency that the customer’s bills will be produced and presented in.
Allowed value:
AUD
portalAccess
boolean 
optional
Indicator whether this Customer has access to the Customer Portal.
altCustId
string 
optional
An alternate Customer reference. Can be a customer reference from an external system.
expectedCallSpend
number <double>
optional
Customer can have an expected call spend configured manually to act as a guide for revenue prediction. Rounded down to 2 decimal places
accountManager
string 
optional
The Account Manager that is responsible for this Customer Account
>= 2 characters<= 2 characters
billingAccount
object 
optional
Details about the Customer's billing account and status
cycleNo
enum<integer> <uint>
optional
The Bill Cycle for this Customer. Note: currently this will always be defaulted to 1. All customers are billed on the 28th of the month.
Allowed value:
1
currBalance
number <double>
read-onlyoptional
Indicates the customer’s current balance. Rounded down to 2 decimal places
amtLastStmt
number <double>
read-onlyoptional
Indicates the total amount that was charged on the customer’s last bill. Rounded down to 2 decimal places
dateLastStmt
string <date-time>
read-onlyoptional
Indicates the last time this customer has been charged
dateSuspendBilling
string <date-time>
optional
Indicates until when this customer has had their Billing suspended until.
noLatePaymentFee
boolean 
required
Indicates whether or not a late payment fee should be charged to this Customer on overdue bills.
relatedParty
array [object {4}] 
optional
A Related Party to this Customer
type
enum<string> 
required
The actual type of the target instance when needed for disambiguation.
Allowed values:
AgentLinkedCustomer
id
integer <uint>
required
Unique identifier of a related entity.
name
string 
optional
Name of the related entity.
href
string 
optional
Reference of the related entity.
authorisedPerson
object 
optional
3rd party authorised person on this account
authName
string 
required
Authorised Person Name
Example:
Jack Inabox
authPhone
string 
optional
Authorised Person phone number
Example:
0300000000
authMobile
string 
optional
Authorised Person mobile number
Example:
0400000000
authEmail
string <email>
optional
Authorised Person email
authEmailAlt
string <email>
optional
Authorised Person alternate email
dateAdded
string <date-time>
read-onlyoptional
Datetime the authorised person was added to the account
userAdded
string 
read-onlyoptional
User who added the authorised person to the account
Example:
tiab.user
dateModified
string <date-time>
read-onlyoptional
Datetime the authorised person's details were last modified
userModified
string 
read-onlyoptional
User who last modified the authorised person's details
highRisk
boolean 
optional
Indicates whether the authorised person has been tagged as high risk
highRiskUpdatedBy
string 
read-onlyoptional
User who last updated the high risk status of this authorised person
Example:
tiab.user
highRiskUpdatedDate
string <date-time>
read-onlyoptional
Datetime when the high risk status was last updated
directDebit
object (Direct Debit) 
optional
Defines the Direct Debit Setup for the Customer
directDebitType
enum<string> 
required
Indicates what direct debit type is used for this customer
Allowed values:
STANDARD_DIRECT_DEBITSPECIAL_DIRECT_DEBITOFF
ddNotificationFlag
enum<string> 
required
Indicates whether to use the Customer's contact email (Y) or the DD Notification Email (N) instead.
Allowed values:
YN
ddNotificationEmail
string 
optional
The alternate email to send direct debit notifications to.
ddPaymentDay
string 
optional
The day of the month to take payments on. If left blank, this will be defaulted to Day 15.
ddSpecialPaymentPeriod
enum<string> 
optional
Can be set to configure a payment plan for a Customer where you want to take regular payments on a pre-defined schedule.
Allowed values:
wkfnmn
ddSpecialPaymentMethod
enum<string> 
optional
Type of payment to make. This can either be configured to take payment from the total balance or the overdue balance only
Allowed values:
STSO
ddSpecialPaymentAmount
number <double>
optional
Amount to take on every direct debit run. Can be configured to setup a payment plan for a Customer. Rounded down to 2 decimal places
ddSpecialDayOfWeek
enum<integer> 
optional
Can be configured to specify the day of the week to take the direct debit on (as opposed to a specific day of the month).
Allowed values:
1234567
ddSpecialEndType
enum<string> 
read-onlyoptional
Read-only. Indicates the type of end date configured for this payment plan setup.
Allowed values:
EAEDEN
ddSpecialStartDate
string <date-time>
optional
Used to set the start date for the payment plan. Format: yyyy-mm-dd
ddSpecialEndDate
string <date-time>
optional
Used to set the end date for the payment plan. Format: yyyy-mm-dd
If neither of ddSpecialEndDate nor ddSpecialRequiredCount is provided, the direct debit payments will continue indefinitely.
ddSpecialRequiredCount
integer 
optional
Indicates the number of recurrences to execute direct debit for, based on the defined schedule. This can be provided instead of specifying an End Date.
If neither of ddSpecialEndDate nor ddSpecialRequiredCount is provided, the direct debit payments will continue indefinitely.
ddSpecialCurrentCount
integer 
read-onlyoptional
Read-only. Will return an indicator of how many payment recurrences have been completed so far based on the required count configured.
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
Previous
List Customers
Next
Set Customer Direct Debit
Built with