GET api/agency/fees?transactionType={transactionType}&defaultOnly={defaultOnly}&categoryType={categoryType}

Get fees for logged in agency
Request Information

URI Parameters

Name	Description	Type	Additional information
transactionType	The transaction type of the fee to retrieve. Currently Sales or Letting	string	None.
defaultOnly		boolean	Default value is True
categoryType	The category type of the fee to retrieve.	string	None.
Body Parameters

None.
Response Information

Resource Description

A list of fees for the agency
Collection of AgencyFeeDataContract
Name	Type	Additional information
Name	string	None.
FeeValueType	EnumDataContract	None.
FeeCategoryType	EnumDataContract	None.
FeeChargeType	EnumDataContract	None.
FeeLiabilityType	EnumDataContract	None.
FeeFrequency	EnumDataContract	None.
FeePercentageOfType	EnumDataContract	None.
VatRateType	EnumDataContract	None.
ApplyTax	boolean	None.
VatValue	decimal number	None.
DefaultValue	decimal number	None.
ScaleableFees	Collection of AgencyScaleableFeeDataContract	None.
AdditionalFees	Collection of AgencyAdditionalFeeDataContract	None.
Notes	string	None.
TransactionType	EnumDataContract	None.
IsDefault	boolean	None.
CalculatedValue	decimal number	None.
AutoApply	boolean	None.
CreatedDate	date	None.
CreatedBy	CreatedByDataContract	None.
Id	integer	None.
Response Formats

application/json, text/json

Sample:
[
  {
    "Name": "sample string 1",
    "FeeValueType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FeeCategoryType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FeeChargeType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FeeLiabilityType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FeeFrequency": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FeePercentageOfType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "VatRateType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "ApplyTax": true,
    "VatValue": 3.1,
    "DefaultValue": 4.1,
    "ScaleableFees": [
      {
        "Name": "sample string 1",
        "Threshold": 2.1,
        "Value": 3.1,
        "ThresholdType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "ValueType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "CreatedDate": "2021-12-07T18:09:30.2408549Z",
        "CreatedBy": {
          "Initials": "sample string 1",
          "ContactName": "sample string 2",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 3",
          "FirstName": "sample string 4",
          "LastName": "sample string 5",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "JobTitle": "sample string 6",
          "Id": 7
        },
        "Id": 5
      },
      {
        "Name": "sample string 1",
        "Threshold": 2.1,
        "Value": 3.1,
        "ThresholdType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "ValueType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "CreatedDate": "2021-12-07T18:09:30.2408549Z",
        "CreatedBy": {
          "Initials": "sample string 1",
          "ContactName": "sample string 2",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 3",
          "FirstName": "sample string 4",
          "LastName": "sample string 5",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "JobTitle": "sample string 6",
          "Id": 7
        },
        "Id": 5
      }
    ],
    "AdditionalFees": [
      {
        "Name": "sample string 1",
        "Threshold": 2.1,
        "Value": 3.1,
        "ThresholdType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "ValueType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "CreatedDate": "2021-12-07T18:09:30.2408549Z",
        "CreatedBy": {
          "Initials": "sample string 1",
          "ContactName": "sample string 2",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 3",
          "FirstName": "sample string 4",
          "LastName": "sample string 5",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "JobTitle": "sample string 6",
          "Id": 7
        },
        "Id": 5
      },
      {
        "Name": "sample string 1",
        "Threshold": 2.1,
        "Value": 3.1,
        "ThresholdType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "ValueType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "CreatedDate": "2021-12-07T18:09:30.2408549Z",
        "CreatedBy": {
          "Initials": "sample string 1",
          "ContactName": "sample string 2",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 3",
          "FirstName": "sample string 4",
          "LastName": "sample string 5",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "JobTitle": "sample string 6",
          "Id": 7
        },
        "Id": 5
      }
    ],
    "Notes": "sample string 5",
    "TransactionType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "IsDefault": true,
    "CalculatedValue": 7.1,
    "AutoApply": true,
    "CreatedDate": "2021-12-07T18:09:30.2408549Z",
    "CreatedBy": {
      "Initials": "sample string 1",
      "ContactName": "sample string 2",
      "Gender": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Title": "sample string 3",
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "PrimaryTelephone": {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      "PrimaryEmail": {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      "JobTitle": "sample string 6",
      "Id": 7
    },
    "Id": 10
  },
  {
    "Name": "sample string 1",
    "FeeValueType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FeeCategoryType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FeeChargeType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FeeLiabilityType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FeeFrequency": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FeePercentageOfType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "VatRateType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "ApplyTax": true,
    "VatValue": 3.1,
    "DefaultValue": 4.1,
    "ScaleableFees": [
      {
        "Name": "sample string 1",
        "Threshold": 2.1,
        "Value": 3.1,
        "ThresholdType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "ValueType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "CreatedDate": "2021-12-07T18:09:30.2408549Z",
        "CreatedBy": {
          "Initials": "sample string 1",
          "ContactName": "sample string 2",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 3",
          "FirstName": "sample string 4",
          "LastName": "sample string 5",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "JobTitle": "sample string 6",
          "Id": 7
        },
        "Id": 5
      },
      {
        "Name": "sample string 1",
        "Threshold": 2.1,
        "Value": 3.1,
        "ThresholdType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "ValueType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "CreatedDate": "2021-12-07T18:09:30.2408549Z",
        "CreatedBy": {
          "Initials": "sample string 1",
          "ContactName": "sample string 2",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 3",
          "FirstName": "sample string 4",
          "LastName": "sample string 5",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "JobTitle": "sample string 6",
          "Id": 7
        },
        "Id": 5
      }
    ],
    "AdditionalFees": [
      {
        "Name": "sample string 1",
        "Threshold": 2.1,
        "Value": 3.1,
        "ThresholdType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "ValueType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "CreatedDate": "2021-12-07T18:09:30.2408549Z",
        "CreatedBy": {
          "Initials": "sample string 1",
          "ContactName": "sample string 2",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 3",
          "FirstName": "sample string 4",
          "LastName": "sample string 5",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "JobTitle": "sample string 6",
          "Id": 7
        },
        "Id": 5
      },
      {
        "Name": "sample string 1",
        "Threshold": 2.1,
        "Value": 3.1,
        "ThresholdType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "ValueType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "CreatedDate": "2021-12-07T18:09:30.2408549Z",
        "CreatedBy": {
          "Initials": "sample string 1",
          "ContactName": "sample string 2",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 3",
          "FirstName": "sample string 4",
          "LastName": "sample string 5",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "JobTitle": "sample string 6",
          "Id": 7
        },
        "Id": 5
      }
    ],
    "Notes": "sample string 5",
    "TransactionType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "IsDefault": true,
    "CalculatedValue": 7.1,
    "AutoApply": true,
    "CreatedDate": "2021-12-07T18:09:30.2408549Z",
    "CreatedBy": {
      "Initials": "sample string 1",
      "ContactName": "sample string 2",
      "Gender": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Title": "sample string 3",
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "PrimaryTelephone": {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      "PrimaryEmail": {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      "JobTitle": "sample string 6",
      "Id": 7
    },
    "Id": 10
  }
]