List Customers - Octane REST API

This API will be used to retrieve a list of customers currently owned by a Service Provider Group. The list of customers is retrieved based on the Group calling the API.

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

Query Params

customerType

string

optional

Filter by Customer Type. See customer.customerIdentity.customerType on schema for allowed values

customerStatus

string

optional

Filter by Customer Status. See customer.customerStatus on schema for allowed values

customerCreditStatus

string

optional

Filter by Customer's Credit Status. See customer.creditProfile.customerCreditStatus on schema for allowed values

agentNo

integer

optional

Filter by Agent No

accountManager

string

optional

Filter by Account Manager

fromDate

string

optional

Filter by Date Added Range. This is the Start Date for the range.

toDate

string

optional

Filter by Date Added Range. This is the End Date for the range.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

array of:

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}

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.

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:

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)

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

settings

object

required

List of settings configured for this customer

language

enum<string>

required

The language to use for any Customer Communication.

Allowed value:

currency

enum<string>

required

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.

accountManager

string

required

The Account Manager that is responsible for this Customer Account

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:

currBalance

number <double>

read-onlyoptional

Indicates the customer’s current balance

amtLastStmt

number <double>

read-onlyoptional

Indicates the total amount that was charged on the customer’s last bill

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>

optional

The actual type of the target instance when needed for disambiguation.

Allowed values:

AgentLinkedCustomer

integer <uint>

optional

Unique identifier of a related entity.

name

string

optional

Name of the related entity.

href

string

optional

Reference of the related entity.

Example

[
    {
        "custNo": 0,
        "customerStatus": "ACT",
        "customerStatusDesc": "Active",
        "href": "/group/{groupno}/customer/{custno}",
        "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"
        },
        "settings": {
            "language": "EN",
            "currency": "AUD",
            "portalAccess": true,
            "altCustId": "string",
            "expectedCallSpend": 0,
            "accountManager": "string"
        },
        "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"
            }
        ]
    }
]

🟠403Invalid access