BizAway API

Accounts Accounts Credit Cards Accounts Groups Airlines Approval Workflows Booking Snapshots Car bookings Car bookings Edit Cars Company Custom Fields Extra Services Flight bookings Flight bookings Edit General Hotel bookings Hotel bookings Edit Hotel custom rates Hotels Invoice Profiles Invoice Reports Invoices Licence Reports PaymentMethods RailCards RoomTypes Search Search Presets General Train bookings Train bookings Edit Trains Travel Documents TSAKnowTravellerNumbers Users User Cards

GET accounts/settings

Get the static option lists and defaults used to configure account entities.

Authorization: superadmin

GET accounts/email-services-settings

Get the email services a user can link and the email domains that are rejected. These are platform-wide settings: the endpoint takes no account and resolves none, so every caller gets the same payload.

Authorization: guest member admin superadmin

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET accounts/:account_id_or_key

Get the account detail.

Authorization: member admin superadmin

GET accounts/:account_id/credit-lines

Get all credit lines associated with an account.

Authorization: member admin superadmin

POST accounts/:account_id/upload-logo

Upload a logo image on an account.

Authorization: admin app superadmin

Attributes	Type	Authorization	Description
logo optional	file		The logo file

Errors codes
MAX_BYTES_EXCEEDED	You are trying to upload a file that exceed the maximum bytes allowed.
INVALID_FILE_FORMAT	You are trying to upload an invalid file type.

POST accounts/:account_id/documents

Upload a document.

Authorization: admin superadmin

Attributes	Type	Authorization	Description
file optional	file		Document
name optional	string		Document name

Errors codes
MAX_BYTES_EXCEEDED	You are trying to upload a file that exceed the maximum bytes allowed.
INVALID_FILE_FORMAT	You are trying to upload an invalid file type.

POST accounts/:account_id/documents/:id

Delete a document.

Authorization: admin superadmin

Attributes	Type	Authorization	Description
id optional	string		Id of the document

Errors codes
MAX_BYTES_EXCEEDED	You are trying to upload a file that exceed the maximum bytes allowed.
INVALID_FILE_FORMAT	You are trying to upload an invalid file type.

GET accounts/:account_id/cards

List the payment cards of an account. Card numbers are masked by the payment provider and the full number is never available; the token is a provider reference that can be used to charge the card, so treat it as a secret. Unlike the single card reads, this list does not embed the account, billing address or invoice profile objects.

Authorization:

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
stats optional	boolean	When true, include the total number of matching cards.
number optional	string	Filter cards by number. The match runs on the masked number, so only its readable digits can be searched.
name optional	string	Filter cards by name
is_active optional	boolean	Filter credit cards by active/inactive

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST ext/accounts/:account_id/cards

[Called by Proxy] Create an account card, with VGS Vault

Authorization:

Attributes	Type	Description
name required	string	The name of the card.
cvv required	string	CVV of the card.
expiration_date required	object	Expiration of the card
holder_name required	string	Holder name date of the card
number required	string	Number of the card
is_public optional	boolean	Active card to public.
allowed_users optional	array	The users that can see this card
default_bill_address_id optional	null\|string	The id of the adress id.
default_invoice_profile_id optional	null\|string	The invoice profile id.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST ext/accounts/:account_id/cards-3ds

[Called by Proxy] tokenize a card

Authorization:

Attributes	Type	Description
cvv required	string	CVV of the card.
expiration_date required	object	Expiration of the card
holder_name required	string	Holder name date of the card
number required	string	Number of the card
default_bill_address_id optional	null\|string	The id of the adress id.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST accounts/:account_id/cards/3ds-lookup

Prepares a 3DSecure lookup for a card

Authorization:

Attributes	Type	Authorization	Description
nonce required	string		The card nonce
df_reference_id required	string		The device fingerprint reference id

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST accounts/:account_id/cards/verify

Process verification of a card

Authorization:

Attributes	Type	Description
nonce required	string	The card nonce
amount required	string	Amount of the payment for verification
card_name required	string	Name of the card
number required	string	Number of the card
month required	string	Month of the card
year required	string	Year of the card
is_public optional	boolean	Active card to public.
allowed_users optional	array	The users that can see this card
default_bill_address_id optional	null\|string	The id of the adress id.
default_invoice_profile_id optional	null\|string	The invoice profile id.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST accounts/:account_id/cards/create-payment-method-nonce

Create a payment method nonce from a card token

Authorization:

Attributes	Type	Authorization	Description
token required	string		The card token

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST accounts/:account_id/cards/verify-payment-method-nonce

Process verification of a payment method nonce

Authorization:

Attributes	Type	Description
card_id required	string	The card id
nonce required	string	The payment method nonce
amount required	string	Amount of the payment for verification

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST ext/accounts/:account_id/cards/:card_id/vaults

[Called by Proxy] Add Vaults of an user card.

Authorization:

Attributes	Type	Description
cvv optional	string	CVV of the card.
expiration_date optional	object	Expiration of the card
holder_name optional	string	Holder name date of the card
number optional	string	Number of the card

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
INVALID_CARD_CC	Invalid credit card.

GET accounts/:account_id/groups/:group_id

Get one user group of an account. When the group is linked to a travel policy, the policy rules replace the ones stored on the group and travel_policy_name is filled in; the approval toggles are forced off when the account plan does not include approval workflows.

Authorization: member admin app superadmin

POST accounts/:account_id/groups

Create an account group. Policy rules are optional: they apply only if there is no standalone travel policy linked. Policy fields can be included as dot-notation keys (e.g. `policies.hotels.active`) or as a nested `policies` object matching the GET response shape (such as for duplicating a group). Partial payloads merge per leaf path. If you provide a policy field, it updates only that setting—no full replacement is performed. Any omitted fields retain their Mongoose schema defaults. Fields not mentioned are not created or modified. For arrays, sending a value replaces the entire array at that path. If you omit all policy fields, the schema default (`{}`) is stored. To link a travel policy at creation, you may pass `travel_policy_id`. You cannot send `travel_policy_id` together with local policy fields (nested `policies` or dot-notation `policies.*` keys). `travel_policy_id: null` may still be combined with local policy fields when unlinking on update.

Authorization:

Attributes	Type	Description
name required	string	The group name
description optional	string	The group description.
default_bill_address_id optional	null\|string	The default bill address of the user.
default_invoice_profile_id optional	null\|string	The default invoice profile of the user.
supervisors optional	array	The group supervisors.
travel_policy_id optional	null\|string	Optional standalone travel policy to link at creation time. Must belong to the same account and must not be archived. Cannot be combined with local policy fields (nested `policies` or `policies.*` dot keys).
policies.fx_tolerance_percent optional	number	FX tolerance (%) for EUR conversion fallback in multi-currency policy enforcement. Must be between 0 and 100.
policies.hotels.active optional	boolean	The flag that indicates whether or not the hotels policy are active
policies.hotels.action optional	string	The configuration action to take if the policy of the hotels aren't respected.
policies.hotels.addons.bizzyflex.personal.active optional	boolean	Enable BizzyFlex in hotels vertical for personal bookings
policies.hotels.addons.bizzyflex.personal.forced optional	boolean	Force BizzyFlex selection during checkout process for personal bookings
policies.hotels.addons.bizzyflex.business.active optional	boolean	Enable BizzyFlex in hotels vertical for business bookings
policies.hotels.addons.bizzyflex.business.forced optional	boolean	Force BizzyFlex selection during checkout process for business bookings
policies.hotels.max_stars optional	null\|number	The group policy that define the max hotel stars.
policies.hotels.min_checkin_days optional	null\|number	The group policy that define the minimum days before checkin.
policies.hotels.rate_per_night optional	null\|array	The group policy that define the rate per night.
policies.hotels.rate_per_night_per_radius optional	null\|array	The group policy that define the rate per night per radius.
policies.flights.active optional	boolean	The flag that indicates whether or not the flights policy are active
policies.flights.action optional	string	The configuration action to take if the policy of the flights aren't respected.
policies.flights.addons.bizzyflex.personal.active optional	boolean	Enable BizzyFlex in flights vertical for personal bookings
policies.flights.addons.bizzyflex.personal.forced optional	boolean	Force BizzyFlex selection during checkout process for personal bookings
policies.flights.addons.bizzyflex.business.active optional	boolean	Enable BizzyFlex in flights vertical for business bookings
policies.flights.addons.bizzyflex.business.forced optional	boolean	Force BizzyFlex selection during checkout process for business bookings
policies.flights.min_departure_days optional	null\|number	The group policy that define the minimum days before departure for a flight search.
policies.flights.max_cabin_class optional	null\|string	The group policy that define the maximum level of cabin class allowed.
policies.flights.min_duration_per_cabin_class optional	null\|array	The group policy that defines the minimum durations of the flight to be able to buy a fare in a given cabin class.
policies.flights.rate_per_trip optional	null\|array	The group policy that define the rate per flight trip.
policies.flights.min_duration_per_rate_per_trip optional	null\|array	Group policy that defines the minimum flight duration to be able to purchase a fare of a given price.
policies.flights.max_rate_per_period_and_itinerary optional	null\|array	Group policy that defines the maximum flight amount for a trip in a period
policies.flights.max_price_threshold optional	null\|number	Group policy that defines the maximum price for a flight based on the minimum price from the search results.
policies.flights.search_constraints.arrival_time_limit optional	null\|string	Policy that defines the arrival time limit for the outbound in roundtrip flights.
policies.flights.search_constraints.duration_threshold optional	null\|number	Policy that defines the duration threshold based on the minimum duration from the search results.
policies.trains.active optional	boolean	The flag that indicates whether or not the trains policy are active
policies.trains.action optional	string	The configuration action to take if the policy of the trains aren't respected.
policies.trains.addons.bizzyflex.personal.active optional	boolean	Enable BizzyFlex in trains vertical for personal bookings
policies.trains.addons.bizzyflex.personal.forced optional	boolean	Force BizzyFlex selection during checkout process for personal bookings
policies.trains.addons.bizzyflex.business.active optional	boolean	Enable BizzyFlex in trains vertical for business bookings
policies.trains.addons.bizzyflex.business.forced optional	boolean	Force BizzyFlex selection during checkout process for business bookings
policies.trains.min_departure_days optional	null\|number	The group policy that define the minimum days before departure for a train search.
policies.trains.carriages_class optional	null\|string	The group policy that defines the allowed carriage class for trains.
policies.trains.rate_per_trip optional	null\|array	The group policy that define the rate per train trip.
policies.trains.max_rate_per_period_and_itinerary optional	null\|array	Group policy that defines the maximum train ticket amount for a trip in a period
policies.cars.active optional	boolean	The flag that indicates whether or not the cars policy are active
policies.cars.action optional	string	The configuration action to take if the policies of the cars aren't respected.
policies.cars.addons.bizzyflex.personal.active optional	boolean	Enable BizzyFlex in cars vertical for personal bookings
policies.cars.addons.bizzyflex.personal.forced optional	boolean	Force BizzyFlex selection during checkout process for personal bookings
policies.cars.addons.bizzyflex.business.active optional	boolean	Enable BizzyFlex in cars vertical for business bookings
policies.cars.addons.bizzyflex.business.forced optional	boolean	Force BizzyFlex selection during checkout process for business bookings
policies.cars.rate_per_rental optional	null\|array	The group policy that define the rate per car rental.
policies.cars.min_pick_up_days optional	null\|number	The group policy that define the minimum days before departure for a car search.
approval.workflow.id optional	string	The approval workflow id
approval.workflow.approval_steps optional	array	The intermediate steps of the approval workflow.
approval.workflow.finalize_step.users optional	array	The users that can finalize the booking.
approval.flights.active optional	boolean	Whether the group approval workflow (AW) is enabled for flights. When linked, effective value comes from the standalone travel policy (group document value is ignored).
approval.trains.active optional	boolean	Whether the group approval workflow (AW) is enabled for trains. When linked, effective value comes from the standalone travel policy (group document value is ignored).
approval.cars.active optional	boolean	Whether the group approval workflow (AW) is enabled for cars. When linked, effective value comes from the standalone travel policy (group document value is ignored).
approval.hotels.active optional	boolean	Whether the group approval workflow (AW) is enabled for hotels. When linked, effective value comes from the standalone travel policy (group document value is ignored).
approval.travel_requests.active optional	boolean	Whether the group approval workflow (AW) is enabled for travel requests. When linked, effective value comes from the standalone travel policy (group document value is ignored).

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
UNAUTHORIZED_ENTITY_ACCESS	You are not authorized to access, use or change the entity passed.
BAD_REQUEST	Generic error for bad request
NOT_FOUND	The resource you are trying to get not exists.

PUT accounts/:account_id/groups/:group_id

Update account group data. Embedded policy rules (`policies.*`) serve as fallback rules when no standalone travel policy is linked. When a linked travel policy is archived, groups are auto-unassigned and policies are reset to schema defaults. Policy fields use dot-notation parameter names, but may be sent as either flat dot keys or within a nested `policies` object (behaves the same as GET/duplicate). Partial payloads merge per leaf path only: • Provided fields update just that path. • Omitted leaves are left unchanged. • Array fields replace the whole array at that path. You can link a policy by setting `travel_policy_id`, or unlink by setting it to `null`. For unlink: `travel_policy_id: null` plus local policy fields is allowed and keeps the provided rules (no reset to defaults). When linked: local `policies.*` edits are rejected; you must change the standalone travel policy instead. Per-vertical AW toggles (`approval.{vertical}.active`) follow the same rules as `policies.*`: editable on the group when unlinked; when linked, edit the standalone travel policy instead.

Authorization:

Attributes	Type	Description
name optional	string	The group name
description optional	string	The group description
default_bill_address_id optional	null\|string	The default bill address of the user.
default_invoice_profile_id optional	null\|string	The default invoice profile of the user.
supervisors optional	array	The group supervisors.
travel_policy_id optional	null\|string	Link/unlink standalone travel policy for this group. Set to objectId to link, set to null to unlink. Mutually exclusive with local policy fields (`policies` object or `policies.*` dot keys) when linking; `travel_policy_id: null` can be combined with local policy fields to unlink and keep provided rules.
policies.fx_tolerance_percent optional	number	FX tolerance (%) for EUR conversion fallback in multi-currency policy enforcement. Must be between 0 and 100.
policies.hotels.active optional	boolean	The flag that indicates whether or not the hotels policy are active
policies.hotels.max_stars optional	null\|number	The group policy that define the max hotel stars.
policies.hotels.min_checkin_days optional	null\|number	The group policy that define the minimum days before checkin.
policies.hotels.rate_per_night optional	null\|array	The group policy that define the rate per night.
policies.hotels.rate_per_night_per_radius optional	null\|array	The group policy that define the rate per night per radius.
policies.hotels.action optional	string	The configuration action to take if the policy of the hotels aren't respected.
policies.hotels.addons.bizzyflex.personal.active optional	boolean	Enable BizzyFlex in hotels vertical for personal bookings
policies.hotels.addons.bizzyflex.personal.forced optional	boolean	Force BizzyFlex selection during checkout process for personal bookings
policies.hotels.addons.bizzyflex.business.active optional	boolean	Enable BizzyFlex in hotels vertical for business bookings
policies.hotels.addons.bizzyflex.business.forced optional	boolean	Force BizzyFlex selection during checkout process for business bookings
policies.flights.active optional	boolean	The flag that indicates whether or not the flights policy are active
policies.flights.min_departure_days optional	null\|number	The group policy that define the minimum days before departure for a flight search.
policies.flights.max_cabin_class optional	null\|string	The group policy that define the maximum level of cabin class allowed.
policies.flights.min_duration_per_cabin_class optional	null\|array	The group policy that defines the minimum durations of the flight to be able to buy a fare in a given cabin class.
policies.flights.rate_per_trip optional	null\|array	The group policy that define the rate per flight trip.
policies.flights.max_rate_per_period_and_itinerary optional	null\|array	Group policy that defines the maximum flight amount for a trip in a period
policies.flights.min_duration_per_rate_per_trip optional	null\|array	Group policy that defines the minimum flight duration to be able to purchase a fare of a given price.
policies.flights.max_price_threshold optional	null\|number	Group policy that defines the maximum price for a flight based on the minimum price from the search results.
policies.flights.action optional	string	The configuration action to take if the policy of the flights aren't respected.
policies.flights.addons.bizzyflex.personal.active optional	boolean	Enable BizzyFlex in flights vertical for personal bookings
policies.flights.addons.bizzyflex.personal.forced optional	boolean	Force BizzyFlex selection during checkout process for personal bookings
policies.flights.addons.bizzyflex.business.active optional	boolean	Enable BizzyFlex in flights vertical for business bookings
policies.flights.addons.bizzyflex.business.forced optional	boolean	Force BizzyFlex selection during checkout process for business bookings
policies.flights.search_constraints.arrival_time_limit optional	null\|string	Policy that defines the arrival time limit for the outbound in roundtrip flights.
policies.flights.search_constraints.duration_threshold optional	null\|number	Policy that defines the duration threshold based on the minimum duration from the search results.
policies.trains.active optional	boolean	The flag that indicates whether or not the trains policy are active
policies.trains.min_departure_days optional	null\|number	The group policy that define the minimum days before departure for a train search.
policies.trains.carriages_class optional	null\|string	The group policy that defines the allowed carriage class for trains.
policies.trains.rate_per_trip optional	null\|array	The group policy that define the rate per train trip.
policies.trains.action optional	string	The configuration action to take if the policy of the trains aren't respected.
policies.trains.addons.bizzyflex.personal.active optional	boolean	Enable BizzyFlex in trains vertical for personal bookings
policies.trains.addons.bizzyflex.personal.forced optional	boolean	Force BizzyFlex selection during checkout process for personal bookings
policies.trains.addons.bizzyflex.business.active optional	boolean	Enable BizzyFlex in trains vertical for business bookings
policies.trains.addons.bizzyflex.business.forced optional	boolean	Force BizzyFlex selection during checkout process for business bookings
policies.trains.max_rate_per_period_and_itinerary optional	null\|array	Group policy that defines the maximum train ticket amount for a trip in a period
policies.cars.active optional	boolean	The flag that indicates whether or not the cars policy are active
policies.cars.rate_per_rental optional	null\|array	The group policy that define the rate per car rental.
policies.cars.min_pick_up_days optional	null\|number	The group policy that define the minimum days before the pick up for a car search.
policies.cars.action optional	string	The configuration action to take if the policy of the cars aren't respected.
policies.cars.addons.bizzyflex.personal.active optional	boolean	Enable BizzyFlex in cars vertical for personal bookings
policies.cars.addons.bizzyflex.personal.forced optional	boolean	Force BizzyFlex selection during checkout process for personal bookings
policies.cars.addons.bizzyflex.business.active optional	boolean	Enable BizzyFlex in cars vertical for business bookings
policies.cars.addons.bizzyflex.business.forced optional	boolean	Force BizzyFlex selection during checkout process for business bookings
approval.workflow.id optional	string	The approval workflow id
approval.workflow.approval_steps optional	array	The intermediate steps of the approval workflow.
approval.workflow.finalize_step.users optional	array	The users that can finalize the booking.
approval.flights.active optional	boolean	Whether the group approval workflow (AW) is enabled for flights. When linked, effective value comes from the standalone travel policy (group document value is ignored).
approval.trains.active optional	boolean	Whether the group approval workflow (AW) is enabled for trains. When linked, effective value comes from the standalone travel policy (group document value is ignored).
approval.cars.active optional	boolean	Whether the group approval workflow (AW) is enabled for cars. When linked, effective value comes from the standalone travel policy (group document value is ignored).
approval.hotels.active optional	boolean	Whether the group approval workflow (AW) is enabled for hotels. When linked, effective value comes from the standalone travel policy (group document value is ignored).
approval.travel_requests.active optional	boolean	Whether the group approval workflow (AW) is enabled for travel requests. When linked, effective value comes from the standalone travel policy (group document value is ignored).

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
BAD_REQUEST	Generic error for bad request
NOT_FOUND	The resource you are trying to get not exists.

POST accounts/:account_id/groups/:group_id/associate

Associate users to a specific group.

Authorization:

Attributes	Type	Authorization	Description
users_ids required	array		The group name

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

DELETE accounts/:account_id/groups/:group_id

Delete an account group.

Authorization:

Attributes	Type	Authorization	Description
destinatary_group_id optional	null\|string		The group id where to transfer eventually associated users of this group

Errors codes
CANNOT_DELETE_DEFAULT_GROUP	This group cannot be deleted till is the default in the account configurations.
INVALID_DESTINATARY_GROUP	The group where to transfer the users does not exist or belongs to another account.

GET accounts/:account_id/groups/:group_id/supervisors

List the users of the account who can approve bookings for the given group, excluding the members of the group itself. The response is a plain array of full user objects, so no extra call is needed to resolve them, and the fields are reduced as they would be for an account administrator even when the caller is a superadmin.

Authorization: admin app superadmin

POST airlines/:airline_id/upload-logo

Save airline logo

Authorization: admin app superadmin

Attributes	Type	Authorization	Description
logo_square optional	file		The logo file

GET approval-workflows

List approval workflows visible in the requested account context.

Authorization:

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
stats optional	boolean	When true, include the total number of matching workflows.
account_id optional	string	Filter by account identifier. Available with bizaway_manage.
name optional	string	Filter by name (case-insensitive partial match)

GET approval-workflows/:approvalworkflow_id

Get the Approval Workflow detail

Authorization:

POST approval-workflows

Add a new Approval Workflow

Authorization:

Attributes	Type	Description
name required	string	The name of the Workflow
account_id optional	null\|string	The account where the Workflow will be visible. null indicates that is visible to ALL accounts
system optional	boolean	If true the Workflow cannot be deleted via API
price_tolerance_default optional	number	The name of the Workflow
is_message_required optional	boolean	if true, a message for supervisor is required
approval_steps optional	array	The Approval steps
finalize_step.price_tolerance_override optional	boolean	Tells if in this step the user can override the default price tolerance
allow_booking_owner optional	boolean	Tells if the booking owner can finalize the booking
allow_prefill_payment_step optional	boolean	Tells if the booking owner can fill up the billing and payment data on his own
broken_policies_supervisor.is_active optional	boolean	if the broken policies supervisor is active
approval_order optional	array	The order of the approval steps

PUT approval-workflows/:approval_workflow_id

Add a new Approval Workflow for the given account

Authorization:

Attributes	Type	Description
name required	string	The name of the Workflow
account_id optional	null\|string	The account where the Workflow will be visible. null indicates that is visible to ALL accounts
is_message_required optional	boolean	if true, a message for supervisor is required
price_tolerance_default required	string	The name of the Workflow
approval_steps optional	array	The Approval steps
finalize_step.price_tolerance_override optional	boolean	Tells if in this step the user can override the default price tolerance
allow_booking_owner optional	boolean	Tells if the booking owner can finalize the booking
allow_prefill_payment_step optional	boolean	Tells if the booking owner can fill up the billing and payment data on his own
broken_policies_supervisor.is_active optional	boolean	if the broken policies supervisor is active
approval_order optional	array	The order of the approval steps

DELETE approval-workflows/:approval_workflow_id

Delete an Approval Workflow for the given account

Authorization:

GET booking-snapshots

List temporary booking snapshot metadata using the supplied filters.

Authorization:

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
sort optional	string	The sort modality
id optional	string	Filter snapshots by id
booking_model optional	string	Filter snapshots by the booking vertical they belong to.
booking_id optional	string	Filter Snapshots by booking models

POST booking-snapshots

Create a new booking snapshot

Authorization:

Attributes	Type	Authorization	Description
booking_model optional	string		The Mongoose model of the booking
booking_id optional	string		The Booking id

GET booking-snapshots/:booking_snapshot_id

Get temporary booking snapshot metadata. The stored booking payload is not exposed.

Authorization:

POST booking-snapshots/:booking_snapshot_id/restore

Restore a booking snapshot

Authorization:

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET car-bookings

Get the full car bookings list.

Authorization: superadmin

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
sort optional	string	The sort modality
locale required	string	The locale for the language of the results contents.
plan_id optional	string	Filter car bookings by plan id.
id optional	string	Filter car bookings by id
has_extra_services optional	boolean	Filter car bookings by extra services.
extra_services optional	array	Filter car bookings by extra service type.
creator_id optional	string	Filter car bookings by creator id
supervisor_id optional	string	Filter car bookings by supervisor id
billing_address_id optional	string	Filter car bookings by billing address id
invoice_profile_id optional	string	Filter car bookings by invoice profile id
code optional	string	Filter car bookings by code
status optional	string	Filter by booking status, one or more separated by commas. Values: draft, created, approving, approved, rejected, initialized, discarded, expired, processing, voided, processed, cancelling, cancelled, trashed.
created_from optional	string	Filter car bookings by creation from
created_to optional	string	Filter car bookings by creation to
updated_from optional	string	Filter car bookings by update from
updated_to optional	string	Filter car bookings by update to
cancelled_from optional	string	Filter car bookings by cancellation from
cancelled_to optional	string	Filter car bookings by cancellation to
pick_up_id optional	string	Filter car bookings by pick up id
pick_up_date_from optional	string	Filter car bookings by pick up date from
pick_up_date_to optional	string	Filter car bookings by pick up date to
traveller_ids optional	string	Filter car bookings by drivers
needs_approval optional	boolean	Filter car bookings by needs approval
is_policy_respected optional	boolean	Filter car bookings by policy respected
is_archived optional	boolean	Filter car bookings by is_archived
total_amount optional	float	Filter car bookings by total amount
invoice_ids optional	string	Filter car bookings by invoice_id
is_invoiced optional	boolean	Return car bookings that are already invoiced
invoicing_status optional	string	Filter by invoicing status, one or more separated by commas. Values: not_invoiced, partly_invoiced, invoiced.
is_personal optional	boolean	Filter car bookings by is personal
license_fee optional	integer	Filter car bookings by license fee
client_classification optional	string	Filter car bookings by client classification.
client_type optional	string	Filter car bookings by client type.
merchant optional	string	Filter car bookings by merchant
approver_id optional	string	Filter car bookings by approver_id.
currency optional	string	Filter flight bookings by currency
account_id optional	string	Filter car bookings by account_id
account_ids optional	array	Filter car bookings by account_ids
exclude_account_ids optional	array	Filter car bookings by exclude account_ids
provider_code optional	string	Filter car bookings by provider_code
provider_key optional	string	Filter car bookings by provider key
payment_method optional	string	Filter car bookings by payment method
custom_fields optional	string	Custom fields
is_manual optional	boolean	Filter car bookings by manual creation
is_gtm optional	boolean	Filter car bookings by gtm reservaton
automatic_invoice optional	boolean	Filter car bookings if auto invoice is active or not
vendor_name optional	string	Filter car bookings by vendor
full_credit optional	boolean	Filter car bookings by full credit
version optional	number	Filter hotel bookings by version (1, 1.5 or 2)
payment_status optional	string	Filter hotel bookings by payment status (not_paid, partly_paid or paid)
is_negotiated optional	boolean	Filter car bookings if fare is negotiated or not
pnr optional	string	Filter car bookings by PNR field

GET car-bookings/my-account

Get the full car bookings list of an account.

Authorization:

Attributes	Type	Authorization	Description
limit optional	integer		Number of results to return
offset optional	integer		Index of the result to start to return results
sort optional	string		The sort modality
locale required	string		The locale for the language of the results contents.
plan_id optional	string		Filter car bookings by plan id.
id optional	string		Filter car bookings by id
has_extra_services optional	boolean		Filter car bookings by extra services.
extra_services optional	array		Filter car bookings by extra service type.
creator_id optional	string		Filter car bookings by creator id
supervisor_id optional	string		Filter car bookings by supervisor id
billing_address_id optional	string		Filter car bookings by billing address id
invoice_profile_id optional	string		Filter car bookings by invoice profile id
code optional	string		Filter car bookings by code
status optional	string		Filter by booking status, one or more separated by commas. Values: draft, created, approving, approved, rejected, initialized, discarded, expired, processing, voided, processed, cancelling, cancelled, trashed.
created_from optional	string		Filter car bookings by creation from
created_to optional	string		Filter car bookings by creation to
updated_from optional	string		Filter car bookings by update from
updated_to optional	string		Filter car bookings by update to
cancelled_from optional	string		Filter car bookings by cancellation from
cancelled_to optional	string		Filter car bookings by cancellation to
pick_up_id optional	string		Filter car bookings by pick up id
pick_up_date_from optional	string		Filter car bookings by pick up date from
pick_up_date_to optional	string		Filter car bookings by pick up date to
traveller_ids optional	string		Filter car bookings by drivers
needs_approval optional	boolean		Filter car bookings by needs approval
is_policy_respected optional	boolean		Filter car bookings by policy respected
is_archived optional	boolean		Filter car bookings by is_archived
total_amount optional	float		Filter car bookings by total amount
invoice_ids optional	string		Filter car bookings by invoice_id
is_invoiced optional	boolean		Return car bookings that are already invoiced
invoicing_status optional	string		Filter by invoicing status, one or more separated by commas. Values: not_invoiced, partly_invoiced, invoiced.
is_personal optional	boolean		Filter car bookings by is personal
license_fee optional	integer		Filter car bookings by license fee
client_classification optional	string		Filter car bookings by client classification.
client_type optional	string		Filter car bookings by client type.
merchant optional	string		Filter car bookings by merchant
approver_id optional	string		Filter car bookings by approver_id.
currency optional	string		Filter flight bookings by currency
account_id optional	string	superadmin	Filter car bookings by account_id

GET car-bookings/drafts

List partial car bookings that are still in draft status.

Authorization:

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
sort optional	string	The sort modality
stats optional	boolean	When true, include the total number of matching drafts.
locale required	string	The locale for the language of the results contents.
id optional	string	Filter car bookings by id
code optional	string	Filter car bookings by code

GET car-bookings/my-user

Get the full car bookings list of the session user.

Authorization: member admin superadmin

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
sort optional	string	The sort modality
locale required	string	The locale for the language of the results contents.
plan_id optional	string	Filter car bookings by plan id.
id optional	string	Filter car bookings by id
has_extra_services optional	boolean	Filter car bookings by extra services.
extra_services optional	array	Filter car bookings by extra service type.
creator_id optional	string	Filter car bookings by creator id
supervisor_id optional	string	Filter car bookings by supervisor id
billing_address_id optional	string	Filter car bookings by billing address id
invoice_profile_id optional	string	Filter car bookings by invoice profile id
code optional	string	Filter car bookings by code
status optional	string	Filter by booking status, one or more separated by commas. Values: draft, created, approving, approved, rejected, initialized, discarded, expired, processing, voided, processed, cancelling, cancelled, trashed.
created_from optional	string	Filter car bookings by creation from
created_to optional	string	Filter car bookings by creation to
updated_from optional	string	Filter car bookings by update from
updated_to optional	string	Filter car bookings by update to
cancelled_from optional	string	Filter car bookings by cancellation from
cancelled_to optional	string	Filter car bookings by cancellation to
pick_up_id optional	string	Filter car bookings by pick up id
pick_up_date_from optional	string	Filter car bookings by pick up date from
pick_up_date_to optional	string	Filter car bookings by pick up date to
traveller_ids optional	string	Filter car bookings by drivers
needs_approval optional	boolean	Filter car bookings by needs approval
is_policy_respected optional	boolean	Filter car bookings by policy respected
is_archived optional	boolean	Filter car bookings by is_archived
total_amount optional	float	Filter car bookings by total amount
invoice_ids optional	string	Filter car bookings by invoice_id
is_invoiced optional	boolean	Return car bookings that are already invoiced
invoicing_status optional	string	Filter by invoicing status, one or more separated by commas. Values: not_invoiced, partly_invoiced, invoiced.
is_personal optional	boolean	Filter car bookings by is personal
license_fee optional	integer	Filter car bookings by license fee
client_classification optional	string	Filter car bookings by client classification.
client_type optional	string	Filter car bookings by client type.
merchant optional	string	Filter car bookings by merchant
approver_id optional	string	Filter car bookings by approver_id.
currency optional	string	Filter flight bookings by currency

GET car-bookings/:car_booking_id

Get the booking detail.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
locale required	string		The locale for the language of the results contents.

POST car-bookings/:car_booking_id/fetch

Fetch booking data from its provider.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
locale required	string		The locale for the language of the results contents.

POST car-bookings

Create a car booking.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
account_id optional	string	superadmin	The account_id context
user_id optional	string	superadmin	The user_id (owner) of the context
fare_id required	string		The fare of the car selected by the customer.
drivers required	array		Drivers data.
phone optional	string		A phone contact for emergency reason.
notes optional	string		The notes of the booking.
flight_number optional	string		The flight number as arrival detail for the vendor.
arrival_details optional	object		arrival details for the vendor.
extra_services optional	array		The extra services and equipments selected by the customer.
request_services optional	array		The request services and equipments selected by the customer.
billing_address_id optional	string		The billing address id.
billing_address_project optional	string		The project for the billing address.
invoice_profile_id optional	string		The invoice profile id.
payment.method required	string		The payment method.
payment.credit_card_id required when payment_method = cc	string		[Credit Card] the token of the selected credit card.
payment.credit_card_owner required when payment_method = cc	string		[Credit Card] the owner of the selected credit card.
bta_card_id required when payment_method = amex_bta	string		[Amex BTA] amex bta card id.
bta_card_account_id required when payment_method = amex_bta	string		[Amex BTA] the account id of the selected amex bta card.
bta_card_number required when payment_method = amex_bta	string		[Amex BTA] the number of the selected amex bta card.
hokodo_data required when payment_method = hokodo	object		[Hokodo] Object of Hokodo Data
is_personal required	boolean		Indicates if the booking is personal.
custom_fields optional	object		Object of custom fields

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.

PUT car-bookings/:car_booking_id

Update a car booking.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
fare_id optional	string		A new booking rate id.
rate_price optional	number	superadmin	Update the rate price.
rate_provider_price optional	number	superadmin	Update the rate provider price.
issuing_fee optional	number	superadmin	Update the rate issuing fee.
license_fee optional	number	superadmin	Update the license fee.
pick_up optional	object		Object of the outbound cars with the index as a reference. Accepted fields for every car: pnr, departure_airport_terminal, arrival_airport_terminal.
drop_off optional	object		Object of the inbound cars with the index as a reference. Accepted fields for every car: pnr, departure_airport_terminal, arrival_airport_terminal.
pick_up_date optional	string	superadmin	Update the pick up date.
drop_off_date optional	string	superadmin	Update the drop off date.
holder_id optional	string		The holder id.
drivers optional	object		Object of the drivers data with the index as a reference. Accepted fields for every driver id, travel_document_id.
phone optional	string		The emergency phone of the booking.
status optional	string	superadmin	The booking status.
provider_code optional	string	superadmin	The provider code.
billing_address_id optional	string		The billing address id.
billing_address_project optional	string		The project for the billing address.
invoice_profile_id optional	string		The invoice profile id.
is_vat_exempt optional	boolean	superadmin	Update booking vat exempt flag
has_declaration_of_intent optional	boolean	superadmin	Update booking declaration of intent flag
automatic_invoice optional	boolean	superadmin	Define if the booking will be automatically invoices
inner_transactions optional	array	superadmin	Update booking inner transactions
transaction_costs optional	number	superadmin	Update the transaction costs.
invoice_id optional	null\|string	superadmin	Update the booking invoice.
provider_key optional	string	superadmin	Update the provider key of the booking. Must be one of the values returned by vertical_fare_sources for this vertical.
driver_birthday optional	object	superadmin	Update driver birthday.
is_personal optional	boolean	superadmin	Update the booking is_personal.
is_archived optional	boolean	superadmin	Update the booking is_archived.
custom_fields optional	object		Object of custom fields
is_gtm optional	boolean	superadmin	Define if the booking is a GTM booking
version optional	number	superadmin	Update the version of the booking.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
NOT_FOUND	The resource you are trying to get not exists.
MISSING_USER_INFO	There are missing info to the user associated to a specific field.
MISSING_DOCUMENT	Missing document for a specific passenger.
DOCUMENT_EXPIRATION_ISSUE	The document you request is expired or will expire during the trip
INVALID_DOCUMENT_OWNER	The document you passed does not belong to the passenger declared.
FARE_EXPIRED	The fare you request is not anymore valid

POST car-bookings/:car_booking_id/initialize

Initialize a car booking creating the booking provider.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
account_id optional	string	superadmin	The account_id context

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
BOOKING_NOT_VALID_STATUS	This booking is not in a valid status to execute the requested operation.
FARE_EXPIRED	The fare you request is not anymore valid

POST car-bookings/:car_booking_id/approve

Approve the current booking

Authorization:

Attributes	Type	Authorization	Description
price_tolerance optional	number

Errors codes
BOOKING_NOT_VALID_STATUS	This booking is not in a valid status to execute the requested operation.

POST car-bookings/:car_booking_id/reject

Reject booking.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
message optional	string		Custom message to the booking creator.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
BOOKING_NOT_VALID_STATUS	This booking is not in a valid status to execute the requested operation.

POST car-bookings/:car_booking_id/void

Void booking.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
message optional	string		Custom message to the booking creator.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
BOOKING_NOT_VALID_STATUS	This booking is not in a valid status to execute the requested operation.

POST car-bookings/:car_booking_id/trash

Trash booking.

Authorization: member admin superadmin

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
BOOKING_NOT_VALID_STATUS	This booking is not in a valid status to execute the requested operation.

POST car-bookings/calculate-costs

Calculate costs of a car booking.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
account_id optional	string	superadmin	The account_id context
car_booking_id required if rate_id not filled	objectId		The car booking id.
rate_id required if booking_id not filled	string		The rate of the car selected by the customer.
locale optional	string		The locale.
extra_services optional	array		Array of extra services and equipments selected by the customer.
request_services optional	array		Array of request services selected by the customer.
payment_method optional	string		The payment method.
billing_address_id optional	string		The billing address id
additional_driver_birthday optional	string		The birthday in format YYYY/MM/DD of the additional driver
credit_card_id required when payment_method = cc	string		[Credit Card] the token of the selected credit card.
credit_card_owner required when payment_method = cc	string		[Credit Card] the owner of the selected credit card.
is_personal required	boolean		Indicates if the booking is personal.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.

POST car-bookings/generate-csv

Generate a csv file with the full car bookings list

Authorization: superadmin

Attributes	Type	Description
creator_id optional	string	Filter car bookings by creator id
supervisor_id optional	string	Filter car bookings by supervisor id
code optional	string	Filter car bookings by code
locale optional	string	The locale for the language of the results contents.
status optional	array	Filter car bookings by status
created_from optional	string	Filter car bookings by creation from
created_to optional	string	Filter car bookings by creation to
updated_from optional	string	Filter car bookings by update from
updated_to optional	string	Filter car bookings by update to
pick_up_id optional	string	Filter car bookings by pick up location
pick_up_date_from optional	string	Filter car bookings by pick up date from
pick_up_date_to optional	string	Filter car bookings by pick up date to
traveller_ids optional	array	Filter car bookings by guests
needs_approval optional	boolean	Filter car bookings by needs approval
invoice_ids optional	array	Filter car bookings by invoice_id
is_invoiced optional	boolean	Return car bookings that are already invoiced
invoicing_status optional	array	Return car bookings based on its invoicing status
invoice_profile_id optional	string	Filter car bookings by invoice profile id
custom_fields optional	string	Custom fields
extra_services optional	array	Filter car bookings by extra service type.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.

POST car-bookings/my-account/generate-csv

Generate a csv file with the full car bookings list of an account

Authorization: admin superadmin

Attributes	Type	Authorization	Description
creator_id optional	string		Filter car bookings by creator id
supervisor_id optional	string		Filter car bookings by supervisor id
code optional	string		Filter car bookings by code
locale optional	string		The locale for the language of the results contents.
status optional	array		Filter car bookings by status
created_from optional	string		Filter car bookings by creation from
created_to optional	string		Filter car bookings by creation to
updated_from optional	string		Filter car bookings by update from
updated_to optional	string		Filter car bookings by update to
pick_up_id optional	string		Filter car bookings by pick up location
pick_up_date_from optional	string		Filter car bookings by pick up date from
pick_up_date_to optional	string		Filter car bookings by pick up date to
traveller_ids optional	array		Filter car bookings by guests
needs_approval optional	boolean		Filter car bookings by needs approval
invoice_ids optional	array		Filter car bookings by invoice_id
is_invoiced optional	boolean		Return car bookings that are already invoiced
invoicing_status optional	array		Return car bookings based on its invoicing status
invoice_profile_id optional	string		Filter car bookings by invoice profile id
custom_fields optional	string		Custom fields
extra_services optional	array		Filter car bookings by extra service type.
account_id optional	string	superadmin	Filter car bookings by account_id
include_deleted_custom_fields optional	boolean		Flag to include deleted Custom Fields

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.

POST car-bookings/my-user/generate-csv

Generate a csv file with the full car bookings list of an account

Authorization: member admin superadmin

Attributes	Type	Description
creator_id optional	string	Filter car bookings by creator id
supervisor_id optional	string	Filter car bookings by supervisor id
code optional	string	Filter car bookings by code
locale optional	string	The locale for the language of the results contents.
status optional	array	Filter car bookings by status
created_from optional	string	Filter car bookings by creation from
created_to optional	string	Filter car bookings by creation to
updated_from optional	string	Filter car bookings by update from
updated_to optional	string	Filter car bookings by update to
pick_up_id optional	string	Filter car bookings by pick up location
pick_up_date_from optional	string	Filter car bookings by pick up date from
pick_up_date_to optional	string	Filter car bookings by pick up date to
traveller_ids optional	array	Filter car bookings by guests
needs_approval optional	boolean	Filter car bookings by needs approval
invoice_ids optional	array	Filter car bookings by invoice_id
is_invoiced optional	boolean	Return car bookings that are already invoiced
invoicing_status optional	array	Return car bookings based on its invoicing status
invoice_profile_id optional	string	Filter car bookings by invoice profile id
custom_fields optional	string	Custom fields
extra_services optional	array	Filter car bookings by extra service type.
is_personal optional	boolean	Filter hotel bookings by is_personal

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.

POST car-bookings/:car_booking_id/initialize-payment

Initialize a payment

Authorization: member admin superadmin

Attributes	Type	Description
payment_method required	string	The payment method.
credit_card_id required when payment_method = cc	string	[Credit Card] the token of the selected credit card.
credit_card_owner required when payment_method = cc	string	[Credit Card] the owner of the selected credit card.
paypal_payment_id required when payment_method = paypal	string	[PayPal] the paypal payment_id.
paypal_payer_id required when payment_method = paypal	string	[PayPal] the paypal payer id.
change_payment_method optional	boolean	Flag that indicates if the action is used to initialize a new payment method.
bta_card_id required when payment_method = amex_bta	string	[Amex BTA] amex bta card id.
bta_card_account_id required when payment_method = amex_bta	string	[Amex BTA] the account id of the selected amex bta card.
bta_card_number required when payment_method = amex_bta	string	[Amex BTA] the number of the selected amex bta card.
hokodo_data required when payment_method = hokodo	object	[Hokodo] Object of Hokodo Data

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
INSUFFICIENT_FOUNDS_CC	There not enough money to execute the operation you request on the credit card of the user.
LIMIT_EXCEEDED_CC	Unable to execute this operation, you have exceeded the maximum amount for your credit card.
CONTACT_TO_THE_BANK	Unable to execute this operation, please contact your bank for more info!
EXPIRED_CARD_CC	Your credit card looks like its already expired
COMPROMISED_CC	The credit card has been flagged as lost, stolen, or otherwise compromised.
CARDHOLDER_STOP_CC	The cardholder has requested their bank to stop all billing for this card.
SECURITY_VIOLATION_CC	The issuing bank detected a security violation and declined the transaction.
FRAUD_CC	The credit card has been flagged as fraud.
TEMPORARY_ISSUE_CC	Unable to execute this operation due to a temporary issue with the bank, try again!

POST car-bookings/:car_booking_id/process

Process a car booking.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
transaction_id optional	string		The transaction_id to use in order to process this booking, not required for payment method === `postpay`

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
PAYMENT_TRANSACTION_REQUIRED	An active payment transaction is required before confirming this booking.
RATE_EXPIRED	The rate you request is not anymore valid
PROVIDER_ERROR	There was an issue with our provider. This can be a temporary problem. Please, retry in a few moments..

PUT car-bookings/:car_booking_id/refresh-rate

Refresh the rate of a car booking whose provider quote has expired.

Authorization: member admin superadmin

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
RATE_EXPIRED	The rate you request is not anymore valid
PROVIDER_ERROR	There was an issue with our provider. This can be a temporary problem. Please, retry in a few moments..
RESOURCE_BUSY	Resource is busy
BOOKING_NOT_VALID_STATUS	This booking is not in a valid status to execute the requested operation.

POST car-bookings/:car_booking_id/cancel

Cancel a confirmed booking.

Authorization:

Attributes	Type	Authorization	Description
force optional	string		This parameter is used to force the booking into status Cancelled when SuperAdmin.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST car-bookings/:car_booking_id/complete-cancel

Complete an car booking cancellation.

Authorization: member admin superadmin

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST car-bookings/:car_booking_id/complete-process

Complete a car booking process.

Authorization: member admin superadmin

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET car-bookings/:car_booking_id/voucher

Get a voucher download URL. If the requested locale has no voucher, this GET generates and persists one; regenerate forces regeneration.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
locale optional	string		Voucher locale. Required unless regenerate=multi.
regenerate optional	string		Use single to regenerate the requested locale or multi to regenerate all supported locales. Regeneration persists generated files.

POST car-bookings/:car_booking_id/edit/price-changes

Adds new price change to a booking

Authorization:

Attributes	Type	Description
reference optional	string	Reference of price change
reference_id optional	string	The id of the reference
reference_type optional	string	The type of the reference on the price change
amount optional	number	The amount of the price change
date optional	string	The date when the price change occurs
reference_transaction optional	string	The id of the transaction
type optional	string	The type of the price change

GET car-bookings/:car_booking_id/edit/price-changes

Get booking price changes section

Authorization:

PUT car-bookings/:car_booking_id/edit/price-changes/:price_change_id

Updates a price change from a booking

Authorization:

Attributes	Type	Description
reference optional	string	Reference of price change
reference_id optional	string	The id of the reference
reference_type optional	string	The type of the reference on the price change
amount optional		The amount of the price change
date optional	string	The date when the price change occurs
reference_transaction optional	string	The id of the transaction
type optional	string	The type of the price change

DELETE car-bookings/:car_booking_id/edit/price-changes/:price_change_id

Delete a price change from a booking

Authorization:

POST car-bookings/:car_booking_id/edit/price-changes/confirm

Confirm all price changes that are in draft status

Authorization:

POST car-bookings/:car_booking_id/edit/price-changes/discard

Discard all price changes that are in draft status

Authorization:

DELETE car-bookings/:car_booking_id

Delete booking (DRAFT) only

Authorization:

Errors codes
BOOKING_NOT_VALID_STATUS	This booking is not in a valid status to execute the requested operation.
NOT_FOUND	The resource you are trying to get not exists.

POST car-bookings/create

Create booking from scratch

Authorization:

Attributes	Type	Description
provider_key optional	string	The provider key of the booking
provider_currency optional	string	The provider currency of the booking
merchant optional	string	The provider currency of the booking
account_id optional	string	The account_id of the booking
assigned_to optional	string	The superadmin assigned to the booking
user_id optional	string	The owner of the booking
is_personal optional	boolean	If true the booking was for personal purposes

POST car-bookings/:car_booking_id/duplicate

Duplicate a booking

Authorization:

Attributes	Type	Authorization	Description
user_id optional	string		The owner of the booking

GET car-bookings/:car_booking_id/edit

Get the booking in the edit-flow shape. Nested account, users and billing entities are fully expanded; this differs from the standard car booking detail response.

Authorization:

PUT car-bookings/:car_booking_id/edit/rate

Update booking rate section

Authorization:

Attributes	Type	Authorization	Description
rate optional	object		The rate of the booking

PUT car-bookings/:car_booking_id/edit/rate/product_info

Update booking rate section adding the product info file

Authorization:

Attributes	Type	Authorization	Description
car_rental_company required	string		Car rental company id
product_info required	file		The product info of the car rental company

PUT car-bookings/:car_booking_id/edit/car

Update booking car section

Authorization:

Attributes	Type	Authorization	Description
car optional	object		The car of the booking

PUT car-bookings/:car_booking_id/edit/drivers

Update booking drivers section

Authorization:

Attributes	Type	Authorization	Description
drivers optional	array		Array with all drivers informations.

PUT car-bookings/:car_booking_id/edit/billing

Update booking billing section

Authorization:

Attributes	Type	Description
billing_address_id optional	string	The billing address id of the booking
invoice_profile_id optional	string	The invoice profile of the booking
automatic_invoice optional	boolean	The Flag of automatic invoice

PUT car-bookings/:car_booking_id/edit/general

Update booking general section

Authorization:

Attributes	Type	Description
holder_id optional	string	The holder of the booking
account_id optional	string	The account of the booking
pnr optional	string	The PNR of the booking
provider_code optional	string	The provider code of the booking
provider_key optional	string	Update the provider key of the booking. Must be one of the values returned by vertical_fare_sources for this vertical.
is_personal optional	boolean	If true the booking is for personal use
trip_id optional	string	The Trip associated to booking
checkin_email optional	string	The Check in Email associated to booking
phone optional	string	The Phone number associated to booking

PUT car-bookings/:car_booking_id/edit/status

Change status of the booking

Authorization:

Attributes	Type	Authorization	Description
status optional	string		The new status of the booking

PUT car-bookings/:car_booking_id/edit/payment

Update booking payment section

Authorization:

Attributes	Type	Description
method optional	string	The method used for pay the booking
transaction_id optional	string	The transaction associated
card_id optional	string	The card id for the payment
card_owner optional	string	The card id for the payment
amount optional	number	The commission fee for the secured transaction

GET car-bookings/:car_booking_id/edit/validate

Validate every section of the booking. On success it returns the edit-shaped booking; a failed validation returns HTTP 400 VALIDATE_BOOKING_FAILED with the failing section and its field errors.

Authorization:

GET car-bookings/:car_booking_id/edit/:section/validate

Validate a single section of the booking. On success it returns the edit-shaped booking; a failed validation returns HTTP 400 VALIDATE_BOOKING_FAILED with the field errors of the section.

Authorization:

Attributes	Type	Authorization	Description
section optional	string		The booking section to validate.

GET car-bookings/:car_booking_id/edit/provider

Fetch the booking live from the rental provider instead of the BizAway database. The call is slow, depends on provider availability and may be rate limited; do not use it as a cheap local read.

Authorization:

DELETE car-bookings/:car_booking_id/edit/rate/product_info

Remove booking rate section product info

Authorization:

GET cars/location

Get a car location entity

Authorization: member admin app superadmin

Attributes	Type	Description
id optional	string	The location id from the db _id
type optional	string	The location type airport or place
locale optional	string	The locale language you want the response in i.e en_us for american english

POST cars/fares/searches

Create a cars search fares session

Authorization:

Attributes	Type	Authorization	Description
account_id Required only for superadmins	string		The account_id context
search_solution_id required	string		A search solution id

GET cars/fares/searches/:search_id

Get Fare search result

Authorization:

Attributes	Type	Authorization	Description
account_id Required only for superadmins	string		The account_id context

POST cars/fares

POST for a single car Fares

Authorization:

Attributes	Type	Authorization	Description
account_id Required only for superadmins	string		The account_id context
search_fare_id required	string		A search fare id.

GET cars/fares/:fare_id

Get a single car Fares

Authorization:

Attributes	Type	Authorization	Description
locale required	string		The locale for the language of the results contents.
account_id required	string		The account_id context

POST cars/charging-info

Returns the charging dates information

Authorization:

Attributes	Type	Authorization	Description
fare_id optional	string		The rate id.
payment_method optional	string		The payment method.

GET company/suppliers

List the suppliers of the BizAway company, used as counterparts of received fiscal documents. This is company bookkeeping master data, unrelated to travel providers and to customer accounts.

Authorization: superadmin

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
sort optional	string	The sort modality
stats optional	boolean	When true, include the total number of matching suppliers.
id optional	string	Filter suppliers by id
company optional	string	Filter suppliers by company
country optional	string	Filter suppliers by country
vat_number optional	string	Filter suppliers by vat number
tax_code optional	string	Filter suppliers by tax code

GET company/suppliers/:supplier_id

Get one supplier of the BizAway company, including its tax identifiers and the defaults prefilled on its fiscal documents.

Authorization: superadmin

POST company/suppliers

Create a company supplier

Authorization: superadmin

Attributes	Type	Description
type required	string	The supplier company name
company required	string	The supplier company name
address required	string	The supplier address
city required	string	The supplier city
region required	string	The supplier state or the province
postal_code required	string	The supplier postal code
country required	string	The supplier country
vat_number optional	string	The supplier VAT number
tax_code optional	string	The supplier tax code if any
default_vat_code optional	string	The supplier default vat code
default_counterpart optional	string	The supplier default counterpart

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

PUT company/suppliers/:supplier_id

Update a company supplier.

Authorization: superadmin

Attributes	Type	Description
type optional	string	The supplier company name
company optional	string	The supplier company name
address optional	string	The supplier address
city optional	string	The supplier city
region optional	string	The supplier state or the province
postal_code optional	string	The supplier postal code
country optional	string	The supplier country
vat_number optional	string	The supplier VAT number
tax_code optional	string	The supplier tax code if any
default_vat_code optional	string	The supplier default vat code
default_counterpart optional	string	The supplier default counterpart

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

DELETE company/suppliers/:supplier_id

Delete a company supplier.

Authorization: superadmin

GET company/payment-methods

List the payment method labels used in the company bookkeeping, for example to record how a received invoice was paid. These carry no payment instrument data: no card number, IBAN or holder. For customer payment cards use the account card or company card endpoints instead.

Authorization: superadmin

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
stats optional	boolean	When true, include the total number of payment methods.
filter optional	string	Accepted and validated as JSON but ignored: this list applies no generic filtering.

GET company/payment-methods/:payment_method_id

Get one payment method label of the company bookkeeping. It carries no payment instrument data.

Authorization: superadmin

POST company/payment-methods

Create a company payment method

Authorization: superadmin

Attributes	Type	Authorization	Description
name required	string		The payment method name
description optional	string		The payment method description

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

PUT company/payment-methods/:payment_method_id

Update a company payment method.

Authorization: superadmin

Attributes	Type	Authorization	Description
name optional	string		The payment method name
description optional	string		The payment method description

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

DELETE company/payment-methods/:payment_method_id

Delete a company payment method.

Authorization: superadmin

GET company/fiscal-documents

List the fiscal documents the BizAway company received from its suppliers, each with its supplier and payment method embedded. These are not the invoices issued to customer accounts, which live under /v1/invoices.

Authorization: superadmin

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
stats optional	boolean	When true, include the total number of matching fiscal documents.
id optional	string	Filter fiscal documents by id
supplier_id optional	string	Filter fiscal documents by the supplier that issued them
type optional	string	Filter fiscal documents by type
number optional	string	Filter fiscal documents by number
created_from optional	string	Filter fiscal documents by creation from
created_to optional	string	Filter fiscal documents by creation to
issue_date_from optional	string	Filter fiscal documents by issued from
issue_date_to optional	string	Filter fiscal documents by issued to
is_paid optional	boolean	Filter paid fiscal documents
is_registered optional	boolean	Filter registered fiscal documents
total_invoice optional	float	Filter fiscal documents by total amount
payment_deadline_from optional	string	Filter fiscal documents by payment deadline from
payment_deadline_to optional	string	Filter fiscal documents by payment deadline to
payment_date_from optional	string	Filter fiscal documents by payment date from
payment_date_to optional	string	Filter fiscal documents by payment date to

GET company/fiscal-documents/:fiscal_document_id

Get one fiscal document received by the BizAway company, with its supplier and payment method embedded.

Authorization: superadmin

POST company/fiscal-documents

Create a company fiscal document

Authorization: superadmin

Attributes	Type	Description
type required	string	The fiscal document type
number required	string	The fiscal document number
issue_date required	string	The fiscal document issue date
supplier_id required	string	The fiscal document supplier id
description optional	string	The fiscal document description
currency required	string	The fiscal document currency
total_taxable_income required	float	The fiscal document total taxable income
total_vat_amount required	float	The fiscal document total vat amount
total_withholding_amount required	float	The fiscal document total withholding amount
total_invoice required	float	The fiscal document total invoice
is_registered optional	boolean	The fiscal document is registered flag
is_paid optional	boolean	The fiscal document is paid flag
payment_method_id optional	string	The fiscal document payment method id
payment_ref optional	string	The fiscal document reference id
payment_date optional	string	The fiscal document payment date
payment_deadline optional	string	The fiscal document payment deadline
linked_invoices optional	array	The fiscal document linked invoice array
vat_code optional	string	The fiscal document vat code
counterpart optional	string	The fiscal document counterpart

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

PUT company/fiscal-documents/:fiscal_document_id

Update a company fiscal document.

Authorization: superadmin

Attributes	Type	Description
type required	string	The fiscal document type
number optional	string	The fiscal document number
issue_date optional	string	The fiscal document issue date
supplier_id optional	string	The fiscal document supplier id
description optional	string	The fiscal document description
currency optional	string	The fiscal document currency
total_taxable_income optional	float	The fiscal document total taxable income
total_vat_amount optional	float	The fiscal document total vat amount
total_withholding_amount optional	float	The fiscal document total withholding amount
total_invoice optional	float	The fiscal document total invoice
is_registered optional	boolean	The fiscal document is registered flag
is_paid optional	boolean	The fiscal document is paid flag
payment_method_id optional	string	The fiscal document payment method id
payment_ref optional	string	The fiscal document reference id
payment_date optional	null\|string	The fiscal document payment date
linked_invoices optional	array	The fiscal document linked invoice array
payment_deadline optional	null\|string	The fiscal document payment deadline
vat_code optional	string	The fiscal document vat code
counterpart optional	string	The fiscal document counterpart

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST company/fiscal-documents/:fiscal_document_id/file

Add a company fiscal document file

Authorization: superadmin

Attributes	Type	Authorization	Description
file required	file		The fiscal document file

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST company/fiscal-documents/export

Export fiscal documents

Authorization: superadmin

Attributes	Type	Description
type optional	string	Filter fiscal documents by type
created_from optional	string	Filter fiscal documents by creation from
created_to optional	string	Filter fiscal documents by creation to
issue_date_from optional	string	Filter fiscal documents by issued from
issue_date_to optional	string	Filter fiscal documents by issued to
supplier_id optional	string	Filter fiscal documents by supplier_id
is_paid optional	boolean	Filter paid fiscal documents
is_registered optional	boolean	Filter registered fiscal documents

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

DELETE company/fiscal-documents/:fiscal_document_id

Delete a company fiscal document

Authorization: superadmin

GET custom-fields

List current v2 custom-field definitions for an account.

Authorization: admin superadmin

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
sort optional	string	The sort modality
account_id optional	string	Filter custom fields by account_id.
entity_types optional	string	Filter custom fields by entity types.
is_deleted optional	boolean	Filter custom fields by is_deleted false.
available_for_approval optional	boolean	Filter custom fields by available for approval.
name optional	string	Filter custom fields by name.

GET custom-fields/:custom_fields_id

Get a legacy v1 custom-field definition by id. It returns the same definition as the v2 read except that values is flattened to display strings, losing the key, the description and the deleted flag of each value; deleted values are included with no way to tell them apart. Prefer the v2 read, which is what the BizAway clients use. There is no v1 list counterpart. Deleted definitions are returned as well, so check is_deleted.

Authorization: admin superadmin

GET custom-fields/:custom_fields_id

Get a custom-field definition by id. This is the current read: values keeps the key, the localized description and the deleted flag of every option. Deleted definitions are returned as well, so check is_deleted.

Authorization: admin superadmin

DELETE custom-fields/:custom_fields_id

Set 'is_deleted' true on a giving custom fields

Authorization: admin superadmin

POST custom-fields

Create a single custom field.

Authorization: admin superadmin

Attributes	Type	Authorization	Description
account_id optional	string	superadmin	The account_id of custom fields. Is required if i am a superadmin
name required	string		The name of custom fields.
type required	string		The type of custom fields.
key optional	string		The name convert in lowercase and without space
values optional	array		The values of single checkbox or select
position required	number		Position of custom field
entity_type required	array		the Entity type of custom field
is_deleted optional	boolean		check if custom field is deleted
roles optional	array		The roles that custom field is associated
is_csv_export optional	boolean		check if custom field exportabled
is_required optional	boolean		check if custom field is required
is_editable optional	boolean		check if custom field is editable by user
available_for_approval optional	boolean		check if custom field is available for approval
is_filterable optional	boolean		check if custom field is filterable
properties optional	object		Required custom field

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

PUT custom-fields/:custom_fields_id

Update custom fields

Authorization: member admin superadmin

Attributes	Type	Description
descriptions.en_us optional	string	The description values for the locale en_us
descriptions.it_it optional	string	The description values for the locale it_it
descriptions.es_es optional	string	The description values for the locale es_es
descriptions.de_de optional	string	The description values for the locale de_de
descriptions.ru_ru optional	string	The description values for the locale ru_ru
descriptions.fr_fr optional	string	The description values for the locale fr_fr
descriptions.pt_pt optional	string	The description values for the locale pt_pt
descriptions.nl_nl optional	string	The description values for the locale nl_nl
descriptions.pl_pl optional	string	The description values for the locale pl_pl
descriptions.cs_cz optional	string	The description values for the locale cs_cz
descriptions.sk_sk optional	string	The description values for the locale sk_sk
descriptions.hu_hu optional	string	The description values for the locale hu_hu
descriptions.sv_se optional	string	The description values for the locale sv_se
name optional	string	The name of custom fields.
values optional	array	The values of single checkbox or select
position optional	number	Position of custom field
is_csv_export optional	boolean	Export Csv of custom field
is_filterable optional	boolean	Filtered of custom field
is_required optional	boolean	Required custom field
is_editable optional	boolean	Editable custom field
available_for_approval optional	boolean	check if custom field is available for approval
properties optional	object	Required custom field

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

PUT custom-fields/update-entity/custom-fields

Update entity type custom fields

Authorization: member admin superadmin

Attributes	Type	Description
entity_type required	string	The name of the entity
entity_id optional	string	The ID of entity
custom_fields optional	object	Object of custom fields

GET extra-services

List the manual extra services BizAway staff can add to a booking, such as fees and ancillary products. The category and type vocabularies come from the platform configuration and are listed by the settings and types routes.

Authorization: superadmin

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
sort optional	string	The sort modality
stats optional	boolean	When true, include the total number of matching extra services.
category optional	string	Filter extra services by category, one or more separated by commas. The available categories are configuration driven, so read them from GET /v1/extra-services/settings rather than assuming a fixed list.
type optional	string	Filter extra services by type, one or more separated by commas. The types available for each category are configuration driven and listed by GET /v1/extra-services/settings.
is_active optional	boolean	Filter extra services by active flag.
is_deleted optional	boolean	Filter extra services by deleted flag.
accounts optional	array	Filter extra services by accounts.

GET extra-services/settings

Get the configuration used to create manual extra services: the categories, the types available in each of them, the rule keys each category supports and the statuses an extra service can take on a booking. These are platform-wide values from the configuration, not per-account settings, so they only change with a deploy. For the flat list of type keys use the types route.

Authorization: member admin superadmin

GET extra-services/types

Get every extra service type key as a flat list, without the categories. The same key can belong to more than one category, so use the settings route when the category matters.

Authorization: member admin superadmin

GET extra-services/:extra_service_id

Get one manual extra service. Unlike the list, this read also resolves the accounts referenced by its inclusion and exclusion rules into objects carrying their key and name.

Authorization: member admin superadmin

POST extra-services

Create an extra service.

Authorization: superadmin

Attributes	Type	Description
name optional	string	The extra service name.
category optional	string	The extra service category.
type optional	string	The extra service type.
description optional	object	The extra service description.
is_active optional	boolean	Indicate if the extra services is currently active.
price optional	null\|number	The extra service price.
currency optional	null\|string	The extra service currency.
provider.price optional	null\|number	The provider price.
provider.currency optional	null\|string	The extra service provider currency.
max_quantity optional	number	Indicate the quantity of the extra service.
price_unit optional	string	Indicate if the extra service is applyed to all of the fare travellers or for one.
notes optional	string	The extra service note.
rules.included_accounts_ids optional	array	List of accounts that may be included from the service.
rules.excluded_accounts_ids optional	array	List of accounts that may be excluded from the service.
rules.included_providers_keys optional	array	List of providers keys that may be included from the service.
rules.excluded_providers_keys optional	array	List of providers keys that may be excluded from the service.
rules.min_purchase_hours optional	number	Indicate that when there are less than this number of hours to go until the departure, additional services cannot be ordered.
rules.price_calculation_ref optional	string	Value to consider for calculate the price of the extra service during all the itinerary.
rules.included_airline_ids optional	array	List of airlines that may be included from the service.
rules.excluded_airline_ids optional	array	List of airlines that may be excluded from the service.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

PUT extra-services/:id

Update an extra services.

Authorization: superadmin

Attributes	Type	Description
name optional	string	The extra service name.
type optional	string	The extra service name.
description optional	object	The extra service description.
is_active optional	boolean	Indicate if the extra services is currently active.
price optional	null\|number	The extra service price.
currency optional	null\|string	The extra service currency.
provider.price optional	number	The provider price.
provider.currency optional	null\|string	The extra service provider currency.
max_quantity optional	number	Indicate the quantity of the extra service.
price_unit optional	string	Indicate if the extra service is applyed to all of the fare travellers or for one.
notes optional	string	The extra service note.
rules.included_accounts_ids optional	array	List of accounts that may be included from the service.
rules.excluded_accounts_ids optional	array	List of accounts that may be excluded from the service.
rules.included_providers_keys optional	array	List of providers keys that may be included from the service.
rules.excluded_providers_keys optional	array	List of providers keys that may be excluded from the service.
rules.min_purchase_hours optional	number	Indicate that when there are less than this number of hours to go until the departure, additional services cannot be ordered.
rules.price_calculation_ref optional	string	Value to consider for calculate the price of the extra service during all the itinerary.
rules.included_airline_ids optional	array	List of airlines that may be included from the service.
rules.excluded_airline_ids optional	array	List of airlines that may be excluded from the service.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
NOT_FOUND	The resource you are trying to get not exists.

DELETE extra-services/:id

Delete an extra service.

Authorization: superadmin

Errors codes
NOT_FOUND	The resource you are trying to get not exists.

POST extra-services/add-to-booking

Add an extra service into an entity.

Authorization: superadmin

Attributes	Type	Description
entity_type optional	string	The entity type.
entity_id optional	string	The entity id.
category optional	string	The extra service category.
type optional	string	The extra service name.
status optional	string	The extra service status.
price optional	null\|number	The extra service price.
currency optional	null\|string	The extra service currency.
provider_price optional	number	The provider price.
provider_currency optional	number	The provider currency.
price_unit optional	string	Indicate if the extra service is applyed to all of the fare travellers or for one.
quantity optional	number	The quantity of the extra service.
description optional	object	The extra service description.
trips_ref optional	array	List of trips ref.
selection_type optional	string	The flight extra service selection type.
route optional	string	Indicates which route the extra service is associated with.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

PUT extra-services/:id/update-to-booking

Update an extra service into an entity.

Authorization: superadmin

Attributes	Type	Description
entity_type optional	string	The entity type.
entity_id optional	string	The entity id.
category optional	string	The extra service category.
type optional	string	The extra service name.
quantity optional	number	The quantity of the extra service.
status optional	string	The extra service status.
price optional	number	The extra service price.
currency optional	string	The extra service currency.
provider_price optional	number	The provider price.
provider_currency optional	string	The provider currency.
price_unit optional	string	Indicate if the extra service is applyed to all of the fare travellers or for one.
transaction_id optional	string	The transaction id.
invoice_id optional	null\|string	The invoice id.
trips_ref optional	array	List of trips ref .
selection_type optional	string	The flight extra service selection type.
route optional	string	Indicates which route the extra service is associated with.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST extra-services/:id/delete-to-booking

Delete an extra service into an entity.

Authorization: superadmin

Attributes	Type	Authorization	Description
entity_type optional	string		The entity type.
entity_id optional	string		The entity id.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST extra-services/send-email

Send the summary email of the extra service.

Authorization: superadmin

Attributes	Type	Authorization	Description
entity_type optional	string		The entity type.
entity_id optional	string		The entity id.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST extra-services/initialize-payment

Initialize a manual extra services.

Authorization: superadmin

Attributes	Type	Description
entity_type optional	string	The entity type.
entity_id optional	string	The entity id.
extra_service_id optional	string	The entity id.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST extra-services/process

Process a manual extra services.

Authorization: superadmin

Attributes	Type	Description
entity_type optional	string	The entity type.
entity_id optional	string	The entity id.
extra_service_id optional	string	The extraservice id.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST extra-services/void

Void a manual extra services.

Authorization: superadmin

Attributes	Type	Description
entity_type optional	string	The entity type.
entity_id optional	string	The entity id.
extra_service_id optional	string	The extraservice id.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST extra-services/void-payment

Void a manual extra service payment.

Authorization: superadmin

Attributes	Type	Description
entity_type optional	string	The entity type.
entity_id optional	string	The entity id.
extra_service_id optional	string	The extraservice id.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST ext/flight-bookings/notify-event/:provider/:secure_key

[Call by provider] Notify a booking event

Authorization:

GET flight-bookings

Get the full flight bookings list.

Authorization: superadmin

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
sort optional	string	The sort modality
locale required	string	The locale for the language of the results contents.
plan_id optional	string	Filter flight bookings by plan id.
has_extra_services optional	boolean	Filter flight bookings by extra services.
extra_services optional	array	Filter flight bookings by extra service type.
id optional	string	Filter flight bookings by id
creator_id optional	string	Filter flight bookings by creator id
supervisor_id optional	string	Filter flight bookings by supervisor id
billing_address_id optional	string	Filter flight bookings by billing address id
invoice_profile_id optional	string	Filter flight bookings by invoice profile id
code optional	string	Filter flight bookings by code
status optional	string	Filter by booking status, one or more separated by commas. Values: draft, created, approving, approved, rejected, initialized, discarded, expired, processing, voided, processed, cancelling, cancelled, trashed.
created_from optional	string	Filter flight bookings by creation from
created_to optional	string	Filter flight bookings by creation to
updated_from optional	string	Filter flight bookings by update from
updated_to optional	string	Filter flight bookings by update to
cancelled_from optional	string	Filter flight bookings by cancellation from
cancelled_to optional	string	Filter flight bookings by cancellation to
departure_airport_id optional	string	Filter flight bookings by departure airport
departure_date_from optional	string	Filter flight bookings by departure date from
departure_date_to optional	string	Filter flight bookings by departure date to
traveller_ids optional	array	Filter flight bookings by guests
needs_approval optional	boolean	Filter flight bookings by needs approval
is_policy_respected optional	boolean	Filter flight bookings by policy respected
is_archived optional	boolean	Filter flight bookings by is_archived
total_amount optional	float	Filter flight bookings by total amount
pnr optional	string	Filter flight bookings by flight pnr
invoice_ids optional	string	Filter flight bookings by invoice_id
invoicing_status optional	string	Filter by invoicing status, one or more separated by commas. Values: not_invoiced, partly_invoiced, invoiced.
is_personal optional	boolean	Filter flight bookings by is personal
merchant optional	string	Filter flight bookings by merchant
itinerary_type optional	string	Filter flight bookings by itinerary type
is_manual optional	boolean	Filter flight bookings by is manual
is_gtm optional	boolean	Filter flight bookings by gtm reservaton
license_fee optional	integer	Filter flight bookings by license fee
client_classification optional	string	Filter flight bookings by client classification.
client_type optional	string	Filter flight bookings by client type.
approver_id optional	string	Filter flight bookings by approver_id.
is_vat_recovery_eligible optional	boolean	Filter flight bookings by is_vat_recovery_eligible.
currency optional	string	Filter flight bookings by currency
fare_type optional	string	Filter flight bookings by fare type
account_id optional	string	Filter flight bookings by account_id
account_ids optional	array	Filter flight bookings by account_ids
exclude_account_ids optional	array	Filter flight bookings by exclude account_ids
provider_code optional	string	Filter flight bookings by provider code
provider_key optional	string	Filter flight bookings by provider key
post_confirmation_status optional	string	Filter flight bookings by the status of the post_confirmation property
bizzyflex_statuses optional	string	Filter flight bookings by bizzyflex status
battleface_statuses optional	string	Filter flight bookings by Battleface insurance status
battleface_order_number optional	string	Filter flight bookings by one or more (comma-separated) Battleface insurance order numbers
payment_method optional	string	Filter flight bookings by payment method
custom_fields optional	string	Custom fields
airlines optional	string	Filter flight bookings that contains at least one airline. Format should be all ids separated by ,
automatic_invoice optional	boolean	Filter flight bookings if auto invoice is active or not
version optional	number	Filter flight bookings by version (1, 1.5 or 2)
payment_status optional	string	Filter flight bookings by payment status (not_paid, partly_paid or paid)
is_negotiated optional	boolean	Filter flight bookings if fare is negotiated or not

GET flight-bookings/my-account

Get the full flight bookings list of an account.

Authorization:

Attributes	Type	Authorization	Description
limit optional	integer		Number of results to return
offset optional	integer		Index of the result to start to return results
sort optional	string		The sort modality
locale required	string		The locale for the language of the results contents.
plan_id optional	string		Filter flight bookings by plan id.
has_extra_services optional	boolean		Filter flight bookings by extra services.
extra_services optional	array		Filter flight bookings by extra service type.
id optional	string		Filter flight bookings by id
creator_id optional	string		Filter flight bookings by creator id
supervisor_id optional	string		Filter flight bookings by supervisor id
billing_address_id optional	string		Filter flight bookings by billing address id
invoice_profile_id optional	string		Filter flight bookings by invoice profile id
code optional	string		Filter flight bookings by code
status optional	string		Filter by booking status, one or more separated by commas. Values: draft, created, approving, approved, rejected, initialized, discarded, expired, processing, voided, processed, cancelling, cancelled, trashed.
created_from optional	string		Filter flight bookings by creation from
created_to optional	string		Filter flight bookings by creation to
updated_from optional	string		Filter flight bookings by update from
updated_to optional	string		Filter flight bookings by update to
cancelled_from optional	string		Filter flight bookings by cancellation from
cancelled_to optional	string		Filter flight bookings by cancellation to
departure_airport_id optional	string		Filter flight bookings by departure airport
departure_date_from optional	string		Filter flight bookings by departure date from
departure_date_to optional	string		Filter flight bookings by departure date to
traveller_ids optional	array		Filter flight bookings by guests
needs_approval optional	boolean		Filter flight bookings by needs approval
is_policy_respected optional	boolean		Filter flight bookings by policy respected
is_archived optional	boolean		Filter flight bookings by is_archived
total_amount optional	float		Filter flight bookings by total amount
pnr optional	string		Filter flight bookings by flight pnr
invoice_ids optional	string		Filter flight bookings by invoice_id
invoicing_status optional	string		Filter by invoicing status, one or more separated by commas. Values: not_invoiced, partly_invoiced, invoiced.
is_personal optional	boolean		Filter flight bookings by is personal
merchant optional	string		Filter flight bookings by merchant
itinerary_type optional	string		Filter flight bookings by itinerary type
is_manual optional	boolean		Filter flight bookings by is manual
is_gtm optional	boolean		Filter flight bookings by gtm reservaton
license_fee optional	integer		Filter flight bookings by license fee
client_classification optional	string		Filter flight bookings by client classification.
client_type optional	string		Filter flight bookings by client type.
approver_id optional	string		Filter flight bookings by approver_id.
is_vat_recovery_eligible optional	boolean		Filter flight bookings by is_vat_recovery_eligible.
currency optional	string		Filter flight bookings by currency
fare_type optional	string		Filter flight bookings by fare type
account_id optional	string	superadmin	Filter flight bookings by account_id

GET flight-bookings/drafts

List partial flight bookings that are still in draft status.

Authorization:

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
sort optional	string	The sort modality
stats optional	boolean	When true, include the total number of matching drafts.
locale required	string	The locale for the language of the results contents.
id optional	string	Filter flight bookings by id
code optional	string	Filter flight bookings by code

GET flight-bookings/my-user

Get the full flight bookings list of the session user.

Authorization: member admin superadmin

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
sort optional	string	The sort modality
locale required	string	The locale for the language of the results contents.
plan_id optional	string	Filter flight bookings by plan id.
has_extra_services optional	boolean	Filter flight bookings by extra services.
extra_services optional	array	Filter flight bookings by extra service type.
id optional	string	Filter flight bookings by id
creator_id optional	string	Filter flight bookings by creator id
supervisor_id optional	string	Filter flight bookings by supervisor id
billing_address_id optional	string	Filter flight bookings by billing address id
invoice_profile_id optional	string	Filter flight bookings by invoice profile id
code optional	string	Filter flight bookings by code
status optional	string	Filter by booking status, one or more separated by commas. Values: draft, created, approving, approved, rejected, initialized, discarded, expired, processing, voided, processed, cancelling, cancelled, trashed.
created_from optional	string	Filter flight bookings by creation from
created_to optional	string	Filter flight bookings by creation to
updated_from optional	string	Filter flight bookings by update from
updated_to optional	string	Filter flight bookings by update to
cancelled_from optional	string	Filter flight bookings by cancellation from
cancelled_to optional	string	Filter flight bookings by cancellation to
departure_airport_id optional	string	Filter flight bookings by departure airport
departure_date_from optional	string	Filter flight bookings by departure date from
departure_date_to optional	string	Filter flight bookings by departure date to
traveller_ids optional	array	Filter flight bookings by guests
needs_approval optional	boolean	Filter flight bookings by needs approval
is_policy_respected optional	boolean	Filter flight bookings by policy respected
is_archived optional	boolean	Filter flight bookings by is_archived
total_amount optional	float	Filter flight bookings by total amount
pnr optional	string	Filter flight bookings by flight pnr
invoice_ids optional	string	Filter flight bookings by invoice_id
invoicing_status optional	string	Filter by invoicing status, one or more separated by commas. Values: not_invoiced, partly_invoiced, invoiced.
is_personal optional	boolean	Filter flight bookings by is personal
merchant optional	string	Filter flight bookings by merchant
itinerary_type optional	string	Filter flight bookings by itinerary type
is_manual optional	boolean	Filter flight bookings by is manual
is_gtm optional	boolean	Filter flight bookings by gtm reservaton
license_fee optional	integer	Filter flight bookings by license fee
client_classification optional	string	Filter flight bookings by client classification.
client_type optional	string	Filter flight bookings by client type.
approver_id optional	string	Filter flight bookings by approver_id.
is_vat_recovery_eligible optional	boolean	Filter flight bookings by is_vat_recovery_eligible.
currency optional	string	Filter flight bookings by currency
fare_type optional	string	Filter flight bookings by fare type

GET flight-bookings/:flight_booking_id

Get the booking detail.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
locale required	string		The locale for the language of the results contents.

GET flight-bookings/:flight_booking_id/rules

Get the fare restrictions stored with a flight booking.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
locale required	string		The locale for the language of the results contents.

POST flight-bookings/calculate-costs

Calculate costs of a flight booking.

Authorization: member admin superadmin

Attributes	Type	Description
flight_booking_id required if fare_id not filled	string	The flight booking id.
fare_id required if flight_booking_id not filled	string	The fare selected by the customer.
extra_baggages required if flight_booking_id not filled	array	Extra baggages selected by the customer.
extra_services required if flight_booking_id not filled	array	Extra services selected by the customer.
insurance_quotes required if flight_booking_id not filled	array	Insurances selected by the customer.
quote optional	boolean	True if there is the need to generate insurance quotes
locale required	string	The locale.
payment_method optional	string	The payment method.
billing_address_id optional	string	The billing address id
credit_card_id required when payment_method = cc	string	[Credit Card] the token of the selected credit card.
credit_card_owner required when payment_method = cc	string	[Credit Card] the owner of the selected credit card.
is_personal required	boolean	Indicates if the booking is personal.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
FARE_EXPIRED	The fare you request is not anymore valid

POST flight-bookings/generate-csv

Generate a csv file with the full flight bookings list

Authorization: superadmin

Attributes	Type	Description
creator_id optional	string	Filter flight bookings by creator id
supervisor_id optional	string	Filter flight bookings by supervisor id
code optional	string	Filter flight bookings by code
locale optional	string	The locale for the language of the results contents.
status optional	array	Filter flight bookings by status
created_from optional	string	Filter flight bookings by creation from
created_to optional	string	Filter flight bookings by creation to
updated_from optional	string	Filter flight bookings by update from
updated_to optional	string	Filter flight bookings by update to
departure_airport_id optional	string	Filter flight bookings by outbound departure airport
departure_date_from optional	string	Filter flight bookings by departure date from
departure_date_to optional	string	Filter flight bookings by departure date to
traveller_ids optional	array	Filter flight bookings by guets
needs_approval optional	boolean	Filter flight bookings by needs approval
is_policy_respected optional	boolean	Filter flight bookings by policy compliance
invoice_ids optional	string	Filter flight bookings by invoice_id
invoicing_status optional	array	Return flight bookings based on its invoicing status
invoice_profile_id optional	string	Filter flight bookings by invoice profile id
itinerary_type optional	string	Filter flight bookings by itinerary type
custom_fields optional	string	Custom fields
extra_services optional	array	Filter flight bookings by extra service type.
fare_type optional	string	Filter flight bookings by fare type

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.

POST flight-bookings/my-account/generate-csv

Generate a csv file with the full flight bookings list of an account

Authorization: admin superadmin

Attributes	Type	Authorization	Description
creator_id optional	string		Filter flight bookings by creator id
supervisor_id optional	string		Filter flight bookings by supervisor id
code optional	string		Filter flight bookings by code
locale optional	string		The locale for the language of the results contents.
status optional	array		Filter flight bookings by status
created_from optional	string		Filter flight bookings by creation from
created_to optional	string		Filter flight bookings by creation to
updated_from optional	string		Filter flight bookings by update from
updated_to optional	string		Filter flight bookings by update to
departure_airport_id optional	string		Filter flight bookings by outbound departure airport
departure_date_from optional	string		Filter flight bookings by departure date from
departure_date_to optional	string		Filter flight bookings by departure date to
traveller_ids optional	array		Filter flight bookings by guets
needs_approval optional	boolean		Filter flight bookings by needs approval
is_policy_respected optional	boolean		Filter flight bookings by policy compliance
invoice_ids optional	string		Filter flight bookings by invoice_id
invoicing_status optional	array		Return flight bookings based on its invoicing status
invoice_profile_id optional	string		Filter flight bookings by invoice profile id
itinerary_type optional	string		Filter flight bookings by itinerary type
custom_fields optional	string		Custom fields
extra_services optional	array		Filter flight bookings by extra service type.
fare_type optional	string		Filter flight bookings by fare type
account_id optional	string	superadmin	Filter flight bookings by account_id
include_deleted_custom_fields optional	boolean		Flag to include deleted Custom Fields

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.

POST flight-bookings/my-user/generate-csv

Generate a csv file with the full flight bookings list of an user

Authorization: member admin superadmin

Attributes	Type	Description
creator_id optional	string	Filter flight bookings by creator id
supervisor_id optional	string	Filter flight bookings by supervisor id
code optional	string	Filter flight bookings by code
locale optional	string	The locale for the language of the results contents.
status optional	array	Filter flight bookings by status
created_from optional	string	Filter flight bookings by creation from
created_to optional	string	Filter flight bookings by creation to
updated_from optional	string	Filter flight bookings by update from
updated_to optional	string	Filter flight bookings by update to
departure_airport_id optional	string	Filter flight bookings by outbound departure airport
departure_date_from optional	string	Filter flight bookings by departure date from
departure_date_to optional	string	Filter flight bookings by departure date to
traveller_ids optional	array	Filter flight bookings by guets
needs_approval optional	boolean	Filter flight bookings by needs approval
is_policy_respected optional	boolean	Filter flight bookings by policy compliance
invoice_ids optional	string	Filter flight bookings by invoice_id
invoicing_status optional	array	Return flight bookings based on its invoicing status
invoice_profile_id optional	string	Filter flight bookings by invoice profile id
itinerary_type optional	string	Filter flight bookings by itinerary type
custom_fields optional	string	Custom fields
extra_services optional	array	Filter flight bookings by extra service type.
fare_type optional	string	Filter flight bookings by fare type
is_personal optional	boolean	Filter flight bookings by is_personal

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.

POST flight-bookings

Create a booking

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
account_id optional	string	superadmin	The account_id context
user_id optional	string	superadmin	The user_id (owner) of the context
fare_id required	string		The fare id selected by the customer
extra_baggages optional	array		Extra baggages selected by the customer.
extra_services optional	array		Extra services selected by the customer.
holder_id optional	string		The id of the passenger selected by the customer as the booking holder.
passengers required	array		Array with all passengers informations.
phone required	string		The phone number of the booking.
billing_address_id optional	string		The billing address id.
billing_address_project optional	string		The project for the billing address.
invoice_profile_id optional	string		The invoice profile id.
airline_terms_accepted optional	boolean		Define if the user has accepted the airline terms
is_personal required	boolean		Indicates if the booking is personal.
custom_fields optional	object		Object of custom fields
payment.method required	string		The payment method.
payment.credit_card_id required when payment_method = cc	string		[Credit Card] the token of the selected credit card.
payment.credit_card_owner required when payment_method = cc	string		[Credit Card] the owner of the selected credit card.
bta_card_id required when payment_method = amex_bta	string		[Amex BTA] amex bta card id.
bta_card_account_id required when payment_method = amex_bta	string		[Amex BTA] the account id of the selected amex bta card.
bta_card_number required when payment_method = amex_bta	string		[Amex BTA] the number of the selected amex bta card.
hokodo_data required when payment_method = hokodo	object		[Hokodo] Object of Hokodo Data
approval_message Required if approval workflow has is_message_required	string		A message to send to the supervisor

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
NOT_FOUND	The resource you are trying to get not exists.
MISSING_USER_INFO	There are missing info to the user associated to a specific field.
MISSING_DOCUMENT	Missing document for a specific passenger.
DOCUMENT_EXPIRATION_ISSUE	The document you request is expired or will expire during the trip
INVALID_DOCUMENT_OWNER	The document you passed does not belong to the passenger declared.
WRONG_PASSENGER_AGE	Wrong passenger age.
NO_MIN_SINGLE_PAX_AGE	No minimum single passenger age.
DUPLICATE_BOOKING	Possible duplicate booking.

PUT flight-bookings/:flight_booking_id

Update a flight booking.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
fare_id optional	null\|string		A new booking fare id.
holder_id optional	string		The holder id.
passengers optional	array		Array with all passengers informations.
extra_baggages optional	array		Extra baggages selected by the customer.
extra_services optional	array		Extra services selected by the customer.
phone optional	string		The emergency phone of the booking.
checkin_email optional	string		The email necessary for the checkin.
legs optional	object		Object of the legs with the id as a reference. Accepted fields for every flight: pnr, departure_airport_terminal, arrival_airport_terminal, login.url, login.username, login.password, cabin_class.
status optional	string	superadmin	The booking status.
provider_code optional	string	superadmin	The provider code.
billing_address_id optional	string		The billing address id.
billing_address_project optional	string		The project for the billing address.
invoice_profile_id optional	string		The invoice profile id.
is_vat_exempt optional	boolean	superadmin	Update booking vat exempt flag
has_declaration_of_intent optional	boolean	superadmin	Update booking declaration of intent flag
automatic_invoice optional	boolean	superadmin	Define if the booking will be automatically invoices
inner_transactions optional	array	superadmin	Update booking inner transactions
transaction_costs optional	number	superadmin	Update the transaction costs.
invoice_id optional	null\|string	superadmin	Update the booking invoice.
fare_price optional	number	superadmin	Update the booking fare price.
fare_provider_price optional	number	superadmin	Update the fare provider price.
issuing_fee optional	number	superadmin	Update the fare issuing fee
provider_key optional	string	superadmin	Update the provider key of the booking. Must be one of the values returned by vertical_fare_sources for this vertical.
passenger_birthday optional	object	superadmin	Update passenger birthday.
cabin_class optional	object	superadmin	Update cabin class.
airline_number optional	object	superadmin	Update airline number.
airline_operator_number optional	object	superadmin	Update airline operator number.
airline_id optional	object	superadmin	Update airline id.
operator_airline_id optional	object	superadmin	Update operator airline id.
datetime optional	object	superadmin	Update departure / arrival datetime.
is_personal optional	boolean	superadmin	Update the booking is_personal.
is_archived optional	boolean	superadmin	Update the booking is_archived.
custom_fields optional	object		Object of custom fields
license_fee optional	number	superadmin	Update the licence fee.
is_gtm optional	boolean	superadmin	Define if the booking is a GTM booking
version optional	number	superadmin	Update the version of the booking.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
NOT_FOUND	The resource you are trying to get not exists.
MISSING_USER_INFO	There are missing info to the user associated to a specific field.
MISSING_DOCUMENT	Missing document for a specific passenger.
DOCUMENT_EXPIRATION_ISSUE	The document you request is expired or will expire during the trip
INVALID_DOCUMENT_OWNER	The document you passed does not belong to the passenger declared.

POST flight-bookings/:flight_booking_id/initialize

Initialize a flight booking creating the booking provider.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
account_id optional	string	superadmin	The account_id context

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
BOOKING_NOT_VALID_STATUS	This booking is not in a valid status to execute the requested operation.
FARE_EXPIRED	The fare you request is not anymore valid
DUPLICATE_BOOKING	Possible duplicate booking.

POST flight-bookings/:flight_booking_id/lock-fare

Block a flight booking creating the booking provider.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
account_id optional	string	superadmin	The account_id context

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
BOOKING_NOT_VALID_STATUS	This booking is not in a valid status to execute the requested operation.
FARE_EXPIRED	The fare you request is not anymore valid
DUPLICATE_BOOKING	Possible duplicate booking.

POST flight-bookings/:flight_booking_id/approve

Approve the current booking

Authorization:

Attributes	Type	Authorization	Description
price_tolerance optional	number

Errors codes
BOOKING_NOT_VALID_STATUS	This booking is not in a valid status to execute the requested operation.

POST flight-bookings/:flight_booking_id/reject

Reject booking.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
message optional	string		Custom message to the booking creator.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
BOOKING_NOT_VALID_STATUS	This booking is not in a valid status to execute the requested operation.

POST flight-bookings/:flight_booking_id/void

Void booking.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
message optional	string		Custom message to the booking creator.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
BOOKING_NOT_VALID_STATUS	This booking is not in a valid status to execute the requested operation.

POST flight-bookings/:flight_booking_id/trash

Trash booking.

Authorization: member admin superadmin

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
BOOKING_NOT_VALID_STATUS	This booking is not in a valid status to execute the requested operation.

POST flight-bookings/:flight_booking_id/discard

Discard booking.

Authorization: member admin superadmin

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
BOOKING_NOT_VALID_STATUS	This booking is not in a valid status to execute the requested operation.

POST flight-bookings/:flight_booking_id/process

Process a flight booking.

Authorization: member admin superadmin

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
FARE_EXPIRED	The fare you request is not anymore valid
PROVIDER_ERROR	There was an issue with our provider. This can be a temporary problem. Please, retry in a few moments..
PAYMENT_TRANSACTION_REQUIRED	An active payment transaction is required before confirming this booking.

POST flight-bookings/:flight_booking_id/complete-process

Complete a flight booking process.

Authorization: member admin superadmin

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET flight-bookings/:flight_booking_id/ticket

Get an existing ticket download URL. Supplying regenerate generates and persists new ticket files.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
locale optional	string		Ticket locale. Required unless regenerate=multi.
regenerate optional	string		Use single to regenerate the requested locale or multi to regenerate all supported locales. Regeneration persists generated files.

POST flight-bookings/:flight_booking_id/passengers/:user_id/ticket

Upload the issued e-ticket file for a passenger of a flight booking.

Authorization: admin superadmin

Attributes	Type	Authorization	Description
file optional	file		The e-ticket file (PDF)

Errors codes
NOT_FOUND	The resource you are trying to get not exists.
MAX_BYTES_EXCEEDED	You are trying to upload a file that exceed the maximum bytes allowed.
INVALID_FILE_FORMAT	You are trying to upload an invalid file type.
INVALID_FILE_MIMETYPE	You are trying to upload an invalid file type.

POST flight-bookings/:flight_booking_id/initialize-payment

Initialize a payment

Authorization: member admin superadmin

Attributes	Type	Description
payment_method required	string	The payment method.
credit_card_id required when payment_method = cc	string	[Credit Card] the token of the selected credit card.
credit_card_owner required when payment_method = cc	string	[Credit Card] the owner of the selected credit card.
paypal_payment_id required when payment_method = paypal	string	[PayPal] the paypal payment_id.
paypal_payer_id required when payment_method = paypal	string	[PayPal] the paypal payer id.
bta_card_id required when payment_method = amex_bta	string	[Amex BTA] amex bta card id.
bta_card_account_id required when payment_method = amex_bta	string	[Amex BTA] the account id of the selected amex bta card.
bta_card_number required when payment_method = amex_bta	string	[Amex BTA] the number of the selected amex bta card.
hokodo_data required when payment_method = hokodo	object	[Hokodo] Object of Hokodo Data

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
INSUFFICIENT_FOUNDS_CC	There not enough money to execute the operation you request on the credit card of the user.
LIMIT_EXCEEDED_CC	Unable to execute this operation, you have exceeded the maximum amount for your credit card.
CONTACT_TO_THE_BANK	Unable to execute this operation, please contact your bank for more info!
EXPIRED_CARD_CC	Your credit card looks like its already expired
COMPROMISED_CC	The credit card has been flagged as lost, stolen, or otherwise compromised.
CARDHOLDER_STOP_CC	The cardholder has requested their bank to stop all billing for this card.
SECURITY_VIOLATION_CC	The issuing bank detected a security violation and declined the transaction.
FRAUD_CC	The credit card has been flagged as fraud.
TEMPORARY_ISSUE_CC	Unable to execute this operation due to a temporary issue with the bank, try again!

GET flight-bookings/:flight_booking_id/update

Refresh the booking from the provider, recalculate costs and policies, and persist the updated booking. This GET has side effects and must not be used for read-only lookup.

Authorization: member admin superadmin

DELETE flight-bookings/:flight_booking_id

Delete booking (DRAFT) only

Authorization: superadmin

Errors codes
BOOKING_NOT_VALID_STATUS	This booking is not in a valid status to execute the requested operation.
NOT_FOUND	The resource you are trying to get not exists.

POST flight-bookings/:flight_booking_id/edit/price-changes

Adds new price change to a booking

Authorization:

Attributes	Type	Description
reference optional	string	Reference of price change
reference_id optional	string	The id of the reference
reference_type optional	string	The type of the reference
amount optional	number	The amount of the price change
date optional	string	The date when the price change occurs
reference_transaction optional	string	The id of the transaction
type optional	string	The type of the price change

GET flight-bookings/:flight_booking_id/edit/price-changes

Get booking price changes section

Authorization:

PUT flight-bookings/:flight_booking_id/edit/price-changes/:price_change_id

Updates a price change from a booking

Authorization:

Attributes	Type	Description
reference optional	string	Reference of price change
reference_id optional	string	The id of the reference
reference_type optional	string	The type of the reference
amount optional	number	The amount of the price change
date optional	string	The date when the price change occurs
reference_transaction optional	string	The id of the transaction
type optional	string	The type of the price change

DELETE flight-bookings/:flight_booking_id/edit/price-changes/:price_change_id

Delete a price change from a booking

Authorization:

POST flight-bookings/:flight_booking_id/edit/price-changes/confirm

Confirm all price changes that are in draft status

Authorization:

POST flight-bookings/:flight_booking_id/edit/price-changes/discard

Discard all price changes that are in draft status

Authorization:

POST download/:entity/:id

Download entity json

Authorization: superadmin

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST emit-platform-update

Broadcast a platform update notice to the connected clients.

Authorization: member admin app superadmin

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET places/:place_id

Resolve a location suggestion into its coordinates. Pass the place_id returned by GET /v1/places. The hotel search can take that place_id directly, so this read is only needed when the coordinates themselves are required. It expects a freshly selected suggestion: on a place id the maps provider no longer knows it returns NOT_FOUND, since a stale id from the caller side is an input error. To resolve a batch of stored ids without failing on retired ones, use GET /v1/places?ids= instead, which silently omits the ids the provider no longer knows.

Authorization: member admin app superadmin

Attributes	Type	Authorization	Description
locale required	string		The locale for search the term

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
NOT_FOUND	The resource you are trying to get not exists.

GET places

Turn typed text into location suggestions, using the maps provider catalogue. Note what this is not: it does not return BizAway airports, stations or hotels, and there is no field saying whether a suggestion is a city or an airport. Only the hotel search consumes the place_id it returns. For the other verticals resolve the location first: airports and their codes come from GET /v1/search/airports, train stations from GET /v1/search/stations and car pick-up points from GET /v1/search/car-places, all of which accept a place_id from here to find the entities nearby.

Authorization: member admin app superadmin

Attributes	Type	Description
locale required	string	The locale for search the term
input optional	string	The input for search places. Required unless ids is provided
ids optional	string	Comma separated place ids to resolve in a single request, up to 200. A place id that cannot be resolved (retired by the maps provider or a transient failure on that single lookup) is omitted from the response instead of failing it, so one bad id cannot hide the others.
types optional	string	The type to filter google places autocomplete API

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET locales

List the locales the platform can serve content in, which are the values accepted by every locale parameter of this API. Only the active ones are returned unless show_all is requested, and some are hidden when their feature flag is off, so the set can differ between environments.

Authorization: guest member admin app superadmin

Attributes	Type	Authorization	Description
show_all optional	boolean		When true, include the locales that are not active.

GET countries

List every country of the platform reference list, with its codes, continent, dialling prefix and localized name. The whole list is always returned, without pagination. The same list is served by GET /v1/countries/settings under a different key.

Authorization: guest member admin app superadmin

Attributes	Type	Authorization	Description
locale optional	string		The locale

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET provinces

List the Italian provinces as a map of province code to province name, used for Italian billing addresses. It covers Italy only and has nothing to do with the geography of the travel searches.

Authorization: guest member admin app superadmin

GET countries/settings

The same country reference list served by GET /v1/countries, returned under a countries key instead of the results and total pair. Despite the name it carries no per-country configuration and no platform settings.

Authorization: guest member admin app superadmin

Attributes	Type	Authorization	Description
locale optional	string		The locale

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET zones

List the geographic zones usable to scope a travel policy or a filter. It returns every country plus the six continents in one list, told apart by the type field. The whole list is always returned, without pagination. This is unrelated to GET /v1/provinces, which covers Italian provinces only.

Authorization: guest member admin app superadmin

Attributes	Type	Authorization	Description
locale optional	string		The locale

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
INVALID_LOCALE	Invalid locale.

GET currencies/conversion-rates

Get the exchange rates the platform uses to convert money, expressed against its base currency. They are a cached snapshot rather than a live quote: the process refreshes its copy every few minutes from a store updated by a scheduled job, so the numbers can be up to a day old. Read updated_at before quoting a converted amount to anybody.

Authorization: guest member admin app superadmin

GET internal-notifications

List the internal notifications, that is the alerts sent to BizAway staff, with the channels each one supports. It is a global catalogue and does not depend on the caller: the identifiers it returns are the values to store in a user internal_notifications. Notifications sent to customers are a separate thing, listed by GET /v1/notifications-available.

Authorization: guest member admin app superadmin

GET notifications-available

List the notifications that extra email addresses can be subscribed to on an account, with their labels translated. The identifiers it returns are the values to store in the notification_type of an account notification contact. It is a global catalogue and does not depend on the caller; only the enabled notifications are returned. This is about the emails sent to customers, unlike GET /v1/internal-notifications which covers the alerts sent to BizAway staff.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
locale required	string		Language of the returned labels. Any string of two to five characters is accepted here, so an unknown locale falls back rather than failing.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET ready

Get core health status

Authorization:

GET assets/:id

Download a stored file. This does not answer with a body: it replies with a redirect to a download URL that expires about ten seconds later, so follow it right away. The id is the base64 of the file storage path and is not meant to be built by hand: take the whole link from the field that carries it, such as a booking voucher or ticket, an invoice file, a travel document image or a fiscal document. Callers holding bizaway_manage can read any path, while the others are limited to the files of their own account.

Authorization:

Attributes	Type	Authorization	Description
id optional	string		Base64 of the file storage path, as found in the link returned by the endpoint that exposes the file.

Errors codes
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.

GET hotel-bookings

Get the full hotel bookings list.

Authorization: superadmin

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
sort optional	string	The sort modality
locale required	string	The locale for the language of the results contents.
plan_id optional	string	Filter hotel bookings by plan id.
has_extra_services optional	boolean	Filter hotel bookings by extra services.
extra_services optional	array	Filter hotel bookings by extra service type.
id optional	string	Filter hotel bookings by id
creator_id optional	string	Filter hotel bookings by creator id
supervisor_id optional	string	Filter hotel bookings by supervisor id
billing_address_id optional	string	Filter hotel bookings by billing address id
invoice_profile_id optional	string	Filter hotel bookings by invoice profile id
code optional	string	Filter hotel bookings by code
status optional	string	Filter by booking status, one or more separated by commas. Values: draft, created, approving, approved, rejected, initialized, discarded, expired, processing, voided, processed, cancelling, cancelled, trashed.
created_from optional	string	Filter hotel bookings by creation from
created_to optional	string	Filter hotel bookings by creation to
updated_from optional	string	Filter hotel bookings by update from
updated_to optional	string	Filter hotel bookings by update to
cancelled_from optional	string	Filter hotel bookings by cancellation from
cancelled_to optional	string	Filter hotel bookings by cancellation to
check_in_from optional	string	Filter hotel bookings by checkin from
check_in_to optional	string	Filter hotel bookings by checkin to
check_out_from optional	string	Filter hotel bookings by checkout to
check_out_to optional	string	Filter hotel bookings by checkout to
traveller_ids optional	string	Filter hotel bookings by guests
hotel_id optional	string	Filter hotel bookings by hotel_id
is_verified optional	boolean	Filter hotel bookings by verified
is_verification_email_sent optional	boolean	Filter hotel bookings by verification email sent
is_reconciled optional	boolean	Filter for hotel custom rate booking that have been reconciled or not
is_archived optional	boolean	Filter hotel bookings by is_archived
payment_info_sent optional	boolean	Filter for hotel custom rate booking that have been sent payment info or not to hotel
needs_approval optional	boolean	Filter hotel bookings by needs approval
is_policy_respected optional	boolean	Filter hotel bookings by policy respected
total_amount optional	float	Filter hotel bookings by total amount
invoice_ids optional	string	Filter hotel bookings by invoice ids
invoicing_status optional	string	Filter by invoicing status, one or more separated by commas. Values: not_invoiced, partly_invoiced, invoiced.
merchant optional	string	Filter hotel bookings by merchant
is_refunded optional	boolean	Filter hotel bookings for which a refund must be made.
payment_method_required optional	boolean	Filter hotel reservations that need a credit card to be finalized
is_personal optional	boolean	Filter hotel bookings by is_personal
is_manual optional	boolean	Filter hotel bookings by is_manual
is_gtm optional	boolean	Filter hotel bookings by gtm reservaton
rebooking_lock optional	boolean	Filter hotel bookings by rebooking lock
license_fee optional	integer	Filter hotel bookings by license fee
client_classification optional	string	Filter hotel bookings by client classification.
client_type optional	string	Filter hotel bookings by client type.
approver_id optional	string	Filter hotel bookings by approver_id.
negotiated optional	string	Filter hotel bookings rate type
currency optional	string	Filter flight bookings by currency
account_id optional	string	Filter hotel bookings by account_id
account_ids optional	array	Filter hotel bookings by account_ids
exclude_account_ids optional	array	Filter hotel bookings by exclude account_ids
provider_code optional	string	Filter hotel bookings by provider_code
provider_key optional	string	Filter hotel bookings by provider key
bizzyflex_statuses optional	string	Filter flight bookings by bizzyflex status
has_market_price optional	boolean	Return hotel bookings that have market price
has_confirmation_number optional	boolean	Return hotel bookings that have hotel confirmation number
is_refundable optional	boolean	Filter hotel bookings by Cancellation Policy.
is_rebooked optional	boolean	Filter rebooked hotel bookings.
payment_method optional	string	Filter hotel bookings by payment method
custom_fields optional	string	Custom fields
automatic_invoice optional	boolean	Filter hotel bookings if auto invoice is active or not
version optional	number	Filter hotel bookings by version (1, 1.5 or 2)
payment_status optional	string	Filter hotel bookings by payment status (not_paid, partly_paid or paid)

GET hotel-bookings/my-account

Get the full hotel bookings list of an account.

Authorization:

Attributes	Type	Authorization	Description
limit optional	integer		Number of results to return
offset optional	integer		Index of the result to start to return results
sort optional	string		The sort modality
locale required	string		The locale for the language of the results contents.
plan_id optional	string		Filter hotel bookings by plan id.
has_extra_services optional	boolean		Filter hotel bookings by extra services.
extra_services optional	array		Filter hotel bookings by extra service type.
id optional	string		Filter hotel bookings by id
creator_id optional	string		Filter hotel bookings by creator id
supervisor_id optional	string		Filter hotel bookings by supervisor id
billing_address_id optional	string		Filter hotel bookings by billing address id
invoice_profile_id optional	string		Filter hotel bookings by invoice profile id
code optional	string		Filter hotel bookings by code
status optional	string		Filter by booking status, one or more separated by commas. Values: draft, created, approving, approved, rejected, initialized, discarded, expired, processing, voided, processed, cancelling, cancelled, trashed.
created_from optional	string		Filter hotel bookings by creation from
created_to optional	string		Filter hotel bookings by creation to
updated_from optional	string		Filter hotel bookings by update from
updated_to optional	string		Filter hotel bookings by update to
cancelled_from optional	string		Filter hotel bookings by cancellation from
cancelled_to optional	string		Filter hotel bookings by cancellation to
check_in_from optional	string		Filter hotel bookings by checkin from
check_in_to optional	string		Filter hotel bookings by checkin to
check_out_from optional	string		Filter hotel bookings by checkout to
check_out_to optional	string		Filter hotel bookings by checkout to
traveller_ids optional	string		Filter hotel bookings by guests
hotel_id optional	string		Filter hotel bookings by hotel_id
is_verified optional	boolean		Filter hotel bookings by verified
is_verification_email_sent optional	boolean		Filter hotel bookings by verification email sent
is_reconciled optional	boolean		Filter for hotel custom rate booking that have been reconciled or not
is_archived optional	boolean		Filter hotel bookings by is_archived
payment_info_sent optional	boolean		Filter for hotel custom rate booking that have been sent payment info or not to hotel
needs_approval optional	boolean		Filter hotel bookings by needs approval
is_policy_respected optional	boolean		Filter hotel bookings by policy respected
total_amount optional	float		Filter hotel bookings by total amount
invoice_ids optional	string		Filter hotel bookings by invoice ids
invoicing_status optional	string		Filter by invoicing status, one or more separated by commas. Values: not_invoiced, partly_invoiced, invoiced.
merchant optional	string		Filter hotel bookings by merchant
is_refunded optional	boolean		Filter hotel bookings for which a refund must be made.
payment_method_required optional	boolean		Filter hotel reservations that need a credit card to be finalized
is_personal optional	boolean		Filter hotel bookings by is_personal
is_manual optional	boolean		Filter hotel bookings by is_manual
is_gtm optional	boolean		Filter hotel bookings by gtm reservaton
rebooking_lock optional	boolean		Filter hotel bookings by rebooking lock
license_fee optional	integer		Filter hotel bookings by license fee
client_classification optional	string		Filter hotel bookings by client classification.
client_type optional	string		Filter hotel bookings by client type.
approver_id optional	string		Filter hotel bookings by approver_id.
negotiated optional	string		Filter hotel bookings rate type
currency optional	string		Filter flight bookings by currency
account_id optional	string	superadmin	Filter hotel bookings by account_id
is_negotiated optional	boolean		Filter hotel bookings by custom rate

GET hotel-bookings/drafts

List partial hotel bookings that are still in draft status.

Authorization:

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
sort optional	string	The sort modality
stats optional	boolean	When true, include the total number of matching drafts.
locale required	string	The locale for the language of the results contents.
id optional	string	Filter hotel bookings by id
code optional	string	Filter hotel bookings by code

GET hotel-bookings/my-user

Get the hotel bookings list of the session user.

Authorization: member admin superadmin

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
sort optional	string	The sort modality
locale required	string	The locale for the language of the results contents.
plan_id optional	string	Filter hotel bookings by plan id.
has_extra_services optional	boolean	Filter hotel bookings by extra services.
extra_services optional	array	Filter hotel bookings by extra service type.
id optional	string	Filter hotel bookings by id
creator_id optional	string	Filter hotel bookings by creator id
supervisor_id optional	string	Filter hotel bookings by supervisor id
billing_address_id optional	string	Filter hotel bookings by billing address id
invoice_profile_id optional	string	Filter hotel bookings by invoice profile id
code optional	string	Filter hotel bookings by code
status optional	string	Filter by booking status, one or more separated by commas. Values: draft, created, approving, approved, rejected, initialized, discarded, expired, processing, voided, processed, cancelling, cancelled, trashed.
created_from optional	string	Filter hotel bookings by creation from
created_to optional	string	Filter hotel bookings by creation to
updated_from optional	string	Filter hotel bookings by update from
updated_to optional	string	Filter hotel bookings by update to
cancelled_from optional	string	Filter hotel bookings by cancellation from
cancelled_to optional	string	Filter hotel bookings by cancellation to
check_in_from optional	string	Filter hotel bookings by checkin from
check_in_to optional	string	Filter hotel bookings by checkin to
check_out_from optional	string	Filter hotel bookings by checkout to
check_out_to optional	string	Filter hotel bookings by checkout to
traveller_ids optional	string	Filter hotel bookings by guests
hotel_id optional	string	Filter hotel bookings by hotel_id
is_verified optional	boolean	Filter hotel bookings by verified
is_verification_email_sent optional	boolean	Filter hotel bookings by verification email sent
is_reconciled optional	boolean	Filter for hotel custom rate booking that have been reconciled or not
is_archived optional	boolean	Filter hotel bookings by is_archived
payment_info_sent optional	boolean	Filter for hotel custom rate booking that have been sent payment info or not to hotel
needs_approval optional	boolean	Filter hotel bookings by needs approval
is_policy_respected optional	boolean	Filter hotel bookings by policy respected
total_amount optional	float	Filter hotel bookings by total amount
invoice_ids optional	string	Filter hotel bookings by invoice ids
invoicing_status optional	string	Filter by invoicing status, one or more separated by commas. Values: not_invoiced, partly_invoiced, invoiced.
merchant optional	string	Filter hotel bookings by merchant
is_refunded optional	boolean	Filter hotel bookings for which a refund must be made.
payment_method_required optional	boolean	Filter hotel reservations that need a credit card to be finalized
is_personal optional	boolean	Filter hotel bookings by is_personal
is_manual optional	boolean	Filter hotel bookings by is_manual
is_gtm optional	boolean	Filter hotel bookings by gtm reservaton
rebooking_lock optional	boolean	Filter hotel bookings by rebooking lock
license_fee optional	integer	Filter hotel bookings by license fee
client_classification optional	string	Filter hotel bookings by client classification.
client_type optional	string	Filter hotel bookings by client type.
approver_id optional	string	Filter hotel bookings by approver_id.
negotiated optional	string	Filter hotel bookings rate type
currency optional	string	Filter flight bookings by currency

GET hotel-bookings/stats

Get aggregated hotel booking counters (booking counts, amount sums and market-price savings) over the bookings matching the filters. Without date filters the aggregation spans all bookings.

Authorization: superadmin

Attributes	Type	Authorization	Description
limit optional	integer		Accepted but ignored: the aggregation always covers every matching booking.
offset optional	integer		Accepted but ignored: the aggregation always covers every matching booking.
account_id optional	string	superadmin	Restrict the aggregation to one account
account_ids optional	string		Restrict the aggregation to a set of accounts, comma separated
status optional	string		Filter by booking status, one or more separated by commas. Values: draft, created, approving, approved, rejected, initialized, discarded, expired, processing, voided, processed, cancelling, cancelled, trashed.
created_from optional	string		Filter hotel bookings created from this day (inclusive)
created_to optional	string		Filter hotel bookings created up to this day (inclusive)
check_in_from optional	string		Filter hotel bookings by check-in from this day (inclusive)
check_in_to optional	string		Filter hotel bookings by check-in up to this day (inclusive)
check_out_from optional	string		Filter hotel bookings by check-out from this day (inclusive)
check_out_to optional	string		Filter hotel bookings by check-out up to the start of this day
provider_key optional	string		Filter hotel bookings by rate provider keys, comma separated
hotel_id optional	string		Filter hotel bookings by hotel_id
creator_id optional	string		Filter hotel bookings by creator id

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET hotel-bookings/:hotel_booking_id

Get the booking detail.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
locale required	string		The locale.

POST hotel-bookings/calculate-costs

Calculate costs of a hotel booking.

Authorization: member admin superadmin

Attributes	Type	Description
hotel_booking_id required if fare_id not filled	string	The hotel booking id.
fare_id required if booking_id not filled	string	The fare of the hotel selected by the customer.
insurance_quotes required if flight_booking_id not filled	array	Insurances selected by the customer.
quote optional	boolean	True if there is the need to generate insurance quotes
locale required	string	The locale.
payment_method optional	string	The payment method.
billing_address_id optional	string	The billing address id
credit_card_id required when payment_method = cc	string	[Credit Card] the token of the selected credit card.
credit_card_owner required when payment_method = cc	string	[Credit Card] the owner of the selected credit card.
is_personal required	boolean	Indicates if the booking is personal.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.

POST hotel-bookings/generate-csv

Generate a csv file with the full hotel bookings list

Authorization: superadmin

Attributes	Type	Authorization	Description
locale optional	string		The locale for the language of the results contents.
account_id optional	string	superadmin	Filter hotel bookings by account_id
creator_id optional	string		Filter hotel bookings by creator id
supervisor_id optional	string		Filter hotel bookings by supervisor id
code optional	string		Filter hotel bookings by code
status optional	array		Filter hotel bookings by status
created_from optional	string		Filter hotel bookings by creation from
created_to optional	string		Filter hotel bookings by creation to
updated_from optional	string		Filter hotel bookings by update from
updated_to optional	string		Filter hotel bookings by update to
check_in_from optional	string		Filter hotel bookings by checkin from
check_in_to optional	string		Filter hotel bookings by checkin to
hotel_id optional	string		Filter hotel bookings by hotel_id
traveller_ids optional	array		Filter hotel bookings by guets
needs_approval optional	boolean		Filter hotel bookings by needs approval
invoice_ids optional	string		Filter hotel bookings by invoice_id
invoicing_status optional	array		Return hotel bookings based on its invoicing status
invoice_profile_id optional	string		Filter hotel bookings by invoice profile id
custom_fields optional	string		Custom fields
extra_services optional	array		Filter hotel bookings by extra service type.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.

POST hotel-bookings/my-account/generate-csv

Generate a csv file with the full hotel bookings list of an account

Authorization: admin superadmin

Attributes	Type	Authorization	Description
locale optional	string		The locale for the language of the results contents.
account_id optional	string	superadmin	Filter hotel bookings by account_id
creator_id optional	string		Filter hotel bookings by creator id
supervisor_id optional	string		Filter hotel bookings by supervisor id
code optional	string		Filter hotel bookings by code
status optional	array		Filter hotel bookings by status
created_from optional	string		Filter hotel bookings by creation from
created_to optional	string		Filter hotel bookings by creation to
updated_from optional	string		Filter hotel bookings by update from
updated_to optional	string		Filter hotel bookings by update to
check_in_from optional	string		Filter hotel bookings by checkin from
check_in_to optional	string		Filter hotel bookings by checkin to
hotel_id optional	string		Filter hotel bookings by hotel_id
traveller_ids optional	array		Filter hotel bookings by guets
needs_approval optional	boolean		Filter hotel bookings by needs approval
invoice_ids optional	string		Filter hotel bookings by invoice_id
invoicing_status optional	array		Return hotel bookings based on its invoicing status
invoice_profile_id optional	string		Filter hotel bookings by invoice profile id
custom_fields optional	string		Custom fields
extra_services optional	array		Filter hotel bookings by extra service type.
account_id optional	string	superadmin	Filter hotel bookings by account_id
include_deleted_custom_fields optional	boolean		Flag to include deleted Custom Fields

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.

POST hotel-bookings/my-user/generate-csv

Generate a csv file with the full hotel bookings list of an account

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
locale optional	string		The locale for the language of the results contents.
account_id optional	string	superadmin	Filter hotel bookings by account_id
creator_id optional	string		Filter hotel bookings by creator id
supervisor_id optional	string		Filter hotel bookings by supervisor id
code optional	string		Filter hotel bookings by code
status optional	array		Filter hotel bookings by status
created_from optional	string		Filter hotel bookings by creation from
created_to optional	string		Filter hotel bookings by creation to
updated_from optional	string		Filter hotel bookings by update from
updated_to optional	string		Filter hotel bookings by update to
check_in_from optional	string		Filter hotel bookings by checkin from
check_in_to optional	string		Filter hotel bookings by checkin to
hotel_id optional	string		Filter hotel bookings by hotel_id
traveller_ids optional	array		Filter hotel bookings by guets
needs_approval optional	boolean		Filter hotel bookings by needs approval
invoice_ids optional	string		Filter hotel bookings by invoice_id
invoicing_status optional	array		Return hotel bookings based on its invoicing status
invoice_profile_id optional	string		Filter hotel bookings by invoice profile id
custom_fields optional	string		Custom fields
extra_services optional	array		Filter hotel bookings by extra service type.
is_personal optional	boolean		Filter hotel bookings by is_personal

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.

POST hotel-bookings

Create an hotel booking.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
account_id optional	string	superadmin	The account_id context
user_id optional	string	superadmin	The user_id (owner) of the context
fare_id required	string		The fare of the hotel selected by the customer.
holder_id optional	string		The id of the guest selected by the customer as the booking holder.
rooms required	array		The array of the rooms with this format { adults: [USER_ID], children: [USER_ID] }.
phone optional	string		A phone contact for emergency reason.
notes optional	string		The notes of the booking.
billing_address_id optional	string		The billing address id.
billing_address_project optional	string		The project for the billing address.
invoice_profile_id optional	string		The invoice profile id.
booker_address.address optional	string		The address of the booker.
booker_address.postal_code optional	string		The address of the booker.
booker_address.city optional	string		The city of the booker.
is_personal required	boolean		Indicates if the booking is personal.
custom_fields optional	object		Object of custom fields
payment.method required	string		The payment method.
payment.credit_card_id required when payment_method = cc	string		[Credit Card] the token of the selected credit card.
payment.credit_card_owner required when payment_method = cc	string		[Credit Card] the owner of the selected credit card.
bta_card_id required when payment_method = amex_bta	string		[Amex BTA] amex bta card id.
bta_card_account_id required when payment_method = amex_bta	string		[Amex BTA] the account id of the selected amex bta card.
bta_card_number required when payment_method = amex_bta	string		[Amex BTA] the number of the selected amex bta card.
hokodo_data required when payment_method = hokodo	object		[Hokodo] Object of Hokodo Data

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.

PUT hotel-bookings/:hotel_booking_id

Update a booking.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
account_id optional	string	superadmin	The account id context.
fare_id optional	string		A new booking fare id.
rate_price optional	number	superadmin	Update the rate price.
issuing_fee optional	number	superadmin	Update the rate issuing fee.
rate_provider_price optional	number	superadmin	Update the rate provider price.
estimated_total_price optional	number	superadmin	Update the estimated total price.
check_in optional	string	superadmin	Update the check in date
check_out optional	string	superadmin	Update the check out date
holder_id optional	string		The holder id.
rooms optional	array		The array of the rooms with this format { adults: [USER_ID], children: [USER_ID] }.
phone optional	string		The emergency phone of the booking.
notes optional	string		The notes of the passenger.
billing_address_id optional	string		The billing address id.
billing_address_project optional	string		The project for the billing address.
invoice_profile_id optional	string		The invoice profile id.
is_vat_exempt optional	boolean	superadmin	Update booking vat exempt flag
has_declaration_of_intent optional	boolean	superadmin	Update booking declaration of intent flag
status optional	string	superadmin	The booking status.
market_price optional	string	superadmin	The booking market price.
provider_code optional	string	superadmin	The provider code.
is_verified optional	boolean	superadmin	Define if the booking is verified
is_archived optional	boolean	superadmin	Update the booking is archived
is_verification_email_sent optional	boolean	superadmin	Define if the email is sent.
is_reconciled optional	boolean	superadmin	Define if the hotel booking custom rate has been reconciled.
payment_info_sent optional	boolean	superadmin	Define if the info payment for hotel custom rate has been sent to hotel.
automatic_invoice optional	boolean	superadmin	Define if the booking will be automatically invoices
inner_transactions optional	array	superadmin	Update booking inner transactions
transaction_costs optional	number	superadmin	Update the transaction costs.
invoice_id optional	null\|string	superadmin	Update the booking invoice.
rate.source.code optional	string	superadmin	Update the booking reservation id.
rate.source.pin optional	string	superadmin	Update the booking PIN.
is_refunded optional	boolean	superadmin	Update the booking is_refunded.
is_personal optional	boolean	superadmin	Update the booking is_personal.
provider_key optional	string	superadmin	Update the provider key of the booking. Must be one of the values returned by vertical_fare_sources for this vertical.
rate_type optional	string	superadmin	Update the booking board type.
room_to_delete optional	number	superadmin	Index of the room to delete.
custom_fields optional	object		Object of custom fields
license_fee optional	number	superadmin	Update the licence fee.
is_gtm optional	boolean	superadmin	Define if the booking is a GTM booking
rebooking_lock optional	boolean	superadmin	Define if the booking is locked for rebooking
timezone optional	string		Timezone of the hotel booking
version optional	number	superadmin	Update the version of the booking.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
NOT_FOUND	The resource you are trying to get not exists.

POST hotel-bookings/:hotel_booking_id/initialize

Initialize an hotel booking creating the booking provider.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
account_id optional	string	superadmin	The account_id context

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
BOOKING_NOT_VALID_STATUS	This booking is not in a valid status to execute the requested operation.

POST hotel-bookings/:hotel_booking_id/approve

Approve the current booking

Authorization:

Attributes	Type	Authorization	Description
price_tolerance optional	number

Errors codes
BOOKING_NOT_VALID_STATUS	This booking is not in a valid status to execute the requested operation.

POST hotel-bookings/:hotel_booking_id/reject

Reject booking.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
message optional	string		Custom message to the booking creator.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
BOOKING_NOT_VALID_STATUS	This booking is not in a valid status to execute the requested operation.

POST hotel-bookings/:hotel_booking_id/void

Void booking.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
message optional	string		Custom message to the booking creator.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
BOOKING_NOT_VALID_STATUS	This booking is not in a valid status to execute the requested operation.

POST hotel-bookings/:hotel_booking_id/trash

Trash booking.

Authorization: member admin superadmin

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
BOOKING_NOT_VALID_STATUS	This booking is not in a valid status to execute the requested operation.

POST hotel-bookings/:hotel_booking_id/process

Process an hotel booking.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
transaction_id optional	string		The transaction_id to use in order to process this booking, not required for payment method === `postpay`

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
PAYMENT_TRANSACTION_REQUIRED	An active payment transaction is required before confirming this booking.

POST hotel-bookings/:hotel_booking_id/complete-process

Complete an hotel booking process.

Authorization: superadmin

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST hotel-bookings/:hotel_booking_id/cancel

Cancel a confirmed booking.

Authorization:

Attributes	Type	Authorization	Description
force optional	string		This parameter is used to force the booking into status Cancelled when SuperAdmin.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST hotel-bookings/:hotel_booking_id/complete-cancel

Complete an hotel booking cancellation.

Authorization: superadmin

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET hotel-bookings/:hotel_booking_id/voucher

Get an existing voucher download URL. Supplying regenerate generates and persists new voucher files.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
locale optional	string		Voucher locale. Required unless regenerate=multi.
regenerate optional	string		Use single to regenerate the requested locale or multi to regenerate all supported locales. Regeneration persists generated files.

POST hotel-bookings/:hotel_booking_id/initialize-payment

Initialize a payment

Authorization: member admin superadmin

Attributes	Type	Description
payment_method required	string	The payment method.
credit_card_id required when payment_method = cc	string	[Credit Card] the token of the selected credit card.
credit_card_owner required when payment_method = cc	string	[Credit Card] the owner of the selected credit card.
paypal_payment_id required when payment_method = paypal	string	[PayPal] the paypal payment_id.
paypal_payer_id required when payment_method = paypal	string	[PayPal] the paypal payer id.
change_payment_method optional	boolean	Flag that indicates if the action is used to initialize a new payment method.
bta_card_id required when payment_method = amex_bta	string	[Amex BTA] amex bta card id.
bta_card_account_id required when payment_method = amex_bta	string	[Amex BTA] the account id of the selected amex bta card.
bta_card_number required when payment_method = amex_bta	string	[Amex BTA] the number of the selected amex bta card.
hokodo_data required when payment_method = hokodo	object	[Hokodo] Object of Hokodo Data

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
INSUFFICIENT_FOUNDS_CC	There not enough money to execute the operation you request on the credit card of the user.
LIMIT_EXCEEDED_CC	Unable to execute this operation, you have exceeded the maximum amount for your credit card.
CONTACT_TO_THE_BANK	Unable to execute this operation, please contact your bank for more info!
EXPIRED_CARD_CC	Your credit card looks like its already expired
COMPROMISED_CC	The credit card has been flagged as lost, stolen, or otherwise compromised.
CARDHOLDER_STOP_CC	The cardholder has requested their bank to stop all billing for this card.
SECURITY_VIOLATION_CC	The issuing bank detected a security violation and declined the transaction.
FRAUD_CC	The credit card has been flagged as fraud.
TEMPORARY_ISSUE_CC	Unable to execute this operation due to a temporary issue with the bank, try again!

POST hotel-bookings/:hotel_booking_id/edit/price-changes

Adds new price change to a booking

Authorization:

Attributes	Type	Description
reference optional	string	Reference of price change
reference_id optional	string	The id of the reference
reference_type optional	string	The type of the reference
amount optional	number	The amount of the price change
date optional	string	The date when the price change occurs
reference_transaction optional	string	The id of the transaction
type optional	string	The type of the price change

GET hotel-bookings/:hotel_booking_id/edit/price-changes

Get booking price changes section

Authorization:

PUT hotel-bookings/:hotel_booking_id/edit/price-changes/:price_change_id

Updates a price change from a booking

Authorization:

Attributes	Type	Description
reference optional	string	Reference of price change
reference_id optional	string	The id of the reference
reference_type optional	string	The type of the reference
amount optional	number	The amount of the price change
date optional	string	The date when the price change occurs
reference_transaction optional	string	The id of the transaction
type optional	string	The type of the price change

DELETE hotel-bookings/:hotel_booking_id/edit/price-changes/:price_change_id

Delete a price change from a booking

Authorization:

POST hotel-bookings/:hotel_booking_id/edit/price-changes/confirm

Confirm all price changes that are in draft status

Authorization:

POST hotel-bookings/:hotel_booking_id/edit/price-changes/discard

Discard all price changes that are in draft status

Authorization:

GET hotel-custom-rates

List the rates negotiated directly between an account and a hotel. Room prices are per night and are the negotiated ones, and the hotel contact and agreement notes are returned in full.

Authorization: superadmin

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
sort optional	string	The sort modality
stats optional	boolean	When true, include the total number of matching negotiated rates.
name optional	string	Filter hotel custom rates by name
hotel_id optional	string	Filter hotel custom rates by hotel_id
account_id optional	string	Filter hotel custom rates by account_id
is_active optional	boolean	Filter hotel custom rates by active flag.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
NOT_FOUND	The resource you are trying to get not exists.

GET hotel-custom-rates/:id

Get one rate negotiated with a hotel, with its rooms, their per-night negotiated prices and the availability windows. The id is the one of the negotiated rate, not of a booking.

Authorization: superadmin

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
NOT_FOUND	The resource you are trying to get not exists.

POST hotel-custom-rates

Create a hotel custom rate.

Authorization: superadmin

Attributes	Type	Description
name required	string	The hotel custom rate name.
account_id required	string	The hotel custom rate account id
hotel_id required	string	The hotel custom rate hotel id
hotel_email required	string	The hotel email
agreement_info optional	string	The agreement info.
is_active required	boolean	Indicate if the hotel custom rate is currently active.
expiration_date required	string	Indicate if the hotel custom rate is currently active.
rooms optional	array	The hotel custom rates rooms.
locale optional	string	Hotel custom rate locale
min_confirmation_days required	number	Maximum number of days in which it is possible to act on the rate (starting from the checkin date)

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
NOT_FOUND	The resource you are trying to get not exists.

POST hotel-custom-rates/:id/upload-attachments

Upload a list of files associated to a hotel custom rate.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
attachments required	array		The files list

Errors codes
MAX_BYTES_EXCEEDED	You are trying to upload a file that exceed the maximum bytes allowed.
INVALID_FILE_FORMAT	You are trying to upload an invalid file type.

POST hotel-custom-rates/:id/delete-attachments

Delete hotel custom rate attachments.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
attachments_ids required	array		The attachments ids

Errors codes
MAX_BYTES_EXCEEDED	You are trying to upload a file that exceed the maximum bytes allowed.
INVALID_FILE_FORMAT	You are trying to upload an invalid file type.

PUT hotel-custom-rates/:id

Update a hotel custom rate.

Authorization: superadmin

Attributes	Type	Description
name optional	string	The hotel custom rate name.
hotel_id optional	string	The hotel custom rate hotel id
hotel_email optional	string	The hotel email
agreement_info optional	string	The agreement info.
is_active optional	boolean	Indicate if the hotel custom rate is currently active.
expiration_date optional	string	Indicate if the hotel custom rate is currently active.
locale optional	string	Hotel custom rate locale
min_confirmation_days optional	number	Maximum number of days in which it is possible to act on the rate (starting from the checkin date)

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
NOT_FOUND	The resource you are trying to get not exists.

POST hotel-custom-rates/:id/add-room

Add a room to an hotel custom rate.

Authorization: superadmin

Attributes	Type	Description
name required	string	The hotel custom room name.
guests required	object	The hotel custom room guest informations.
type required	string	The hotel custom room type.
price required	number	The hotel custom room price.
currency optional	string	The hotel custom room currency.
max_quantity optional	number	The hotel custom room max quantity.
is_refundable required	boolean	Indicates if the room rate is refundable.
min_refundable_days optional	number	Refundabled date deadline (referred to the check in date).
is_active required	boolean	Indicate if the hotel custom rate room is currently active.
rules optional	object	Hotel custom rate rules

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

PUT hotel-custom-rates/:custom_rate_id/room/:room_id

Update a hotel custom rate room.

Authorization: superadmin

Attributes	Type	Description
name optional	string	The hotel custom room name.
guests optional	object	The hotel custom room guest informations.
type optional	string	The hotel custom room type.
price optional	number	The hotel custom room price.
currency optional	string	The hotel custom room currency.
max_quantity optional	number	The hotel custom room max quantity.
is_refundable optional	boolean	Indicates if the room rate is refundable.
min_refundable_days optional	number	The hotel custom room max quantity.
is_active optional	boolean	Indicate if the hotel custom rate room is currently active.
rules optional	object	Hotel custom rate rules

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
NOT_FOUND	The resource you are trying to get not exists.

DELETE hotel-custom-rates/:id

Delete a hotel custom rate.

Authorization: superadmin

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
NOT_FOUND	The resource you are trying to get not exists.

DELETE hotel-custom-rates/:custom_rate_id/room/:room_id

Delete a hotel custom rate room.

Authorization: superadmin

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
NOT_FOUND	The resource you are trying to get not exists.

GET hotel-custom-rates/booking/:token

Read a booking made on a negotiated rate, as the hotel sees it in the confirmation portal. The token is the single secret of this flow: it is generated when the confirmation request email is sent, stored on the booking, and rotated every time that email is sent again, which invalidates the previous link. It does not expire on its own and it is not consumed by reading. Anyone holding the token can call this without a BizAway token, so treat it as a credential. The response is the portal view of the booking, not the negotiated rate entity, and it identifies the booking with _id.

Authorization: guest

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
NOT_FOUND	The resource you are trying to get not exists.

POST hotel-custom-rates/booking/:token/confirm

Endpoint used by the hotel to confirm the custom rate booking

Authorization: guest

Attributes	Type	Authorization	Description
employee_name required	string		Name of the hotel employee who confirms the booking
provider_code optional	null\|string		Internal booking code of the hotel

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
NOT_FOUND	The resource you are trying to get not exists.

POST hotel-custom-rates/booking/:token/void

Endpoint used by the hotel to void the custom rate booking

Authorization: guest

Attributes	Type	Authorization	Description
employee_name required	string		Name of the hotel employee who refuses the booking
motivation required	string		Reason for which the booking was refused by the hotel

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
NOT_FOUND	The resource you are trying to get not exists.

POST hotel-custom-rates/booking/:token/confirm-cancellation

Endpoint used by the hotel to confirm the custom rate cancellation request

Authorization: guest

Attributes	Type	Authorization	Description
employee_name required	string		Name of the hotel employee who confirm the cancellation request

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
NOT_FOUND	The resource you are trying to get not exists.

POST hotel-custom-rates/booking/:token/refuse-cancellation

Endpoint used by the hotel to refuse the custom rate cancellation request

Authorization: guest

Attributes	Type	Authorization	Description
employee_name required	string		Name of the hotel employee who refuses the cancellation request
motivation required	string		Reason for which the booking was refused by the hotel

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
NOT_FOUND	The resource you are trying to get not exists.

GET hotel-custom-rates/booking/:id/resend-notification

Send the hotel again the pending request email for a custom rate booking: the confirmation request when the booking is processing, the cancellation request when it is cancelling, and an error for any other status. This sends an email despite being a GET, so it is not safe to call to read state. On the confirmation path it also issues a new portal token, which invalidates the link sent earlier, and it writes an activity entry every time. It is not idempotent: every call sends another email to the hotel. The id is the one of the hotel booking, not of the negotiated rate, and the body only reports the outcome.

Authorization: superadmin

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
NOT_FOUND	The resource you are trying to get not exists.
BOOKING_NOT_VALID_STATUS	This booking is not in a valid status to execute the requested operation.

GET hotels/property-types

Alias of GET /v1/property-types, kept for the clients that call it under the hotels prefix. Same handler, same payload; prefer the shorter path.

Authorization: member admin app superadmin

GET hotels/rate-policies

Alias of GET /v1/rate-policies, kept for the clients that call it under the hotels prefix. Same handler, same payload; prefer the shorter path.

Authorization: member admin app superadmin

GET hotels/rate-types

Alias of GET /v1/rate-types, kept for the clients that call it under the hotels prefix. Same handler, same payload; prefer the shorter path.

Authorization: member admin app superadmin

GET hotels

List the hotels of the BizAway inventory. This is our own stored data, so the read never calls a provider. Pass locale to get the free-text fields in that language.

Authorization: member admin app superadmin

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
stats optional	boolean	When true, include the total number of matching hotels.
locale optional	string	Language of the free-text fields such as description, policies and fees. English is used when it is omitted, and an unsupported value falls back to English rather than failing.
name optional	string	Filter hotels by name
stars optional	string	Filter hotels by stars
giataId optional	string	Filter hotels by giataId
mapping_provider optional	string	Filter hotels by choosing a mapping_provider from a predefined set.
mapping_provider_id optional	string	Filter hotels by a specific mapping_provider_id.
property_type optional	string	Filter hotels by typology.
country optional	string	Filter hotels by country.
city optional	string	Filter hotels by city.
chain_id optional	string	Filter hotels by chain_id

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET hotels/:hotel_id

Get one hotel of the BizAway inventory, with its address, position, amenities, images and the free-text information published by the property. No provider is called. Pass locale to get the free-text fields in that language.

Authorization: member admin app superadmin

Attributes	Type	Authorization	Description
locale optional	string		Language of the free-text fields such as description, policies and fees. English is used when it is omitted, and an unsupported value falls back to English rather than failing.

POST hotels

Manually add a new hotel.

Authorization: superadmin

Attributes	Type	Description
name optional	string	Name of the hotel.
stars optional	number	Stars of the hotel.
property_type optional	string	Typology of the hotel.
position optional	object	Geographical coordinates of the hotel. Must include both `lat` and `lon` as strings representing latitude and longitude.
country optional	string	Country where the hotel resides.
is_active optional	boolean	Sets whether the hotel is active or not.
default_image optional	string	Default hotel picture.
images optional	array	Default hotel picture.
giataId optional	string	Giata ID of the hotel.
currency optional	string	Currency of the hotel.
total_rooms optional	number	Number of total rooms of the hotel.
phone optional	string	Phone number of the hotel.
web optional	string	Web site of the hotel.
email optional	string	Email address of the hotel.
address optional	string	Address of the hotel.
city optional	string	City of the hotel.
postal_code optional	string	Postal code of the hotel.
chain_id optional	string	Chain id oh the hotel's chain

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

PUT hotels/:hotel_id

Manually update an existing hotel.

Authorization: superadmin

Attributes	Type	Description
name optional	string	Name of the hotel.
stars optional	number	Stars of the hotel.
property_type optional	string	Typology of the hotel.
position optional	object	Geographical coordinates of the hotel. Must include both `lat` and `lon` as strings representing latitude and longitude.
country optional	string	Country where the hotel resides.
is_active optional	boolean	Sets whether the hotel is active or not.
default_image optional	string	Default hotel picture.
images optional	array	Default hotel picture.
giataId optional	string	Giata ID of the hotel.
currency optional	string	Currency of the hotel.
total_rooms optional	number	Number of total rooms of the hotel.
phone optional	string	Phone number of the hotel.
web optional	string	Web site URL of the hotel.
email optional	string	Email address of the hotel.
address optional	string	Address of the hotel.
city optional	string	City of the hotel.
postal_code optional	string	Postal code of the hotel.
chain_id optional	string	Chain id oh the hotel's chain

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

DELETE hotels/:hotel_id

Delete a hotel.

Authorization: superadmin

POST hotels/solutions/searches

Create an hotel search

Authorization:

Attributes	Type	Authorization	Description
account_id Required only for superadmins	string	superadmin	The account_id context
place_id required	string		A place id.
position optional	object
check_in required	string		The check-in date in the format YYYY/MM/DD.
check_out required	string		The check-out date in the format YYYY/MM/DD.
locale required	string		The locale for the language of the results contents.
rooms required	array		An array containing the number of adults and child with their ages.
nationality optional	string		User nationality.
user_id optional	string		User id.
is_package_search optional	boolean		A flag to check if user is booking other verticals with us.
merchant optional	string		Specify a merchant

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET hotels/solutions/searches/:search_id

Poll the hotels found by a solutions search session. Poll until status is completed or error: while it is inProgress the results grow and the prices can go down as more providers answer. Reading the session does not call any provider. Pick a hotel and start a fares search on it to get the bookable rates.

Authorization:

Attributes	Type	Description
locale required	string	The locale for the language of the results contents.
account_id optional	string	Account the search belongs to. Required when the caller is a superadmin, which otherwise fails with MISSING_PARAMETERS.
limit optional	number	Number of results.
offset optional	number	Results left margin
sort optional	string	Define the sortings rules. Sortable fields: price, stars, review_score, priority and distance.
only_available_rates optional	boolean	Filter by available rates.
only_preferred_hotels optional	boolean	Filter by preferred hotels.
only_recommended_hotels optional	boolean	Filter by recommended hotels.
is_negotiated optional	boolean	Filter by is_negotiated.
name optional	string	Filter by hotel name.
distance optional	number	Filter by distance from the center.
stars optional	string	Filter by hotel stars.
review_score optional	number	Filter by hotel review score.
property_types optional	string	Filter by hotel property types.
price optional	string	Filter by price range.
attributes optional	string	Filter by attributes.
hotel_chains optional	string	Filter by hotel chains.
has_cancellation optional	boolean	Filter by has_cancellation.
is_in_policy optional	boolean	Filter by is_in_policy.
has_breakfast optional	boolean	Filter by breakfast included.
merchants optional	string	Filter by merchants.
displayable_chains_only optional	boolean	When true, omit non-displayable hotel chains from the hotel_chains aggregator. Defaults to false.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
MISSING_PARAMETERS	Missing parameters.
NOT_FOUND	The resource you are trying to get not exists.

POST hotels/fares/searches

Create a hotel search fares session

Authorization:

Attributes	Type	Authorization	Description
account_id Required only for superadmins	string	superadmin	The account_id context
hotel_id required	string		A place id.
check_in required	string		The check-in date in the format YYYY/MM/DD.
check_out required	string		The check-out date in the format YYYY/MM/DD.
locale required	string		The locale for the language of the results contents.
rooms required	array		An array containing the number of adults and child with their ages.
nationality optional	string		User nationality.
is_package_search optional	boolean		A flag to check if user is booking other verticals with us.
provider optional	string		Optional provider key to query. When provided, the search runs only against this provider. Must be a configured hotel provider key.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET hotels/fares/searches/:search_id

Poll the bookable rates found by a fares search session for one hotel. Poll until status is completed or error: while it is inProgress the results grow and a price can improve. Reading the session does not call any provider. The rate items here are lighter than the fare you get after creating one from them.

Authorization:

Attributes	Type	Description
locale required	string	The locale for the language of the results contents.
account_id optional	string	Account the search belongs to. Required when the caller is a superadmin, which otherwise fails with MISSING_PARAMETERS.
holder_id optional	string	User to evaluate the company travel policy against, when it is not the traveller who created the search.
limit optional	number	Number of results.
offset optional	number	Results left margin
sort optional	string	Define the sortings rules. Sortable fields: price.
price optional	string	Filter by price range.
cancellation_policy optional	string	Filter by cancellation policy, one or more separated by commas. Values: refundableFree, notRefundable, notAvailable.
type optional	string	Filter by rate type, one or more separated by commas. Values: onlyBed, bedAndBreakfast, halfBoard, fullBoard, bedAndDinner, allInclusive.
merchant optional	string	Filter by merchant.
room_codes optional	string	Filter by room codes.
negotiated optional	string	Filter by negotiated: account or negotiated: bizaway.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
MISSING_PARAMETERS	Missing parameters.
NOT_FOUND	The resource you are trying to get not exists.

POST hotels/fares

Create a fare

Authorization:

Attributes	Type	Authorization	Description
search_fare_id required	string		A search fare id.
locale required	string		The locale for the language of the results contents.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET hotels/fares/:fare_id

Get a built hotel fare, that is the rate selected from a fares search and prepared for booking. Its payload is richer than the rate item inside the search: it embeds a snapshot of the hotel, the issuing fee, the provider price breakdown and the charging dates, and it drops the per-rate policy outcome. The originating search rate is kept in search_fare_id.

Authorization:

Attributes	Type	Authorization	Description
locale required	string		The locale for the language of the results contents.
account_id optional	string		Account the fare belongs to, used when the caller has no account of their own.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
NOT_FOUND	The resource you are trying to get not exists.

GET property-types

List the kinds of property a hotel can be, as key and English label. This is the canonical path; GET /v1/hotels/property-types is an alias of it. The list comes from a file shipped with the platform and can change with a deploy, so read it instead of hardcoding the values. The labels are not localized.

Authorization: member admin app superadmin

GET rate-policies

List the cancellation policies a hotel rate can have, as key and English label. This is the canonical path; GET /v1/hotels/rate-policies is an alias of it. The labels are not localized.

Authorization: member admin app superadmin

GET rate-types

List the board types a hotel rate can include, as key and English label. This is the canonical path; GET /v1/hotels/rate-types is an alias of it. The labels are not localized.

Authorization: member admin app superadmin

GET invoice-profiles/my-account

List the invoice profiles that belong to the whole account, that is the ones with no owning user. A superadmin has no account of their own and must pass account_id, otherwise the request fails with MISSING_PARAMETERS. Any restriction to specific users or groups is reported on each profile but is not applied to this list.

Authorization: admin superadmin

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
sort optional	string	The sort modality
id optional	string	Filter by invoice profile id
account_id optional	string	Filter by account id
name optional	string	Filter by name
is_deleted optional	boolean	Filter by is deleted
user_id optional	string	Accepted but pointless here: this list only returns profiles without an owning user, so filtering by user_id always yields an empty page.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
MISSING_PARAMETERS	Missing parameters.

GET invoice-profiles/my-user

List the personal invoice profiles owned by the calling user. The scope comes from the token and not from any parameter, and no account is involved, so a superadmin service user gets its own profiles only, which is normally an empty page. To read the profiles of an account use the my-account or public routes with account_id.

Authorization: member admin superadmin

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
sort optional	string	The sort modality
id optional	string	Filter by invoice profile id
account_id optional	string	Filter by account id
name optional	string	Filter by name
is_deleted optional	boolean	Filter by is deleted

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET invoice-profiles/public

List every invoice profile the calling user can use inside one account, that is the account-level ones plus their own personal ones. Despite the name nothing here is publicly readable. A superadmin has no account of their own and must pass account_id, otherwise the request fails with MISSING_PARAMETERS.

Authorization: member admin superadmin

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
sort optional	string	The sort modality
id optional	string	Filter by invoice profile id
account_id optional	string	Filter by account id
name optional	string	Filter by name
is_deleted optional	boolean	Filter by is deleted

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
MISSING_PARAMETERS	Missing parameters.

POST invoice-profiles

Create new invoice profile.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
account_id Required only for superadmins	string	superadmin	The invoice profile account id
user_id Required only for superadmins	string	superadmin	The invoice profile user id
name required	string		The invoice profile name
default_billing_address_id optional	string		The invoice profile name
is_personal required	boolean		Define if the invoice profile is personal
is_deleted optional	boolean		Define if the invoice profile is deleted
email_destinataries optional	array		Admin emails where to send the invoices.
credit_note_recipients optional	object		Recipients for credit note emails.
payment_reminder_recipients optional	object		Recipients for payment reminder emails.
allowed_users optional	array		Users allowed to use this profile
allowed_groups optional	array		Groups of users allowed to use this profile
default_payment_method optional	string		The default_payment_method
default_payment_option optional	string		The default_payment_option than can be id or code number

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

PUT invoice-profiles/:invoice_profile_id

Update an invoice profile.

Authorization: member admin superadmin

Attributes	Type	Description
account_id optional	string	The invoice profile account id
user_id optional	string	The invoice profile user id
name optional	string	The invoice profile name
default_billing_address_id optional	string	The invoice profile name
is_personal optional	boolean	Define if the invoice profile is personal
is_deleted optional	boolean	Define if the invoice profile is deleted
email_destinataries optional	array	Admin emails where to send the invoices.
credit_note_recipients optional	object	Recipients for credit note emails.
payment_reminder_recipients optional	object	Recipients for payment reminder emails.
allowed_users optional	array	Users allowed to use this profile
allowed_groups optional	array	Groups of users allowed to use this profile
default_payment_method optional	string	The default_payment_method
default_payment_option optional	string	The default_payment_option than can be id or code number

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

DELETE invoice-profiles/:invoice_profile_id

Set 'is_deleted' true on a giving invoice profile.

Authorization: member admin superadmin

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET invoice-reports

List the invoice reports, each being a named selection of the invoices of one account within an issue date window. A superadmin sees the reports of every account unless account_id is passed, so scope the request to keep it cheap.

Authorization: admin superadmin

Attributes	Type	Authorization	Description
limit optional	integer		Number of results to return
offset optional	integer		Index of the result to start to return results
sort optional	string		The sort modality
stats optional	boolean		When true, include the total number of matching reports.
id optional	string		Filter invoice reports by id
account_id optional	string	superadmin	Filter invoice reports by account_id
is_internal optional	boolean	superadmin	Filter invoice reports by is_internal
name optional	string		Filter invoice reports by name
number optional	string		Filter invoice reports by number
created_from optional	string		Filter invoice reports by creation from
created_to optional	string		Filter invoice reports by creation to
is_automatic optional	boolean		Filter automatic invoice reports

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET invoice-reports/:invoice_report_id

Get one invoice report, that is its name, number and the issue date window that selects its invoices. Read the invoices themselves from the sibling invoices route and the figures from the sibling stats route.

Authorization: admin superadmin

GET invoice-reports/:invoice_report_id/invoices

Get all invoices that matches the report specification.

Authorization: admin superadmin

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
sort optional	string	The sort modality

GET invoice-reports/:invoice_report_id/stats

Get the figures of an invoice report: counts and amounts over the invoices it selects, with one entry per currency and a breakdown by payer. The scope comes entirely from the report, so this route takes no filter; it counts only registered, non personal invoices and ignores the single invoices that belong to a group invoice. Amounts are summed in their own currency and never converted.

Authorization: admin superadmin

POST invoice-reports

Create an invoice report.

Authorization: admin superadmin

Attributes	Type	Authorization	Description
account_id optional	string	superadmin	The account_id context
is_internal optional	boolean	superadmin	Define if the report is for internal use
name required	string		Name of the invoice report.
filters.issue_date_from required	string		Issue date from of the invoice report.
filters.issue_date_to required	string		Issue date to of the invoice report.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST invoice-reports/:invoice_report_id/download

Download invoices of a specific invoice report

Authorization: member admin app superadmin

Attributes	Type	Authorization	Description
currency optional	string		Currency of invoices to download

PUT invoice-reports/:invoice_report_id

Update an invoice report.

Authorization: admin superadmin

Attributes	Type	Authorization	Description
is_internal optional	boolean	superadmin	Define if the report is for internal use
name optional	string		Name of the invoice report.
filters.issue_date_from optional	string		Issue date from of the invoice report.
filters.issue_date_to optional	string		Issue date to of the invoice report.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

DELETE invoice-reports/:invoice_report_id

Delete an invoice report.

Authorization: admin superadmin

GET invoices

List invoices visible to the caller using the supplied filters.

Authorization:

Attributes	Type	Authorization	Description
limit optional	integer		Number of results to return
offset optional	integer		Index of the result to start to return results
stats optional	boolean		When true, include the total number of matching invoices.
id optional	string		Filter invoices by id
ids optional	array		Filter invoices by multiple ids
account_id optional	string		Filter invoices by account_id
billing_address_id optional	string	admin,superadmin	Filter invoices by billing_address_id
invoice_profile_id optional	string	admin,superadmin	Filter invoices by invoice profile id
sectional optional	string		Filter invoices by sectional
number optional	string		Filter invoices by number
category optional	string		Filter invoices by category
created_from optional	string		Filter invoices by creation from
created_to optional	string		Filter invoices by creation to
issue_date_from optional	string		Filter invoices by issued from
issue_date_to optional	string		Filter invoices by issued to
payment_deadline_from optional	string		Filter invoices by payment deadline from
payment_deadline_to optional	string		Filter invoices by payment deadline to
status optional	string		Filter invoices by payment status, one or more separated by commas. Values: not_paid, paid, voided, not_refunded, refunded.
is_registered optional	boolean		Filter registered invoices
registration_status optional	string		Filter invoices by registration status
is_rounding optional	boolean		Filter service if has rounding
is_agency_regime optional	boolean		Filter agency regime invoices
credit_note_number optional	string		Filter invoices by credit note number
credit_note_created_from optional	string		Filter invoices by credit note creation from
credit_note_created_to optional	string		Filter invoices by credit note creation to
credit_note_issue_date_from optional	string		Filter invoices by credit note issued from
credit_note_issue_date_to optional	string		Filter invoices by credit note issued to
credit_note_is_registered optional	boolean		Filter registered credit note invoices
account_lead_source optional	string		Filter invoices by account lead source
destinatary_country optional	string		Filter invoices by destinatary country
is_personal optional	boolean		Filter personal invoices
version optional	number		Filter by version
preferred_booking_payment_method optional	string		Filter invoices by payment method
commercial_responsible optional	string		Filter invoices by commercial_responsible_id
vat_code optional	string		Filter invoices by vat_code
sectional optional	string		Filter invoices by sectional
need_reconciliation optional	boolean		Filter invoices by need reconciliation
exclude_consolidated_with_group optional	boolean		Exclude consolidated invoices that are linked to a group
currency optional	string		Filter by currency
has_manual_cc optional	boolean		Filter invoices by has manual credit card

GET invoices/stats

Get aggregated invoice figures, with one entry per currency and no conversion between currencies. Without filters the aggregation spans every invoice on the platform and is expensive, so narrow it down, typically by account and by a date range. It ignores the single invoices that belong to a group invoice, and unlike the invoice report figures it applies no default on personal or not yet registered invoices.

Authorization:

Attributes	Type	Description
limit optional	integer	Accepted but ignored: the aggregation always covers every matching invoice.
offset optional	integer	Accepted but ignored: the aggregation always covers every matching invoice.
ids optional	array	Filter invoices by multiple ids
account_id optional	string	Filter invoices by account_id
category optional	string	Filter invoices by category
sectional optional	string	Filter invoices by sectional
created_from optional	string	Filter invoices by creation from
created_to optional	string	Filter invoices by creation to
issue_date_from optional	string	Filter invoices by issued from
issue_date_to optional	string	Filter invoices by issued to
payment_deadline_from optional	string	Filter invoices by payment deadline from
payment_deadline_to optional	string	Filter invoices by payment deadline to
preferred_booking_payment_method optional	string	Filter invoices by payment method
commercial_responsible optional	string	Filter invoices by commercial_responsible_id
status optional	string	Filter invoices by payment status. Values: not_paid, paid, voided, not_refunded, refunded.
is_registered optional	boolean	Filter registered invoices
is_agency_regime optional	boolean	Accepted but ignored by this aggregation.
billing_address_id optional	string	Filter by billing address
is_personal optional	boolean	Filter personal invoices
account_lead_source optional	string	Restrict the aggregation to the accounts coming from this lead source.
currency optional	string	Accepted but ignored: the figures are always grouped by the currency of each invoice.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET invoices/settings

Get the reference data used when creating and registering invoices: tax rates, bookkeeping counterparts, service types, numbering sectionals, the countries where VAT recovery is enabled and the payment terms. These are platform-wide values, not per-account settings. The payment terms come from the accounting system and are cached, so an empty terms list means that system was unreachable rather than that none are configured.

Authorization:

GET invoices/:invoice_id

Get the invoice detail.

Authorization:

PUT invoices/:invoice_id

Update an account invoice.

Authorization:

Attributes	Type	Description
number optional	string	The invoice number
issue_date optional	string	The invoice issue date
account_id optional	string	The invoice account id
category optional	string	The invoice category
locale optional	string	The invoice locale
billing_address_id optional	string	The invoice assocaited billing address
invoice_profile_id optional	string	The invoice profile id
fiscal_products optional	array	The fiscal products of the invoice
services optional	array	The invoice list of services
is_registered optional	boolean	Define if the invoice is registered
is_agency_regime optional	boolean	Define if the invoice is agency regime
status optional	string	The invoice status
inner_transactions optional	array	Update invoice inner transactions
destinatary.sdi_code required	null\|string	The sdi code of electronic invoicing
destinatary.pec required	null\|string	Pec
version optional	number	The invoice version
external_sectional optional	string	The ERP external sectional
external_id optional	string	The ERP external ID
meta.source optional	string	The source of the system that call the API
need_reconciliation optional	boolean	Define if the invoice need reconciliation

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST invoices/:invoice_id/update-document

Update the pdf document

Authorization:

Attributes	Type	Authorization	Description
locale optional	string		The locale for the language of the results contents.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST invoices/download-excel

Download invoice excel.

Authorization:

Attributes	Type	Authorization	Description
invoice_id required	string		invoice id to download excel

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST invoices/product-details-fields

Get the invoice product details configuration.

Authorization:

Attributes	Type	Authorization	Description
locale required	string		The locale for the language of the results contents.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST invoices/download-product-details

Download invoice product details csv.

Authorization:

Attributes	Type	Description
invoice_id required	string	invoice id
csv_fields_config required	string	List of fields to include in the prodict details csv.
save_config optional	boolean	If true, saves the selected csv configuration as default for future exports.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST invoices/download

Download a zip of invoices

Authorization:

Attributes	Type	Authorization	Description
ids optional	array		Array of invoices id to download in a zip

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST invoices/export

Export invoices

Authorization:

Attributes	Type	Description
created_from optional	string	Filter fiscal documents by creation from
created_to optional	string	Filter fiscal documents by creation to
issue_date_from optional	string	Filter fiscal documents by issued from
issue_date_to optional	string	Filter fiscal documents by issued to
payment_deadline_from optional	string	Filter fiscal documents payment deadline from
payment_deadline_to optional	string	Filter fiscal documents by payment deadline to
account_id optional	string	Filter fiscal documents by account_id
is_registered optional	boolean	Filter registered fiscal documents
is_agency_regime optional	boolean	Filter agency regime fiscal documents
format optional	string	Allows to choose the format in which exports will be generated

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST invoices/inner-transactions/export

Export inner transactions

Authorization:

Attributes	Type	Description
transfer_date_from optional	string	Filter inner transactions by transfer date from
transfer_date_to optional	string	Filter inner transactions by transfer date to
format optional	string	Allows to choose the format in which exports will be generated

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST invoices/bulk-update

Bulk update of invoices

Authorization:

Attributes	Type	Description
values.is_registered optional	boolean	Define if the invoice is registered
filters.number optional	string	Filter invoices by number
filters.category optional	string	Filter invoices by category
filters.created_from optional	string	Filter invoices by creation from
filters.created_to optional	string	Filter invoices by creation to
filters.issue_date_from optional	string	Filter invoices by issued from
filters.issue_date_to optional	string	Filter invoices by issued to
filters.status optional	string	Filter invoices by status
filters.is_registered optional	boolean	Filter registered invoices
filters.is_agency_regime optional	boolean	Filter agency regime invoices
filters.credit_note_number optional	string	Filter invoices by credit note number
filters.credit_note_created_from optional	string	Filter invoices by credit note creation from
filters.credit_note_created_to optional	string	Filter invoices by credit note creation to
filters.credit_note_issue_date_from optional	string	Filter invoices by credit note issued from
filters.credit_note_issue_date_to optional	string	Filter invoices by credit note issued to
filters.credit_note_is_registered optional	boolean	Filter registered credit note invoices

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST invoices/inner-transactions/bulk-update

Bulk update of inner transactions

Authorization:

Attributes	Type	Description
values.is_registered optional	boolean	Define if the invoice is registered
filters.transfer_date_from optional	string	Filter inner transaction by transfer date from
filters.transfer_date_to optional	string	Filter inner transaction by transfer date to

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

DELETE invoices/:invoice_id

Delete an account invoice.

Authorization:

GET licence-reports

Get all the licence reports.

Authorization:

Attributes	Type	Authorization	Description
limit optional	integer		Number of results to return
offset optional	integer		Index of the result to start to return results
sort optional	string		The sort modality
id optional	string		Filter licence reports by id
account_id optional	string	superadmin	Filter licence reports by account_id
issue_date_from optional	string		Filter licence reports by issue date from
issue_date_to optional	string		Filter invoice reports by issue date to
is_delivered optional	boolean		Filter licence report delievered
status optional	string		Filter licence report by status
license_type optional	string		Filter licence by license type

GET licence-reports/:licence_report_id

Get the licence report detail.

Authorization: admin superadmin

DELETE licence-reports/:licence_report_id

Delete a licence report.

Authorization:

POST licence-reports

Create a licence report.

Authorization:

Attributes	Type	Description
account_id required	string	The licence report account id
is_internal optional	boolean	Licence report is internal or not
issue_date_from optional	string	The licence report start date
issue_date_to optional	string	The licence report end date
name optional	string	The licence report name

PUT licence-reports/:licence_report_id

Update a licence report.

Authorization:

Attributes	Type	Description
email_destinataries optional	array	The report email destinataries
total_amendment optional	float	The total amendment granted for the report
status optional	string	The status of the report

GET licence-reports/:licence_report_id/send

Email the licence report to the addresses configured on it, generating its spreadsheet first if it does not exist yet, and then mark the report as delivered and processed. This sends real email and changes the report despite being a GET, so it must never be called to read state, and it is not idempotent: every call sends the report again. The response body carries no data.

Authorization:

Errors codes
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
NOT_FOUND	The resource you are trying to get not exists.

GET licence-reports/:licence_report_id/create_report_file

Rebuild the spreadsheet of the licence report: it deletes the previous file, generates a new one, stores it and updates the report. This writes despite being a GET, so it must never be called to read state, and it is not idempotent. The file is not returned in the response, which carries no data; read the report to get the link to it.

Authorization:

Attributes	Type	Authorization	Description
locale required	string		Language the spreadsheet is generated in.

Errors codes
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
VALIDATION_FAILED	Validation of the parameters failed.
NOT_FOUND	The resource you are trying to get not exists.

POST licence-reports/:licence_report_id/items

Update a licence report with new items

Authorization:

Attributes	Type	Authorization	Description
items optional	array		Add new bookings to the report

PUT licence-reports/:licence_report_id/items/:item_id

Update a licence report item

Authorization:

Attributes	Type	Authorization	Description
amount optional	float		The item amount
market_price_savings optional	float		The item market price savings

POST licence-reports/:licence_report_id/delete-items

Delete a list of licence report items.

Authorization:

Attributes	Type	Authorization	Description
item_ids optional	array		The item ids to remove from the report

DELETE licence-reports/:licence_report_id/items/:item_id

Delete an item from the licence report.

Authorization:

POST payment-methods/init-braintree

Init Braintree.

Authorization: member admin superadmin

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST payment-methods/init-paypal

Initialize a PayPal transaction.

Authorization: member admin superadmin

Attributes	Type	Description
ref_type required	string	A referement type.
ref_id required	string	A booking id.
return_url required	string	The paypal return url.
cancel_url required	string	The paypal cancel url.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET railcards

List railcards visible to the caller. Superadmins see all railcards; other roles must filter by users of their own account.

Authorization:

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
sort optional	string	The sort modality
users_ids optional	string	Filter railcards by owner user ids, comma separated. Required for non-superadmin callers.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET railcards/:railcard_id

Get railcard details, with the owner user and the railcard type embedded.

Authorization:

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST railcards

Create new railcard.

Authorization:

Attributes	Type	Description
name required	string	The railcard name
number optional	string	The railcard number
account_id Required only for superadmins	string	The railcard owner account id
user_id optional	string	The railcard user id
railcard_type_id required	string	The railcard type id
first_name required	string	First name of the owner
last_name required	string	Last name of the owner

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

PUT railcards/:railcard_id

Update a railcard.

Authorization:

Attributes	Type	Description
name optional	string	The railcard name
user_id Only a superadmin can change the railcard user reference	string	The railcard owner id
account_id Only a superadmin can change the railcard account reference	string	The railcard owner account id
first_name required	string	First name of the owner
last_name required	string	Last name of the owner

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

DELETE railcards/:railcard_id

Delete a railcard.

Authorization:

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET room-types

List the normalized room types, used to recognize the room names returned by the hotel providers and map them onto a single vocabulary. The vocabulary lives in the database and changes without a deploy, so read it instead of hardcoding it.

Authorization: member admin superadmin

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
stats optional	boolean	When true, include the total number of matching room types.
id optional	string	Filter room types by id
code optional	string	Filter room types by code
matches optional	string	Return the room types whose recognized provider names contain this text.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET room-types/:room_type_id

Get one normalized room type, with the provider room names it recognizes.

Authorization: member admin superadmin

POST room-types

Create a new hotel room type

Authorization: superadmin

Attributes	Type	Description
code optional	string	Internal code to map a specific hotel room type
translation_id optional	string	Translation id ref
matches optional	array	Keywords that must match a room name in order to map it

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

PUT room-types/:room_type_id

Manually update an hotel room type.

Authorization: superadmin

Attributes	Type	Description
code optional	string	Internal code to identify and map a specific hotel room type
translation_id optional	string	Translation id associated to the room type
matches optional	array	Keywords that must match a room name in order to map it

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

DELETE room-types/:room_type_id

Delete an hotel room type.

Authorization: superadmin

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET search

Global autocomplete over several entity families at once: places and hotels, stations and airports, and the back office entities (users, accounts, invoices, transactions and trips). Each requested family is queried independently and returned under its own key, so a single term can be resolved against every family the caller is allowed to see. Use the types parameter to restrict the families, because asking for all of them is considerably more expensive.

Authorization: member admin app superadmin

Attributes	Type	Description
q required	string	The term to search inside our search engine
locale required	string	The locale for search the term
types optional	string	The result families to query, one or more separated by commas. Values: places, places_detailed, location, hotels, stations, airports, users, accounts, invoices, transactions, trips. When omitted every family is queried. Unknown values are ignored rather than rejected, so a typo silently returns fewer families.
places_type optional	string	Restricts the places families to a Google Places type, for example airport or lodging. The vocabulary is Google's, not BizAway's, and the default is geocode\|establishment.
exclude_meta optional	boolean	Exclude meta data from output

GET search/stations

Search for stations

Authorization: member admin app superadmin

Attributes	Type	Description
limit optional	integer	Number of results to return
locale required	string	The locale for search the term
place_id required	string	The palce id to search inside our search engine

GET search/car-places

Search for airports

Authorization: member admin app superadmin

Attributes	Type	Description
limit optional	integer	Number of results to return
place_id required	string	The palce id to search inside our search engine
locale required	string	The locale

GET search-presets/my-account

List the search presets that belong to the whole account, that is the ones with no owning user. A superadmin has no account of their own and must pass account_id, otherwise the request fails with MISSING_PARAMETERS.

Authorization:

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
sort optional	string	The sort modality
stats optional	boolean	When true, include the total number of matching presets.
account_id optional	string	Filter by account_id

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
MISSING_PARAMETERS	Missing parameters.

GET search-presets/my-user

List the personal search presets owned by the calling user. The scope comes from the token and not from any parameter, and no account is involved, so a superadmin service user gets its own presets only, which is normally an empty page. To read the presets of an account use the my-account or public routes with account_id.

Authorization:

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
sort optional	string	The sort modality
stats optional	boolean	When true, include the total number of matching presets.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.

GET search-presets/public

List every search preset the calling user can use inside one account, that is the account-level ones plus their own personal ones. Despite the name nothing here is publicly readable. A superadmin has no account of their own and must pass account_id, otherwise the request fails with MISSING_PARAMETERS.

Authorization:

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
sort optional	string	The sort modality
stats optional	boolean	When true, include the total number of matching presets.
account_id optional	string	Filter by account_id

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
MISSING_PARAMETERS	Missing parameters.

GET search-presets/:search_preset_id

Get one search preset with its saved filters.

Authorization:

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
NOT_FOUND	The resource you are trying to get not exists.

POST search-presets

Create a search preset.

Authorization:

Attributes	Type	Description
account_id Required only for superadmins	objectId	The account_id context
name required	string	The search preset name
is_public optional	boolean	Indicates if the search preset is public
type required	string	The search preset type
filters optional	array	Filters array with filters data

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.

PUT search-presets/:search_preset_id

Update a search preset.

Authorization:

Attributes	Type	Description
account_id Required only for superadmins	objectId	The account_id context
name optional	string	The search preset name
is_public optional	boolean	Indicates if the search preset is public
type required	string	The search preset type
filters optional	array	Filters array with filters data

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.

DELETE search-presets/:search_preset_id

Deletes a search preset.

Authorization:

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.

POST tests/params

TEST PARAMS

Authorization: superadmin

Attributes	Type	Description
param1 required	integer	Param 1
obj.param2 required	integer	Param 2
obj.param3 required	integer	Param 3

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST tests/emails

Send an email

Authorization: superadmin

Attributes	Type	Description
booking_id required	string	The entity booking id
entity_type required	string	The entity type
action required	string	The kind of email to excecute
email required	string	The destinatary email
locale required	string	The locale for the email
data required	object	The extra data required for every kind of email action

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET tests/email-template

Test email cration in browser

Authorization: superadmin

Attributes	Type	Description
entity_id optional	string	The entity booking id
entity_type optional	string	The entity type
prebuilt required	string	The kind of email to excecute
locale required	string	The locale for the email

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET tests/hotel-booking-voucher-creation

Test pdf creation for vauchers from the browser.

Authorization: guest superadmin

Attributes	Type	Description
id required	string	The booking id
locale required	string	The locale for the email
mode optional	string	The output type. Default stream.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET tests/car-booking-voucher-creation

Test pdf creation for vauchers from the browser.

Authorization: guest admin superadmin

Attributes	Type	Description
id required	string	The booking id
locale required	string	The locale for the email
mode optional	string	The output type. Default stream.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST tests/flight-booking-boarding-pass-email

Send flight booking boarding passes email

Authorization: superadmin

Attributes	Type	Description
id required	string	The flight booking id
departure_airport required	string	The iata code of the departure airport
arrival_airport required	string	The iata code of the arrival airport
boarding_pass_file required	string	The boarding pass file url
email required	string	The destinatary email
locale required	string	The locale for the email

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET tests/flight-booking-ticket-creation

Test pdf creation for tickets from the browser.

Authorization: guest superadmin

Attributes	Type	Description
id required	string	The booking id
locale required	string	The locale for the email
mode optional	string	The output type. Default stream.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET tests/invoice-creation

Test invoice pdf creation from the browser.

Authorization: guest superadmin

Attributes	Type	Authorization	Description
id required	string		The invoice id
mode optional	string		The output type. Default stream.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET tests/invoice-details-creation

Test invoice details pdf creation from the browser.

Authorization: guest superadmin

Attributes	Type	Description
id required	string	The invoice id
locale required	string	The locale for the email
mode optional	string	The output type. Default stream.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST tests/invitation-email

Send invite email

Authorization: superadmin

Attributes	Type	Authorization	Description
user_id required	string		The destinatary user_id

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
NOT_FOUND	The resource you are trying to get not exists.
NOT_ACTIVE	The resource you are trying to use is not active.
EMAIL_ALREADY_USED	The email you are trying to use is already in use.

POST tests/logs

Test some logs

Authorization: superadmin

Attributes	Type	Authorization	Description
type required	string		The log type
message required	string		The log message

POST tests/misterroom

Test MisterRoom client

Authorization: superadmin

POST tests/eps/client

Test EPS client

Authorization: superadmin

POST tests/amadeus

Test Amadeus

Authorization: superadmin

POST tests/amadeus/hotel-descriptive-info

Test Amadeus hotel descriptive info

Authorization: superadmin

Attributes	Type	Authorization	Description
hotel_code required	string		The hotel code

POST tests/amadeus/hotel-availability

Test Amadeus hotel availability info

Authorization: superadmin

Attributes	Type	Authorization	Description
hotel_code required	string		The hotel code

POST tests/amadeus/hotel-corporate-availability

Test Amadeus corporate rates availability

Authorization: superadmin

POST tests/notifications

Test notifications

Authorization: superadmin

POST tests/new_notifications

Test notifications

Authorization:

POST tests/monthly-invoice-report

Send monthly invoice report email

Authorization: superadmin

Attributes	Type	Description
id required	string	The invoice report id
email required	string	The destinatary email
locale required	string	The locale for the email

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET tests/providerSettings

test provider settings

Authorization:

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET tests/entitiesSettings

test entities settings

Authorization:

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST tests/batch-remove-invoices

Send monthly invoice report email

Authorization: superadmin

Attributes	Type	Authorization	Description
number_from required	number		The invoice number from
number_to required	number		The invoice number to

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET train-bookings/drafts

List partial train bookings that are still in draft status.

Authorization:

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
sort optional	string	The sort modality
stats optional	boolean	When true, include the total number of matching drafts.
locale required	string	The locale for the language of the results contents.
id optional	string	Filter train bookings by id
code optional	string	Filter train bookings by code

GET train-bookings

Get the full train bookings list.

Authorization: superadmin

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
sort optional	string	The sort modality
locale required	string	The locale for the language of the results contents.
plan_id optional	string	Filter train bookings by plan id.
has_extra_services optional	boolean	Filter train bookings by extra services.
extra_services optional	array	Filter hotel bookings by extra service type.
id optional	string	Filter train bookings by id
creator_id optional	string	Filter train bookings by creator id
supervisor_id optional	string	Filter train bookings by supervisor id
billing_address_id optional	string	Filter train bookings by billing address id
invoice_profile_id optional	string	Filter train bookings by invoice profile id
code optional	string	Filter train bookings by code
status optional	string	Filter by booking status, one or more separated by commas. Values: draft, created, approving, approved, rejected, initialized, discarded, expired, processing, voided, processed, cancelling, cancelled, trashed.
created_from optional	string	Filter train bookings by creation from
created_to optional	string	Filter train bookings by creation to
updated_from optional	string	Filter train bookings by update from
updated_to optional	string	Filter train bookings by update to
cancelled_from optional	string	Filter train bookings by cancellation from
cancelled_to optional	string	Filter train bookings by cancellation to
departure_station_id optional	string	Filter train bookings by departure station
arrival_station_id optional	string	Filter train bookings by arrival station
train_carriers optional	string	Filter train bookings that contains at least one train carrier. Format should be all ids separated by ,
departure_date_from optional	string	Filter train bookings by departure from
departure_date_to optional	string	Filter train bookings by departure to
traveller_ids optional	string	Filter train bookings by passengers
needs_approval optional	boolean	Filter train bookings by needs approval
is_policy_respected optional	boolean	Filter train bookings by policy respected
total_amount optional	float	Filter train bookings by total amount
invoice_ids optional	string	Filter train bookings by invoice_id
invoicing_status optional	string	Filter by invoicing status, one or more separated by commas. Values: not_invoiced, partly_invoiced, invoiced.
is_personal optional	boolean	Filter train bookings by is personal
license_fee optional	integer	Filter train bookings by license fee
client_classification optional	string	Filter train bookings by client classification.
client_type optional	string	Filter train bookings by client type.
merchant optional	string	Filter train bookings by merchant
vendor optional	string	Filter train bookings by vendor name
supplier_code optional	string	Filter train bookings by supplier_code
approver_id optional	string	Filter train bookings by approver_id.
is_vat_recovery_eligible optional	boolean	Filter train bookings by is_vat_recovery_eligible.
currency optional	string	Filter flight bookings by currency
account_id optional	string	Filter train bookings by account_id
account_ids optional	array	Filter train bookings by account_ids
exclude_account_ids optional	array	Filter train bookings by exclude account_ids
is_archived optional	boolean	Filter train bookings by is_archived
provider_code optional	string	Filter train bookings by provider_code
provider_key optional	string	Filter train bookings by provider key
bizzyflex_statuses optional	string	Filter flight bookings by bizzyflex status
payment_method optional	string	Filter train bookings by payment method
custom_fields optional	string	Custom fields
is_manual optional	boolean	Filter train bookings by is manual
is_gtm optional	boolean	Filter train bookings by gtm reservaton
automatic_invoice optional	boolean	Filter train bookings if auto invoice is active or not
version optional	number	Filter train bookings by version (1, 1.5 or 2)
payment_status optional	string	Filter train bookings by payment status (not_paid, partly_paid or paid)
is_regional optional	boolean	Filter for regional train (italy)

GET train-bookings/my-user

Get the full train bookings list of the session user.

Authorization: member admin superadmin

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
sort optional	string	The sort modality
locale required	string	The locale for the language of the results contents.
plan_id optional	string	Filter train bookings by plan id.
has_extra_services optional	boolean	Filter train bookings by extra services.
extra_services optional	array	Filter hotel bookings by extra service type.
id optional	string	Filter train bookings by id
creator_id optional	string	Filter train bookings by creator id
supervisor_id optional	string	Filter train bookings by supervisor id
billing_address_id optional	string	Filter train bookings by billing address id
invoice_profile_id optional	string	Filter train bookings by invoice profile id
code optional	string	Filter train bookings by code
status optional	string	Filter by booking status, one or more separated by commas. Values: draft, created, approving, approved, rejected, initialized, discarded, expired, processing, voided, processed, cancelling, cancelled, trashed.
created_from optional	string	Filter train bookings by creation from
created_to optional	string	Filter train bookings by creation to
updated_from optional	string	Filter train bookings by update from
updated_to optional	string	Filter train bookings by update to
cancelled_from optional	string	Filter train bookings by cancellation from
cancelled_to optional	string	Filter train bookings by cancellation to
departure_station_id optional	string	Filter train bookings by departure station
arrival_station_id optional	string	Filter train bookings by arrival station
train_carriers optional	string	Filter train bookings that contains at least one train carrier. Format should be all ids separated by ,
departure_date_from optional	string	Filter train bookings by departure from
departure_date_to optional	string	Filter train bookings by departure to
traveller_ids optional	string	Filter train bookings by passengers
needs_approval optional	boolean	Filter train bookings by needs approval
is_policy_respected optional	boolean	Filter train bookings by policy respected
total_amount optional	float	Filter train bookings by total amount
invoice_ids optional	string	Filter train bookings by invoice_id
invoicing_status optional	string	Filter by invoicing status, one or more separated by commas. Values: not_invoiced, partly_invoiced, invoiced.
is_personal optional	boolean	Filter train bookings by is personal
license_fee optional	integer	Filter train bookings by license fee
client_classification optional	string	Filter train bookings by client classification.
client_type optional	string	Filter train bookings by client type.
merchant optional	string	Filter train bookings by merchant
vendor optional	string	Filter train bookings by vendor name
supplier_code optional	string	Filter train bookings by supplier_code
approver_id optional	string	Filter train bookings by approver_id.
is_vat_recovery_eligible optional	boolean	Filter train bookings by is_vat_recovery_eligible.
currency optional	string	Filter flight bookings by currency

GET train-bookings/my-account

Get the full train bookings list of an account.

Authorization:

Attributes	Type	Authorization	Description
limit optional	integer		Number of results to return
offset optional	integer		Index of the result to start to return results
sort optional	string		The sort modality
locale required	string		The locale for the language of the results contents.
plan_id optional	string		Filter train bookings by plan id.
has_extra_services optional	boolean		Filter train bookings by extra services.
extra_services optional	array		Filter hotel bookings by extra service type.
id optional	string		Filter train bookings by id
creator_id optional	string		Filter train bookings by creator id
supervisor_id optional	string		Filter train bookings by supervisor id
billing_address_id optional	string		Filter train bookings by billing address id
invoice_profile_id optional	string		Filter train bookings by invoice profile id
code optional	string		Filter train bookings by code
status optional	string		Filter by booking status, one or more separated by commas. Values: draft, created, approving, approved, rejected, initialized, discarded, expired, processing, voided, processed, cancelling, cancelled, trashed.
created_from optional	string		Filter train bookings by creation from
created_to optional	string		Filter train bookings by creation to
updated_from optional	string		Filter train bookings by update from
updated_to optional	string		Filter train bookings by update to
cancelled_from optional	string		Filter train bookings by cancellation from
cancelled_to optional	string		Filter train bookings by cancellation to
departure_station_id optional	string		Filter train bookings by departure station
arrival_station_id optional	string		Filter train bookings by arrival station
train_carriers optional	string		Filter train bookings that contains at least one train carrier. Format should be all ids separated by ,
departure_date_from optional	string		Filter train bookings by departure from
departure_date_to optional	string		Filter train bookings by departure to
traveller_ids optional	string		Filter train bookings by passengers
needs_approval optional	boolean		Filter train bookings by needs approval
is_policy_respected optional	boolean		Filter train bookings by policy respected
total_amount optional	float		Filter train bookings by total amount
invoice_ids optional	string		Filter train bookings by invoice_id
invoicing_status optional	string		Filter by invoicing status, one or more separated by commas. Values: not_invoiced, partly_invoiced, invoiced.
is_personal optional	boolean		Filter train bookings by is personal
license_fee optional	integer		Filter train bookings by license fee
client_classification optional	string		Filter train bookings by client classification.
client_type optional	string		Filter train bookings by client type.
merchant optional	string		Filter train bookings by merchant
vendor optional	string		Filter train bookings by vendor name
supplier_code optional	string		Filter train bookings by supplier_code
approver_id optional	string		Filter train bookings by approver_id.
is_vat_recovery_eligible optional	boolean		Filter train bookings by is_vat_recovery_eligible.
currency optional	string		Filter flight bookings by currency
account_id optional	string	superadmin	Filter train bookings by account_id

GET train-bookings/:train_booking_id

Get the train booking detail.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
locale required	string		The locale for the language of the results contents.

POST train-bookings/calculate-costs

Calculate costs of a train booking.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
account_id optional	string	superadmin	The account_id context
train_booking_id required if rate_id not filled	string		The train booking id.
outbound_fares_ids required if trainBooking_id not filled	array		An array with all outbound fares of the train selected by the customer.
inbound_fares_ids optional	array		An array with all inbound fares of the train selected by the customer.
locale required	string		The locale.
payment_method optional	string		The payment method.
billing_address_id optional	string		The billing address id
credit_card_id required when payment_method = cc	string		[Credit Card] the token of the selected credit card.
credit_card_owner required when payment_method = cc	string		[Credit Card] the owner of the selected credit card.
is_personal required	boolean		Indicates if the booking is personal.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.

POST train-bookings/generate-csv

Generate a csv file with the full train bookings list

Authorization: superadmin

Attributes	Type	Description
creator_id optional	string	Filter train bookings by creator id
supervisor_id optional	string	Filter train bookings by supervisor id
code optional	string	Filter train bookings by code
locale optional	string	The locale for the language of the results contents.
status optional	array	Filter train bookings by status
created_from optional	string	Filter train bookings by creation from
created_to optional	string	Filter train bookings by creation to
updated_from optional	string	Filter train bookings by update from
updated_to optional	string	Filter train bookings by update to
departure_station_id optional	string	Filter train bookings by departure station
arrival_station_id optional	string	Filter train bookings by arrival station
departure_date_from optional	string	Filter train bookings by departure date from
departure_date_to optional	string	Filter train bookings by departure date to
traveller_ids optional	array	Filter train bookings by guets
needs_approval optional	boolean	Filter train bookings by needs approval
invoice_ids optional	array	Filter train bookings by invoice_id
invoicing_status optional	array	Return train bookings based on its invoicing status
invoice_profile_id optional	string	Filter train bookings by invoice profile id
custom_fields optional	string	Custom fields
extra_services optional	array	Filter train bookings by extra service type.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.

POST train-bookings/my-account/generate-csv

Generate a csv file with the full train bookings list of an account

Authorization: admin superadmin

Attributes	Type	Authorization	Description
creator_id optional	string		Filter train bookings by creator id
supervisor_id optional	string		Filter train bookings by supervisor id
code optional	string		Filter train bookings by code
locale optional	string		The locale for the language of the results contents.
status optional	array		Filter train bookings by status
created_from optional	string		Filter train bookings by creation from
created_to optional	string		Filter train bookings by creation to
updated_from optional	string		Filter train bookings by update from
updated_to optional	string		Filter train bookings by update to
departure_station_id optional	string		Filter train bookings by departure station
arrival_station_id optional	string		Filter train bookings by arrival station
departure_date_from optional	string		Filter train bookings by departure date from
departure_date_to optional	string		Filter train bookings by departure date to
traveller_ids optional	array		Filter train bookings by guets
needs_approval optional	boolean		Filter train bookings by needs approval
invoice_ids optional	array		Filter train bookings by invoice_id
invoicing_status optional	array		Return train bookings based on its invoicing status
invoice_profile_id optional	string		Filter train bookings by invoice profile id
custom_fields optional	string		Custom fields
extra_services optional	array		Filter train bookings by extra service type.
account_id optional	string	superadmin	Filter train bookings by account_id
include_deleted_custom_fields optional	boolean		Flag to include deleted Custom Fields

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.

POST train-bookings/my-user/generate-csv

Generate a csv file with the full train bookings list of an user

Authorization: member admin superadmin

Attributes	Type	Description
creator_id optional	string	Filter train bookings by creator id
supervisor_id optional	string	Filter train bookings by supervisor id
code optional	string	Filter train bookings by code
locale optional	string	The locale for the language of the results contents.
status optional	array	Filter train bookings by status
created_from optional	string	Filter train bookings by creation from
created_to optional	string	Filter train bookings by creation to
updated_from optional	string	Filter train bookings by update from
updated_to optional	string	Filter train bookings by update to
departure_station_id optional	string	Filter train bookings by departure station
arrival_station_id optional	string	Filter train bookings by arrival station
departure_date_from optional	string	Filter train bookings by departure date from
departure_date_to optional	string	Filter train bookings by departure date to
traveller_ids optional	array	Filter train bookings by guets
needs_approval optional	boolean	Filter train bookings by needs approval
invoice_ids optional	array	Filter train bookings by invoice_id
invoicing_status optional	array	Return train bookings based on its invoicing status
invoice_profile_id optional	string	Filter train bookings by invoice profile id
custom_fields optional	string	Custom fields
extra_services optional	array	Filter train bookings by extra service type.
is_personal optional	boolean	Filter hotel bookings by is_personal

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.

POST train-bookings/check

Check a trip

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
account_id optional	string	superadmin	The account_id context
outbound_fares required	array		An array of fares id for the outbound
inbound_fares optional	array		An array of fares id for the inbound

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.

POST train-bookings/prepare-booking

Check a trip

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
account_id optional	string	superadmin	The account_id context
fares required	array		An array of fares id

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.

POST train-bookings

Create a booking

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
account_id optional	string	superadmin	The account_id context
user_id optional	string	superadmin	The user_id (owner) of the context
fares_data_id optional	string		Fare id
holder_id optional	string		The id of the passenger selected by the customer as the booking holder.
passengers required	array		Array with all passengers ID.
phone optional	string		The phone number of the booking.
notes optional	string		The notes of the booking.
billing_address_id optional	string		The billing address id.
billing_address_project required	string		The project of the billing address.
invoice_profile_id optional	string		The invoice profile id.
payment.method required	string		The payment method.
payment.credit_card_id required when payment_method = cc	string		[Credit Card] the token of the selected credit card.
payment.credit_card_owner required when payment_method = cc	string		[Credit Card] the owner of the selected credit card.
bta_card_id required when payment_method = amex_bta	string		[Amex BTA] amex bta card id.
bta_card_account_id required when payment_method = amex_bta	string		[Amex BTA] the account id of the selected amex bta card.
bta_card_number required when payment_method = amex_bta	string		[Amex BTA] the number of the selected amex bta card.
hokodo_data required when payment_method = hokodo	object		[Hokodo] Object of Hokodo Data
is_personal required	boolean		Indicates if the booking is personal.
custom_fields optional	object		Object of custom fields

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
INSUFFICIENT_FOUNDS_CC	There not enough money to execute the operation you request on the credit card of the user.
LIMIT_EXCEEDED_CC	Unable to execute this operation, you have exceeded the maximum amount for your credit card.
CONTACT_TO_THE_BANK	Unable to execute this operation, please contact your bank for more info!
EXPIRED_CARD_CC	Your credit card looks like its already expired
COMPROMISED_CC	The credit card has been flagged as lost, stolen, or otherwise compromised.
CARDHOLDER_STOP_CC	The cardholder has requested their bank to stop all billing for this card.
SECURITY_VIOLATION_CC	The issuing bank detected a security violation and declined the transaction.
FRAUD_CC	The credit card has been flagged as fraud.
TEMPORARY_ISSUE_CC	Unable to execute this operation due to a temporary issue with the bank, try again!

PUT train-bookings/:train_booking_id

Update a train booking.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
status optional	string	superadmin	The train booking status.
outbound_fares optional	array		Object array with fare IDs and relative data to update them.
inbound_fares optional	array		Object array with fare IDs and relative data to update them.
holder_id optional	string		The holder id.
passengers optional	array		Array with all passengers ID.
phone optional	string		The emergency phone of the booking.
notes optional	string		The notes of the passenger.
billing_address_id optional	string		The billing address id.
invoice_profile_id optional	string		The invoice profile id.
is_vat_exempt optional	boolean	superadmin	Update booking vat exempt flag
has_declaration_of_intent optional	boolean	superadmin	Update booking declaration of intent flag
automatic_invoice optional	boolean	superadmin	Define if the booking will be automatically invoices
inner_transactions optional	array	superadmin	Update booking inner transactions
transaction_costs optional	number	superadmin	Update the transaction costs.
invoice_id optional	null\|string	superadmin	Update the booking invoice.
provider_code optional	string	superadmin	Update the booking provider code.
seat optional	object	superadmin	Update the seat number.
coach optional	object	superadmin	Update the coach number.
train_code optional	object	superadmin	Update the train code.
train_name optional	object	superadmin	Update the train name.
datetime optional	object	superadmin	Update the train departure / arrival datetime.
is_personal optional	boolean	superadmin	Update the booking is_personal.
is_archived optional	boolean	superadmin	Update the booking is_archived.
custom_fields optional	object		Object of custom fields
fare optional	object	superadmin	Fare object
fare_provider_price optional	number	superadmin	The provider price
fare_price optional	number	superadmin	The fare price
issuing_fee optional	number	superadmin	Update the fare issuing fee
provider_key optional	string	superadmin	Update the provider key of the booking. Must be one of the values returned by vertical_fare_sources for this vertical.
license_fee optional	number	superadmin	Update the licence fee.
is_gtm optional	boolean	superadmin	Define if the booking is a GTM booking
version optional	number	superadmin	Update the version of the booking.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
NOT_FOUND	The resource you are trying to get not exists.

POST train-bookings/:train_booking_id/files

Upload a file

Authorization: superadmin

Attributes	Type	Description
file required	file	The file to upload
fare_id required	string	The related fare id
fare_type required	string	The fare type, outbound or inbound.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.

DELETE train-bookings/:train_booking_id/files

Delete a file

Authorization: superadmin

Attributes	Type	Authorization	Description
fare_id required	string		The related fare id
fare_type required	string		The fare type, outbound or inbound.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.

POST train-bookings/:train_booking_id/approve

Approve the current booking

Authorization:

Attributes	Type	Authorization	Description
price_tolerance optional	number

Errors codes
BOOKING_NOT_VALID_STATUS	This booking is not in a valid status to execute the requested operation.

POST train-bookings/:train_booking_id/reject

Reject booking.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
message optional	string		Custom message to the booking creator.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
BOOKING_NOT_VALID_STATUS	This booking is not in a valid status to execute the requested operation.

POST train-bookings/:train_booking_id/void

Void train booking.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
message optional	string		Message to the booking creator if `notify` is true.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
BOOKING_NOT_VALID_STATUS	This booking is not in a valid status to execute the requested operation.

POST train-bookings/:train_booking_id/trash

Trash booking.

Authorization: member admin superadmin

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
BOOKING_NOT_VALID_STATUS	This booking is not in a valid status to execute the requested operation.

POST train-bookings/:train_booking_id/initialize

Initialize a train booking.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
outbound_fares required	array		An array of fares id for the outbound
inbound_fares optional	array		An array of fares id for the inbound

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
BOOKING_NOT_VALID_STATUS	This booking is not in a valid status to execute the requested operation.

POST train-bookings/:train_booking_id/process

Confirm train booking.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
transaction_id required	string		The transaction_id to use in order to process this booking, not required for payment method === `postpay`

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
BOOKING_NOT_VALID_STATUS	This booking is not in a valid status to execute the requested operation.
PAYMENT_TRANSACTION_REQUIRED	An active payment transaction is required before confirming this booking.

POST train-bookings/:train_booking_id/complete-process

Complete an train booking process.

Authorization: member admin superadmin

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST train-bookings/:train_booking_id/assign

Assign train booking to an admin

Authorization: superadmin

Errors codes
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
NOT_FOUND	The resource you are trying to get not exists.

POST train-bookings/:train_booking_id/transactions

Create a transaction.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
payment_method required	string		The payment method.
amount optional	float	superadmin	The amount of the transaction. If is not filled the transaction amount will be calculated automatically from the booking.
payment_data.token required when payment_method = cc	string		[Credit Card] the token of the selected credit card.
payment_data.payment_id required when payment_method = paypal	string		[PayPal] the paypal payment_id.
payment_data.payer_id required when payment_method = paypal	string		[PayPal] the paypal payer id.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
INSUFFICIENT_FOUNDS_CC	There not enough money to execute the operation you request on the credit card of the user.
LIMIT_EXCEEDED_CC	Unable to execute this operation, you have exceeded the maximum amount for your credit card.
CONTACT_TO_THE_BANK	Unable to execute this operation, please contact your bank for more info!
EXPIRED_CARD_CC	Your credit card looks like its already expired
COMPROMISED_CC	The credit card has been flagged as lost, stolen, or otherwise compromised.
CARDHOLDER_STOP_CC	The cardholder has requested their bank to stop all billing for this card.
SECURITY_VIOLATION_CC	The issuing bank detected a security violation and declined the transaction.
FRAUD_CC	The credit card has been flagged as fraud.
TEMPORARY_ISSUE_CC	Unable to execute this operation due to a temporary issue with the bank, try again!

PUT train-bookings/:train_booking_id/transactions/:transaction_id

Update a transaction.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
payer_id optional	string		[PayPal] payer_id

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST train-bookings/:train_booking_id/transactions/:transaction_id/void

Void a transaction.

Authorization: member admin superadmin

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST train-bookings/:train_booking_id/transactions/:transaction_id/capture

Capture a transaction.

Authorization: member admin superadmin

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST train-bookings/:train_booking_id/initialize-payment

Initialize a payment

Authorization: member admin superadmin

Attributes	Type	Description
payment_method required	string	The payment method.
credit_card_id required when payment_method = cc	string	[Credit Card] the token of the selected credit card.
credit_card_owner required when payment_method = cc	string	[Credit Card] the owner of the selected credit card.
paypal_payment_id required when payment_method = paypal	string	[PayPal] the paypal payment_id.
paypal_payer_id required when payment_method = paypal	string	[PayPal] the paypal payer id.
change_payment_method optional	boolean	Flag that indicates if the action is used to initialize a new payment method.
bta_card_id required when payment_method = amex_bta	string	[Amex BTA] amex bta card id.
bta_card_account_id required when payment_method = amex_bta	string	[Amex BTA] the account id of the selected amex bta card.
bta_card_number required when payment_method = amex_bta	string	[Amex BTA] the number of the selected amex bta card.
hokodo_data required when payment_method = hokodo	object	[Hokodo] Object of Hokodo Data

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
INSUFFICIENT_FOUNDS_CC	There not enough money to execute the operation you request on the credit card of the user.
LIMIT_EXCEEDED_CC	Unable to execute this operation, you have exceeded the maximum amount for your credit card.
CONTACT_TO_THE_BANK	Unable to execute this operation, please contact your bank for more info!
EXPIRED_CARD_CC	Your credit card looks like its already expired
COMPROMISED_CC	The credit card has been flagged as lost, stolen, or otherwise compromised.
CARDHOLDER_STOP_CC	The cardholder has requested their bank to stop all billing for this card.
SECURITY_VIOLATION_CC	The issuing bank detected a security violation and declined the transaction.
FRAUD_CC	The credit card has been flagged as fraud.
TEMPORARY_ISSUE_CC	Unable to execute this operation due to a temporary issue with the bank, try again!

POST train-bookings/:id/upload-attachments

Upload a list of files associated to a train booking.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
attachments optional	array		The files list
is_internal optional	null\|boolean		Specify if attachments are internal.

Errors codes
MAX_BYTES_EXCEEDED	You are trying to upload a file that exceed the maximum bytes allowed.
INVALID_FILE_FORMAT	You are trying to upload an invalid file type.

POST train-bookings/:id/delete-attachment

Delete an attachment file and remove it from a train booking.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
attachment_id optional	string		The attachment id

Errors codes
MAX_BYTES_EXCEEDED	You are trying to upload a file that exceed the maximum bytes allowed.
INVALID_FILE_FORMAT	You are trying to upload an invalid file type.

GET old/train-bookings/:id/operations

Returns a list of possible postbooking options on a booking

Authorization: member admin superadmin

POST train-bookings/:id/cancel

Executes a cancellation/refund operation

Authorization:

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST train-bookings/:id/solution/search

Search new solutions for a booking

Authorization: member admin superadmin

Attributes	Type	Description
type_change optional	string	Type of the change
account_id optional	string	Id of the account
country optional	string	Country of the search
itinerary optional	array	The itinerary of the search
locale optional	string	Locale of the search
passengers optional	object	Number of passengers
leg_ids optional	array	The list of leg ids

GET train-bookings/:id/solution/search/:solution_id

Poll the itinerary options of a post-booking change solutions search. solution_id is the solutions search session id created for this booking. Poll until status is completed or error. To read fare options for a chosen solution use the sibling route with the trailing fare_id.

Authorization: member admin superadmin

Attributes	Type	Description
account_id optional	string	Account of the booking. Required when the caller is a superadmin.
locale required	string	The locale for the language of the results contents.
limit optional	number	Number of results.
offset optional	number	Results left margin
sort optional	string	Define the sortings rules. Sortable fields: price
price optional	string	Filter by price range.
trip_departure_times optional	string	Filter by trips departure times. It accepts comma separated values in minutes

POST train-bookings/:id/solution/search/:solution_id/fare

Starts a search of fares for a solution

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
type_change optional	string		Type of the change
account_id optional	string	superadmin	Id of the account
locale optional	string		Locale of the search

GET train-bookings/:id/solution/search/:solution_id/:fare_id

Poll the fare options of a post-booking change fares search. fare_id is the fares search session id created for the solution chosen from the sibling solutions route; solution_id gives the solution context. Poll until status is completed or error.

Authorization: member admin superadmin

Attributes	Type	Description
account_id optional	string	Account of the booking. Required when the caller is a superadmin.
locale required	string	The locale for the language of the results contents.
limit optional	number	Number of results.
offset optional	number	Results left margin
sort optional	string	Define the sortings rules. Sortable fields: price.
price optional	string	Filter by price range.

POST train-bookings/:id/solution/search/:solution_id/:fare_id/confirm

Confirms the selection of a solution and a fare

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
change_operation optional	string		Transaction associated with the booking
expected_penalty optional	number		The expected penalty of the operation

POST train-bookings/:id/travellers_update

Executes a passenger update

Authorization: member admin superadmin

Attributes	Type	Description
travellers optional	array	Travellers of the booking
transaction_reference optional	string	Reference of the transactiona associated to the booking
expected_penalty optional	number	The expected penalty of the operation

POST train-bookings/:train_booking_id/edit/price-changes

Adds new price change to a booking

Authorization:

Attributes	Type	Description
reference optional	string	Reference of price change
reference_id optional	string	The id of the reference
reference_type optional	string	Type of the reference on the price change
amount optional	number	The amount of the price change
date optional	string	The date when the price change occurs
reference_transaction optional	string	The id of the transaction
type optional	string	The type of the price change

POST train-bookings/:booking_id/edit/attachments

Update booking fare section adding the attachment info file

Authorization:

Attributes	Type	Authorization	Description
attachment required	file		The attachment of the train

GET train-bookings/:train_booking_id/edit/price-changes

Get booking price changes section

Authorization:

PUT train-bookings/:train_booking_id/edit/price-changes/:price_change_id

Updates a price change from a booking

Authorization:

Attributes	Type	Description
reference optional	string	Reference of price change
reference_id optional	string	The id of the reference
reference_type optional	string	Type of the reference on the price change
amount optional	number	The amount of the price change
date optional	string	The date when the price change occurs
reference_transaction optional	string	The id of the transaction
type optional	string	The type of the price change

DELETE train-bookings/:train_booking_id/edit/price-changes/:price_change_id

Delete a price change from a booking

Authorization:

POST train-bookings/:train_booking_id/edit/price-changes/confirm

Confirm all price changes that are in draft status

Authorization:

POST train-bookings/:train_booking_id/edit/price-changes/discard

Discard all price changes that are in draft status

Authorization:

POST trains/solutions/searches

Create a train search session

Authorization:

Attributes	Type	Authorization	Description
passengers required	array		Array with all passengers informations.
locale required	string		The locale for the language of the results contents.
account_id optional	string	superadmin	The account_id context

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
INVALID_DEPARTURE_DATE	The departure date is invalid. Be sure the departure date and time are after the current timing.
INVALID_ARRIVAL_DATE	The arrival date is invalid. Be sure the arrival date and time are after the departure timing.

GET trains/solutions/searches/:search_id

Poll the itinerary options of a train solutions search session. Poll until status is completed or error. Results are sorted by departure datetime.

Authorization:

Attributes	Type	Description
locale required	string	The locale for the language of the results contents.
limit optional	number	Number of results.
offset optional	number	Results left margin
sort optional	string	Define the sortings rules. Sortable fields: price
train_carriers optional	string	Filter by train_carriers ids
price optional	string	Filter by price range.
trip_departure_times optional	string	Filter by trips departure times. It accepts comma separated values in minutes

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST trains/fares/searches

Create a train search fares session

Authorization:

Attributes	Type	Authorization	Description
account_id Required only for superadmins	string	superadmin	The account_id context
search_solution_id required	string		A search solution id

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET trains/fares/searches/:search_id

Poll the fare options of a train fares search session created for a selected solution. Poll until status is completed or error.

Authorization:

Attributes	Type	Description
locale required	string	The locale for the language of the results contents.
limit optional	number	Number of results.
offset optional	number	Results left margin
sort optional	string	Define the sortings rules. Sortable fields: price.
price optional	string	Filter by price range.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST trains/fares

Create a fare

Authorization:

Attributes	Type	Description
search_fare_ids required	array	A search fare ids.
discount_codes optional	array	objects of discount codes.
locale required	string	The locale for the language of the results contents.
leg_ids optional	array	The list of leg ids

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET trains/fares/:fare_id

Get a built train fare with its trips, prices, extra services and the passenger information required to book it.

Authorization:

Attributes	Type	Authorization	Description
locale required	string		The locale for the language of the results contents.
account_id optional	string		Account context of the fare. Required when the caller is a superadmin.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET trains/fares/:fare_id/seatmap

Get the seatmap of a train fare. The seatmap is requested live from the rail provider, so the call can be slow and the layout structure varies by provider; legs without a seatmap return an empty seat_map array.

Authorization:

Attributes	Type	Authorization	Description
locale required	string		The locale for the language of the results contents.
account_id optional	string		Account context of the fare. Required when the caller is a superadmin.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET trains/search/:sid

Poll a legacy-engine train search session by its sid. Poll until status is completed or error. Prefer the newer /v1/trains/solutions/searches flow for new integrations.

Authorization: member admin app superadmin

Attributes	Type	Authorization	Description
account_id optional	string	superadmin	The account_id context
locale required	string		The locale for the language of the results contents.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST trains/search

Create a trains search session

Authorization: member admin app superadmin

Attributes	Type	Authorization	Description
departure_station required	string		Departure station id.
arrival_station required	string		Arrival station id.
departure_date required	string		Departure date.
departure_time required	string		Departure time.
return_date optional	string		Return date.
return_time optional	string		Return time.
passengers required	array		An array containing every passenger age.
locale required	string		The locale for the language of the results contents.
account_id optional	string	superadmin	The account_id context

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
INVALID_DEPARTURE_DATE	The departure date is invalid. Be sure the departure date and time are after the current timing.
INVALID_PASSENGER_TYPE	Invalid passenger type.
INVALID_PASSENGER_AGE	Invalid passenger type.

GET travel-documents

List travel documents visible to the caller, optionally scoped by account or user.

Authorization:

Attributes	Type	Authorization	Description
limit optional	integer		Number of results to return
offset optional	integer		Index of the result to start to return results
stats optional	boolean		When true, include the total number of matching travel documents.
account_id optional	string	superadmin	Filter by account identifier. Available to superadmins.
user_id optional	string	admin,superadmin	Filter by user identifier. Available to admins and superadmins.
type optional	string		Filter by travel-document type.

GET travel-documents/:travel_document_id

Get the travel document detail.

Authorization: member admin superadmin

PUT travel-documents/:travel_document_id

Update an user travel document.

Authorization:

Attributes	Type	Description
type optional	string	The travel document type.
number optional	string	The travel document number.
expiration optional	string	The travel document expiration date.
country optional	string	The travel document country of emission.
issue_city optional	string	The travel document city of emission.
issue_date optional	string	The travel document date of emission.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST travel-documents/:travel_document_id/document-image

Upload multiple images for a travel document.

Authorization:

Attributes	Type	Authorization	Description
document_image optional	array		Images of the travel document

Errors codes
MAX_BYTES_EXCEEDED	You are trying to upload a file that exceed the maximum bytes allowed.
INVALID_FILE_FORMAT	You are trying to upload an invalid file type.

DELETE travel-documents/:travel_document_id

Remove an user travel document.

Authorization:

GET tsa-ktn

Get all TSA Know Traveller Number from a user_ids list.

Authorization:

Attributes	Type	Description
limit optional	integer	Number of results to return
offset optional	integer	Index of the result to start to return results
users_ids optional	string	Filter TSA Know Traveller Numbers by user id

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET tsa-ktn/:tsa_know_travelller_numbers_id

Get Known Traveler Number details. The path parameter keeps the legacy triple-l spelling.

Authorization:

POST tsa-ktn

Create new TSA Know Traveller Number.

Authorization:

Attributes	Type	Description
account_id required	string	The TSA Know Traveller Number owner account id
user_id required	string	The TSA Know Traveller Number user id
known_traveler_number optional	string	The TSA Know Traveller Number
expiration_date optional	string	The TSA Know Traveller Number expiration date

Errors codes
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
VALIDATION_FAILED	Validation of the parameters failed.

PUT tsa-ktn/:tsa_know_travelller_number_id

Update a TSA Know Traveller Number.

Authorization:

Attributes	Type	Authorization	Description
known_traveler_number optional	string		The TSA Know Traveller Number
expiration_date optional	string		The TSA Know Traveller Number expiration date

Errors codes
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
VALIDATION_FAILED	Validation of the parameters failed.

DELETE tsa-ktn/:tsa_know_travelller_number_id

Delete a TSA Know Traveller Number.

Authorization:

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET users/available-payment-methods

Get payment methods available to the session user for an account and optional booking context.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
account_id optional	string	superadmin	Account context. A superadmin service user must provide this value.
is_personal optional	boolean	member,admin,superadmin	Returns only user's personal cards
car_fare_id optional	string		Car fare context used to derive the merchant.
car_booking_id optional	string		Car booking context used to derive the merchant.
hotel_fare_id optional	string		Hotel fare context used to derive the merchant.
hotel_booking_id optional	string		Hotel booking context used to derive the merchant.
flight_fare_id optional	string		Flight fare context used to derive the merchant.
flight_booking_id optional	string		Flight booking context used to derive the merchant.
train_fare_id optional	string		Train fare context used to derive the merchant.
train_booking_id optional	string		Train booking context used to derive the merchant.
merchant optional	string		Legacy merchant hint. The current implementation derives the merchant from a booking or fare context when one is supplied.

POST users/invite-multiple

Invite multiple users to register.

Authorization:

Attributes	Type	Description
user_ids optional	array	Array of user IDs to invite.
emails optional	array	Optional array of emails (must match user_ids length if provided).
invite_all optional	boolean	If true, invites all eligible users. Ignores user_ids/emails.
dry_run optional	boolean	If true with invite_all, returns preview stats without sending invites.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
NOT_FOUND	The resource you are trying to get not exists.
NOT_ACTIVE	The resource you are trying to use is not active.
EMAIL_ALREADY_USED	The email you are trying to use is already in use.

POST users/:user_id/invite

Invite an user to register.

Authorization:

Attributes	Type	Authorization	Description
email optional	string		The email of the user to invite.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
AUTHORIZATION_FAILED	You are not authorized to perform this operation or access this information.
NOT_FOUND	The resource you are trying to get not exists.
NOT_ACTIVE	The resource you are trying to use is not active.
EMAIL_ALREADY_USED	The email you are trying to use is already in use.

PUT users/:user_id

Update an user.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
first_name optional	string		The first name of the user.
last_name optional	string		The last name of the user.
full_name optional	string		The full name of the user.
traveller_first_name optional	string		The traveller first name of the user.
traveller_last_name optional	string		The traveller last name of the user.
role_id optional	string		The user role.
group_id optional	null\|string		The user group id.
phone optional	string		The phone of the user.
employee_number optional	null\|string		The employee registration number of the user.
position optional	null\|string		The position of the user.
country_of_residence optional	string		The country where the user currently resides.
department optional	string		The department or team the user belongs to.
line_manager_id optional	null\|string		The line manager of the user (another platform user in the same account or a superadmin). Pass null to clear.
birthday optional	string		The birthday of the user.
gender optional	string		The gender of the user.
nationality optional	string		The nationality of the user.
email optional	string		The email of the user.
contact_email optional	string		The contact email of the user.
default_locale optional	string		The default locale of the user.
default_format_date optional	object		The format date settings for user display dates on platform.
default_currency optional	string		The default currency of the user.
default_bill_address_id optional	null\|string		The default bill address of the user.
default_invoice_profile_id optional	null\|string		The default invoice profile of the user.
password optional	string	superadmin	The user password.
internal_notifications optional	array	superadmin	The superadmin internal notification configs.
disabled_notifications optional	array		Notifications configuration for the user ( opt-out )
onboarding_tasks optional	object		The onboarding tasks of the user.
notifications_transports_config optional	object	superadmin	The superadmin internal notification transports configs.
cpa_permissions optional	array	superadmin	The array of permissions for the CPA.
notes.customer_service optional	string	superadmin	Some account customer service notes.
notes.commercial optional	string	superadmin	Some account commercial notes.
notes.general optional	string	superadmin	Some account general notes.
is_temporary optional	boolean	superadmin	Is temporary flag
user_ref_ext optional	string	superadmin	External reference
tax_code optional	string		Tax code of the user

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

PATCH users/:user_id/segmentation

Update user segmentation data. This endpoint merges the provided segmentation fields with existing ones.

Authorization: member admin superadmin

Attributes	Type	Authorization	Description
segmentation optional	object		Partial segmentation data to merge. Example: { "department": "engineering" } or { "seniority_level": "mid", "region": "emea" }
user_segmentation_completed optional	boolean		Flag to mark segmentation process as completed.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

GET users/:user_id/segmentation

Get user segmentation data.

Authorization: member admin superadmin

GET users/segmentation-fields

Get available segmentation fields and their possible values.

Authorization: member admin superadmin

GET users/:user_id/travel-documents

Get the user travel documents list.

Authorization: member admin superadmin

GET users/:user_id/tsa-ktn

Get the user TSA Know Traveller Numbers list.

Authorization: member admin superadmin

POST ext/users/:user_id/cards

[Called by Proxy] Create an user card, with VGS Vault

Authorization:

Attributes	Type	Description
name required	string	The name of the card.
cvv required	string	CVV of the card.
expiration_date required	object	Expiration of the card
holder_name required	string	Holder name date of the card
number required	string	Number of the card
default_bill_address_id optional	null\|string	The id of the adress id.
default_invoice_profile_id optional	null\|string	The invoice profile id.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST ext/users/:user_id/cards-3ds

[Called by Proxy] tokenize a card

Authorization:

Attributes	Type	Description
cvv required	string	CVV of the card.
expiration_date required	object	Expiration of the card
holder_name required	string	Holder name date of the card
number required	string	Number of the card

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST users/:user_id/cards/3ds-lookup

Prepares a 3DSecure lookup for a card

Authorization:

Attributes	Type	Authorization	Description
nonce required	string		The card nonce
df_reference_id required	string		The device fingerprint reference id

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST users/:user_id/cards/verify

Process verification of a card

Authorization:

Attributes	Type	Description
nonce required	string	The card nonce
amount required	string	Amount of the payment for verification
card_name required	string	Name of the card
number required	string	Number of the card
month required	string	Month of the card
year required	string	Year of the card
default_bill_address_id optional	null\|string	The id of the address id.
default_invoice_profile_id optional	null\|string	The invoice profile id.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST users/:user_id/cards/create-payment-method-nonce

Create a payment method nonce from a card token

Authorization:

Attributes	Type	Authorization	Description
token required	string		The card token

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST users/:user_id/cards/verify-payment-method-nonce

Process verification of a payment method nonce

Authorization:

Attributes	Type	Description
card_id required	string	The card id
nonce required	string	The payment method nonce
amount required	string	Amount of the payment for verification

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST users/:user_id/cards

Create an user card.

Authorization:

Attributes	Type	Description
nonce required	string	The card nonce.
name required	string	The name of the card.
default_bill_address_id optional	null\|string	The id of the adress id.
default_invoice_profile_id optional	null\|string	The invoice profile id.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

POST ext/users/:user_id/cards/:card_id/vaults

[Called by Proxy] Add Vaults of an user card.

Authorization:

Attributes	Type	Description
cvv optional	string	CVV of the card.
expiration_date optional	object	Expiration of the card
holder_name optional	string	Holder name date of the card
number optional	string	Number of the card

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.
INVALID_CARD_CC	Invalid credit card.

PUT users/:user_id/cards/:card_id

Edit an user card.

Authorization:

Attributes	Type	Description
name optional	string	The name of the card.
default_bill_address_id optional	null\|string	The id of the adress id.
default_invoice_profile_id optional	null\|string	The invoice profile id.

Errors codes
VALIDATION_FAILED	Validation of the parameters failed.

Accounts 7 requests

Accounts Credit Cards 8 requests

Accounts Groups 6 requests

Airlines 1 requests

Approval Workflows 5 requests

Booking Snapshots 4 requests

Car bookings 31 requests

Car bookings Edit 15 requests

Cars 6 requests

Company 17 requests

Custom Fields 7 requests

Extra Services 15 requests

Flight bookings 27 requests

Flight bookings Edit 6 requests

General 14 requests

Hotel bookings 23 requests

Hotel bookings Edit 6 requests

Hotel custom rates 16 requests

Hotels 17 requests

Invoice Profiles 6 requests

Invoice Reports 8 requests

Invoices 15 requests

Licence Reports 11 requests

PaymentMethods 2 requests

RailCards 5 requests

RoomTypes 5 requests

Search 3 requests

Search Presets 7 requests

General 23 requests

Train bookings 38 requests

Train bookings Edit 7 requests

Trains 9 requests

Travel Documents 5 requests

TSAKnowTravellerNumbers 5 requests

Users 9 requests

User Cards 9 requests