Bill Run / Schedule

What can you do with BillRunSchedule?


Properties

Property Details
id
"id": 842
Type: Number
This is the unique numeric identifier for the BillRunSchedule
scheduledStart
"scheduledStart": "2005-04-11T14:56:24"
Type: Date
created
"created": "2005-04-11T14:56:24"
Type: Date
start
"start": "2005-04-11T14:56:24"
Type: Date
complete
"complete": "2005-04-11T14:56:24"
Type: Date
billRunId
"billRunId": 981
Type: Number
Unique identifier for the associated BillRun object.
billRunScheduleStatusTypeId
"billRunScheduleStatusTypeId": 999
Type: Number
Unique identifier for the associated BillRunScheduleStatusType object.
accountId
"accountId": 209
Type: Number
Unique identifier for the associated Account object.


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:

  • scheduledStart
  • created
  • start
  • complete
  • billRunId
  • billRunScheduleStatusTypeId
  • accountId

DataFlow PATCH objects:


End Points

DELETEapi/v1/BillRun/Schedule/{id:int}
Delete an instance of the BillRunSchedule object.
GETapi/v1/BillRun/Schedule
Retrieve all of the BillRunSchedule objects.
GETapi/v1/BillRun/Schedule/Metadata
Retrieve all of the meta data details of the BillRunSchedule object.
GETapi/v1/BillRun/Schedule/Metadata/{option}
Retrieve all the meta data details of the BillRunSchedule object based on provided options.
{option}Metadata options for the BillRunSchedule object.
GETapi/v1/BillRun/Schedule/Paged
Retreive all of the BillRunSchedule objects in a paged fashion.
GETapi/v1/BillRun/Schedule/{id:int}
Retrieve an instance of the BillRunSchedule object by it's ID.
{id:int}Unique identifier for the BillRunSchedule object.
POSTapi/v1/BillRun/Schedule
Create a new instance of the BillRunSchedule object.
PUTapi/v1/BillRun/Schedule/{id:int}
Update an existing instance of the BillRunSchedule object.