POST api/common/billrun

This method adds a new Bill Run

Request Information

URI Parameters

None.

Body Parameters

BillrunPostRequest
NameDescriptionTypeAdditional information
Name The Bill Run name string

Required

String length: inclusive between 0 and 50
AgentOnlyBillrun specify whether this bill run is for Agents only boolean

None.
Address The Invoice Address string

None.
WhiteLabelBillingCompanyId The ID of the White Label Billing Company integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "Name": "sample string 1",
  "AgentOnlyBillrun": true,
  "Address": "sample string 2",
  "WhiteLabelBillingCompanyId": 1
}

application/xml, text/xml

Sample: 
<BillrunPostRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/aBILLity.API.Models.Company">
  <Address>sample string 2</Address>
  <AgentOnlyBillrun>true</AgentOnlyBillrun>
  <Name>sample string 1</Name>
  <WhiteLabelBillingCompanyId>1</WhiteLabelBillingCompanyId>
</BillrunPostRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BillrunPostResponse
NameDescriptionTypeAdditional information
Id integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "Id": 1
}

application/xml, text/xml

Sample: 
<BillrunPostResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/aBILLity.API.Models.Company">
  <Id>1</Id>
</BillrunPostResponse>