GET api/admin/v1/RevenueFlows/search?q={q}&page={page}&pageSize={pageSize}&sortField={sortField}&sortAscending={sortAscending}

Search Revenue Flows by code or description

Request Information

URI Parameters

NameDescriptionTypeAdditional information
q

Text to search (code, description)

 string

Required
page

Current page

 integer

Default value is 1
pageSize

Page size

 integer

Default value is 50
sortField

Name of the field to use for sorting

 string

Default value is

sortAscending

True for ascending sorting, false otherwise

 boolean

Default value is True

Body Parameters

None

Response Information

Resource Description

List of found Revenue Flows

Collection of RevenueFlowDto
NameDescriptionTypeAdditional 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-21T10:07:27.9304451+01:00",
    "CreatedBy": {
      "Login": "sample string 1",
      "FullName": "sample string 2",
      "Avatar": "sample string 3",
      "Id": 4
    },
    "LastUpdateDate": "2024-11-21T10:07:27.9304451+01:00",
    "LastUpdatedBy": {
      "Login": "sample string 1",
      "FullName": "sample string 2",
      "Avatar": "sample string 3",
      "Id": 4
    },
    "Id": 10
  },
  {
    "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-21T10:07:27.9304451+01:00",
    "CreatedBy": {
      "Login": "sample string 1",
      "FullName": "sample string 2",
      "Avatar": "sample string 3",
      "Id": 4
    },
    "LastUpdateDate": "2024-11-21T10:07:27.9304451+01:00",
    "LastUpdatedBy": {
      "Login": "sample string 1",
      "FullName": "sample string 2",
      "Avatar": "sample string 3",
      "Id": 4
    },
    "Id": 10
  }
]

application/xml, text/xml

Sample: 
<ArrayOfRevenueFlowDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oryx.Web.Api.Models">
  <RevenueFlowDto>
    <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-21T10:07:27.9304451+01:00</CreationDate>
    <LastUpdateDate>2024-11-21T10:07:27.9304451+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>
  </RevenueFlowDto>
  <RevenueFlowDto>
    <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-21T10:07:27.9304451+01:00</CreationDate>
    <LastUpdateDate>2024-11-21T10:07:27.9304451+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>
  </RevenueFlowDto>
</ArrayOfRevenueFlowDto>