POST v1/Generic/InvoiceMethodInsert
Request Information
URI Parameters
None.
Body Parameters
InvoiceMethodInsertRequestName | Description | Type | Additional information |
---|---|---|---|
CustomerPaymentNumber | string |
None. |
|
CustomerId | integer |
Required |
|
UserName | string |
None. |
|
PaymentType | string |
None. |
|
PaymentSource | string |
None. |
|
PaymentBilledDateTime | date |
None. |
|
BillDueDate | date |
None. |
|
AmountBilled | decimal number |
None. |
|
PaymentDue | decimal number |
None. |
|
PaymentReceivedDateTime | date |
None. |
|
PaymentRefundedDateTime | date |
None. |
|
AmountReceived | decimal number |
None. |
|
CurrencyType | string |
None. |
|
CCTransactionId | integer |
None. |
|
CCRefundTransactionID | integer |
None. |
|
PaymentNote | string |
None. |
|
PaymentStatus | 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. |
|
EmailLogs | string |
None. |
|
CreatedDate | date |
None. |
|
PostageAccountId | integer |
Required |
|
PostageCheckId | integer |
None. |
|
SourceModule | string |
None. |
|
FSPaymentResponseId | integer |
None. |
|
FSReverseResponseId | integer |
None. |
|
InvoicePaymentDetailRequest | InvoiceMethodInsertDetailRequest |
None. |
Request Formats
application/json, text/json
Sample:
{ "CustomerPaymentNumber": "sample string 1", "CustomerId": 2, "UserName": "sample string 3", "PaymentType": "sample string 4", "PaymentSource": "sample string 5", "PaymentBilledDateTime": "2024-10-11T08:39:20.0990626-04:00", "BillDueDate": "2024-10-11T08:39:20.0990626-04:00", "AmountBilled": 6.0, "PaymentDue": 7.0, "PaymentReceivedDateTime": "2024-10-11T08:39:20.0990626-04:00", "PaymentRefundedDateTime": "2024-10-11T08:39:20.0990626-04:00", "AmountReceived": 8.0, "CurrencyType": "sample string 9", "CCTransactionId": 10, "CCRefundTransactionID": 11, "PaymentNote": "sample string 12", "PaymentStatus": "sample string 13", "ContactId": 14, "AddressLine1": "sample string 15", "AddressLine2": "sample string 16", "AddressLine3": "sample string 17", "City": "sample string 18", "StateCode": "sample string 19", "ZipCode": "sample string 20", "EmailAddress": "sample string 21", "Phone": "sample string 22", "Extension": "sample string 23", "EmailLogs": "sample string 24", "CreatedDate": "2024-10-11T08:39:20.0990626-04:00", "PostageAccountId": 26, "PostageCheckId": 27, "SourceModule": "sample string 28", "FSPaymentResponseId": 29, "FSReverseResponseId": 30, "InvoicePaymentDetailRequest": { "OrderId": 1, "VersionId": 2, "PaymentLabel": "sample string 3", "AmountBilled": 4.0, "AmountApplied": 5.0 } }
application/xml, text/xml
Sample:
<InvoiceMethodInsertRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <CustomerPaymentNumber>sample string 1</CustomerPaymentNumber> <CustomerId>2</CustomerId> <UserName>sample string 3</UserName> <PaymentType>sample string 4</PaymentType> <PaymentSource>sample string 5</PaymentSource> <PaymentBilledDateTime>2024-10-11T08:39:20.0990626-04:00</PaymentBilledDateTime> <BillDueDate>2024-10-11T08:39:20.0990626-04:00</BillDueDate> <AmountBilled>6</AmountBilled> <PaymentDue>7</PaymentDue> <PaymentReceivedDateTime>2024-10-11T08:39:20.0990626-04:00</PaymentReceivedDateTime> <PaymentRefundedDateTime>2024-10-11T08:39:20.0990626-04:00</PaymentRefundedDateTime> <AmountReceived>8</AmountReceived> <CurrencyType>sample string 9</CurrencyType> <CCTransactionId>10</CCTransactionId> <CCRefundTransactionID>11</CCRefundTransactionID> <PaymentNote>sample string 12</PaymentNote> <PaymentStatus>sample string 13</PaymentStatus> <ContactId>14</ContactId> <AddressLine1>sample string 15</AddressLine1> <AddressLine2>sample string 16</AddressLine2> <AddressLine3>sample string 17</AddressLine3> <City>sample string 18</City> <StateCode>sample string 19</StateCode> <ZipCode>sample string 20</ZipCode> <EmailAddress>sample string 21</EmailAddress> <Phone>sample string 22</Phone> <Extension>sample string 23</Extension> <EmailLogs>sample string 24</EmailLogs> <CreatedDate>2024-10-11T08:39:20.0990626-04:00</CreatedDate> <PostageAccountId>26</PostageAccountId> <PostageCheckId>27</PostageCheckId> <SourceModule>sample string 28</SourceModule> <FSPaymentResponseId>29</FSPaymentResponseId> <FSReverseResponseId>30</FSReverseResponseId> <InvoicePaymentDetailRequest> <OrderId>1</OrderId> <VersionId>2</VersionId> <PaymentLabel>sample string 3</PaymentLabel> <AmountBilled>4</AmountBilled> <AmountApplied>5</AmountApplied> </InvoicePaymentDetailRequest> </InvoiceMethodInsertRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
stringResponse Formats
application/json, text/json
Sample:
"sample string 1"
application/xml, text/xml
Sample:
<string>sample string 1</string>