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

Request Information

URI Parameters

Name	Description	Type	Additional information
unitAccountId		integer	Required

Body Parameters

ACHDefinition

Name	Type	Additional information
ACHDefinitionID	integer	None.
AccountType	ACHAccountTypes	None.
UnitAccountID	integer	None.
Name	string	None.
ContactID	integer	None.
AccountNumber	string	None.
RoutingNumber	string	None.
BankName	string	None.
IsActive	boolean	None.
IsDeleted	boolean	None.
DateCreated	date	None.
LastModified	date	None.
IsAuthorized	boolean	None.
AuthorizationDate	date	None.
AuthorizedByLoginID	integer	None.
AuthorizedByName	string	None.
ACHPaymentPlans	Collection of ACHPaymentPlan	None.

Request Formats

application/json, text/json

Sample:

{
  "ACHDefinitionID": 1,
  "AccountType": 0,
  "UnitAccountID": 2,
  "Name": "sample string 3",
  "ContactID": 4,
  "AccountNumber": "sample string 5",
  "RoutingNumber": "sample string 6",
  "BankName": "sample string 7",
  "IsActive": true,
  "IsDeleted": true,
  "DateCreated": "2025-05-20T10:51:59.0901753-07:00",
  "LastModified": "2025-05-20T10:51:59.0901753-07:00",
  "IsAuthorized": true,
  "AuthorizationDate": "2025-05-20T10:51:59.0901753-07:00",
  "AuthorizedByLoginID": 10,
  "AuthorizedByName": "sample string 11",
  "ACHPaymentPlans": [
    {
      "ACHPaymentPlanID": 1,
      "ACHDefinitionID": 2,
      "UnitAccountID": 3,
      "Name": "sample string 4",
      "IsManual": true,
      "ManualAmount": 6.0,
      "StartDate": "2025-05-20T10:51:59.0901753-07:00",
      "AuthorizationDate": "2025-05-20T10:51:59.0901753-07:00",
      "AuthorizedByLoginID": 9,
      "AuthorizedByName": "sample string 10",
      "EndDate": "2025-05-20T10:51:59.0901753-07:00",
      "IsActive": true,
      "Distribution": 13.0,
      "PaymentPlanType": 0,
      "IsDeleted": true,
      "DateCreated": "2025-05-20T10:51:59.0901753-07:00",
      "LastModified": "2025-05-20T10:51:59.0901753-07:00"
    },
    {
      "ACHPaymentPlanID": 1,
      "ACHDefinitionID": 2,
      "UnitAccountID": 3,
      "Name": "sample string 4",
      "IsManual": true,
      "ManualAmount": 6.0,
      "StartDate": "2025-05-20T10:51:59.0901753-07:00",
      "AuthorizationDate": "2025-05-20T10:51:59.0901753-07:00",
      "AuthorizedByLoginID": 9,
      "AuthorizedByName": "sample string 10",
      "EndDate": "2025-05-20T10:51:59.0901753-07:00",
      "IsActive": true,
      "Distribution": 13.0,
      "PaymentPlanType": 0,
      "IsDeleted": true,
      "DateCreated": "2025-05-20T10:51:59.0901753-07:00",
      "LastModified": "2025-05-20T10:51:59.0901753-07:00"
    }
  ]
}

application/xml, text/xml

Sample:

<ACHDefinition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaliberAPI">
  <ACHDefinitionID>1</ACHDefinitionID>
  <ACHPaymentPlans>
    <ACHPaymentPlan>
      <ACHDefinitionID>2</ACHDefinitionID>
      <ACHPaymentPlanID>1</ACHPaymentPlanID>
      <AuthorizationDate>2025-05-20T10:51:59.0901753-07:00</AuthorizationDate>
      <AuthorizedByLoginID>9</AuthorizedByLoginID>
      <AuthorizedByName>sample string 10</AuthorizedByName>
      <DateCreated>2025-05-20T10:51:59.0901753-07:00</DateCreated>
      <Distribution>13</Distribution>
      <EndDate>2025-05-20T10:51:59.0901753-07:00</EndDate>
      <IsActive>true</IsActive>
      <IsDeleted>true</IsDeleted>
      <IsManual>true</IsManual>
      <LastModified>2025-05-20T10:51:59.0901753-07:00</LastModified>
      <ManualAmount>6</ManualAmount>
      <Name>sample string 4</Name>
      <PaymentPlanType>Recurring</PaymentPlanType>
      <StartDate>2025-05-20T10:51:59.0901753-07:00</StartDate>
      <UnitAccountID>3</UnitAccountID>
    </ACHPaymentPlan>
    <ACHPaymentPlan>
      <ACHDefinitionID>2</ACHDefinitionID>
      <ACHPaymentPlanID>1</ACHPaymentPlanID>
      <AuthorizationDate>2025-05-20T10:51:59.0901753-07:00</AuthorizationDate>
      <AuthorizedByLoginID>9</AuthorizedByLoginID>
      <AuthorizedByName>sample string 10</AuthorizedByName>
      <DateCreated>2025-05-20T10:51:59.0901753-07:00</DateCreated>
      <Distribution>13</Distribution>
      <EndDate>2025-05-20T10:51:59.0901753-07:00</EndDate>
      <IsActive>true</IsActive>
      <IsDeleted>true</IsDeleted>
      <IsManual>true</IsManual>
      <LastModified>2025-05-20T10:51:59.0901753-07:00</LastModified>
      <ManualAmount>6</ManualAmount>
      <Name>sample string 4</Name>
      <PaymentPlanType>Recurring</PaymentPlanType>
      <StartDate>2025-05-20T10:51:59.0901753-07:00</StartDate>
      <UnitAccountID>3</UnitAccountID>
    </ACHPaymentPlan>
  </ACHPaymentPlans>
  <AccountNumber>sample string 5</AccountNumber>
  <AccountType>Checking</AccountType>
  <AuthorizationDate>2025-05-20T10:51:59.0901753-07:00</AuthorizationDate>
  <AuthorizedByLoginID>10</AuthorizedByLoginID>
  <AuthorizedByName>sample string 11</AuthorizedByName>
  <BankName>sample string 7</BankName>
  <ContactID>4</ContactID>
  <DateCreated>2025-05-20T10:51:59.0901753-07:00</DateCreated>
  <IsActive>true</IsActive>
  <IsAuthorized>true</IsAuthorized>
  <IsDeleted>true</IsDeleted>
  <LastModified>2025-05-20T10:51:59.0901753-07:00</LastModified>
  <Name>sample string 3</Name>
  <RoutingNumber>sample string 6</RoutingNumber>
  <UnitAccountID>2</UnitAccountID>
</ACHDefinition>

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

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.