PUT api/admin/v1/BillingFlows/{billingFlowId}
Update an existing Billing Flow
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| billingFlowId |
ID of the Billing Flows |
integer |
Required |
Body Parameters
New Billing Flow informations
BillingFlowEditDto| Name | Description | Type | Additional information |
|---|---|---|---|
| ContractTypeId |
ID of the type of the contract (optional) |
integer |
None |
| DefaultAmount |
Default amount |
decimal number |
None |
| HoursDivider |
Hours divider |
decimal number |
None |
| IsPercentuage |
True if is a percentuage amount |
boolean |
None |
| IsFixedAmount |
True if is a fixed amount |
boolean |
None |
| IsHourly |
True if is an hourly amount |
boolean |
None |
| IsDaily |
True if is a daily amount |
boolean |
None |
| Code |
The short code of the element |
string |
None |
| Description |
The description of the element |
string |
None |
| IsActive |
True if the element is active, false otherwise |
boolean |
None |
| Id |
Unique ID |
integer |
None |
Request Formats
application/json, text/json
Sample:
{
"ContractTypeId": 1,
"DefaultAmount": 1.0,
"HoursDivider": 2.0,
"IsPercentuage": true,
"IsFixedAmount": true,
"IsHourly": true,
"IsDaily": true,
"Code": "sample string 7",
"Description": "sample string 8",
"IsActive": true,
"Id": 10
}
application/xml, text/xml
Sample:
<BillingFlowEditDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oryx.Web.Api.Models"> <Id>10</Id> <Code>sample string 7</Code> <Description>sample string 8</Description> <IsActive>true</IsActive> <ContractTypeId>1</ContractTypeId> <DefaultAmount>1</DefaultAmount> <HoursDivider>2</HoursDivider> <IsDaily>true</IsDaily> <IsFixedAmount>true</IsFixedAmount> <IsHourly>true</IsHourly> <IsPercentuage>true</IsPercentuage> </BillingFlowEditDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
200
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None |
|
| Content | HttpContent |
None |
|
| StatusCode | HttpStatusCode |
None |
|
| ReasonPhrase | string |
None |
|
| Headers | Collection of Object |
None |
|
| RequestMessage | HttpRequestMessage |
None |
|
| IsSuccessStatusCode | boolean |
None |