Account Information

Overview

Account information including service listing and account balances can be obtained via a GET request to the REST web services API.   

 

Sample Query

https://portal.neural.net.au:15000/get/account-info&user=USERNAME&pass=PASSWORD

Optionally, fields may also be sent in an HTTP POST request instead of GET 

 

Field List

Field Name

Required

Sample Value

Description

user

Yes

Jsmith

Your Portal username

pass

Yes

Secret123

Your Portal password

       

 

Fields are case sensitive; sample value is representative of default value.

Data will be returned in the requested format as specified in the the format field.  In the absence of the format field the response will be sent as JSON.

 

Formatting of timestamps

Timestamps may be provided in any format supported by PHP time interpretation, including relative times.  For example, you may specify a value of "-30 days" in the fromtimestamp field.  Please see the PHP documentation for information about compound date formats as well as relative date formats.  Compound and relative times will be interpreted as GMT+10 (AEST) unless a non-timezone-specific format (such as UNIX timestamp) is used, or the timezone is specified in the value.

 

 

Result Values

Field Name

Encoding

Sample Value

Description

Profile

Array

See Table A

User account profile information

Balances

Array

See Table B (Pre-paid account)

User account monetary balance information

Balances

Array See Table C (Post-paid account) User account monetary balance information

 

 

Table A

Field Name

Encoding

Sample Value

Description

userid

String

1234

Account number

username

String

john

Login username

company

String Sample company Pty Ltd Full company name

firstname

String John Primary contact first name

surname

String Smith Primary contact surname

email

String john@example.com Primary e-mail address

phone

String 07 3171 4300 Phone number

mobile

String 04 88 888 888 Mobile Number

fax

String 07 3171 4320 Fax Number

timezone

String Australia/Sydney Timezone (see list)

address

Array address, city, state, postcode, country Array of address values

 

 

 

Table B

Field Name

Encoding

Sample Value

Description

prepaid_balance

Float, 4 dec

1234.1234

Current remaining pre-paid balance

uninvoiced_charges

Float, 4 dec

1234.1234

Charges incurred in this pre-paid account since the last invoice was issued

credit_limit

Float, 2 dec 1234.12 Amount this account can go into negative balance before it is automatically suspended

format

String AUD, float, 4 decimal places Reminder comment

 

 

Table C

Field Name

Encoding

Sample Value

Description

remaining_credit

Float, 4 dec

1234.1234

Current remaining post-paid balance

uninvoiced_charges

Float, 4 dec

1234.1234

Charges incurred in this post-paid account since the last invoice was issued

credit_limit

Float, 2 dec 1234.12 Maximum credit allowance on post-paid account

format

String AUD, float, 4 decimal places Reminder comment

 

 

 

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk