POST api/entities/{entityId}/recurringTransactions/chargeEndDate/globalAdjustment

Update End Date

Request Information

URI Parameters

Name	Description	Type	Additional information
entityId	[Required] - Entity id	integer	Required

Body Parameters

[Required] - Object that contains the parameters for running a global adjustment

GlobalAdjustmentParamsEndDate

Name	Description	Type	Additional information
ChargeCodeId	[Required] Id of charge code	integer	Required Range: inclusive between 1 and 2147483647
AdjustmentOption	[Required] Adjustment calculation option	GlobalAdjustmentOptionEnum	Range: inclusive between 1 and 4
UserId	[Required] User id	integer	Required Range: inclusive between 1 and 2147483647
EndDate	[Required] End date	date	Required Range: inclusive between 1/1/1753 and 12/31/9999
ChargeType	Charge Type	string	None.
ChargeCodeGroup	Recurring Charge and Date Range	ChargeCodeGroup	None.

Request Formats

application/json, text/json

Sample:

{
  "chargeCodeId": 1,
  "adjustmentOption": 1,
  "userId": 2,
  "endDate": "2024-10-14T04:22:28.7874854-04:00",
  "chargeType": "sample string 4",
  "chargeCodeGroup": {
    "startDate": "2024-10-14T04:22:28.7874854-04:00",
    "endDate": "2024-10-14T04:22:28.7874854-04:00",
    "id": 1
  }
}

application/xml, text/xml

Sample:

<GlobalAdjustmentParamsEndDate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.RecurringTransactions">
  <AdjustmentOption>FlatRate</AdjustmentOption>
  <ChargeCodeGroup>
    <EndDate>2024-10-14T04:22:28.7874854-04:00</EndDate>
    <StartDate>2024-10-14T04:22:28.7874854-04:00</StartDate>
    <id>1</id>
  </ChargeCodeGroup>
  <ChargeCodeId>1</ChargeCodeId>
  <ChargeType>sample string 4</ChargeType>
  <EndDate>2024-10-14T04:22:28.7874854-04:00</EndDate>
  <UserId>2</UserId>
</GlobalAdjustmentParamsEndDate>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'GlobalAdjustmentParamsEndDate'.

Response Information

Resource Description

List RecurringTransactionViewModel

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.