PUT api/role/{id}/addfee

Add a fee for a given PropertyMarketingRole.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	the id of the role	integer	Required

Body Parameters

The fee to add to the role

Dezrez.Core.DataContracts.External.Api.Role.Command.UpdateFee.UpdateFeeDataContract

Name	Type	Additional information
Name	string	None.
FeeValueType	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
FeeCategoryType	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
FeeChargeType	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
FeeLiabilityType	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
FeeFrequency	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
ApplyTax	boolean	None.
VatValue	decimal number	None.
DefaultValue	decimal number	None.
ScaleableFees	Collection of Dezrez.Core.DataContracts.External.Api.Role.Command.UpdateFee.UpdateFeeScaleableFeeDataContract	None.
AdditionalFees	Collection of Dezrez.Core.DataContracts.External.Api.Role.Command.UpdateFee.UpdateFeeAdditionalFeeDataContract	None.
Notes	string	None.
TransactionType	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
AgencyType	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
IsDefault	boolean	None.
PersistAsBranchFee	boolean	None.
PersistAsAgencyFee	boolean	None.
AutoApply	boolean	None.
FeePercentageOfType	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
VatRateType	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
Id	integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

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"
  },
  "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"
      },
      "Id": 4
    },
    {
      "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"
      },
      "Id": 4
    }
  ],
  "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"
      },
      "Id": 4
    },
    {
      "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"
      },
      "Id": 4
    }
  ],
  "Notes": "sample string 5",
  "TransactionType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "AgencyType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "IsDefault": true,
  "PersistAsBranchFee": true,
  "PersistAsAgencyFee": true,
  "AutoApply": true,
  "FeePercentageOfType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "VatRateType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Id": 10
}

Response Information

Resource Description

Dezrez.Core.DataContracts.External.Api.Role.Command.UpdateFee.UpdateFeeResponseDataContract

Name	Type	Additional information
Name	string	None.
FeeValueType	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
DefaultValue	decimal number	None.
ScaleableFees	Collection of Dezrez.Core.DataContracts.External.Api.Role.Command.UpdateFee.UpdateFeeScaleableFeeResponseDataContract	None.
AdditionalFees	Collection of Dezrez.Core.DataContracts.External.Api.Role.Command.UpdateFee.UpdateFeeAdditionalFeeResponseDataContract	None.
Notes	string	None.
TransactionType	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
FeePercentageOfType	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
FeeCategoryType	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
VatRateType	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
IsDefault	boolean	None.
ApplyTax	boolean	None.
CreatedDate	date	None.
CreatedBy	Dezrez.Core.DataContracts.External.Api.People.Query.Get.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"
  },
  "DefaultValue": 2.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": "2024-11-21T10:00:47.527182Z",
      "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": "2024-11-21T10:00:47.527182Z",
      "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": "2024-11-21T10:00:47.527182Z",
      "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": "2024-11-21T10:00:47.527182Z",
      "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 3",
  "TransactionType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "FeePercentageOfType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "FeeCategoryType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "VatRateType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "IsDefault": true,
  "ApplyTax": true,
  "CreatedDate": "2024-11-21T10:00:47.527182Z",
  "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": 7
}