Account / Package (View)

What can you do with ViewAccountPackage?


Properties

Property Details
id
"id": 774
Type: Number
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
inheritedEffectiveCancel
"inheritedEffectiveCancel": "2005-04-11T14:56:24"
Type: Date
accountPackageStatusTypeId
"accountPackageStatusTypeId": 574
Type: Number
accountPackageStatusTypeName
"accountPackageStatusTypeName": "Hello World"
Type: String
termsId
"termsId": 228
Type: Number
termsName
"termsName": "Hello World"
Type: String
createdByUserId
"createdByUserId": 899
Type: Number
createdByUserName
"createdByUserName": "Hello World"
Type: String
billDay
"billDay": 597
Type: Number
inheritedBillDay
"inheritedBillDay": 408
Type: Number
updatedByUserId
"updatedByUserId": 916
Type: Number
updatedByUserName
"updatedByUserName": "Hello World"
Type: String
usageBillDay
"usageBillDay": 231
Type: Number
inheritedUsageBillDay
"inheritedUsageBillDay": 311
Type: Number
accountId
"accountId": 764
Type: Number
accountName
"accountName": "Hello World"
Type: String
accountEffectiveCancel
"accountEffectiveCancel": "2005-04-11T14:56:24"
Type: Date
accountInvoicerAccountId
"accountInvoicerAccountId": 632
Type: Number
accountInvoicerName
"accountInvoicerName": "Hello World"
Type: String
accountUsageInvoicerAccountId
"accountUsageInvoicerAccountId": 822
Type: Number
accountUsageInvoicerName
"accountUsageInvoicerName": "Hello World"
Type: String
accountTaxSettingAccountId
"accountTaxSettingAccountId": 235
Type: Number
accountTaxSettingName
"accountTaxSettingName": "Hello World"
Type: String
packageId
"packageId": 288
Type: Number
packageName
"packageName": "Hello World"
Type: String
packageFrequencyId
"packageFrequencyId": 371
Type: Number
packageFrequencyName
"packageFrequencyName": "Hello World"
Type: String
packageFrequencyFrequency
"packageFrequencyFrequency": 211
Type: Number
packageFrequencyIsActive
"packageFrequencyIsActive": true
Type: Boolean
frequencyTypeId
"frequencyTypeId": 226
Type: Number
frequencyTypeName
"frequencyTypeName": "Hello World"
Type: String
billGroupId
"billGroupId": 334
Type: Number
billGroupName
"billGroupName": "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:

  • amount
  • created
  • nextBill
  • name
  • oneTimeAmount
  • lastStatusChanged
  • effective
  • canceled
  • updated
  • effectiveCancel
  • inheritedEffectiveCancel
  • accountPackageStatusTypeId
  • accountPackageStatusTypeName
  • termsId
  • termsName
  • createdByUserId
  • createdByUserName
  • billDay
  • inheritedBillDay
  • updatedByUserId
  • updatedByUserName
  • usageBillDay
  • inheritedUsageBillDay
  • accountId
  • accountName
  • accountEffectiveCancel
  • accountInvoicerAccountId
  • accountInvoicerName
  • accountUsageInvoicerAccountId
  • accountUsageInvoicerName
  • accountTaxSettingAccountId
  • accountTaxSettingName
  • packageId
  • packageName
  • packageFrequencyId
  • packageFrequencyName
  • packageFrequencyFrequency
  • packageFrequencyIsActive
  • frequencyTypeId
  • frequencyTypeName
  • billGroupId
  • billGroupName

End Points

GETapi/v1/Account/Package/View
Retrieve all of the ViewAccountPackage objects.
GETapi/v1/Account/Package/View/Metadata
Retrieve all of the meta data details of the ViewAccountPackage object.
GETapi/v1/Account/Package/View/Metadata/{option}
Retrieve all the meta data details of the ViewAccountPackage object based on provided options.
{option}Metadata options for the ViewAccountPackage object.
GETapi/v1/Account/Package/View/Paged
Retreive all of the ViewAccountPackage objects in a paged fashion.
GETapi/v1/Account/Package/View/{id:int}
Retrieve an instance of the ViewAccountPackage object by it's ID.
{id:int}Unique identifier for the ViewAccountPackage object.