Account / Package

What can you do with AccountPackage?


Properties

Property Details
id
"id": 113
Type: Number
This is the unique numeric identifier for the AccountPackage
accountId
"accountId": 451
Type: Number
Unique identifier for the associated Account object.
amount
"amount": "Hello World"
Type: String
created
"created": "2005-04-11T14:56:24"
Type: Date
nextBill
"nextBill": "2005-04-11T14:56:24"
Type: Date
name
"name": "Hello World"
Type: String
oneTimeAmount
"oneTimeAmount": "Hello World"
Type: String
lastStatusChanged
"lastStatusChanged": "2005-04-11T14:56:24"
Type: Date
effective
"effective": "2005-04-11T14:56:24"
Type: Date
canceled
"canceled": "2005-04-11T14:56:24"
Type: Date
updated
"updated": "2005-04-11T14:56:24"
Type: Date
effectiveCancel
"effectiveCancel": "2005-04-11T14:56:24"
Type: Date
accountPackageStatusTypeId
"accountPackageStatusTypeId": 299
Type: Number
Unique identifier for the associated AccountPackageStatusType object.
packageFrequencyId
"packageFrequencyId": 306
Type: Number
Unique identifier for the associated PackageFrequency object.
termsId
"termsId": 983
Type: Number
Unique identifier for the associated Terms object.
createdByUserId
"createdByUserId": 23
Type: Number
Unique identifier for the associated User object.
billDay
"billDay": 192
Type: Number
updatedByUserId
"updatedByUserId": 441
Type: Number
Unique identifier for the associated User object.
usageBillDay
"usageBillDay": 174
Type: Number


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:

  • accountId
  • amount
  • created
  • nextBill
  • name
  • oneTimeAmount
  • lastStatusChanged
  • effective
  • canceled
  • updated
  • effectiveCancel
  • accountPackageStatusTypeId
  • packageFrequencyId
  • termsId
  • createdByUserId
  • billDay
  • updatedByUserId
  • usageBillDay

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 AccountPackage object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

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