TAG LINE
SMALL TITLE

Bill Run / Schedule

(API Version v2)


What can you do with BillRunSchedule?


Properties

Property Details
id
"id": 7
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": 10
Type: Number
Unique identifier for the associated BillRun object.
billRunScheduleStatusTypeId
"billRunScheduleStatusTypeId": 8
Type: Number
Unique identifier for the associated BillRunScheduleStatusType object.
accountId
"accountId": 23
Type: Number
Unique identifier for the associated Account object.
periodStart
"periodStart": "2005-04-11T14:56:24"
Type: Date
periodEnd
"periodEnd": "2005-04-11T14:56:24"
Type: Date
createdByUserId
"createdByUserId": 15
Type: Number
Unique identifier for the associated User object.
orderId
"orderId": 16
Type: Number
Unique identifier for the associated Order 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
  • periodStart
  • periodEnd
  • createdByUserId
  • orderId

DataFlow PATCH objects:


End Points

DELETEapi/v2/BillRun/Schedule/{id:int}
Delete an instance of the BillRunSchedule object.
GETapi/v2/BillRun/Schedule
Retrieve all of the BillRunSchedule objects.
GETapi/v2/BillRun/Schedule/Paged
Retreive all of the BillRunSchedule objects in a paged fashion.
GETapi/v2/BillRun/Schedule/{id:int}
Retrieve an instance of the BillRunSchedule object by it's ID.
{id:int}Unique identifier for the BillRunSchedule object.
POSTapi/v2/BillRun/Schedule
Create a new instance of the BillRunSchedule object.
PUTapi/v2/BillRun/Schedule/{id:int}
Update an existing instance of the BillRunSchedule object.
PUTapi/v2/BillRun/Schedule/{id:int}/Cancel
Update an existing instance of a Cancel object that belongs to the BillRunSchedule.
{id:int}Unique identifier for the BillRunSchedule object.