TAG LINE
SMALL TITLE

Bill Run / History

(API Version v3)


What can you do with BillRunHistory?


Properties

Property Details
id
"id": 9
Type: Number
This is the unique numeric identifier for the BillRunHistory
ownerId
"ownerId": 5
Type: Number
Unique identifier for the associated Owner object.
billRunId
"billRunId": 20
Type: Number
Unique identifier for the associated BillRun object.
name
"name": "Hello World"
Type: String
billing
"billing": true
Type: Boolean
billingStart
"billingStart": "2005-04-11T14:56:24"
Type: Date
billingEnd
"billingEnd": "2005-04-11T14:56:24"
Type: Date
billingCount
"billingCount": 20
Type: Number
billingQueued
"billingQueued": 22
Type: Number
billingProcessed
"billingProcessed": 22
Type: Number
invoicing
"invoicing": true
Type: Boolean
invoicingStart
"invoicingStart": "2005-04-11T14:56:24"
Type: Date
invoicingEnd
"invoicingEnd": "2005-04-11T14:56:24"
Type: Date
invoicingCount
"invoicingCount": 15
Type: Number
invoicingQueued
"invoicingQueued": 15
Type: Number
invoicingProcessed
"invoicingProcessed": 15
Type: Number
render
"render": true
Type: Boolean
renderStart
"renderStart": "2005-04-11T14:56:24"
Type: Date
renderEnd
"renderEnd": "2005-04-11T14:56:24"
Type: Date
renderCount
"renderCount": 6
Type: Number
renderQueued
"renderQueued": 8
Type: Number
renderProcessed
"renderProcessed": 16
Type: Number
complete
"complete": true
Type: Boolean
billRunScheduleId
"billRunScheduleId": 26
Type: Number
Unique identifier for the associated BillRunSchedule object.
billingErrorCount
"billingErrorCount": 21
Type: Number
billingError
"billingError": "Hello World"
Type: String
usage
"usage": true
Type: Boolean
usageStart
"usageStart": "2005-04-11T14:56:24"
Type: Date
usageEnd
"usageEnd": "2005-04-11T14:56:24"
Type: Date
usageCount
"usageCount": 8
Type: Number
usageQueued
"usageQueued": 7
Type: Number
usageProcessed
"usageProcessed": 3
Type: Number
usageErrorCount
"usageErrorCount": 13
Type: Number
usageError
"usageError": "Hello World"
Type: String
invoicingErrorCount
"invoicingErrorCount": 7
Type: Number
invoicingError
"invoicingError": "Hello World"
Type: String
renderErrorCount
"renderErrorCount": 16
Type: Number
renderError
"renderError": "Hello World"
Type: String
term
"term": true
Type: Boolean
termRetry
"termRetry": true
Type: Boolean
termStart
"termStart": "2005-04-11T14:56:24"
Type: Date
termEnd
"termEnd": "2005-04-11T14:56:24"
Type: Date
termCount
"termCount": 20
Type: Number
termQueued
"termQueued": 22
Type: Number
termProcessed
"termProcessed": 1
Type: Number
termErrorCount
"termErrorCount": 12
Type: Number
termError
"termError": "Hello World"
Type: String
contract
"contract": true
Type: Boolean
contractStart
"contractStart": "2005-04-11T14:56:24"
Type: Date
contractEnd
"contractEnd": "2005-04-11T14:56:24"
Type: Date
contractCount
"contractCount": 10
Type: Number
contractQueued
"contractQueued": 16
Type: Number
contractProcessed
"contractProcessed": 0
Type: Number
contractErrorCount
"contractErrorCount": 25
Type: Number
contractError
"contractError": "Hello World"
Type: String
currencyExchangeId
"currencyExchangeId": 27
Type: Number
Unique identifier for the associated CurrencyExchange object.
delivery
"delivery": true
Type: Boolean
deliveryStart
"deliveryStart": "2005-04-11T14:56:24"
Type: Date
deliveryEnd
"deliveryEnd": "2005-04-11T14:56:24"
Type: Date
deliveryCount
"deliveryCount": 11
Type: Number
deliveryQueued
"deliveryQueued": 24
Type: Number
deliveryProcessed
"deliveryProcessed": 17
Type: Number
deliveryErrorCount
"deliveryErrorCount": 26
Type: Number
deliveryError
"deliveryError": "Hello World"
Type: String
payment
"payment": true
Type: Boolean
paymentStart
"paymentStart": "2005-04-11T14:56:24"
Type: Date
paymentEnd
"paymentEnd": "2005-04-11T14:56:24"
Type: Date
paymentCount
"paymentCount": 14
Type: Number
paymentQueued
"paymentQueued": 21
Type: Number
paymentProcessed
"paymentProcessed": 10
Type: Number
paymentErrorCount
"paymentErrorCount": 17
Type: Number
paymentError
"paymentError": "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:

  • billRunId
  • name
  • billing
  • billingStart
  • billingEnd
  • billingCount
  • billingQueued
  • billingProcessed
  • invoicing
  • invoicingStart
  • invoicingEnd
  • invoicingCount
  • invoicingQueued
  • invoicingProcessed
  • render
  • renderStart
  • renderEnd
  • renderCount
  • renderQueued
  • renderProcessed
  • complete
  • billRunScheduleId
  • billingErrorCount
  • billingError
  • usage
  • usageStart
  • usageEnd
  • usageCount
  • usageQueued
  • usageProcessed
  • usageErrorCount
  • usageError
  • invoicingErrorCount
  • invoicingError
  • renderErrorCount
  • renderError
  • term
  • termRetry
  • termStart
  • termEnd
  • termCount
  • termQueued
  • termProcessed
  • termErrorCount
  • termError
  • contract
  • contractStart
  • contractEnd
  • contractCount
  • contractQueued
  • contractProcessed
  • contractErrorCount
  • contractError
  • currencyExchangeId
  • delivery
  • deliveryStart
  • deliveryEnd
  • deliveryCount
  • deliveryQueued
  • deliveryProcessed
  • deliveryErrorCount
  • deliveryError
  • payment
  • paymentStart
  • paymentEnd
  • paymentCount
  • paymentQueued
  • paymentProcessed
  • paymentErrorCount
  • paymentError

DataFlow PATCH objects:


End Points

GETapi/v3/BillRun/History
Retrieve all of the BillRunHistory objects.
GETapi/v3/BillRun/History/Paged
Retreive all of the BillRunHistory objects in a paged fashion.
GETapi/v3/BillRun/History/{id:int}
Retrieve an instance of the BillRunHistory object by it's ID.
{id:int}Unique identifier for the BillRunHistory object.