POST api/v2/unitaccount/{unitAccountId}/achpaymentplan

Request Information

URI Parameters

NameDescriptionTypeAdditional information
unitAccountId

integer

Required

Body Parameters

ACHPaymentPlan
NameDescriptionTypeAdditional information
ACHPaymentPlanID

integer

None.

ACHDefinitionID

integer

None.

UnitAccountID

integer

None.

Name

string

None.

IsManual

boolean

None.

ManualAmount

decimal number

None.

StartDate

date

None.

AuthorizationDate

date

None.

AuthorizedByLoginID

integer

None.

AuthorizedByName

string

None.

EndDate

date

None.

IsActive

boolean

None.

Distribution

decimal number

None.

PaymentPlanType

PaymentPlanTypes

None.

IsDeleted

boolean

None.

DateCreated

date

None.

LastModified

date

None.

Request Formats

application/json, text/json

Sample:
{
  "ACHPaymentPlanID": 1,
  "ACHDefinitionID": 2,
  "UnitAccountID": 3,
  "Name": "sample string 4",
  "IsManual": true,
  "ManualAmount": 6.0,
  "StartDate": "2025-05-20T11:10:17.0995218-07:00",
  "AuthorizationDate": "2025-05-20T11:10:17.0995218-07:00",
  "AuthorizedByLoginID": 9,
  "AuthorizedByName": "sample string 10",
  "EndDate": "2025-05-20T11:10:17.0995218-07:00",
  "IsActive": true,
  "Distribution": 13.0,
  "PaymentPlanType": 0,
  "IsDeleted": true,
  "DateCreated": "2025-05-20T11:10:17.0995218-07:00",
  "LastModified": "2025-05-20T11:10:17.0995218-07:00"
}

application/xml, text/xml

Sample:
<ACHPaymentPlan xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaliberAPI">
  <ACHDefinitionID>2</ACHDefinitionID>
  <ACHPaymentPlanID>1</ACHPaymentPlanID>
  <AuthorizationDate>2025-05-20T11:10:17.0995218-07:00</AuthorizationDate>
  <AuthorizedByLoginID>9</AuthorizedByLoginID>
  <AuthorizedByName>sample string 10</AuthorizedByName>
  <DateCreated>2025-05-20T11:10:17.0995218-07:00</DateCreated>
  <Distribution>13</Distribution>
  <EndDate>2025-05-20T11:10:17.0995218-07:00</EndDate>
  <IsActive>true</IsActive>
  <IsDeleted>true</IsDeleted>
  <IsManual>true</IsManual>
  <LastModified>2025-05-20T11:10:17.0995218-07:00</LastModified>
  <ManualAmount>6</ManualAmount>
  <Name>sample string 4</Name>
  <PaymentPlanType>Recurring</PaymentPlanType>
  <StartDate>2025-05-20T11:10:17.0995218-07:00</StartDate>
  <UnitAccountID>3</UnitAccountID>
</ACHPaymentPlan>

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

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.