> For the complete documentation index, see [llms.txt](https://docs.one-cp.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.one-cp.com/integration-and-development/models.md).

# Models

## The CorporateCheckout object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"CorporateCheckout":{"type":"object","required":["currency","items","title"],"properties":{"currency":{"type":"string","description":"Currency of the CorporateCheckout"},"items":{"type":"array","description":"List of items included in the CorporateCheckout.","items":{"$ref":"#/components/schemas/Item"},"minItems":1},"refIDs":{"type":"object","properties":{},"additionalProperties":true,"description":"External identifiers associated with the CorporateCheckout."},"title":{"type":"string","description":"Title of the CorporateCheckout"},"attachments":{"type":"array","description":"List of attachments associated with the CorporateCheckout","items":{"$ref":"#/components/schemas/Attachment"}},"note":{"description":"Additional notes about the CorporateCheckout. (Internal note only - not visible to the customer)","type":"string"},"email":{"description":"Email content, Subject and Recipient list which will be sent to the user","$ref":"#/components/schemas/CheckoutEmail"},"restrictedMethods":{"type":"string","description":"Payment methods that the provider has deactivated","enum":["ECA","VIS","AMX","CUP","DIN","DIS","JCB","EPS","DEA","KLN","MBP","PAP","BCN","P24"]}},"additionalProperties":false},"Item":{"type":"object","required":["name","quantity","price","category"],"properties":{"name":{"type":"string","description":"Name of the item"},"category":{"type":"string","description":"Category of the item","enum":["FLIGHT","RENTAL_CAR","TAXI_SHUTTLE","ACCOMMODATION","EVENT","SERVICE","PUBLIC_TRANSPORTATION","MICRO_MOBILITY","PARKING","FUEL","FEE","F_AND_B","OTHER","RAIL","CONFERENCE","TRAVEL_AGENCY","OTHER_TRAVEL","ADVERTISING","MARKET_RESEARCH","CONFERENCE_NOT_TRAVEL","SUBSCRIPTION","LAP_SUPPLY","CONSULTING","HARDWARE","SOFTWARE_AND_IT","SOFTWARE_SUBSCRIPTION","TELECOM","OFFICE_SUPPLY","OFFICE_EQUIPMENT_AND_FURNITURE","RENT_AND_LEASE","UTILITIES","INSURANCE","LEGAL_FEE","ADMINISTRATIVE_SERVICE","RETAIL"]},"quantity":{"type":"object","$ref":"#/components/schemas/ItemQuantity"},"price":{"type":"number","description":"Price of the item depending on the quantity (amount and unit) provided. If FLAT_FEE then price is the total price for the item otherwise price is the price per unit","minimum":0},"description":{"type":"string","description":"Description of the item"},"order":{"type":"number","description":"The order of the item."},"stockId":{"type":"string","description":"External Stock identifier for the item."},"totalTax":{"type":"number","description":"Total tax amount in the currency specified in the CorporateCheckout. This value will be calculated based on the taxes if not provided","minimum":0},"total":{"type":"number","description":"Total amount of the items, price + totalTax. This value will be calculated based on the price and taxes if not provided","minimum":0},"taxes":{"type":"array","description":"List of taxes associated with the item","items":{"$ref":"#/components/schemas/ItemTax"}},"co2":{"type":"number","description":"Carbon dioxide pollution in kg","minimum":0},"cancellationPolicy":{"oneOf":[{"$ref":"#/components/schemas/CancellationPolicy"},{"type":"string","description":"String representation of cancellation policy"}]}},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/Flight"},{"$ref":"#/components/schemas/Accommodation"},{"$ref":"#/components/schemas/Rail"},{"$ref":"#/components/schemas/RentalCar"},{"$ref":"#/components/schemas/TaxiShuttle"},{"$ref":"#/components/schemas/Parking"},{"$ref":"#/components/schemas/DatePeriodItem"}]},"ItemQuantity":{"type":"object","required":["amount"],"properties":{"amount":{"type":"number","description":"Amount of the quantity","minimum":1},"unit":{"type":"string","description":"Unit of the quantity. If FLAT_FEE then price is the total price for the amount without tax, otherwise price is the price per unit","enum":["FLAT_FEE","PER_HOUR","PER_DAY","PER_NIGHT","PER_WEEK","PER_MONTH","PER_YEAR","PER_PERSON"],"default":"FLAT_FEE"}},"additionalProperties":false},"ItemTax":{"type":"object","required":["value","applyTo"],"properties":{"type":{"type":"string","description":"Type of the tax","enum":["NET_PRICE","VAT","BED_TAX","CITY_HOTEL_FEES","COUNTRY_TAX","CITY_TAX","ENERGY_CHARGE","FEDERAL_TAX","GST","INCLUSION","LODGING_TAX","MAINTENANCE_FEE","OCCUPANCY_TAX","PACKAGE_RATE_FEE","ROOM_TAX","RESORT_FEES","SALES_TAX","STATE_PROVINCE_TAX","SURCHARGE","SERVICE_CHARGE","OTHER_TAX","TOURISM_TAX"],"default":"VAT"},"value":{"type":"number","description":"Value of the tax based on the unit used (if the unit provided is AMOUNT, we expect the value to be based on the currency used in the CorporateCheckout)","minimum":0},"unit":{"type":"string","description":"Unit of the tax value (AMOUNT or PERCENT)","enum":["AMOUNT","PERCENT"],"default":"PERCENT"},"basis":{"type":"string","description":"Basis of the tax value (FLAT_FEE or PER_QUANTITY)","enum":["FLAT_FEE","PER_QUANTITY"],"default":"PER_QUANTITY"},"applyTo":{"type":"string","description":"Indicates what base value the tax will be applied to. Some taxes are accumulated on the total price of the item plus other taxes","enum":["NET_PRICE","VAT","BED_TAX","CITY_HOTEL_FEES","COUNTRY_TAX","CITY_TAX","ENERGY_CHARGE","FEDERAL_TAX","GST","INCLUSION","LODGING_TAX","MAINTENANCE_FEE","OCCUPANCY_TAX","PACKAGE_RATE_FEE","ROOM_TAX","RESORT_FEES","SALES_TAX","STATE_PROVINCE_TAX","SURCHARGE","SERVICE_CHARGE","OTHER_TAX","TOURISM_TAX"],"default":"NET_PRICE"}},"additionalProperties":false},"CancellationPolicy":{"type":"object","required":["reference","penalties"],"properties":{"reference":{"type":"string","description":"Reference date for penalty calculation","enum":["PAYMENT_DATE","START_PERIOD"]},"penalties":{"type":"array","description":"List of penalties applicable to the item","items":{"$ref":"#/components/schemas/BasePenalty"},"minItems":1},"description":{"type":"string","description":"Description of the cancellation policy"}},"additionalProperties":false},"BasePenalty":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["OFFSET_PENALTY","DATE_PENALTY"]},"value":{"$ref":"#/components/schemas/CancellationPenaltyValue"}},"oneOf":[{"properties":{"type":{"enum":["OFFSET_PENALTY"]},"offset":{"$ref":"#/components/schemas/CancellationPenaltyOffset"}},"required":["offset"]},{"properties":{"type":{"enum":["DATE_PENALTY"]},"until":{"type":"string","format":"date-time","description":"The date after which the penalty will be applied"}},"required":["until"]}],"additionalProperties":false},"CancellationPenaltyValue":{"type":"object","required":["amount","unit"],"properties":{"amount":{"type":"number","description":"Penalty amount","minimum":0},"unit":{"type":"string","description":"Penalty value unit","enum":["FIXED_AMOUNT","PERCENTAGE"]}},"additionalProperties":false},"CancellationPenaltyOffset":{"type":"object","required":["amount","unit"],"properties":{"amount":{"type":"number","description":"Offset amount","minimum":0},"unit":{"type":"string","description":"Offset time unit","enum":["DAYS","HOURS","MONTHS"]}},"additionalProperties":false},"Flight":{"type":"object","required":["category","period","departure","destination","airline","serviceClass"],"properties":{"category":{"type":"string","enum":["FLIGHT"]},"period":{"$ref":"#/components/schemas/Period"},"departure":{"type":"string","description":"Departure airport - 3-letter IATA airport code"},"destination":{"type":"string","description":"Destination airport - 3-letter IATA airport code"},"airline":{"type":"string","description":"Airline - 3-letter ICAO or 2-letter IATA airline code"},"serviceClass":{"type":"string","enum":["FIRST_CLASS","BUSINESS_CLASS","ECONOMY_CLASS","OTHER"]},"flightNumber":{"type":"string","description":"Flight number"},"fareClass":{"type":"string","description":"Fare class code"}},"additionalProperties":false},"Period":{"type":"object","required":["start","end"],"properties":{"start":{"type":"string","format":"date-time","description":"Start date/time using ISO 8601 format"},"end":{"type":"string","format":"date-time","description":"End date/time using ISO 8601 format"}},"additionalProperties":false},"Accommodation":{"type":"object","required":["category","period","location","accommodationType"],"properties":{"category":{"type":"string","enum":["ACCOMMODATION"]},"period":{"$ref":"#/components/schemas/Period"},"locationName":{"type":"string","description":"Location name (property name)"},"location":{"$ref":"#/components/schemas/Location"},"roomType":{"type":"string","enum":["APARTMENT","QUADRUPLE","SUITE","TRIPLE","TWIN","DOUBLE","SINGLE","STUDIO","FAMILY","TWIN_DOUBLE","DORMITORY_ROOM","BED_IN_DORMITORY","BUNGALOW","CHALET","HOLIDAY_HOME","VILLA","MOBILE_HOME","TENT"]},"accommodationType":{"type":"string","enum":["RESORT","HOSTEL","HOTEL","INN","LODGE","MOTEL","LOVE_HOTEL","KP_BUSINESS_HOTEL","CAPSULE_HOTEL","APARTMENT","BED_BREAKFAST","CAMPING","CHALET","BOAT","FARM_STAY","TENTED","VILLA","GUEST_HOUSE","APART_HOTEL","RIAD","RYOKAN","HOME_STAY","HOLIDAY_HOME","COUNTRY_HOUSE","HOLIDAY_PARK"]},"serviceClass":{"type":"string","enum":["FIRST_CLASS","BUSINESS_CLASS","ECONOMY_CLASS","OTHER"]}},"additionalProperties":false},"Location":{"type":"object","required":["city","country"],"properties":{"street":{"type":"string","description":"Street name"},"house":{"type":"string","description":"House number"},"zipCode":{"type":"string","description":"Postal code"},"city":{"type":"string","description":"City name"},"country":{"type":"string","description":"Country name"},"lat":{"type":"string","description":"Latitude of the location"},"lng":{"type":"string","description":"Longitude of the location"}},"additionalProperties":false},"Rail":{"type":"object","required":["category","period","departure","destination","serviceClass"],"properties":{"category":{"type":"string","enum":["RAIL"]},"period":{"$ref":"#/components/schemas/Period"},"departure":{"$ref":"#/components/schemas/Location"},"destination":{"$ref":"#/components/schemas/Location"},"serviceClass":{"type":"string","enum":["FIRST_CLASS","BUSINESS_CLASS","ECONOMY_CLASS","OTHER"]}},"additionalProperties":false},"RentalCar":{"type":"object","required":["category","period","pickUpLocation","dropOffLocation"],"properties":{"category":{"type":"string","enum":["RENTAL_CAR"]},"period":{"$ref":"#/components/schemas/Period"},"pickUpLocation":{"$ref":"#/components/schemas/Location"},"dropOffLocation":{"$ref":"#/components/schemas/Location"},"classificationCode":{"type":"string","description":"Vehicle classification code"}},"additionalProperties":false},"TaxiShuttle":{"type":"object","required":["category","period","pickUpLocation","dropOffLocation"],"properties":{"category":{"type":"string","enum":["TAXI_SHUTTLE"]},"period":{"$ref":"#/components/schemas/Period"},"pickUpLocation":{"$ref":"#/components/schemas/Location"},"dropOffLocation":{"$ref":"#/components/schemas/Location"}},"additionalProperties":false},"Parking":{"type":"object","required":["category","period","location"],"properties":{"category":{"type":"string","enum":["PARKING"]},"period":{"$ref":"#/components/schemas/Period"},"plateNumber":{"type":"string","description":"Plate number of the car"},"location":{"$ref":"#/components/schemas/Location"}}},"DatePeriodItem":{"type":"object","required":["category","period"],"properties":{"category":{"type":"string","enum":["OTHER_TRAVEL","TRAVEL_AGENCY","PUBLIC_TRANSPORTATION"]},"period":{"$ref":"#/components/schemas/Period"}},"additionalProperties":false},"Attachment":{"type":"object","required":["url","type"],"properties":{"url":{"type":"string","description":"URL to the file. (File size is limited to 10MB if uploaded to our system; otherwise, the URL must be publicly available and accessible at all times.)"},"type":{"type":"string","description":"Type of the attachment","enum":["INVOICE","PROPOSAL","CONTRACT","TERMS_AND_CONDITIONS","PICTURES","HEADER_IMAGE","OTHER"]}},"additionalProperties":false},"CheckoutEmail":{"type":"object","required":["subject","content","recipients"],"properties":{"subject":{"type":"string","description":"Subject of the email"},"content":{"type":"string","description":"Body of the email"},"recipients":{"type":"array","description":"List of recipients associated with the CorporateCheckout","items":{"type":"string","format":"email"},"minItems":1}},"additionalProperties":false}}}}
```

## The Attachment object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"Attachment":{"type":"object","required":["url","type"],"properties":{"url":{"type":"string","description":"URL to the file. (File size is limited to 10MB if uploaded to our system; otherwise, the URL must be publicly available and accessible at all times.)"},"type":{"type":"string","description":"Type of the attachment","enum":["INVOICE","PROPOSAL","CONTRACT","TERMS_AND_CONDITIONS","PICTURES","HEADER_IMAGE","OTHER"]}},"additionalProperties":false}}}}
```

## The CheckoutEmail object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"CheckoutEmail":{"type":"object","required":["subject","content","recipients"],"properties":{"subject":{"type":"string","description":"Subject of the email"},"content":{"type":"string","description":"Body of the email"},"recipients":{"type":"array","description":"List of recipients associated with the CorporateCheckout","items":{"type":"string","format":"email"},"minItems":1}},"additionalProperties":false}}}}
```

## The Item object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"Item":{"type":"object","required":["name","quantity","price","category"],"properties":{"name":{"type":"string","description":"Name of the item"},"category":{"type":"string","description":"Category of the item","enum":["FLIGHT","RENTAL_CAR","TAXI_SHUTTLE","ACCOMMODATION","EVENT","SERVICE","PUBLIC_TRANSPORTATION","MICRO_MOBILITY","PARKING","FUEL","FEE","F_AND_B","OTHER","RAIL","CONFERENCE","TRAVEL_AGENCY","OTHER_TRAVEL","ADVERTISING","MARKET_RESEARCH","CONFERENCE_NOT_TRAVEL","SUBSCRIPTION","LAP_SUPPLY","CONSULTING","HARDWARE","SOFTWARE_AND_IT","SOFTWARE_SUBSCRIPTION","TELECOM","OFFICE_SUPPLY","OFFICE_EQUIPMENT_AND_FURNITURE","RENT_AND_LEASE","UTILITIES","INSURANCE","LEGAL_FEE","ADMINISTRATIVE_SERVICE","RETAIL"]},"quantity":{"type":"object","$ref":"#/components/schemas/ItemQuantity"},"price":{"type":"number","description":"Price of the item depending on the quantity (amount and unit) provided. If FLAT_FEE then price is the total price for the item otherwise price is the price per unit","minimum":0},"description":{"type":"string","description":"Description of the item"},"order":{"type":"number","description":"The order of the item."},"stockId":{"type":"string","description":"External Stock identifier for the item."},"totalTax":{"type":"number","description":"Total tax amount in the currency specified in the CorporateCheckout. This value will be calculated based on the taxes if not provided","minimum":0},"total":{"type":"number","description":"Total amount of the items, price + totalTax. This value will be calculated based on the price and taxes if not provided","minimum":0},"taxes":{"type":"array","description":"List of taxes associated with the item","items":{"$ref":"#/components/schemas/ItemTax"}},"co2":{"type":"number","description":"Carbon dioxide pollution in kg","minimum":0},"cancellationPolicy":{"oneOf":[{"$ref":"#/components/schemas/CancellationPolicy"},{"type":"string","description":"String representation of cancellation policy"}]}},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/Flight"},{"$ref":"#/components/schemas/Accommodation"},{"$ref":"#/components/schemas/Rail"},{"$ref":"#/components/schemas/RentalCar"},{"$ref":"#/components/schemas/TaxiShuttle"},{"$ref":"#/components/schemas/Parking"},{"$ref":"#/components/schemas/DatePeriodItem"}]},"ItemQuantity":{"type":"object","required":["amount"],"properties":{"amount":{"type":"number","description":"Amount of the quantity","minimum":1},"unit":{"type":"string","description":"Unit of the quantity. If FLAT_FEE then price is the total price for the amount without tax, otherwise price is the price per unit","enum":["FLAT_FEE","PER_HOUR","PER_DAY","PER_NIGHT","PER_WEEK","PER_MONTH","PER_YEAR","PER_PERSON"],"default":"FLAT_FEE"}},"additionalProperties":false},"ItemTax":{"type":"object","required":["value","applyTo"],"properties":{"type":{"type":"string","description":"Type of the tax","enum":["NET_PRICE","VAT","BED_TAX","CITY_HOTEL_FEES","COUNTRY_TAX","CITY_TAX","ENERGY_CHARGE","FEDERAL_TAX","GST","INCLUSION","LODGING_TAX","MAINTENANCE_FEE","OCCUPANCY_TAX","PACKAGE_RATE_FEE","ROOM_TAX","RESORT_FEES","SALES_TAX","STATE_PROVINCE_TAX","SURCHARGE","SERVICE_CHARGE","OTHER_TAX","TOURISM_TAX"],"default":"VAT"},"value":{"type":"number","description":"Value of the tax based on the unit used (if the unit provided is AMOUNT, we expect the value to be based on the currency used in the CorporateCheckout)","minimum":0},"unit":{"type":"string","description":"Unit of the tax value (AMOUNT or PERCENT)","enum":["AMOUNT","PERCENT"],"default":"PERCENT"},"basis":{"type":"string","description":"Basis of the tax value (FLAT_FEE or PER_QUANTITY)","enum":["FLAT_FEE","PER_QUANTITY"],"default":"PER_QUANTITY"},"applyTo":{"type":"string","description":"Indicates what base value the tax will be applied to. Some taxes are accumulated on the total price of the item plus other taxes","enum":["NET_PRICE","VAT","BED_TAX","CITY_HOTEL_FEES","COUNTRY_TAX","CITY_TAX","ENERGY_CHARGE","FEDERAL_TAX","GST","INCLUSION","LODGING_TAX","MAINTENANCE_FEE","OCCUPANCY_TAX","PACKAGE_RATE_FEE","ROOM_TAX","RESORT_FEES","SALES_TAX","STATE_PROVINCE_TAX","SURCHARGE","SERVICE_CHARGE","OTHER_TAX","TOURISM_TAX"],"default":"NET_PRICE"}},"additionalProperties":false},"CancellationPolicy":{"type":"object","required":["reference","penalties"],"properties":{"reference":{"type":"string","description":"Reference date for penalty calculation","enum":["PAYMENT_DATE","START_PERIOD"]},"penalties":{"type":"array","description":"List of penalties applicable to the item","items":{"$ref":"#/components/schemas/BasePenalty"},"minItems":1},"description":{"type":"string","description":"Description of the cancellation policy"}},"additionalProperties":false},"BasePenalty":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["OFFSET_PENALTY","DATE_PENALTY"]},"value":{"$ref":"#/components/schemas/CancellationPenaltyValue"}},"oneOf":[{"properties":{"type":{"enum":["OFFSET_PENALTY"]},"offset":{"$ref":"#/components/schemas/CancellationPenaltyOffset"}},"required":["offset"]},{"properties":{"type":{"enum":["DATE_PENALTY"]},"until":{"type":"string","format":"date-time","description":"The date after which the penalty will be applied"}},"required":["until"]}],"additionalProperties":false},"CancellationPenaltyValue":{"type":"object","required":["amount","unit"],"properties":{"amount":{"type":"number","description":"Penalty amount","minimum":0},"unit":{"type":"string","description":"Penalty value unit","enum":["FIXED_AMOUNT","PERCENTAGE"]}},"additionalProperties":false},"CancellationPenaltyOffset":{"type":"object","required":["amount","unit"],"properties":{"amount":{"type":"number","description":"Offset amount","minimum":0},"unit":{"type":"string","description":"Offset time unit","enum":["DAYS","HOURS","MONTHS"]}},"additionalProperties":false},"Flight":{"type":"object","required":["category","period","departure","destination","airline","serviceClass"],"properties":{"category":{"type":"string","enum":["FLIGHT"]},"period":{"$ref":"#/components/schemas/Period"},"departure":{"type":"string","description":"Departure airport - 3-letter IATA airport code"},"destination":{"type":"string","description":"Destination airport - 3-letter IATA airport code"},"airline":{"type":"string","description":"Airline - 3-letter ICAO or 2-letter IATA airline code"},"serviceClass":{"type":"string","enum":["FIRST_CLASS","BUSINESS_CLASS","ECONOMY_CLASS","OTHER"]},"flightNumber":{"type":"string","description":"Flight number"},"fareClass":{"type":"string","description":"Fare class code"}},"additionalProperties":false},"Period":{"type":"object","required":["start","end"],"properties":{"start":{"type":"string","format":"date-time","description":"Start date/time using ISO 8601 format"},"end":{"type":"string","format":"date-time","description":"End date/time using ISO 8601 format"}},"additionalProperties":false},"Accommodation":{"type":"object","required":["category","period","location","accommodationType"],"properties":{"category":{"type":"string","enum":["ACCOMMODATION"]},"period":{"$ref":"#/components/schemas/Period"},"locationName":{"type":"string","description":"Location name (property name)"},"location":{"$ref":"#/components/schemas/Location"},"roomType":{"type":"string","enum":["APARTMENT","QUADRUPLE","SUITE","TRIPLE","TWIN","DOUBLE","SINGLE","STUDIO","FAMILY","TWIN_DOUBLE","DORMITORY_ROOM","BED_IN_DORMITORY","BUNGALOW","CHALET","HOLIDAY_HOME","VILLA","MOBILE_HOME","TENT"]},"accommodationType":{"type":"string","enum":["RESORT","HOSTEL","HOTEL","INN","LODGE","MOTEL","LOVE_HOTEL","KP_BUSINESS_HOTEL","CAPSULE_HOTEL","APARTMENT","BED_BREAKFAST","CAMPING","CHALET","BOAT","FARM_STAY","TENTED","VILLA","GUEST_HOUSE","APART_HOTEL","RIAD","RYOKAN","HOME_STAY","HOLIDAY_HOME","COUNTRY_HOUSE","HOLIDAY_PARK"]},"serviceClass":{"type":"string","enum":["FIRST_CLASS","BUSINESS_CLASS","ECONOMY_CLASS","OTHER"]}},"additionalProperties":false},"Location":{"type":"object","required":["city","country"],"properties":{"street":{"type":"string","description":"Street name"},"house":{"type":"string","description":"House number"},"zipCode":{"type":"string","description":"Postal code"},"city":{"type":"string","description":"City name"},"country":{"type":"string","description":"Country name"},"lat":{"type":"string","description":"Latitude of the location"},"lng":{"type":"string","description":"Longitude of the location"}},"additionalProperties":false},"Rail":{"type":"object","required":["category","period","departure","destination","serviceClass"],"properties":{"category":{"type":"string","enum":["RAIL"]},"period":{"$ref":"#/components/schemas/Period"},"departure":{"$ref":"#/components/schemas/Location"},"destination":{"$ref":"#/components/schemas/Location"},"serviceClass":{"type":"string","enum":["FIRST_CLASS","BUSINESS_CLASS","ECONOMY_CLASS","OTHER"]}},"additionalProperties":false},"RentalCar":{"type":"object","required":["category","period","pickUpLocation","dropOffLocation"],"properties":{"category":{"type":"string","enum":["RENTAL_CAR"]},"period":{"$ref":"#/components/schemas/Period"},"pickUpLocation":{"$ref":"#/components/schemas/Location"},"dropOffLocation":{"$ref":"#/components/schemas/Location"},"classificationCode":{"type":"string","description":"Vehicle classification code"}},"additionalProperties":false},"TaxiShuttle":{"type":"object","required":["category","period","pickUpLocation","dropOffLocation"],"properties":{"category":{"type":"string","enum":["TAXI_SHUTTLE"]},"period":{"$ref":"#/components/schemas/Period"},"pickUpLocation":{"$ref":"#/components/schemas/Location"},"dropOffLocation":{"$ref":"#/components/schemas/Location"}},"additionalProperties":false},"Parking":{"type":"object","required":["category","period","location"],"properties":{"category":{"type":"string","enum":["PARKING"]},"period":{"$ref":"#/components/schemas/Period"},"plateNumber":{"type":"string","description":"Plate number of the car"},"location":{"$ref":"#/components/schemas/Location"}}},"DatePeriodItem":{"type":"object","required":["category","period"],"properties":{"category":{"type":"string","enum":["OTHER_TRAVEL","TRAVEL_AGENCY","PUBLIC_TRANSPORTATION"]},"period":{"$ref":"#/components/schemas/Period"}},"additionalProperties":false}}}}
```

## The ItemQuantity object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"ItemQuantity":{"type":"object","required":["amount"],"properties":{"amount":{"type":"number","description":"Amount of the quantity","minimum":1},"unit":{"type":"string","description":"Unit of the quantity. If FLAT_FEE then price is the total price for the amount without tax, otherwise price is the price per unit","enum":["FLAT_FEE","PER_HOUR","PER_DAY","PER_NIGHT","PER_WEEK","PER_MONTH","PER_YEAR","PER_PERSON"],"default":"FLAT_FEE"}},"additionalProperties":false}}}}
```

## The ItemTax object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"ItemTax":{"type":"object","required":["value","applyTo"],"properties":{"type":{"type":"string","description":"Type of the tax","enum":["NET_PRICE","VAT","BED_TAX","CITY_HOTEL_FEES","COUNTRY_TAX","CITY_TAX","ENERGY_CHARGE","FEDERAL_TAX","GST","INCLUSION","LODGING_TAX","MAINTENANCE_FEE","OCCUPANCY_TAX","PACKAGE_RATE_FEE","ROOM_TAX","RESORT_FEES","SALES_TAX","STATE_PROVINCE_TAX","SURCHARGE","SERVICE_CHARGE","OTHER_TAX","TOURISM_TAX"],"default":"VAT"},"value":{"type":"number","description":"Value of the tax based on the unit used (if the unit provided is AMOUNT, we expect the value to be based on the currency used in the CorporateCheckout)","minimum":0},"unit":{"type":"string","description":"Unit of the tax value (AMOUNT or PERCENT)","enum":["AMOUNT","PERCENT"],"default":"PERCENT"},"basis":{"type":"string","description":"Basis of the tax value (FLAT_FEE or PER_QUANTITY)","enum":["FLAT_FEE","PER_QUANTITY"],"default":"PER_QUANTITY"},"applyTo":{"type":"string","description":"Indicates what base value the tax will be applied to. Some taxes are accumulated on the total price of the item plus other taxes","enum":["NET_PRICE","VAT","BED_TAX","CITY_HOTEL_FEES","COUNTRY_TAX","CITY_TAX","ENERGY_CHARGE","FEDERAL_TAX","GST","INCLUSION","LODGING_TAX","MAINTENANCE_FEE","OCCUPANCY_TAX","PACKAGE_RATE_FEE","ROOM_TAX","RESORT_FEES","SALES_TAX","STATE_PROVINCE_TAX","SURCHARGE","SERVICE_CHARGE","OTHER_TAX","TOURISM_TAX"],"default":"NET_PRICE"}},"additionalProperties":false}}}}
```

## The Flight object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"Flight":{"type":"object","required":["category","period","departure","destination","airline","serviceClass"],"properties":{"category":{"type":"string","enum":["FLIGHT"]},"period":{"$ref":"#/components/schemas/Period"},"departure":{"type":"string","description":"Departure airport - 3-letter IATA airport code"},"destination":{"type":"string","description":"Destination airport - 3-letter IATA airport code"},"airline":{"type":"string","description":"Airline - 3-letter ICAO or 2-letter IATA airline code"},"serviceClass":{"type":"string","enum":["FIRST_CLASS","BUSINESS_CLASS","ECONOMY_CLASS","OTHER"]},"flightNumber":{"type":"string","description":"Flight number"},"fareClass":{"type":"string","description":"Fare class code"}},"additionalProperties":false},"Period":{"type":"object","required":["start","end"],"properties":{"start":{"type":"string","format":"date-time","description":"Start date/time using ISO 8601 format"},"end":{"type":"string","format":"date-time","description":"End date/time using ISO 8601 format"}},"additionalProperties":false}}}}
```

## The Accommodation object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"Accommodation":{"type":"object","required":["category","period","location","accommodationType"],"properties":{"category":{"type":"string","enum":["ACCOMMODATION"]},"period":{"$ref":"#/components/schemas/Period"},"locationName":{"type":"string","description":"Location name (property name)"},"location":{"$ref":"#/components/schemas/Location"},"roomType":{"type":"string","enum":["APARTMENT","QUADRUPLE","SUITE","TRIPLE","TWIN","DOUBLE","SINGLE","STUDIO","FAMILY","TWIN_DOUBLE","DORMITORY_ROOM","BED_IN_DORMITORY","BUNGALOW","CHALET","HOLIDAY_HOME","VILLA","MOBILE_HOME","TENT"]},"accommodationType":{"type":"string","enum":["RESORT","HOSTEL","HOTEL","INN","LODGE","MOTEL","LOVE_HOTEL","KP_BUSINESS_HOTEL","CAPSULE_HOTEL","APARTMENT","BED_BREAKFAST","CAMPING","CHALET","BOAT","FARM_STAY","TENTED","VILLA","GUEST_HOUSE","APART_HOTEL","RIAD","RYOKAN","HOME_STAY","HOLIDAY_HOME","COUNTRY_HOUSE","HOLIDAY_PARK"]},"serviceClass":{"type":"string","enum":["FIRST_CLASS","BUSINESS_CLASS","ECONOMY_CLASS","OTHER"]}},"additionalProperties":false},"Period":{"type":"object","required":["start","end"],"properties":{"start":{"type":"string","format":"date-time","description":"Start date/time using ISO 8601 format"},"end":{"type":"string","format":"date-time","description":"End date/time using ISO 8601 format"}},"additionalProperties":false},"Location":{"type":"object","required":["city","country"],"properties":{"street":{"type":"string","description":"Street name"},"house":{"type":"string","description":"House number"},"zipCode":{"type":"string","description":"Postal code"},"city":{"type":"string","description":"City name"},"country":{"type":"string","description":"Country name"},"lat":{"type":"string","description":"Latitude of the location"},"lng":{"type":"string","description":"Longitude of the location"}},"additionalProperties":false}}}}
```

## The Parking object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"Parking":{"type":"object","required":["category","period","location"],"properties":{"category":{"type":"string","enum":["PARKING"]},"period":{"$ref":"#/components/schemas/Period"},"plateNumber":{"type":"string","description":"Plate number of the car"},"location":{"$ref":"#/components/schemas/Location"}}},"Period":{"type":"object","required":["start","end"],"properties":{"start":{"type":"string","format":"date-time","description":"Start date/time using ISO 8601 format"},"end":{"type":"string","format":"date-time","description":"End date/time using ISO 8601 format"}},"additionalProperties":false},"Location":{"type":"object","required":["city","country"],"properties":{"street":{"type":"string","description":"Street name"},"house":{"type":"string","description":"House number"},"zipCode":{"type":"string","description":"Postal code"},"city":{"type":"string","description":"City name"},"country":{"type":"string","description":"Country name"},"lat":{"type":"string","description":"Latitude of the location"},"lng":{"type":"string","description":"Longitude of the location"}},"additionalProperties":false}}}}
```

## The TaxiShuttle object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"TaxiShuttle":{"type":"object","required":["category","period","pickUpLocation","dropOffLocation"],"properties":{"category":{"type":"string","enum":["TAXI_SHUTTLE"]},"period":{"$ref":"#/components/schemas/Period"},"pickUpLocation":{"$ref":"#/components/schemas/Location"},"dropOffLocation":{"$ref":"#/components/schemas/Location"}},"additionalProperties":false},"Period":{"type":"object","required":["start","end"],"properties":{"start":{"type":"string","format":"date-time","description":"Start date/time using ISO 8601 format"},"end":{"type":"string","format":"date-time","description":"End date/time using ISO 8601 format"}},"additionalProperties":false},"Location":{"type":"object","required":["city","country"],"properties":{"street":{"type":"string","description":"Street name"},"house":{"type":"string","description":"House number"},"zipCode":{"type":"string","description":"Postal code"},"city":{"type":"string","description":"City name"},"country":{"type":"string","description":"Country name"},"lat":{"type":"string","description":"Latitude of the location"},"lng":{"type":"string","description":"Longitude of the location"}},"additionalProperties":false}}}}
```

## The RentalCar object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"RentalCar":{"type":"object","required":["category","period","pickUpLocation","dropOffLocation"],"properties":{"category":{"type":"string","enum":["RENTAL_CAR"]},"period":{"$ref":"#/components/schemas/Period"},"pickUpLocation":{"$ref":"#/components/schemas/Location"},"dropOffLocation":{"$ref":"#/components/schemas/Location"},"classificationCode":{"type":"string","description":"Vehicle classification code"}},"additionalProperties":false},"Period":{"type":"object","required":["start","end"],"properties":{"start":{"type":"string","format":"date-time","description":"Start date/time using ISO 8601 format"},"end":{"type":"string","format":"date-time","description":"End date/time using ISO 8601 format"}},"additionalProperties":false},"Location":{"type":"object","required":["city","country"],"properties":{"street":{"type":"string","description":"Street name"},"house":{"type":"string","description":"House number"},"zipCode":{"type":"string","description":"Postal code"},"city":{"type":"string","description":"City name"},"country":{"type":"string","description":"Country name"},"lat":{"type":"string","description":"Latitude of the location"},"lng":{"type":"string","description":"Longitude of the location"}},"additionalProperties":false}}}}
```

## The Rail object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"Rail":{"type":"object","required":["category","period","departure","destination","serviceClass"],"properties":{"category":{"type":"string","enum":["RAIL"]},"period":{"$ref":"#/components/schemas/Period"},"departure":{"$ref":"#/components/schemas/Location"},"destination":{"$ref":"#/components/schemas/Location"},"serviceClass":{"type":"string","enum":["FIRST_CLASS","BUSINESS_CLASS","ECONOMY_CLASS","OTHER"]}},"additionalProperties":false},"Period":{"type":"object","required":["start","end"],"properties":{"start":{"type":"string","format":"date-time","description":"Start date/time using ISO 8601 format"},"end":{"type":"string","format":"date-time","description":"End date/time using ISO 8601 format"}},"additionalProperties":false},"Location":{"type":"object","required":["city","country"],"properties":{"street":{"type":"string","description":"Street name"},"house":{"type":"string","description":"House number"},"zipCode":{"type":"string","description":"Postal code"},"city":{"type":"string","description":"City name"},"country":{"type":"string","description":"Country name"},"lat":{"type":"string","description":"Latitude of the location"},"lng":{"type":"string","description":"Longitude of the location"}},"additionalProperties":false}}}}
```

## The DatePeriodItem object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"DatePeriodItem":{"type":"object","required":["category","period"],"properties":{"category":{"type":"string","enum":["OTHER_TRAVEL","TRAVEL_AGENCY","PUBLIC_TRANSPORTATION"]},"period":{"$ref":"#/components/schemas/Period"}},"additionalProperties":false},"Period":{"type":"object","required":["start","end"],"properties":{"start":{"type":"string","format":"date-time","description":"Start date/time using ISO 8601 format"},"end":{"type":"string","format":"date-time","description":"End date/time using ISO 8601 format"}},"additionalProperties":false}}}}
```

## The Location object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"Location":{"type":"object","required":["city","country"],"properties":{"street":{"type":"string","description":"Street name"},"house":{"type":"string","description":"House number"},"zipCode":{"type":"string","description":"Postal code"},"city":{"type":"string","description":"City name"},"country":{"type":"string","description":"Country name"},"lat":{"type":"string","description":"Latitude of the location"},"lng":{"type":"string","description":"Longitude of the location"}},"additionalProperties":false}}}}
```

## The Period object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"Period":{"type":"object","required":["start","end"],"properties":{"start":{"type":"string","format":"date-time","description":"Start date/time using ISO 8601 format"},"end":{"type":"string","format":"date-time","description":"End date/time using ISO 8601 format"}},"additionalProperties":false}}}}
```

## The ValidationError object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"ValidationError":{"type":"object","properties":{"message":{"type":"array","items":{"type":"string"}},"error":{"type":"string"},"statusCode":{"type":"number"}}}}}}
```

## The CancellationReq object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"CancellationReq":{"type":"object","required":["itemsOrder"],"properties":{"itemsOrder":{"type":"array","description":"Array of item order numbers to cancel, order numbers start from 1","items":{"type":"number","minimum":1},"minItems":1},"amount":{"type":"number","description":"Specific refund amount. If not provided or 0, the refundable amount will be calculated based on cancellation policy","minimum":0},"invoiceTitle":{"type":"string","description":"Title of the cancellation invoice"},"invoiceNumber":{"type":"string","description":"Invoice number for the cancellation"}},"additionalProperties":false}}}}
```

## The CancellationPolicy object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"CancellationPolicy":{"type":"object","required":["reference","penalties"],"properties":{"reference":{"type":"string","description":"Reference date for penalty calculation","enum":["PAYMENT_DATE","START_PERIOD"]},"penalties":{"type":"array","description":"List of penalties applicable to the item","items":{"$ref":"#/components/schemas/BasePenalty"},"minItems":1},"description":{"type":"string","description":"Description of the cancellation policy"}},"additionalProperties":false},"BasePenalty":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["OFFSET_PENALTY","DATE_PENALTY"]},"value":{"$ref":"#/components/schemas/CancellationPenaltyValue"}},"oneOf":[{"properties":{"type":{"enum":["OFFSET_PENALTY"]},"offset":{"$ref":"#/components/schemas/CancellationPenaltyOffset"}},"required":["offset"]},{"properties":{"type":{"enum":["DATE_PENALTY"]},"until":{"type":"string","format":"date-time","description":"The date after which the penalty will be applied"}},"required":["until"]}],"additionalProperties":false},"CancellationPenaltyValue":{"type":"object","required":["amount","unit"],"properties":{"amount":{"type":"number","description":"Penalty amount","minimum":0},"unit":{"type":"string","description":"Penalty value unit","enum":["FIXED_AMOUNT","PERCENTAGE"]}},"additionalProperties":false},"CancellationPenaltyOffset":{"type":"object","required":["amount","unit"],"properties":{"amount":{"type":"number","description":"Offset amount","minimum":0},"unit":{"type":"string","description":"Offset time unit","enum":["DAYS","HOURS","MONTHS"]}},"additionalProperties":false}}}}
```

## The BasePenalty object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"BasePenalty":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["OFFSET_PENALTY","DATE_PENALTY"]},"value":{"$ref":"#/components/schemas/CancellationPenaltyValue"}},"oneOf":[{"properties":{"type":{"enum":["OFFSET_PENALTY"]},"offset":{"$ref":"#/components/schemas/CancellationPenaltyOffset"}},"required":["offset"]},{"properties":{"type":{"enum":["DATE_PENALTY"]},"until":{"type":"string","format":"date-time","description":"The date after which the penalty will be applied"}},"required":["until"]}],"additionalProperties":false},"CancellationPenaltyValue":{"type":"object","required":["amount","unit"],"properties":{"amount":{"type":"number","description":"Penalty amount","minimum":0},"unit":{"type":"string","description":"Penalty value unit","enum":["FIXED_AMOUNT","PERCENTAGE"]}},"additionalProperties":false},"CancellationPenaltyOffset":{"type":"object","required":["amount","unit"],"properties":{"amount":{"type":"number","description":"Offset amount","minimum":0},"unit":{"type":"string","description":"Offset time unit","enum":["DAYS","HOURS","MONTHS"]}},"additionalProperties":false}}}}
```

## The CancellationPenaltyValue object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"CancellationPenaltyValue":{"type":"object","required":["amount","unit"],"properties":{"amount":{"type":"number","description":"Penalty amount","minimum":0},"unit":{"type":"string","description":"Penalty value unit","enum":["FIXED_AMOUNT","PERCENTAGE"]}},"additionalProperties":false}}}}
```

## The CancellationPenaltyOffset object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"CancellationPenaltyOffset":{"type":"object","required":["amount","unit"],"properties":{"amount":{"type":"number","description":"Offset amount","minimum":0},"unit":{"type":"string","description":"Offset time unit","enum":["DAYS","HOURS","MONTHS"]}},"additionalProperties":false}}}}
```

## The FailedContractStatusDto object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"FailedContractStatusDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the failed contract"},"refrence":{"type":"string","description":"Transaction reference number"},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"errors":{"type":"array","description":"List of errors that occurred during transaction processing","items":{"$ref":"#/components/schemas/ContractStepError"}},"contractId":{"type":"string","description":"Transaction identifier"}},"additionalProperties":false},"ContractStepError":{"type":"object","required":["fieldName","message"],"properties":{"fieldName":{"type":"string","description":"Name of the field that caused the error"},"message":{"type":"string","description":"Error message describing the issue"}},"additionalProperties":false}}}}
```

## The ContractStepError object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"ContractStepError":{"type":"object","required":["fieldName","message"],"properties":{"fieldName":{"type":"string","description":"Name of the field that caused the error"},"message":{"type":"string","description":"Error message describing the issue"}},"additionalProperties":false}}}}
```

## The DetectDto object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"DetectDto":{"type":"object","required":["screenshot","content","url"],"properties":{"screenshot":{"type":"string","description":"Base64 encoded screenshot of the page"},"content":{"type":"string","description":"HTML content of the page"},"url":{"type":"string","format":"uri","description":"URL of the page to detect"}},"additionalProperties":false}}}}
```

## The IPageable object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"IPageable":{"type":"object","properties":{"content":{"type":"array","description":"Array of items for the current page","items":{}},"page":{"type":"object","properties":{"totalElements":{"type":"number","description":"Total number of elements across all pages"},"totalPages":{"type":"number","description":"Total number of pages"},"size":{"type":"number","description":"Number of elements per page"},"number":{"type":"number","description":"Current page number (0-based)"}}}},"additionalProperties":false}}}}
```

## The Filter object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"Filter":{"type":"object","required":["field","operator","value"],"properties":{"field":{"type":"string","description":"Field name to filter by"},"operator":{"type":"string","description":"Filter operator","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","GREATER_THAN","LESS_THAN","GREATER_THAN_OR_EQUAL","LESS_THAN_OR_EQUAL"]},"value":{"description":"Value to filter by"}},"additionalProperties":false}}}}
```

## The StatusResponse object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"StatusResponse":{"type":"object","required":["status"],"properties":{"status":{"type":"string","enum":["PENDING","CONFIRMED","CANCELLED","PAID","FAILED"],"description":"Current status of the transaction"},"checkout":{"$ref":"#/components/schemas/CheckoutInfo","description":"Detailed checkout information (only present when status is PAID)"}},"additionalProperties":false},"CheckoutInfo":{"type":"object","required":["reference","payment","customer","billing"],"properties":{"reference":{"type":"string","description":"Contract reference key"},"payment":{"$ref":"#/components/schemas/PaymentInfo"},"customer":{"$ref":"#/components/schemas/CustomerInfo"},"beneficiary":{"$ref":"#/components/schemas/BeneficiaryInfo"},"billing":{"$ref":"#/components/schemas/BillingInfo"},"card":{"type":"object","description":"Payment card information","additionalProperties":true},"reporting":{"type":"object","description":"Additional reporting data","additionalProperties":true}},"additionalProperties":false},"PaymentInfo":{"type":"object","required":["reference","provider"],"properties":{"reference":{"type":"string","description":"Payment reference"},"provider":{"type":"string","description":"Payment provider name (e.g., 'Stripe', 'PayPal')"}},"additionalProperties":false},"CustomerInfo":{"type":"object","required":["firstName","lastName"],"properties":{"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"},"email":{"type":"string","format":"email","description":"Customer email address"},"phone":{"type":"string","description":"Customer phone number"},"address":{"$ref":"#/components/schemas/Address"}},"additionalProperties":false},"BeneficiaryInfo":{"type":"object","required":["firstName","lastName","email"],"properties":{"firstName":{"type":"string","description":"Beneficiary first name"},"lastName":{"type":"string","description":"Beneficiary last name"},"email":{"type":"string","format":"email","description":"Beneficiary email address"}},"additionalProperties":false},"BillingInfo":{"type":"object","properties":{"name":{"type":"string","description":"Billing name"},"email":{"type":"string","format":"email","description":"Billing email address"},"address":{"$ref":"#/components/schemas/Address"},"externalIds":{"type":"object","description":"External company identifiers","additionalProperties":true}},"additionalProperties":false}}}}
```

## The CheckoutInfo object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"CheckoutInfo":{"type":"object","required":["reference","payment","customer","billing"],"properties":{"reference":{"type":"string","description":"Contract reference key"},"payment":{"$ref":"#/components/schemas/PaymentInfo"},"customer":{"$ref":"#/components/schemas/CustomerInfo"},"beneficiary":{"$ref":"#/components/schemas/BeneficiaryInfo"},"billing":{"$ref":"#/components/schemas/BillingInfo"},"card":{"type":"object","description":"Payment card information","additionalProperties":true},"reporting":{"type":"object","description":"Additional reporting data","additionalProperties":true}},"additionalProperties":false},"PaymentInfo":{"type":"object","required":["reference","provider"],"properties":{"reference":{"type":"string","description":"Payment reference"},"provider":{"type":"string","description":"Payment provider name (e.g., 'Stripe', 'PayPal')"}},"additionalProperties":false},"CustomerInfo":{"type":"object","required":["firstName","lastName"],"properties":{"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"},"email":{"type":"string","format":"email","description":"Customer email address"},"phone":{"type":"string","description":"Customer phone number"},"address":{"$ref":"#/components/schemas/Address"}},"additionalProperties":false},"BeneficiaryInfo":{"type":"object","required":["firstName","lastName","email"],"properties":{"firstName":{"type":"string","description":"Beneficiary first name"},"lastName":{"type":"string","description":"Beneficiary last name"},"email":{"type":"string","format":"email","description":"Beneficiary email address"}},"additionalProperties":false},"BillingInfo":{"type":"object","properties":{"name":{"type":"string","description":"Billing name"},"email":{"type":"string","format":"email","description":"Billing email address"},"address":{"$ref":"#/components/schemas/Address"},"externalIds":{"type":"object","description":"External company identifiers","additionalProperties":true}},"additionalProperties":false}}}}
```

## The PaymentInfo object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"PaymentInfo":{"type":"object","required":["reference","provider"],"properties":{"reference":{"type":"string","description":"Payment reference"},"provider":{"type":"string","description":"Payment provider name (e.g., 'Stripe', 'PayPal')"}},"additionalProperties":false}}}}
```

## The CustomerInfo object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"CustomerInfo":{"type":"object","required":["firstName","lastName"],"properties":{"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"},"email":{"type":"string","format":"email","description":"Customer email address"},"phone":{"type":"string","description":"Customer phone number"},"address":{"$ref":"#/components/schemas/Address"}},"additionalProperties":false}}}}
```

## The BeneficiaryInfo object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"BeneficiaryInfo":{"type":"object","required":["firstName","lastName","email"],"properties":{"firstName":{"type":"string","description":"Beneficiary first name"},"lastName":{"type":"string","description":"Beneficiary last name"},"email":{"type":"string","format":"email","description":"Beneficiary email address"}},"additionalProperties":false}}}}
```

## The BillingInfo object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"BillingInfo":{"type":"object","properties":{"name":{"type":"string","description":"Billing name"},"email":{"type":"string","format":"email","description":"Billing email address"},"address":{"$ref":"#/components/schemas/Address"},"externalIds":{"type":"object","description":"External company identifiers","additionalProperties":true}},"additionalProperties":false}}}}
```

## The UpdateCorporateCheckout object

```json
{"openapi":"3.0.0","info":{"title":"1-CP API Docs","version":"0.0.1"},"components":{"schemas":{"UpdateCorporateCheckout":{"type":"object","properties":{"externalIds":{"type":"object","description":"External company identifiers","additionalProperties":true},"title":{"type":"string","description":"Title of contract"},"note":{"type":"string","description":"Note"},"attachments":{"type":"array","description":"List of attachments associated with the CorporateCheckout","items":{"$ref":"#/components/schemas/Attachment"}}}},"Attachment":{"type":"object","required":["url","type"],"properties":{"url":{"type":"string","description":"URL to the file. (File size is limited to 10MB if uploaded to our system; otherwise, the URL must be publicly available and accessible at all times.)"},"type":{"type":"string","description":"Type of the attachment","enum":["INVOICE","PROPOSAL","CONTRACT","TERMS_AND_CONDITIONS","PICTURES","HEADER_IMAGE","OTHER"]}},"additionalProperties":false}}}}
```