Account / Service

What can you do with AccountService?


Properties

Property Details
id
"id": 980
Type: Number
This is the unique numeric identifier for the AccountService
serviceId
"serviceId": 843
Type: Number
Unique identifier for the associated Service object.
accountId
"accountId": 727
Type: Number
Unique identifier for the associated Account object.
created
"created": "2005-04-11T14:56:24"
Type: Date
accountPackageId
"accountPackageId": 714
Type: Number
Unique identifier for the associated AccountPackage object.
name
"name": "Hello World"
Type: String
usageBillDay
"usageBillDay": 651
Type: Number
amount
"amount": "Hello World"
Type: String
oneTimeAmount
"oneTimeAmount": "Hello World"
Type: String
updated
"updated": "2005-04-11T14:56:24"
Type: Date
canceledDate
"canceledDate": "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
termsId
"termsId": 668
Type: Number
Unique identifier for the associated Terms object.
createdByUserId
"createdByUserId": 540
Type: Number
Unique identifier for the associated User object.
updatedByUserId
"updatedByUserId": 881
Type: Number
Unique identifier for the associated User object.
canceled
"canceled": "2005-04-11T14:56:24"
Type: Date
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


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
  • created
  • accountPackageId
  • name
  • usageBillDay
  • amount
  • oneTimeAmount
  • updated
  • canceled
  • effectiveCancel
  • effective
  • posted
  • termsId
  • createdByUserId
  • updatedByUserId
  • usageNextBill
  • usageFinalBill

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/v1/Account/Service/{id:int}
Delete an instance of the AccountService object.
GETapi/v1/Account/Service
Retrieve all of the AccountService objects.
GETapi/v1/Account/Service/Metadata
Retrieve all of the meta data details of the AccountService object.
GETapi/v1/Account/Service/Metadata/{option}
Retrieve all the meta data details of the AccountService object based on provided options.
{option}Metadata options for the AccountService object.
GETapi/v1/Account/Service/Paged
Retreive all of the AccountService objects in a paged fashion.
GETapi/v1/Account/Service/Paged/Detail
Retreive all of the AccountService objects in a paged fashion with all object details.
GETapi/v1/Account/Service/{id:int}
Retrieve an instance of the AccountService object by it's ID.
{id:int}Unique identifier for the AccountService object.
GETapi/v1/Account/Service/{id:int}/Detail
Retreive all of the Detail objects for the specified AccountService.
{id:int}Unique identifier for the AccountService object.
PATCHapi/v1/Account/Service/{id:int}
Update the AccountService object and optionally make changes to any child objects.
POSTapi/v1/Account/Service
Create a new instance of the AccountService object.
PUTapi/v1/Account/Service/{id:int}
Update an existing instance of the AccountService object.