Bill Run

What can you do with BillRun?


Properties

Property Details
id
"id": 76
Type: Number
This is the unique numeric identifier for the BillRun
billPeriodEnd
"billPeriodEnd": "2005-04-11T14:56:24"
Type: Date
billPeriodStart
"billPeriodStart": "2005-04-11T14:56:24"
Type: Date
ownerId
"ownerId": 635
Type: Number
Unique identifier for the associated Owner object.
runBilling
"runBilling": true
Type: Boolean
runCreditCard
"runCreditCard": true
Type: Boolean
runAch
"runAch": true
Type: Boolean
name
"name": "Hello World"
Type: String
runDelivery
"runDelivery": true
Type: Boolean
runRenderInvoice
"runRenderInvoice": true
Type: Boolean
runPaymentTerm
"runPaymentTerm": true
Type: Boolean
runBillUsage
"runBillUsage": true
Type: Boolean
enabled
"enabled": true
Type: Boolean
runPaymentRetryTerms
"runPaymentRetryTerms": true
Type: Boolean
runCreditCardToken
"runCreditCardToken": true
Type: Boolean
runAchToken
"runAchToken": true
Type: Boolean
collectionTypeId
"collectionTypeId": 870
Type: Number
Unique identifier for the associated CollectionType object.
runInvoicing
"runInvoicing": true
Type: Boolean
currencyExchangeId
"currencyExchangeId": 11
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:

  • billPeriodEnd
  • billPeriodStart
  • runBilling
  • runCreditCard
  • runACH
  • name
  • runDelivery
  • runRenderInvoice
  • runPaymentTerm
  • runBillUsage
  • enabled
  • runPaymentRetryTerms
  • runCreditCardToken
  • runACHToken
  • collectionTypeId
  • runInvoicing
  • currencyExchangeId

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the BillRun object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v1/BillRun/{id:int}
Delete an instance of the BillRun object.
GETapi/v1/BillRun
Retrieve all of the BillRun objects.
GETapi/v1/BillRun/Metadata
Retrieve all of the meta data details of the BillRun object.
GETapi/v1/BillRun/Metadata/{option}
Retrieve all the meta data details of the BillRun object based on provided options.
{option}Metadata options for the BillRun object.
GETapi/v1/BillRun/Paged
Retreive all of the BillRun objects in a paged fashion.
GETapi/v1/BillRun/Paged/Detail
Retreive all of the BillRun objects in a paged fashion with all object details.
GETapi/v1/BillRun/{id:int}
Retrieve an instance of the BillRun object by it's ID.
{id:int}Unique identifier for the BillRun object.
GETapi/v1/BillRun/{id:int}/Detail
Retreive all of the Detail objects for the specified BillRun.
{id:int}Unique identifier for the BillRun object.
PATCHapi/v1/BillRun/{id:int}
Update the BillRun object and optionally make changes to any child objects.
POSTapi/v1/BillRun
Create a new instance of the BillRun object.
PUTapi/v1/BillRun/{id:int}
Update an existing instance of the BillRun object.