POST api/entities/{entityId}/recurringTransactions/globalAdjustment?retroChargesPostDate={retroChargesPostDate}&retroChargesDescription={retroChargesDescription}

Performs a global adjustment.

Request Information

URI Parameters

Name	Description	Type	Additional information
entityId	[Required] Entity id	integer	Required
retroChargesPostDate	[Required if any retro charges are created] Post date for created retroactive charges	date	None.
retroChargesDescription	[Required if any retro charges are created]Description of retroactive charges	string	None.

Body Parameters

Object that contains the parameters for running a global adjustment

GlobalAdjustmentParams

Name	Description	Type	Additional information
ChargeCodeId	[Required] Id of charge code	integer	Range: inclusive between 1 and 2147483647
AdjustmentOption	[Required] Adjustment calculation option	GlobalAdjustmentOptionEnum	Range: inclusive between 1 and 3
Action	[Required] Action to take	GlobalAdjustmentActionEnum	Range: inclusive between 1 and 3
StartDate	[Required] Start date	date	Required Range: inclusive between 1/1/1753 and 12/31/9999
Value	[Required] Value to use when calculating the adjustment	decimal number	None.
UserId	[Required] User id	integer	Range: inclusive between 1 and 2147483647
Type	Recurring Transaction Type	RecurringTransactionType	None.
RetroGLPostDate		date	None.

Request Formats

application/json, text/json

Sample:

{
  "chargeCodeId": 1,
  "adjustmentOption": 1,
  "action": 1,
  "startDate": "2024-10-14T08:22:39.5410042-04:00",
  "value": 3.0,
  "userId": 4,
  "type": 0,
  "retroGLPostDate": "2024-10-14T08:22:39.5410042-04:00"
}

application/xml, text/xml

Sample:

<GlobalAdjustmentParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.RecurringTransactions">
  <Action>Increase</Action>
  <AdjustmentOption>FlatRate</AdjustmentOption>
  <ChargeCodeId>1</ChargeCodeId>
  <RetroGLPostDate>2024-10-14T08:22:39.5410042-04:00</RetroGLPostDate>
  <StartDate>2024-10-14T08:22:39.5410042-04:00</StartDate>
  <Type>Charge</Type>
  <UserId>4</UserId>
  <Value>3</Value>
</GlobalAdjustmentParams>

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 'GlobalAdjustmentParams'.

Response Information

Resource Description

Collection of RecurringTransactionViewModel

Name	Description	Type	Additional information
Id	Id of the Recurring Charge/Credit, it will default to 0 for new Transaction.	integer	None.
BuildingId	Building Id	integer	None.
ChargeCodeId	Charge Code Id	integer	None.
UnitId	Unit Id. It will default to 0 for ApplyTo is All\UnitType	integer	None.
UnitType	Unit Type Id. It will default to 0 for ApplyTo is All\Shares\Unit	integer	None.
ChargeCodeAdjustedCodeId	Adjusted Code Id	integer	None.
OverrideDueDay	Override Due Day. Valid values are betwee 1 and 31.	integer	None.
StartDate	Date the Recurring Transaction begins.	date	None.
EndDate	Date the Recurring Transaction ends.	date	None.
Rate	Rate. Use when ApplyTo is Shares. Will be 0.00M when ApplyTo is not Shares	decimal number	None.
Amount	Amount. Use when ApplyTo is not Shares. Will be 0.00M when ApplyTo is Shares.	decimal number	None.
Type	Type of the Recurring Transaction. Possible values are 'Credit' or 'Charge'	RecurringTransactionType	None.
GroupId	Group Id. Used to handle Group Increase action. Will be initially set to the Id of the Recurring Transaction.	integer	None.
Status	Status. Used to handle Group Increase action. Will be initially set to Created.	integer	None.
ApplyToId	Id of Apply To configuration.	integer	None.
CreatedOn	Date the recurring transaction was created. Defaults to system date and time at the time of creation.	date	None.
CreatedBy	Id of User who created the recurring transaction	integer	None.
ModifiedBy	Id of User who last modified the recurring transaction. Initial value is null	integer	None.
ModifiedOn	Date the recurring transaction was last modified. Initial value is null	date	None.
EditDates	Indicates whether dates can be updated for this recurring transaction.	boolean	None.
NumberOfShares	If ApplyTo = Shares this will be populated with the Number Of Shares of the unit.	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "buildingId": 2,
    "chargeCodeId": 3,
    "unitId": 4,
    "unitType": 5,
    "chargeCodeAdjustedCodeId": 6,
    "overrideDueDay": 7,
    "startDate": "2024-10-14T08:22:39.5410042-04:00",
    "endDate": "2024-10-14T08:22:39.5410042-04:00",
    "rate": 10.0,
    "amount": 11.0,
    "type": 0,
    "groupId": 12,
    "status": 13,
    "applyToId": 14,
    "createdOn": "2024-10-14T08:22:39.5410042-04:00",
    "createdBy": 1,
    "modifiedBy": 1,
    "modifiedOn": "2024-10-14T08:22:39.5410042-04:00",
    "editDates": true,
    "numberOfShares": 1.0
  },
  {
    "id": 1,
    "buildingId": 2,
    "chargeCodeId": 3,
    "unitId": 4,
    "unitType": 5,
    "chargeCodeAdjustedCodeId": 6,
    "overrideDueDay": 7,
    "startDate": "2024-10-14T08:22:39.5410042-04:00",
    "endDate": "2024-10-14T08:22:39.5410042-04:00",
    "rate": 10.0,
    "amount": 11.0,
    "type": 0,
    "groupId": 12,
    "status": 13,
    "applyToId": 14,
    "createdOn": "2024-10-14T08:22:39.5410042-04:00",
    "createdBy": 1,
    "modifiedBy": 1,
    "modifiedOn": "2024-10-14T08:22:39.5410042-04:00",
    "editDates": true,
    "numberOfShares": 1.0
  }
]

application/xml, text/xml

Sample:

<ArrayOfRecurringTransactionViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.RecurringTransactions">
  <RecurringTransactionViewModel>
    <Amount>11</Amount>
    <ApplyToId>14</ApplyToId>
    <BuildingId>2</BuildingId>
    <ChargeCodeAdjustedCodeId>6</ChargeCodeAdjustedCodeId>
    <ChargeCodeId>3</ChargeCodeId>
    <CreatedBy>1</CreatedBy>
    <CreatedOn>2024-10-14T08:22:39.5410042-04:00</CreatedOn>
    <EditDates>true</EditDates>
    <EndDate>2024-10-14T08:22:39.5410042-04:00</EndDate>
    <GroupId>12</GroupId>
    <Id>1</Id>
    <ModifiedBy>1</ModifiedBy>
    <ModifiedOn>2024-10-14T08:22:39.5410042-04:00</ModifiedOn>
    <NumberOfShares>1</NumberOfShares>
    <OverrideDueDay>7</OverrideDueDay>
    <Rate>10</Rate>
    <StartDate>2024-10-14T08:22:39.5410042-04:00</StartDate>
    <Status>13</Status>
    <Type>Charge</Type>
    <UnitId>4</UnitId>
    <UnitType>5</UnitType>
  </RecurringTransactionViewModel>
  <RecurringTransactionViewModel>
    <Amount>11</Amount>
    <ApplyToId>14</ApplyToId>
    <BuildingId>2</BuildingId>
    <ChargeCodeAdjustedCodeId>6</ChargeCodeAdjustedCodeId>
    <ChargeCodeId>3</ChargeCodeId>
    <CreatedBy>1</CreatedBy>
    <CreatedOn>2024-10-14T08:22:39.5410042-04:00</CreatedOn>
    <EditDates>true</EditDates>
    <EndDate>2024-10-14T08:22:39.5410042-04:00</EndDate>
    <GroupId>12</GroupId>
    <Id>1</Id>
    <ModifiedBy>1</ModifiedBy>
    <ModifiedOn>2024-10-14T08:22:39.5410042-04:00</ModifiedOn>
    <NumberOfShares>1</NumberOfShares>
    <OverrideDueDay>7</OverrideDueDay>
    <Rate>10</Rate>
    <StartDate>2024-10-14T08:22:39.5410042-04:00</StartDate>
    <Status>13</Status>
    <Type>Charge</Type>
    <UnitId>4</UnitId>
    <UnitType>5</UnitType>
  </RecurringTransactionViewModel>
</ArrayOfRecurringTransactionViewModel>