TAG LINE
SMALL TITLE

Bill Run / Schedule

(API Version v2)


The Bill Run Schedule holds information for any one-off or recurring scheduled Bill Runs.


What can you do with BillRunSchedule?


Properties

Property Details
identity
READ-ONLY
"identity": 25
Type: Number
This is the unique numeric identifier for the BillRunSchedule
created
READ-ONLY
"created": "2021-04-26T15:25:27.587Z"
Type: Date
This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format.
start
READ-ONLY
"start": "2021-04-26T15:25:27.587Z"
Type: Date
The time stamp when this Bill Run Schedule started.

Date and time values are specified in the ISO 8601 format.
complete
READ-ONLY
"complete": "2021-04-26T15:25:27.587Z"
Type: Date
The time stamp when this Bill Run Schedule completed.

Date and time values are specified in the ISO 8601 format.
billRunId
"billRunId": 9
Type: Number
Unique identifier for the associated BillRun object.
billRunName
"billRunName": "Sample Name"
Type: String
The name of the object associated with the billRunId property.
billRunScheduleStatusTypeId
"billRunScheduleStatusTypeId": 21
Type: Number
Unique identifier for the associated BillRunScheduleStatusType object.
billRunScheduleStatusTypeName
"billRunScheduleStatusTypeName": "Sample Name"
Type: String
The name of the object associated with the billRunScheduleStatusTypeId property.
accountId
"accountId": 3
Type: Number
This property would be used in a one-off Bill Run for a specific Account.

Unique identifier for the associated Account object.
accountName
"accountName": "Sample Name"
Type: String
The name of the object associated with the accountId property.
periodStart
"periodStart": "2021-04-26T15:25:27.587Z"
Type: Date
Start date for the billing period.

Date and time values are specified in the ISO 8601 format.
periodEnd
"periodEnd": "2021-04-26T15:25:27.587Z"
Type: Date
End date for the billing period.

Date and time values are specified in the ISO 8601 format.
createdByUserId
"createdByUserId": 5
Type: Number
Unique identifier for the associated User object.
createdByUserName
"createdByUserName": "Sample Name"
Type: String
The name of the object associated with the createdByUserId property.
orderId
"orderId": 9
Type: Number
This property would be used in a one-off Bill Run for a specific Order.

Unique identifier for the associated Order object.
orderName
"orderName": "Sample Name"
Type: String
The name of the object associated with the orderId property.
parentBillRunId
"parentBillRunId": 9
Type: Number
Unique identifier for the associated BillRun object.
parentBillRunName
"parentBillRunName": "Sample Name"
Type: String
The name of the object associated with the parentBillRunId property.
scheduleId
"scheduleId": 8
Type: Number
Unique identifier for the associated Schedule object.
scheduleName
"scheduleName": "Sample Name"
Type: String
The name of the object associated with the scheduleId property.
billRunSettings
"billRunSettings": "Hello World"
Type: String


Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

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:

  • created
  • start
  • complete
  • billRunId
  • billRunScheduleStatusTypeId
  • accountId
  • periodStart
  • periodEnd
  • createdByUserId
  • orderId
  • parentBillRunId
  • scheduleId
  • billRunSettings

End Points

POSTapi/v2/BillRun/Schedule/{id}/Cancel
Cancel an existing BillRunSchedule based on the {id} provided.
{id}Unique identifier for the BillRunSchedule object.