TAG LINE
TAG LINE
SMALL TITLE

Schedule

(API Version v9)


What can you do with Schedule?


Properties

Property Details
identity
READ-ONLY
"identity": 11
Type: Number
This is the unique numeric identifier for the Schedule
ownerId
READ-ONLY
"ownerId": 8
Type: Number
Unique identifier for the associated Owner object.
ownerName
READ-ONLY
"ownerName": "Sample Name"
Type: String
The name of the object associated with the ownerId property.
name
"name": "Hello World"
Type: String
firstScheduleStart
"firstScheduleStart": "2021-04-26T15:25:27.587Z"
Type: Date
Date and time values are specified in the ISO 8601 format.
scheduleEventTypeId
"scheduleEventTypeId": 10
Type: Number
Unique identifier for the associated ScheduleEventType object.
scheduleEventTypeName
"scheduleEventTypeName": "Sample Name"
Type: String
The name of the object associated with the scheduleEventTypeId property.
scheduleStatusTypeId
"scheduleStatusTypeId": 18
Type: Number
Unique identifier for the associated ScheduleStatusType object.
scheduleStatusTypeName
"scheduleStatusTypeName": "Sample Name"
Type: String
The name of the object associated with the scheduleStatusTypeId property.
frequency
"frequency": 13
Type: Number
monthlyRecurTypeId
"monthlyRecurTypeId": 4
Type: Number
Unique identifier for the associated MonthlyRecurType object.
monthlyRecurTypeName
"monthlyRecurTypeName": "Sample Name"
Type: String
The name of the object associated with the monthlyRecurTypeId property.
scheduleData
"scheduleData": "Hello World"
Type: String
scheduleFrequencyTypeId
"scheduleFrequencyTypeId": 8
Type: Number
Unique identifier for the associated ScheduleFrequencyType object.
scheduleFrequencyTypeName
"scheduleFrequencyTypeName": "Sample Name"
Type: String
The name of the object associated with the scheduleFrequencyTypeId property.


End Points

POSTSchedule/BillRun
Create a new instance of the Schedule object.
Create a new instance of the Schedule object.
POST Schedule/BillRun

{
    "name": "Sample Text Data",
    "firstScheduleStart": "2021-04-26T15:25:27.587Z",
    "scheduleEventTypeId": 5,
    "scheduleStatusTypeId": 6,
    "frequency": 9,
    "monthlyRecurTypeId": 23,
    "scheduleData": "Sample Text Data",
    "scheduleFrequencyTypeId": 7
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 12,
                "ownerName": "Sample Text Data",
                "name": "Sample Text Data",
                "firstScheduleStart": "2021-04-26T15:25:27.587Z",
                "scheduleEventTypeId": 18,
                "scheduleEventTypeName": "Sample Text Data",
                "scheduleStatusTypeId": 16,
                "scheduleStatusTypeName": "Sample Text Data",
                "frequency": 10,
                "monthlyRecurTypeId": 18,
                "monthlyRecurTypeName": "Sample Text Data",
                "scheduleData": "Sample Text Data",
                "scheduleFrequencyTypeId": 27,
                "scheduleFrequencyTypeName": "Sample Text Data"
            }
        ]
    }
}