GET api/admin/v1/BillingFlows/{billingFlowId}
Details of the Billing Flow
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| billingFlowId |
ID of the Billing Flow |
integer |
Required |
Body Parameters
None
Response Information
Resource Description
Billing Flows details
BillingFlowDto| Name | Description | Type | Additional information |
|---|---|---|---|
| ContractType |
The type of the contract |
ContractTypeMinDto |
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 |
| Permissions |
Permissions |
PermissionDto |
None |
| CreationDate |
Creation |
date |
None |
| CreatedBy |
The user who has made the insert |
UserMinDto |
None |
| LastUpdateDate |
Date of the last update |
date |
None |
| LastUpdatedBy |
The user who has made the last update |
UserMinDto |
None |
| Id |
Unique ID |
integer |
None |
Response Formats
application/json, text/json
Sample:
{
"ContractType": {
"Code": "sample string 1",
"Description": "sample string 2",
"Id": 3
},
"DefaultAmount": 1.0,
"HoursDivider": 2.0,
"IsPercentuage": true,
"IsFixedAmount": true,
"IsHourly": true,
"IsDaily": true,
"Code": "sample string 7",
"Description": "sample string 8",
"IsActive": true,
"Permissions": {
"CanModify": true,
"CanDelete": true
},
"CreationDate": "2024-11-01T19:38:49.1147208+01:00",
"CreatedBy": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"LastUpdateDate": "2024-11-01T19:38:49.1147208+01:00",
"LastUpdatedBy": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"Id": 10
}
application/xml, text/xml
Sample:
<BillingFlowDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oryx.Web.Api.Models">
<Id>10</Id>
<CreatedBy>
<Id>4</Id>
<Avatar>sample string 3</Avatar>
<FullName>sample string 2</FullName>
<Login>sample string 1</Login>
</CreatedBy>
<CreationDate>2024-11-01T19:38:49.1147208+01:00</CreationDate>
<LastUpdateDate>2024-11-01T19:38:49.1147208+01:00</LastUpdateDate>
<LastUpdatedBy>
<Id>4</Id>
<Avatar>sample string 3</Avatar>
<FullName>sample string 2</FullName>
<Login>sample string 1</Login>
</LastUpdatedBy>
<Code>sample string 7</Code>
<Description>sample string 8</Description>
<IsActive>true</IsActive>
<Permissions>
<CanDelete>true</CanDelete>
<CanModify>true</CanModify>
</Permissions>
<ContractType>
<Id>3</Id>
<Code>sample string 1</Code>
<Description>sample string 2</Description>
</ContractType>
<DefaultAmount>1</DefaultAmount>
<HoursDivider>2</HoursDivider>
<IsDaily>true</IsDaily>
<IsFixedAmount>true</IsFixedAmount>
<IsHourly>true</IsHourly>
<IsPercentuage>true</IsPercentuage>
</BillingFlowDto>