TAG LINE
SMALL TITLE

Bill Group

(API Version v2)


What can you do with BillGroup?


Properties

Property Details
id
"id": 14
Type: Number
This is the unique numeric identifier for the BillGroup
name
"name": "Hello World"
Type: String
advanceInvoiceDays
"advanceInvoiceDays": 22
Type: Number
ownerId
"ownerId": 13
Type: Number
Unique identifier for the associated Owner object.
billDay
"billDay": 9
Type: Number
invoiceDateProcessTypeId
"invoiceDateProcessTypeId": 24
Type: Number
Unique identifier for the associated InvoiceDateProcessType object.
invoiceCloseThresholdAmount
"invoiceCloseThresholdAmount": "Hello World"
Type: String
usageBillingTypeId
"usageBillingTypeId": 25
Type: Number
Unique identifier for the associated UsageBillingType object.
invoiceDueDateTypeId
"invoiceDueDateTypeId": 20
Type: Number
Unique identifier for the associated InvoiceDueDateType object.
usageBillDay
"usageBillDay": 13
Type: Number
invoiceDeliveryId
"invoiceDeliveryId": 22
Type: Number
Unique identifier for the associated InvoiceDelivery 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:

  • name
  • advanceInvoiceDays
  • billDay
  • invoiceDateProcessTypeId
  • invoiceCloseThresholdAmount
  • usageBillingTypeId
  • invoiceDueDateTypeId
  • usageBillDay
  • invoiceDeliveryId

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 BillGroup object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

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