Bill Run History

What can you do with BillRunHistory?


Properties

Property Details
id
"id": 457
Type: Number
This is the unique numeric identifier for the BillRunHistory
ownerId
"ownerId": 144
Type: Number
Unique identifier for the associated Owner object.
billRunId
"billRunId": 927
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": 371
Type: Number
billingQueued
"billingQueued": 914
Type: Number
billingProcessed
"billingProcessed": 839
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": 722
Type: Number
invoicingQueued
"invoicingQueued": 362
Type: Number
invoicingProcessed
"invoicingProcessed": 391
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": 391
Type: Number
renderQueued
"renderQueued": 851
Type: Number
renderProcessed
"renderProcessed": 209
Type: Number
complete
"complete": true
Type: Boolean
billRunScheduleId
"billRunScheduleId": 987
Type: Number
Unique identifier for the associated BillRunSchedule object.
billingErrorCount
"billingErrorCount": 682
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": 884
Type: Number
usageQueued
"usageQueued": 501
Type: Number
usageProcessed
"usageProcessed": 444
Type: Number
usageErrorCount
"usageErrorCount": 189
Type: Number
usageError
"usageError": "Hello World"
Type: String
invoicingErrorCount
"invoicingErrorCount": 203
Type: Number
invoicingError
"invoicingError": "Hello World"
Type: String
renderErrorCount
"renderErrorCount": 169
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": 689
Type: Number
termQueued
"termQueued": 883
Type: Number
termProcessed
"termProcessed": 453
Type: Number
termErrorCount
"termErrorCount": 870
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": 910
Type: Number
contractQueued
"contractQueued": 188
Type: Number
contractProcessed
"contractProcessed": 883
Type: Number
contractErrorCount
"contractErrorCount": 709
Type: Number
contractError
"contractError": "Hello World"
Type: String
currencyExchangeId
"currencyExchangeId": 320
Type: Number
Unique identifier for the associated CurrencyExchange 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:

  • 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
  • currencyExchangeId
  • contract
  • contractStart
  • contractEnd
  • contractCount
  • contractQueued
  • contractProcessed
  • contractErrorCount
  • contractError

DataFlow PATCH objects:


End Points

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