POST https://api.legendonlineservices.co.uk/Cap2/CreatePaymentVehicle

Create a new payment vehicle

Request Parameters

From Body Type Description
ActiveDate DateTime Optional.
AdditionalAgreement String Optional. Max 50 characters
AdditionalAgreementPrice String Max 50 characters
ContactGuid Guid
CourseReference String Max 50 characters
InventoryCode String Optional. Max 25 characters
InventoryPrice Decimal
LocationGuid Guid
NoInventoryCodeEntered Boolean Optional.
PaymentType String Payment type - singlepayment, membership, regularcharge, additionalmandate
StartCourseDate DateTime 




{
  "ContactGuid": "12b15367-32f2-4170-a0cb-93da68eb5f3f",
  "InventoryCode": "sample string 2",
  "InventoryPrice": 3.0,
  "CourseReference": "sample string 4",
  "LocationGuid": "1d1aceed-b017-46a3-86d3-e25862678f9b",
  "NoInventoryCodeEntered": true,
  "ActiveDate": "2025-04-25T14:11:36.2010768+01:00",
  "StartCourseDate": "2025-04-25T14:11:36.2010768+01:00",
  "PaymentType": "sample string 7",
  "AdditionalAgreement": "sample string 8",
  "AdditionalAgreementPrice": "sample string 9"
}

Response - (Status 200 - OK)

Create payment vehicle response

Name Type Description
FirstPaymentDate DateTime First payment date 




{
  "FirstPaymentDate": "2025-04-25T14:11:36.2167188+01:00"
}

Remarks

This end point replaces the old CreatePaymentVehicle SOAP endpoint that is now obsolete.
Fields below are required for the relevant payment type.
Single payment
- Inventory code
- Inventory price
Regular charge
- Start course date
- Inventory code
- Additional agreement price
Additional mandate
- Start course date
- Inventory code
- Additional agreement price

Bundle(s)
Cap2