POST v1/Generic/InvoiceMethodUpdate

Request Information

URI Parameters

None.

Body Parameters

InvoiceMethodUpdateRequest
NameDescriptionTypeAdditional information
CustomerPaymentId

integer

Required
PaymentBilledDateTime

date

None.
BillDueDate

date

None.
AmountBilled

decimal number

None.
PaymentNote

string

None.
PaymentStatus

string

None.
PostageAccountId

integer

None.
SourceModule

string

None.
ContactId

integer

None.
AddressLine1

string

None.
AddressLine2

string

None.
AddressLine3

string

None.
City

string

None.
StateCode

string

None.
ZipCode

string

None.
EmailAddress

string

None.
Phone

string

None.
Extension

string

None.
FSPaymentResponseId

integer

None.
FSReverseResponseId

integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "CustomerPaymentId": 1,
  "PaymentBilledDateTime": "2024-11-21T04:37:49.4582141-05:00",
  "BillDueDate": "2024-11-21T04:37:49.4582141-05:00",
  "AmountBilled": 2.0,
  "PaymentNote": "sample string 3",
  "PaymentStatus": "sample string 4",
  "PostageAccountId": 5,
  "SourceModule": "sample string 6",
  "ContactId": 7,
  "AddressLine1": "sample string 8",
  "AddressLine2": "sample string 9",
  "AddressLine3": "sample string 10",
  "City": "sample string 11",
  "StateCode": "sample string 12",
  "ZipCode": "sample string 13",
  "EmailAddress": "sample string 14",
  "Phone": "sample string 15",
  "Extension": "sample string 16",
  "FSPaymentResponseId": 17,
  "FSReverseResponseId": 18
}

application/xml, text/xml

Sample: 
<InvoiceMethodUpdateRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CustomerPaymentId>1</CustomerPaymentId>
  <PaymentBilledDateTime>2024-11-21T04:37:49.4582141-05:00</PaymentBilledDateTime>
  <BillDueDate>2024-11-21T04:37:49.4582141-05:00</BillDueDate>
  <AmountBilled>2</AmountBilled>
  <PaymentNote>sample string 3</PaymentNote>
  <PaymentStatus>sample string 4</PaymentStatus>
  <PostageAccountId>5</PostageAccountId>
  <SourceModule>sample string 6</SourceModule>
  <ContactId>7</ContactId>
  <AddressLine1>sample string 8</AddressLine1>
  <AddressLine2>sample string 9</AddressLine2>
  <AddressLine3>sample string 10</AddressLine3>
  <City>sample string 11</City>
  <StateCode>sample string 12</StateCode>
  <ZipCode>sample string 13</ZipCode>
  <EmailAddress>sample string 14</EmailAddress>
  <Phone>sample string 15</Phone>
  <Extension>sample string 16</Extension>
  <FSPaymentResponseId>17</FSPaymentResponseId>
  <FSReverseResponseId>18</FSReverseResponseId>
</InvoiceMethodUpdateRequest>

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

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample: 
"sample string 1"

application/xml, text/xml

Sample: 
<string>sample string 1</string>