POST api/BoatRenewalDetails

Queries the database for the Boat Renewal Details based on the account code supplied and returns them

Request Information

URI Parameters

None.

Body Parameters

Account code binding model, sent as a model so it can be subject to modelstate checks

AccountCodeBindingModel
NameDescriptionTypeAdditional information
accountCode

Fixed length account code

 string

Required

Max length: 10
marinaCode

Optional marina code

 string

Max length: 10
boatNo

Optional boat number

 integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "accountCode": "HSMM1113",
  "marinaCode": null,
  "boatNo": null
}

multipart/form-data

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

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

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

1
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

BoatRenewalDetailsBindingModel
NameDescriptionTypeAdditional information
contractId

Unique contract id number

 integer

None.
contractPaid

Flag to see if contract has already been paid

 boolean

None.
contractTotal

As name suggests

 decimal number

None.
marinaCode

As name suggests

 string

None.
marinaName

As name suggests

 string

None.
startDate

As name suggests

 string

None.
endDate

As name suggests

 string

None.
discountApplied

As name suggests

 boolean

None.
discountPercentage

As name suggests

 decimal number

None.
discountValue

As name suggests

 decimal number

None.
preDiscountTotal

As name suggests

 decimal number

None.
depositAmount

The deposit value for this contract. May be 0.

 decimal number

None.
depositAmountPaid

How much has been paid towards the deposit.

 decimal number

None.
payByInstalments

Indicates whether the contract is paid by instalments rather than a lump sum.

 boolean

None.
instalmentValue

Instalment value if paid by instalments, null otherwise.

 decimal number

None.
totalDue

The total contract value less the deposit value.

 decimal number

None.
contractGroupId

The contract group ID for the contract, or for the charging rate if the contract has no specific group set.

 integer

None.
contractGroupDescription

The description of the contract group the contract falls under.

 string

None.
contractLoyaltyDiscountPercentage

Loyalty discount percentage

 decimal number

None.
contractLoyaltyDiscountValue

Loyalty discount value

 decimal number

None.
paymentDate

Date contract paid online

 string

None.
adjustment

Value of manual adjustment made to contract

 decimal number

None.
adjustmentApplied

Indicates if an adjustment has already been applied to the contract

 boolean

None.
totalModified

Indicates if either a discount or an adjustment has already been applied to the contract

 boolean

None.
newContract

Indicates that this is a completely new contract, not a renewal.

 boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "contractId": 0,
  "contractPaid": false,
  "contractTotal": 1050.49,
  "marinaCode": "PM",
  "marinaName": "PremMarina",
  "startDate": "1/1/1999",
  "endDate": "12/12/9999",
  "discountApplied": false,
  "discountPercentage": 3.0,
  "discountValue": 450.26,
  "preDiscountTotal": 1500.75,
  "depositAmount": 0.0,
  "depositAmountPaid": 0.0,
  "payByInstalments": false,
  "instalmentValue": null,
  "totalDue": 0.0,
  "contractGroupId": 0,
  "contractGroupDescription": null,
  "contractLoyaltyDiscountPercentage": 0.0,
  "contractLoyaltyDiscountValue": 0.0,
  "paymentDate": null,
  "adjustment": 0.0,
  "adjustmentApplied": false,
  "totalModified": false,
  "newContract": false
}

multipart/form-data

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

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="contractPaid"

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

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

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

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="startDate"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="endDate"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="discountApplied"

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

9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="discountValue"

10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="preDiscountTotal"

11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="depositAmount"

12
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="depositAmountPaid"

13
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payByInstalments"

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

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="totalDue"

15
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="contractGroupId"

16
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="contractGroupDescription"

sample string 17
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="contractLoyaltyDiscountPercentage"

18
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="contractLoyaltyDiscountValue"

19
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="paymentDate"

sample string 20
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="adjustment"

21
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="adjustmentApplied"

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

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

True
--MultipartDataMediaFormatterBoundary1q2w3e--