TAG LINE
SMALL TITLE

Account / Service / Current

(API Version v2)


What can you do with AccountService?


Properties

Property Details
id
"id": "Hello World"
Type: String
This is the unique numeric identifier for the AccountService
serviceId
"serviceId": 8
Type: Number
Unique identifier for the associated Service object.
accountId
"accountId": 4
Type: Number
Unique identifier for the associated Account object.
created
"created": "2005-04-11T14:56:24"
Type: Date
accountPackageId
"accountPackageId": "Hello World"
Type: String
Unique identifier for the associated AccountPackage object.
name
"name": "Hello World"
Type: String
usageBillDay
"usageBillDay": 25
Type: Number
amount
"amount": "Hello World"
Type: String
oneTimeAmount
"oneTimeAmount": "Hello World"
Type: String
updated
"updated": "2005-04-11T14:56:24"
Type: Date
effective
"effective": "2005-04-11T14:56:24"
Type: Date
posted
"posted": "2005-04-11T14:56:24"
Type: Date
createdByUserId
"createdByUserId": 7
Type: Number
Unique identifier for the associated User object.
updatedByUserId
"updatedByUserId": 24
Type: Number
Unique identifier for the associated User object.
effectiveCancel
"effectiveCancel": "2005-04-11T14:56:24"
Type: Date
usageNextBill
"usageNextBill": "2005-04-11T14:56:24"
Type: Date
usageFinalBill
"usageFinalBill": "2005-04-11T14:56:24"
Type: Date
finalBill
"finalBill": "2005-04-11T14:56:24"
Type: Date
lastBilled
"lastBilled": "2005-04-11T14:56:24"
Type: Date
lastUsageBilled
"lastUsageBilled": "2005-04-11T14:56:24"
Type: Date
addOnPackageFrequencyId
"addOnPackageFrequencyId": 11
Type: Number
Unique identifier for the associated PackageFrequency object.
id
"id": "Hello World"
Type: String
serviceType
"serviceType": "Hello World"
Type: String


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • serviceId
  • accountId
  • accountPackageId
  • name
  • usageBillDay
  • amount
  • oneTimeAmount
  • effective
  • posted
  • effectiveCancel
  • usageNextBill
  • usageFinalBill
  • finalBill
  • serviceType

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the AccountService object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v2/Account/Service/{id:long}
Delete an instance of the AccountService object.
GETapi/v2/Account/Service
Retrieve all of the AccountService objects.
GETapi/v2/Account/Service/Paged
Retreive all of the AccountService objects in a paged fashion.
GETapi/v2/Account/Service/Paged/Detail
Retreive all of the AccountService objects in a paged fashion with all object details.
GETapi/v2/Account/Service/{id:long}
Retrieve all of the AccountService objects.
GETapi/v2/Account/Service/{id:long}/Detail
Retrieve all of the AccountService objects.
PATCHapi/v2/Account/Service/{id:long}
Update the AccountService object and optionally make changes to any child objects.
POSTapi/v2/Account/Service
Create a new instance of the AccountService object.
PUTapi/v2/Account/Service/{id:long}
Update an existing instance of the AccountService object.