PUT api/branch/updatefee

Add or update fee for logged in branch. Processes this branch API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The update fee data contract supplied with the request.

UpdateFeeDataContract

Name	Description	Type	Additional information
Name	The name value.	string	None.
FeeValueType	The fee value type value.	EnumDataContract	None.
FeeCategoryType	The fee category type value.	EnumDataContract	None.
FeeChargeType	The fee charge type value.	EnumDataContract	None.
FeeLiabilityType	The fee liability type value.	EnumDataContract	None.
FeeFrequency	The fee frequency value.	EnumDataContract	None.
ApplyTax	Indicates whether apply tax is true.	boolean	None.
VatValue	The vat value value.	decimal number	None.
DefaultValue	The default value value.	decimal number	None.
ScaleableFees	The collection of scaleable fees.	Collection of UpdateFeeScaleableFeeDataContract	None.
AdditionalFees	The collection of additional fees.	Collection of UpdateFeeAdditionalFeeDataContract	None.
Notes	The notes value.	string	None.
TransactionType	The transaction type value.	EnumDataContract	None.
AgencyType	The agency type value.	EnumDataContract	None.
IsDefault	Indicates whether this item is default.	boolean	None.
PersistAsBranchFee	Indicates whether persist as branch fee is true.	boolean	None.
PersistAsAgencyFee	Indicates whether persist as agency fee is true.	boolean	None.
AutoApply	Indicates whether auto apply is true.	boolean	None.
FeePercentageOfType	The fee percentage of type value.	EnumDataContract	None.
VatRateType	The vat rate type value.	EnumDataContract	None.
Id	The unique identifier of this resource.	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

The response returned after the operation completes.

HttpResponseMessage

Name	Description	Type	Additional information
Version	The version value.	Version	None.
Content	The content value.	HttpContent	None.
StatusCode	The status code classification.	HttpStatusCode	None.
ReasonPhrase	The reason phrase value.	string	None.
Headers	The collection of headers.	Collection of Object	None.
RequestMessage	The request message value.	HttpRequestMessage	None.
IsSuccessStatusCode	Indicates whether this item is success status code.	boolean	None.