POST api/boatyard/PayForBooking

Invoices a works order and records payment

Request Information

URI Parameters

None.

Body Parameters

BoatYardBookingPaymentModel
NameDescriptionTypeAdditional information
WOId

Works order id prefixed with marina code

 string

None.
PaymentType

Payment type, if BACS payment type then no payment recorded but invoice generated

 string

None.
PaymentValue

Value of the payment in the system's base currency

 decimal number

None.
PaymentReference

Reference to record against the payment

 string

None.
PaymentSuccessful

Indicates if the payment was successful

 boolean

None.
PaymentMessage

Message to associate with the payment

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "woId": "sample string 1",
  "paymentType": "sample string 2",
  "paymentValue": 3.0,
  "paymentReference": "sample string 4",
  "paymentSuccessful": true,
  "paymentMessage": "sample string 5"
}

multipart/form-data

Sample: 
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="WOId"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="PaymentType"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="PaymentValue"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="PaymentReference"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="PaymentSuccessful"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="PaymentMessage"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample: 
"sample string 1"

multipart/form-data

Sample: 
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name=""

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e--