POST api/PaymentPlans

Request Information

URI Parameters

None.

Body Parameters

PaymentPlan
NameDescriptionTypeAdditional information
PaymentPlanId

integer

None.

AccountNum

integer

None.

UtilityId

integer

None.

StartingDate

date

None.

PlanAmount

decimal number

None.

NumberOfPayments

integer

None.

Payment1Amount

decimal number

None.

Payment1Billed

string

Max length: 1

Payment2Amount

decimal number

None.

Payment2Billed

string

Max length: 1

Payment3Amount

decimal number

None.

Payment3Billed

string

Max length: 1

Payment4Amount

decimal number

None.

Payment4Billed

string

Max length: 1

Payment5Amount

decimal number

None.

Payment5Billed

string

Max length: 1

Payment6Amount

decimal number

None.

Payment6Billed

string

Max length: 1

Status

string

Max length: 10

DateCreated

date

None.

DateUpdated

date

None.

CreatedBy

integer

None.

UpdatedBy

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "PaymentPlanId": 1,
  "AccountNum": 2,
  "UtilityId": 3,
  "StartingDate": "2020-02-15T08:12:12.5344512+00:00",
  "PlanAmount": 5.0,
  "NumberOfPayments": 6,
  "Payment1Amount": 1.0,
  "Payment1Billed": "sample string 7",
  "Payment2Amount": 1.0,
  "Payment2Billed": "sample string 8",
  "Payment3Amount": 1.0,
  "Payment3Billed": "sample string 9",
  "Payment4Amount": 1.0,
  "Payment4Billed": "sample string 10",
  "Payment5Amount": 1.0,
  "Payment5Billed": "sample string 11",
  "Payment6Amount": 1.0,
  "Payment6Billed": "sample string 12",
  "Status": "sample string 13",
  "DateCreated": "2020-02-15T08:12:12.5344512+00:00",
  "DateUpdated": "2020-02-15T08:12:12.5344512+00:00",
  "CreatedBy": 16,
  "UpdatedBy": 17
}

application/xml, text/xml

Sample:
<PaymentPlan xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APL.Models">
  <AccountNum>2</AccountNum>
  <CreatedBy>16</CreatedBy>
  <DateCreated>2020-02-15T08:12:12.5344512+00:00</DateCreated>
  <DateUpdated>2020-02-15T08:12:12.5344512+00:00</DateUpdated>
  <NumberOfPayments>6</NumberOfPayments>
  <Payment1Amount>1</Payment1Amount>
  <Payment1Billed>sample string 7</Payment1Billed>
  <Payment2Amount>1</Payment2Amount>
  <Payment2Billed>sample string 8</Payment2Billed>
  <Payment3Amount>1</Payment3Amount>
  <Payment3Billed>sample string 9</Payment3Billed>
  <Payment4Amount>1</Payment4Amount>
  <Payment4Billed>sample string 10</Payment4Billed>
  <Payment5Amount>1</Payment5Amount>
  <Payment5Billed>sample string 11</Payment5Billed>
  <Payment6Amount>1</Payment6Amount>
  <Payment6Billed>sample string 12</Payment6Billed>
  <PaymentPlanId>1</PaymentPlanId>
  <PlanAmount>5</PlanAmount>
  <StartingDate>2020-02-15T08:12:12.5344512+00:00</StartingDate>
  <Status>sample string 13</Status>
  <UpdatedBy>17</UpdatedBy>
  <UtilityId>3</UtilityId>
</PaymentPlan>

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

Response Information

Resource Description

PaymentPlan
NameDescriptionTypeAdditional information
PaymentPlanId

integer

None.

AccountNum

integer

None.

UtilityId

integer

None.

StartingDate

date

None.

PlanAmount

decimal number

None.

NumberOfPayments

integer

None.

Payment1Amount

decimal number

None.

Payment1Billed

string

Max length: 1

Payment2Amount

decimal number

None.

Payment2Billed

string

Max length: 1

Payment3Amount

decimal number

None.

Payment3Billed

string

Max length: 1

Payment4Amount

decimal number

None.

Payment4Billed

string

Max length: 1

Payment5Amount

decimal number

None.

Payment5Billed

string

Max length: 1

Payment6Amount

decimal number

None.

Payment6Billed

string

Max length: 1

Status

string

Max length: 10

DateCreated

date

None.

DateUpdated

date

None.

CreatedBy

integer

None.

UpdatedBy

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "PaymentPlanId": 1,
  "AccountNum": 2,
  "UtilityId": 3,
  "StartingDate": "2020-02-15T08:12:12.5344512+00:00",
  "PlanAmount": 5.0,
  "NumberOfPayments": 6,
  "Payment1Amount": 1.0,
  "Payment1Billed": "sample string 7",
  "Payment2Amount": 1.0,
  "Payment2Billed": "sample string 8",
  "Payment3Amount": 1.0,
  "Payment3Billed": "sample string 9",
  "Payment4Amount": 1.0,
  "Payment4Billed": "sample string 10",
  "Payment5Amount": 1.0,
  "Payment5Billed": "sample string 11",
  "Payment6Amount": 1.0,
  "Payment6Billed": "sample string 12",
  "Status": "sample string 13",
  "DateCreated": "2020-02-15T08:12:12.5344512+00:00",
  "DateUpdated": "2020-02-15T08:12:12.5344512+00:00",
  "CreatedBy": 16,
  "UpdatedBy": 17
}

application/xml, text/xml

Sample:
<PaymentPlan xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APL.Models">
  <AccountNum>2</AccountNum>
  <CreatedBy>16</CreatedBy>
  <DateCreated>2020-02-15T08:12:12.5344512+00:00</DateCreated>
  <DateUpdated>2020-02-15T08:12:12.5344512+00:00</DateUpdated>
  <NumberOfPayments>6</NumberOfPayments>
  <Payment1Amount>1</Payment1Amount>
  <Payment1Billed>sample string 7</Payment1Billed>
  <Payment2Amount>1</Payment2Amount>
  <Payment2Billed>sample string 8</Payment2Billed>
  <Payment3Amount>1</Payment3Amount>
  <Payment3Billed>sample string 9</Payment3Billed>
  <Payment4Amount>1</Payment4Amount>
  <Payment4Billed>sample string 10</Payment4Billed>
  <Payment5Amount>1</Payment5Amount>
  <Payment5Billed>sample string 11</Payment5Billed>
  <Payment6Amount>1</Payment6Amount>
  <Payment6Billed>sample string 12</Payment6Billed>
  <PaymentPlanId>1</PaymentPlanId>
  <PlanAmount>5</PlanAmount>
  <StartingDate>2020-02-15T08:12:12.5344512+00:00</StartingDate>
  <Status>sample string 13</Status>
  <UpdatedBy>17</UpdatedBy>
  <UtilityId>3</UtilityId>
</PaymentPlan>