api-doc.eclipse-billing.co.uk
Open in
urlscan Pro
3.215.255.119
Public Scan
URL:
https://api-doc.eclipse-billing.co.uk/
Submission: On October 14 via automatic, source certstream-suspicious — Scanned from DE
Submission: On October 14 via automatic, source certstream-suspicious — Scanned from DE
Form analysis 0 forms found in the DOM
Text Content
Public
Documentation Settings
Environment
No Environment
Layout
Double Column
Language
cURL
NGWEBAPI PUBLIC DOCUMENTATION COLLECTION
* Introduction
Customers
Bill Plans
Bill Charges
Phone numbers
Companies
Products
Price Lists
Number Groups
Rating Tables
Tax
Number Profiles
Payment Types
Bundles
Bill Styles
Analysis
Carriers
Account\Sales Managers
Archives
Profit and Loss by Supplier
Line Types
Invoices
NGwebapi Public Documentation Collection
EclipseNG Public API Endpoints
Please note that access to this API is read-only by default. If you require
access to anything other than GET end points then please speak to our I.T.
Department.
Customers
POST
Add customer
{{mainUrl}}customers
Adds a new customer record to the system.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
Content-Type
application/json
customerKey
{{customerKey}}
BODYraw
View More
{
"accountNumber": "ABF1233",
"company": "Blog Tech1",
"salutation": "Mr",
"title": "Managing Director",
"foreName": "Joe",
"surname": "Blogs",
"address1": "11 High Stret",
"address2": "Hilton",
"address3": "Derby",
"postcode": "DE1 2AA",
Example Request
Add customer
View More
curl --location -g --request POST '{{mainUrl}}customers' \
--header 'Content-Type: application/json' \
--header 'customerKey: {{customerKey}}' \
--data-raw '{
"accountNumber": "ABF1233",
"company": "Blog Tech1",
"salutation": "Mr",
"title": "Managing Director",
"foreName": "Joe",
"surname": "Blogs",
"address1": "11 High Stret",
GET
Get all customers
{{mainUrl}}customers
Returns a collection of all customers models in the system.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get all customers
curl --location -g --request GET '{{mainUrl}}customers' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Customer by ID
{{mainUrl}}customers/{{id}}
Returns a customer model matching the customer ID that has been passed.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Example Request
Customer by ID
curl --location -g --request GET '{{mainUrl}}customers/{{id}}' \
--header 'customerKey: {{customerKey}}'
GET
Search customer
{{mainUrl}}customers/search?account_number={{firstaccount}}&company={{firstcompany}}
Returns a collection of customer models containing zero to many results
depending on the criteria passed to it.
You can pass the following parameters that will allow you to do a partial match
on a single or combination of the following parameters
account_number
Company
Surname
Forename
Address1
Address2
Address3
Postcode
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
PARAMS
account_number
{{firstaccount}}
company
{{firstcompany}}
Example Request
Search customer
curl --location -g --request GET '{{mainUrl}}customers/search?account_number={{firstaccount}}&company={{firstcompany}}' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get customer salutations
{{mainUrl}}customers/salutations/
AUTHORIZATIONOAuth 2.0
Access Token
<access-token>
HEADERS
customerKey
{{customerKey}}
Example Request
Get customer salutations
curl --location -g --request GET '{{mainUrl}}customers/salutations/' \
--header 'customerKey: {{customerKey}}'
PUT
Close account by id
{{mainUrl}}customers/{{customerId}}/close
Closes a customers account. Warning this will disconnect all numbers, account
and number level charges on this account.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
Content-Type
application/json
customerKey
{{customerKey}}
BODYraw
"{{closedate}}"
Example Request
Close account by id
curl --location -g --request PUT '{{mainUrl}}customers/{{customerId}}/close' \
--header 'Content-Type: application/json' \
--header 'customerKey: {{customerKey}}' \
--data-raw '
"{{closedate}}"
'
PUT
Update customer by id
{{mainUrl}}customers/{{customerId}}
Updates a customer model based on the values in the model passed in.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
Content-Type
application/json
customerKey
{{customerKey}}
BODYraw
View More
{
"accountNumber": "AHJRBCA",
"company": "Test company",
"salutation": "Mr",
"title": "Managing Director",
"foreName": "Phil",
"surname": "Blogs",
"address1": "22 a Road",
"address2": "A vilalge ",
"address3": "A Town",
"postcode": "DE25FG",
Example Request
Update customer by id
View More
curl --location -g --request PUT '{{mainUrl}}customers/{{customerId}}' \
--header 'Content-Type: application/json' \
--header 'customerKey: {{customerKey}}' \
--data-raw '{
"accountNumber": "AHJRBCA",
"company": "Test company",
"salutation": "Mr",
"title": "Managing Director",
"foreName": "Phil",
"surname": "Blogs",
"address1": "22 a Road",
Bill Plans
POST
Add bill plan
{{mainUrl}}billplans
Adds a new bill plan to the system. A bill plan must be linked to a customer and
is required before adding Phonenumbers/CLIs to the Database.
AUTHORIZATIONOAuth 2.0
Access Token
<access-token>
HEADERS
Content-Type
application/json
customerKey
{{customerKey}}
BODYraw
{
"customerId": 1,
"billPlanId": 0,
"copy": false,
"numCopies": 1
}
Example Request
Add bill plan
View More
curl --location -g --request POST '{{mainUrl}}billplans' \
--header 'Content-Type: application/json' \
--header 'customerKey: {{customerKey}}' \
--data-raw '{
"customerId": 1,
"billPlanId": 0,
"copy": false,
"numCopies": 1
}'
GET
Get all phone numbers by bill plan id
{{mainUrl}}billplans/{{billplanid}}phonenumbers
Returns a collection of phonenumber models containing all of the phonenumbers
assigned to the bill plan ID passed.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get all phone numbers by bill plan id
curl --location -g --request GET '{{mainUrl}}billplans/{{billplanid}}phonenumbers' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get bill plan by customer id
{{mainUrl}}customers/{{customerid}}/billplans
Returns a bill plan model matching the ID provided.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get bill plan by customer id
curl --location -g --request GET '{{mainUrl}}customers/{{customerid}}/billplans' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
PUT
Update bill plan by id
{{mainUrl}}billplans/{{billingid}}
Updates a single bill plan.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
Content-Type
application/json
customerKey
{{customerKey}}
BODYraw
View More
{
"name": "New bill plan",
"site_Contact": "",
"site_address": "",
"sysmanufac": "",
"sysyearinst": 0,
"syssoftver": "",
"sysprogrammable": false,
"sysext": 0,
"sys2ndary_id": 0,
"syscostmaint": 0,
Example Request
Update bill plan by id
View More
curl --location -g --request PUT '{{mainUrl}}billplans/{{billingid}}' \
--header 'Content-Type: application/json' \
--header 'customerKey: {{customerKey}}' \
--data-raw '{
"name": "New bill plan",
"site_Contact": "",
"site_address": "",
"sysmanufac": "",
"sysyearinst": 0,
"syssoftver": "",
"sysprogrammable": false,
GET
Get a bill plan by id
{{mainUrl}}billplans/{{billingid}}
Returns a bill plan model matching the ID that has been provided.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get a bill plan by id
curl --location -g --request GET '{{mainUrl}}billplans/{{billingid}}' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Search bill plan phonumbers by description
{{mainUrl}}billplans/{{billingid}}/phonenumbers?search={{searchParameter}}
Returns a collection of phonenumber models containing zero to many result based
on the criteria passed.
Parameters are:
Number - this is a partial match
numberStatus - All = 0, Connected = 1, Disconnected = 2
accountType All = 0, Customer= 1, Dealer = 2, Supplier = 3, Reseller = 4,
Contact = 5, Prospect = 6
start>
end
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
PARAMS
search
{{searchParameter}}
Example Request
Search bill plan phonumbers by description
curl --location -g --request GET '{{mainUrl}}billplans/{{billingid}}/phonenumbers?search={{searchParameter}}' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
DEL
Delete bill plan
{{mainUrl}}billplans/{{billingid}}
Deletes the bill plan and all number and charges connected to the bill plan Note
- Once deleted this cannot be reversed
The following list details reasons why you might not be able to delete a bill
plan.
* The bill plan contains active number(s)
* The customer has a finalised invoice
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
Content-Type
application/json
customerKey
{{customerKey}}
Example Request
Delete bill plan
curl --location -g --request DELETE '{{mainUrl}}billplans/{{billingid}}' \
--header 'Content-Type: application/json' \
--header 'customerKey: {{customerKey}}' \
--data-raw ''
Bill Charges
POST
Add new charge
{{mainUrl}}billcharges
Adds a new charge to either an account or CLI.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
Content-Type
application/json
customerKey
{{customerKey}}
BODYraw
{
"customerId": 139,
"numberId": 40318,
"productId": 20,
"startDate": "2019-06-26",
"refNo": "",
"repeatCode": 1,
"quantity": 1,
"supplierFilter": ""
}
Example Request
Add new charge
View More
curl --location -g --request POST '{{mainUrl}}billcharges' \
--header 'Content-Type: application/json' \
--header 'customerKey: {{customerKey}}' \
--data-raw '{
"customerId": 139,
"numberId": 40318,
"productId": 20,
"startDate": "2019-06-26",
"refNo": "",
"repeatCode": 1,
"quantity": 1,
GET
Get bill charges by id
{{mainUrl}}billcharges/{{id}}
Returns a charge model matching the ID provided.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get bill charges by id
curl --location -g --request GET '{{mainUrl}}billcharges/{{id}}' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get bill charges by customer
{{mainUrl}}customers/{{customer_id}}/billcharges
Returns a collection of charge models that will contain all of the charges that
are linked to a customer.
Account level charges are those charge models where the tel_id field is set to
0.
Number level charges are those charge models where the tel_id field is greater
than 0.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get bill charges by customer
curl --location -g --request GET '{{mainUrl}}customers/{{customer_id}}/billcharges' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get bill charges by phone number
{{mainUrl}}phonenumbers/{{tel_id}}/billcharges
Returns a collection of charge models that are linked to a specific
CLI/Phonenumber.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Example Request
Get bill charges by phone number
curl --location -g --request GET '{{mainUrl}}phonenumbers/{{tel_id}}/billcharges' \
--header 'customerKey: {{customerKey}}'
GET
Get all repeat periods
{{mainUrl}}billcharges/repeatcodes
AUTHORIZATIONOAuth 2.0
Access Token
<access-token>
HEADERS
NG-APIKey
56e494e4-ae1b-4221-8154-2e712fbe307a
customerKey
{{customerKey}}
Content-Type
application/json
BODYraw
{
"CustomerId": 144,
"FromDate": "",
"ToDate": "",
"StartInvoiceNo": null,
"EndInvoiceNo": null,
"PONumber": null
}
Example Request
Get all repeat periods
View More
curl --location -g --request GET '{{mainUrl}}billcharges/repeatcodes' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"CustomerId": 144,
"FromDate": "",
"ToDate": "",
"StartInvoiceNo": null,
"EndInvoiceNo": null,
"PONumber": null
}'
PUT
Update charge
{{mainUrl}}billcharges/{{id}}
Updates a charge in the system.
Note There are certain restrictions on the kind of changes that can be applied.
These include the following.
* A product cannot be changed on a live charge.
* Some values cannot be changed if the charge is included on a Bill that has
been finalised.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
Content-Type
application/json
customerKey
{{customerKey}}
BODYraw
View More
{
"refNo": "Updated",
"repeatCode": 1,
"quantity": 1,
"description": "Updated text",
"unitPrice": 20,
"buyPrice": 0,
"startDate": "2018-10-10",
"endDate": "",
"lastTo": "",
"applyWhen": 0,
Example Request
Update charge
View More
curl --location -g --request PUT '{{mainUrl}}billcharges/{{id}}' \
--header 'Content-Type: application/json' \
--header 'customerKey: {{customerKey}}' \
--data-raw '{
"refNo": "Updated",
"repeatCode": 1,
"quantity": 1,
"description": "Updated text",
"unitPrice": 20,
"buyPrice": 0,
"startDate": "2018-10-10",
PUT
End charge
{{mainUrl}}billcharges/{{id}}/end
Ends a charge on the system. This will set the date beyond which the charge will
no longer bill. if the date is before the last to date (date the charge has
already been billed to) then a credit will be generated unless the Credit flag
is set to false.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
Content-Type
application/json
customerKey
{{customerKey}}
BODYraw
'{{delete date}}'
Example Request
End charge
curl --location -g --request PUT '{{mainUrl}}billcharges/{{id}}/end' \
--header 'Content-Type: application/json' \
--header 'customerKey: {{customerKey}}' \
--data-raw ''\''{{delete date}}'\''
'
DEL
Delete charge
{{mainUrl}}billcharges/{{id}}
Deletes a charge from the system. Once removed it cannot be restored. Note
Charges contained on a bill that has been finalised cannot be deleted.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
Content-Type
application/json
customerKey
{{customerKey}}
Example Request
Delete charge
curl --location -g --request DELETE '{{mainUrl}}billcharges/{{id}}' \
--header 'Content-Type: application/json' \
--header 'customerKey: {{customerKey}}' \
--data-raw ''
Phone numbers
POST
Add fixed number
{{mainUrl}}/numberprofile/{{Fixedprofileid}}/phonenumbers
Adds a number of the type - fixed line.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
Content-Type
application/json
customerKey
{{customerKey}}
BODYraw
View More
{
"cli": "02085558555",
"accountId": 169,
"billingPlanId": 2380,
"numberType": 2,
"startDate": "2019-07-15",
"costCentre": "000",
"description": "Test",
"email": "api@informbilling.co.uk",
"processLine": true,
"ratingTables": [
Example Request
Add fixed number
View More
curl --location -g --request POST '{{mainUrl}}/numberprofile/{{Fixedprofileid}}/phonenumbers' \
--header 'Content-Type: application/json' \
--header 'customerKey: {{customerKey}}' \
--data-raw '{
"cli": "02085558555",
"accountId": 169,
"billingPlanId": 2380,
"numberType": 2,
"startDate": "2019-07-15",
"costCentre": "000",
"description": "Test",
PUT
Update fixed number
{{mainUrl}}phonenumbers/fixed/{{telid}}
Updates a fixed line number.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
Content-Type
application/json
customerKey
{{customerKey}}
BODYraw
View More
{
"equip_id": 5,
"numlines": 1,
"numchannels": 1,
"type_id": 26,
"centrex": {
"cps_options": "D"
},
"description": "test description/username",
"costcode": "000",
"conDate": "2016-03-05T00:00:00Z",
Example Request
Update fixed number
View More
curl --location -g --request PUT '{{base}}phonenumbers/fixed/19852' \
--header 'Content-Type: application/json' \
--data-raw '{
"equip_id": 5,
"numlines": 1,
"numchannels": 1,
"type_id": 26,
"centrex": {
"cps_options": "D"
},
"description": "test description/username",
Example Response
200 OK
Body
Header(5)
No response body
This request doesn't return a response body
POST
Add mobile number
{{mainUrl}}/numberprofile/{{Mobileprofileid}}/phonenumbers
Adds a mobile number to the system.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
Content-Type
application/json
customerKey
{{customerKey}}
BODYraw
View More
{
"cli": "07864710356",
"accountId": 61,
"billingPlanId": 2002,
"numberType": 3,
"startDate": "2019-07-15 00:00:00.000",
"costCentre": "000",
"description": "Test",
"email": "api@informbilling.co.uk",
"processLine": false,
"ratingTables": [
Example Request
Add mobile number
View More
curl --location -g --request POST '{{mainUrl}}/numberprofile/{{Mobileprofileid}}/phonenumbers' \
--header 'Content-Type: application/json' \
--header 'customerKey: {{customerKey}}' \
--data-raw '{
"cli": "07864710356",
"accountId": 61,
"billingPlanId": 2002,
"numberType": 3,
"startDate": "2019-07-15 00:00:00.000",
"costCentre": "000",
"description": "Test",
PUT
Update mobile number
{{mainUrl}}phonenumbers/mobile/{{telid}}
Updates a mobile number.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
Content-Type
application/json
customerKey
{{customerKey}}
BODYraw
View More
{
"sim": "-",
"puk": "-",
"mailbox": "aa",
"data": "aa",
"fax": "aa",
"bar_int": true,
"bar_roam": true,
"bar_out": true,
"bar_stolen": true,
"lower": 1,
Example Request
Update mobile number
View More
curl --location -g --request PUT '{{mainUrl}}phonenumbers/mobile/{{telid}}' \
--header 'Content-Type: application/json' \
--header 'customerKey: {{customerKey}}' \
--data-raw '{
"sim": "-",
"puk": "-",
"mailbox": "aa",
"data": "aa",
"fax": "aa",
"bar_int": true,
"bar_roam": true,
POST
Add NTS number
{{mainUrl}}/numberprofile/{{NTSprofileid}}/phonenumbers
Adds an Inbound NTS number to the system.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
Content-Type
application/json
customerKey
{{customerKey}}
BODYraw
View More
{
"cli": "0800558542",
"accountId": 139,
"billingPlanId": 2074,
"numberType": 1,
"startDate": "2018-10-18",
"costCentre": "000",
"description": "Test",
"email": "api@informbilling.co.uk",
"processLine": true,
"ratingTables": [
Example Request
Add NTS number
View More
curl --location -g --request POST '{{mainUrl}}/numberprofile/{{NTSprofileid}}/phonenumbers' \
--header 'Content-Type: application/json' \
--header 'customerKey: {{customerKey}}' \
--data-raw '{
"cli": "0800558542",
"accountId": 139,
"billingPlanId": 2074,
"numberType": 1,
"startDate": "2018-10-18",
"costCentre": "000",
"description": "Test",
PUT
Update NTS number
{{mainUrl}}phonenumbers/nts/{{telid}}
Updates an inbound NTS number.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
Content-Type
application/json
customerKey
{{customerKey}}
BODYraw
View More
{
"ntsclass": 1,
"ntstype": 4,
"routing_plan": 1,
"description": "no",
"costcode": "100",
"conDate": "2014-11-01T00:00:00Z",
"email": "abdulw@informbilling.co.uk",
"sp_contype": 10,
"user_contractdate": "2014-11-01T00:00:00Z",
"user_contractlen": 12,
Example Request
Update NTS number
View More
curl --location -g --request PUT '{{mainUrl}}phonenumbers/nts/{{telid}}' \
--header 'Content-Type: application/json' \
--header 'customerKey: {{customerKey}}' \
--data-raw '{
"ntsclass": 1,
"ntstype": 4,
"routing_plan": 1,
"description": "no",
"costcode": "100",
"conDate": "2014-11-01T00:00:00Z",
"email": "abdulw@informbilling.co.uk",
PUT
Update CLI
{{mainUrl}}phonenumbers/{{telid}}/updatecli
Updates any number type.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
Content-Type
application/json
customerKey
{{customerKey}}
BODYraw
{
"newCli": "Clearsolution"
}
Example Request
Update CLI
curl --location -g --request PUT '{{mainUrl}}phonenumbers/{{telid}}/updatecli' \
--header 'Content-Type: application/json' \
--header 'customerKey: {{customerKey}}' \
--data-raw '{
"newCli": "Clearsolution"
}'
PUT
Disconnect a number
{{mainUrl}}billplans/{{billplanid}}/phonenumbers/{{telid}}/disconnect
Sets a disconnection date for a number. The number will not be deleted. This
controls the dates that calls will be billed for on this number.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
Content-Type
application/json
customerKey
{{customerKey}}
BODYraw
{
"disconnectionDate":"2017-10-31",
"deleteUnbilled": true,
"credit": true
}
Example Request
Disconnect a number
curl --location -g --request PUT '{{mainUrl}}billplans/{{billplanid}}/phonenumbers/{{telid}}/disconnect' \
--header 'Content-Type: application/json' \
--header 'customerKey: {{customerKey}}' \
--data-raw '{
"disconnectionDate":"2017-10-31",
"deleteUnbilled": true,
"credit": true
}'
DEL
Delete number
{{mainUrl}}billplans/{{billplanid}}/phonenumbers/{{telid}}
Permanently deletes the number from the system. Note Once a number has been
deleted it cannot be retrieved and all charges connected to this number will
also be deleted.
* A number cannot be deleted if it has calls or charges that are contained on a
bill that is finalised.
* If there are any unbilled calls connected to this number the number will
still be deleted but the unbilled calls will be flagged as missing billing
cli(s) in Eclipse NG.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Example Request
Delete number
curl --location -g --request DELETE '{{mainUrl}}billplans/{{billplanid}}/phonenumbers/{{telid}}' \
--header 'customerKey: {{customerKey}}' \
--data-raw ''
GET
Get Number details
{{mainUrl}}billplans/{{billplanid}}/phonenumbers/{{telid}}
Returns a collection of phonenumber models that will contain zero or more
phonenumbers depending on the criteria used.
AUTHORIZATIONOAuth 2.0
Access Token
<access-token>
HEADERS
customerKey
{{customerKey}}
Example Request
Get Number details
curl --location -g --request GET '{{mainUrl}}billplans/{{billplanid}}/phonenumbers/{{telid}}' \
--header 'customerKey: {{customerKey}}'
GET
Search phone numbers
{{mainUrl}}phonenumbers/search?start=1&end=50
Returns a collection of phonenumber models containing zero to many results based
on the criteria passed.
Parameters are:
Number - this is a partial match.
numberStatus - All = 0, Connected = 1, Disconnected = 2
accountType All = 0, Customer= 1, Dealer = 2, Supplier = 3, Reseller = 4,
Contact = 5, Prospect = 6
start>
end
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
PARAMS
start
1
end
50
Example Request
Search phone numbers
curl --location -g --request GET '{{mainUrl}}phonenumbers/search?start=1&end=50' \
--header 'customerKey: {{customerKey}}'
GET
DDIs
{{mainUrl}}phonenumbers/ddi/{{telid}}
Returns a collection of DDI models.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
DDIs
curl --location -g --request GET '{{mainUrl}}phonenumbers/ddi/{{telid}}' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
Companies
GET
Get all companies
{{mainUrl}}companies
Returns a collection of all company models in the system. There will always be
at least one billing company.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get all companies
curl --location -g --request GET '{{mainUrl}}companies' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get a company by id
{{mainUrl}}companies/{{id}}
Returns a company model matching the id passed.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get a company by id
curl --location -g --request GET '{{mainUrl}}companies/{{id}}' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Search Companies
{{mainUrl}}companies/search?coaddress={{address}}
Returns a collection of company models containing zero to many results based on
the criteria used.
Parameters are:
coname - partial match
coaddress - partial match
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
PARAMS
coaddress
{{address}}
Example Request
Search Companies
curl --location -g --request GET '{{mainUrl}}companies/search?coaddress={{address}}' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
Products
GET
Get all products
{{mainUrl}}products/search
Returns a collection of product models in the system. Products are currently
read-only and are used when adding a charge to the system.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get all products
curl --location -g --request GET '{{mainUrl}}products/search' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get product by id
{{mainUrl}}products/{{product_id}}
Returns a product model matching the id passed.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get product by id
curl --location -g --request GET '{{mainUrl}}products/{{product_id}}' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Search product
{{mainUrl}}products/search?search={{searchText}}
Returns a collection of product models containing zero to many results depening
on the criteia passed.
Parameters are:
status
productType
carrier
search - partial match in different fields
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
PARAMS
search
{{searchText}}
Example Request
Search product
curl --location -g --request GET '{{mainUrl}}products/search?search={{searchText}}' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
Price Lists
GET
Get all price lists
{{mainUrl}}pricelists
Returns a collection of price list models containing all of the price lists in
the system.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get all price lists
curl --location -g --request GET '{{mainUrl}}pricelists' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get all price list by id
{{mainUrl}}pricelists/{{id}}
Returns a price list model related to the id passed.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get all price list by id
curl --location -g --request GET '{{mainUrl}}pricelists/{{id}}' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
Number Groups
GET
Get all global number groups
{{mainUrl}}globalnumbergroups
Returns a collection of number group models containing all global number groups
in the system.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get all global number groups
curl --location -g --request GET '{{mainUrl}}globalnumbergroups' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get global number group by id
{{mainUrl}}globalnumbergroups/{{id}}
Returns a number group model related to the id passed.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get global number group by id
curl --location -g --request GET '{{mainUrl}}globalnumbergroups/{{id}}' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get all number groups
{{mainUrl}}customernumbergroups
Returns a collection of number group models containing all number groups in the
system.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get all number groups
curl --location -g --request GET '{{mainUrl}}customernumbergroups' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get customer number groups by customer id
{{mainUrl}}customers/{{customerid}}/customernumbergroups
Returns a collection of all customer number group models related to the customer
id passed.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get customer number groups by customer id
curl --location -g --request GET '{{mainUrl}}customers/{{customerid}}/customernumbergroups' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get customer number group by id and customer Id
{{mainUrl}}customers/{{customerid}}/customernumbergroups/{{id}}
Returns a customer number group model related to the customer id and number
group id passed.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get customer number group by id and customer Id
curl --location -g --request GET '{{mainUrl}}customers/{{customerid}}/customernumbergroups/{{id}}' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get number group by phone number
{{mainUrl}}sharednumbergroups/telId/{{telid}}
Returns a collection of number group models related to the phone number id
passed.
AUTHORIZATIONOAuth 2.0
Access Token
<access-token>
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get number group by phone number
curl --location -g --request GET '{{mainUrl}}sharednumbergroups/telId/{{telid}}' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
Rating Tables
GET
Get all sell rating tables
{{mainUrl}}sellratingtables
Returns a collection of sell rating table models containing all sell rating
tables in the system.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get all sell rating tables
curl --location -g --request GET '{{mainUrl}}sellratingtables' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get sell rating table by id
{{mainUrl}}sellratingtables/{{id}}
Returns a sell rating table model related to the id passed.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get sell rating table by id
curl --location -g --request GET '{{mainUrl}}sellratingtables/{{id}}' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get all compare rating tables
{{mainUrl}}compareratingtables
Returns a collection of rating table models containing all compare rating tables
in the system.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get all compare rating tables
curl --location -g --request GET '{{mainUrl}}compareratingtables' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get compare rating table by id
{{mainUrl}}compareratingtables/{{id}}
Returns a rating table model related to the id passed.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get compare rating table by id
curl --location -g --request GET '{{mainUrl}}compareratingtables/{{id}}' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get all buy rating tables
{{mainUrl}}buyratingtables
Returns a collection of rating table models containing all buy rating tables in
the system.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get all buy rating tables
curl --location -g --request GET '{{mainUrl}}buyratingtables' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get buy rating table by id
{{mainUrl}}buyratingtables/{{id}}
Returns a rating table model related to the id passed.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get buy rating table by id
curl --location -g --request GET '{{mainUrl}}buyratingtables/{{id}}' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get sell rating table by phone number
{{mainUrl}}sellratingtables/telid/{{telid}}
Returns a collection of rating table models containing all sell rating tables
related to the phonenumber id passed.
AUTHORIZATIONOAuth 2.0
Access Token
<access-token>
HEADERS
NG-APIKey
56e494e4-ae1b-4221-8154-2e712fbe307a
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get sell rating table by phone number
curl --location -g --request GET '{{mainUrl}}sellratingtables/telid/{{telid}}' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
Tax
GET
Get all tax bands
{{mainUrl}}taxbands
Returns a collection of tax band models containing all tax bands in the system.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get all tax bands
curl --location -g --request GET '{{mainUrl}}taxbands' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get tax band by id
{{mainUrl}}taxbands/{{id}}
Returns a tax band model related to the id passed.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get tax band by id
curl --location -g --request GET '{{mainUrl}}taxbands/{{id}}' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
Number Profiles
GET
Get all number profiles
{{mainUrl}}numberprofiles
Returns a collection of number profile models containing all number profiles in
the system.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get all number profiles
curl --location -g --request GET '{{mainUrl}}numberprofiles' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get profile by id
{{mainUrl}}numberprofiles/{{id}}
Returns a profile model related to the id passed.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get profile by id
curl --location -g --request GET '{{mainUrl}}numberprofiles/{{id}}' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
Payment Types
GET
Get all payment types
{{mainUrl}}paymenttypes
Returns a collection of payment type models containing all payment types in the
system.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get all payment types
curl --location -g --request GET '{{mainUrl}}paymenttypes' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get payment type by id
{{mainUrl}}paymenttypes/{{id}}
Returns a payment type model related to the id passed.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get payment type by id
curl --location -g --request GET '{{mainUrl}}paymenttypes/{{id}}' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Search payment types
{{mainUrl}}paymenttypes/search?name={{name}}
Returns a collection of payment type models containing payment types related to
the search text.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
PARAMS
name
{{name}}
Example Request
Search payment types
curl --location -g --request GET '{{mainUrl}}paymenttypes/search?name={{name}}' \
--header 'customerKey: {{customerKey}}'
Bundles
GET
Get all bundles
{{mainUrl}}billbundles
Returns a collection of bundle models containing all bundles in the system.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get all bundles
curl --location -g --request GET '{{mainUrl}}billbundles' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get bundle by id
{{mainUrl}}billbundles/{{bundle_id}}
Returns a bundle model related to the id passed.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get bundle by id
curl --location -g --request GET '{{mainUrl}}billbundles/{{bundle_id}}' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get bundle by phone number
{{mainUrl}}billbundles/telid/{{telid}}
Returns a collection of bundle models related to the phone number id passed.
AUTHORIZATIONOAuth 2.0
Access Token
<access-token>
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get bundle by phone number
curl --location -g --request GET '{{mainUrl}}billbundles/telid/{{telid}}' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
Bill Styles
GET
Get all bill styles
{{mainUrl}}billstyles
Returns a collection of bill style models containing all bill styles in the
system.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get all bill styles
curl --location -g --request GET '{{mainUrl}}billstyles' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get bill style by id
{{mainUrl}}billstyles/{{id}}
Returns a bill style model related to the id passed.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get bill style by id
curl --location -g --request GET '{{mainUrl}}billstyles/{{id}}' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
Analysis
GET
Get Analysis styles
{{mainUrl}}analysisstyles
Returns a collection of analysis style models containing all styles in the
system.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get Analysis styles
curl --location -g --request GET '{{mainUrl}}analysisstyles' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get Analysis styles by id
{{mainUrl}}analysisstyles/{{id}}
Returns an analysis style model related to the id passed.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get Analysis styles by id
curl --location -g --request GET '{{mainUrl}}analysisstyles/{{id}}' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
Carriers
GET
Get all carriers
{{mainUrl}}carriers
Returns a collection of carrier models containing all carriers in the system.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get all carriers
curl --location -g --request GET '{{mainUrl}}carriers' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get all service providers
{{mainUrl}}serviceproviders
Returns a collection of service providers models containing all service
providers in the system.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get all service providers
curl --location -g --request GET '{{mainUrl}}serviceproviders' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
Account\Sales Managers
GET
Get all account managers
{{mainUrl}}accountmanagers
Returns a collection of account manager models containing all account mangers in
the system.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get all account managers
curl --location -g --request GET '{{mainUrl}}accountmanagers' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get account manager by id
{{mainUrl}}accountmanagers/{{id}}
Returns an account manager model related to the id passed.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
Content-Type
application/json
customerKey
{{customerKey}}
Example Request
Get account manager by id
curl --location -g --request GET '{{mainUrl}}accountmanagers/{{id}}' \
--header 'Content-Type: application/json' \
--header 'customerKey: {{customerKey}}' \
--data-raw ''
GET
Get all sales managers
{{mainUrl}}salesmanagers
Returns a collection of sales manager models containing all sales managers in
the system.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Example Request
Get all sales managers
curl --location -g --request GET '{{mainUrl}}salesmanagers' \
--header 'customerKey: {{customerKey}}'
GET
Get sales manager by id
{{mainUrl}}accountmanagers/{{id}}
Returns a sales manager model related to the id passed.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
CustomerKey
{{customerKey}}
Example Request
Get sales manager by id
curl --location -g --request GET '{{mainUrl}}accountmanagers/{{id}}' \
--header 'CustomerKey: {{customerKey}}'
Archives
GET
Archives
{{mainUrl}}Archive/
Returns a collection of archive models that you have access to. The id(s) of
these models can be used when calling endpoints that require access to archived
data.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Archives
curl --location -g --request GET '{{mainUrl}}Archive/' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
Profit and Loss by Supplier
GET
Get profit and loss by supplier current month
{{mainUrl}}Supplier/ProfitAndLoss
Returns a collection of supplier profit and loss models containing profit and
loss data by supplier for the current month.
AUTHORIZATIONOAuth 2.0
Access Token
<access-token>
HEADERS
NG-APIKey
56e494e4-ae1b-4221-8154-2e712fbe307a
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get profit and loss by supplier current month
curl --location -g --request GET '{{mainUrl}}Supplier/ProfitAndLoss' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get profit and loss by supplier archive month
{{mainUrl}}Supplier/ProfitAndLoss/{{achivemonthid}}
Returns a collection of supplier profit and loss models containing profit and
loss data by supplier contained in the archive month (the archive id can be
obtained by calling the Archives end point)
AUTHORIZATIONOAuth 2.0
Access Token
<access-token>
HEADERS
NG-APIKey
56e494e4-ae1b-4221-8154-2e712fbe307a
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get profit and loss by supplier archive month
curl --location -g --request GET '{{mainUrl}}Supplier/ProfitAndLoss/{{achivemonthid}}' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
Line Types
GET
Search line type for fixed number
{{mainUrl}}phonenumbers/phonetypes
Returns a collection of line type models that are related to fixed number types.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Example Request
Search line type for fixed number
curl --location -g --request GET '{{mainUrl}}phonenumbers/phonetypes' \
--header 'customerKey: {{customerKey}}'
Invoices
GET
Sales Invoices
{{mainUrl}}Invoice/SalesInvoices
Returns a collection of sales invoice models containing sales invoice data
related to the serach criteria passed.
The search criteria is made up of:
* FromDate: If filled in will return sales invoices where the invoice date is
greater than or equal to the date passed.
* ToDate: If filled in will return sales invoices where the invoice date is
less than or equal to the date passed.
* CustomerId: If filled in will return sales invoices where customerId is equal
to the id passed.
* InvoiceNo: If filled in will return sales invoices where the invoice number
is equal to that passed.
* PONumber: If filled in will return sales invoices where the PO number is
equal to that passed.
* CustRef: If filled in will return sales invoices where the customer reference
number is equal to that passed.
Please note that combining these fields will narrow down the results passed
back.
AUTHORIZATIONOAuth 2.0
Access Token
<access-token>
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
BODYraw
{
"FromDate": null,
"ToDate": null,
"CustomerId": 1612,
"InvoiceNo": null,
"PONumber": null,
"CustRef": null
}
Example Request
Sales Invoices
View More
curl --location -g --request GET '{{mainUrl}}Invoice/SalesInvoices' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"FromDate": null,
"ToDate": null,
"CustomerId": 1612,
"InvoiceNo": null,
"PONumber": null,
"CustRef": null
}'
GET
Get all recurring invoices current month
{{mainUrl}}Invoice/RecurringInvoices
Returns a collection of recurring invoice models containing recurring invoices
in the current month.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
Example Request
Get all recurring invoices current month
curl --location -g --request GET '{{mainUrl}}Invoice/RecurringInvoices' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get all recurring invoices archive month
{{mainUrl}}Invoice/RecurringInvoices?dbId={{archivemonthid}}
Returns a collection of recurring invoice models containing recurring invoices
in the archive month specified.
You can call the Archives end point to get the id(s) of the archives to query in
this call.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
PARAMS
dbId
{{archivemonthid}}
Example Request
Get all recurring invoices archive month
curl --location -g --request GET '{{mainUrl}}Invoice/RecurringInvoices?dbId={{archivemonthid}}' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw ''
GET
Get all invoices
{{mainUrl}}Invoice
Returns a collection of invoice models containing historical sales and recurring
invoice data. Please note current cycle recurring invoice models will be
returned where the invoice has been finalised and emailed but be aware that this
could change if the user(s) roll the invoices back in the billing platform.
AUTHORIZATIONOAuth 2.0
Access Token
{{token}}
HEADERS
customerKey
{{customerKey}}
Content-Type
application/json
BODYraw
{
"CustomerId": 144,
"FromDate": "",
"ToDate": "",
"StartInvoiceNo": null,
"EndInvoiceNo": null,
"PONumber": null
}
Example Request
Get all invoices
View More
curl --location -g --request GET '{{mainUrl}}Invoice' \
--header 'customerKey: {{customerKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"CustomerId": 144,
"FromDate": "",
"ToDate": "",
"StartInvoiceNo": null,
"EndInvoiceNo": null,
"PONumber": null
}'