TAG LINE
SMALL TITLE
| id | "id": 20 Type: Number This is the unique numeric identifier for the BillRunHistory |
| ownerId | "ownerId": 6 Type: Number Unique identifier for the associated Owner object. |
| billRunId | "billRunId": 15 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": 8 Type: Number |
| billingQueued | "billingQueued": 1 Type: Number |
| billingProcessed | "billingProcessed": 7 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": 5 Type: Number |
| invoicingProcessed | "invoicingProcessed": 18 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": 4 Type: Number |
| renderQueued | "renderQueued": 15 Type: Number |
| renderProcessed | "renderProcessed": 22 Type: Number |
| complete | "complete": true Type: Boolean |
| billRunScheduleId | "billRunScheduleId": 16 Type: Number Unique identifier for the associated BillRunSchedule object. |
| billingErrorCount | "billingErrorCount": 2 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": 1 Type: Number |
| usageQueued | "usageQueued": 21 Type: Number |
| usageProcessed | "usageProcessed": 15 Type: Number |
| usageErrorCount | "usageErrorCount": 19 Type: Number |
| usageError | "usageError": "Hello World" Type: String |
| invoicingErrorCount | "invoicingErrorCount": 1 Type: Number |
| invoicingError | "invoicingError": "Hello World" Type: String |
| renderErrorCount | "renderErrorCount": 27 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": 7 Type: Number |
| termQueued | "termQueued": 11 Type: Number |
| termProcessed | "termProcessed": 20 Type: Number |
| termErrorCount | "termErrorCount": 0 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": 23 Type: Number |
| contractQueued | "contractQueued": 2 Type: Number |
| contractProcessed | "contractProcessed": 23 Type: Number |
| contractErrorCount | "contractErrorCount": 6 Type: Number |
| contractError | "contractError": "Hello World" Type: String |
| currencyExchangeId | "currencyExchangeId": 9 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": 6 Type: Number |
| deliveryQueued | "deliveryQueued": 20 Type: Number |
| deliveryProcessed | "deliveryProcessed": 3 Type: Number |
| deliveryErrorCount | "deliveryErrorCount": 14 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": 2 Type: Number |
| paymentQueued | "paymentQueued": 12 Type: Number |
| paymentProcessed | "paymentProcessed": 6 Type: Number |
| paymentErrorCount | "paymentErrorCount": 11 Type: Number |
| paymentError | "paymentError": "Hello World" Type: String |
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:
DataFlow PATCH objects:
| GET | api/v2/BillRun/History |
| Retrieve all of the BillRunHistory objects. | |
| GET | api/v2/BillRun/History/Paged |
| Retreive all of the BillRunHistory objects in a paged fashion. | |
| GET | api/v2/BillRun/History/{id:int} |
| Retrieve an instance of the BillRunHistory object by it's ID. | |
| {id:int} | Unique identifier for the BillRunHistory object. |