POST api/order/Payment/Cash/Save

To Add a cash payment for a Order

Request Information

URI Parameters

None.

Body Parameters

CashPaymentViewModel
NameDescriptionTypeAdditional information
OrderID

This is the orderID to apply the payment

integer

Required

PaymentDate

This is the date used by accounting for the payment recorded

date

Required

Amount

The payment amount to apply. This amount must be no greater than the order total.

decimal number

Required

Request Formats

application/xml, text/xml

Sample:
<CashPaymentViewModel>
  <OrderID>1</OrderID>
  <PaymentDate>01/09/2025 01:28:08</PaymentDate>
  <Amount>3</Amount>
</CashPaymentViewModel>

application/json, text/json

Sample:
{
  "OrderID": 1,
  "PaymentDate": "2025-01-09T01:28:08.555216-05:00",
  "Amount": 3.0
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedFormatter' to write type 'CashPaymentViewModel'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/xml, text/xml, application/json, text/json

Sample:

Sample not available.