GET v1/Locations/{locationID}/Policies/AgencyFees

Get a list of Agency Fees

Request Information

URI Parameters

NameDescriptionTypeAdditional information
locationID

Id of the location

string

Required

Body Parameters

None.

Response Information

Resource Description

List of agency fees

Collection of UtilityAgencyFeeDTO
NameDescriptionTypeAdditional information
DefaultAmount

Default amount

decimal number

None.

AmountIsPercent

Signifies whether the amount is percent

boolean

None.

Visible

Signifies whether the fee is visible

boolean

None.

LocationID

Id of the location

integer

None.

ShowInInvoice

Signifies whether the fee is shown in invoice

boolean

None.

FeeType

Type of the fee

integer

None.

AgencyFeeID

Id of the agency fee

integer

None.

AgencyFeeName

Name of the agency fee

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "DefaultAmount": 1.0,
    "AmountIsPercent": true,
    "Visible": true,
    "LocationID": 1,
    "ShowInInvoice": true,
    "FeeType": 1,
    "AgencyFeeID": 3,
    "AgencyFeeName": "sample string 4"
  },
  {
    "DefaultAmount": 1.0,
    "AmountIsPercent": true,
    "Visible": true,
    "LocationID": 1,
    "ShowInInvoice": true,
    "FeeType": 1,
    "AgencyFeeID": 3,
    "AgencyFeeName": "sample string 4"
  }
]

application/xml, text/xml

Sample:
<ArrayOfUtilityAgencyFeeDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Policies">
  <UtilityAgencyFeeDTO>
    <AgencyFeeID>3</AgencyFeeID>
    <AgencyFeeName>sample string 4</AgencyFeeName>
    <AmountIsPercent>true</AmountIsPercent>
    <DefaultAmount>1</DefaultAmount>
    <FeeType>1</FeeType>
    <LocationID>1</LocationID>
    <ShowInInvoice>true</ShowInInvoice>
    <Visible>true</Visible>
  </UtilityAgencyFeeDTO>
  <UtilityAgencyFeeDTO>
    <AgencyFeeID>3</AgencyFeeID>
    <AgencyFeeName>sample string 4</AgencyFeeName>
    <AmountIsPercent>true</AmountIsPercent>
    <DefaultAmount>1</DefaultAmount>
    <FeeType>1</FeeType>
    <LocationID>1</LocationID>
    <ShowInInvoice>true</ShowInInvoice>
    <Visible>true</Visible>
  </UtilityAgencyFeeDTO>
</ArrayOfUtilityAgencyFeeDTO>