Account

Account Read

Returns information about an Account.

Authentication & Authorization

AuthenticationAuthorization
Authenticated Session Account Admin

Request Parameters

Required ParametersDescription
Action “AccountRead”
SessionId Authenticated Session identifier.
AccountId A positive integer which references a unique Account.

Result Element Schema

AccountRead.rnc:

AccountRead.rng, Account.rng, Contact.rng, CreditCard.rng

Sample Request

cURL
1
2
3
4
curl -X POST \
--data \
'Action=AccountRead&SessionId=nlibgopjksp2bel1ai22lp37l4&AccountId=22543' \
https://api.onsip.com/api
JavaScript
1
2
3
4
5
6
7
8
9
10
11
var data = new FormData();
data.append('Action', 'AccountRead');
data.append('SessionId', 'nlibgopjksp2bel1ai22lp37l4');
data.append('AccountId', '22543');

var xhr = new XMLHttpRequest();
xhr.open('POST', 'https://api.onsip.com/api', true);
xhr.onload = function () {
  console.log(this.responseText);
}
xhr.send(data);

Sample Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
<Response xmlns="http://www.jnctn.net/ns/rest/2006-01">
  <Context>
    <Action>
      <IsCompleted>true</IsCompleted>
    </Action>
    <Request>
      <IsValid>true</IsValid>
      <DateTime>2014-04-21T14:04:13+00:00</DateTime>
      <Duration>74</Duration>
      <Parameters>
        <Parameter>
          <Name>Action</Name>
          <Value>AccountRead</Value>
        </Parameter>
        <Parameter>
          <Name>SessionId</Name>
          <Value>nlibgopjksp2bel1ai22lp37l4</Value>
        </Parameter>
        <Parameter>
          <Name>AccountId</Name>
          <Value>22543</Value>
        </Parameter>
      </Parameters>
    </Request>
    <Session>
      <IsEstablished>true</IsEstablished>
      <SessionId>nlibgopjksp2bel1ai22lp37l4</SessionId>
      <UserId>152255</UserId>
      <Roles>
        <Role>
          <Name>Account Admin</Name>
        </Role>
      </Roles>
    </Session>
  </Context>
  <Result>
    <AccountRead>
      <Account>
        <AccountId>22543</AccountId>
        <Receivable>887.05</Receivable>
        <Promocode/>
        <Productcode>onSIP</Productcode>
        <PerUserPricing>false</PerUserPricing>
        <BalanceSeconds>0</BalanceSeconds>
        <EscrowSecondsUpdate>0</EscrowSecondsUpdate>
        <EscrowSecondsCredit>0</EscrowSecondsCredit>
        <RegistrationLimit>0</RegistrationLimit>
        <Balance>88.8550000</Balance>
        <CreditLimit>0.00</CreditLimit>
        <Recharge>false</Recharge>
        <RechargeLevel>0.00</RechargeLevel>
        <RechargeThreshold>0.00</RechargeThreshold>
        <Modified>2014-04-07T16:02:02+00:00</Modified>
        <Created>2013-06-03T13:47:29+00:00</Created>
        <Contact>
          <Name>John Example</Name>
          <Organization>example</Organization>
          <Address>123 Dude Street</Address>
          <City>Brooklyn</City>
          <State>NY</State>
          <Zipcode>11201</Zipcode>
          <Country>United States of America</Country>
          <CountryId>207</CountryId>
          <Phone>1-555-555-5555</Phone>
          <Email>john@example.onsip.com</Email>
          <Modified>2013-06-03T13:47:29+00:00</Modified>
        </Contact>
      </Account>
    </AccountRead>
  </Result>
</Response>

Account Edit Contact

Update the Contact record associated with the account.

Authentication & Authorization

AuthenticationAuthorization
Authenticated Session Account Admin

Request Parameters

Required ParametersDescription
Action “AccountEditContact”
SessionId Authenticated Session identifier.
AccountId A positive integer which references a unique Account.
Name The contact name.
Address The contact address.
City The contact city.
State The contact state - the two letter state code.
Zipcode The contact zipcode.
CountryId A positive integer which references a unique Country.
Phone The contact phone number.
Email The contact email address.
Optional ParametersDefaultDescription
Organization ’’ The contact company or organization name.

Result Element Schema

AccountEditContact.rnc:

AccountEditContact.rng, Account.rng, Contact.rng, CreditCard.rng

Sample Request

cURL
1
2
3
4
curl -X POST \
--data \
'Action=AccountEditContact&SessionId=nlibgopjksp2bel1ai22lp37l4&AccountId=22543&Name=john&Address=55BroadSt&City=NYC&State=NY&Zipcode=10004&CountryId=1&Phone=5555555555&Email=john@example.onsip.com' \
https://api.onsip.com/api
JavaScript
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
var data = new FormData();
data.append('Action', 'AccountEditContact');
data.append('SessionId', 'nlibgopjksp2bel1ai22lp37l4');
data.append('AccountId', '22543');
data.append('Name', 'Name');
data.append('Address', '55BroadSt');
data.append('City', 'NYC');
data.append('State', 'State');
data.append('Zipcode', '10004');
data.append('CountryId', '1');
data.append('Phone', '5555555555');
data.append('Email', 'john@example.onsip.com');

var xhr = new XMLHttpRequest();
xhr.open('POST', 'https://api.onsip.com/api', true);
xhr.onload = function () {
  console.log(this.responseText);
}
xhr.send(data);

Sample Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
<Response xmlns="http://www.jnctn.net/ns/rest/2006-01">
  <Context>
    <Action>
      <IsCompleted>true</IsCompleted>
    </Action>
    <Request>
      <IsValid>true</IsValid>
      <DateTime>2014-04-21T14:09:11+00:00</DateTime>
      <Duration>118</Duration>
      <Parameters>
        <Parameter>
          <Name>Action</Name>
          <Value>AccountEditContact</Value>
        </Parameter>
        <Parameter>
          <Name>SessionId</Name>
          <Value>nlibgopjksp2bel1ai22lp37l4</Value>
        </Parameter>
        <Parameter>
          <Name>AccountId</Name>
          <Value>22543</Value>
        </Parameter>
        <Parameter>
          <Name>Name</Name>
          <Value>john</Value>
        </Parameter>
        <Parameter>
          <Name>Address</Name>
          <Value>55BroadSt</Value>
        </Parameter>
        <Parameter>
          <Name>City</Name>
          <Value>NYC</Value>
        </Parameter>
        <Parameter>
          <Name>State</Name>
          <Value>NY</Value>
        </Parameter>
        <Parameter>
          <Name>Zipcode</Name>
          <Value>10004</Value>
        </Parameter>
        <Parameter>
          <Name>CountryId</Name>
          <Value>1</Value>
        </Parameter>
        <Parameter>
          <Name>Phone</Name>
          <Value>5555555555</Value>
        </Parameter>
        <Parameter>
          <Name>Email</Name>
          <Value>james@onsip.com</Value>
        </Parameter>
        <Parameter>
          <Name>Organization</Name>
          <Value/>
        </Parameter>
        <Parameter>
          <Name>UpdateDescendents</Name>
          <Value/>
        </Parameter>
      </Parameters>
    </Request>
    <Session>
      <IsEstablished>true</IsEstablished>
      <SessionId>nlibgopjksp2bel1ai22lp37l4</SessionId>
      <UserId>152255</UserId>
      <Roles>
        <Role>
          <Name>Account Admin</Name>
        </Role>
      </Roles>
    </Session>
  </Context>
  <Result>
    <AccountEditContact>
      <Account>
        <AccountId>22543</AccountId>
        <Receivable>887.05</Receivable>
        <Promocode/>
        <Productcode>onSIP</Productcode>
        <PerUserPricing>false</PerUserPricing>
        <BalanceSeconds>0</BalanceSeconds>
        <EscrowSecondsUpdate>0</EscrowSecondsUpdate>
        <EscrowSecondsCredit>0</EscrowSecondsCredit>
        <RegistrationLimit>0</RegistrationLimit>
        <Balance>88.8550000</Balance>
        <CreditLimit>0.00</CreditLimit>
        <Recharge>false</Recharge>
        <RechargeLevel>0.00</RechargeLevel>
        <RechargeThreshold>0.00</RechargeThreshold>
        <Modified>2014-04-21T14:09:11+00:00</Modified>
        <Created>2013-06-03T13:47:29+00:00</Created>
        <Contact>
          <Name>john</Name>
          <Organization/>
          <Address>55BroadSt</Address>
          <City>NYC</City>
          <State>NY</State>
          <Zipcode>10004</Zipcode>
          <Country>Afghanistan</Country>
          <CountryId>1</CountryId>
          <Phone>1-555-555-5555</Phone>
          <Email>john@example.onsip.com</Email>
          <Modified>2014-04-21T14:09:11+00:00</Modified>
        </Contact>
      </Account>
    </AccountEditContact>
  </Result>
</Response>

Account Edit Add Credit

Add credit to the pre-paid balance of the account by charging the credit card on file.

Authentication & Authorization

AuthenticationAuthorization
Authenticated Session Account Admin

Request Parameters

Required ParametersDescription
Action “AccountEditAddCredit”
SessionId Authenticated Session identifier.
AccountId A positive integer which references a unique Account.
Amount Amount in dollars as an integer between 10 and 10000.

Result Element Schema

AccountEditAddCredit.rnc:

AccountEditAddCredit.rng, Account.rng, Contact.rng, CreditCard.rng

Sample Request

cURL
1
2
3
4
curl -X POST \
--data \
'Action=AccountEditAddCredit&SessionId=q7m617ujhop06vgf9saqnghgp0&AccountId=19819&Amount=1000' \
https://api.onsip.com/api
JavaScript
1
2
3
4
5
6
7
8
9
10
11
12
var data = new FormData();
data.append('Action', 'AccountEditAddCredit');
data.append('SessionId', 'q7m617ujhop06vgf9saqnghgp0');
data.append('AccountId', '19819');
data.append('Amount', '1000');

var xhr = new XMLHttpRequest();
xhr.open('POST', 'https://api.onsip.com/api', true);
xhr.onload = function () {
  console.log(this.responseText);
}
xhr.send(data);

Sample Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
<Response xmlns="http://www.jnctn.net/ns/rest/2006-01">
  <Context>
    <Action>
      <IsCompleted>true</IsCompleted>
    </Action>
    <Request>
      <IsValid>true</IsValid>
      <DateTime>2014-04-21T14:31:20+00:00</DateTime>
      <Duration>2944</Duration>
      <Parameters>
        <Parameter>
          <Name>Action</Name>
          <Value>AccountEditAddCredit</Value>
        </Parameter>
        <Parameter>
          <Name>SessionId</Name>
          <Value>q7m617ujhop06vgf9saqnghgp0</Value>
        </Parameter>
        <Parameter>
          <Name>AccountId</Name>
          <Value>19819</Value>
        </Parameter>
        <Parameter>
          <Name>Amount</Name>
          <Value>1000</Value>
        </Parameter>
      </Parameters>
    </Request>
    <Session>
      <IsEstablished>true</IsEstablished>
      <SessionId>q7m617ujhop06vgf9saqnghgp0</SessionId>
      <UserId>123168</UserId>
      <Roles>
        <Role>
          <Name>Account Admin</Name>
        </Role>
      </Roles>
    </Session>
  </Context>
  <Result>
    <AccountEditAddCredit>
      <Account>
        <AccountId>19819</AccountId>
        <Receivable>0.00</Receivable>
        <Promocode/>
        <Productcode>platform</Productcode>
        <PerUserPricing>false</PerUserPricing>
        <BalanceSeconds>0</BalanceSeconds>
        <EscrowSecondsUpdate>0</EscrowSecondsUpdate>
        <EscrowSecondsCredit>0</EscrowSecondsCredit>
        <RegistrationLimit>10</RegistrationLimit>
        <Balance>1000.0000000</Balance>
        <CreditLimit>0.00</CreditLimit>
        <Recharge>false</Recharge>
        <RechargeLevel>0.00</RechargeLevel>
        <RechargeThreshold>0.00</RechargeThreshold>
        <Modified>2014-04-21T14:31:23+00:00</Modified>
        <Created>2014-04-16T14:34:44+00:00</Created>
        <Contact>
          <Name>John Example</Name>
          <Organization>short</Organization>
          <Address>55 Broad Street</Address>
          <City>New York City</City>
          <State>NY</State>
          <Zipcode>10004</Zipcode>
          <Country>United States of America</Country>
          <CountryId>207</CountryId>
          <Phone>1-234-567-8910</Phone>
          <Email>john@example.onsip.com</Email>
          <Modified>2014-04-16T14:34:44+00:00</Modified>
        </Contact>
        <CreditCard>
          <CreditCardId>36570</CreditCardId>
          <AccountId>19819</AccountId>
          <CreditCardType>3</CreditCardType>
          <Name>Fake Fake</Name>
          <LastFour>0002</LastFour>
          <Expiration>04/2017</Expiration>
          <Modified>2014-04-21T14:21:36+00:00</Modified>
          <FirstName>Fake</FirstName>
          <LastName>Fake</LastName>
          <Address>Fake</Address>
          <City>NYC</City>
          <State>NY</State>
          <Zipcode>10004</Zipcode>
          <CountryId>207</CountryId>
          <Phone>1-555-555-5555</Phone>
          <IPAddress>127.0.0.1</IPAddress>
        </CreditCard>
      </Account>
    </AccountEditAddCredit>
  </Result>
</Response>

Account Edit Recharge

Modify the auto recharge parameters of the account.

Authentication & Authorization

AuthenticationAuthorization
Authenticated Session Account Admin

Request Parameters

Required ParametersDescription
Action “AccountEditRecharge”
SessionId Authenticated Session identifier.
AccountId A positive integer which references a unique Account.
Recharge Enable auto recharge for this account; boolean (true/false).
RechargeThreshold The dollar amount below which the pre-paid balance must fall for an auto recharge to be attempted; an integer >= 5 and <= 5000.
RechargeLevel The dollar amount to which the pre-paid balance will be increased by an auto recharge: an integer >= 10 and <= 10000.

Result Element Schema

AccountEditRecharge.rnc:

AccountEditRecharge.rng, Account.rng, Contact.rng, CreditCard.rng

Sample Request

cURL
1
2
3
4
curl -X POST \
--data \
'Action=AccountEditRecharge&SessionId=q7m617ujhop06vgf9saqnghgp0&AccountId=19819&Recharge=false&RechargeThreshold=10&RechargeLevel=11' \
https://api.onsip.com/api
JavaScript
1
2
3
4
5
6
7
8
9
10
11
12
13
14
var data = new FormData();
data.append('Action', 'AccountEditRecharge');
data.append('SessionId', 'q7m617ujhop06vgf9saqnghgp0');
data.append('AccountId', '19819');
data.append('Recharge', 'false');
data.append('RechargeThreshold', '10');
data.append('RechargeLevel', '11');

var xhr = new XMLHttpRequest();
xhr.open('POST', 'https://api.onsip.com/api', true);
xhr.onload = function () {
  console.log(this.responseText);
}
xhr.send(data);

Sample Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
<Response xmlns="http://www.jnctn.net/ns/rest/2006-01">
  <Context>
    <Action>
      <IsCompleted>true</IsCompleted>
    </Action>
    <Request>
      <IsValid>true</IsValid>
      <DateTime>2014-04-21T14:33:48+00:00</DateTime>
      <Duration>1211</Duration>
      <Parameters>
        <Parameter>
          <Name>Action</Name>
          <Value>AccountEditRecharge</Value>
        </Parameter>
        <Parameter>
          <Name>SessionId</Name>
          <Value>q7m617ujhop06vgf9saqnghgp0</Value>
        </Parameter>
        <Parameter>
          <Name>AccountId</Name>
          <Value>19819</Value>
        </Parameter>
        <Parameter>
          <Name>Recharge</Name>
          <Value>false</Value>
        </Parameter>
        <Parameter>
          <Name>RechargeThreshold</Name>
          <Value>10</Value>
        </Parameter>
        <Parameter>
          <Name>RechargeLevel</Name>
          <Value>11</Value>
        </Parameter>
      </Parameters>
    </Request>
    <Session>
      <IsEstablished>true</IsEstablished>
      <SessionId>q7m617ujhop06vgf9saqnghgp0</SessionId>
      <UserId>123168</UserId>
      <Roles>
        <Role>
          <Name>Account Admin</Name>
        </Role>
      </Roles>
    </Session>
  </Context>
  <Result>
    <AccountEditRecharge>
      <Account>
        <AccountId>19819</AccountId>
        <Receivable>0.00</Receivable>
        <Promocode/>
        <Productcode>platform</Productcode>
        <PerUserPricing>false</PerUserPricing>
        <BalanceSeconds>0</BalanceSeconds>
        <EscrowSecondsUpdate>0</EscrowSecondsUpdate>
        <EscrowSecondsCredit>0</EscrowSecondsCredit>
        <RegistrationLimit>10</RegistrationLimit>
        <Balance>1000.0000000</Balance>
        <CreditLimit>0.00</CreditLimit>
        <Recharge>false</Recharge>
        <RechargeLevel>11</RechargeLevel>
        <RechargeThreshold>10</RechargeThreshold>
        <Modified>2014-04-21T14:31:23+00:00</Modified>
        <Created>2014-04-16T14:34:44+00:00</Created>
        <Contact>
          <Name>John Example</Name>
          <Organization>short</Organization>
          <Address>55 Broad Street</Address>
          <City>New York City</City>
          <State>NY</State>
          <Zipcode>10004</Zipcode>
          <Country>United States of America</Country>
          <CountryId>207</CountryId>
          <Phone>1-234-567-8910</Phone>
          <Email>james@onsip.com</Email>
          <Modified>2014-04-16T14:34:44+00:00</Modified>
        </Contact>
        <CreditCard>
          <CreditCardId>36570</CreditCardId>
          <AccountId>19819</AccountId>
          <CreditCardType>3</CreditCardType>
          <Name>Fake Fake</Name>
          <LastFour>0002</LastFour>
          <Expiration>04/2017</Expiration>
          <Modified>2014-04-21T14:21:36+00:00</Modified>
          <FirstName>Fake</FirstName>
          <LastName>Fake</LastName>
          <Address>Fake</Address>
          <City>NYC</City>
          <State>NY</State>
          <Zipcode>10004</Zipcode>
          <CountryId>207</CountryId>
          <Phone>1-555-555-5555</Phone>
          <IPAddress>127.0.0.1</IPAddress>
        </CreditCard>
      </Account>
    </AccountEditRecharge>
  </Result>
</Response>

Account Invoice Read

If used with an AccountInvoiceId this returns an existing invoice. Otherwise, based on the current account configuration, this will generate a preliminary invoice for the next billing cycle (useful to get an idea of what the next monthly invoice will look like).

Authentication & Authorization

AuthenticationAuthorization
Authenticated Session Account Admin

Request Parameters

Required ParametersDescription
Action “AccountInvoiceRead”
SessionId Authenticated Session identifier.
One and Only One of the Following ParametersDescription
AccountId A positive integer which references a unique Account.
AccountInvoiceId A positive integer which references a unique Invoice.

Result Element Schema

AccountInvoiceRead.rnc:

AccountInvoiceRead.rng, AccountInvoice.rng

Sample Request

cURL
1
2
3
4
curl -X POST \
--data \
'Action=AccountInvoiceRead&SessionId=q7m617ujhop06vgf9saqnghgp0&AccountId=19819' \
https://api.onsip.com/api
JavaScript
1
2
3
4
5
6
7
8
9
10
11
var data = new FormData();
data.append('Action', 'AccountInvoiceRead');
data.append('SessionId', 'q7m617ujhop06vgf9saqnghgp0');
data.append('AccountId', '19819');

var xhr = new XMLHttpRequest();
xhr.open('POST', 'https://api.onsip.com/api', true);
xhr.onload = function () {
  console.log(this.responseText);
}
xhr.send(data);

Sample Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
<Response xmlns="http://www.jnctn.net/ns/rest/2006-01">
  <Context>
    <Action>
      <IsCompleted>true</IsCompleted>
    </Action>
    <Request>
      <IsValid>true</IsValid>
      <DateTime>2014-04-21T14:35:30+00:00</DateTime>
      <Duration>15683</Duration>
      <Parameters>
        <Parameter>
          <Name>Action</Name>
          <Value>AccountInvoiceRead</Value>
        </Parameter>
        <Parameter>
          <Name>SessionId</Name>
          <Value>q7m617ujhop06vgf9saqnghgp0</Value>
        </Parameter>
        <Parameter>
          <Name>AccountId</Name>
          <Value>19819</Value>
        </Parameter>
      </Parameters>
    </Request>
    <Session>
      <IsEstablished>true</IsEstablished>
      <SessionId>q7m617ujhop06vgf9saqnghgp0</SessionId>
      <UserId>123168</UserId>
      <Roles>
        <Role>
          <Name>Account Admin</Name>
        </Role>
      </Roles>
    </Session>
  </Context>
  <Result>
    <AccountInvoiceRead>
      <AccountInvoice>
        <AccountInvoiceId>0</AccountInvoiceId>
        <AccountId>19819</AccountId>
        <Date>2014-05-16</Date>
        <Type>MonthlyAccountInvoice</Type>
        <Tax>0.00</Tax>
        <Total>0.00</Total>
        <SubTotal>0.00</SubTotal>
        <Notes/>
        <TaxItems/>
        <TypeSpecificData></TypeSpecificData>
        <ItemGroups>
          <ItemGroup>
            <Type>Package</Type>
            <SubTotal>0.00</SubTotal>
            <Items/>
          </ItemGroup>
          <ItemGroup>
            <Type>Resource</Type>
            <SubTotal>0.00</SubTotal>
            <Items>
              <Item>
                <Type>Resource</Type>
                <Quantity>0</Quantity>
                <Description>ACD Queue Address</Description>
                <UnitPrice>0.00</UnitPrice>
                <Amount>0.00</Amount>
                <ResourceItem>
                  <ResourceId>8</ResourceId>
                  <ResourceName>AcdQueueAddress</ResourceName>
                  <ResourceDescription>ACD Queue Address</ResourceDescription>
                  <ResourceOneTimeCharge>0.00</ResourceOneTimeCharge>
                  <ResourceMonthlyRecurringCharge>0.00</ResourceMonthlyRecurringCharge>
                  <AccountUsed>0</AccountUsed>
                  <AccountLimit>0</AccountLimit>
                  <PackageQuantity>0</PackageQuantity>
                </ResourceItem>
              </Item>
              <Item>
                <Type>Resource</Type>
                <Quantity>0</Quantity>
                <Description>ACD Queue Channel</Description>
                <UnitPrice>19.95</UnitPrice>
                <Amount>0.00</Amount>
                <ResourceItem>
                  <ResourceId>7</ResourceId>
                  <ResourceName>AcdQueue</ResourceName>
                  <ResourceDescription>ACD Queue Channel</ResourceDescription>
                  <ResourceOneTimeCharge>0.00</ResourceOneTimeCharge>
                  <ResourceMonthlyRecurringCharge>19.95</ResourceMonthlyRecurringCharge>
                  <AccountUsed>0</AccountUsed>
                  <AccountLimit>0</AccountLimit>
                  <PackageQuantity>0</PackageQuantity>
                </ResourceItem>
              </Item>
              <Item>
                <Type>Resource</Type>
                <Quantity>0</Quantity>
                <Description>Announcement Address</Description>
                <UnitPrice>0.00</UnitPrice>
                <Amount>0.00</Amount>
                <ResourceItem>
                  <ResourceId>15</ResourceId>
                  <ResourceName>AnnouncementAddress</ResourceName>
                  <ResourceDescription>Announcement Address</ResourceDescription>
                  <ResourceOneTimeCharge>0.00</ResourceOneTimeCharge>
                  <ResourceMonthlyRecurringCharge>0.00</ResourceMonthlyRecurringCharge>
                  <AccountUsed>0</AccountUsed>
                  <AccountLimit>0</AccountLimit>
                  <PackageQuantity>0</PackageQuantity>
                </ResourceItem>
              </Item>
              <Item>
                <Type>Resource</Type>
                <Quantity>0</Quantity>
                <Description>Announcement</Description>
                <UnitPrice>4.95</UnitPrice>
                <Amount>0.00</Amount>
                <ResourceItem>
                  <ResourceId>14</ResourceId>
                  <ResourceName>Announcement</ResourceName>
                  <ResourceDescription>Announcement</ResourceDescription>
                  <ResourceOneTimeCharge>0.00</ResourceOneTimeCharge>
                  <ResourceMonthlyRecurringCharge>4.95</ResourceMonthlyRecurringCharge>
                  <AccountUsed>0</AccountUsed>
                  <AccountLimit>0</AccountLimit>
                  <PackageQuantity>0</PackageQuantity>
                </ResourceItem>
              </Item>
              <Item>
                <Type>Resource</Type>
                <Quantity>0</Quantity>
                <Description>Auto-Attendant Address</Description>
                <UnitPrice>0.00</UnitPrice>
                <Amount>0.00</Amount>
                <ResourceItem>
                  <ResourceId>5</ResourceId>
                  <ResourceName>AttendantAddress</ResourceName>
                  <ResourceDescription>Auto-Attendant Address</ResourceDescription>
                  <ResourceOneTimeCharge>0.00</ResourceOneTimeCharge>
                  <ResourceMonthlyRecurringCharge>0.00</ResourceMonthlyRecurringCharge>
                  <AccountUsed>0</AccountUsed>
                  <AccountLimit>0</AccountLimit>
                  <PackageQuantity>0</PackageQuantity>
                </ResourceItem>
              </Item>
              <Item>
                <Type>Resource</Type>
                <Quantity>0</Quantity>
                <Description>Auto-Attendant Menu</Description>
                <UnitPrice>19.95</UnitPrice>
                <Amount>0.00</Amount>
                <ResourceItem>
                  <ResourceId>4</ResourceId>
                  <ResourceName>AttendantMenu</ResourceName>
                  <ResourceDescription>Auto-Attendant Menu</ResourceDescription>
                  <ResourceOneTimeCharge>0.00</ResourceOneTimeCharge>
                  <ResourceMonthlyRecurringCharge>19.95</ResourceMonthlyRecurringCharge>
                  <AccountUsed>0</AccountUsed>
                  <AccountLimit>0</AccountLimit>
                  <PackageQuantity>0</PackageQuantity>
                </ResourceItem>
              </Item>
              <Item>
                <Type>Resource</Type>
                <Quantity>0</Quantity>
                <Description>Busy Lamp Field</Description>
                <UnitPrice>19.95</UnitPrice>
                <Amount>0.00</Amount>
                <ResourceItem>
                  <ResourceId>26</ResourceId>
                  <ResourceName>BusyLampField</ResourceName>
                  <ResourceDescription>Busy Lamp Field</ResourceDescription>
                  <ResourceOneTimeCharge>0.00</ResourceOneTimeCharge>
                  <ResourceMonthlyRecurringCharge>19.95</ResourceMonthlyRecurringCharge>
                  <AccountUsed>0</AccountUsed>
                  <AccountLimit>0</AccountLimit>
                  <PackageQuantity>0</PackageQuantity>
                </ResourceItem>
              </Item>
              <Item>
                <Type>Resource</Type>
                <Quantity>0</Quantity>
                <Description>Conference Bridge Address</Description>
                <UnitPrice>0.00</UnitPrice>
                <Amount>0.00</Amount>
                <ResourceItem>
                  <ResourceId>19</ResourceId>
                  <ResourceName>ConferenceBridgeAddress</ResourceName>
                  <ResourceDescription>Conference Bridge Address</ResourceDescription>
                  <ResourceOneTimeCharge>0.00</ResourceOneTimeCharge>
                  <ResourceMonthlyRecurringCharge>0.00</ResourceMonthlyRecurringCharge>
                  <AccountUsed>0</AccountUsed>
                  <AccountLimit>0</AccountLimit>
                  <PackageQuantity>0</PackageQuantity>
                </ResourceItem>
              </Item>
              <Item>
                <Type>Resource</Type>
                <Quantity>0</Quantity>
                <Description>Conference Bridge User</Description>
                <UnitPrice>19.95</UnitPrice>
                <Amount>0.00</Amount>
                <ResourceItem>
                  <ResourceId>18</ResourceId>
                  <ResourceName>ConferenceBridge</ResourceName>
                  <ResourceDescription>Conference Bridge User</ResourceDescription>
                  <ResourceOneTimeCharge>0.00</ResourceOneTimeCharge>
                  <ResourceMonthlyRecurringCharge>19.95</ResourceMonthlyRecurringCharge>
                  <AccountUsed>0</AccountUsed>
                  <AccountLimit>0</AccountLimit>
                  <PackageQuantity>0</PackageQuantity>
                </ResourceItem>
              </Item>
              <Item>
                <Type>Resource</Type>
                <Quantity>0</Quantity>
                <Description>Dial By Name Directory Address</Description>
                <UnitPrice>0.00</UnitPrice>
                <Amount>0.00</Amount>
                <ResourceItem>
                  <ResourceId>10</ResourceId>
                  <ResourceName>DbnDirectoryAddress</ResourceName>
                  <ResourceDescription>Dial By Name Directory Address</ResourceDescription>
                  <ResourceOneTimeCharge>0.00</ResourceOneTimeCharge>
                  <ResourceMonthlyRecurringCharge>0.00</ResourceMonthlyRecurringCharge>
                  <AccountUsed>0</AccountUsed>
                  <AccountLimit>0</AccountLimit>
                  <PackageQuantity>0</PackageQuantity>
                </ResourceItem>
              </Item>
              <Item>
                <Type>Resource</Type>
                <Quantity>0</Quantity>
                <Description>Dial By Name Directory</Description>
                <UnitPrice>9.95</UnitPrice>
                <Amount>0.00</Amount>
                <ResourceItem>
                  <ResourceId>9</ResourceId>
                  <ResourceName>DbnDirectory</ResourceName>
                  <ResourceDescription>Dial By Name Directory</ResourceDescription>
                  <ResourceOneTimeCharge>0.00</ResourceOneTimeCharge>
                  <ResourceMonthlyRecurringCharge>9.95</ResourceMonthlyRecurringCharge>
                  <AccountUsed>0</AccountUsed>
                  <AccountLimit>0</AccountLimit>
                  <PackageQuantity>0</PackageQuantity>
                </ResourceItem>
              </Item>
              <Item>
                <Type>Resource</Type>
                <Quantity>0</Quantity>
                <Description>E911 Service User</Description>
                <UnitPrice>1.80</UnitPrice>
                <Amount>0.00</Amount>
                <ResourceItem>
                  <ResourceId>20</ResourceId>
                  <ResourceName>E911UserAddress</ResourceName>
                  <ResourceDescription>E911 Service User</ResourceDescription>
                  <ResourceOneTimeCharge>0.00</ResourceOneTimeCharge>
                  <ResourceMonthlyRecurringCharge>1.80</ResourceMonthlyRecurringCharge>
                  <AccountUsed>0</AccountUsed>
                  <AccountLimit>0</AccountLimit>
                  <PackageQuantity>0</PackageQuantity>
                </ResourceItem>
              </Item>
              <Item>
                <Type>Resource</Type>
                <Quantity>0</Quantity>
                <Description>PSTN Gateway Service</Description>
                <UnitPrice>19.95</UnitPrice>
                <Amount>0.00</Amount>
                <ResourceItem>
                  <ResourceId>17</ResourceId>
                  <ResourceName>Gateway</ResourceName>
                  <ResourceDescription>PSTN Gateway Service</ResourceDescription>
                  <ResourceOneTimeCharge>0.00</ResourceOneTimeCharge>
                  <ResourceMonthlyRecurringCharge>19.95</ResourceMonthlyRecurringCharge>
                  <AccountUsed>0</AccountUsed>
                  <AccountLimit>0</AccountLimit>
                  <PackageQuantity>0</PackageQuantity>
                </ResourceItem>
              </Item>
              <Item>
                <Type>Resource</Type>
                <Quantity>0</Quantity>
                <Description>Call/Hunt Group Address</Description>
                <UnitPrice>14.95</UnitPrice>
                <Amount>0.00</Amount>
                <ResourceItem>
                  <ResourceId>6</ResourceId>
                  <ResourceName>GroupAddress</ResourceName>
                  <ResourceDescription>Call/Hunt Group Address</ResourceDescription>
                  <ResourceOneTimeCharge>0.00</ResourceOneTimeCharge>
                  <ResourceMonthlyRecurringCharge>14.95</ResourceMonthlyRecurringCharge>
                  <AccountUsed>0</AccountUsed>
                  <AccountLimit>0</AccountLimit>
                  <PackageQuantity>0</PackageQuantity>
                </ResourceItem>
              </Item>
              <Item>
                <Type>Resource</Type>
                <Quantity>0</Quantity>
                <Description>Inbound Bridge Address</Description>
                <UnitPrice>1.95</UnitPrice>
                <Amount>0.00</Amount>
                <ResourceItem>
                  <ResourceId>16</ResourceId>
                  <ResourceName>InboundBridgeAddress</ResourceName>
                  <ResourceDescription>Inbound Bridge Address</ResourceDescription>
                  <ResourceOneTimeCharge>0.00</ResourceOneTimeCharge>
                  <ResourceMonthlyRecurringCharge>1.95</ResourceMonthlyRecurringCharge>
                  <AccountUsed>0</AccountUsed>
                  <AccountLimit>0</AccountLimit>
                  <PackageQuantity>0</PackageQuantity>
                </ResourceItem>
              </Item>
              <Item>
                <Type>Resource</Type>
                <Quantity>0</Quantity>
                <Description>Parking Channel Set (15)</Description>
                <UnitPrice>14.95</UnitPrice>
                <Amount>0.00</Amount>
                <ResourceItem>
                  <ResourceId>23</ResourceId>
                  <ResourceName>LotChannel</ResourceName>
                  <ResourceDescription>Parking Channel Set (15)</ResourceDescription>
                  <ResourceOneTimeCharge>0.00</ResourceOneTimeCharge>
                  <ResourceMonthlyRecurringCharge>14.95</ResourceMonthlyRecurringCharge>
                  <AccountUsed>0</AccountUsed>
                  <AccountLimit>0</AccountLimit>
                  <PackageQuantity>0</PackageQuantity>
                </ResourceItem>
              </Item>
              <Item>
                <Type>Resource</Type>
                <Quantity>0</Quantity>
                <Description>Enhanced Music on Hold</Description>
                <UnitPrice>19.95</UnitPrice>
                <Amount>0.00</Amount>
                <ResourceItem>
                  <ResourceId>22</ResourceId>
                  <ResourceName>MohEnhanced</ResourceName>
                  <ResourceDescription>Enhanced Music on Hold</ResourceDescription>
                  <ResourceOneTimeCharge>0.00</ResourceOneTimeCharge>
                  <ResourceMonthlyRecurringCharge>19.95</ResourceMonthlyRecurringCharge>
                  <AccountUsed>0</AccountUsed>
                  <AccountLimit>0</AccountLimit>
                  <PackageQuantity>0</PackageQuantity>
                </ResourceItem>
              </Item>
              <Item>
                <Type>Resource</Type>
                <Quantity>0</Quantity>
                <Description>Music on Hold Channel</Description>
                <UnitPrice>4.95</UnitPrice>
                <Amount>0.00</Amount>
                <ResourceItem>
                  <ResourceId>21</ResourceId>
                  <ResourceName>MohChannel</ResourceName>
                  <ResourceDescription>Music on Hold Channel</ResourceDescription>
                  <ResourceOneTimeCharge>0.00</ResourceOneTimeCharge>
                  <ResourceMonthlyRecurringCharge>4.95</ResourceMonthlyRecurringCharge>
                  <AccountUsed>0</AccountUsed>
                  <AccountLimit>0</AccountLimit>
                  <PackageQuantity>0</PackageQuantity>
                </ResourceItem>
              </Item>
              <Item>
                <Type>Resource</Type>
                <Quantity>0</Quantity>
                <Description>Time Switch Address</Description>
                <UnitPrice>0.00</UnitPrice>
                <Amount>0.00</Amount>
                <ResourceItem>
                  <ResourceId>11</ResourceId>
                  <ResourceName>TimeSwitchAddress</ResourceName>
                  <ResourceDescription>Time Switch Address</ResourceDescription>
                  <ResourceOneTimeCharge>0.00</ResourceOneTimeCharge>
                  <ResourceMonthlyRecurringCharge>0.00</ResourceMonthlyRecurringCharge>
                  <AccountUsed>0</AccountUsed>
                  <AccountLimit>0</AccountLimit>
                  <PackageQuantity>0</PackageQuantity>
                </ResourceItem>
              </Item>
              <Item>
                <Type>Resource</Type>
                <Quantity>1</Quantity>
                <Description>User Address</Description>
                <UnitPrice>0.00</UnitPrice>
                <Amount>0.00</Amount>
                <ResourceItem>
                  <ResourceId>1</ResourceId>
                  <ResourceName>UserAddress</ResourceName>
                  <ResourceDescription>User Address</ResourceDescription>
                  <ResourceOneTimeCharge>0.00</ResourceOneTimeCharge>
                  <ResourceMonthlyRecurringCharge>0.00</ResourceMonthlyRecurringCharge>
                  <AccountUsed>1</AccountUsed>
                  <AccountLimit>1</AccountLimit>
                  <PackageQuantity>0</PackageQuantity>
                </ResourceItem>
              </Item>
              <Item>
                <Type>Resource</Type>
                <Quantity>0</Quantity>
                <Description>Voice Application Address</Description>
                <UnitPrice>0.00</UnitPrice>
                <Amount>0.00</Amount>
                <ResourceItem>
                  <ResourceId>13</ResourceId>
                  <ResourceName>VoiceAppAddress</ResourceName>
                  <ResourceDescription>Voice Application Address</ResourceDescription>
                  <ResourceOneTimeCharge>0.00</ResourceOneTimeCharge>
                  <ResourceMonthlyRecurringCharge>0.00</ResourceMonthlyRecurringCharge>
                  <AccountUsed>0</AccountUsed>
                  <AccountLimit>0</AccountLimit>
                  <PackageQuantity>0</PackageQuantity>
                </ResourceItem>
              </Item>
              <Item>
                <Type>Resource</Type>
                <Quantity>0</Quantity>
                <Description>Voice Application</Description>
                <UnitPrice>0.00</UnitPrice>
                <Amount>0.00</Amount>
                <ResourceItem>
                  <ResourceId>12</ResourceId>
                  <ResourceName>VoiceApp</ResourceName>
                  <ResourceDescription>Voice Application</ResourceDescription>
                  <ResourceOneTimeCharge>0.00</ResourceOneTimeCharge>
                  <ResourceMonthlyRecurringCharge>0.00</ResourceMonthlyRecurringCharge>
                  <AccountUsed>0</AccountUsed>
                  <AccountLimit>0</AccountLimit>
                  <PackageQuantity>0</PackageQuantity>
                </ResourceItem>
              </Item>
              <Item>
                <Type>Resource</Type>
                <Quantity>0</Quantity>
                <Description>Voicemail Address</Description>
                <UnitPrice>0.00</UnitPrice>
                <Amount>0.00</Amount>
                <ResourceItem>
                  <ResourceId>3</ResourceId>
                  <ResourceName>VoicemailAddress</ResourceName>
                  <ResourceDescription>Voicemail Address</ResourceDescription>
                  <ResourceOneTimeCharge>0.00</ResourceOneTimeCharge>
                  <ResourceMonthlyRecurringCharge>0.00</ResourceMonthlyRecurringCharge>
                  <AccountUsed>0</AccountUsed>
                  <AccountLimit>0</AccountLimit>
                  <PackageQuantity>0</PackageQuantity>
                </ResourceItem>
              </Item>
              <Item>
                <Type>Resource</Type>
                <Quantity>0</Quantity>
                <Description>Voice Mailbox</Description>
                <UnitPrice>2.00</UnitPrice>
                <Amount>0.00</Amount>
                <ResourceItem>
                  <ResourceId>2</ResourceId>
                  <ResourceName>Voicemailbox</ResourceName>
                  <ResourceDescription>Voice Mailbox</ResourceDescription>
                  <ResourceOneTimeCharge>0.00</ResourceOneTimeCharge>
                  <ResourceMonthlyRecurringCharge>2.00</ResourceMonthlyRecurringCharge>
                  <AccountUsed>0</AccountUsed>
                  <AccountLimit>0</AccountLimit>
                  <PackageQuantity>0</PackageQuantity>
                </ResourceItem>
              </Item>
            </Items>
          </ItemGroup>
        </ItemGroups>
      </AccountInvoice>
    </AccountInvoiceRead>
  </Result>
</Response>

Account Invoice Browse

Returns all invoices for an account.

Authentication & Authorization

AuthenticationAuthorization
Authenticated Session Account Admin

Request Parameters

Required ParametersDescription
Action “AccountInvoiceBrowse”
SessionId Authenticated Session identifier.
AccountId A positive integer which references a unique Account.
Optional ParametersDefaultDescription
OrderBy AccountInvoiceId AccountId | AccountInvoiceId
Limit 20 The maximum number of records to return.
Offset 0 The offset of the first record to return. The offset of the initial record is 0 (not 1).
CalcFound true Calculate how many records there would be in the result set, disregarding any Limit parameter.

Result Element Schema

AccountInvoiceBrowse.rnc:

AccountInvoiceBrowse.rng, AccountInvoice.rng

Sample Request

cURL
1
2
3
4
curl -X POST \
--data \
'Action=AccountInvoiceBrowse&SessionId=q7m617ujhop06vgf9saqnghgp0&AccountId=19819' \
https://api.onsip.com/api
JavaScript
1
2
3
4
5
6
7
8
9
10
11
var data = new FormData();
data.append('Action', 'AccountInvoiceBrowse');
data.append('SessionId', 'q7m617ujhop06vgf9saqnghgp0');
data.append('AccountId', '19819');

var xhr = new XMLHttpRequest();
xhr.open('POST', 'https://api.onsip.com/api', true);
xhr.onload = function () {
  console.log(this.responseText);
}
xhr.send(data);

Sample Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
<Response xmlns="http://www.jnctn.net/ns/rest/2006-01">
  <Context>
    <Action>
      <IsCompleted>true</IsCompleted>
    </Action>
    <Request>
      <IsValid>true</IsValid>
      <DateTime>2014-04-21T14:45:45+00:00</DateTime>
      <Duration>587</Duration>
      <Parameters>
        <Parameter>
          <Name>Action</Name>
          <Value>AccountInvoiceBrowse</Value>
        </Parameter>
        <Parameter>
          <Name>SessionId</Name>
          <Value>q7m617ujhop06vgf9saqnghgp0</Value>
        </Parameter>
        <Parameter>
          <Name>AccountId</Name>
          <Value>19819</Value>
        </Parameter>
        <Parameter>
          <Name>OrderBy</Name>
          <Value>AccountInvoiceId Desc</Value>
        </Parameter>
        <Parameter>
          <Name>Limit</Name>
          <Value>20</Value>
        </Parameter>
        <Parameter>
          <Name>Offset</Name>
          <Value>0</Value>
        </Parameter>
        <Parameter>
          <Name>CalcFound</Name>
          <Value>true</Value>
        </Parameter>
      </Parameters>
    </Request>
    <Session>
      <IsEstablished>true</IsEstablished>
      <SessionId>q7m617ujhop06vgf9saqnghgp0</SessionId>
      <UserId>123168</UserId>
      <Roles>
        <Role>
          <Name>Account Admin</Name>
        </Role>
      </Roles>
    </Session>
  </Context>
  <Result>
    <AccountInvoiceBrowse>
      <AccountInvoices Limit="20" Offset="0" Found="0"/>
    </AccountInvoiceBrowse>
  </Result>
</Response>

Topics: Developer Docs