How to view the Payment Plan via Rest API

Booking Manager allows charter operators and agencies to decide and implement payment plans. Agencies may have payment plans different from those of the charter. All this information is visible and available via API Rest.

How to get the Charter Payment Plan before Starting the Booking Process

Agents using Rest now can obtain a resource's Payment Plan before starting the booking process. To do this they must call the getOffers endpoint for a specific period. 

In the example below we have called the availability of the resource 3896940402400797 for the period 14 -21 September 2024

https://booking-manager.com/api/v2/offers?showOptions=True&yachtId=3896940402400797&dateFrom=2024-09-14T00:00:00&dateTo=2024-09-21T00:00:00

As you can see from the screenshot above, the endpoint returns the Payment Plan requested by the charter in addition to all the other data.

It is important to note that this Payment Plan only applies when the getOffers call is made.

Payment Plan in the Booking Process

Once the boat's availability is checked and the Payment Plan is obtained, the agent can proceed with the booking using the PostCreateReservation endpoint. Using this endpoint the agent will open an Option and display the Charter Payment Plan again.

The Payment Plan data visible in this section and in getOffers are therefore the data entered by the charter, to view how charter operators can enter their Payment Plans click here.

In this case, the system shows you the Payment Plan that the Agent must respect towards the Charter operator.

Once the option is opened, the agent can proceed to open a reservation using the endpoint PutConfirmReservation. 

As you can see from the screenshot, in this case, the Payment Plan is different from the one displayed in previous calls. This is because with this call the booking process is finished and the system shows the Payment Plan of the Agent and no longer of the charter. To view how an Agent can enter their Payment Plans click here.

In this case, the system shows you the Payment Plan that the guest must respect towards the agency.