{ "x-generator": "NSwag v14.7.1.0 (NJsonSchema v11.6.1.0 (Newtonsoft.Json v13.0.0.0))", "openapi": "3.0.0", "info": { "title": "Rently API", "version": "v1" }, "servers": [ { "url": "https://{tenant}.rently.com.ar", "description": "Tenant host. Replace {tenant} with your organization's subdomain.", "variables": { "tenant": { "default": "demo", "description": "Your tenant's subdomain." } } } ], "paths": { "/api/bradesco/webhooks": { "post": { "tags": [ "Bradesco" ], "summary": "Recibe la notificación de pago, la valida y la encola.", "description": "Un evento legítimo pero sin nada que hacer (no es de pago, título desconocido) se contesta con éxito: un\nerror solo provocaría reintentos del banco por algo que no va a cambiar.", "operationId": "Bradesco_HandleBradescoWebHook", "requestBody": { "x-name": "webhook", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BradescoWebhookMessage" } ] } } }, "x-position": 1 }, "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/v1/santander/webhooks": { "post": { "tags": [ "Santander" ], "description": "El endpoint es anónimo y su efecto es acreditar un pago, así que no alcanza con autenticar el evento:\nel payload NO es fuente de verdad. El secreto decide si el evento se procesa, y la liquidación se\nconfirma contra Santander por mTLS antes de encolar la conciliación. Un evento fabricado no acredita\nnada aunque el secreto se filtre.", "operationId": "Santander_HandleSantanderWebHook", "requestBody": { "x-name": "webhook", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SantanderWebhookMessage" } ] } } }, "x-position": 1 }, "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/selfcheckin": { "put": { "tags": [ "Booking Checkin" ], "summary": "Update self-check-in", "description": "This endpoint allows updating the self-check-in information for a booking,\nincluding customer details, documents, and other required information.\nThe endpoint validates the provided data and updates the booking accordingly.", "operationId": "BookingCheckinApi_SelfCheckinUpdate", "requestBody": { "x-name": "model", "description": "The self-check-in data to update", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelfCheckinUpdateBookingModel" } ] } } }, "x-position": 1 }, "responses": { "200": { "description": "Actualiza los datos de self-checkin de la reserva", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Booking" } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/bookings/list": { "get": { "tags": [ "Bookings" ], "summary": "List bookings", "description": "Gets a paginated list of bookings", "operationId": "Bookings_ListBookings2", "parameters": [ { "name": "status", "in": "query", "description": "Optional filter by booking status", "schema": { "oneOf": [ { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BookingStatusEnum2" } ] } ] }, "x-position": 1 }, { "name": "offset", "in": "query", "description": "Id-based pagination cursor (default: 0). Pass 0 on the first call (regardless of sort direction).\nOn subsequent calls pass the NextOffset value returned by the previous response.\nIteration ends when Results.Count < Limit.", "schema": { "type": "integer", "format": "int32", "default": 0 }, "x-position": 2 }, { "name": "limit", "in": "query", "description": "Number of items per page (default: 30, max: 100)", "schema": { "type": "integer", "format": "int32", "default": 30 }, "x-position": 3 }, { "name": "sortDirectionAsc", "in": "query", "description": "Sort direction (default: true)", "schema": { "type": "boolean", "default": true }, "x-position": 4 }, { "name": "updatedSince", "in": "query", "description": "Optional. When set, returns only bookings updated strictly after this date/time. Bookings without an UpdatedOn timestamp (legacy/pre-audit records) are excluded when this filter is applied.", "schema": { "type": "string", "format": "date-time", "nullable": true }, "x-position": 5 } ], "responses": { "200": { "description": "Gets a paginated list of bookings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultOfBookingDescription" }, "example": { "Offset": 0, "Limit": 30, "Total": 1, "Results": [ { "Id": 1, "Version": null, "Customer": null, "Balance": -299.99, "IsFullBonus": false, "FeeNoShow": 0.0, "TotalPayed": 0.0, "Extra": null, "Promotion": null, "IsQuotation": false, "Car": null, "Model": { "Id": 10, "Name": "Corolla", "SIPP": "CDMR" }, "Category": { "Id": 5, "Name": "Economy" }, "FromDate": "2026-09-25T13:58:00.0429473Z", "ToDate": "2026-09-28T13:58:00.0429473Z", "DeliveryPlaceId": 1, "ReturnPlaceId": 2, "Price": 299.99, "AgencyPrice": 269.99, "CustomerPrice": 30.0, "Currency": "USD", "Franchise": null, "FranchiseDamage": null, "FranchiseRollover": null, "FranchiseTheft": null, "FranchiseHail": null, "TotalDays": 3.0, "IlimitedKm": false, "MaxAllowedDistance": 0, "MaxAllowedDistanceByDay": 0, "WillLeaveCountry": null, "AverageDayPrice": 99.99666666666667, "Additionals": [], "CurrentStatus": 1, "CurrentStatusDate": "0001-01-01T00:00:00", "DeliveryTransportationId": null, "ReturnTransportationId": null, "IsCustomerOver25": false, "ExternalSystemId": null, "PrepaidAmount": 0.0, "ElegibleSIPPCodeUpgrade": null, "ExchangeRate": null, "DailyRate": 0.0, "HourlyRate": 0.0, "ExtraDayRate": 0.0, "ExtraHourRate": 0.0, "RatePlan": null, "IsOnRequest": false, "DeliveryInfo": null, "DropoffInfo": null, "Origin": null, "CreationDate": "0001-01-01T00:00:00", "PayedByAgency": 0.0, "PayedByCustomer": 0.0, "CommercialAgreementCode": null, "PurchaseOrder": null, "Brand": null, "SalesCommision": 0.0, "IsTransfer": false, "PriceDetails": null, "Agency": null, "IsSelfCheckin": false, "Code": "BK-0001", "UpdatedOn": "2026-09-24T13:58:00.0429473Z", "UpdatedByUserName": null } ], "NextOffset": 0 } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/bookings/closed": { "get": { "tags": [ "Bookings" ], "summary": "List closed bookings", "description": "Gets a paginated list of closed bookings filtered by close date range.", "operationId": "Bookings_ListClosedBookings", "parameters": [ { "name": "fromDate", "in": "query", "required": true, "description": "Start of the close date range (required). Date only - time component is ignored.", "schema": { "type": "string", "format": "date-time" }, "x-position": 1 }, { "name": "toDate", "in": "query", "required": true, "description": "End of the close date range (required, inclusive). Date only - time component is ignored. Must be >= fromDate. Maximum range is 90 days.", "schema": { "type": "string", "format": "date-time" }, "x-position": 2 }, { "name": "offset", "in": "query", "description": "Number of records to skip (default: 0).", "schema": { "type": "integer", "format": "int32", "default": 0 }, "x-position": 3 }, { "name": "limit", "in": "query", "description": "Number of records to return per page (default: 30, max: 100).", "schema": { "type": "integer", "format": "int32", "default": 30 }, "x-position": 4 }, { "name": "sortDirectionAsc", "in": "query", "description": "Sort direction ascending when true (default: true).", "schema": { "type": "boolean", "default": true }, "x-position": 5 }, { "name": "sortByCloseDate", "in": "query", "description": "Sort by close date when true, sort by Id when false (default: false).", "schema": { "type": "boolean", "default": false }, "x-position": 6 } ], "responses": { "200": { "description": "Gets a paginated list of closed bookings filtered by close date range. fromDate and toDate are date-only (time component ignored); toDate is inclusive of the full day.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultOfBooking" }, "example": { "Offset": 0, "Limit": 30, "Total": 1, "Results": [ { "Id": 1, "Version": null, "Customer": { "Id": 1, "GlobalId": "2e3e5a41-578b-4f74-ab16-9a78473b943e", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:00.083336Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:00.0836654Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:00.0836654Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:00.0836654Z", "DocumentIdExpiration": "2036-09-24T13:58:00.0836654Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null }, "Balance": 0.0, "TotalPayed": 0.0, "Extra": null, "Promotion": null, "IsQuotation": false, "Car": { "Id": "CAR123", "Model": { "Description": "The Toyota Corolla is a reliable and fuel-efficient compact sedan with modern features and comfortable interior.", "ImagePath": "/images/models/corolla.jpg", "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 750.0, "FranchiseTheft": 1000.0, "FranchiseHail": 500.0, "Brand": { "Name": "Toyota" }, "Doors": 4, "Passengers": 5, "BigLuggage": 2, "SmallLuggage": 2, "Steering": "Power Steering", "SteeringType": 3, "Gearbox": "Automatic", "TransmissionType": 2, "Multimedia": "Bluetooth, Navigation System", "AirConditioner": "Automatic Climate Control", "AirConditionerType": 1, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": [ { "Id": 1, "Name": "Fuel Type", "Description": "Type of fuel used by the vehicle", "Type": 0, "Unit": "Type", "Value": "Gasoline", "ModelId": 1 }, { "Id": 2, "Name": "Engine Size", "Description": "Engine displacement", "Type": 1, "Unit": "Liters", "Value": "1.8", "ModelId": 1 }, { "Id": 3, "Name": "Transmission", "Description": "Type of transmission", "Type": 0, "Unit": "Type", "Value": "Automatic", "ModelId": 1 } ], "LowerPrice": 45.0, "Id": 1, "Name": "Corolla", "Category": { "Models": null, "Id": 1, "Name": "Economy", "Order": 1.0, "PrincipalModelId": null, "Franchise": 0.0, "FranchiseDamage": 0.0, "FranchiseRollover": 0.0, "FranchiseTheft": 0.0, "FranchiseHail": 0.0, "ImagePath": null }, "SIPP": "CDMR" }, "CurrentBranchOfficeId": 1, "CurrentBranchOffice": "LAX Branch", "BranchOfficeOwner": "Rently LAX Airport", "CurrentKms": 50000, "FuelType": "Gasoline", "Gasoline": 75, "FriendlyName": "Toyota Corolla 2023", "CurrentPlateId": "ABC123", "ChassisIdentification": "1HGCM82633A123456", "CurrentPlate": { "Id": "ABC123", "IssuingCountry": "United States", "IssuingState": "CA" }, "Color": "Silver", "Year": 2023, "TollDeviceId": "TOLL123", "BatteryNumber": "BAT123456", "CreationDate": "0001-01-01T00:00:00", "InactiveDate": null, "LeasedToCompany": null, "SupplierFullName": null, "LastReturnDate": null }, "Model": null, "Category": { "Models": [ { "Description": null, "ImagePath": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "Brand": { "Name": "Toyota" }, "Doors": 0, "Passengers": 0, "BigLuggage": 0, "SmallLuggage": 0, "Steering": null, "SteeringType": null, "Gearbox": null, "TransmissionType": null, "Multimedia": null, "AirConditioner": null, "AirConditionerType": null, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": null, "LowerPrice": 45.0, "Id": 1, "Name": "Toyota Yaris", "Category": null, "SIPP": null } ], "Id": 1, "Name": "Economy", "Order": 0.0, "PrincipalModelId": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "ImagePath": null }, "FromDate": "2026-09-25T13:58:00.0886151Z", "ToDate": "2026-09-28T13:58:00.0896301Z", "DeliveryPlace": { "Price": 0.0, "Name": "Airport Terminal 1", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 1 }, "ReturnPlace": { "Price": 0.0, "Name": "Downtown Branch", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 2 }, "TotalDaysString": "3 days", "Price": 299.99, "AgencyPrice": 269.99, "CustomerPrice": 30.0, "Currency": "USD", "Franchise": null, "FranchiseDamage": null, "FranchiseRollover": null, "FranchiseTheft": null, "FranchiseHail": null, "TotalDays": 0.0, "IlimitedKm": false, "MaxAllowedDistance": 0, "MaxAllowedDistanceByDay": 0, "HasFranchiseModifiers": false, "WillLeaveCountry": null, "AverageDayPrice": 0.0, "PriceItems": [ { "Id": 1, "IsBookingPrice": false, "Description": "Base Price", "Price": 269.99, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 1, "TariffName": null, "AppliedCoverageBrackets": [ { "DaysFrom": 1, "DaysTo": 2, "Amount": 200.0 }, { "DaysFrom": 3, "DaysTo": 3, "Amount": 69.99 } ] }, { "Id": 2, "IsBookingPrice": false, "Description": "Insurance", "Price": 30.0, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 0, "TariffName": null } ], "Additionals": [ { "Additional": { "Name": "GPS Navigation", "Description": null, "ImagePath": null, "IsPriceByDay": false, "Price": 29.99, "MaxQuantityPerBooking": 0, "Type": null, "Stock": 0, "Order": 0.0, "Id": 1 }, "Quantity": 1 } ], "AvailablePromotions": null, "CurrentStatus": 1, "CurrentStatusDate": "0001-01-01T00:00:00", "DeliveryTransportationId": null, "ReturnTransportationId": null, "IsCustomerOver25": false, "ExternalSystemId": null, "PrepaidAmount": 0.0, "ElegibleSIPPCodeUpgrade": null, "Attributes": {}, "ExchangeRate": null, "DailyRate": 0.0, "HourlyRate": 0.0, "ExtraDayRate": 0.0, "ExtraHourRate": 0.0, "RatePlan": null, "IsOnRequest": false, "DeliveryInfo": null, "DropoffInfo": null, "Origin": null, "CreationDate": "0001-01-01T00:00:00", "UpdatedOn": null, "UpdatedByUserName": null, "PayedByAgency": 0.0, "PayedByCustomer": 0.0, "CommercialAgreementCode": null, "PurchaseOrder": null, "Brand": null, "SalesCommision": 0.0, "IsTransfer": false, "PriceDetails": { "Price": 299.99, "CustomerPrice": 30.0, "AgencyPrice": 269.99, "SalesCommission": 0.0, "Currency": "USD" }, "Agency": null, "IsSelfCheckin": false, "Links": null, "DistanceUnit": "kilometers", "Code": null } ], "NextOffset": 0 } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/booking/book": { "post": { "tags": [ "Bookings" ], "summary": "Create booking", "description": "Creates a new booking\n \nWhen `FullResponse` is true and the booking was priced by VDR coverage brackets, its rental lines billed per\nday may carry `AppliedCoverageBrackets`. Each of those lines declares a single range with its whole `Price`.\nSeveral lines of the same payer can declare the same range, and the total of that range is their sum. The\ndetail is left out of every line when the stored lines cannot be traced back to their ranges, for example\nafter an extension paid by a different payer. The simplified response never carries it.", "operationId": "Bookings_SaveBooking", "requestBody": { "x-name": "bookingModel", "description": "The booking details", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SaveBookingModel" } ] }, "example": { "Customer": { "Id": 0, "GlobalId": "00000000-0000-0000-0000-000000000000", "Name": "John Doe", "Lastname": null, "Firstname": null, "DocumentId": "12345678", "DocumentTypeId": 2, "EmailAddress": "john.doe@example.com", "CellPhone": null, "Address": null, "AddressNumber": null, "AddressDepartment": null, "Country": null, "BirthDate": null, "CreditCards": [], "Memberships": [], "Age": 30, "DriverLicenceNumber": null, "DriverLicenceCountry": null, "DriverLicenseExpiration": null, "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": null, "FiscalConditionId": null, "Notes": null, "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": null, "State": null, "Region": null, "CommercialAgreements": [], "HasWebLogin": false, "IATACode": null, "BirthCountry": null, "BirthState": null, "DriverLicenseIssuance": null, "DriverLicenseState": null, "DocumentIdIssuance": null, "DocumentIdExpiration": null, "DocumentIdIssuanceState": null, "DocumentIdIssuanceCountry": null, "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null }, "Car": { "Id": null, "Model": { "Id": 1, "Name": null, "Category": null, "SIPP": "ECAR" } }, "Category": { "Id": 1, "Name": "" }, "FromDate": "2026-09-25T10:58:00.1890428-03:00", "ToDate": "2026-09-27T10:58:00.1920968-03:00", "DeliveryPlace": { "IsCustomAddress": false, "Address": null, "City": null, "Id": 1 }, "ReturnPlace": { "IsCustomAddress": false, "Address": null, "City": null, "Id": 1 }, "Additionals": [ { "Additional": { "Id": 1 }, "Quantity": 1 } ], "PriceItems": [], "Attributes": {}, "Origin": null, "Brand": null, "Agency": null, "Currency": "USD", "Price": 0.0, "Franchise": null, "FranchiseDamage": null, "FranchiseRollover": null, "FranchiseTheft": null, "FranchiseHail": null, "ExchangeRate": null, "Promotion": null, "PromotionCode": null, "CommercialAgreementCode": null, "ExternalSystemId": null, "PrepaidAmount": 0.0, "IsQuotation": false, "IsOnRequest": false, "Extra": null, "DeliveryTransportationId": null, "ReturnTransportationId": null, "ElegibleSIPPCodeUpgrade": null, "IlimitedKm": false, "MaxAllowedDistanceByDay": 0, "MaxAllowedDistance": 0, "DistanceUnit": null, "DailyRate": 0.0, "HourlyRate": 0.0, "ExtraDayRate": 0.0, "ExtraHourRate": 0.0, "RatePlan": null, "IsCustomerOver25": false, "Version": null, "CreationDate": "0001-01-01T00:00:00", "FullResponse": true, "IsFixedPrice": false, "IsPriceAllInclusive": false, "ForceExchangeRate": false, "CurrentLanguage": null, "Language": null } } }, "x-position": 1 }, "responses": { "200": { "description": "Creates a new booking\nor\nCreates a new booking", "content": { "application/json": { "schema": {}, "example": { "Id": 1, "Version": null, "Customer": { "Id": 1, "GlobalId": "fe4d2ae8-79e3-40d8-9fff-41775e713ed2", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:00.2081424Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:00.2081424Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:00.2081424Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:00.2081424Z", "DocumentIdExpiration": "2036-09-24T13:58:00.2081424Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null }, "Balance": 0.0, "TotalPayed": 0.0, "Extra": null, "Promotion": null, "IsQuotation": false, "Car": { "Id": "CAR123", "Model": { "Description": "The Toyota Corolla is a reliable and fuel-efficient compact sedan with modern features and comfortable interior.", "ImagePath": "/images/models/corolla.jpg", "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 750.0, "FranchiseTheft": 1000.0, "FranchiseHail": 500.0, "Brand": { "Name": "Toyota" }, "Doors": 4, "Passengers": 5, "BigLuggage": 2, "SmallLuggage": 2, "Steering": "Power Steering", "SteeringType": 3, "Gearbox": "Automatic", "TransmissionType": 2, "Multimedia": "Bluetooth, Navigation System", "AirConditioner": "Automatic Climate Control", "AirConditionerType": 1, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": [ { "Id": 1, "Name": "Fuel Type", "Description": "Type of fuel used by the vehicle", "Type": 0, "Unit": "Type", "Value": "Gasoline", "ModelId": 1 }, { "Id": 2, "Name": "Engine Size", "Description": "Engine displacement", "Type": 1, "Unit": "Liters", "Value": "1.8", "ModelId": 1 }, { "Id": 3, "Name": "Transmission", "Description": "Type of transmission", "Type": 0, "Unit": "Type", "Value": "Automatic", "ModelId": 1 } ], "LowerPrice": 45.0, "Id": 1, "Name": "Corolla", "Category": { "Models": null, "Id": 1, "Name": "Economy", "Order": 1.0, "PrincipalModelId": null, "Franchise": 0.0, "FranchiseDamage": 0.0, "FranchiseRollover": 0.0, "FranchiseTheft": 0.0, "FranchiseHail": 0.0, "ImagePath": null }, "SIPP": "CDMR" }, "CurrentBranchOfficeId": 1, "CurrentBranchOffice": "LAX Branch", "BranchOfficeOwner": "Rently LAX Airport", "CurrentKms": 50000, "FuelType": "Gasoline", "Gasoline": 75, "FriendlyName": "Toyota Corolla 2023", "CurrentPlateId": "ABC123", "ChassisIdentification": "1HGCM82633A123456", "CurrentPlate": { "Id": "ABC123", "IssuingCountry": "United States", "IssuingState": "CA" }, "Color": "Silver", "Year": 2023, "TollDeviceId": "TOLL123", "BatteryNumber": "BAT123456", "CreationDate": "0001-01-01T00:00:00", "InactiveDate": null, "LeasedToCompany": null, "SupplierFullName": null, "LastReturnDate": null }, "Model": null, "Category": { "Models": [ { "Description": null, "ImagePath": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "Brand": { "Name": "Toyota" }, "Doors": 0, "Passengers": 0, "BigLuggage": 0, "SmallLuggage": 0, "Steering": null, "SteeringType": null, "Gearbox": null, "TransmissionType": null, "Multimedia": null, "AirConditioner": null, "AirConditionerType": null, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": null, "LowerPrice": 45.0, "Id": 1, "Name": "Toyota Yaris", "Category": null, "SIPP": null } ], "Id": 1, "Name": "Economy", "Order": 0.0, "PrincipalModelId": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "ImagePath": null }, "FromDate": "2026-09-25T13:58:00.2081424Z", "ToDate": "2026-09-28T13:58:00.2081424Z", "DeliveryPlace": { "Price": 0.0, "Name": "Airport Terminal 1", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 1 }, "ReturnPlace": { "Price": 0.0, "Name": "Downtown Branch", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 2 }, "TotalDaysString": "3 days", "Price": 299.99, "AgencyPrice": 269.99, "CustomerPrice": 30.0, "Currency": "USD", "Franchise": null, "FranchiseDamage": null, "FranchiseRollover": null, "FranchiseTheft": null, "FranchiseHail": null, "TotalDays": 0.0, "IlimitedKm": false, "MaxAllowedDistance": 0, "MaxAllowedDistanceByDay": 0, "HasFranchiseModifiers": false, "WillLeaveCountry": null, "AverageDayPrice": 0.0, "PriceItems": [ { "Id": 1, "IsBookingPrice": false, "Description": "Base Price", "Price": 200.0, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 1, "TariffName": null, "AppliedCoverageBrackets": [ { "DaysFrom": 1, "DaysTo": 2, "Amount": 200.0 } ] }, { "Id": 2, "IsBookingPrice": false, "Description": "Base Price", "Price": 69.99, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 1, "TariffName": null, "AppliedCoverageBrackets": [ { "DaysFrom": 3, "DaysTo": 3, "Amount": 69.99 } ] }, { "Id": 3, "IsBookingPrice": false, "Description": "Insurance", "Price": 30.0, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 0, "TariffName": null } ], "Additionals": [ { "Additional": { "Name": "GPS Navigation", "Description": null, "ImagePath": null, "IsPriceByDay": false, "Price": 29.99, "MaxQuantityPerBooking": 0, "Type": null, "Stock": 0, "Order": 0.0, "Id": 1 }, "Quantity": 1 } ], "AvailablePromotions": null, "CurrentStatus": 1, "CurrentStatusDate": "0001-01-01T00:00:00", "DeliveryTransportationId": null, "ReturnTransportationId": null, "IsCustomerOver25": false, "ExternalSystemId": null, "PrepaidAmount": 0.0, "ElegibleSIPPCodeUpgrade": null, "Attributes": {}, "ExchangeRate": null, "DailyRate": 0.0, "HourlyRate": 0.0, "ExtraDayRate": 0.0, "ExtraHourRate": 0.0, "RatePlan": null, "IsOnRequest": false, "DeliveryInfo": null, "DropoffInfo": null, "Origin": null, "CreationDate": "0001-01-01T00:00:00", "UpdatedOn": null, "UpdatedByUserName": null, "PayedByAgency": 0.0, "PayedByCustomer": 0.0, "CommercialAgreementCode": null, "PurchaseOrder": null, "Brand": null, "SalesCommision": 0.0, "IsTransfer": false, "PriceDetails": { "Price": 299.99, "CustomerPrice": 30.0, "AgencyPrice": 269.99, "SalesCommission": 0.0, "Currency": "USD" }, "Agency": null, "IsSelfCheckin": false, "Links": null, "DistanceUnit": "kilometers", "Code": null } } }, "x-expectedSchemas": [ { "description": "Creates a new booking", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Booking" } ] } }, { "description": "Creates a new booking", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BookingCreationResponse" } ] } } ] }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/booking/update": { "put": { "tags": [ "Bookings" ], "summary": "Update booking", "description": "Updates an existing booking **in place**: the booking keeps its id and history, and the main\nfield changes (dates, places, car or category, distance, transportation ids, agency, agreements\nand price) are audited as comments on the booking. This is a modify operation, not a\ncancel-and-rebook.\n \nDates, times, pickup/return places, car model or category, additionals, transportation ids\n(flight numbers) and price-related fields are updated directly and the price is recalculated\n(the same 1% tolerance as on creation applies when `Price` is sent). Under model-based\navailability the requested dates are re-validated, keeping the assigned vehicle when it is\nstill available; under category-based availability the category quota is only re-checked when\nthe category changes — date-only changes are applied without a new availability check.\n \nBooking status:\n- **Canceled** bookings are automatically reactivated. When the booking has an assigned vehicle\n (or availability is model based) its availability is validated and the request fails with\n `BookingStatusNotAllowUpdate` when no vehicle is available; category-based bookings with no\n assigned vehicle are reactivated without an availability check. Reactivation happens before\n the version validation, so a request later rejected by version may still have reactivated\n the booking.\n- **Delivered** and **Closed** bookings cannot be updated: the request fails with\n `BookingStatusNotAllowUpdate` and a warning comment is added to the booking.\n \nVersioning: when both the stored and the incoming `Version` are numeric, an incoming value\nlower than or equal to the stored one fails with `BookingVersionError` and a higher one is\napplied; when either value is missing or not numeric, no version check is performed and the\nupdate is applied.\n \nCustomer data: only `Customer.Name` and `Customer.EmailAddress` are updated, and only when the\ncustomer was created by the same API user making the request; otherwise customer changes are\nignored. Other customer fields (phone, age, documents, etc.) are never modified by this endpoint.\n \nAdditionals are synchronized with the request: optional additionals omitted from `Additionals`\nare removed from the booking, while required additionals and system-added ones (e.g. after-hours\ncharges) are re-applied automatically even when omitted.\n \nWhen `FullResponse` is true and the booking was priced by VDR coverage brackets, its rental lines billed per\nday may carry `AppliedCoverageBrackets`. Each of those lines declares a single range with its whole `Price`.\nSeveral lines of the same payer can declare the same range, and the total of that range is their sum. The\ndetail is left out of every line when the stored lines cannot be traced back to their ranges, for example\nafter an extension paid by a different payer. The simplified response never carries it.", "operationId": "Bookings_UpdateBooking", "requestBody": { "x-name": "bookingModel", "description": "The updated booking details", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/UpdateBookingModel" } ] }, "example": { "Customer": { "Id": 0, "GlobalId": "00000000-0000-0000-0000-000000000000", "Name": "John Doe", "Lastname": null, "Firstname": null, "DocumentId": "12345678", "DocumentTypeId": 2, "EmailAddress": "john.doe@example.com", "CellPhone": null, "Address": null, "AddressNumber": null, "AddressDepartment": null, "Country": null, "BirthDate": null, "CreditCards": [], "Memberships": [], "Age": 30, "DriverLicenceNumber": null, "DriverLicenceCountry": null, "DriverLicenseExpiration": null, "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": null, "FiscalConditionId": null, "Notes": null, "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": null, "State": null, "Region": null, "CommercialAgreements": [], "HasWebLogin": false, "IATACode": null, "BirthCountry": null, "BirthState": null, "DriverLicenseIssuance": null, "DriverLicenseState": null, "DocumentIdIssuance": null, "DocumentIdExpiration": null, "DocumentIdIssuanceState": null, "DocumentIdIssuanceCountry": null, "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null }, "Car": { "Id": null, "Model": { "Id": 1, "Name": null, "Category": null, "SIPP": "ECAR" } }, "Category": { "Id": 1, "Name": "" }, "FromDate": "2026-09-25T10:58:00.2216898-03:00", "ToDate": "2026-09-27T10:58:00.2222153-03:00", "DeliveryPlace": { "IsCustomAddress": false, "Address": null, "City": null, "Id": 1 }, "ReturnPlace": { "IsCustomAddress": false, "Address": null, "City": null, "Id": 1 }, "Additionals": [ { "Additional": { "Id": 1 }, "Quantity": 1 } ], "PriceItems": [], "Attributes": {}, "Origin": null, "Brand": null, "Agency": null, "Currency": "USD", "Price": 0.0, "Franchise": null, "FranchiseDamage": null, "FranchiseRollover": null, "FranchiseTheft": null, "FranchiseHail": null, "ExchangeRate": null, "Promotion": null, "PromotionCode": null, "CommercialAgreementCode": null, "ExternalSystemId": null, "PrepaidAmount": 0.0, "IsQuotation": false, "IsOnRequest": false, "Extra": null, "DeliveryTransportationId": null, "ReturnTransportationId": null, "ElegibleSIPPCodeUpgrade": null, "IlimitedKm": false, "MaxAllowedDistanceByDay": 0, "MaxAllowedDistance": 0, "DistanceUnit": null, "DailyRate": 0.0, "HourlyRate": 0.0, "ExtraDayRate": 0.0, "ExtraHourRate": 0.0, "RatePlan": null, "IsCustomerOver25": false, "Version": null, "CreationDate": "0001-01-01T00:00:00", "FullResponse": true, "IsFixedPrice": false, "IsPriceAllInclusive": false, "ForceExchangeRate": false, "CurrentLanguage": null, "Language": null } } }, "x-position": 1 }, "responses": { "200": { "description": "Updates an existing booking\nor\nUpdates an existing booking", "content": { "application/json": { "schema": {}, "example": { "Id": 1, "Version": null, "Customer": { "Id": 1, "GlobalId": "a84743c0-aaf7-43db-91f2-40edfc2618ca", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:00.2222153Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:00.2222153Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:00.2222153Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:00.2222153Z", "DocumentIdExpiration": "2036-09-24T13:58:00.2222153Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null }, "Balance": 0.0, "TotalPayed": 0.0, "Extra": null, "Promotion": null, "IsQuotation": false, "Car": { "Id": "CAR123", "Model": { "Description": "The Toyota Corolla is a reliable and fuel-efficient compact sedan with modern features and comfortable interior.", "ImagePath": "/images/models/corolla.jpg", "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 750.0, "FranchiseTheft": 1000.0, "FranchiseHail": 500.0, "Brand": { "Name": "Toyota" }, "Doors": 4, "Passengers": 5, "BigLuggage": 2, "SmallLuggage": 2, "Steering": "Power Steering", "SteeringType": 3, "Gearbox": "Automatic", "TransmissionType": 2, "Multimedia": "Bluetooth, Navigation System", "AirConditioner": "Automatic Climate Control", "AirConditionerType": 1, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": [ { "Id": 1, "Name": "Fuel Type", "Description": "Type of fuel used by the vehicle", "Type": 0, "Unit": "Type", "Value": "Gasoline", "ModelId": 1 }, { "Id": 2, "Name": "Engine Size", "Description": "Engine displacement", "Type": 1, "Unit": "Liters", "Value": "1.8", "ModelId": 1 }, { "Id": 3, "Name": "Transmission", "Description": "Type of transmission", "Type": 0, "Unit": "Type", "Value": "Automatic", "ModelId": 1 } ], "LowerPrice": 45.0, "Id": 1, "Name": "Corolla", "Category": { "Models": null, "Id": 1, "Name": "Economy", "Order": 1.0, "PrincipalModelId": null, "Franchise": 0.0, "FranchiseDamage": 0.0, "FranchiseRollover": 0.0, "FranchiseTheft": 0.0, "FranchiseHail": 0.0, "ImagePath": null }, "SIPP": "CDMR" }, "CurrentBranchOfficeId": 1, "CurrentBranchOffice": "LAX Branch", "BranchOfficeOwner": "Rently LAX Airport", "CurrentKms": 50000, "FuelType": "Gasoline", "Gasoline": 75, "FriendlyName": "Toyota Corolla 2023", "CurrentPlateId": "ABC123", "ChassisIdentification": "1HGCM82633A123456", "CurrentPlate": { "Id": "ABC123", "IssuingCountry": "United States", "IssuingState": "CA" }, "Color": "Silver", "Year": 2023, "TollDeviceId": "TOLL123", "BatteryNumber": "BAT123456", "CreationDate": "0001-01-01T00:00:00", "InactiveDate": null, "LeasedToCompany": null, "SupplierFullName": null, "LastReturnDate": null }, "Model": null, "Category": { "Models": [ { "Description": null, "ImagePath": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "Brand": { "Name": "Toyota" }, "Doors": 0, "Passengers": 0, "BigLuggage": 0, "SmallLuggage": 0, "Steering": null, "SteeringType": null, "Gearbox": null, "TransmissionType": null, "Multimedia": null, "AirConditioner": null, "AirConditionerType": null, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": null, "LowerPrice": 45.0, "Id": 1, "Name": "Toyota Yaris", "Category": null, "SIPP": null } ], "Id": 1, "Name": "Economy", "Order": 0.0, "PrincipalModelId": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "ImagePath": null }, "FromDate": "2026-09-25T13:58:00.2222153Z", "ToDate": "2026-09-28T13:58:00.2222153Z", "DeliveryPlace": { "Price": 0.0, "Name": "Airport Terminal 1", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 1 }, "ReturnPlace": { "Price": 0.0, "Name": "Downtown Branch", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 2 }, "TotalDaysString": "3 days", "Price": 299.99, "AgencyPrice": 269.99, "CustomerPrice": 30.0, "Currency": "USD", "Franchise": null, "FranchiseDamage": null, "FranchiseRollover": null, "FranchiseTheft": null, "FranchiseHail": null, "TotalDays": 0.0, "IlimitedKm": false, "MaxAllowedDistance": 0, "MaxAllowedDistanceByDay": 0, "HasFranchiseModifiers": false, "WillLeaveCountry": null, "AverageDayPrice": 0.0, "PriceItems": [ { "Id": 1, "IsBookingPrice": false, "Description": "Base Price", "Price": 200.0, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 1, "TariffName": null, "AppliedCoverageBrackets": [ { "DaysFrom": 1, "DaysTo": 2, "Amount": 200.0 } ] }, { "Id": 2, "IsBookingPrice": false, "Description": "Base Price", "Price": 69.99, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 1, "TariffName": null, "AppliedCoverageBrackets": [ { "DaysFrom": 3, "DaysTo": 3, "Amount": 69.99 } ] }, { "Id": 3, "IsBookingPrice": false, "Description": "Insurance", "Price": 30.0, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 0, "TariffName": null } ], "Additionals": [ { "Additional": { "Name": "GPS Navigation", "Description": null, "ImagePath": null, "IsPriceByDay": false, "Price": 29.99, "MaxQuantityPerBooking": 0, "Type": null, "Stock": 0, "Order": 0.0, "Id": 1 }, "Quantity": 1 } ], "AvailablePromotions": null, "CurrentStatus": 1, "CurrentStatusDate": "0001-01-01T00:00:00", "DeliveryTransportationId": null, "ReturnTransportationId": null, "IsCustomerOver25": false, "ExternalSystemId": null, "PrepaidAmount": 0.0, "ElegibleSIPPCodeUpgrade": null, "Attributes": {}, "ExchangeRate": null, "DailyRate": 0.0, "HourlyRate": 0.0, "ExtraDayRate": 0.0, "ExtraHourRate": 0.0, "RatePlan": null, "IsOnRequest": false, "DeliveryInfo": null, "DropoffInfo": null, "Origin": null, "CreationDate": "0001-01-01T00:00:00", "UpdatedOn": null, "UpdatedByUserName": null, "PayedByAgency": 0.0, "PayedByCustomer": 0.0, "CommercialAgreementCode": null, "PurchaseOrder": null, "Brand": null, "SalesCommision": 0.0, "IsTransfer": false, "PriceDetails": { "Price": 299.99, "CustomerPrice": 30.0, "AgencyPrice": 269.99, "SalesCommission": 0.0, "Currency": "USD" }, "Agency": null, "IsSelfCheckin": false, "Links": null, "DistanceUnit": "kilometers", "Code": null } } }, "x-expectedSchemas": [ { "description": "Updates an existing booking", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Booking" } ] } }, { "description": "Updates an existing booking", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BookingCreationResponse" } ] } } ] }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/booking/cancel": { "post": { "tags": [ "Bookings" ], "summary": "Cancel booking", "description": "Cancels a booking", "operationId": "Bookings_CancelBooking", "requestBody": { "x-name": "model", "description": "The cancellation details", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CancelBookingModel" } ] }, "example": { "FullResponse": true, "ExternalCancellationReason": null, "CancellationType": null, "BookingId": 12345, "Lastname": "Doe" } } }, "x-position": 1 }, "responses": { "200": { "description": "Cancels a booking", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Booking" }, "example": { "Id": 1, "Version": null, "Customer": { "Id": 1, "GlobalId": "14dc0ae0-e584-4b3c-82e9-54752fc93290", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:00.230363Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:00.230363Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:00.230363Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:00.230363Z", "DocumentIdExpiration": "2036-09-24T13:58:00.230363Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null }, "Balance": 0.0, "TotalPayed": 0.0, "Extra": null, "Promotion": null, "IsQuotation": false, "Car": { "Id": "CAR123", "Model": { "Description": "The Toyota Corolla is a reliable and fuel-efficient compact sedan with modern features and comfortable interior.", "ImagePath": "/images/models/corolla.jpg", "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 750.0, "FranchiseTheft": 1000.0, "FranchiseHail": 500.0, "Brand": { "Name": "Toyota" }, "Doors": 4, "Passengers": 5, "BigLuggage": 2, "SmallLuggage": 2, "Steering": "Power Steering", "SteeringType": 3, "Gearbox": "Automatic", "TransmissionType": 2, "Multimedia": "Bluetooth, Navigation System", "AirConditioner": "Automatic Climate Control", "AirConditionerType": 1, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": [ { "Id": 1, "Name": "Fuel Type", "Description": "Type of fuel used by the vehicle", "Type": 0, "Unit": "Type", "Value": "Gasoline", "ModelId": 1 }, { "Id": 2, "Name": "Engine Size", "Description": "Engine displacement", "Type": 1, "Unit": "Liters", "Value": "1.8", "ModelId": 1 }, { "Id": 3, "Name": "Transmission", "Description": "Type of transmission", "Type": 0, "Unit": "Type", "Value": "Automatic", "ModelId": 1 } ], "LowerPrice": 45.0, "Id": 1, "Name": "Corolla", "Category": { "Models": null, "Id": 1, "Name": "Economy", "Order": 1.0, "PrincipalModelId": null, "Franchise": 0.0, "FranchiseDamage": 0.0, "FranchiseRollover": 0.0, "FranchiseTheft": 0.0, "FranchiseHail": 0.0, "ImagePath": null }, "SIPP": "CDMR" }, "CurrentBranchOfficeId": 1, "CurrentBranchOffice": "LAX Branch", "BranchOfficeOwner": "Rently LAX Airport", "CurrentKms": 50000, "FuelType": "Gasoline", "Gasoline": 75, "FriendlyName": "Toyota Corolla 2023", "CurrentPlateId": "ABC123", "ChassisIdentification": "1HGCM82633A123456", "CurrentPlate": { "Id": "ABC123", "IssuingCountry": "United States", "IssuingState": "CA" }, "Color": "Silver", "Year": 2023, "TollDeviceId": "TOLL123", "BatteryNumber": "BAT123456", "CreationDate": "0001-01-01T00:00:00", "InactiveDate": null, "LeasedToCompany": null, "SupplierFullName": null, "LastReturnDate": null }, "Model": null, "Category": { "Models": [ { "Description": null, "ImagePath": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "Brand": { "Name": "Toyota" }, "Doors": 0, "Passengers": 0, "BigLuggage": 0, "SmallLuggage": 0, "Steering": null, "SteeringType": null, "Gearbox": null, "TransmissionType": null, "Multimedia": null, "AirConditioner": null, "AirConditionerType": null, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": null, "LowerPrice": 45.0, "Id": 1, "Name": "Toyota Yaris", "Category": null, "SIPP": null } ], "Id": 1, "Name": "Economy", "Order": 0.0, "PrincipalModelId": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "ImagePath": null }, "FromDate": "2026-09-25T13:58:00.230363Z", "ToDate": "2026-09-28T13:58:00.230363Z", "DeliveryPlace": { "Price": 0.0, "Name": "Airport Terminal 1", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 1 }, "ReturnPlace": { "Price": 0.0, "Name": "Downtown Branch", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 2 }, "TotalDaysString": "3 days", "Price": 299.99, "AgencyPrice": 269.99, "CustomerPrice": 30.0, "Currency": "USD", "Franchise": null, "FranchiseDamage": null, "FranchiseRollover": null, "FranchiseTheft": null, "FranchiseHail": null, "TotalDays": 0.0, "IlimitedKm": false, "MaxAllowedDistance": 0, "MaxAllowedDistanceByDay": 0, "HasFranchiseModifiers": false, "WillLeaveCountry": null, "AverageDayPrice": 0.0, "PriceItems": [ { "Id": 1, "IsBookingPrice": false, "Description": "Base Price", "Price": 269.99, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 1, "TariffName": null, "AppliedCoverageBrackets": [ { "DaysFrom": 1, "DaysTo": 2, "Amount": 200.0 }, { "DaysFrom": 3, "DaysTo": 3, "Amount": 69.99 } ] }, { "Id": 2, "IsBookingPrice": false, "Description": "Insurance", "Price": 30.0, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 0, "TariffName": null } ], "Additionals": [ { "Additional": { "Name": "GPS Navigation", "Description": null, "ImagePath": null, "IsPriceByDay": false, "Price": 29.99, "MaxQuantityPerBooking": 0, "Type": null, "Stock": 0, "Order": 0.0, "Id": 1 }, "Quantity": 1 } ], "AvailablePromotions": null, "CurrentStatus": 1, "CurrentStatusDate": "0001-01-01T00:00:00", "DeliveryTransportationId": null, "ReturnTransportationId": null, "IsCustomerOver25": false, "ExternalSystemId": null, "PrepaidAmount": 0.0, "ElegibleSIPPCodeUpgrade": null, "Attributes": {}, "ExchangeRate": null, "DailyRate": 0.0, "HourlyRate": 0.0, "ExtraDayRate": 0.0, "ExtraHourRate": 0.0, "RatePlan": null, "IsOnRequest": false, "DeliveryInfo": null, "DropoffInfo": null, "Origin": null, "CreationDate": "0001-01-01T00:00:00", "UpdatedOn": null, "UpdatedByUserName": null, "PayedByAgency": 0.0, "PayedByCustomer": 0.0, "CommercialAgreementCode": null, "PurchaseOrder": null, "Brand": null, "SalesCommision": 0.0, "IsTransfer": false, "PriceDetails": { "Price": 299.99, "CustomerPrice": 30.0, "AgencyPrice": 269.99, "SalesCommission": 0.0, "Currency": "USD" }, "Agency": null, "IsSelfCheckin": false, "Links": null, "DistanceUnit": "kilometers", "Code": null } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/booking/uncancel": { "post": { "tags": [ "Bookings" ], "summary": "Uncancel booking", "description": "Reactiva una reserva cancelada", "operationId": "Bookings_UncancelBooking", "requestBody": { "x-name": "model", "description": "Datos de la reserva a reactivar", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/UncancelBookingModel" } ] }, "example": { "BookingId": 12345 } } }, "x-position": 1 }, "responses": { "200": { "description": "Uncancels a booking", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Booking" }, "example": { "Id": 1, "Version": null, "Customer": { "Id": 1, "GlobalId": "c1b71d93-626c-477c-86f8-4d82e9f596bd", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:00.2639955Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:00.2639955Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:00.2639955Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:00.2639955Z", "DocumentIdExpiration": "2036-09-24T13:58:00.2639955Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null }, "Balance": 0.0, "TotalPayed": 0.0, "Extra": null, "Promotion": null, "IsQuotation": false, "Car": { "Id": "CAR123", "Model": { "Description": "The Toyota Corolla is a reliable and fuel-efficient compact sedan with modern features and comfortable interior.", "ImagePath": "/images/models/corolla.jpg", "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 750.0, "FranchiseTheft": 1000.0, "FranchiseHail": 500.0, "Brand": { "Name": "Toyota" }, "Doors": 4, "Passengers": 5, "BigLuggage": 2, "SmallLuggage": 2, "Steering": "Power Steering", "SteeringType": 3, "Gearbox": "Automatic", "TransmissionType": 2, "Multimedia": "Bluetooth, Navigation System", "AirConditioner": "Automatic Climate Control", "AirConditionerType": 1, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": [ { "Id": 1, "Name": "Fuel Type", "Description": "Type of fuel used by the vehicle", "Type": 0, "Unit": "Type", "Value": "Gasoline", "ModelId": 1 }, { "Id": 2, "Name": "Engine Size", "Description": "Engine displacement", "Type": 1, "Unit": "Liters", "Value": "1.8", "ModelId": 1 }, { "Id": 3, "Name": "Transmission", "Description": "Type of transmission", "Type": 0, "Unit": "Type", "Value": "Automatic", "ModelId": 1 } ], "LowerPrice": 45.0, "Id": 1, "Name": "Corolla", "Category": { "Models": null, "Id": 1, "Name": "Economy", "Order": 1.0, "PrincipalModelId": null, "Franchise": 0.0, "FranchiseDamage": 0.0, "FranchiseRollover": 0.0, "FranchiseTheft": 0.0, "FranchiseHail": 0.0, "ImagePath": null }, "SIPP": "CDMR" }, "CurrentBranchOfficeId": 1, "CurrentBranchOffice": "LAX Branch", "BranchOfficeOwner": "Rently LAX Airport", "CurrentKms": 50000, "FuelType": "Gasoline", "Gasoline": 75, "FriendlyName": "Toyota Corolla 2023", "CurrentPlateId": "ABC123", "ChassisIdentification": "1HGCM82633A123456", "CurrentPlate": { "Id": "ABC123", "IssuingCountry": "United States", "IssuingState": "CA" }, "Color": "Silver", "Year": 2023, "TollDeviceId": "TOLL123", "BatteryNumber": "BAT123456", "CreationDate": "0001-01-01T00:00:00", "InactiveDate": null, "LeasedToCompany": null, "SupplierFullName": null, "LastReturnDate": null }, "Model": null, "Category": { "Models": [ { "Description": null, "ImagePath": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "Brand": { "Name": "Toyota" }, "Doors": 0, "Passengers": 0, "BigLuggage": 0, "SmallLuggage": 0, "Steering": null, "SteeringType": null, "Gearbox": null, "TransmissionType": null, "Multimedia": null, "AirConditioner": null, "AirConditionerType": null, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": null, "LowerPrice": 45.0, "Id": 1, "Name": "Toyota Yaris", "Category": null, "SIPP": null } ], "Id": 1, "Name": "Economy", "Order": 0.0, "PrincipalModelId": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "ImagePath": null }, "FromDate": "2026-09-25T13:58:00.2639955Z", "ToDate": "2026-09-28T13:58:00.2639955Z", "DeliveryPlace": { "Price": 0.0, "Name": "Airport Terminal 1", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 1 }, "ReturnPlace": { "Price": 0.0, "Name": "Downtown Branch", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 2 }, "TotalDaysString": "3 days", "Price": 299.99, "AgencyPrice": 269.99, "CustomerPrice": 30.0, "Currency": "USD", "Franchise": null, "FranchiseDamage": null, "FranchiseRollover": null, "FranchiseTheft": null, "FranchiseHail": null, "TotalDays": 0.0, "IlimitedKm": false, "MaxAllowedDistance": 0, "MaxAllowedDistanceByDay": 0, "HasFranchiseModifiers": false, "WillLeaveCountry": null, "AverageDayPrice": 0.0, "PriceItems": [ { "Id": 1, "IsBookingPrice": false, "Description": "Base Price", "Price": 269.99, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 1, "TariffName": null, "AppliedCoverageBrackets": [ { "DaysFrom": 1, "DaysTo": 2, "Amount": 200.0 }, { "DaysFrom": 3, "DaysTo": 3, "Amount": 69.99 } ] }, { "Id": 2, "IsBookingPrice": false, "Description": "Insurance", "Price": 30.0, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 0, "TariffName": null } ], "Additionals": [ { "Additional": { "Name": "GPS Navigation", "Description": null, "ImagePath": null, "IsPriceByDay": false, "Price": 29.99, "MaxQuantityPerBooking": 0, "Type": null, "Stock": 0, "Order": 0.0, "Id": 1 }, "Quantity": 1 } ], "AvailablePromotions": null, "CurrentStatus": 1, "CurrentStatusDate": "0001-01-01T00:00:00", "DeliveryTransportationId": null, "ReturnTransportationId": null, "IsCustomerOver25": false, "ExternalSystemId": null, "PrepaidAmount": 0.0, "ElegibleSIPPCodeUpgrade": null, "Attributes": {}, "ExchangeRate": null, "DailyRate": 0.0, "HourlyRate": 0.0, "ExtraDayRate": 0.0, "ExtraHourRate": 0.0, "RatePlan": null, "IsOnRequest": false, "DeliveryInfo": null, "DropoffInfo": null, "Origin": null, "CreationDate": "0001-01-01T00:00:00", "UpdatedOn": null, "UpdatedByUserName": null, "PayedByAgency": 0.0, "PayedByCustomer": 0.0, "CommercialAgreementCode": null, "PurchaseOrder": null, "Brand": null, "SalesCommision": 0.0, "IsTransfer": false, "PriceDetails": { "Price": 299.99, "CustomerPrice": 30.0, "AgencyPrice": 269.99, "SalesCommission": 0.0, "Currency": "USD" }, "Agency": null, "IsSelfCheckin": false, "Links": null, "DistanceUnit": "kilometers", "Code": null } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/booking/external/cancel": { "post": { "tags": [ "Bookings" ], "summary": "Cancel booking by external ID", "description": "Cancels a booking by external system ID", "operationId": "Bookings_CancelExternalBooking", "requestBody": { "x-name": "model", "description": "The cancellation details", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CancelBookingExternalModel" } ] }, "example": { "ExternalBookingId": "abc123", "FullResponse": true } } }, "x-position": 1 }, "responses": { "200": { "description": "Cancels a booking by external system ID", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Booking" }, "example": { "Id": 1, "Version": null, "Customer": { "Id": 1, "GlobalId": "370c4f39-8080-44d1-b6f7-053c46360abb", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:00.2710159Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:00.2710159Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:00.2710159Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:00.2710159Z", "DocumentIdExpiration": "2036-09-24T13:58:00.2710159Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null }, "Balance": 0.0, "TotalPayed": 0.0, "Extra": null, "Promotion": null, "IsQuotation": false, "Car": { "Id": "CAR123", "Model": { "Description": "The Toyota Corolla is a reliable and fuel-efficient compact sedan with modern features and comfortable interior.", "ImagePath": "/images/models/corolla.jpg", "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 750.0, "FranchiseTheft": 1000.0, "FranchiseHail": 500.0, "Brand": { "Name": "Toyota" }, "Doors": 4, "Passengers": 5, "BigLuggage": 2, "SmallLuggage": 2, "Steering": "Power Steering", "SteeringType": 3, "Gearbox": "Automatic", "TransmissionType": 2, "Multimedia": "Bluetooth, Navigation System", "AirConditioner": "Automatic Climate Control", "AirConditionerType": 1, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": [ { "Id": 1, "Name": "Fuel Type", "Description": "Type of fuel used by the vehicle", "Type": 0, "Unit": "Type", "Value": "Gasoline", "ModelId": 1 }, { "Id": 2, "Name": "Engine Size", "Description": "Engine displacement", "Type": 1, "Unit": "Liters", "Value": "1.8", "ModelId": 1 }, { "Id": 3, "Name": "Transmission", "Description": "Type of transmission", "Type": 0, "Unit": "Type", "Value": "Automatic", "ModelId": 1 } ], "LowerPrice": 45.0, "Id": 1, "Name": "Corolla", "Category": { "Models": null, "Id": 1, "Name": "Economy", "Order": 1.0, "PrincipalModelId": null, "Franchise": 0.0, "FranchiseDamage": 0.0, "FranchiseRollover": 0.0, "FranchiseTheft": 0.0, "FranchiseHail": 0.0, "ImagePath": null }, "SIPP": "CDMR" }, "CurrentBranchOfficeId": 1, "CurrentBranchOffice": "LAX Branch", "BranchOfficeOwner": "Rently LAX Airport", "CurrentKms": 50000, "FuelType": "Gasoline", "Gasoline": 75, "FriendlyName": "Toyota Corolla 2023", "CurrentPlateId": "ABC123", "ChassisIdentification": "1HGCM82633A123456", "CurrentPlate": { "Id": "ABC123", "IssuingCountry": "United States", "IssuingState": "CA" }, "Color": "Silver", "Year": 2023, "TollDeviceId": "TOLL123", "BatteryNumber": "BAT123456", "CreationDate": "0001-01-01T00:00:00", "InactiveDate": null, "LeasedToCompany": null, "SupplierFullName": null, "LastReturnDate": null }, "Model": null, "Category": { "Models": [ { "Description": null, "ImagePath": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "Brand": { "Name": "Toyota" }, "Doors": 0, "Passengers": 0, "BigLuggage": 0, "SmallLuggage": 0, "Steering": null, "SteeringType": null, "Gearbox": null, "TransmissionType": null, "Multimedia": null, "AirConditioner": null, "AirConditionerType": null, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": null, "LowerPrice": 45.0, "Id": 1, "Name": "Toyota Yaris", "Category": null, "SIPP": null } ], "Id": 1, "Name": "Economy", "Order": 0.0, "PrincipalModelId": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "ImagePath": null }, "FromDate": "2026-09-25T13:58:00.2710159Z", "ToDate": "2026-09-28T13:58:00.2710159Z", "DeliveryPlace": { "Price": 0.0, "Name": "Airport Terminal 1", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 1 }, "ReturnPlace": { "Price": 0.0, "Name": "Downtown Branch", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 2 }, "TotalDaysString": "3 days", "Price": 299.99, "AgencyPrice": 269.99, "CustomerPrice": 30.0, "Currency": "USD", "Franchise": null, "FranchiseDamage": null, "FranchiseRollover": null, "FranchiseTheft": null, "FranchiseHail": null, "TotalDays": 0.0, "IlimitedKm": false, "MaxAllowedDistance": 0, "MaxAllowedDistanceByDay": 0, "HasFranchiseModifiers": false, "WillLeaveCountry": null, "AverageDayPrice": 0.0, "PriceItems": [ { "Id": 1, "IsBookingPrice": false, "Description": "Base Price", "Price": 269.99, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 1, "TariffName": null, "AppliedCoverageBrackets": [ { "DaysFrom": 1, "DaysTo": 2, "Amount": 200.0 }, { "DaysFrom": 3, "DaysTo": 3, "Amount": 69.99 } ] }, { "Id": 2, "IsBookingPrice": false, "Description": "Insurance", "Price": 30.0, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 0, "TariffName": null } ], "Additionals": [ { "Additional": { "Name": "GPS Navigation", "Description": null, "ImagePath": null, "IsPriceByDay": false, "Price": 29.99, "MaxQuantityPerBooking": 0, "Type": null, "Stock": 0, "Order": 0.0, "Id": 1 }, "Quantity": 1 } ], "AvailablePromotions": null, "CurrentStatus": 1, "CurrentStatusDate": "0001-01-01T00:00:00", "DeliveryTransportationId": null, "ReturnTransportationId": null, "IsCustomerOver25": false, "ExternalSystemId": null, "PrepaidAmount": 0.0, "ElegibleSIPPCodeUpgrade": null, "Attributes": {}, "ExchangeRate": null, "DailyRate": 0.0, "HourlyRate": 0.0, "ExtraDayRate": 0.0, "ExtraHourRate": 0.0, "RatePlan": null, "IsOnRequest": false, "DeliveryInfo": null, "DropoffInfo": null, "Origin": null, "CreationDate": "0001-01-01T00:00:00", "UpdatedOn": null, "UpdatedByUserName": null, "PayedByAgency": 0.0, "PayedByCustomer": 0.0, "CommercialAgreementCode": null, "PurchaseOrder": null, "Brand": null, "SalesCommision": 0.0, "IsTransfer": false, "PriceDetails": { "Price": 299.99, "CustomerPrice": 30.0, "AgencyPrice": 269.99, "SalesCommission": 0.0, "Currency": "USD" }, "Agency": null, "IsSelfCheckin": false, "Links": null, "DistanceUnit": "kilometers", "Code": null } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/booking/reserve": { "post": { "tags": [ "Bookings" ], "summary": "Reserve booking", "description": "Changes a booking status to Reserved", "operationId": "Bookings_ReserveBooking", "requestBody": { "x-name": "model", "description": "The reservation details", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ReserveBookingModel" } ] }, "example": { "FullResponse": true, "ExternalCancellationReason": null, "CancellationType": null, "BookingId": 12345, "Lastname": "Doe" } } }, "x-position": 1 }, "responses": { "200": { "description": "Changes a booking status to Reserved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Booking" }, "example": { "Id": 1, "Version": null, "Customer": { "Id": 1, "GlobalId": "45685b6d-ce6b-490e-8f87-0a7e162833c7", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:00.2755659Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:00.2755659Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:00.2755659Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:00.2755659Z", "DocumentIdExpiration": "2036-09-24T13:58:00.2755659Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null }, "Balance": 0.0, "TotalPayed": 0.0, "Extra": null, "Promotion": null, "IsQuotation": false, "Car": { "Id": "CAR123", "Model": { "Description": "The Toyota Corolla is a reliable and fuel-efficient compact sedan with modern features and comfortable interior.", "ImagePath": "/images/models/corolla.jpg", "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 750.0, "FranchiseTheft": 1000.0, "FranchiseHail": 500.0, "Brand": { "Name": "Toyota" }, "Doors": 4, "Passengers": 5, "BigLuggage": 2, "SmallLuggage": 2, "Steering": "Power Steering", "SteeringType": 3, "Gearbox": "Automatic", "TransmissionType": 2, "Multimedia": "Bluetooth, Navigation System", "AirConditioner": "Automatic Climate Control", "AirConditionerType": 1, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": [ { "Id": 1, "Name": "Fuel Type", "Description": "Type of fuel used by the vehicle", "Type": 0, "Unit": "Type", "Value": "Gasoline", "ModelId": 1 }, { "Id": 2, "Name": "Engine Size", "Description": "Engine displacement", "Type": 1, "Unit": "Liters", "Value": "1.8", "ModelId": 1 }, { "Id": 3, "Name": "Transmission", "Description": "Type of transmission", "Type": 0, "Unit": "Type", "Value": "Automatic", "ModelId": 1 } ], "LowerPrice": 45.0, "Id": 1, "Name": "Corolla", "Category": { "Models": null, "Id": 1, "Name": "Economy", "Order": 1.0, "PrincipalModelId": null, "Franchise": 0.0, "FranchiseDamage": 0.0, "FranchiseRollover": 0.0, "FranchiseTheft": 0.0, "FranchiseHail": 0.0, "ImagePath": null }, "SIPP": "CDMR" }, "CurrentBranchOfficeId": 1, "CurrentBranchOffice": "LAX Branch", "BranchOfficeOwner": "Rently LAX Airport", "CurrentKms": 50000, "FuelType": "Gasoline", "Gasoline": 75, "FriendlyName": "Toyota Corolla 2023", "CurrentPlateId": "ABC123", "ChassisIdentification": "1HGCM82633A123456", "CurrentPlate": { "Id": "ABC123", "IssuingCountry": "United States", "IssuingState": "CA" }, "Color": "Silver", "Year": 2023, "TollDeviceId": "TOLL123", "BatteryNumber": "BAT123456", "CreationDate": "0001-01-01T00:00:00", "InactiveDate": null, "LeasedToCompany": null, "SupplierFullName": null, "LastReturnDate": null }, "Model": null, "Category": { "Models": [ { "Description": null, "ImagePath": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "Brand": { "Name": "Toyota" }, "Doors": 0, "Passengers": 0, "BigLuggage": 0, "SmallLuggage": 0, "Steering": null, "SteeringType": null, "Gearbox": null, "TransmissionType": null, "Multimedia": null, "AirConditioner": null, "AirConditionerType": null, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": null, "LowerPrice": 45.0, "Id": 1, "Name": "Toyota Yaris", "Category": null, "SIPP": null } ], "Id": 1, "Name": "Economy", "Order": 0.0, "PrincipalModelId": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "ImagePath": null }, "FromDate": "2026-09-25T13:58:00.2755659Z", "ToDate": "2026-09-28T13:58:00.2755659Z", "DeliveryPlace": { "Price": 0.0, "Name": "Airport Terminal 1", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 1 }, "ReturnPlace": { "Price": 0.0, "Name": "Downtown Branch", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 2 }, "TotalDaysString": "3 days", "Price": 299.99, "AgencyPrice": 269.99, "CustomerPrice": 30.0, "Currency": "USD", "Franchise": null, "FranchiseDamage": null, "FranchiseRollover": null, "FranchiseTheft": null, "FranchiseHail": null, "TotalDays": 0.0, "IlimitedKm": false, "MaxAllowedDistance": 0, "MaxAllowedDistanceByDay": 0, "HasFranchiseModifiers": false, "WillLeaveCountry": null, "AverageDayPrice": 0.0, "PriceItems": [ { "Id": 1, "IsBookingPrice": false, "Description": "Base Price", "Price": 269.99, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 1, "TariffName": null, "AppliedCoverageBrackets": [ { "DaysFrom": 1, "DaysTo": 2, "Amount": 200.0 }, { "DaysFrom": 3, "DaysTo": 3, "Amount": 69.99 } ] }, { "Id": 2, "IsBookingPrice": false, "Description": "Insurance", "Price": 30.0, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 0, "TariffName": null } ], "Additionals": [ { "Additional": { "Name": "GPS Navigation", "Description": null, "ImagePath": null, "IsPriceByDay": false, "Price": 29.99, "MaxQuantityPerBooking": 0, "Type": null, "Stock": 0, "Order": 0.0, "Id": 1 }, "Quantity": 1 } ], "AvailablePromotions": null, "CurrentStatus": 1, "CurrentStatusDate": "0001-01-01T00:00:00", "DeliveryTransportationId": null, "ReturnTransportationId": null, "IsCustomerOver25": false, "ExternalSystemId": null, "PrepaidAmount": 0.0, "ElegibleSIPPCodeUpgrade": null, "Attributes": {}, "ExchangeRate": null, "DailyRate": 0.0, "HourlyRate": 0.0, "ExtraDayRate": 0.0, "ExtraHourRate": 0.0, "RatePlan": null, "IsOnRequest": false, "DeliveryInfo": null, "DropoffInfo": null, "Origin": null, "CreationDate": "0001-01-01T00:00:00", "UpdatedOn": null, "UpdatedByUserName": null, "PayedByAgency": 0.0, "PayedByCustomer": 0.0, "CommercialAgreementCode": null, "PurchaseOrder": null, "Brand": null, "SalesCommision": 0.0, "IsTransfer": false, "PriceDetails": { "Price": 299.99, "CustomerPrice": 30.0, "AgencyPrice": 269.99, "SalesCommission": 0.0, "Currency": "USD" }, "Agency": null, "IsSelfCheckin": false, "Links": null, "DistanceUnit": "kilometers", "Code": null } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/booking/{bookingId}": { "get": { "tags": [ "Bookings" ], "summary": "Get booking", "description": "Gets a booking by ID", "operationId": "Bookings_GetBooking", "parameters": [ { "name": "bookingId", "in": "path", "required": true, "description": "The booking ID", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "Gets a booking by ID", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Booking" }, "example": { "Id": 1, "Version": null, "Customer": { "Id": 1, "GlobalId": "3dc904f7-8edf-4713-b38a-a43ed2c34243", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:00.2805682Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:00.2805682Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:00.2805682Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:00.2805682Z", "DocumentIdExpiration": "2036-09-24T13:58:00.2805682Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null }, "Balance": 0.0, "TotalPayed": 0.0, "Extra": null, "Promotion": null, "IsQuotation": false, "Car": { "Id": "CAR123", "Model": { "Description": "The Toyota Corolla is a reliable and fuel-efficient compact sedan with modern features and comfortable interior.", "ImagePath": "/images/models/corolla.jpg", "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 750.0, "FranchiseTheft": 1000.0, "FranchiseHail": 500.0, "Brand": { "Name": "Toyota" }, "Doors": 4, "Passengers": 5, "BigLuggage": 2, "SmallLuggage": 2, "Steering": "Power Steering", "SteeringType": 3, "Gearbox": "Automatic", "TransmissionType": 2, "Multimedia": "Bluetooth, Navigation System", "AirConditioner": "Automatic Climate Control", "AirConditionerType": 1, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": [ { "Id": 1, "Name": "Fuel Type", "Description": "Type of fuel used by the vehicle", "Type": 0, "Unit": "Type", "Value": "Gasoline", "ModelId": 1 }, { "Id": 2, "Name": "Engine Size", "Description": "Engine displacement", "Type": 1, "Unit": "Liters", "Value": "1.8", "ModelId": 1 }, { "Id": 3, "Name": "Transmission", "Description": "Type of transmission", "Type": 0, "Unit": "Type", "Value": "Automatic", "ModelId": 1 } ], "LowerPrice": 45.0, "Id": 1, "Name": "Corolla", "Category": { "Models": null, "Id": 1, "Name": "Economy", "Order": 1.0, "PrincipalModelId": null, "Franchise": 0.0, "FranchiseDamage": 0.0, "FranchiseRollover": 0.0, "FranchiseTheft": 0.0, "FranchiseHail": 0.0, "ImagePath": null }, "SIPP": "CDMR" }, "CurrentBranchOfficeId": 1, "CurrentBranchOffice": "LAX Branch", "BranchOfficeOwner": "Rently LAX Airport", "CurrentKms": 50000, "FuelType": "Gasoline", "Gasoline": 75, "FriendlyName": "Toyota Corolla 2023", "CurrentPlateId": "ABC123", "ChassisIdentification": "1HGCM82633A123456", "CurrentPlate": { "Id": "ABC123", "IssuingCountry": "United States", "IssuingState": "CA" }, "Color": "Silver", "Year": 2023, "TollDeviceId": "TOLL123", "BatteryNumber": "BAT123456", "CreationDate": "0001-01-01T00:00:00", "InactiveDate": null, "LeasedToCompany": null, "SupplierFullName": null, "LastReturnDate": null }, "Model": null, "Category": { "Models": [ { "Description": null, "ImagePath": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "Brand": { "Name": "Toyota" }, "Doors": 0, "Passengers": 0, "BigLuggage": 0, "SmallLuggage": 0, "Steering": null, "SteeringType": null, "Gearbox": null, "TransmissionType": null, "Multimedia": null, "AirConditioner": null, "AirConditionerType": null, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": null, "LowerPrice": 45.0, "Id": 1, "Name": "Toyota Yaris", "Category": null, "SIPP": null } ], "Id": 1, "Name": "Economy", "Order": 0.0, "PrincipalModelId": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "ImagePath": null }, "FromDate": "2026-09-25T13:58:00.2805682Z", "ToDate": "2026-09-28T13:58:00.2805682Z", "DeliveryPlace": { "Price": 0.0, "Name": "Airport Terminal 1", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 1 }, "ReturnPlace": { "Price": 0.0, "Name": "Downtown Branch", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 2 }, "TotalDaysString": "3 days", "Price": 299.99, "AgencyPrice": 269.99, "CustomerPrice": 30.0, "Currency": "USD", "Franchise": null, "FranchiseDamage": null, "FranchiseRollover": null, "FranchiseTheft": null, "FranchiseHail": null, "TotalDays": 0.0, "IlimitedKm": false, "MaxAllowedDistance": 0, "MaxAllowedDistanceByDay": 0, "HasFranchiseModifiers": false, "WillLeaveCountry": null, "AverageDayPrice": 0.0, "PriceItems": [ { "Id": 1, "IsBookingPrice": false, "Description": "Base Price", "Price": 269.99, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 1, "TariffName": null, "AppliedCoverageBrackets": [ { "DaysFrom": 1, "DaysTo": 2, "Amount": 200.0 }, { "DaysFrom": 3, "DaysTo": 3, "Amount": 69.99 } ] }, { "Id": 2, "IsBookingPrice": false, "Description": "Insurance", "Price": 30.0, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 0, "TariffName": null } ], "Additionals": [ { "Additional": { "Name": "GPS Navigation", "Description": null, "ImagePath": null, "IsPriceByDay": false, "Price": 29.99, "MaxQuantityPerBooking": 0, "Type": null, "Stock": 0, "Order": 0.0, "Id": 1 }, "Quantity": 1 } ], "AvailablePromotions": null, "CurrentStatus": 1, "CurrentStatusDate": "0001-01-01T00:00:00", "DeliveryTransportationId": null, "ReturnTransportationId": null, "IsCustomerOver25": false, "ExternalSystemId": null, "PrepaidAmount": 0.0, "ElegibleSIPPCodeUpgrade": null, "Attributes": {}, "ExchangeRate": null, "DailyRate": 0.0, "HourlyRate": 0.0, "ExtraDayRate": 0.0, "ExtraHourRate": 0.0, "RatePlan": null, "IsOnRequest": false, "DeliveryInfo": null, "DropoffInfo": null, "Origin": null, "CreationDate": "0001-01-01T00:00:00", "UpdatedOn": null, "UpdatedByUserName": null, "PayedByAgency": 0.0, "PayedByCustomer": 0.0, "CommercialAgreementCode": null, "PurchaseOrder": null, "Brand": null, "SalesCommision": 0.0, "IsTransfer": false, "PriceDetails": { "Price": 299.99, "CustomerPrice": 30.0, "AgencyPrice": 269.99, "SalesCommission": 0.0, "Currency": "USD" }, "Agency": null, "IsSelfCheckin": false, "Links": null, "DistanceUnit": "kilometers", "Code": null } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/bookingWithPromotion/{bookingId}": { "get": { "tags": [ "Bookings" ], "summary": "Get booking with promotion", "description": "Gets a booking with promotion applied", "operationId": "Bookings_GetBookingWithPromotion", "parameters": [ { "name": "bookingId", "in": "path", "required": true, "description": "The booking ID", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "promotionId", "in": "query", "required": true, "description": "The promotion ID to apply", "schema": { "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "Gets a booking with promotion applied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Booking" }, "example": { "Id": 1, "Version": null, "Customer": { "Id": 1, "GlobalId": "afc05b2d-ebae-4364-8552-58f5d1e0f319", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:00.2840938Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:00.2840938Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:00.2840938Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:00.2840938Z", "DocumentIdExpiration": "2036-09-24T13:58:00.2840938Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null }, "Balance": 0.0, "TotalPayed": 0.0, "Extra": null, "Promotion": null, "IsQuotation": false, "Car": { "Id": "CAR123", "Model": { "Description": "The Toyota Corolla is a reliable and fuel-efficient compact sedan with modern features and comfortable interior.", "ImagePath": "/images/models/corolla.jpg", "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 750.0, "FranchiseTheft": 1000.0, "FranchiseHail": 500.0, "Brand": { "Name": "Toyota" }, "Doors": 4, "Passengers": 5, "BigLuggage": 2, "SmallLuggage": 2, "Steering": "Power Steering", "SteeringType": 3, "Gearbox": "Automatic", "TransmissionType": 2, "Multimedia": "Bluetooth, Navigation System", "AirConditioner": "Automatic Climate Control", "AirConditionerType": 1, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": [ { "Id": 1, "Name": "Fuel Type", "Description": "Type of fuel used by the vehicle", "Type": 0, "Unit": "Type", "Value": "Gasoline", "ModelId": 1 }, { "Id": 2, "Name": "Engine Size", "Description": "Engine displacement", "Type": 1, "Unit": "Liters", "Value": "1.8", "ModelId": 1 }, { "Id": 3, "Name": "Transmission", "Description": "Type of transmission", "Type": 0, "Unit": "Type", "Value": "Automatic", "ModelId": 1 } ], "LowerPrice": 45.0, "Id": 1, "Name": "Corolla", "Category": { "Models": null, "Id": 1, "Name": "Economy", "Order": 1.0, "PrincipalModelId": null, "Franchise": 0.0, "FranchiseDamage": 0.0, "FranchiseRollover": 0.0, "FranchiseTheft": 0.0, "FranchiseHail": 0.0, "ImagePath": null }, "SIPP": "CDMR" }, "CurrentBranchOfficeId": 1, "CurrentBranchOffice": "LAX Branch", "BranchOfficeOwner": "Rently LAX Airport", "CurrentKms": 50000, "FuelType": "Gasoline", "Gasoline": 75, "FriendlyName": "Toyota Corolla 2023", "CurrentPlateId": "ABC123", "ChassisIdentification": "1HGCM82633A123456", "CurrentPlate": { "Id": "ABC123", "IssuingCountry": "United States", "IssuingState": "CA" }, "Color": "Silver", "Year": 2023, "TollDeviceId": "TOLL123", "BatteryNumber": "BAT123456", "CreationDate": "0001-01-01T00:00:00", "InactiveDate": null, "LeasedToCompany": null, "SupplierFullName": null, "LastReturnDate": null }, "Model": null, "Category": { "Models": [ { "Description": null, "ImagePath": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "Brand": { "Name": "Toyota" }, "Doors": 0, "Passengers": 0, "BigLuggage": 0, "SmallLuggage": 0, "Steering": null, "SteeringType": null, "Gearbox": null, "TransmissionType": null, "Multimedia": null, "AirConditioner": null, "AirConditionerType": null, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": null, "LowerPrice": 45.0, "Id": 1, "Name": "Toyota Yaris", "Category": null, "SIPP": null } ], "Id": 1, "Name": "Economy", "Order": 0.0, "PrincipalModelId": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "ImagePath": null }, "FromDate": "2026-09-25T13:58:00.2840938Z", "ToDate": "2026-09-28T13:58:00.2840938Z", "DeliveryPlace": { "Price": 0.0, "Name": "Airport Terminal 1", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 1 }, "ReturnPlace": { "Price": 0.0, "Name": "Downtown Branch", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 2 }, "TotalDaysString": "3 days", "Price": 299.99, "AgencyPrice": 269.99, "CustomerPrice": 30.0, "Currency": "USD", "Franchise": null, "FranchiseDamage": null, "FranchiseRollover": null, "FranchiseTheft": null, "FranchiseHail": null, "TotalDays": 0.0, "IlimitedKm": false, "MaxAllowedDistance": 0, "MaxAllowedDistanceByDay": 0, "HasFranchiseModifiers": false, "WillLeaveCountry": null, "AverageDayPrice": 0.0, "PriceItems": [ { "Id": 1, "IsBookingPrice": false, "Description": "Base Price", "Price": 269.99, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 1, "TariffName": null, "AppliedCoverageBrackets": [ { "DaysFrom": 1, "DaysTo": 2, "Amount": 200.0 }, { "DaysFrom": 3, "DaysTo": 3, "Amount": 69.99 } ] }, { "Id": 2, "IsBookingPrice": false, "Description": "Insurance", "Price": 30.0, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 0, "TariffName": null } ], "Additionals": [ { "Additional": { "Name": "GPS Navigation", "Description": null, "ImagePath": null, "IsPriceByDay": false, "Price": 29.99, "MaxQuantityPerBooking": 0, "Type": null, "Stock": 0, "Order": 0.0, "Id": 1 }, "Quantity": 1 } ], "AvailablePromotions": null, "CurrentStatus": 1, "CurrentStatusDate": "0001-01-01T00:00:00", "DeliveryTransportationId": null, "ReturnTransportationId": null, "IsCustomerOver25": false, "ExternalSystemId": null, "PrepaidAmount": 0.0, "ElegibleSIPPCodeUpgrade": null, "Attributes": {}, "ExchangeRate": null, "DailyRate": 0.0, "HourlyRate": 0.0, "ExtraDayRate": 0.0, "ExtraHourRate": 0.0, "RatePlan": null, "IsOnRequest": false, "DeliveryInfo": null, "DropoffInfo": null, "Origin": null, "CreationDate": "0001-01-01T00:00:00", "UpdatedOn": null, "UpdatedByUserName": null, "PayedByAgency": 0.0, "PayedByCustomer": 0.0, "CommercialAgreementCode": null, "PurchaseOrder": null, "Brand": null, "SalesCommision": 0.0, "IsTransfer": false, "PriceDetails": { "Price": 299.99, "CustomerPrice": 30.0, "AgencyPrice": 269.99, "SalesCommission": 0.0, "Currency": "USD" }, "Agency": null, "IsSelfCheckin": false, "Links": null, "DistanceUnit": "kilometers", "Code": null } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/booking/{bookingId}/applypromotion": { "post": { "tags": [ "Bookings" ], "summary": "Apply promotion to booking", "description": "Applies a promotion to a booking", "operationId": "Bookings_ApplyPromotionToBooking", "parameters": [ { "name": "bookingId", "in": "path", "required": true, "description": "The booking ID", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "promotionId", "in": "query", "required": true, "description": "The promotion ID to apply", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 } ], "responses": { "200": { "description": "Applies a promotion to a booking", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Booking" }, "example": { "Id": 1, "Version": null, "Customer": { "Id": 1, "GlobalId": "44791090-f0c2-43fe-b810-91d222808e13", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:00.2866116Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:00.2866116Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:00.2866116Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:00.2866116Z", "DocumentIdExpiration": "2036-09-24T13:58:00.2866116Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null }, "Balance": 0.0, "TotalPayed": 0.0, "Extra": null, "Promotion": null, "IsQuotation": false, "Car": { "Id": "CAR123", "Model": { "Description": "The Toyota Corolla is a reliable and fuel-efficient compact sedan with modern features and comfortable interior.", "ImagePath": "/images/models/corolla.jpg", "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 750.0, "FranchiseTheft": 1000.0, "FranchiseHail": 500.0, "Brand": { "Name": "Toyota" }, "Doors": 4, "Passengers": 5, "BigLuggage": 2, "SmallLuggage": 2, "Steering": "Power Steering", "SteeringType": 3, "Gearbox": "Automatic", "TransmissionType": 2, "Multimedia": "Bluetooth, Navigation System", "AirConditioner": "Automatic Climate Control", "AirConditionerType": 1, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": [ { "Id": 1, "Name": "Fuel Type", "Description": "Type of fuel used by the vehicle", "Type": 0, "Unit": "Type", "Value": "Gasoline", "ModelId": 1 }, { "Id": 2, "Name": "Engine Size", "Description": "Engine displacement", "Type": 1, "Unit": "Liters", "Value": "1.8", "ModelId": 1 }, { "Id": 3, "Name": "Transmission", "Description": "Type of transmission", "Type": 0, "Unit": "Type", "Value": "Automatic", "ModelId": 1 } ], "LowerPrice": 45.0, "Id": 1, "Name": "Corolla", "Category": { "Models": null, "Id": 1, "Name": "Economy", "Order": 1.0, "PrincipalModelId": null, "Franchise": 0.0, "FranchiseDamage": 0.0, "FranchiseRollover": 0.0, "FranchiseTheft": 0.0, "FranchiseHail": 0.0, "ImagePath": null }, "SIPP": "CDMR" }, "CurrentBranchOfficeId": 1, "CurrentBranchOffice": "LAX Branch", "BranchOfficeOwner": "Rently LAX Airport", "CurrentKms": 50000, "FuelType": "Gasoline", "Gasoline": 75, "FriendlyName": "Toyota Corolla 2023", "CurrentPlateId": "ABC123", "ChassisIdentification": "1HGCM82633A123456", "CurrentPlate": { "Id": "ABC123", "IssuingCountry": "United States", "IssuingState": "CA" }, "Color": "Silver", "Year": 2023, "TollDeviceId": "TOLL123", "BatteryNumber": "BAT123456", "CreationDate": "0001-01-01T00:00:00", "InactiveDate": null, "LeasedToCompany": null, "SupplierFullName": null, "LastReturnDate": null }, "Model": null, "Category": { "Models": [ { "Description": null, "ImagePath": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "Brand": { "Name": "Toyota" }, "Doors": 0, "Passengers": 0, "BigLuggage": 0, "SmallLuggage": 0, "Steering": null, "SteeringType": null, "Gearbox": null, "TransmissionType": null, "Multimedia": null, "AirConditioner": null, "AirConditionerType": null, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": null, "LowerPrice": 45.0, "Id": 1, "Name": "Toyota Yaris", "Category": null, "SIPP": null } ], "Id": 1, "Name": "Economy", "Order": 0.0, "PrincipalModelId": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "ImagePath": null }, "FromDate": "2026-09-25T13:58:00.2866116Z", "ToDate": "2026-09-28T13:58:00.2866116Z", "DeliveryPlace": { "Price": 0.0, "Name": "Airport Terminal 1", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 1 }, "ReturnPlace": { "Price": 0.0, "Name": "Downtown Branch", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 2 }, "TotalDaysString": "3 days", "Price": 299.99, "AgencyPrice": 269.99, "CustomerPrice": 30.0, "Currency": "USD", "Franchise": null, "FranchiseDamage": null, "FranchiseRollover": null, "FranchiseTheft": null, "FranchiseHail": null, "TotalDays": 0.0, "IlimitedKm": false, "MaxAllowedDistance": 0, "MaxAllowedDistanceByDay": 0, "HasFranchiseModifiers": false, "WillLeaveCountry": null, "AverageDayPrice": 0.0, "PriceItems": [ { "Id": 1, "IsBookingPrice": false, "Description": "Base Price", "Price": 269.99, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 1, "TariffName": null, "AppliedCoverageBrackets": [ { "DaysFrom": 1, "DaysTo": 2, "Amount": 200.0 }, { "DaysFrom": 3, "DaysTo": 3, "Amount": 69.99 } ] }, { "Id": 2, "IsBookingPrice": false, "Description": "Insurance", "Price": 30.0, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 0, "TariffName": null } ], "Additionals": [ { "Additional": { "Name": "GPS Navigation", "Description": null, "ImagePath": null, "IsPriceByDay": false, "Price": 29.99, "MaxQuantityPerBooking": 0, "Type": null, "Stock": 0, "Order": 0.0, "Id": 1 }, "Quantity": 1 } ], "AvailablePromotions": null, "CurrentStatus": 1, "CurrentStatusDate": "0001-01-01T00:00:00", "DeliveryTransportationId": null, "ReturnTransportationId": null, "IsCustomerOver25": false, "ExternalSystemId": null, "PrepaidAmount": 0.0, "ElegibleSIPPCodeUpgrade": null, "Attributes": {}, "ExchangeRate": null, "DailyRate": 0.0, "HourlyRate": 0.0, "ExtraDayRate": 0.0, "ExtraHourRate": 0.0, "RatePlan": null, "IsOnRequest": false, "DeliveryInfo": null, "DropoffInfo": null, "Origin": null, "CreationDate": "0001-01-01T00:00:00", "UpdatedOn": null, "UpdatedByUserName": null, "PayedByAgency": 0.0, "PayedByCustomer": 0.0, "CommercialAgreementCode": null, "PurchaseOrder": null, "Brand": null, "SalesCommision": 0.0, "IsTransfer": false, "PriceDetails": { "Price": 299.99, "CustomerPrice": 30.0, "AgencyPrice": 269.99, "SalesCommission": 0.0, "Currency": "USD" }, "Agency": null, "IsSelfCheckin": false, "Links": null, "DistanceUnit": "kilometers", "Code": null } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/booking/{bookingId}/external-system-id": { "post": { "tags": [ "Bookings" ], "summary": "Set booking external ID", "description": "Requires the CanAccessAdminApi permission, and the booking must belong to the authenticated user and have been\ncreated by an external system. The identifier can only be set once: the request fails if the booking already has\nan external system identifier, or if the provided value is already used by another non-cancelled booking.", "operationId": "Bookings_UpdateExternalSystemId", "parameters": [ { "name": "bookingId", "in": "path", "required": true, "description": "The internal identifier of the booking to update.", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "requestBody": { "x-name": "model", "description": "The payload containing the external system identifier to assign.", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/UpdateExternalSystemIdModel" } ] }, "example": { "ExternalSystemId": "EXT-123456" } } }, "x-position": 2 }, "responses": { "200": { "description": "Updates the ExternalSystemId of a booking created by an external system" }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/booking/external/{bookingId}": { "get": { "tags": [ "Bookings" ], "summary": "Get booking by external ID", "description": "Gets a booking by external system ID", "operationId": "Bookings_GetBookingExternal", "parameters": [ { "name": "bookingId", "in": "path", "required": true, "description": "The external system booking ID", "schema": { "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Gets a booking by external system ID", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Booking" }, "example": { "Id": 1, "Version": null, "Customer": { "Id": 1, "GlobalId": "e4b7f168-44cb-4972-91d6-518fdb588639", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:00.2941679Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:00.2941679Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:00.2941679Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:00.2941679Z", "DocumentIdExpiration": "2036-09-24T13:58:00.2941679Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null }, "Balance": 0.0, "TotalPayed": 0.0, "Extra": null, "Promotion": null, "IsQuotation": false, "Car": { "Id": "CAR123", "Model": { "Description": "The Toyota Corolla is a reliable and fuel-efficient compact sedan with modern features and comfortable interior.", "ImagePath": "/images/models/corolla.jpg", "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 750.0, "FranchiseTheft": 1000.0, "FranchiseHail": 500.0, "Brand": { "Name": "Toyota" }, "Doors": 4, "Passengers": 5, "BigLuggage": 2, "SmallLuggage": 2, "Steering": "Power Steering", "SteeringType": 3, "Gearbox": "Automatic", "TransmissionType": 2, "Multimedia": "Bluetooth, Navigation System", "AirConditioner": "Automatic Climate Control", "AirConditionerType": 1, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": [ { "Id": 1, "Name": "Fuel Type", "Description": "Type of fuel used by the vehicle", "Type": 0, "Unit": "Type", "Value": "Gasoline", "ModelId": 1 }, { "Id": 2, "Name": "Engine Size", "Description": "Engine displacement", "Type": 1, "Unit": "Liters", "Value": "1.8", "ModelId": 1 }, { "Id": 3, "Name": "Transmission", "Description": "Type of transmission", "Type": 0, "Unit": "Type", "Value": "Automatic", "ModelId": 1 } ], "LowerPrice": 45.0, "Id": 1, "Name": "Corolla", "Category": { "Models": null, "Id": 1, "Name": "Economy", "Order": 1.0, "PrincipalModelId": null, "Franchise": 0.0, "FranchiseDamage": 0.0, "FranchiseRollover": 0.0, "FranchiseTheft": 0.0, "FranchiseHail": 0.0, "ImagePath": null }, "SIPP": "CDMR" }, "CurrentBranchOfficeId": 1, "CurrentBranchOffice": "LAX Branch", "BranchOfficeOwner": "Rently LAX Airport", "CurrentKms": 50000, "FuelType": "Gasoline", "Gasoline": 75, "FriendlyName": "Toyota Corolla 2023", "CurrentPlateId": "ABC123", "ChassisIdentification": "1HGCM82633A123456", "CurrentPlate": { "Id": "ABC123", "IssuingCountry": "United States", "IssuingState": "CA" }, "Color": "Silver", "Year": 2023, "TollDeviceId": "TOLL123", "BatteryNumber": "BAT123456", "CreationDate": "0001-01-01T00:00:00", "InactiveDate": null, "LeasedToCompany": null, "SupplierFullName": null, "LastReturnDate": null }, "Model": null, "Category": { "Models": [ { "Description": null, "ImagePath": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "Brand": { "Name": "Toyota" }, "Doors": 0, "Passengers": 0, "BigLuggage": 0, "SmallLuggage": 0, "Steering": null, "SteeringType": null, "Gearbox": null, "TransmissionType": null, "Multimedia": null, "AirConditioner": null, "AirConditionerType": null, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": null, "LowerPrice": 45.0, "Id": 1, "Name": "Toyota Yaris", "Category": null, "SIPP": null } ], "Id": 1, "Name": "Economy", "Order": 0.0, "PrincipalModelId": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "ImagePath": null }, "FromDate": "2026-09-25T13:58:00.2951684Z", "ToDate": "2026-09-28T13:58:00.2951684Z", "DeliveryPlace": { "Price": 0.0, "Name": "Airport Terminal 1", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 1 }, "ReturnPlace": { "Price": 0.0, "Name": "Downtown Branch", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 2 }, "TotalDaysString": "3 days", "Price": 299.99, "AgencyPrice": 269.99, "CustomerPrice": 30.0, "Currency": "USD", "Franchise": null, "FranchiseDamage": null, "FranchiseRollover": null, "FranchiseTheft": null, "FranchiseHail": null, "TotalDays": 0.0, "IlimitedKm": false, "MaxAllowedDistance": 0, "MaxAllowedDistanceByDay": 0, "HasFranchiseModifiers": false, "WillLeaveCountry": null, "AverageDayPrice": 0.0, "PriceItems": [ { "Id": 1, "IsBookingPrice": false, "Description": "Base Price", "Price": 269.99, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 1, "TariffName": null, "AppliedCoverageBrackets": [ { "DaysFrom": 1, "DaysTo": 2, "Amount": 200.0 }, { "DaysFrom": 3, "DaysTo": 3, "Amount": 69.99 } ] }, { "Id": 2, "IsBookingPrice": false, "Description": "Insurance", "Price": 30.0, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 0, "TariffName": null } ], "Additionals": [ { "Additional": { "Name": "GPS Navigation", "Description": null, "ImagePath": null, "IsPriceByDay": false, "Price": 29.99, "MaxQuantityPerBooking": 0, "Type": null, "Stock": 0, "Order": 0.0, "Id": 1 }, "Quantity": 1 } ], "AvailablePromotions": null, "CurrentStatus": 1, "CurrentStatusDate": "0001-01-01T00:00:00", "DeliveryTransportationId": null, "ReturnTransportationId": null, "IsCustomerOver25": false, "ExternalSystemId": null, "PrepaidAmount": 0.0, "ElegibleSIPPCodeUpgrade": null, "Attributes": {}, "ExchangeRate": null, "DailyRate": 0.0, "HourlyRate": 0.0, "ExtraDayRate": 0.0, "ExtraHourRate": 0.0, "RatePlan": null, "IsOnRequest": false, "DeliveryInfo": null, "DropoffInfo": null, "Origin": null, "CreationDate": "0001-01-01T00:00:00", "UpdatedOn": null, "UpdatedByUserName": null, "PayedByAgency": 0.0, "PayedByCustomer": 0.0, "CommercialAgreementCode": null, "PurchaseOrder": null, "Brand": null, "SalesCommision": 0.0, "IsTransfer": false, "PriceDetails": { "Price": 299.99, "CustomerPrice": 30.0, "AgencyPrice": 269.99, "SalesCommission": 0.0, "Currency": "USD" }, "Agency": null, "IsSelfCheckin": false, "Links": null, "DistanceUnit": "kilometers", "Code": null } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/booking/files": { "post": { "tags": [ "Bookings" ], "summary": "Attach files to booking", "description": "Attaches files to a booking", "operationId": "Bookings_AttachFiles", "requestBody": { "x-name": "model", "description": "The files to attach", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AddFilesModel" } ] }, "example": { "InvoiceLegalId": "789", "InvoiceId": "456", "BookingId": "123", "CarId": "CAR123", "InfractionId": 321, "Files": [ { "Name": "document.pdf", "Content": "base64EncodedContent", "Type": "application/pdf" } ] } } }, "x-position": 1 }, "responses": { "200": { "description": "Attaches files to a booking", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } }, "example": [ { "Path": "infractions/123/ticket.pdf", "Name": "Traffic Ticket.pdf", "Category": "Ticket", "Hash": null }, { "Path": "infractions/123/payment_receipt.pdf", "Name": "Payment Receipt.pdf", "Category": "Receipt", "Hash": null } ] } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/invoice/files": { "post": { "tags": [ "Bookings" ], "summary": "Attach files to invoice", "description": "Attaches files to an invoice", "operationId": "Bookings_AttachInvoiceFiles", "requestBody": { "x-name": "model", "description": "The files to attach", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AddFilesModel" } ] }, "example": { "InvoiceLegalId": "789", "InvoiceId": "456", "BookingId": "123", "CarId": "CAR123", "InfractionId": 321, "Files": [ { "Name": "document.pdf", "Content": "base64EncodedContent", "Type": "application/pdf" } ] } } }, "x-position": 1 }, "responses": { "200": { "description": "Attaches files to an invoice", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } }, "example": [ { "Path": "infractions/123/ticket.pdf", "Name": "Traffic Ticket.pdf", "Category": "Ticket", "Hash": null }, { "Path": "infractions/123/payment_receipt.pdf", "Name": "Payment Receipt.pdf", "Category": "Receipt", "Hash": null } ] } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/booking/{bookingId}/attachments": { "get": { "tags": [ "Bookings" ], "summary": "List booking attachments", "description": "Gets the attachments for a booking", "operationId": "Bookings_GetBookingAttachments", "parameters": [ { "name": "bookingId", "in": "path", "required": true, "description": "The booking ID", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "Gets the attachments for a booking", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } }, "example": [ { "Path": "infractions/123/ticket.pdf", "Name": "Traffic Ticket.pdf", "Category": "Ticket", "Hash": null }, { "Path": "infractions/123/payment_receipt.pdf", "Name": "Payment Receipt.pdf", "Category": "Receipt", "Hash": null } ] } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/booking/comments": { "post": { "tags": [ "Bookings" ], "summary": "Add booking comment", "description": "Adds a comment to a booking", "operationId": "Bookings_AddComment", "requestBody": { "x-name": "model", "description": "The comment details", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BookingComment" } ] }, "example": { "Id": 1, "CreatedOn": "2026-09-24T13:58:00.3382759Z", "CreatedById": 1, "Message": "Customer called to confirm their booking details. All information was correct.", "CommentType": 1, "Important": true, "CustomerId": null, "InfractionId": null, "InfractionNoticeId": null, "BookingId": null, "SinisterId": null, "CarId": null, "WorkItemId": null, "BranchOfficeId": null, "InvoiceId": null, "CreditNoteId": null, "CommercialAgreementId": null, "PurchaseOrderId": null, "BookingTariffId": null, "CorporateQuoteId": null, "IncidentId": null } } }, "x-position": 1 }, "responses": { "200": { "description": "Adds a comment to a booking" }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/booking/{bookingId}/driver/{customerId}": { "put": { "tags": [ "Bookings" ], "summary": "Add driver to booking", "description": "Adds a driver to a booking", "operationId": "Bookings_AddDriver", "parameters": [ { "name": "bookingId", "in": "path", "required": true, "description": "The booking ID", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "customerId", "in": "path", "required": true, "description": "The customer ID to add as driver", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 } ], "responses": { "200": { "description": "Adds a driver to a booking" }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/booking/{bookingId}/drivers": { "get": { "tags": [ "Bookings" ], "summary": "List booking drivers", "description": "Gets the additional drivers from a booking", "operationId": "Bookings_GetDrivers", "parameters": [ { "name": "bookingId", "in": "path", "required": true, "description": "The booking ID", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "Gets a drivers list from a booking", "content": { "application/json": { "example": [ { "Id": 1, "FirstName": "John", "LastName": "Doe", "CellPhone": "+5401140999999", "EmailAddress": "john.doe@test.com" } ] } } }, "400": { "description": "Invalid request or validation failed\nor\nApi Error", "content": { "application/json": { "schema": {} } }, "x-expectedSchemas": [ { "description": "Invalid request or validation failed", "schema": { "$ref": "#/components/schemas/Void" } }, { "description": "Api Error", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WebApiErrorResponse" } ] } } ] }, "403": { "description": "Unauthenticated user" } } } }, "/api/booking/{bookingId}/links": { "get": { "tags": [ "Bookings" ], "summary": "Get booking links", "description": "Gets booking links by booking id, the id can be the internal or the external one", "operationId": "Bookings_GetBookingLinks", "parameters": [ { "name": "bookingId", "in": "path", "required": true, "description": "Internal or external bookingId", "schema": { "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Gets a booking by external system ID", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookingLinks" }, "example": { "Id": 1, "Version": null, "Customer": { "Id": 1, "GlobalId": "8e79307d-739a-4be3-9052-55ebe972a468", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:00.3618091Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:00.3618091Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:00.3618091Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:00.3618091Z", "DocumentIdExpiration": "2036-09-24T13:58:00.3618091Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null }, "Balance": 0.0, "TotalPayed": 0.0, "Extra": null, "Promotion": null, "IsQuotation": false, "Car": { "Id": "CAR123", "Model": { "Description": "The Toyota Corolla is a reliable and fuel-efficient compact sedan with modern features and comfortable interior.", "ImagePath": "/images/models/corolla.jpg", "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 750.0, "FranchiseTheft": 1000.0, "FranchiseHail": 500.0, "Brand": { "Name": "Toyota" }, "Doors": 4, "Passengers": 5, "BigLuggage": 2, "SmallLuggage": 2, "Steering": "Power Steering", "SteeringType": 3, "Gearbox": "Automatic", "TransmissionType": 2, "Multimedia": "Bluetooth, Navigation System", "AirConditioner": "Automatic Climate Control", "AirConditionerType": 1, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": [ { "Id": 1, "Name": "Fuel Type", "Description": "Type of fuel used by the vehicle", "Type": 0, "Unit": "Type", "Value": "Gasoline", "ModelId": 1 }, { "Id": 2, "Name": "Engine Size", "Description": "Engine displacement", "Type": 1, "Unit": "Liters", "Value": "1.8", "ModelId": 1 }, { "Id": 3, "Name": "Transmission", "Description": "Type of transmission", "Type": 0, "Unit": "Type", "Value": "Automatic", "ModelId": 1 } ], "LowerPrice": 45.0, "Id": 1, "Name": "Corolla", "Category": { "Models": null, "Id": 1, "Name": "Economy", "Order": 1.0, "PrincipalModelId": null, "Franchise": 0.0, "FranchiseDamage": 0.0, "FranchiseRollover": 0.0, "FranchiseTheft": 0.0, "FranchiseHail": 0.0, "ImagePath": null }, "SIPP": "CDMR" }, "CurrentBranchOfficeId": 1, "CurrentBranchOffice": "LAX Branch", "BranchOfficeOwner": "Rently LAX Airport", "CurrentKms": 50000, "FuelType": "Gasoline", "Gasoline": 75, "FriendlyName": "Toyota Corolla 2023", "CurrentPlateId": "ABC123", "ChassisIdentification": "1HGCM82633A123456", "CurrentPlate": { "Id": "ABC123", "IssuingCountry": "United States", "IssuingState": "CA" }, "Color": "Silver", "Year": 2023, "TollDeviceId": "TOLL123", "BatteryNumber": "BAT123456", "CreationDate": "0001-01-01T00:00:00", "InactiveDate": null, "LeasedToCompany": null, "SupplierFullName": null, "LastReturnDate": null }, "Model": null, "Category": { "Models": [ { "Description": null, "ImagePath": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "Brand": { "Name": "Toyota" }, "Doors": 0, "Passengers": 0, "BigLuggage": 0, "SmallLuggage": 0, "Steering": null, "SteeringType": null, "Gearbox": null, "TransmissionType": null, "Multimedia": null, "AirConditioner": null, "AirConditionerType": null, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": null, "LowerPrice": 45.0, "Id": 1, "Name": "Toyota Yaris", "Category": null, "SIPP": null } ], "Id": 1, "Name": "Economy", "Order": 0.0, "PrincipalModelId": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "ImagePath": null }, "FromDate": "2026-09-25T13:58:00.3618091Z", "ToDate": "2026-09-28T13:58:00.3618091Z", "DeliveryPlace": { "Price": 0.0, "Name": "Airport Terminal 1", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 1 }, "ReturnPlace": { "Price": 0.0, "Name": "Downtown Branch", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 2 }, "TotalDaysString": "3 days", "Price": 299.99, "AgencyPrice": 269.99, "CustomerPrice": 30.0, "Currency": "USD", "Franchise": null, "FranchiseDamage": null, "FranchiseRollover": null, "FranchiseTheft": null, "FranchiseHail": null, "TotalDays": 0.0, "IlimitedKm": false, "MaxAllowedDistance": 0, "MaxAllowedDistanceByDay": 0, "HasFranchiseModifiers": false, "WillLeaveCountry": null, "AverageDayPrice": 0.0, "PriceItems": [ { "Id": 1, "IsBookingPrice": false, "Description": "Base Price", "Price": 269.99, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 1, "TariffName": null, "AppliedCoverageBrackets": [ { "DaysFrom": 1, "DaysTo": 2, "Amount": 200.0 }, { "DaysFrom": 3, "DaysTo": 3, "Amount": 69.99 } ] }, { "Id": 2, "IsBookingPrice": false, "Description": "Insurance", "Price": 30.0, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 0, "TariffName": null } ], "Additionals": [ { "Additional": { "Name": "GPS Navigation", "Description": null, "ImagePath": null, "IsPriceByDay": false, "Price": 29.99, "MaxQuantityPerBooking": 0, "Type": null, "Stock": 0, "Order": 0.0, "Id": 1 }, "Quantity": 1 } ], "AvailablePromotions": null, "CurrentStatus": 1, "CurrentStatusDate": "0001-01-01T00:00:00", "DeliveryTransportationId": null, "ReturnTransportationId": null, "IsCustomerOver25": false, "ExternalSystemId": null, "PrepaidAmount": 0.0, "ElegibleSIPPCodeUpgrade": null, "Attributes": {}, "ExchangeRate": null, "DailyRate": 0.0, "HourlyRate": 0.0, "ExtraDayRate": 0.0, "ExtraHourRate": 0.0, "RatePlan": null, "IsOnRequest": false, "DeliveryInfo": null, "DropoffInfo": null, "Origin": null, "CreationDate": "0001-01-01T00:00:00", "UpdatedOn": null, "UpdatedByUserName": null, "PayedByAgency": 0.0, "PayedByCustomer": 0.0, "CommercialAgreementCode": null, "PurchaseOrder": null, "Brand": null, "SalesCommision": 0.0, "IsTransfer": false, "PriceDetails": { "Price": 299.99, "CustomerPrice": 30.0, "AgencyPrice": 269.99, "SalesCommission": 0.0, "Currency": "USD" }, "Agency": null, "IsSelfCheckin": false, "Links": null, "DistanceUnit": "kilometers", "Code": null } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/booking/{bookingId}/cancellation": { "get": { "tags": [ "Bookings" ], "summary": "Get booking cancellation", "description": "Gets cancellation information for a cancelled booking", "operationId": "Bookings_GetBookingCancellation", "parameters": [ { "name": "bookingId", "in": "path", "required": true, "description": "The ID of the booking", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "Gets cancellation information for a booking", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookingCancellationInfo" }, "example": { "CancellationType": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "Reason": "Unconfirmed Online Booking", "CancelledDate": "2024-01-15T10:30:00", "CancelledByUser": "Juan González" } } } }, "400": { "description": "Booking not found or not cancelled\nor\nApi Error", "content": { "application/json": { "schema": {} } }, "x-expectedSchemas": [ { "description": "Booking not found or not cancelled", "schema": { "$ref": "#/components/schemas/Void" } }, { "description": "Api Error", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WebApiErrorResponse" } ] } } ] }, "403": { "description": "Unauthenticated user" } } } }, "/api/booking/pay": { "post": { "tags": [ "Booking Payments" ], "summary": "Pay booking", "description": "Processes a payment for a booking", "operationId": "BookingsPayments_PayBooking", "requestBody": { "x-name": "model", "description": "The payment details including booking ID, amount, and payment gateway information", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PayBookingModel" } ] }, "example": { "BookingId": 123, "ExtraData": "Additional payment information", "AccountId": 456, "Voucher_Number": "VOUCHER123", "IsPayedByAgency": false, "CreditCardNumber": "4111111111111111", "CreditCardExpirationMonth": 12, "CreditCardExpirationYear": 2027, "CreditCardType": "VISA", "CreditCardPlaceHolder": "John Doe", "CreditCardCode": "123", "TransactionId": "TXN123", "GatewayId": "STRIPE", "Amount": 199.99, "payerID": null, "paymentToken": null, "CurrencyCode": "USD", "ExchangeRate": null, "BillingInformation": { "FirstName": "John", "LastName": "Doe", "DocumentTypeId": 1, "DocumentId": "123456789", "FiscalConditionId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1234567890", "Address": "123 Main St", "AddressNumber": "456", "ZipCode": "12345", "Country": null, "Birthday": null, "City": null, "State": null, "AddressDepartment": "Apt 789" }, "ReturnUrl": null } } }, "x-position": 1 }, "responses": { "200": { "description": "Payment processed successfully" }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/bookingPayments/{bookingId}": { "get": { "tags": [ "Booking Payments" ], "summary": "List booking payments", "description": "Gets all payments for a specific booking", "operationId": "BookingsPayments_GetBookingPayments", "parameters": [ { "name": "bookingId", "in": "path", "required": true, "description": "The ID of the booking", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "List of booking payments retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BookingPayment" } }, "example": [ { "Id": 1, "Type": 14, "Amount": 199.99, "Status": 0, "Date": "2026-09-24T13:58:00.4447255Z", "CreatedBy": "John Doe", "ConciliationStatus": 1, "ConciliatedOn": "2026-09-24T13:58:00.4447255Z", "BookingBrandId": 3 } ] } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/bookingPayments/cancel": { "post": { "tags": [ "Booking Payments" ], "summary": "Cancel booking payment", "description": "Cancels a payment for a booking", "operationId": "BookingsPayments_CancelBookingPayment", "parameters": [ { "name": "paymentId", "in": "query", "required": true, "description": "The ID of the payment to cancel", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "Payment cancelled successfully" }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/CommercialAgreements": { "get": { "tags": [ "Commercial Agreements" ], "summary": "List agency commercial agreements", "description": "The response includes the following information for each commercial agreement:\n- Agreement ID and code\n- Agreement name and description\n- Validity period (start and end dates)\n- Discount rate\n- Active status\n- Associated branch offices\n- Associated agencies", "operationId": "CommercialAgreements_ListCommercialAgreements", "parameters": [ { "name": "agencyId", "in": "query", "description": "Optional agency ID to filter agreements", "schema": { "type": "integer", "format": "int32", "nullable": true }, "x-position": 1 }, { "name": "agencyIata", "in": "query", "description": "Optional agency IATA code to filter agreements", "schema": { "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "Returns the list of commercial agreements", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommercialAgreement" } }, "example": [ { "Id": 1, "Code": "prepaid", "ValidFrom": "2026-09-24T10:58:00.5201379-03:00", "ValidTo": "2027-09-24T10:58:00.5201379-03:00", "Notes": "Special conditions apply", "BranchOffices": [ 1, 2, 3 ] } ] } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/CommercialAgreements/list": { "get": { "tags": [ "Commercial Agreements" ], "summary": "List all commercial agreements", "description": "Returns all the active Commercial Agreements with the allowed Agencies and Branch Offices.", "operationId": "CommercialAgreements_ListAllCommercialAgreements", "responses": { "200": { "description": "Returns the list of commercial agreements", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommercialAgreementExtended" } }, "example": [ { "Id": 1, "Code": "prepaid", "ValidFrom": "2026-09-24T10:58:00.5352783-03:00", "ValidTo": "2027-09-24T10:58:00.5352783-03:00", "Notes": "Special conditions apply", "BranchOffices": [ 1, 2, 3 ] } ] } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/CommercialAgreements/by-code": { "get": { "tags": [ "Commercial Agreements" ], "summary": "Get commercial agreement by code", "description": "The code travels in the query string (not in the path) so codes containing URL-unsafe characters\n(e.g. '%') can be looked up without hitting IIS request filtering (double-escape) on the path.\nThe response includes VDR CoverageBrackets with inclusive 1-based day ranges; an open range has no end day.", "operationId": "CommercialAgreements_GetCommercialAgreement", "parameters": [ { "name": "code", "in": "query", "required": true, "description": "Commercial Agreement Code", "schema": { "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Returns the commercial agreement", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommercialAgreementComplete" }, "example": { "Brands": [ "brand-1", "brand-2" ], "AcceptedPaymentMethods": [ { "Id": 1, "Name": "Cash" }, { "Id": 2, "Name": "Credit Card" } ], "Tariffs": [ 10, 20, 30 ], "RatePayedBy": "Agency", "RatePayment": 100.0, "IsRatePaymentFixedAmount": "Fixed", "RateCommision": 15.0, "IsRateCommisionFixedAmount": "Percentage", "DeliveryPayedBy": "Customer", "DeliveryPaymentPercentage": 10.0, "IsDeliveryPaymentFixedAmount": "Percentage", "DeliveryCommision": 5.0, "IsDeliveryCommisionFixedAmount": "Percentage", "ReturnPayedBy": "Customer", "ReturnPaymentPercentage": 10.0, "IsReturnPaymentFixedAmount": "Percentage", "ReturnCommision": 5.0, "IsReturnCommisionFixedAmount": "Percentage", "OneWayDropOffPayedBy": "Agency", "OneWayDropOffPaymentPercentage": 20.0, "IsOneWayDropOffPaymentFixedAmount": "Percentage", "OneWayDropOffCommision": 8.0, "IsOneWayDropOffCommisionFixedAmount": "Percentage", "TariffApplyStrategyName": "Standard", "AllowBookingWithoutFranchise": true, "ExcludeTollCollection": false, "CommissionByPrice": "LastPriceCommission", "PriceModificator": 1.1, "CommissionableTaxes": [ { "TaxId": 1, "Commision": 21.0, "IsFixedAmount": "Percentage", "IsApplicable": "Applicable", "PayedBy": "Customer" } ], "Additionals": [ { "AdditionalId": 1, "Modifier": 10.0, "ModifierStrategy": "Percentage", "AdditionalAction": "Show", "Commision": 5.0, "CommissionStrategy": "Fixed", "PayedBy": "Agency", "Percentage": 100.0, "IsFixedAmount": "Fixed" } ], "CoverageBrackets": [ { "DaysFrom": 1, "DaysTo": 7, "PayedBy": "Customer", "CoveragePercentage": 50.0, "CoverageFixedAmount": null }, { "DaysFrom": 8, "DaysTo": null, "PayedBy": "Agency", "CoveragePercentage": null, "CoverageFixedAmount": 400.0 } ], "Agencies": [ "AGENCY1", "AGENCY2" ], "Id": 1, "Code": "prepaid", "ValidFrom": "2026-09-24T10:58:00.5820057-03:00", "ValidTo": "2027-09-24T10:58:00.5820057-03:00", "Notes": "Special conditions apply", "BranchOffices": [ 1, 2, 3 ] } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/CommercialAgreements/by-id/{id}": { "get": { "tags": [ "Commercial Agreements" ], "summary": "Get commercial agreement by ID", "description": "Returns the Commercial Agreement by Id if exists. The response includes VDR CoverageBrackets with inclusive\n1-based day ranges; an open range has no end day.", "operationId": "CommercialAgreements_GetCommercialAgreement2", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Commercial Agreement id", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "Returns the commercial agreement", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommercialAgreementComplete" }, "example": { "Brands": [ "brand-1", "brand-2" ], "AcceptedPaymentMethods": [ { "Id": 1, "Name": "Cash" }, { "Id": 2, "Name": "Credit Card" } ], "Tariffs": [ 10, 20, 30 ], "RatePayedBy": "Agency", "RatePayment": 100.0, "IsRatePaymentFixedAmount": "Fixed", "RateCommision": 15.0, "IsRateCommisionFixedAmount": "Percentage", "DeliveryPayedBy": "Customer", "DeliveryPaymentPercentage": 10.0, "IsDeliveryPaymentFixedAmount": "Percentage", "DeliveryCommision": 5.0, "IsDeliveryCommisionFixedAmount": "Percentage", "ReturnPayedBy": "Customer", "ReturnPaymentPercentage": 10.0, "IsReturnPaymentFixedAmount": "Percentage", "ReturnCommision": 5.0, "IsReturnCommisionFixedAmount": "Percentage", "OneWayDropOffPayedBy": "Agency", "OneWayDropOffPaymentPercentage": 20.0, "IsOneWayDropOffPaymentFixedAmount": "Percentage", "OneWayDropOffCommision": 8.0, "IsOneWayDropOffCommisionFixedAmount": "Percentage", "TariffApplyStrategyName": "Standard", "AllowBookingWithoutFranchise": true, "ExcludeTollCollection": false, "CommissionByPrice": "LastPriceCommission", "PriceModificator": 1.1, "CommissionableTaxes": [ { "TaxId": 1, "Commision": 21.0, "IsFixedAmount": "Percentage", "IsApplicable": "Applicable", "PayedBy": "Customer" } ], "Additionals": [ { "AdditionalId": 1, "Modifier": 10.0, "ModifierStrategy": "Percentage", "AdditionalAction": "Show", "Commision": 5.0, "CommissionStrategy": "Fixed", "PayedBy": "Agency", "Percentage": 100.0, "IsFixedAmount": "Fixed" } ], "CoverageBrackets": [ { "DaysFrom": 1, "DaysTo": 7, "PayedBy": "Customer", "CoveragePercentage": 50.0, "CoverageFixedAmount": null }, { "DaysFrom": 8, "DaysTo": null, "PayedBy": "Agency", "CoveragePercentage": null, "CoverageFixedAmount": 400.0 } ], "Agencies": [ "AGENCY1", "AGENCY2" ], "Id": 1, "Code": "prepaid", "ValidFrom": "2026-09-24T10:58:00.596427-03:00", "ValidTo": "2027-09-24T10:58:00.596427-03:00", "Notes": "Special conditions apply", "BranchOffices": [ 1, 2, 3 ] } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/configurations/attachments": { "get": { "tags": [ "Configurations" ], "summary": "Get attachment settings", "description": "This endpoint returns the configuration of allowed file types for different entities in the system.\nThe configuration includes file extensions, size limits, and other file-related settings.", "operationId": "Configurations_Attachments", "responses": { "200": { "description": "Returns the allowed file types configuration for each entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileTypeConfiguration" }, "example": { "Types": { "Car": [ "Delivery", "Return", "Service", "Other" ], "Customer": [ "Passport", "DriverLicense", "Other" ], "Expense": [ "Invoice", "Receipt", "Ticket", "Other" ], "Booking": [ "Invoice", "Return", "Contract", "Other" ] } } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/configurations/taxPayerTypes": { "get": { "tags": [ "Configurations" ], "summary": "List tax payer types", "description": "Retrieves all tax payer types", "operationId": "Configurations_GetTaxPayerTypes", "responses": { "200": { "description": "Returns the system's tax payer type configuration", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxPayerType" } }, "example": [ { "Id": 1, "Name": "Individual", "IsExempt": false, "IsEndConsumer": false, "IsRegisteredTaxPayer": false, "IsSelfEmployed": false }, { "Id": 2, "Name": "Company", "IsExempt": false, "IsEndConsumer": false, "IsRegisteredTaxPayer": false, "IsSelfEmployed": false } ] } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/configurations/bookings": { "get": { "tags": [ "Configurations" ], "summary": "Get booking settings", "description": "This endpoint returns the configuration settings for bookings, including:\n- Driver age restrictions\n- Booking duration limits\n- Gasoline tank settings\n- Return time tolerances\n- Insurance requirements\n- Distance unit settings", "operationId": "Configurations_Bookings", "responses": { "200": { "description": "Returns the general booking configuration settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookingConfiguration" }, "example": { "DriverAgeAllowedMin": 21, "DriverAgeAllowedMax": 75, "MinDays": 1, "MaxDays": 30, "GasolineTankFractions": 4, "ReturnToleranceInMinutes": 30, "HalfDayToleranceInHours": 4, "MinDaysToCharge": 1, "DriverAgeWithoutCautionMin": 25, "DriverAgeWithoutCautionMax": 70, "RequireDriverLicenceForDelivery": true, "UseDriverAgeAllowed": true, "CutsByDistance": [ 100, 200, 300 ], "UseDriverAgeWithoutCaution": true, "MustHaveAtLeastOneInsurance": true, "DistanceUnit": "km", "AvailabilityBased": 0, "PriceBased": 0 } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/configurations/mails": { "get": { "tags": [ "Configurations" ], "summary": "Get mail notification settings", "description": "This endpoint returns the email notification settings configured for the API user.\nThese settings determine which notifications the user will receive via email.", "operationId": "Configurations_Mails", "responses": { "200": { "description": "Returns the email notification configuration for the API user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationsConfiguration" }, "example": { "Configurations": { "BookingConfirmation": { "IsEnabled": true, "CustomNotificationReplacement": 1 }, "PaymentReminder": { "IsEnabled": true, "CustomNotificationReplacement": null } } } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/configurations/documentTypes": { "get": { "tags": [ "Configurations" ], "summary": "List document types", "description": "This endpoint returns a list of all document types configured in the system.\nDocument types are used for customer identification and verification.", "operationId": "Configurations_DocumentTypes", "responses": { "200": { "description": "Returns the system's document type configuration", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentType" } }, "example": [ { "Id": 1, "Name": "Passport", "IsDriverLicense": false }, { "Id": 2, "Name": "Driver's License", "IsDriverLicense": false } ] } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/configurations/gatewayCredentials": { "get": { "tags": [ "Configurations" ], "summary": "List gateway credentials", "description": "This endpoint returns a list of payment gateways with their credentials,\nthe branch offices where they are used and the booking brands they are restricted to.\nA configuration with an empty list of booking brands applies to every booking brand.\nWhen a booking brand is supplied, only the configurations assigned to that brand are returned;\na brand with no configurations assigned returns an empty list.\nRequires the 'CanAccessExtendedApi' permission.", "operationId": "Configurations_GatewayCredentials", "parameters": [ { "name": "bookingBrandId", "in": "query", "description": "Optional booking brand ID to filter the gateway credentials", "schema": { "type": "integer", "format": "int32", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Returns a list of payment gateways with their credentials and the associated branch offices and booking brands", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GatewayCredential" } }, "example": [ { "Id": "stripe_1", "PaymentType": 14, "Configuration": "{'PublicApiKey':'pk_test_123','SecretApiKey':'sk_test_123','Location':'loc_001','SupportsExtendedAuthorization':true,'AccountId':'acct_123','PlatformConnectionMode':2,'PlatformCountryCode':'CL','ApplicationFeePercentage':0.0125}", "BranchOffices": [ 1, 2 ], "BookingBrandIds": [ 4 ] }, { "Id": "redsys_1", "PaymentType": 22, "Configuration": "{'MerchantCode':'123456789','AuthenticationKey':'********'}", "BranchOffices": [ 1, 3 ], "BookingBrandIds": [] }, { "Id": "cybersource_1", "PaymentType": 26, "Configuration": "{'Environment':'Sandbox','MerchantId':'rently_merchant','KeyId':'11111111-2222-3333-4444-555555555555','SharedSecret':'********','Currencies':['USD','CRC'],'CountryCode':'CR','FlexLanguage':'es','InstallmentsEnabled':true,'MaxInstallments':12,'DisableTokenizeCards':false}", "BranchOffices": [ 1 ], "BookingBrandIds": [] } ] } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/configurations/paymentaccounts": { "get": { "tags": [ "Configurations" ], "summary": "List payment accounts", "description": "This endpoint returns a list of active payment accounts that have associated payment types\nand are configured for the system's currency.", "operationId": "Configurations_Accounts", "responses": { "200": { "description": "Returns a list of payment accounts with their associated payment types and branch offices", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentAccount" } }, "example": [ { "Id": 1, "Name": "Main Account", "PaymentTypes": [ 1, 2 ], "BranchOffices": [ 1, 2 ] }, { "Id": 2, "Name": "Secondary Account", "PaymentTypes": [ 1 ], "BranchOffices": [ 2 ] } ] } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/configurations/generalSettings": { "get": { "tags": [ "Configurations" ], "summary": "Get general settings", "description": "This endpoint returns the general configuration settings for the tenant, including:\n- Cash box configuration (number of decimals)\n- Payment gateway configurations", "operationId": "Configurations_TenantGeneralSettings", "responses": { "200": { "description": "Returns the general settings for the tenant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantGeneralSettings" }, "example": { "CashBoxConfiguration": { "NumberOfDecimals": 2 }, "PaymentGatewayConfigs": [ { "Id": 1, "Name": "Stripe", "PaymentType": 14, "BranchOfficeIds": [ 1, 2, 3 ], "BookingBrandIds": [] }, { "Id": 2, "Name": "PayPal", "PaymentType": 6, "BranchOfficeIds": [ 1 ], "BookingBrandIds": [ 1 ] } ] } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/customers": { "get": { "tags": [ "Customers" ], "summary": "List customers", "description": "The filter parameter can be used to search customers by name, email, or document ID.\nThe response includes the total count of matching customers, current offset, limit, and the list of customers.", "operationId": "CustomersApi_GetCustomers", "parameters": [ { "name": "filter", "in": "query", "description": "Optional filter string to search customers", "schema": { "type": "string", "nullable": true }, "x-position": 1 }, { "name": "offset", "in": "query", "description": "Number of records to skip (default: 0)", "schema": { "type": "integer", "format": "int32", "default": 0 }, "x-position": 2 }, { "name": "limit", "in": "query", "description": "Maximum number of records to return (default: 30)", "schema": { "type": "integer", "format": "int32", "default": 30 }, "x-position": 3 } ], "responses": { "200": { "description": "Returns the list of customers with pagination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultOfCustomer" }, "example": { "Offset": 0, "Limit": 30, "Total": 2, "Results": [ { "Id": 1, "GlobalId": "83971ecd-1346-4f6c-b71d-9369cd2a107c", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:00.7092143Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:00.7092143Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:00.7092143Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:00.7092143Z", "DocumentIdExpiration": "2036-09-24T13:58:00.7092143Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null } ], "NextOffset": 0 } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/customer/{customerId}/bookings": { "get": { "tags": [ "Customers" ], "summary": "List customer bookings", "description": "This endpoint supports both numeric customer IDs and global IDs.\nFor company customers, it also includes bookings where the customer is the agency.", "operationId": "CustomersApi_GetBookingsForCustomer", "parameters": [ { "name": "customerId", "in": "path", "required": true, "description": "The unique identifier of the customer", "schema": { "type": "string", "nullable": true }, "x-position": 1 }, { "name": "offset", "in": "query", "description": "Number of records to skip (default: 0)", "schema": { "type": "integer", "format": "int32", "default": 0 }, "x-position": 2 }, { "name": "limit", "in": "query", "description": "Maximum number of records to return (default: 30)", "schema": { "type": "integer", "format": "int32", "default": 30 }, "x-position": 3 }, { "name": "orderDesc", "in": "query", "description": "Whether to sort results in descending order (default: false)", "schema": { "type": "boolean", "default": false }, "x-position": 4 } ], "responses": { "200": { "description": "Returns the list of bookings for the specified customer with pagination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultOfBooking" }, "example": { "Offset": 0, "Limit": 30, "Total": 1, "Results": [ { "Id": 1, "Version": null, "Customer": { "Id": 1, "GlobalId": "b091442f-056f-4f84-945c-02c8a4ef25e4", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:00.7128796Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:00.7128796Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:00.7128796Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:00.7128796Z", "DocumentIdExpiration": "2036-09-24T13:58:00.7128796Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null }, "Balance": 0.0, "TotalPayed": 0.0, "Extra": null, "Promotion": null, "IsQuotation": false, "Car": { "Id": "CAR123", "Model": { "Description": "The Toyota Corolla is a reliable and fuel-efficient compact sedan with modern features and comfortable interior.", "ImagePath": "/images/models/corolla.jpg", "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 750.0, "FranchiseTheft": 1000.0, "FranchiseHail": 500.0, "Brand": { "Name": "Toyota" }, "Doors": 4, "Passengers": 5, "BigLuggage": 2, "SmallLuggage": 2, "Steering": "Power Steering", "SteeringType": 3, "Gearbox": "Automatic", "TransmissionType": 2, "Multimedia": "Bluetooth, Navigation System", "AirConditioner": "Automatic Climate Control", "AirConditionerType": 1, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": [ { "Id": 1, "Name": "Fuel Type", "Description": "Type of fuel used by the vehicle", "Type": 0, "Unit": "Type", "Value": "Gasoline", "ModelId": 1 }, { "Id": 2, "Name": "Engine Size", "Description": "Engine displacement", "Type": 1, "Unit": "Liters", "Value": "1.8", "ModelId": 1 }, { "Id": 3, "Name": "Transmission", "Description": "Type of transmission", "Type": 0, "Unit": "Type", "Value": "Automatic", "ModelId": 1 } ], "LowerPrice": 45.0, "Id": 1, "Name": "Corolla", "Category": { "Models": null, "Id": 1, "Name": "Economy", "Order": 1.0, "PrincipalModelId": null, "Franchise": 0.0, "FranchiseDamage": 0.0, "FranchiseRollover": 0.0, "FranchiseTheft": 0.0, "FranchiseHail": 0.0, "ImagePath": null }, "SIPP": "CDMR" }, "CurrentBranchOfficeId": 1, "CurrentBranchOffice": "LAX Branch", "BranchOfficeOwner": "Rently LAX Airport", "CurrentKms": 50000, "FuelType": "Gasoline", "Gasoline": 75, "FriendlyName": "Toyota Corolla 2023", "CurrentPlateId": "ABC123", "ChassisIdentification": "1HGCM82633A123456", "CurrentPlate": { "Id": "ABC123", "IssuingCountry": "United States", "IssuingState": "CA" }, "Color": "Silver", "Year": 2023, "TollDeviceId": "TOLL123", "BatteryNumber": "BAT123456", "CreationDate": "0001-01-01T00:00:00", "InactiveDate": null, "LeasedToCompany": null, "SupplierFullName": null, "LastReturnDate": null }, "Model": null, "Category": { "Models": [ { "Description": null, "ImagePath": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "Brand": { "Name": "Toyota" }, "Doors": 0, "Passengers": 0, "BigLuggage": 0, "SmallLuggage": 0, "Steering": null, "SteeringType": null, "Gearbox": null, "TransmissionType": null, "Multimedia": null, "AirConditioner": null, "AirConditionerType": null, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": null, "LowerPrice": 45.0, "Id": 1, "Name": "Toyota Yaris", "Category": null, "SIPP": null } ], "Id": 1, "Name": "Economy", "Order": 0.0, "PrincipalModelId": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "ImagePath": null }, "FromDate": "2026-09-25T13:58:00.7128796Z", "ToDate": "2026-09-28T13:58:00.7128796Z", "DeliveryPlace": { "Price": 0.0, "Name": "Airport Terminal 1", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 1 }, "ReturnPlace": { "Price": 0.0, "Name": "Downtown Branch", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 2 }, "TotalDaysString": "3 days", "Price": 299.99, "AgencyPrice": 269.99, "CustomerPrice": 30.0, "Currency": "USD", "Franchise": null, "FranchiseDamage": null, "FranchiseRollover": null, "FranchiseTheft": null, "FranchiseHail": null, "TotalDays": 0.0, "IlimitedKm": false, "MaxAllowedDistance": 0, "MaxAllowedDistanceByDay": 0, "HasFranchiseModifiers": false, "WillLeaveCountry": null, "AverageDayPrice": 0.0, "PriceItems": [ { "Id": 1, "IsBookingPrice": false, "Description": "Base Price", "Price": 269.99, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 1, "TariffName": null, "AppliedCoverageBrackets": [ { "DaysFrom": 1, "DaysTo": 2, "Amount": 200.0 }, { "DaysFrom": 3, "DaysTo": 3, "Amount": 69.99 } ] }, { "Id": 2, "IsBookingPrice": false, "Description": "Insurance", "Price": 30.0, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 0, "TariffName": null } ], "Additionals": [ { "Additional": { "Name": "GPS Navigation", "Description": null, "ImagePath": null, "IsPriceByDay": false, "Price": 29.99, "MaxQuantityPerBooking": 0, "Type": null, "Stock": 0, "Order": 0.0, "Id": 1 }, "Quantity": 1 } ], "AvailablePromotions": null, "CurrentStatus": 1, "CurrentStatusDate": "0001-01-01T00:00:00", "DeliveryTransportationId": null, "ReturnTransportationId": null, "IsCustomerOver25": false, "ExternalSystemId": null, "PrepaidAmount": 0.0, "ElegibleSIPPCodeUpgrade": null, "Attributes": {}, "ExchangeRate": null, "DailyRate": 0.0, "HourlyRate": 0.0, "ExtraDayRate": 0.0, "ExtraHourRate": 0.0, "RatePlan": null, "IsOnRequest": false, "DeliveryInfo": null, "DropoffInfo": null, "Origin": null, "CreationDate": "0001-01-01T00:00:00", "UpdatedOn": null, "UpdatedByUserName": null, "PayedByAgency": 0.0, "PayedByCustomer": 0.0, "CommercialAgreementCode": null, "PurchaseOrder": null, "Brand": null, "SalesCommision": 0.0, "IsTransfer": false, "PriceDetails": { "Price": 299.99, "CustomerPrice": 30.0, "AgencyPrice": 269.99, "SalesCommission": 0.0, "Currency": "USD" }, "Agency": null, "IsSelfCheckin": false, "Links": null, "DistanceUnit": "kilometers", "Code": null } ], "NextOffset": 0 } } } }, "404": { "description": "Customer not found" }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/customer/{customerId}/bookings/{bookingId}": { "get": { "tags": [ "Customers" ], "summary": "Get customer booking", "description": "This endpoint verifies that the booking belongs to the specified customer before returning the details.", "operationId": "CustomersApi_GetBookingForCustomer", "parameters": [ { "name": "customerId", "in": "path", "required": true, "description": "The unique identifier of the customer", "schema": { "type": "string", "nullable": true }, "x-position": 1 }, { "name": "bookingId", "in": "path", "required": true, "description": "The unique identifier of the booking", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 } ], "responses": { "200": { "description": "Returns the booking details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Booking" }, "example": { "Id": 1, "Version": null, "Customer": { "Id": 1, "GlobalId": "e46453bc-c75b-495e-9356-0830f83e3b5d", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:00.7176543Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:00.7176543Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:00.7176543Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:00.7176543Z", "DocumentIdExpiration": "2036-09-24T13:58:00.7176543Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null }, "Balance": 0.0, "TotalPayed": 0.0, "Extra": null, "Promotion": null, "IsQuotation": false, "Car": { "Id": "CAR123", "Model": { "Description": "The Toyota Corolla is a reliable and fuel-efficient compact sedan with modern features and comfortable interior.", "ImagePath": "/images/models/corolla.jpg", "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 750.0, "FranchiseTheft": 1000.0, "FranchiseHail": 500.0, "Brand": { "Name": "Toyota" }, "Doors": 4, "Passengers": 5, "BigLuggage": 2, "SmallLuggage": 2, "Steering": "Power Steering", "SteeringType": 3, "Gearbox": "Automatic", "TransmissionType": 2, "Multimedia": "Bluetooth, Navigation System", "AirConditioner": "Automatic Climate Control", "AirConditionerType": 1, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": [ { "Id": 1, "Name": "Fuel Type", "Description": "Type of fuel used by the vehicle", "Type": 0, "Unit": "Type", "Value": "Gasoline", "ModelId": 1 }, { "Id": 2, "Name": "Engine Size", "Description": "Engine displacement", "Type": 1, "Unit": "Liters", "Value": "1.8", "ModelId": 1 }, { "Id": 3, "Name": "Transmission", "Description": "Type of transmission", "Type": 0, "Unit": "Type", "Value": "Automatic", "ModelId": 1 } ], "LowerPrice": 45.0, "Id": 1, "Name": "Corolla", "Category": { "Models": null, "Id": 1, "Name": "Economy", "Order": 1.0, "PrincipalModelId": null, "Franchise": 0.0, "FranchiseDamage": 0.0, "FranchiseRollover": 0.0, "FranchiseTheft": 0.0, "FranchiseHail": 0.0, "ImagePath": null }, "SIPP": "CDMR" }, "CurrentBranchOfficeId": 1, "CurrentBranchOffice": "LAX Branch", "BranchOfficeOwner": "Rently LAX Airport", "CurrentKms": 50000, "FuelType": "Gasoline", "Gasoline": 75, "FriendlyName": "Toyota Corolla 2023", "CurrentPlateId": "ABC123", "ChassisIdentification": "1HGCM82633A123456", "CurrentPlate": { "Id": "ABC123", "IssuingCountry": "United States", "IssuingState": "CA" }, "Color": "Silver", "Year": 2023, "TollDeviceId": "TOLL123", "BatteryNumber": "BAT123456", "CreationDate": "0001-01-01T00:00:00", "InactiveDate": null, "LeasedToCompany": null, "SupplierFullName": null, "LastReturnDate": null }, "Model": null, "Category": { "Models": [ { "Description": null, "ImagePath": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "Brand": { "Name": "Toyota" }, "Doors": 0, "Passengers": 0, "BigLuggage": 0, "SmallLuggage": 0, "Steering": null, "SteeringType": null, "Gearbox": null, "TransmissionType": null, "Multimedia": null, "AirConditioner": null, "AirConditionerType": null, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": null, "LowerPrice": 45.0, "Id": 1, "Name": "Toyota Yaris", "Category": null, "SIPP": null } ], "Id": 1, "Name": "Economy", "Order": 0.0, "PrincipalModelId": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "ImagePath": null }, "FromDate": "2026-09-25T13:58:00.7176543Z", "ToDate": "2026-09-28T13:58:00.7176543Z", "DeliveryPlace": { "Price": 0.0, "Name": "Airport Terminal 1", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 1 }, "ReturnPlace": { "Price": 0.0, "Name": "Downtown Branch", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 2 }, "TotalDaysString": "3 days", "Price": 299.99, "AgencyPrice": 269.99, "CustomerPrice": 30.0, "Currency": "USD", "Franchise": null, "FranchiseDamage": null, "FranchiseRollover": null, "FranchiseTheft": null, "FranchiseHail": null, "TotalDays": 0.0, "IlimitedKm": false, "MaxAllowedDistance": 0, "MaxAllowedDistanceByDay": 0, "HasFranchiseModifiers": false, "WillLeaveCountry": null, "AverageDayPrice": 0.0, "PriceItems": [ { "Id": 1, "IsBookingPrice": false, "Description": "Base Price", "Price": 269.99, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 1, "TariffName": null, "AppliedCoverageBrackets": [ { "DaysFrom": 1, "DaysTo": 2, "Amount": 200.0 }, { "DaysFrom": 3, "DaysTo": 3, "Amount": 69.99 } ] }, { "Id": 2, "IsBookingPrice": false, "Description": "Insurance", "Price": 30.0, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 0, "TariffName": null } ], "Additionals": [ { "Additional": { "Name": "GPS Navigation", "Description": null, "ImagePath": null, "IsPriceByDay": false, "Price": 29.99, "MaxQuantityPerBooking": 0, "Type": null, "Stock": 0, "Order": 0.0, "Id": 1 }, "Quantity": 1 } ], "AvailablePromotions": null, "CurrentStatus": 1, "CurrentStatusDate": "0001-01-01T00:00:00", "DeliveryTransportationId": null, "ReturnTransportationId": null, "IsCustomerOver25": false, "ExternalSystemId": null, "PrepaidAmount": 0.0, "ElegibleSIPPCodeUpgrade": null, "Attributes": {}, "ExchangeRate": null, "DailyRate": 0.0, "HourlyRate": 0.0, "ExtraDayRate": 0.0, "ExtraHourRate": 0.0, "RatePlan": null, "IsOnRequest": false, "DeliveryInfo": null, "DropoffInfo": null, "Origin": null, "CreationDate": "0001-01-01T00:00:00", "UpdatedOn": null, "UpdatedByUserName": null, "PayedByAgency": 0.0, "PayedByCustomer": 0.0, "CommercialAgreementCode": null, "PurchaseOrder": null, "Brand": null, "SalesCommision": 0.0, "IsTransfer": false, "PriceDetails": { "Price": 299.99, "CustomerPrice": 30.0, "AgencyPrice": 269.99, "SalesCommission": 0.0, "Currency": "USD" }, "Agency": null, "IsSelfCheckin": false, "Links": null, "DistanceUnit": "kilometers", "Code": null } } } }, "404": { "description": "Booking not found or not associated with the customer" }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/customer/{customerId}/paymentMethod": { "get": { "tags": [ "Customers" ], "summary": "Get customer payment method", "description": "Supported gateway IDs:\n- STRIPE: Stripe payment gateway\n- POYNT: Poynt payment gateway\n- GENIUS: Genius payment gateway\n- REDSYS: Redsys payment gateway\n- CYBERSOURCE: CyberSource payment gateway", "operationId": "CustomersApi_GetPaymentMethod", "parameters": [ { "name": "customerId", "in": "path", "required": true, "description": "The unique identifier of the customer", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "gatewayId", "in": "query", "required": true, "description": "The identifier of the payment gateway (e.g., \"STRIPE\", \"POYNT\", \"GENIUS\", \"REDSYS\", \"CYBERSOURCE\")", "schema": { "type": "string", "nullable": true }, "x-position": 2 }, { "name": "branchOfficePaymentId", "in": "query", "description": "Optional branch office payment configuration ID", "schema": { "type": "integer", "format": "int32", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "Returns payment gateway information for the customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGatewayInformationModel" }, "example": { "GatewayId": "STRIPE", "BranchOfficePaymentId": 1, "RentlyCustomerId": 123, "CreditCard": { "Type": "VISA", "Number": "**** **** **** 4242", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": "***", "CardHolderName": "John Doe" }, "PaymentGatewayConfigId": 456, "GatewayCustomerId": "cus_123456789", "GatewayPaymentMethodId": "pm_123456789", "Metadata": "{\"last4\":\"4242\",\"brand\":\"visa\"}" } } } }, "404": { "description": "Customer not found" }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } }, "post": { "tags": [ "Customers" ], "summary": "Add customer payment method", "description": "This endpoint supports adding or updating credit card information for a customer.\nThe payment method will be associated with the specified payment gateway.", "operationId": "CustomersApi_AddOrUpdatePaymentMethod", "parameters": [ { "name": "customerId", "in": "path", "required": true, "description": "The unique identifier of the customer", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "requestBody": { "x-name": "paymentInformationModel", "description": "The payment method information to add or update", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaymentGatewayInformationModel" } ] }, "example": { "GatewayId": "STRIPE", "BranchOfficePaymentId": 1, "RentlyCustomerId": 123, "CreditCard": { "Type": "VISA", "Number": "**** **** **** 4242", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": "***", "CardHolderName": "John Doe" }, "PaymentGatewayConfigId": 456, "GatewayCustomerId": "cus_123456789", "GatewayPaymentMethodId": "pm_123456789", "Metadata": "{\"last4\":\"4242\",\"brand\":\"visa\"}" } } }, "x-position": 2 }, "responses": { "200": { "description": "Payment method added or updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentGatewayInformationModel" }, "example": { "GatewayId": "STRIPE", "BranchOfficePaymentId": 1, "RentlyCustomerId": 123, "CreditCard": { "Type": "VISA", "Number": "**** **** **** 4242", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": "***", "CardHolderName": "John Doe" }, "PaymentGatewayConfigId": 456, "GatewayCustomerId": "cus_123456789", "GatewayPaymentMethodId": "pm_123456789", "Metadata": "{\"last4\":\"4242\",\"brand\":\"visa\"}" } } } }, "404": { "description": "Customer not found" }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/customer": { "post": { "tags": [ "Customers" ], "summary": "Create customer", "description": "The system checks for existing customers by document ID and email address.\nIf returnIfExist is true, it returns the existing customer instead of throwing an error.\nWhen returnIfExist is true and a GlobalId is provided, the existing customer is matched by\nGlobalId first, falling back to document ID and email address when no GlobalId match is found.", "operationId": "CustomersApi_CreateCustomer", "parameters": [ { "name": "returnIfExist", "in": "query", "description": "If true, returns existing customer instead of throwing an error when duplicate found", "schema": { "type": "boolean", "default": false }, "x-position": 2 } ], "requestBody": { "x-name": "customerModel", "description": "The customer information to create", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Customer" } ] }, "example": { "Id": 1, "GlobalId": "c277caa8-19f9-47c5-b61d-e31c9fd91a02", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:00.7308843Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:00.7308843Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:00.7308843Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:00.7308843Z", "DocumentIdExpiration": "2036-09-24T13:58:00.7308843Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null } } }, "x-position": 1 }, "responses": { "200": { "description": "Customer created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" }, "example": { "Id": 1, "GlobalId": "c59febe4-af3e-4431-93ce-1b05f43a4642", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:00.7308843Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:00.7308843Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:00.7308843Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:00.7308843Z", "DocumentIdExpiration": "2036-09-24T13:58:00.7308843Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null } } } }, "400": { "description": "Invalid customer data\nor\nApi Error", "content": { "application/json": { "schema": {} } }, "x-expectedSchemas": [ { "description": "Invalid customer data", "schema": { "$ref": "#/components/schemas/Void" } }, { "description": "Api Error", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WebApiErrorResponse" } ] } } ] }, "403": { "description": "Unauthenticated user" } } }, "put": { "tags": [ "Customers" ], "summary": "Update customer", "description": "This endpoint updates all provided fields for the customer.\nFields not included in the request will remain unchanged.", "operationId": "CustomersApi_UpdateCustomer", "requestBody": { "x-name": "customerModel", "description": "The updated customer information", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Customer" } ] }, "example": { "Id": 1, "GlobalId": "7968e950-1ccd-4e1b-b1a1-3cda8a47070d", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:00.7351418Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:00.7351418Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:00.7351418Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:00.7351418Z", "DocumentIdExpiration": "2036-09-24T13:58:00.7351418Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null } } }, "x-position": 1 }, "responses": { "200": { "description": "Customer updated successfully" }, "400": { "description": "Invalid customer data\nor\nApi Error", "content": { "application/json": { "schema": {} } }, "x-expectedSchemas": [ { "description": "Invalid customer data", "schema": { "$ref": "#/components/schemas/Void" } }, { "description": "Api Error", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WebApiErrorResponse" } ] } } ] }, "404": { "description": "Customer not found" }, "403": { "description": "Unauthenticated user" } } } }, "/api/customer/createorupdate": { "post": { "tags": [ "Customers" ], "summary": "Create or update customer", "description": "This endpoint provides upsert functionality using email as the unique identifier.\n \n- If a customer with the provided email exists, it will be updated and returned.\n- If no customer exists with that email, a new customer will be created after validating uniqueness of email and document type+number.\n \nValidation rules:\n- Email is required and used as the primary lookup key\n- If Id or GlobalId are provided (non-zero/non-empty), the request will be rejected with 400 - use UpdateCustomer endpoint instead\n- For new customers: validates that email and document type+number combination don't already exist\n- For updates: if document type or number changed, validates the new combination isn't used by another customer (requires permissions)", "operationId": "CustomersApi_CreateOrUpdateCustomer", "requestBody": { "x-name": "customerModel", "description": "The customer information to create or update", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Customer" } ] }, "example": { "Id": 1, "GlobalId": "d37d7404-044e-4992-8711-e0aeb35f1a95", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:00.7401481Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:00.7401481Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:00.7401481Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:00.7401481Z", "DocumentIdExpiration": "2036-09-24T13:58:00.7401481Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null } } }, "x-position": 1 }, "responses": { "200": { "description": "Customer created or updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" }, "example": { "Id": 1, "GlobalId": "0b07cc1e-5206-4514-8ff6-49aeb2b34c74", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:00.7401481Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:00.7401481Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:00.7401481Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:00.7401481Z", "DocumentIdExpiration": "2036-09-24T13:58:00.7401481Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null } } } }, "400": { "description": "Invalid customer data or ID/GlobalID provided\nor\nApi Error", "content": { "application/json": { "schema": {} } }, "x-expectedSchemas": [ { "description": "Invalid customer data or ID/GlobalID provided", "schema": { "$ref": "#/components/schemas/Void" } }, { "description": "Api Error", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WebApiErrorResponse" } ] } } ] }, "403": { "description": "Unauthenticated user" } } } }, "/api/customer/{customerId}": { "get": { "tags": [ "Customers" ], "summary": "Get customer", "description": "This endpoint supports both numeric customer IDs and global IDs.\nFor customers with applicable commercial agreements, it includes the list of valid agreement codes.", "operationId": "CustomersApi_GetCustomer", "parameters": [ { "name": "customerId", "in": "path", "required": true, "description": "The customer's ID or global ID", "schema": { "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Returns the customer details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" }, "example": { "Id": 1, "GlobalId": "289a7bbe-64d0-4692-ab97-a2c8b61642db", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:00.7426665Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:00.7426665Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:00.7426665Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:00.7426665Z", "DocumentIdExpiration": "2036-09-24T13:58:00.7426665Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null } } } }, "404": { "description": "Customer not found" }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/customer/{customerId}/priceagreement": { "patch": { "tags": [ "Customers" ], "summary": "Update customer price agreement", "description": "This endpoint supports both numeric customer IDs and global IDs.\nIt only changes the customer's price agreement; every other customer field remains unchanged.\nSending a null PriceAgreementId (or omitting it) unassigns the customer's current price agreement.\nA comment is added to the customer's record registering the previous and the new price agreement.\nRequires the price agreements feature to be enabled for the tenant and the CanUsePriceAgreements permission.", "operationId": "CustomersApi_UpdateCustomerPriceAgreement", "parameters": [ { "name": "customerId", "in": "path", "required": true, "description": "The customer's ID or global ID", "schema": { "type": "string", "nullable": true }, "x-position": 1 } ], "requestBody": { "x-name": "model", "description": "The price agreement to assign", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/UpdateCustomerPriceAgreementModel" } ] } } }, "x-position": 2 }, "responses": { "200": { "description": "Price agreement updated successfully" }, "400": { "description": "Invalid data or feature not enabled\nor\nApi Error", "content": { "application/json": { "schema": {} } }, "x-expectedSchemas": [ { "description": "Invalid data or feature not enabled", "schema": { "$ref": "#/components/schemas/Void" } }, { "description": "Api Error", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WebApiErrorResponse" } ] } } ] }, "404": { "description": "Customer or price agreement not found" }, "403": { "description": "Unauthenticated user" } } } }, "/api/customer/{customerId}/comments": { "post": { "tags": [ "Customers" ], "summary": "Add customer comment", "description": "Comments can be used to track important information or interactions with the customer.", "operationId": "CustomersApi_AddCustomerComment", "parameters": [ { "name": "customerId", "in": "path", "required": true, "description": "The unique identifier of the customer", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "requestBody": { "x-name": "commentModel", "description": "The comment information to add", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AddCustomerCommentModel" } ] }, "example": { "Message": "Customer called to confirm their booking details. All information was correct.", "CommentType": 1, "Important": true } } }, "x-position": 2 }, "responses": { "200": { "description": "Comment added successfully" }, "400": { "description": "Invalid comment data\nor\nApi Error", "content": { "application/json": { "schema": {} } }, "x-expectedSchemas": [ { "description": "Invalid comment data", "schema": { "$ref": "#/components/schemas/Void" } }, { "description": "Api Error", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WebApiErrorResponse" } ] } } ] }, "404": { "description": "Customer not found" }, "403": { "description": "Unauthenticated user" } } } }, "/api/customer/{customerId}/attachments": { "get": { "tags": [ "Customers" ], "summary": "List customer attachments", "description": "This endpoint returns the paths of all files attached to the customer's record.", "operationId": "CustomersApi_GetCustomerAttachments", "parameters": [ { "name": "customerId", "in": "path", "required": true, "description": "The unique identifier of the customer", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "Returns the list of attachment paths", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [ { "Path": "infractions/123/ticket.pdf", "Name": "Traffic Ticket.pdf", "Category": "Ticket", "Hash": null }, { "Path": "infractions/123/payment_receipt.pdf", "Name": "Payment Receipt.pdf", "Category": "Receipt", "Hash": null } ] } } }, "404": { "description": "Customer not found" }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } }, "post": { "tags": [ "Customers" ], "summary": "Attach files to customer", "description": "Each file should include its name, content (base64 encoded), and type.\nThe files will be stored in the system and associated with the customer.", "operationId": "CustomersApi_AttachFilesToCustomer", "parameters": [ { "name": "customerId", "in": "path", "required": true, "description": "The unique identifier of the customer", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "requestBody": { "x-name": "files", "description": "The list of files to attach", "content": { "application/json": { "schema": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/FileModel" } }, "example": [ { "Name": "inspection_report.pdf", "Content": "AQIDBAU=", "Type": "Inspection" }, { "Name": "damage_photos.jpg", "Content": "BgcICQo=", "Type": "Photos" } ] } }, "x-position": 2 }, "responses": { "200": { "description": "Files attached successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } }, "example": [ { "Path": "infractions/123/ticket.pdf", "Name": "Traffic Ticket.pdf", "Category": "Ticket", "Hash": null }, { "Path": "infractions/123/payment_receipt.pdf", "Name": "Payment Receipt.pdf", "Category": "Receipt", "Hash": null } ] } } }, "400": { "description": "Invalid file data\nor\nApi Error", "content": { "application/json": { "schema": {} } }, "x-expectedSchemas": [ { "description": "Invalid file data", "schema": { "$ref": "#/components/schemas/Void" } }, { "description": "Api Error", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WebApiErrorResponse" } ] } } ] }, "404": { "description": "Customer not found" }, "403": { "description": "Unauthenticated user" } } } }, "/api/customer/{customerId}/document-images": { "post": { "tags": [ "Customers" ], "summary": "Upload customer documents", "description": "This endpoint uploads up to 4 images via multipart/form-data using specific field names:\n- documentFront: Front of identification document\n- documentBack: Back of identification document\n- licenseFront: Front of driver license\n- licenseBack: Back of driver license\n \nAll fields are optional. Only provided images will be uploaded and assigned.\nFiles are automatically renamed with normalized format: customer-{customerId}-{type}-{guid}.{ext}\nContent-Type must be multipart/form-data.", "operationId": "CustomersApi_UploadCustomerDocumentImages", "parameters": [ { "name": "customerId", "in": "path", "required": true, "description": "The unique identifier of the customer", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "Document images uploaded successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerDocumentImagesUploadResponse" }, "example": { "CustomerId": 123, "UploadResults": { "documentfront": { "Success": true, "FileId": 1001, "Url": "https://blob.com/uploads/documents/customer-123-documentfront-abc123.jpg", "Error": null }, "documentback": { "Success": true, "FileId": 1002, "Url": "https://blob.com/uploads/documents/customer-123-documentback-def456.jpg", "Error": null }, "licensefront": { "Success": true, "FileId": 1003, "Url": "https://blob.com/uploads/documents/customer-123-licensefront-ghi789.jpg", "Error": null }, "licenseback": { "Success": true, "FileId": 1004, "Url": "https://blob.com/uploads/documents/customer-123-licenseback-jkl012.jpg", "Error": null } }, "DocumentImages": { "FrontImageId": 1001, "FrontImageUrl": "https://blob.com/uploads/documents/customer-123-documentfront-abc123.jpg", "BackImageId": 1002, "BackImageUrl": "https://blob.com/uploads/documents/customer-123-documentback-def456.jpg" }, "DriverLicenseImages": { "FrontImageId": 1003, "FrontImageUrl": "https://blob.com/uploads/documents/customer-123-licensefront-ghi789.jpg", "BackImageId": 1004, "BackImageUrl": "https://blob.com/uploads/documents/customer-123-licenseback-jkl012.jpg" } } } } }, "400": { "description": "Unsupported media type or invalid data\nor\nApi Error", "content": { "application/json": { "schema": {} } }, "x-expectedSchemas": [ { "description": "Unsupported media type or invalid data", "schema": { "$ref": "#/components/schemas/Void" } }, { "description": "Api Error", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WebApiErrorResponse" } ] } } ] }, "404": { "description": "Customer not found" }, "403": { "description": "Unauthenticated user" } } } }, "/api/damages": { "get": { "tags": [ "Damages" ], "summary": "List damages", "description": "Lista los daños de un auto, opcionalmente filtrados por estado.", "operationId": "Damages_GetDamages", "parameters": [ { "name": "carId", "in": "query", "required": true, "schema": { "type": "string", "nullable": true }, "x-position": 1 }, { "name": "status", "in": "query", "schema": { "oneOf": [ { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DamageStatusEnum" } ] } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } }, "post": { "tags": [ "Damages" ], "summary": "Create damage", "description": "Crea un daño marcado por un empleado (Active o PossibleDuplicate según el detector).", "operationId": "Damages_CreateDamage", "requestBody": { "x-name": "model", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DamageCreateModel" } ] } } }, "x-position": 1 }, "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/damages/{id}": { "get": { "tags": [ "Damages" ], "summary": "Get damage", "description": "Obtiene un daño por su Id. 404 si no existe.", "operationId": "Damages_GetDamage", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } }, "put": { "tags": [ "Damages" ], "summary": "Update damage", "description": "Edita los campos manuales de un daño (tipo, descripción, precio, color, ubicación). No cambia el estado.", "operationId": "Damages_UpdateDamage", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "requestBody": { "x-name": "model", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DamageUpdateModel" } ] } } }, "x-position": 2 }, "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } }, "delete": { "tags": [ "Damages" ], "summary": "Delete damage", "description": "Elimina un daño y sus vínculos a services. 404 si no existe.", "operationId": "Damages_DeleteDamage", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/damages/{id}/validate": { "post": { "tags": [ "Damages" ], "summary": "Validate damage", "description": "Aprueba o rechaza un daño en PendingValidation. 409 si el estado ya cambió.", "operationId": "Damages_Validate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "requestBody": { "x-name": "model", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DamageValidateModel" } ] } } }, "x-position": 2 }, "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/damages/{id}/confirm-duplicate": { "post": { "tags": [ "Damages" ], "summary": "Confirm damage duplicate", "description": "Confirma que un daño es duplicado de otro (lo rechaza y setea DuplicateOfId). 409 si cambió.", "operationId": "Damages_ConfirmDuplicate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "requestBody": { "x-name": "model", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ConfirmDuplicateModel" } ] } } }, "x-position": 2 }, "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/damages/{id}/dismiss-duplicate": { "post": { "tags": [ "Damages" ], "summary": "Dismiss damage duplicate", "description": "Desestima la sugerencia de duplicado (el daño pasa a Active). 409 si cambió.", "operationId": "Damages_DismissDuplicate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/damages/{id}/duplicate-candidates": { "get": { "tags": [ "Damages" ], "summary": "List damage duplicate candidates", "description": "Devuelve posibles duplicados del daño según la heurística del detector.", "operationId": "Damages_DuplicateCandidates", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/damages/link-to-service": { "post": { "tags": [ "Damages" ], "summary": "Link damages to service", "description": "Vincula daños Active a un Service (pasan a InRepair). Devuelve la cantidad vinculada.", "operationId": "Damages_LinkToService", "requestBody": { "x-name": "model", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/LinkDamagesToServiceModel" } ] } } }, "x-position": 1 }, "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/damage-type-settings": { "get": { "tags": [ "DamageTypeSettings" ], "summary": "List damage type settings", "description": "Configuración efectiva de todos los tipos de daño (enum + override + defaults).", "operationId": "DamageTypeSettings_GetAll", "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/damage-type-settings/{type}": { "put": { "tags": [ "DamageTypeSettings" ], "summary": "Update damage type setting", "description": "Crea o actualiza el override de un tipo de daño.", "operationId": "DamageTypeSettings_Upsert", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/DamageTypeEnum" }, "x-position": 1 } ], "requestBody": { "x-name": "model", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DamageTypeSettingUpdateModel" } ] } } }, "x-position": 2 }, "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } }, "delete": { "tags": [ "DamageTypeSettings" ], "summary": "Delete damage type setting", "description": "Borra el override de un tipo de daño (vuelve a los defaults del código).", "operationId": "DamageTypeSettings_Reset", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/DamageTypeEnum" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/incidents/type": { "get": { "tags": [ "Incidents" ], "summary": "List incident types", "description": "Retrieves all the existint incident types", "operationId": "Incidents_GetIncidentTypes", "responses": { "200": { "description": "Returns the list of incident types", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentType" } }, "example": [ { "Id": 1, "Name": "Choque", "FranchiseType": 0, "Incidents": [] }, { "Id": 2, "Name": "choque frontal", "FranchiseType": 0, "Incidents": [] }, { "Id": 3, "Name": "robo", "FranchiseType": 0, "Incidents": [] }, { "Id": 4, "Name": "robo estereo", "FranchiseType": 0, "Incidents": [] }, { "Id": 5, "Name": "rotura cristales", "FranchiseType": 0, "Incidents": [] }, { "Id": 6, "Name": "VIDRIOS TESTS", "FranchiseType": 0, "Incidents": [] }, { "Id": 7, "Name": "Espejo retrovisor", "FranchiseType": 0, "Incidents": [] } ] } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/incidents/{incidentId}": { "get": { "tags": [ "Incidents" ], "summary": "Get incident", "description": "Retrieves an incident by its id", "operationId": "Incidents_GetIncident", "parameters": [ { "name": "incidentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "Returns an incident by Id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Incident" }, "example": { "Id": 15, "IncidentDate": "2024-04-24T10:00:00", "CarId": "ABC123", "IncidentTypeId": 5, "BookingId": 3001, "Notes": "Some notes no larger than 1000 chars", "HasRecovery": true, "Files": [ { "Path": "https://example.com/test.jpg", "Name": "test.jpg" } ] } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/incidents": { "post": { "tags": [ "Incidents" ], "summary": "Create incident", "description": "Adds an incident", "operationId": "Incidents_AddIncident", "requestBody": { "x-name": "model", "description": "Incident to be added", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AddIncidentModel" } ] }, "example": { "IncidentDate": "2024-04-24T10:00:00", "CarId": "ABC123", "IncidentTypeId": 1, "BookingId": 3001, "Notes": "Some random text no larger than 1000 chars", "HasRecovery": true } } }, "x-position": 1 }, "responses": { "200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Incident" }, "example": { "Id": 15, "IncidentDate": "2024-04-24T10:00:00", "CarId": "ABC123", "IncidentTypeId": 5, "BookingId": 3001, "Notes": "Some notes no larger than 1000 chars", "HasRecovery": true, "Files": [ { "Path": "https://example.com/test.jpg", "Name": "test.jpg" } ] } } } }, "400": { "description": "Invalid model state\nor\nApi Error", "content": { "application/json": { "schema": {} } }, "x-expectedSchemas": [ { "description": "Invalid model state", "schema": { "$ref": "#/components/schemas/Void" } }, { "description": "Api Error", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WebApiErrorResponse" } ] } } ] }, "403": { "description": "Unauthenticated user" } } } }, "/api/incidents/{incidentId}/files": { "post": { "tags": [ "Incidents" ], "summary": "Attach files to incident", "description": "Adds files to an incident", "operationId": "Incidents_AddFiles", "parameters": [ { "name": "incidentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "Created", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentFile" } }, "example": [ { "Path": "https://example.com/test.jpj", "Name": "test.jpg" }, { "Path": "https://example.com/test2.jpj", "Name": "test2.jpg" } ] } } }, "400": { "description": "Unsupported media type. Expected multipart/form-data.\nor\nNo files provided\nor\nApi Error", "content": { "application/json": { "schema": {} } }, "x-expectedSchemas": [ { "description": "Unsupported media type. Expected multipart/form-data.", "schema": { "$ref": "#/components/schemas/Void" } }, { "description": "No files provided", "schema": { "$ref": "#/components/schemas/Void" } }, { "description": "Api Error", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WebApiErrorResponse" } ] } } ] }, "404": { "description": "Incident not found." }, "403": { "description": "Unauthenticated user" } } } }, "/api/booking/addinfractions": { "post": { "tags": [ "Infractions" ], "summary": "Add infractions to booking", "description": "Items may include an optional InfractionNoticeId to link the infraction to an InfractionNotice,\nhonored only when the EnableInfractionNotices feature is on (otherwise ignored). Links are\nvalidated before anything is created, so any invalid link fails the whole batch with 400 and nothing\nis persisted.", "operationId": "Infractions_AddInfractions", "requestBody": { "x-name": "model", "description": "List of infractions to add", "content": { "application/json": { "schema": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/AddInfractionModel" } }, "example": { "ReqId": 1, "BookingId": 123, "Date": "2024-04-24T10:00:00", "Act": "SPEED_VIOLATION", "InfractionAmount": 150.0, "FeeAmount": 25.0, "PrincipalAmount": 150.0, "AmountToPay": 120.0, "AmountToPayAfterDueDate": 180.0, "Jurisdiction": "New York", "InfractionType": "SpeedingTicket", "InfractionNoticeId": null } } }, "x-position": 1 }, "responses": { "200": { "description": "List of processed infractions", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddInfractionResponse" } }, "example": { "ReqId": 1, "Status": "Paid", "InfractionId": 456, "PaymentUrl": "https://example.com/payment/456", "StatusDescription": null } } } }, "400": { "description": "Invalid model state\nor\nApi Error", "content": { "application/json": { "schema": {} } }, "x-expectedSchemas": [ { "description": "Invalid model state", "schema": { "$ref": "#/components/schemas/Void" } }, { "description": "Api Error", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WebApiErrorResponse" } ] } } ] }, "403": { "description": "Unauthenticated user" } } } }, "/api/customer/{customerId}/infractions/{infractionId}": { "get": { "tags": [ "Infractions" ], "summary": "Get customer infraction", "description": "Retrieves a specific infraction for a customer.", "operationId": "Infractions_GetInfraction", "parameters": [ { "name": "customerId", "in": "path", "required": true, "description": "The ID of the customer", "schema": { "type": "string", "nullable": true }, "x-position": 1 }, { "name": "infractionId", "in": "path", "required": true, "description": "The ID of the infraction", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 } ], "responses": { "200": { "description": "The infraction details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Infraction" }, "example": { "Id": 1, "BookingId": 123, "CreationDate": "2026-09-24T13:58:01.1670987Z", "Date": "2026-09-23T13:58:01.1670987Z", "Amount": 150.0, "PrincipalAmount": 150.0, "CurrentCollectionStatus": { "Date": "2026-09-24T13:58:01.1670987Z", "Status": 1 }, "Booking": { "Id": 1, "Version": null, "Customer": { "Id": 1, "GlobalId": "54d409de-6721-4064-8282-2b8657959118", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:01.1686093Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:01.1686093Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:01.1686093Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:01.1686093Z", "DocumentIdExpiration": "2036-09-24T13:58:01.1686093Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null }, "Balance": 0.0, "TotalPayed": 0.0, "Extra": null, "Promotion": null, "IsQuotation": false, "Car": { "Id": "CAR123", "Model": { "Description": "The Toyota Corolla is a reliable and fuel-efficient compact sedan with modern features and comfortable interior.", "ImagePath": "/images/models/corolla.jpg", "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 750.0, "FranchiseTheft": 1000.0, "FranchiseHail": 500.0, "Brand": { "Name": "Toyota" }, "Doors": 4, "Passengers": 5, "BigLuggage": 2, "SmallLuggage": 2, "Steering": "Power Steering", "SteeringType": 3, "Gearbox": "Automatic", "TransmissionType": 2, "Multimedia": "Bluetooth, Navigation System", "AirConditioner": "Automatic Climate Control", "AirConditionerType": 1, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": [ { "Id": 1, "Name": "Fuel Type", "Description": "Type of fuel used by the vehicle", "Type": 0, "Unit": "Type", "Value": "Gasoline", "ModelId": 1 }, { "Id": 2, "Name": "Engine Size", "Description": "Engine displacement", "Type": 1, "Unit": "Liters", "Value": "1.8", "ModelId": 1 }, { "Id": 3, "Name": "Transmission", "Description": "Type of transmission", "Type": 0, "Unit": "Type", "Value": "Automatic", "ModelId": 1 } ], "LowerPrice": 45.0, "Id": 1, "Name": "Corolla", "Category": { "Models": null, "Id": 1, "Name": "Economy", "Order": 1.0, "PrincipalModelId": null, "Franchise": 0.0, "FranchiseDamage": 0.0, "FranchiseRollover": 0.0, "FranchiseTheft": 0.0, "FranchiseHail": 0.0, "ImagePath": null }, "SIPP": "CDMR" }, "CurrentBranchOfficeId": 1, "CurrentBranchOffice": "LAX Branch", "BranchOfficeOwner": "Rently LAX Airport", "CurrentKms": 50000, "FuelType": "Gasoline", "Gasoline": 75, "FriendlyName": "Toyota Corolla 2023", "CurrentPlateId": "ABC123", "ChassisIdentification": "1HGCM82633A123456", "CurrentPlate": { "Id": "ABC123", "IssuingCountry": "United States", "IssuingState": "CA" }, "Color": "Silver", "Year": 2023, "TollDeviceId": "TOLL123", "BatteryNumber": "BAT123456", "CreationDate": "0001-01-01T00:00:00", "InactiveDate": null, "LeasedToCompany": null, "SupplierFullName": null, "LastReturnDate": null }, "Model": null, "Category": { "Models": [ { "Description": null, "ImagePath": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "Brand": { "Name": "Toyota" }, "Doors": 0, "Passengers": 0, "BigLuggage": 0, "SmallLuggage": 0, "Steering": null, "SteeringType": null, "Gearbox": null, "TransmissionType": null, "Multimedia": null, "AirConditioner": null, "AirConditionerType": null, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": null, "LowerPrice": 45.0, "Id": 1, "Name": "Toyota Yaris", "Category": null, "SIPP": null } ], "Id": 1, "Name": "Economy", "Order": 0.0, "PrincipalModelId": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "ImagePath": null }, "FromDate": "2026-09-25T13:58:01.1686093Z", "ToDate": "2026-09-28T13:58:01.1686093Z", "DeliveryPlace": { "Price": 0.0, "Name": "Airport Terminal 1", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 1 }, "ReturnPlace": { "Price": 0.0, "Name": "Downtown Branch", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 2 }, "TotalDaysString": "3 days", "Price": 299.99, "AgencyPrice": 269.99, "CustomerPrice": 30.0, "Currency": "USD", "Franchise": null, "FranchiseDamage": null, "FranchiseRollover": null, "FranchiseTheft": null, "FranchiseHail": null, "TotalDays": 0.0, "IlimitedKm": false, "MaxAllowedDistance": 0, "MaxAllowedDistanceByDay": 0, "HasFranchiseModifiers": false, "WillLeaveCountry": null, "AverageDayPrice": 0.0, "PriceItems": [ { "Id": 1, "IsBookingPrice": false, "Description": "Base Price", "Price": 269.99, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 1, "TariffName": null, "AppliedCoverageBrackets": [ { "DaysFrom": 1, "DaysTo": 2, "Amount": 200.0 }, { "DaysFrom": 3, "DaysTo": 3, "Amount": 69.99 } ] }, { "Id": 2, "IsBookingPrice": false, "Description": "Insurance", "Price": 30.0, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 0, "TariffName": null } ], "Additionals": [ { "Additional": { "Name": "GPS Navigation", "Description": null, "ImagePath": null, "IsPriceByDay": false, "Price": 29.99, "MaxQuantityPerBooking": 0, "Type": null, "Stock": 0, "Order": 0.0, "Id": 1 }, "Quantity": 1 } ], "AvailablePromotions": null, "CurrentStatus": 1, "CurrentStatusDate": "0001-01-01T00:00:00", "DeliveryTransportationId": null, "ReturnTransportationId": null, "IsCustomerOver25": false, "ExternalSystemId": null, "PrepaidAmount": 0.0, "ElegibleSIPPCodeUpgrade": null, "Attributes": {}, "ExchangeRate": null, "DailyRate": 0.0, "HourlyRate": 0.0, "ExtraDayRate": 0.0, "ExtraHourRate": 0.0, "RatePlan": null, "IsOnRequest": false, "DeliveryInfo": null, "DropoffInfo": null, "Origin": null, "CreationDate": "0001-01-01T00:00:00", "UpdatedOn": null, "UpdatedByUserName": null, "PayedByAgency": 0.0, "PayedByCustomer": 0.0, "CommercialAgreementCode": null, "PurchaseOrder": null, "Brand": null, "SalesCommision": 0.0, "IsTransfer": false, "PriceDetails": { "Price": 299.99, "CustomerPrice": 30.0, "AgencyPrice": 269.99, "SalesCommission": 0.0, "Currency": "USD" }, "Agency": null, "IsSelfCheckin": false, "Links": null, "DistanceUnit": "kilometers", "Code": null }, "Car": { "Id": "CAR123", "Model": { "Description": "The Toyota Corolla is a reliable and fuel-efficient compact sedan with modern features and comfortable interior.", "ImagePath": "/images/models/corolla.jpg", "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 750.0, "FranchiseTheft": 1000.0, "FranchiseHail": 500.0, "Brand": { "Name": "Toyota" }, "Doors": 4, "Passengers": 5, "BigLuggage": 2, "SmallLuggage": 2, "Steering": "Power Steering", "SteeringType": 3, "Gearbox": "Automatic", "TransmissionType": 2, "Multimedia": "Bluetooth, Navigation System", "AirConditioner": "Automatic Climate Control", "AirConditionerType": 1, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": [ { "Id": 1, "Name": "Fuel Type", "Description": "Type of fuel used by the vehicle", "Type": 0, "Unit": "Type", "Value": "Gasoline", "ModelId": 1 }, { "Id": 2, "Name": "Engine Size", "Description": "Engine displacement", "Type": 1, "Unit": "Liters", "Value": "1.8", "ModelId": 1 }, { "Id": 3, "Name": "Transmission", "Description": "Type of transmission", "Type": 0, "Unit": "Type", "Value": "Automatic", "ModelId": 1 } ], "LowerPrice": 45.0, "Id": 1, "Name": "Corolla", "Category": { "Models": null, "Id": 1, "Name": "Economy", "Order": 1.0, "PrincipalModelId": null, "Franchise": 0.0, "FranchiseDamage": 0.0, "FranchiseRollover": 0.0, "FranchiseTheft": 0.0, "FranchiseHail": 0.0, "ImagePath": null }, "SIPP": "CDMR" }, "CurrentBranchOfficeId": 1, "CurrentBranchOffice": "LAX Branch", "BranchOfficeOwner": "Rently LAX Airport", "CurrentKms": 50000, "FuelType": "Gasoline", "Gasoline": 75, "FriendlyName": "Toyota Corolla 2023", "CurrentPlateId": "ABC123", "ChassisIdentification": "1HGCM82633A123456", "CurrentPlate": { "Id": "ABC123", "IssuingCountry": "United States", "IssuingState": "CA" }, "Color": "Silver", "Year": 2023, "TollDeviceId": "TOLL123", "BatteryNumber": "BAT123456", "CreationDate": "0001-01-01T00:00:00", "InactiveDate": null, "LeasedToCompany": null, "SupplierFullName": null, "LastReturnDate": null }, "Attachment": "infractions/123/ticket.pdf", "Act": "TKT-123456", "InfractionNoticeId": null } } } }, "404": { "description": "Customer or infraction not found" }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/customer/{customerId}/infractions": { "get": { "tags": [ "Infractions" ], "summary": "List customer infractions", "description": "This endpoint returns a paginated list of all infractions associated with the specified customer.\nThe response includes the total count of infractions, current offset, limit, and the list of infractions.\nEach infraction includes details such as ID, booking information, amount, status, and associated files.", "operationId": "Infractions_GetInfractionsForCustomer", "parameters": [ { "name": "customerId", "in": "path", "required": true, "description": "The unique identifier of the customer", "schema": { "type": "string", "nullable": true }, "x-position": 1 }, { "name": "offset", "in": "query", "description": "The number of records to skip (default: 0)", "schema": { "type": "integer", "format": "int32", "default": 0 }, "x-position": 2 }, { "name": "limit", "in": "query", "description": "The maximum number of records to return (default: 30)", "schema": { "type": "integer", "format": "int32", "default": 30 }, "x-position": 3 } ], "responses": { "200": { "description": "Returns the list of infractions with pagination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultOfInfraction" }, "example": { "Offset": 0, "Limit": 30, "Total": 2, "Results": [ { "Id": 1, "BookingId": 123, "CreationDate": "2026-09-24T13:58:01.1866665Z", "Date": "2026-09-23T13:58:01.1866665Z", "Amount": 150.0, "PrincipalAmount": null, "CurrentCollectionStatus": { "Date": "2026-09-24T13:58:01.1866665Z", "Status": 1 }, "Booking": { "Id": 1, "Version": null, "Customer": { "Id": 1, "GlobalId": "f1ef29fc-b185-47e7-87aa-b24bb0306da0", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:01.1866665Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:01.1866665Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:01.1866665Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:01.1866665Z", "DocumentIdExpiration": "2036-09-24T13:58:01.1866665Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null }, "Balance": 0.0, "TotalPayed": 0.0, "Extra": null, "Promotion": null, "IsQuotation": false, "Car": { "Id": "CAR123", "Model": { "Description": "The Toyota Corolla is a reliable and fuel-efficient compact sedan with modern features and comfortable interior.", "ImagePath": "/images/models/corolla.jpg", "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 750.0, "FranchiseTheft": 1000.0, "FranchiseHail": 500.0, "Brand": { "Name": "Toyota" }, "Doors": 4, "Passengers": 5, "BigLuggage": 2, "SmallLuggage": 2, "Steering": "Power Steering", "SteeringType": 3, "Gearbox": "Automatic", "TransmissionType": 2, "Multimedia": "Bluetooth, Navigation System", "AirConditioner": "Automatic Climate Control", "AirConditionerType": 1, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": [ { "Id": 1, "Name": "Fuel Type", "Description": "Type of fuel used by the vehicle", "Type": 0, "Unit": "Type", "Value": "Gasoline", "ModelId": 1 }, { "Id": 2, "Name": "Engine Size", "Description": "Engine displacement", "Type": 1, "Unit": "Liters", "Value": "1.8", "ModelId": 1 }, { "Id": 3, "Name": "Transmission", "Description": "Type of transmission", "Type": 0, "Unit": "Type", "Value": "Automatic", "ModelId": 1 } ], "LowerPrice": 45.0, "Id": 1, "Name": "Corolla", "Category": { "Models": null, "Id": 1, "Name": "Economy", "Order": 1.0, "PrincipalModelId": null, "Franchise": 0.0, "FranchiseDamage": 0.0, "FranchiseRollover": 0.0, "FranchiseTheft": 0.0, "FranchiseHail": 0.0, "ImagePath": null }, "SIPP": "CDMR" }, "CurrentBranchOfficeId": 1, "CurrentBranchOffice": "LAX Branch", "BranchOfficeOwner": "Rently LAX Airport", "CurrentKms": 50000, "FuelType": "Gasoline", "Gasoline": 75, "FriendlyName": "Toyota Corolla 2023", "CurrentPlateId": "ABC123", "ChassisIdentification": "1HGCM82633A123456", "CurrentPlate": { "Id": "ABC123", "IssuingCountry": "United States", "IssuingState": "CA" }, "Color": "Silver", "Year": 2023, "TollDeviceId": "TOLL123", "BatteryNumber": "BAT123456", "CreationDate": "0001-01-01T00:00:00", "InactiveDate": null, "LeasedToCompany": null, "SupplierFullName": null, "LastReturnDate": null }, "Model": null, "Category": { "Models": [ { "Description": null, "ImagePath": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "Brand": { "Name": "Toyota" }, "Doors": 0, "Passengers": 0, "BigLuggage": 0, "SmallLuggage": 0, "Steering": null, "SteeringType": null, "Gearbox": null, "TransmissionType": null, "Multimedia": null, "AirConditioner": null, "AirConditionerType": null, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": null, "LowerPrice": 45.0, "Id": 1, "Name": "Toyota Yaris", "Category": null, "SIPP": null } ], "Id": 1, "Name": "Economy", "Order": 0.0, "PrincipalModelId": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "ImagePath": null }, "FromDate": "2026-09-25T13:58:01.1866665Z", "ToDate": "2026-09-28T13:58:01.1866665Z", "DeliveryPlace": { "Price": 0.0, "Name": "Airport Terminal 1", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 1 }, "ReturnPlace": { "Price": 0.0, "Name": "Downtown Branch", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 2 }, "TotalDaysString": "3 days", "Price": 299.99, "AgencyPrice": 269.99, "CustomerPrice": 30.0, "Currency": "USD", "Franchise": null, "FranchiseDamage": null, "FranchiseRollover": null, "FranchiseTheft": null, "FranchiseHail": null, "TotalDays": 0.0, "IlimitedKm": false, "MaxAllowedDistance": 0, "MaxAllowedDistanceByDay": 0, "HasFranchiseModifiers": false, "WillLeaveCountry": null, "AverageDayPrice": 0.0, "PriceItems": [ { "Id": 1, "IsBookingPrice": false, "Description": "Base Price", "Price": 269.99, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 1, "TariffName": null, "AppliedCoverageBrackets": [ { "DaysFrom": 1, "DaysTo": 2, "Amount": 200.0 }, { "DaysFrom": 3, "DaysTo": 3, "Amount": 69.99 } ] }, { "Id": 2, "IsBookingPrice": false, "Description": "Insurance", "Price": 30.0, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 0, "TariffName": null } ], "Additionals": [ { "Additional": { "Name": "GPS Navigation", "Description": null, "ImagePath": null, "IsPriceByDay": false, "Price": 29.99, "MaxQuantityPerBooking": 0, "Type": null, "Stock": 0, "Order": 0.0, "Id": 1 }, "Quantity": 1 } ], "AvailablePromotions": null, "CurrentStatus": 1, "CurrentStatusDate": "0001-01-01T00:00:00", "DeliveryTransportationId": null, "ReturnTransportationId": null, "IsCustomerOver25": false, "ExternalSystemId": null, "PrepaidAmount": 0.0, "ElegibleSIPPCodeUpgrade": null, "Attributes": {}, "ExchangeRate": null, "DailyRate": 0.0, "HourlyRate": 0.0, "ExtraDayRate": 0.0, "ExtraHourRate": 0.0, "RatePlan": null, "IsOnRequest": false, "DeliveryInfo": null, "DropoffInfo": null, "Origin": null, "CreationDate": "0001-01-01T00:00:00", "UpdatedOn": null, "UpdatedByUserName": null, "PayedByAgency": 0.0, "PayedByCustomer": 0.0, "CommercialAgreementCode": null, "PurchaseOrder": null, "Brand": null, "SalesCommision": 0.0, "IsTransfer": false, "PriceDetails": { "Price": 299.99, "CustomerPrice": 30.0, "AgencyPrice": 269.99, "SalesCommission": 0.0, "Currency": "USD" }, "Agency": null, "IsSelfCheckin": false, "Links": null, "DistanceUnit": "kilometers", "Code": null }, "Car": { "Id": "CAR123", "Model": { "Description": "The Toyota Corolla is a reliable and fuel-efficient compact sedan with modern features and comfortable interior.", "ImagePath": "/images/models/corolla.jpg", "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 750.0, "FranchiseTheft": 1000.0, "FranchiseHail": 500.0, "Brand": { "Name": "Toyota" }, "Doors": 4, "Passengers": 5, "BigLuggage": 2, "SmallLuggage": 2, "Steering": "Power Steering", "SteeringType": 3, "Gearbox": "Automatic", "TransmissionType": 2, "Multimedia": "Bluetooth, Navigation System", "AirConditioner": "Automatic Climate Control", "AirConditionerType": 1, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": [ { "Id": 1, "Name": "Fuel Type", "Description": "Type of fuel used by the vehicle", "Type": 0, "Unit": "Type", "Value": "Gasoline", "ModelId": 1 }, { "Id": 2, "Name": "Engine Size", "Description": "Engine displacement", "Type": 1, "Unit": "Liters", "Value": "1.8", "ModelId": 1 }, { "Id": 3, "Name": "Transmission", "Description": "Type of transmission", "Type": 0, "Unit": "Type", "Value": "Automatic", "ModelId": 1 } ], "LowerPrice": 45.0, "Id": 1, "Name": "Corolla", "Category": { "Models": null, "Id": 1, "Name": "Economy", "Order": 1.0, "PrincipalModelId": null, "Franchise": 0.0, "FranchiseDamage": 0.0, "FranchiseRollover": 0.0, "FranchiseTheft": 0.0, "FranchiseHail": 0.0, "ImagePath": null }, "SIPP": "CDMR" }, "CurrentBranchOfficeId": 1, "CurrentBranchOffice": "LAX Branch", "BranchOfficeOwner": "Rently LAX Airport", "CurrentKms": 50000, "FuelType": "Gasoline", "Gasoline": 75, "FriendlyName": "Toyota Corolla 2023", "CurrentPlateId": "ABC123", "ChassisIdentification": "1HGCM82633A123456", "CurrentPlate": { "Id": "ABC123", "IssuingCountry": "United States", "IssuingState": "CA" }, "Color": "Silver", "Year": 2023, "TollDeviceId": "TOLL123", "BatteryNumber": "BAT123456", "CreationDate": "0001-01-01T00:00:00", "InactiveDate": null, "LeasedToCompany": null, "SupplierFullName": null, "LastReturnDate": null }, "Attachment": null, "Act": null, "InfractionNoticeId": null } ], "NextOffset": 0 } } } }, "404": { "description": "Customer not found" }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/infraction/pay": { "post": { "tags": [ "Infractions" ], "summary": "Pay infraction", "description": "Supported gateway IDs:\n- ML: MercadoPago\n- PL: PayPal\n- TBANKCL: Transbank\n- BAC: BAC Credomatic\n- PROMERICA: Promerica\n- STRIPE: Stripe\n- FISERVIPG: Fiserv IPG\n- PRISMA: Prisma\n- CECABANK: Cecabank", "operationId": "Infractions_PayInfraction", "requestBody": { "x-name": "model", "description": "Payment details", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PayInfractionModel" } ] }, "example": { "InfractionId": 123, "ExtraData": "{\"reference\":\"INF123\"}", "CreditCardNumber": null, "CreditCardExpirationMonth": 0, "CreditCardExpirationYear": 0, "CreditCardType": "VISA", "CreditCardPlaceHolder": "John Doe", "CreditCardCode": null, "TransactionId": "TX123", "GatewayId": "ML", "Amount": 175.0, "payerID": null, "paymentToken": null, "CurrencyCode": "USD", "ExchangeRate": null, "BillingInformation": { "FirstName": "John", "LastName": "Doe", "DocumentTypeId": 1, "DocumentId": "123456789", "FiscalConditionId": null, "EmailAddress": "john.doe@example.com", "CellPhone": "+1234567890", "Address": "123 Main St", "AddressNumber": "Apt 4B", "ZipCode": "12345", "Country": "USA", "Birthday": null, "City": "New York", "State": "NY", "AddressDepartment": null }, "ReturnUrl": null } } }, "x-position": 1 }, "responses": { "200": { "description": "Payment processed successfully" }, "400": { "description": "Invalid payment details\nor\nApi Error", "content": { "application/json": { "schema": {} } }, "x-expectedSchemas": [ { "description": "Invalid payment details", "schema": { "$ref": "#/components/schemas/Void" } }, { "description": "Api Error", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WebApiErrorResponse" } ] } } ] }, "404": { "description": "Infraction not found" }, "403": { "description": "Unauthenticated user" } } } }, "/api/infraction/files": { "post": { "tags": [ "Infractions" ], "summary": "Attach files to infraction", "description": "This endpoint allows attaching multiple files to an existing infraction.\nEach file should include its name, content (base64 encoded), and type.\nThe files will be stored in the system and associated with the specified infraction.", "operationId": "Infractions_AttachInfractionFiles", "requestBody": { "x-name": "model", "description": "The model containing the files to attach and the infraction ID", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AddFilesModel" } ] }, "example": { "InvoiceLegalId": "789", "InvoiceId": "456", "BookingId": "123", "CarId": "CAR123", "InfractionId": 321, "Files": [ { "Name": "document.pdf", "Content": "base64EncodedContent", "Type": "application/pdf" } ] } } }, "x-position": 1 }, "responses": { "200": { "description": "Files attached successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } }, "example": [ { "Path": "infractions/123/ticket.pdf", "Name": "Traffic Ticket.pdf", "Category": "Ticket", "Hash": null }, { "Path": "infractions/123/payment_receipt.pdf", "Name": "Payment Receipt.pdf", "Category": "Receipt", "Hash": null } ] } } }, "400": { "description": "Invalid request data\nor\nApi Error", "content": { "application/json": { "schema": {} } }, "x-expectedSchemas": [ { "description": "Invalid request data", "schema": { "$ref": "#/components/schemas/Void" } }, { "description": "Api Error", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WebApiErrorResponse" } ] } } ] }, "404": { "description": "Infraction not found" }, "403": { "description": "Unauthenticated user" } } } }, "/api/infraction/settings": { "get": { "tags": [ "Infractions" ], "summary": "Get infraction settings", "description": "Returns collector settings for infractions collector integration.", "operationId": "Infractions_GetCollectorSettings", "responses": { "200": { "description": "Collector settings JSON" }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/infraction": { "post": { "tags": [ "Infractions" ], "summary": "Create infraction", "description": "Requires the InfractionsCollector feature to be enabled.\nThe vehicle is looked up by its plate, and the infraction is associated with a booking by matching the plate and\ndate: when exactly one booking matches it is linked automatically; otherwise the infraction is saved without a\nbooking and a notification email is sent for manual resolution. Administrative charges are calculated\nautomatically. If an equivalent infraction already exists it is returned with IsNew set to false instead of\ncreating a duplicate.\nInfractionNoticeId optionally links the infraction to an InfractionNotice, honored only when the\nEnableInfractionNotices feature is on (otherwise ignored). The link is validated before the infraction\nis created, so a rejected link returns 400 with nothing persisted.", "operationId": "Infractions_AddInfraction", "requestBody": { "x-name": "model", "description": "The infraction details, including the vehicle plate, date, amount, infraction type and an optional attachment.\nMay optionally include an InfractionNoticeId to link the infraction to an InfractionNotice.", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AddInfractionModelWithNoBooking" } ] } } }, "x-position": 1 }, "responses": { "200": { "description": "The created or existing infraction, indicating whether it was newly created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddInfractionWithNoBookingResponse" } } } }, "400": { "description": "Invalid model state\nor\nApi Error", "content": { "application/json": { "schema": {} } }, "x-expectedSchemas": [ { "description": "Invalid model state", "schema": { "$ref": "#/components/schemas/Void" } }, { "description": "Api Error", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WebApiErrorResponse" } ] } } ] }, "403": { "description": "Unauthenticated user" } } } }, "/api/infraction/{infractionId}/charge": { "post": { "tags": [ "Infractions" ], "summary": "Charge infraction", "description": "Loads the infraction and tries to collect its full amount through the configured charge service. The operation is\nbest-effort: a failed charge is reported in the response with IsSuccess set to false rather than failing the request.", "operationId": "Infractions_TryChargeInfraction", "parameters": [ { "name": "infractionId", "in": "path", "required": true, "description": "The unique identifier of the infraction to charge.", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "The result of the charge attempt", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TryChargeInfractionResponse" } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/notifications/mail/list": { "get": { "tags": [ "Notifications" ], "summary": "List mail templates", "description": "This endpoint returns the templates that can be active: the ones active in their base configuration, plus\nthe ones inactive in the base configuration that at least one brand activates through its own setting.\nThe result is therefore a set of candidates, not a set of templates guaranteed to be sent. There is no\nrelated entity in this request, so the brand that decides the final state cannot be resolved here: a\ncandidate is confirmed or rejected when it is sent, once the brand of the related entity is known.\nEach template includes its configuration and content.", "operationId": "Notifications_List", "responses": { "200": { "description": "Returns the mail notification template candidates; each one is definitively validated when sent, against the brand of the related entity", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MailNotificationTemplateModel" } }, "example": { "Id": 1, "Name": "Rental Agreement Notification", "From": "notifications@rently.com", "MailAccountId": null, "To": "{{customer.email}}", "ReplyTos": "support@rently.com", "EntityType": "RentalAgreement", "Description": "Email template for rental agreement notifications" } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/notifications/mail/send": { "post": { "tags": [ "Notifications" ], "summary": "Send mail notification", "description": "This endpoint sends an email notification using a predefined template.\nThe operation includes:\n- Template validation\n- Email address validation\n- Related entity verification\n- Activation check for the brand of the related entity\n- Email generation and sending\n- Comment creation for tracking", "operationId": "Notifications_Send", "requestBody": { "x-name": "model", "description": "The email notification request containing template and recipient details", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SendMailNotificacionRequest" } ] }, "example": { "MailNotificationId": 1, "EntityId": "100", "SelectedLanguage": "en-US", "To": "customer@example.com" } } }, "x-position": 1 }, "responses": { "200": { "description": "Email notification sent successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendMailNotificacionResponse" }, "example": { "NotificationId": 1 } } } }, "400": { "description": "Invalid request, email notifications are disabled, or the template is inactive for the brand of the related entity\nor\nApi Error", "content": { "application/json": { "schema": {} } }, "x-expectedSchemas": [ { "description": "Invalid request, email notifications are disabled, or the template is inactive for the brand of the related entity", "schema": { "$ref": "#/components/schemas/Void" } }, { "description": "Api Error", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WebApiErrorResponse" } ] } } ] }, "403": { "description": "User lacks required permissions\nor\nUnauthenticated user" }, "404": { "description": "Notification template or related entity not found" } } } }, "/api/notifications/mail/send/{guid}": { "post": { "tags": [ "Notifications" ], "summary": "Send mail notification by ID", "description": "This endpoint sends an email notification using a predefined template.\nThe operation includes:\n- Template validation\n- Email address validation\n- Related entity verification\n- Activation check for the brand of the related entity\n- Email generation and sending\n- Comment creation for tracking", "operationId": "Notifications_SendKnown", "parameters": [ { "name": "guid", "in": "path", "required": true, "description": "The guid of the known email notification template", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "requestBody": { "x-name": "model", "description": "The email notification request containing template and recipient details", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SendMailNotificacionRequestBase" } ] }, "example": { "MailNotificationId": 1, "EntityId": "100", "SelectedLanguage": "en-US", "To": "customer@example.com" } } }, "x-position": 2 }, "responses": { "200": { "description": "Email notification sent successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendMailNotificacionResponse" }, "example": { "NotificationId": 1 } } } }, "400": { "description": "Invalid request, email notifications are disabled, or the template is inactive for the brand of the related entity\nor\nApi Error", "content": { "application/json": { "schema": {} } }, "x-expectedSchemas": [ { "description": "Invalid request, email notifications are disabled, or the template is inactive for the brand of the related entity", "schema": { "$ref": "#/components/schemas/Void" } }, { "description": "Api Error", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WebApiErrorResponse" } ] } } ] }, "403": { "description": "User lacks required permissions\nor\nUnauthenticated user" }, "404": { "description": "Notification template or related entity not found" } } } }, "/api/operations/deliveries": { "get": { "tags": [ "Operations" ], "summary": "List deliveries", "description": "This endpoint returns all car deliveries scheduled for the specified branch office.\nIf no date is provided, it defaults to the current date.\nThe operation requires the 'CanGetTodayDeliveries' permission.", "operationId": "Operations_Deliveries", "parameters": [ { "name": "branchOfficeId", "in": "query", "required": true, "description": "The unique identifier of the branch office", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "date", "in": "query", "description": "Optional date to filter deliveries (defaults to current date)", "schema": { "type": "string", "format": "date-time", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "Returns the list of scheduled deliveries", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Booking" } }, "example": [ { "Id": 1, "Version": null, "Customer": { "Id": 1, "GlobalId": "7cef439b-0761-45b1-b1e2-dd187ab62fb6", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:01.3378426Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:01.3378426Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:01.3378426Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:01.3378426Z", "DocumentIdExpiration": "2036-09-24T13:58:01.3378426Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null }, "Balance": 0.0, "TotalPayed": 0.0, "Extra": null, "Promotion": null, "IsQuotation": false, "Car": { "Id": "CAR123", "Model": { "Description": "The Toyota Corolla is a reliable and fuel-efficient compact sedan with modern features and comfortable interior.", "ImagePath": "/images/models/corolla.jpg", "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 750.0, "FranchiseTheft": 1000.0, "FranchiseHail": 500.0, "Brand": { "Name": "Toyota" }, "Doors": 4, "Passengers": 5, "BigLuggage": 2, "SmallLuggage": 2, "Steering": "Power Steering", "SteeringType": 3, "Gearbox": "Automatic", "TransmissionType": 2, "Multimedia": "Bluetooth, Navigation System", "AirConditioner": "Automatic Climate Control", "AirConditionerType": 1, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": [ { "Id": 1, "Name": "Fuel Type", "Description": "Type of fuel used by the vehicle", "Type": 0, "Unit": "Type", "Value": "Gasoline", "ModelId": 1 }, { "Id": 2, "Name": "Engine Size", "Description": "Engine displacement", "Type": 1, "Unit": "Liters", "Value": "1.8", "ModelId": 1 }, { "Id": 3, "Name": "Transmission", "Description": "Type of transmission", "Type": 0, "Unit": "Type", "Value": "Automatic", "ModelId": 1 } ], "LowerPrice": 45.0, "Id": 1, "Name": "Corolla", "Category": { "Models": null, "Id": 1, "Name": "Economy", "Order": 1.0, "PrincipalModelId": null, "Franchise": 0.0, "FranchiseDamage": 0.0, "FranchiseRollover": 0.0, "FranchiseTheft": 0.0, "FranchiseHail": 0.0, "ImagePath": null }, "SIPP": "CDMR" }, "CurrentBranchOfficeId": 1, "CurrentBranchOffice": "LAX Branch", "BranchOfficeOwner": "Rently LAX Airport", "CurrentKms": 50000, "FuelType": "Gasoline", "Gasoline": 75, "FriendlyName": "Toyota Corolla 2023", "CurrentPlateId": "ABC123", "ChassisIdentification": "1HGCM82633A123456", "CurrentPlate": { "Id": "ABC123", "IssuingCountry": "United States", "IssuingState": "CA" }, "Color": "Silver", "Year": 2023, "TollDeviceId": "TOLL123", "BatteryNumber": "BAT123456", "CreationDate": "0001-01-01T00:00:00", "InactiveDate": null, "LeasedToCompany": null, "SupplierFullName": null, "LastReturnDate": null }, "Model": null, "Category": { "Models": [ { "Description": null, "ImagePath": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "Brand": { "Name": "Toyota" }, "Doors": 0, "Passengers": 0, "BigLuggage": 0, "SmallLuggage": 0, "Steering": null, "SteeringType": null, "Gearbox": null, "TransmissionType": null, "Multimedia": null, "AirConditioner": null, "AirConditionerType": null, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": null, "LowerPrice": 45.0, "Id": 1, "Name": "Toyota Yaris", "Category": null, "SIPP": null } ], "Id": 1, "Name": "Economy", "Order": 0.0, "PrincipalModelId": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "ImagePath": null }, "FromDate": "2026-09-25T13:58:01.3378426Z", "ToDate": "2026-09-28T13:58:01.3378426Z", "DeliveryPlace": { "Price": 0.0, "Name": "Airport Terminal 1", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 1 }, "ReturnPlace": { "Price": 0.0, "Name": "Downtown Branch", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 2 }, "TotalDaysString": "3 days", "Price": 299.99, "AgencyPrice": 269.99, "CustomerPrice": 30.0, "Currency": "USD", "Franchise": null, "FranchiseDamage": null, "FranchiseRollover": null, "FranchiseTheft": null, "FranchiseHail": null, "TotalDays": 0.0, "IlimitedKm": false, "MaxAllowedDistance": 0, "MaxAllowedDistanceByDay": 0, "HasFranchiseModifiers": false, "WillLeaveCountry": null, "AverageDayPrice": 0.0, "PriceItems": [ { "Id": 1, "IsBookingPrice": false, "Description": "Base Price", "Price": 269.99, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 1, "TariffName": null, "AppliedCoverageBrackets": [ { "DaysFrom": 1, "DaysTo": 2, "Amount": 200.0 }, { "DaysFrom": 3, "DaysTo": 3, "Amount": 69.99 } ] }, { "Id": 2, "IsBookingPrice": false, "Description": "Insurance", "Price": 30.0, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 0, "TariffName": null } ], "Additionals": [ { "Additional": { "Name": "GPS Navigation", "Description": null, "ImagePath": null, "IsPriceByDay": false, "Price": 29.99, "MaxQuantityPerBooking": 0, "Type": null, "Stock": 0, "Order": 0.0, "Id": 1 }, "Quantity": 1 } ], "AvailablePromotions": null, "CurrentStatus": 1, "CurrentStatusDate": "0001-01-01T00:00:00", "DeliveryTransportationId": null, "ReturnTransportationId": null, "IsCustomerOver25": false, "ExternalSystemId": null, "PrepaidAmount": 0.0, "ElegibleSIPPCodeUpgrade": null, "Attributes": {}, "ExchangeRate": null, "DailyRate": 0.0, "HourlyRate": 0.0, "ExtraDayRate": 0.0, "ExtraHourRate": 0.0, "RatePlan": null, "IsOnRequest": false, "DeliveryInfo": null, "DropoffInfo": null, "Origin": null, "CreationDate": "0001-01-01T00:00:00", "UpdatedOn": null, "UpdatedByUserName": null, "PayedByAgency": 0.0, "PayedByCustomer": 0.0, "CommercialAgreementCode": null, "PurchaseOrder": null, "Brand": null, "SalesCommision": 0.0, "IsTransfer": false, "PriceDetails": { "Price": 299.99, "CustomerPrice": 30.0, "AgencyPrice": 269.99, "SalesCommission": 0.0, "Currency": "USD" }, "Agency": null, "IsSelfCheckin": false, "Links": null, "DistanceUnit": "kilometers", "Code": null } ] } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/operations/returns": { "get": { "tags": [ "Operations" ], "summary": "List returns", "description": "All date math uses the queried branch office's timezone, not the logged-in user's. When no\ndate is provided it defaults to the branch's current day.\n \nFor \"today\" (date omitted or equal to the branch's current day) the result includes:\n- Delivered bookings due today or overdue (return date on a previous day);\n- Reserved/Confirmed bookings still within the no-show window (FromDate + NoShowGap >= now);\n once that window elapses they are considered no-shows and excluded.\n \nFor any other (past/future) date, only returns whose return date falls on that exact day are\nlisted. This mirrors the dashboard's today-returns (DashboardService.GetTodayDevolutions). #21500 #21501\n \nThe operation requires the 'CanGetTodayDeliveries' permission.", "operationId": "Operations_Returns", "parameters": [ { "name": "branchOfficeId", "in": "query", "required": true, "description": "The unique identifier of the branch office", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "date", "in": "query", "description": "Optional day to query, in the branch timezone (defaults to the branch's current day)", "schema": { "type": "string", "format": "date-time", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "List of returns for the requested day", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Booking" } }, "example": [ { "Id": 1, "Version": null, "Customer": { "Id": 1, "GlobalId": "04c3962d-b7bc-42fb-82f0-c2e4e5d887b0", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:01.3503593Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:01.3503593Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:01.3503593Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:01.3503593Z", "DocumentIdExpiration": "2036-09-24T13:58:01.3503593Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null }, "Balance": 0.0, "TotalPayed": 0.0, "Extra": null, "Promotion": null, "IsQuotation": false, "Car": { "Id": "CAR123", "Model": { "Description": "The Toyota Corolla is a reliable and fuel-efficient compact sedan with modern features and comfortable interior.", "ImagePath": "/images/models/corolla.jpg", "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 750.0, "FranchiseTheft": 1000.0, "FranchiseHail": 500.0, "Brand": { "Name": "Toyota" }, "Doors": 4, "Passengers": 5, "BigLuggage": 2, "SmallLuggage": 2, "Steering": "Power Steering", "SteeringType": 3, "Gearbox": "Automatic", "TransmissionType": 2, "Multimedia": "Bluetooth, Navigation System", "AirConditioner": "Automatic Climate Control", "AirConditionerType": 1, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": [ { "Id": 1, "Name": "Fuel Type", "Description": "Type of fuel used by the vehicle", "Type": 0, "Unit": "Type", "Value": "Gasoline", "ModelId": 1 }, { "Id": 2, "Name": "Engine Size", "Description": "Engine displacement", "Type": 1, "Unit": "Liters", "Value": "1.8", "ModelId": 1 }, { "Id": 3, "Name": "Transmission", "Description": "Type of transmission", "Type": 0, "Unit": "Type", "Value": "Automatic", "ModelId": 1 } ], "LowerPrice": 45.0, "Id": 1, "Name": "Corolla", "Category": { "Models": null, "Id": 1, "Name": "Economy", "Order": 1.0, "PrincipalModelId": null, "Franchise": 0.0, "FranchiseDamage": 0.0, "FranchiseRollover": 0.0, "FranchiseTheft": 0.0, "FranchiseHail": 0.0, "ImagePath": null }, "SIPP": "CDMR" }, "CurrentBranchOfficeId": 1, "CurrentBranchOffice": "LAX Branch", "BranchOfficeOwner": "Rently LAX Airport", "CurrentKms": 50000, "FuelType": "Gasoline", "Gasoline": 75, "FriendlyName": "Toyota Corolla 2023", "CurrentPlateId": "ABC123", "ChassisIdentification": "1HGCM82633A123456", "CurrentPlate": { "Id": "ABC123", "IssuingCountry": "United States", "IssuingState": "CA" }, "Color": "Silver", "Year": 2023, "TollDeviceId": "TOLL123", "BatteryNumber": "BAT123456", "CreationDate": "0001-01-01T00:00:00", "InactiveDate": null, "LeasedToCompany": null, "SupplierFullName": null, "LastReturnDate": null }, "Model": null, "Category": { "Models": [ { "Description": null, "ImagePath": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "Brand": { "Name": "Toyota" }, "Doors": 0, "Passengers": 0, "BigLuggage": 0, "SmallLuggage": 0, "Steering": null, "SteeringType": null, "Gearbox": null, "TransmissionType": null, "Multimedia": null, "AirConditioner": null, "AirConditionerType": null, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": null, "LowerPrice": 45.0, "Id": 1, "Name": "Toyota Yaris", "Category": null, "SIPP": null } ], "Id": 1, "Name": "Economy", "Order": 0.0, "PrincipalModelId": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "ImagePath": null }, "FromDate": "2026-09-25T13:58:01.3503593Z", "ToDate": "2026-09-28T13:58:01.3503593Z", "DeliveryPlace": { "Price": 0.0, "Name": "Airport Terminal 1", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 1 }, "ReturnPlace": { "Price": 0.0, "Name": "Downtown Branch", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 2 }, "TotalDaysString": "3 days", "Price": 299.99, "AgencyPrice": 269.99, "CustomerPrice": 30.0, "Currency": "USD", "Franchise": null, "FranchiseDamage": null, "FranchiseRollover": null, "FranchiseTheft": null, "FranchiseHail": null, "TotalDays": 0.0, "IlimitedKm": false, "MaxAllowedDistance": 0, "MaxAllowedDistanceByDay": 0, "HasFranchiseModifiers": false, "WillLeaveCountry": null, "AverageDayPrice": 0.0, "PriceItems": [ { "Id": 1, "IsBookingPrice": false, "Description": "Base Price", "Price": 269.99, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 1, "TariffName": null, "AppliedCoverageBrackets": [ { "DaysFrom": 1, "DaysTo": 2, "Amount": 200.0 }, { "DaysFrom": 3, "DaysTo": 3, "Amount": 69.99 } ] }, { "Id": 2, "IsBookingPrice": false, "Description": "Insurance", "Price": 30.0, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 0, "TariffName": null } ], "Additionals": [ { "Additional": { "Name": "GPS Navigation", "Description": null, "ImagePath": null, "IsPriceByDay": false, "Price": 29.99, "MaxQuantityPerBooking": 0, "Type": null, "Stock": 0, "Order": 0.0, "Id": 1 }, "Quantity": 1 } ], "AvailablePromotions": null, "CurrentStatus": 1, "CurrentStatusDate": "0001-01-01T00:00:00", "DeliveryTransportationId": null, "ReturnTransportationId": null, "IsCustomerOver25": false, "ExternalSystemId": null, "PrepaidAmount": 0.0, "ElegibleSIPPCodeUpgrade": null, "Attributes": {}, "ExchangeRate": null, "DailyRate": 0.0, "HourlyRate": 0.0, "ExtraDayRate": 0.0, "ExtraHourRate": 0.0, "RatePlan": null, "IsOnRequest": false, "DeliveryInfo": null, "DropoffInfo": null, "Origin": null, "CreationDate": "0001-01-01T00:00:00", "UpdatedOn": null, "UpdatedByUserName": null, "PayedByAgency": 0.0, "PayedByCustomer": 0.0, "CommercialAgreementCode": null, "PurchaseOrder": null, "Brand": null, "SalesCommision": 0.0, "IsTransfer": false, "PriceDetails": { "Price": 299.99, "CustomerPrice": 30.0, "AgencyPrice": 269.99, "SalesCommission": 0.0, "Currency": "USD" }, "Agency": null, "IsSelfCheckin": false, "Links": null, "DistanceUnit": "kilometers", "Code": null } ] } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/operations/delivery": { "post": { "tags": [ "Operations" ], "summary": "Process delivery", "description": "This endpoint handles both pre-deliveries and actual deliveries of cars.\nIt performs various validations including:\n- Booking status checks\n- Driver license requirements\n- Car availability\n- Franchise requirements\n- Driver age restrictions\n- Balance checks\nThe operation requires the 'CanMakeDeliveries' permission.", "operationId": "Operations_Delivery", "requestBody": { "x-name": "model", "description": "The delivery request containing booking and car check details", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DeliveryModel" } ] } } }, "x-position": 1 }, "responses": { "200": { "description": "Delivery or pre-delivery processed successfully" }, "400": { "description": "Invalid request or validation failed\nor\nApi Error", "content": { "application/json": { "schema": {} } }, "x-expectedSchemas": [ { "description": "Invalid request or validation failed", "schema": { "$ref": "#/components/schemas/Void" } }, { "description": "Api Error", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WebApiErrorResponse" } ] } } ] }, "403": { "description": "User lacks required permissions\nor\nUnauthenticated user" }, "404": { "description": "Booking not found" } } } }, "/api/operations/return": { "post": { "tags": [ "Operations" ], "summary": "Process return", "description": "This endpoint handles both pre-returns and actual returns of cars.\nIt performs various validations including:\n- Booking status checks\n- Delivery verification\n- Kilometer validation\nThe operation requires the 'CanMakeDevolution' permission.", "operationId": "Operations_Return", "requestBody": { "x-name": "model", "description": "The return request containing booking and car check details", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ReturnModel" } ] } } }, "x-position": 1 }, "responses": { "200": { "description": "Return or pre-return processed successfully", "content": { "application/json": { "example": { "Id": 1, "Version": null, "Customer": { "Id": 1, "GlobalId": "f6ea0cc4-91f2-4e8d-8259-b60283d26f4a", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:01.3679153Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:01.3679153Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:01.3679153Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:01.3679153Z", "DocumentIdExpiration": "2036-09-24T13:58:01.3679153Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null }, "Balance": 0.0, "TotalPayed": 0.0, "Extra": null, "Promotion": null, "IsQuotation": false, "Car": { "Id": "CAR123", "Model": { "Description": "The Toyota Corolla is a reliable and fuel-efficient compact sedan with modern features and comfortable interior.", "ImagePath": "/images/models/corolla.jpg", "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 750.0, "FranchiseTheft": 1000.0, "FranchiseHail": 500.0, "Brand": { "Name": "Toyota" }, "Doors": 4, "Passengers": 5, "BigLuggage": 2, "SmallLuggage": 2, "Steering": "Power Steering", "SteeringType": 3, "Gearbox": "Automatic", "TransmissionType": 2, "Multimedia": "Bluetooth, Navigation System", "AirConditioner": "Automatic Climate Control", "AirConditionerType": 1, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": [ { "Id": 1, "Name": "Fuel Type", "Description": "Type of fuel used by the vehicle", "Type": 0, "Unit": "Type", "Value": "Gasoline", "ModelId": 1 }, { "Id": 2, "Name": "Engine Size", "Description": "Engine displacement", "Type": 1, "Unit": "Liters", "Value": "1.8", "ModelId": 1 }, { "Id": 3, "Name": "Transmission", "Description": "Type of transmission", "Type": 0, "Unit": "Type", "Value": "Automatic", "ModelId": 1 } ], "LowerPrice": 45.0, "Id": 1, "Name": "Corolla", "Category": { "Models": null, "Id": 1, "Name": "Economy", "Order": 1.0, "PrincipalModelId": null, "Franchise": 0.0, "FranchiseDamage": 0.0, "FranchiseRollover": 0.0, "FranchiseTheft": 0.0, "FranchiseHail": 0.0, "ImagePath": null }, "SIPP": "CDMR" }, "CurrentBranchOfficeId": 1, "CurrentBranchOffice": "LAX Branch", "BranchOfficeOwner": "Rently LAX Airport", "CurrentKms": 50000, "FuelType": "Gasoline", "Gasoline": 75, "FriendlyName": "Toyota Corolla 2023", "CurrentPlateId": "ABC123", "ChassisIdentification": "1HGCM82633A123456", "CurrentPlate": { "Id": "ABC123", "IssuingCountry": "United States", "IssuingState": "CA" }, "Color": "Silver", "Year": 2023, "TollDeviceId": "TOLL123", "BatteryNumber": "BAT123456", "CreationDate": "0001-01-01T00:00:00", "InactiveDate": null, "LeasedToCompany": null, "SupplierFullName": null, "LastReturnDate": null }, "Model": null, "Category": { "Models": [ { "Description": null, "ImagePath": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "Brand": { "Name": "Toyota" }, "Doors": 0, "Passengers": 0, "BigLuggage": 0, "SmallLuggage": 0, "Steering": null, "SteeringType": null, "Gearbox": null, "TransmissionType": null, "Multimedia": null, "AirConditioner": null, "AirConditionerType": null, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": null, "LowerPrice": 45.0, "Id": 1, "Name": "Toyota Yaris", "Category": null, "SIPP": null } ], "Id": 1, "Name": "Economy", "Order": 0.0, "PrincipalModelId": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "ImagePath": null }, "FromDate": "2026-09-25T13:58:01.3679153Z", "ToDate": "2026-09-28T13:58:01.3679153Z", "DeliveryPlace": { "Price": 0.0, "Name": "Airport Terminal 1", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 1 }, "ReturnPlace": { "Price": 0.0, "Name": "Downtown Branch", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 2 }, "TotalDaysString": "3 days", "Price": 299.99, "AgencyPrice": 269.99, "CustomerPrice": 30.0, "Currency": "USD", "Franchise": null, "FranchiseDamage": null, "FranchiseRollover": null, "FranchiseTheft": null, "FranchiseHail": null, "TotalDays": 0.0, "IlimitedKm": false, "MaxAllowedDistance": 0, "MaxAllowedDistanceByDay": 0, "HasFranchiseModifiers": false, "WillLeaveCountry": null, "AverageDayPrice": 0.0, "PriceItems": [ { "Id": 1, "IsBookingPrice": false, "Description": "Base Price", "Price": 269.99, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 1, "TariffName": null, "AppliedCoverageBrackets": [ { "DaysFrom": 1, "DaysTo": 2, "Amount": 200.0 }, { "DaysFrom": 3, "DaysTo": 3, "Amount": 69.99 } ] }, { "Id": 2, "IsBookingPrice": false, "Description": "Insurance", "Price": 30.0, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 0, "TariffName": null } ], "Additionals": [ { "Additional": { "Name": "GPS Navigation", "Description": null, "ImagePath": null, "IsPriceByDay": false, "Price": 29.99, "MaxQuantityPerBooking": 0, "Type": null, "Stock": 0, "Order": 0.0, "Id": 1 }, "Quantity": 1 } ], "AvailablePromotions": null, "CurrentStatus": 1, "CurrentStatusDate": "0001-01-01T00:00:00", "DeliveryTransportationId": null, "ReturnTransportationId": null, "IsCustomerOver25": false, "ExternalSystemId": null, "PrepaidAmount": 0.0, "ElegibleSIPPCodeUpgrade": null, "Attributes": {}, "ExchangeRate": null, "DailyRate": 0.0, "HourlyRate": 0.0, "ExtraDayRate": 0.0, "ExtraHourRate": 0.0, "RatePlan": null, "IsOnRequest": false, "DeliveryInfo": null, "DropoffInfo": null, "Origin": null, "CreationDate": "0001-01-01T00:00:00", "UpdatedOn": null, "UpdatedByUserName": null, "PayedByAgency": 0.0, "PayedByCustomer": 0.0, "CommercialAgreementCode": null, "PurchaseOrder": null, "Brand": null, "SalesCommision": 0.0, "IsTransfer": false, "PriceDetails": { "Price": 299.99, "CustomerPrice": 30.0, "AgencyPrice": 269.99, "SalesCommission": 0.0, "Currency": "USD" }, "Agency": null, "IsSelfCheckin": false, "Links": null, "DistanceUnit": "kilometers", "Code": null } } } }, "400": { "description": "Invalid request or validation failed\nor\nApi Error", "content": { "application/json": { "schema": {} } }, "x-expectedSchemas": [ { "description": "Invalid request or validation failed", "schema": { "$ref": "#/components/schemas/Void" } }, { "description": "Api Error", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WebApiErrorResponse" } ] } } ] }, "403": { "description": "User lacks required permissions\nor\nUnauthenticated user" }, "404": { "description": "Booking not found" } } } }, "/api/search": { "get": { "tags": [ "Availability" ], "summary": "Search available cars", "description": "Searches for available cars based on the specified criteria.\nWhen the commercial agreement splits the daily rate by VDR coverage brackets, each rental line of\nPriceItems also carries AppliedCoverageBrackets: the day ranges that line covers and the part of its\nPrice that belongs to each one. The payer is the one of the line. Lines that were not priced by coverage\nbrackets omit the property, and the totals are the same either way.", "operationId": "PublicApi_Search", "parameters": [ { "name": "From", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "To", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "FromPlace", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32", "minimum": 1.0 } }, { "name": "ToPlace", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "Promotion", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "IlimitedKm", "in": "query", "schema": { "type": "boolean", "nullable": true } }, { "name": "OnlyFullAvailability", "in": "query", "schema": { "type": "boolean" } }, { "name": "AvailabilityByModel", "in": "query", "schema": { "type": "boolean", "nullable": true } }, { "name": "CommercialAgreementCode", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "CurrencyCode", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "ShowFinalPrice", "in": "query", "schema": { "type": "boolean" } }, { "name": "PromotionCode", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "DriverAge", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "Promotions", "in": "query", "style": "form", "explode": true, "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int32" } } }, { "name": "CustomerId", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "ReturnAdditionalsPrice", "in": "query", "schema": { "type": "boolean" } }, { "name": "AgencyGuid", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "Origin", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "BookingBrandId", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "MaxKmForBooking", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } } ], "responses": { "200": { "description": "Returns a list of available cars matching the search criteria", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Availability" } }, "example": { "Car": { "Id": "ABC123", "Model": { "Description": null, "ImagePath": null, "Franchise": 0.0, "FranchiseDamage": 0.0, "FranchiseRollover": 0.0, "FranchiseTheft": 0.0, "FranchiseHail": 0.0, "Brand": { "Name": "Toyota" }, "Doors": 0, "Passengers": 0, "BigLuggage": 0, "SmallLuggage": 0, "Steering": null, "SteeringType": null, "Gearbox": null, "TransmissionType": null, "Multimedia": null, "AirConditioner": null, "AirConditionerType": null, "FuelType": null, "DailyPrice": 0.0, "ModelAttributes": null, "LowerPrice": 0.0, "Id": 1, "Name": "Corolla", "Category": null, "SIPP": null }, "CurrentBranchOfficeId": 1, "CurrentBranchOffice": "Main Branch", "BranchOfficeOwner": "Main Branch", "CurrentKms": 50000, "FuelType": "Gasoline", "Gasoline": 100, "FriendlyName": "My Corolla", "CurrentPlateId": null, "ChassisIdentification": null, "CurrentPlate": null, "Color": null, "Year": 0, "TollDeviceId": null, "BatteryNumber": null, "CreationDate": "0001-01-01T00:00:00", "InactiveDate": null, "LeasedToCompany": null, "SupplierFullName": null, "LastReturnDate": null }, "Category": { "Id": 1, "Name": "Economy", "Order": 1.0, "PrincipalModelId": 1, "Franchise": 500.0, "FranchiseDamage": 1000.0, "FranchiseRollover": 1500.0, "FranchiseTheft": 2000.0, "FranchiseHail": 2500.0, "ImagePath": "/images/categories/economy.jpg" }, "FromDate": "2026-09-24T10:58:01.5150286-03:00", "ToDate": "2026-10-01T10:58:01.5150286-03:00", "DeliveryPlace": { "Price": 0.0, "Name": "Main Branch", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 1, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 1 }, "ReturnPlace": { "Price": 0.0, "Name": "Main Branch", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 1, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 1 }, "TotalDaysString": "7 days", "Price": 300.0, "AgencyPrice": 270.0, "CustomerPrice": 300.0, "Franchise": 300.0, "FranchiseDamage": 800.0, "FranchiseRollover": 1200.0, "FranchiseTheft": 1500.0, "FranchiseHail": 2000.0, "TotalDays": 7.0, "IlimitedKm": true, "MaxAllowedDistance": 0, "MaxAllowedDistanceByDay": 0, "HasFranchiseModifiers": false, "WillLeaveCountry": false, "AverageDayPrice": 42.86, "PriceItems": [ { "Id": 0, "IsBookingPrice": true, "Description": "Rental for 7 days", "Price": 270.0, "Type": 0, "TypeId": 0, "UnitPrice": 42.86, "Quantity": 7, "Payer": 1, "TariffName": null, "AppliedCoverageBrackets": [ { "DaysFrom": 1, "DaysTo": 5, "Amount": 200.0 }, { "DaysFrom": 6, "DaysTo": 7, "Amount": 70.0 } ] }, { "Id": 0, "IsBookingPrice": true, "Description": "Rental for 7 days", "Price": 30.0, "Type": 0, "TypeId": 0, "UnitPrice": 42.86, "Quantity": 7, "Payer": 0, "TariffName": null, "AppliedCoverageBrackets": [ { "DaysFrom": 6, "DaysTo": 7, "Amount": 30.0 } ] } ], "Additionals": [], "AdditionalsPrice": [], "AvailablePromotions": [], "Currency": "USD", "WebDeepLink": "https://example.com/book?id=ABC123", "OnlyQuote": false, "SalesCommision": 0.0, "PriceDetails": null, "DistanceUnit": "kilometers", "BookingOrigin": null, "Brand": null } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/booking/price": { "get": { "tags": [ "Availability" ], "summary": "Get booking price", "description": "Gets the price details for a specific booking configuration.\nWhen the commercial agreement splits the daily rate by VDR coverage brackets, each rental line of\nPriceItems also carries AppliedCoverageBrackets: the day ranges that line covers and the part of its\nPrice that belongs to each one. The payer is the one of the line. Lines that were not priced by coverage\nbrackets omit the property, and the totals are the same either way.", "operationId": "PublicApi_BookingPrice", "parameters": [ { "name": "From", "in": "query", "description": "The start date and time of the rental period.", "schema": { "type": "string", "format": "date-time" } }, { "name": "To", "in": "query", "description": "The end date and time of the rental period.", "schema": { "type": "string", "format": "date-time" } }, { "name": "FromPlace", "in": "query", "description": "The identifier of the pickup location.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ToPlace", "in": "query", "description": "The identifier of the return location.", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "Promotion", "in": "query", "description": "The identifier of a single promotion to apply to the booking.", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "Promotions", "in": "query", "style": "form", "explode": true, "description": "An array of promotion identifiers to apply to the booking.", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int32" } } }, { "name": "IlimitedKm", "in": "query", "description": "A value indicating whether the rental includes unlimited kilometers.", "schema": { "type": "boolean" } }, { "name": "ModelId", "in": "query", "description": "The identifier of the car model to be rented.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Additionals", "in": "query", "style": "form", "explode": true, "description": "The list of additional services or products to be included in the booking.", "schema": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/BookingAdditional" } } }, { "name": "CommercialAgreementCode", "in": "query", "description": "The commercial agreement code for special pricing.", "schema": { "type": "string", "nullable": true } }, { "name": "DriverAge", "in": "query", "description": "The age of the primary driver.", "schema": { "type": "integer", "format": "int32" } }, { "name": "CustomerId", "in": "query", "description": "The identifier of the customer making the booking.", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "AgencyGuid", "in": "query", "description": "The unique identifier of the agency making the booking.", "schema": { "type": "string", "nullable": true } }, { "name": "CurrencyCode", "in": "query", "description": "The currency code for the booking price.", "schema": { "type": "string", "nullable": true } }, { "name": "BookingBrandId", "in": "query", "description": "The identifier of the booking brand used to filter places, agreements and tariffs.", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "MaxKmForBooking", "in": "query", "description": "The maximum number of kilometers allowed per day for the booking.", "schema": { "type": "integer", "format": "int32", "nullable": true } } ], "responses": { "200": { "description": "Returns detailed booking information with prices", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Booking" }, "example": { "Id": 1, "Version": null, "Customer": { "Id": 1, "GlobalId": "178bedbb-6f55-4072-b160-f8eb1b34ee1b", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:01.5595939Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:01.5595939Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:01.5595939Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:01.5595939Z", "DocumentIdExpiration": "2036-09-24T13:58:01.5595939Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null }, "Balance": 0.0, "TotalPayed": 0.0, "Extra": null, "Promotion": null, "IsQuotation": false, "Car": { "Id": "CAR123", "Model": { "Description": "The Toyota Corolla is a reliable and fuel-efficient compact sedan with modern features and comfortable interior.", "ImagePath": "/images/models/corolla.jpg", "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 750.0, "FranchiseTheft": 1000.0, "FranchiseHail": 500.0, "Brand": { "Name": "Toyota" }, "Doors": 4, "Passengers": 5, "BigLuggage": 2, "SmallLuggage": 2, "Steering": "Power Steering", "SteeringType": 3, "Gearbox": "Automatic", "TransmissionType": 2, "Multimedia": "Bluetooth, Navigation System", "AirConditioner": "Automatic Climate Control", "AirConditionerType": 1, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": [ { "Id": 1, "Name": "Fuel Type", "Description": "Type of fuel used by the vehicle", "Type": 0, "Unit": "Type", "Value": "Gasoline", "ModelId": 1 }, { "Id": 2, "Name": "Engine Size", "Description": "Engine displacement", "Type": 1, "Unit": "Liters", "Value": "1.8", "ModelId": 1 }, { "Id": 3, "Name": "Transmission", "Description": "Type of transmission", "Type": 0, "Unit": "Type", "Value": "Automatic", "ModelId": 1 } ], "LowerPrice": 45.0, "Id": 1, "Name": "Corolla", "Category": { "Models": null, "Id": 1, "Name": "Economy", "Order": 1.0, "PrincipalModelId": null, "Franchise": 0.0, "FranchiseDamage": 0.0, "FranchiseRollover": 0.0, "FranchiseTheft": 0.0, "FranchiseHail": 0.0, "ImagePath": null }, "SIPP": "CDMR" }, "CurrentBranchOfficeId": 1, "CurrentBranchOffice": "LAX Branch", "BranchOfficeOwner": "Rently LAX Airport", "CurrentKms": 50000, "FuelType": "Gasoline", "Gasoline": 75, "FriendlyName": "Toyota Corolla 2023", "CurrentPlateId": "ABC123", "ChassisIdentification": "1HGCM82633A123456", "CurrentPlate": { "Id": "ABC123", "IssuingCountry": "United States", "IssuingState": "CA" }, "Color": "Silver", "Year": 2023, "TollDeviceId": "TOLL123", "BatteryNumber": "BAT123456", "CreationDate": "0001-01-01T00:00:00", "InactiveDate": null, "LeasedToCompany": null, "SupplierFullName": null, "LastReturnDate": null }, "Model": null, "Category": { "Models": [ { "Description": null, "ImagePath": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "Brand": { "Name": "Toyota" }, "Doors": 0, "Passengers": 0, "BigLuggage": 0, "SmallLuggage": 0, "Steering": null, "SteeringType": null, "Gearbox": null, "TransmissionType": null, "Multimedia": null, "AirConditioner": null, "AirConditionerType": null, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": null, "LowerPrice": 45.0, "Id": 1, "Name": "Toyota Yaris", "Category": null, "SIPP": null } ], "Id": 1, "Name": "Economy", "Order": 0.0, "PrincipalModelId": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "ImagePath": null }, "FromDate": "2026-09-25T13:58:01.5595939Z", "ToDate": "2026-09-28T13:58:01.5595939Z", "DeliveryPlace": { "Price": 0.0, "Name": "Airport Terminal 1", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 1 }, "ReturnPlace": { "Price": 0.0, "Name": "Downtown Branch", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 2 }, "TotalDaysString": "3 days", "Price": 299.99, "AgencyPrice": 269.99, "CustomerPrice": 30.0, "Currency": "USD", "Franchise": null, "FranchiseDamage": null, "FranchiseRollover": null, "FranchiseTheft": null, "FranchiseHail": null, "TotalDays": 0.0, "IlimitedKm": false, "MaxAllowedDistance": 0, "MaxAllowedDistanceByDay": 0, "HasFranchiseModifiers": false, "WillLeaveCountry": null, "AverageDayPrice": 0.0, "PriceItems": [ { "Id": 1, "IsBookingPrice": false, "Description": "Base Price", "Price": 269.99, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 1, "TariffName": null, "AppliedCoverageBrackets": [ { "DaysFrom": 1, "DaysTo": 2, "Amount": 200.0 }, { "DaysFrom": 3, "DaysTo": 3, "Amount": 69.99 } ] }, { "Id": 2, "IsBookingPrice": false, "Description": "Insurance", "Price": 30.0, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 0, "TariffName": null } ], "Additionals": [ { "Additional": { "Name": "GPS Navigation", "Description": null, "ImagePath": null, "IsPriceByDay": false, "Price": 29.99, "MaxQuantityPerBooking": 0, "Type": null, "Stock": 0, "Order": 0.0, "Id": 1 }, "Quantity": 1 } ], "AvailablePromotions": null, "CurrentStatus": 1, "CurrentStatusDate": "0001-01-01T00:00:00", "DeliveryTransportationId": null, "ReturnTransportationId": null, "IsCustomerOver25": false, "ExternalSystemId": null, "PrepaidAmount": 0.0, "ElegibleSIPPCodeUpgrade": null, "Attributes": {}, "ExchangeRate": null, "DailyRate": 0.0, "HourlyRate": 0.0, "ExtraDayRate": 0.0, "ExtraHourRate": 0.0, "RatePlan": null, "IsOnRequest": false, "DeliveryInfo": null, "DropoffInfo": null, "Origin": null, "CreationDate": "0001-01-01T00:00:00", "UpdatedOn": null, "UpdatedByUserName": null, "PayedByAgency": 0.0, "PayedByCustomer": 0.0, "CommercialAgreementCode": null, "PurchaseOrder": null, "Brand": null, "SalesCommision": 0.0, "IsTransfer": false, "PriceDetails": { "Price": 299.99, "CustomerPrice": 30.0, "AgencyPrice": 269.99, "SalesCommission": 0.0, "Currency": "USD" }, "Agency": null, "IsSelfCheckin": false, "Links": null, "DistanceUnit": "kilometers", "Code": null } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/booking/additionals-price": { "get": { "tags": [ "Availability" ], "summary": "Get additionals price", "description": "Gets the price details for additional services for a specific booking", "operationId": "PublicApi_GetAdditionalPrices", "parameters": [ { "name": "Customer", "in": "query", "description": "The customer associated with the additional price item", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CustomerRequestModel" } ] } }, { "name": "Promotion", "in": "query", "description": "The promotion associated with the additional price item", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "ModelId", "in": "query", "description": "The car model identifier. Can be null if Car identifier is used instead", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "SIPPCode", "in": "query", "description": "The SIPP code identifier. Can be null if CategoryId or ModelId is present", "schema": { "type": "string", "nullable": true } }, { "name": "CategoryId", "in": "query", "description": "The category identifier. Can be null if SIPPCode or ModelId is present", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "ToDate", "in": "query", "required": true, "description": "The end date of the additional price item", "schema": { "type": "string", "format": "date-time" } }, { "name": "FromDate", "in": "query", "required": true, "description": "The start date of the additional price item", "schema": { "type": "string", "format": "date-time" } }, { "name": "ReturnPlaceId", "in": "query", "description": "The return location identifier for the additional price item", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "DeliveryPlaceId", "in": "query", "description": "The delivery location identifier for the additional price item", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "IlimitedKm", "in": "query", "description": "Indicates whether the additional price item includes unlimited kilometers", "schema": { "type": "boolean" } }, { "name": "MaxKmForBooking", "in": "query", "description": "The maximum number of kilometers allowed per day for the booking.", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "CurrencyCode", "in": "query", "description": "The currency code for pricing calculations", "schema": { "type": "string", "nullable": true } }, { "name": "CommercialAgreementCode", "in": "query", "description": "The commercial agreement code for special pricing arrangements", "schema": { "type": "string", "nullable": true } }, { "name": "AgencyGuid", "in": "query", "description": "The unique identifier for the agency", "schema": { "type": "string", "nullable": true } }, { "name": "DriverAge", "in": "query", "description": "The age of the primary driver.", "schema": { "type": "integer", "format": "int32", "nullable": true } } ], "responses": { "200": { "description": "Returns a list of additional services with their prices", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdditionalPriceItem" } }, "example": { "Name": "GPS Navigation", "Description": "Portable GPS navigation system with real-time traffic updates", "ImagePath": null, "IsPriceByDay": false, "Price": 10.0, "MaxQuantityPerBooking": 0, "Type": null, "Stock": 0, "Order": 0.0, "Id": 1 } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/rates/{code}": { "get": { "tags": [ "Rate" ], "summary": "Get rate by code", "description": "Gets an active rate by its business code, including its price matrix.", "operationId": "RatesApi_GetRate", "parameters": [ { "name": "code", "in": "path", "required": true, "description": "The business code of the rate.", "schema": { "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Returns the rate with the given code", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rate" } } } }, "404": { "description": "No active rate exists with the given code" }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } }, "put": { "tags": [ "Rate" ], "summary": "Update rate by code", "description": "This is a full replacement of the rate: the Prices matrix sent in the body replaces\nthe existing one entirely. Omitting it (empty) clears every price; to edit individual cells without\ntouching the rest use PATCH /api/rates/{id}/prices instead.\nThe code in the body must match the code in the route, and the rate's currency cannot be changed.", "operationId": "RatesApi_UpdateRate", "parameters": [ { "name": "code", "in": "path", "required": true, "description": "The business code of the rate to update.", "schema": { "type": "string", "nullable": true }, "x-position": 1 } ], "requestBody": { "x-name": "model", "description": "The new rate data.", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Rate" } ] } } }, "x-position": 2 }, "responses": { "200": { "description": "Returns the updated rate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rate" } } } }, "404": { "description": "No active rate exists with the given code" }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } }, "delete": { "tags": [ "Rate" ], "summary": "Delete rate by code", "description": "Deletes (deactivates) the active rate identified by the given code.", "operationId": "RatesApi_DeleteRate", "parameters": [ { "name": "code", "in": "path", "required": true, "description": "The business code of the rate to delete.", "schema": { "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "The rate was deactivated" }, "404": { "description": "No active rate exists with the given code" }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/rates/{id}": { "get": { "tags": [ "Rate" ], "summary": "Get rate by ID", "description": "Gets an active rate by its identifier, including its price matrix.", "operationId": "RatesApi_GetRateById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The identifier of the rate.", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "Returns the rate with the given identifier", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rate" } } } }, "404": { "description": "No active rate exists with the given identifier" }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } }, "put": { "tags": [ "Rate" ], "summary": "Update rate by ID", "description": "This is a full replacement of the rate: the Prices matrix sent in the body replaces\nthe existing one entirely. Omitting it (empty) clears every price; to edit individual cells without\ntouching the rest use PATCH /api/rates/{id}/prices instead.\nThe rate's currency cannot be changed.", "operationId": "RatesApi_UpdateRateById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The identifier of the rate to update.", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "requestBody": { "x-name": "model", "description": "The new rate data.", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Rate" } ] } } }, "x-position": 2 }, "responses": { "200": { "description": "Returns the updated rate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rate" } } } }, "404": { "description": "No active rate exists with the given identifier" }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } }, "delete": { "tags": [ "Rate" ], "summary": "Delete rate by ID", "description": "Deletes (deactivates) the active rate identified by the given id.", "operationId": "RatesApi_DeleteRateById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The identifier of the rate to delete.", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "The rate was deactivated" }, "404": { "description": "No active rate exists with the given identifier" }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/rates": { "post": { "tags": [ "Rate" ], "summary": "Create rate", "description": "Creates a rate. Fails with RateAlreadyExists when an active rate with the same code already exists.", "operationId": "RatesApi_CreateRate", "requestBody": { "x-name": "model", "description": "The rate to create.", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Rate" } ] } } }, "x-position": 1 }, "responses": { "200": { "description": "Returns the created rate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rate" } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/rates/{id}/prices": { "patch": { "tags": [ "Rate" ], "summary": "Update rate prices", "description": "Upserts individual price cells of the active rate identified by the given id, leaving every other\nprice untouched. Each cell is matched by its model/category and its time and distance range: when a\nmatching cell already exists its price is updated, otherwise the cell is added. Every cell not present\nin the request is preserved as-is.", "operationId": "RatesApi_UpsertRatePrices", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The identifier of the rate.", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "requestBody": { "x-name": "prices", "description": "The price cells to upsert.", "content": { "application/json": { "schema": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/RatePrice" } } } }, "x-position": 2 }, "responses": { "200": { "description": "Returns the updated rate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rate" } } } }, "404": { "description": "No active rate exists with the given identifier" }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/cars/{id}": { "get": { "tags": [ "Cars" ], "summary": "Get car", "description": "This endpoint retrieves detailed information about a specific car, including:\n- Car model and specifications\n- Current location and status\n- Availability information", "operationId": "Cars_GetCar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The unique identifier of the car", "schema": { "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Returns the requested car", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Car" }, "example": { "Id": "CAR123", "Model": { "Description": "The Toyota Corolla is a reliable and fuel-efficient compact sedan with modern features and comfortable interior.", "ImagePath": "/images/models/corolla.jpg", "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 750.0, "FranchiseTheft": 1000.0, "FranchiseHail": 500.0, "Brand": { "Name": "Toyota" }, "Doors": 4, "Passengers": 5, "BigLuggage": 2, "SmallLuggage": 2, "Steering": "Power Steering", "SteeringType": 3, "Gearbox": "Automatic", "TransmissionType": 2, "Multimedia": "Bluetooth, Navigation System", "AirConditioner": "Automatic Climate Control", "AirConditionerType": 1, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": [ { "Id": 1, "Name": "Fuel Type", "Description": "Type of fuel used by the vehicle", "Type": 0, "Unit": "Type", "Value": "Gasoline", "ModelId": 1 }, { "Id": 2, "Name": "Engine Size", "Description": "Engine displacement", "Type": 1, "Unit": "Liters", "Value": "1.8", "ModelId": 1 }, { "Id": 3, "Name": "Transmission", "Description": "Type of transmission", "Type": 0, "Unit": "Type", "Value": "Automatic", "ModelId": 1 } ], "LowerPrice": 45.0, "Id": 1, "Name": "Corolla", "Category": { "Models": null, "Id": 1, "Name": "Economy", "Order": 1.0, "PrincipalModelId": null, "Franchise": 0.0, "FranchiseDamage": 0.0, "FranchiseRollover": 0.0, "FranchiseTheft": 0.0, "FranchiseHail": 0.0, "ImagePath": null }, "SIPP": "CDMR" }, "CurrentBranchOfficeId": 1, "CurrentBranchOffice": "LAX Branch", "BranchOfficeOwner": "Rently LAX Airport", "CurrentKms": 50000, "FuelType": "Gasoline", "Gasoline": 75, "FriendlyName": "Toyota Corolla 2023", "CurrentPlateId": "ABC123", "ChassisIdentification": "1HGCM82633A123456", "CurrentPlate": { "Id": "ABC123", "IssuingCountry": "United States", "IssuingState": "CA" }, "Color": "Silver", "Year": 2023, "TollDeviceId": "TOLL123", "BatteryNumber": "BAT123456", "CreationDate": "0001-01-01T00:00:00", "InactiveDate": null, "LeasedToCompany": null, "SupplierFullName": null, "LastReturnDate": null } } } }, "400": { "description": "Invalid car ID\nor\nApi Error", "content": { "application/json": { "schema": {} } }, "x-expectedSchemas": [ { "description": "Invalid car ID", "schema": { "$ref": "#/components/schemas/Void" } }, { "description": "Api Error", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WebApiErrorResponse" } ] } } ] }, "404": { "description": "Car not found" }, "403": { "description": "Unauthenticated user" } } } }, "/api/cars/{id}/bookings": { "get": { "tags": [ "Cars" ], "summary": "List car bookings", "description": "This endpoint retrieves a paginated list of all bookings associated with a specific car.\nThe results can be filtered and sorted by various criteria.", "operationId": "Cars_GetCarBookings", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The unique identifier of the car", "schema": { "type": "string", "nullable": true }, "x-position": 1 }, { "name": "offset", "in": "query", "description": "The number of records to skip (default: 0)", "schema": { "type": "integer", "format": "int32", "default": 0 }, "x-position": 2 }, { "name": "limit", "in": "query", "description": "The maximum number of records to return (default: 30)", "schema": { "type": "integer", "format": "int32", "default": 30 }, "x-position": 3 } ], "responses": { "200": { "description": "Returns the list of bookings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultOfBooking" }, "example": { "Offset": 0, "Limit": 30, "Total": 1, "Results": [ { "Id": 1, "Version": null, "Customer": { "Id": 1, "GlobalId": "91dbaa53-e2be-4ab8-a7f8-30dec91f29fd", "Name": "John Doe", "Lastname": "Doe", "Firstname": "John", "DocumentId": "123456789", "DocumentTypeId": 1, "EmailAddress": "john.doe@example.com", "CellPhone": "+1-555-0123", "Address": "123 Main St", "AddressNumber": "456", "AddressDepartment": "Apt 789", "Country": "United States", "BirthDate": "1990-01-01T00:00:00", "CreditCards": [ { "Type": "VISA", "Number": "**** **** **** 1111", "ExpirationMonth": 12, "ExpirationYear": 2025, "SecurityCode": null, "CardHolderName": "John Doe" } ], "Memberships": [ { "Id": null, "MembershipType": 3, "Description": "Gold Member", "Number": "FT123456", "ExpirationDate": "2027-09-24T13:58:01.7064648Z", "UsedInBooking": false, "BookingBrandIds": [] } ], "Age": 33, "DriverLicenceNumber": "DL123456", "DriverLicenceCountry": "United States", "DriverLicenseExpiration": "2031-09-24T13:58:01.7064648Z", "DriverLicenseRenachNumber": null, "DriverLicenseCategory": null, "ZipCode": "12345", "FiscalConditionId": 1, "Notes": "Preferred customer", "IsCompany": false, "IsAgency": false, "IsProvider": false, "IsHotel": false, "City": "New York", "State": "NY", "Region": "Northeast", "CommercialAgreements": [ "Standard Agreement" ], "HasWebLogin": true, "IATACode": null, "BirthCountry": "United States", "BirthState": "NY", "DriverLicenseIssuance": "2021-09-24T13:58:01.7064648Z", "DriverLicenseState": "NY", "DocumentIdIssuance": "2016-09-24T13:58:01.7064648Z", "DocumentIdExpiration": "2036-09-24T13:58:01.7064648Z", "DocumentIdIssuanceState": "NY", "DocumentIdIssuanceCountry": "United States", "PersonalCode": null, "StateRegistration": null, "MunicipalRegistration": null }, "Balance": 0.0, "TotalPayed": 0.0, "Extra": null, "Promotion": null, "IsQuotation": false, "Car": { "Id": "CAR123", "Model": { "Description": "The Toyota Corolla is a reliable and fuel-efficient compact sedan with modern features and comfortable interior.", "ImagePath": "/images/models/corolla.jpg", "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 750.0, "FranchiseTheft": 1000.0, "FranchiseHail": 500.0, "Brand": { "Name": "Toyota" }, "Doors": 4, "Passengers": 5, "BigLuggage": 2, "SmallLuggage": 2, "Steering": "Power Steering", "SteeringType": 3, "Gearbox": "Automatic", "TransmissionType": 2, "Multimedia": "Bluetooth, Navigation System", "AirConditioner": "Automatic Climate Control", "AirConditionerType": 1, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": [ { "Id": 1, "Name": "Fuel Type", "Description": "Type of fuel used by the vehicle", "Type": 0, "Unit": "Type", "Value": "Gasoline", "ModelId": 1 }, { "Id": 2, "Name": "Engine Size", "Description": "Engine displacement", "Type": 1, "Unit": "Liters", "Value": "1.8", "ModelId": 1 }, { "Id": 3, "Name": "Transmission", "Description": "Type of transmission", "Type": 0, "Unit": "Type", "Value": "Automatic", "ModelId": 1 } ], "LowerPrice": 45.0, "Id": 1, "Name": "Corolla", "Category": { "Models": null, "Id": 1, "Name": "Economy", "Order": 1.0, "PrincipalModelId": null, "Franchise": 0.0, "FranchiseDamage": 0.0, "FranchiseRollover": 0.0, "FranchiseTheft": 0.0, "FranchiseHail": 0.0, "ImagePath": null }, "SIPP": "CDMR" }, "CurrentBranchOfficeId": 1, "CurrentBranchOffice": "LAX Branch", "BranchOfficeOwner": "Rently LAX Airport", "CurrentKms": 50000, "FuelType": "Gasoline", "Gasoline": 75, "FriendlyName": "Toyota Corolla 2023", "CurrentPlateId": "ABC123", "ChassisIdentification": "1HGCM82633A123456", "CurrentPlate": { "Id": "ABC123", "IssuingCountry": "United States", "IssuingState": "CA" }, "Color": "Silver", "Year": 2023, "TollDeviceId": "TOLL123", "BatteryNumber": "BAT123456", "CreationDate": "0001-01-01T00:00:00", "InactiveDate": null, "LeasedToCompany": null, "SupplierFullName": null, "LastReturnDate": null }, "Model": null, "Category": { "Models": [ { "Description": null, "ImagePath": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "Brand": { "Name": "Toyota" }, "Doors": 0, "Passengers": 0, "BigLuggage": 0, "SmallLuggage": 0, "Steering": null, "SteeringType": null, "Gearbox": null, "TransmissionType": null, "Multimedia": null, "AirConditioner": null, "AirConditionerType": null, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": null, "LowerPrice": 45.0, "Id": 1, "Name": "Toyota Yaris", "Category": null, "SIPP": null } ], "Id": 1, "Name": "Economy", "Order": 0.0, "PrincipalModelId": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "ImagePath": null }, "FromDate": "2026-09-25T13:58:01.7064648Z", "ToDate": "2026-09-28T13:58:01.7064648Z", "DeliveryPlace": { "Price": 0.0, "Name": "Airport Terminal 1", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 1 }, "ReturnPlace": { "Price": 0.0, "Name": "Downtown Branch", "Category": null, "Address": null, "City": null, "Country": null, "BranchOfficeId": 0, "BranchOfficeName": null, "BranchOfficeIATACode": null, "IsFranchise": false, "Latitude": 0.0, "Longitude": 0.0, "CanAddCustomAddress": false, "IsCustomAddress": false, "AvailableOperationOptions": null, "AvailableReturnPlaces": null, "AvailableBrandCodes": null, "Id": 2 }, "TotalDaysString": "3 days", "Price": 299.99, "AgencyPrice": 269.99, "CustomerPrice": 30.0, "Currency": "USD", "Franchise": null, "FranchiseDamage": null, "FranchiseRollover": null, "FranchiseTheft": null, "FranchiseHail": null, "TotalDays": 0.0, "IlimitedKm": false, "MaxAllowedDistance": 0, "MaxAllowedDistanceByDay": 0, "HasFranchiseModifiers": false, "WillLeaveCountry": null, "AverageDayPrice": 0.0, "PriceItems": [ { "Id": 1, "IsBookingPrice": false, "Description": "Base Price", "Price": 269.99, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 1, "TariffName": null, "AppliedCoverageBrackets": [ { "DaysFrom": 1, "DaysTo": 2, "Amount": 200.0 }, { "DaysFrom": 3, "DaysTo": 3, "Amount": 69.99 } ] }, { "Id": 2, "IsBookingPrice": false, "Description": "Insurance", "Price": 30.0, "Type": 0, "TypeId": 0, "UnitPrice": 0.0, "Quantity": 0, "Payer": 0, "TariffName": null } ], "Additionals": [ { "Additional": { "Name": "GPS Navigation", "Description": null, "ImagePath": null, "IsPriceByDay": false, "Price": 29.99, "MaxQuantityPerBooking": 0, "Type": null, "Stock": 0, "Order": 0.0, "Id": 1 }, "Quantity": 1 } ], "AvailablePromotions": null, "CurrentStatus": 1, "CurrentStatusDate": "0001-01-01T00:00:00", "DeliveryTransportationId": null, "ReturnTransportationId": null, "IsCustomerOver25": false, "ExternalSystemId": null, "PrepaidAmount": 0.0, "ElegibleSIPPCodeUpgrade": null, "Attributes": {}, "ExchangeRate": null, "DailyRate": 0.0, "HourlyRate": 0.0, "ExtraDayRate": 0.0, "ExtraHourRate": 0.0, "RatePlan": null, "IsOnRequest": false, "DeliveryInfo": null, "DropoffInfo": null, "Origin": null, "CreationDate": "0001-01-01T00:00:00", "UpdatedOn": null, "UpdatedByUserName": null, "PayedByAgency": 0.0, "PayedByCustomer": 0.0, "CommercialAgreementCode": null, "PurchaseOrder": null, "Brand": null, "SalesCommision": 0.0, "IsTransfer": false, "PriceDetails": { "Price": 299.99, "CustomerPrice": 30.0, "AgencyPrice": 269.99, "SalesCommission": 0.0, "Currency": "USD" }, "Agency": null, "IsSelfCheckin": false, "Links": null, "DistanceUnit": "kilometers", "Code": null } ], "NextOffset": 0 } } } }, "400": { "description": "Invalid car ID\nor\nApi Error", "content": { "application/json": { "schema": {} } }, "x-expectedSchemas": [ { "description": "Invalid car ID", "schema": { "$ref": "#/components/schemas/Void" } }, { "description": "Api Error", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WebApiErrorResponse" } ] } } ] }, "404": { "description": "Car not found" }, "403": { "description": "Unauthenticated user" } } } }, "/api/cars": { "get": { "tags": [ "Cars" ], "summary": "List cars", "description": "This endpoint retrieves a paginated list of cars, with the option to:\n- Filter by active status\n- Sort by various criteria\n- Paginate through results", "operationId": "Cars_ListCars", "parameters": [ { "name": "active", "in": "query", "description": "Whether to return only active cars (default: true)", "schema": { "type": "boolean", "default": true, "nullable": true }, "x-position": 1 }, { "name": "offset", "in": "query", "description": "The number of records to skip (default: 0)", "schema": { "type": "integer", "format": "int32", "default": 0 }, "x-position": 2 }, { "name": "limit", "in": "query", "description": "The maximum number of records to return (default: 30)", "schema": { "type": "integer", "format": "int32", "default": 30 }, "x-position": 3 } ], "responses": { "200": { "description": "Obtiene los autos paginados.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultOfCar" }, "example": { "Offset": 0, "Limit": 30, "Total": 1, "Results": [ { "Id": "CAR123", "Model": { "Description": "The Toyota Corolla is a reliable and fuel-efficient compact sedan with modern features and comfortable interior.", "ImagePath": "/images/models/corolla.jpg", "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 750.0, "FranchiseTheft": 1000.0, "FranchiseHail": 500.0, "Brand": { "Name": "Toyota" }, "Doors": 4, "Passengers": 5, "BigLuggage": 2, "SmallLuggage": 2, "Steering": "Power Steering", "SteeringType": 3, "Gearbox": "Automatic", "TransmissionType": 2, "Multimedia": "Bluetooth, Navigation System", "AirConditioner": "Automatic Climate Control", "AirConditionerType": 1, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": [ { "Id": 1, "Name": "Fuel Type", "Description": "Type of fuel used by the vehicle", "Type": 0, "Unit": "Type", "Value": "Gasoline", "ModelId": 1 }, { "Id": 2, "Name": "Engine Size", "Description": "Engine displacement", "Type": 1, "Unit": "Liters", "Value": "1.8", "ModelId": 1 }, { "Id": 3, "Name": "Transmission", "Description": "Type of transmission", "Type": 0, "Unit": "Type", "Value": "Automatic", "ModelId": 1 } ], "LowerPrice": 45.0, "Id": 1, "Name": "Corolla", "Category": { "Models": null, "Id": 1, "Name": "Economy", "Order": 1.0, "PrincipalModelId": null, "Franchise": 0.0, "FranchiseDamage": 0.0, "FranchiseRollover": 0.0, "FranchiseTheft": 0.0, "FranchiseHail": 0.0, "ImagePath": null }, "SIPP": "CDMR" }, "CurrentBranchOfficeId": 1, "CurrentBranchOffice": "LAX Branch", "BranchOfficeOwner": "Rently LAX Airport", "CurrentKms": 50000, "FuelType": "Gasoline", "Gasoline": 75, "FriendlyName": "Toyota Corolla 2023", "CurrentPlateId": "ABC123", "ChassisIdentification": "1HGCM82633A123456", "CurrentPlate": { "Id": "ABC123", "IssuingCountry": "United States", "IssuingState": "CA" }, "Color": "Silver", "Year": 2023, "TollDeviceId": "TOLL123", "BatteryNumber": "BAT123456", "CreationDate": "0001-01-01T00:00:00", "InactiveDate": null, "LeasedToCompany": null, "SupplierFullName": null, "LastReturnDate": null } ], "NextOffset": 0 } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/cars/relocate": { "post": { "tags": [ "Cars" ], "summary": "Relocate car", "description": "This endpoint handles the relocation of a car from its current location to a new branch office.\nThe operation includes validation of the car's availability and the destination location.", "operationId": "Cars_CreateRelocation", "requestBody": { "x-name": "model", "description": "The relocation request containing car and destination details", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CarRealocate" } ] }, "example": { "CarId": "CAR123", "PlaceId": 1, "DriverId": 42, "Km": 50000, "Gasoline": 75 } } }, "x-position": 1 }, "responses": { "200": { "description": "Car relocation successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarTransferReturn" }, "example": { "Success": true, "BookingId": 12345 } } } }, "400": { "description": "Invalid request or car not available\nor\nApi Error", "content": { "application/json": { "schema": {} } }, "x-expectedSchemas": [ { "description": "Invalid request or car not available", "schema": { "$ref": "#/components/schemas/Void" } }, { "description": "Api Error", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WebApiErrorResponse" } ] } } ] }, "403": { "description": "User does not have permission to relocate cars\nor\nUnauthenticated user" } } } }, "/api/cars/transfer": { "post": { "tags": [ "Cars" ], "summary": "Transfer car", "description": "This endpoint handles the transfer of a car from its current location to a new branch office.\nThe operation includes validation of the car's availability and the destination location.", "operationId": "Cars_CreateTransfer", "requestBody": { "x-name": "model", "description": "The transfer request containing car and destination details", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CarTransfer" } ] }, "example": { "CarId": "CAR123", "FromDate": "2026-09-25T13:58:01.7686996Z", "ToDate": "2026-09-26T13:58:01.7686996Z", "PlaceId": 1, "DriverId": 42 } } }, "x-position": 1 }, "responses": { "200": { "description": "Car relocation successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarTransferReturn" }, "example": { "Success": true, "BookingId": 12345 } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/cars/{carId}/files": { "get": { "tags": [ "Cars" ], "summary": "List car files", "description": "This endpoint retrieves all files attached to a specific car, including documents, images, and other attachments.", "operationId": "Cars_ListFiles", "parameters": [ { "name": "carId", "in": "path", "required": true, "description": "The unique identifier of the car", "schema": { "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "List of files associated with the specified car", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } }, "example": { "Path": "/files/cars/CAR123/documentation/vehicle_registration.pdf", "Name": "vehicle_registration.pdf", "Category": "Documentation", "Hash": null } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } }, "post": { "tags": [ "Cars" ], "summary": "Attach files to car", "description": "This endpoint allows attaching files to a car, such as documents, images, or other relevant files.\nThe files are stored and associated with the car for future reference.", "operationId": "Cars_AttachFiles", "parameters": [ { "name": "carId", "in": "path", "required": true, "description": "The unique identifier of the car", "schema": { "type": "string", "nullable": true }, "x-position": 1 } ], "requestBody": { "x-name": "model", "description": "The list of files to be attached", "content": { "application/json": { "schema": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/FileModel" } }, "example": [ { "Name": "inspection_report.pdf", "Content": "AQIDBAU=", "Type": "Inspection" }, { "Name": "damage_photos.jpg", "Content": "BgcICQo=", "Type": "Photos" } ] } }, "x-position": 2 }, "responses": { "200": { "description": "Files attached successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } }, "example": { "Path": "/files/cars/CAR123/documentation/vehicle_registration.pdf", "Name": "vehicle_registration.pdf", "Category": "Documentation", "Hash": null } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/placetypes": { "get": { "tags": [ "General Information" ], "summary": "List place types", "description": "Retrieves all available place types in the system", "operationId": "GeneralInformation_GetPlaceTypes", "responses": { "200": { "description": "Obtiene los tipos de lugares.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlaceType" } }, "example": [ { "Id": 1, "Name": "Airport" }, { "Id": 2, "Name": "City Center" } ] } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/places": { "get": { "tags": [ "General Information" ], "summary": "List places", "description": "Retrieves all available places for pickup and return", "operationId": "GeneralInformation_GetPlaces", "parameters": [ { "name": "filterNotAvailableForExternalSystems", "in": "query", "description": "Whether to filter places not available for external systems", "schema": { "type": "boolean", "default": true }, "x-position": 1 }, { "name": "brandCodes", "in": "query", "style": "form", "explode": true, "description": "Optional list of brand codes to filter by. When omitted or empty, all places are returned.\n Each place's effective brands are resolved by falling back from the place's own brands to its branch office's brands,\n and finally to all active brands when neither has an explicit restriction.", "schema": { "type": "array", "nullable": true, "items": { "type": "string" } }, "x-position": 2 } ], "responses": { "200": { "description": "Obtiene los lugares de entrega y devolución activos para los sistemas externos.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Place" } }, "example": [ { "Price": 50.0, "Name": "Airport Terminal 1", "Category": "Airport", "Address": "123 Airport Road, New York", "City": "New York", "Country": "USA", "BranchOfficeId": 1, "BranchOfficeName": "New York Airport", "BranchOfficeIATACode": "NYC", "IsFranchise": false, "Latitude": 40.7128, "Longitude": -74.006, "CanAddCustomAddress": true, "IsCustomAddress": false, "AvailableOperationOptions": "Pickup,Return", "AvailableReturnPlaces": [ 2, 3 ], "AvailableBrandCodes": null, "Id": 1 } ] } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/branchoffices": { "get": { "tags": [ "General Information" ], "summary": "List branch offices", "description": "Retrieves all branch offices", "operationId": "GeneralInformation_GetBranchOffices", "responses": { "200": { "description": "Obtiene las sucursales activas para los sistemas externos.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BranchOffice2" } }, "example": { "Id": 1, "BusinessName": "Rently LAX Airport", "Name": "LAX Branch", "Street": "123 Airport Road", "Number": "Terminal 1", "Door": "Gate A", "City": "Los Angeles", "Country": "United States", "PostalCode": "90045", "Latitude": 33.9416, "Longitude": -118.4085, "Telephone": "+1-213-555-0123", "GuardTelephone": "+1-213-555-0124", "Email": "lax@rently.com", "IATACode": "LAX", "IsFranchise": false, "PublicWebSite": "https://rently.com/locations/lax" } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/additionals": { "get": { "tags": [ "General Information" ], "summary": "List additionals", "description": "Retrieves all available additional services", "operationId": "GeneralInformation_GetAdditionals", "responses": { "200": { "description": "Obtiene los adicionales activos para los sistemas externos.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Additional" } }, "example": { "Name": "GPS Navigation", "Description": "Portable GPS navigation system with real-time traffic updates", "ImagePath": null, "IsPriceByDay": false, "Price": 10.0, "MaxQuantityPerBooking": 0, "Type": null, "Stock": 0, "Order": 0.0, "Id": 1 } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/additionalswithstock": { "get": { "tags": [ "General Information" ], "summary": "List additionals with stock", "description": "Retrieves all available additional services with their stock information", "operationId": "GeneralInformation_GetAdditionalsWithStock", "parameters": [ { "name": "categoryId", "in": "query", "required": true, "description": "The category ID", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "modelId", "in": "query", "required": true, "description": "The model ID", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "from", "in": "query", "required": true, "description": "Start date", "schema": { "type": "string", "format": "date-time" }, "x-position": 3 }, { "name": "to", "in": "query", "required": true, "description": "End date", "schema": { "type": "string", "format": "date-time" }, "x-position": 4 }, { "name": "price", "in": "query", "required": true, "description": "Base price", "schema": { "type": "number", "format": "decimal" }, "x-position": 5 } ], "responses": { "200": { "description": "Obtiene los adicionales activos y su correspondiente stock para los sistemas externos.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Additional" } }, "example": { "Name": "GPS Navigation", "Description": "Portable GPS navigation system with real-time traffic updates", "ImagePath": null, "IsPriceByDay": false, "Price": 10.0, "MaxQuantityPerBooking": 0, "Type": null, "Stock": 0, "Order": 0.0, "Id": 1 } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/languages": { "get": { "tags": [ "General Information" ], "summary": "List languages", "description": "This endpoint returns a list of language codes (e.g., \"en\", \"es\", \"fr\") that are supported by the system.\nThese codes can be used to set the language for API requests using the Accept-Language header.", "operationId": "GeneralInformation_GetSupportedLanguages", "responses": { "200": { "description": "Obtiene la lista de idiomas soportada por el sistema.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "en", "es", "fr", "de", "it", "pt" ] } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/languages-info": { "get": { "tags": [ "General Information" ], "summary": "List language details", "description": "This endpoint returns comprehensive information about each supported language, including:\n- Language name in its native form\n- Language code (ISO 639-1)\n- Name (e.g., \"en-US\")", "operationId": "GeneralInformation_GetLanguages", "responses": { "200": { "description": "Obtiene la lista de idiomas soportada por el sistema con informacion adicional de nombre, codigos, etc.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Language" } }, "example": [ { "Name": "en-US", "DisplayName": "English (United States)", "EnglishName": "English (United States)", "NativeName": "English (United States)", "ThreeLetterWindowsLanguageName": "ENU", "ThreeLetterISOLanguageName": "eng", "TwoLetterISOLanguageName": "en" }, { "Name": "es-AR", "DisplayName": "Spanish (Argentina)", "EnglishName": "Spanish (Argentina)", "NativeName": "español (Argentina)", "ThreeLetterWindowsLanguageName": "ESS", "ThreeLetterISOLanguageName": "spa", "TwoLetterISOLanguageName": "es" } ] } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/holidays": { "get": { "tags": [ "General Information" ], "summary": "List holidays", "description": "Retrieves all holidays", "operationId": "GeneralInformation_GetHolidays", "parameters": [ { "name": "branchofficeid", "in": "query", "description": "Optional branch office ID to filter holidays", "schema": { "type": "integer", "format": "int32", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Obtiene los feriados.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Holiday" } } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/attentionschedule": { "get": { "tags": [ "General Information" ], "summary": "Get attention schedule", "description": "Retrieves the attention schedule configuration for all branch offices", "operationId": "GeneralInformation_GetAttentionSchedule", "responses": { "200": { "description": "Returns the attention schedule configuration for all branch offices", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttentionSchedule" } }, "example": [ { "Id": 1, "Schedule": { "Monday": [ { "OpenedFrom": "08:00:00", "OpenedTo": "18:00:00" } ], "Tuesday": [ { "OpenedFrom": "08:00:00", "OpenedTo": "18:00:00" } ], "Wednesday": [ { "OpenedFrom": "08:00:00", "OpenedTo": "18:00:00" } ], "Thursday": [ { "OpenedFrom": "08:00:00", "OpenedTo": "18:00:00" } ], "Friday": [ { "OpenedFrom": "08:00:00", "OpenedTo": "18:00:00" } ], "Saturday": [ { "OpenedFrom": "09:00:00", "OpenedTo": "14:00:00" } ], "Sunday": [], "Holiday": [], "ScheduleDates": [], "ClosedDays": [] }, "TimezoneId": "America/New_York", "TimezoneUTCOffset": "-04:00:00", "GapForBookingTime": 30, "Gap": 15, "AllowAfterHours": true, "BeforeHoursMaxMinutes": 60, "AfterHoursMaxMinutes": 120, "ChangeOfDayWithFixedSchedule": true, "CheckOutTime": "10:00:00" } ] } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/categories": { "get": { "tags": [ "General Information" ], "summary": "List categories", "description": "Retrieves all available vehicle categories with their active models", "operationId": "GeneralInformation_GetCategories", "responses": { "200": { "description": "Returns all available vehicle categories with their active models", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } }, "example": [ { "Models": [ { "Description": null, "ImagePath": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "Brand": { "Name": "Toyota" }, "Doors": 0, "Passengers": 0, "BigLuggage": 0, "SmallLuggage": 0, "Steering": null, "SteeringType": null, "Gearbox": null, "TransmissionType": null, "Multimedia": null, "AirConditioner": null, "AirConditionerType": null, "FuelType": null, "DailyPrice": 50.0, "ModelAttributes": null, "LowerPrice": 45.0, "Id": 1, "Name": "Toyota Yaris", "Category": null, "SIPP": null } ], "Id": 1, "Name": "Economy", "Order": 0.0, "PrincipalModelId": null, "Franchise": 1000.0, "FranchiseDamage": 500.0, "FranchiseRollover": 2000.0, "FranchiseTheft": 1500.0, "FranchiseHail": 800.0, "ImagePath": null } ] } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/promotions": { "get": { "tags": [ "General Information" ], "summary": "List promotions", "description": "Retrieves all active promotions", "operationId": "GeneralInformation_GetPromotions", "responses": { "200": { "description": "Returns all active promotions", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Promotion" } }, "example": [ { "Id": 1, "Name": "Summer Special", "Description": "20% off on all economy cars", "ImagePath": "/images/promotions/summer-special.jpg", "Order": 1.0, "Models": [ { "Id": 1, "Name": "Corolla", "Category": null, "SIPP": null } ], "AcceptedPaymentTypes": [ { "Id": 1, "Name": "Credit Card" }, { "Id": 2, "Name": "Debit Card" } ], "ValidForPayment": 0 }, { "Id": 2, "Name": "Winter Special", "Description": "10% off on all economy cars", "ImagePath": "/images/promotions/winter-special.jpg", "Order": 1.0, "Models": [ { "Id": 1, "Name": "Corolla", "Category": null, "SIPP": null } ], "AcceptedPaymentTypes": [ { "Id": 1, "Name": "Credit Card" }, { "Id": 2, "Name": "Debit Card" } ], "ValidForPayment": 0 } ] } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/promotion/{id}": { "get": { "tags": [ "General Information" ], "summary": "Get promotion", "description": "Returns a promotion by its id", "operationId": "GeneralInformation_GetPromotionById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "Returns a promotion by its id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Promotion" }, "example": { "Id": 1, "Name": "Summer Special", "Description": "20% off on all economy cars", "ImagePath": "/images/promotions/summer-special.jpg", "Order": 1.0, "Models": [ { "Id": 1, "Name": "Corolla", "Category": null, "SIPP": null } ], "AcceptedPaymentTypes": [ { "Id": 1, "Name": "Credit Card" }, { "Id": 2, "Name": "Debit Card" } ], "ValidForPayment": 0 } } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/promotions/{promotionCode}/valid": { "get": { "tags": [ "General Information" ], "summary": "Validate promotion", "description": "Returns a promotion if the code is valid and meets all validation criteria", "operationId": "GeneralInformation_GetValidPromotion", "parameters": [ { "name": "promotionCode", "in": "path", "required": true, "description": "The promotion code to validate", "schema": { "type": "string", "nullable": true }, "x-position": 1 }, { "name": "totalDays", "in": "query", "description": "Total days of the rental (optional, for future use)", "schema": { "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "fromDate", "in": "query", "description": "Rental pickup date (validates against promotion's valid pickup date range)", "schema": { "type": "string", "format": "date-time", "nullable": true }, "x-position": 3 }, { "name": "toDate", "in": "query", "description": "Rental return date (validates against promotion's valid dropoff date range and calculates total days)", "schema": { "type": "string", "format": "date-time", "nullable": true }, "x-position": 4 }, { "name": "categoryId", "in": "query", "description": "Vehicle category ID (validates against promotion's allowed categories)", "schema": { "type": "integer", "format": "int32", "nullable": true }, "x-position": 5 }, { "name": "modelId", "in": "query", "description": "Vehicle model ID (validates against promotion's allowed models)", "schema": { "type": "integer", "format": "int32", "nullable": true }, "x-position": 6 }, { "name": "deliveryPlaceId", "in": "query", "description": "Pickup place ID (validates against promotion's allowed branch offices)", "schema": { "type": "integer", "format": "int32", "nullable": true }, "x-position": 7 }, { "name": "returnPlaceId", "in": "query", "description": "Return place ID (validates against promotion's valid dropoff days)", "schema": { "type": "integer", "format": "int32", "nullable": true }, "x-position": 8 } ], "responses": { "200": { "description": "Returns the promotion for the given code if it's valid", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Promotion" } }, "example": { "Id": 1, "Name": "Summer Special", "Description": "20% off on all economy cars", "ImagePath": "/images/promotions/summer-special.jpg", "Order": 1.0, "Models": [ { "Id": 1, "Name": "Corolla", "Category": null, "SIPP": null } ], "AcceptedPaymentTypes": [ { "Id": 1, "Name": "Credit Card" }, { "Id": 2, "Name": "Debit Card" } ], "ValidForPayment": 0 } } } }, "404": { "description": "If there is no valid promotion for the given code" }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/currencies": { "get": { "tags": [ "General Information" ], "summary": "List currencies", "description": "Retrieves all supported currencies with their exchange rates", "operationId": "GeneralInformation_GetCurrencies", "responses": { "200": { "description": "Gets the supported currencies of the system and the current exchange rate", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Currency" } }, "example": [ { "Id": 1, "Name": "US Dollar", "Symbol": "$", "ExchangeRate": 1.0, "IsSystemDefault": true, "ISOCode": "USD" }, { "Id": 2, "Name": "Euro", "Symbol": "€", "ExchangeRate": 0.85, "IsSystemDefault": false, "ISOCode": "EUR" } ] } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/services/{id}": { "get": { "tags": [ "Services" ], "summary": "Get service", "description": "Retrieves a specific service by its identifier", "operationId": "Services_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The unique identifier of the service", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "Returns the requested service", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Service" }, "example": { "Id": 1, "CarId": "CAR123", "Km": 50000, "ServiceType": { "Id": 1, "Name": "Oil Change" }, "Notes": "Regular maintenance service", "FromDate": "2026-09-24T13:58:02.1266879Z", "ToDate": "2026-09-24T15:58:02.1266879Z", "Status": 0, "Provider": null, "Price": 0.0, "IsFixed": true, "IsLockedForEdit": false } } } }, "404": { "description": "Service not found" }, "400": { "description": "Invalid service ID\nor\nApi Error", "content": { "application/json": { "schema": {} } }, "x-expectedSchemas": [ { "description": "Invalid service ID", "schema": { "$ref": "#/components/schemas/Void" } }, { "description": "Api Error", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WebApiErrorResponse" } ] } } ] }, "403": { "description": "Unauthenticated user" } } } }, "/api/services/types": { "get": { "tags": [ "Services" ], "summary": "List service types", "description": "Retrieves all active service types", "operationId": "Services_GetServiceTypes", "responses": { "200": { "description": "Returns the list of active service types", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceType" } }, "example": [ { "Id": 1, "Name": "Oil Change" }, { "Id": 2, "Name": "Tire Rotation" }, { "Id": 3, "Name": "Brake Service" } ] } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/services": { "post": { "tags": [ "Services" ], "summary": "Create service", "description": "This endpoint creates a new service schedule for a car, including:\n- Service type\n- Service dates\n- Provider information\n- Initial status\nThe operation requires the 'CanCreateServiceSchedule' permission.", "operationId": "Services_Create", "requestBody": { "x-name": "model", "description": "The service creation request", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CreateService" } ] }, "example": { "CarId": "CAR123", "Km": 50000, "ServiceTypeId": 1, "Notes": "Regular maintenance service", "FromDate": "2026-09-24T13:58:02.1580503Z", "ToDate": "2026-09-24T15:58:02.1580503Z", "Status": 0, "ProviderId": 1, "Price": 0.0, "IsFixed": false, "IsLockedForEdit": false } } }, "x-position": 1 }, "responses": { "200": { "description": "Returns the created service", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Service" }, "example": { "Id": 1, "CarId": "CAR123", "Km": 50000, "ServiceType": { "Id": 1, "Name": "Oil Change" }, "Notes": "Regular maintenance service", "FromDate": "2026-09-24T13:58:02.1570558Z", "ToDate": "2026-09-24T15:58:02.1570558Z", "Status": 0, "Provider": null, "Price": 0.0, "IsFixed": true, "IsLockedForEdit": false } } } }, "400": { "description": "Invalid request or car not available\nor\nApi Error", "content": { "application/json": { "schema": {} } }, "x-expectedSchemas": [ { "description": "Invalid request or car not available", "schema": { "$ref": "#/components/schemas/Void" } }, { "description": "Api Error", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WebApiErrorResponse" } ] } } ] }, "403": { "description": "User lacks required permissions\nor\nUnauthenticated user" } } }, "put": { "tags": [ "Services" ], "summary": "Update service", "description": "This endpoint updates an existing service schedule, including:\n- Service dates\n- Provider information\n- Service status\n- Additional notes\nThe operation requires the 'CanEditServiceSchedule' permission.\nAdditional permissions may be required for specific operations:\n- CanBlockServiceUpdates: To change the locked status\n- CanMakeServiceFixed: To change the fixed status", "operationId": "Services_Edit", "requestBody": { "x-name": "model", "description": "The service update request", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/UpdateService" } ] }, "example": { "Id": 1, "CarId": "CAR123", "Km": 50000, "ServiceTypeId": 1, "Notes": "Regular maintenance service", "FromDate": "2026-09-24T13:58:02.1741426Z", "ToDate": "2026-09-24T15:58:02.1741426Z", "Status": 1, "ProviderId": 1, "Price": 0.0, "IsFixed": true, "IsLockedForEdit": false } } }, "x-position": 1 }, "responses": { "200": { "description": "Returns the updated service", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Service" }, "example": { "Id": 1, "CarId": "CAR123", "Km": 50000, "ServiceType": { "Id": 1, "Name": "Oil Change" }, "Notes": "Regular maintenance service", "FromDate": "2026-09-24T13:58:02.1731399Z", "ToDate": "2026-09-24T15:58:02.1731399Z", "Status": 0, "Provider": null, "Price": 0.0, "IsFixed": true, "IsLockedForEdit": false } } } }, "400": { "description": "Invalid request or car not available\nor\nApi Error", "content": { "application/json": { "schema": {} } }, "x-expectedSchemas": [ { "description": "Invalid request or car not available", "schema": { "$ref": "#/components/schemas/Void" } }, { "description": "Api Error", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WebApiErrorResponse" } ] } } ] }, "403": { "description": "User lacks required permissions\nor\nUnauthenticated user" }, "404": { "description": "Service not found" } } } }, "/api/listWebFiles": { "get": { "tags": [ "Storage" ], "summary": "List web files", "description": "Lists all web files available in the storage", "operationId": "Storage_ListWebFiles", "responses": { "200": { "description": "List of web file URIs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uri" } }, "example": [ "https://example.com/files/document1.pdf", "https://example.com/files/image1.jpg", "https://example.com/files/report.xlsx" ] } } }, "400": { "description": "Api Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiErrorResponse" } } } }, "403": { "description": "Unauthenticated user" } } } }, "/api/addWebFile": { "post": { "tags": [ "Storage" ], "summary": "Add web file", "description": "Adds a new file to the web storage", "operationId": "Storage_AddWebFile", "requestBody": { "x-name": "file", "description": "The file to be added, including its name and base64 content", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ApiFileModel" } ] }, "example": { "FileName": "example.pdf", "Base64File": "JVBERi0xLjcKCjEgMCBvYmogICUgZW50cnkgcG9pbnQKPDwKICAvVHlwZSAvQ2F0YWxvZwogIC9QYWdlcyAyIDAgUgo+PgplbmRvYmoK" } } }, "x-position": 1 }, "responses": { "200": { "description": "File path where the file was saved", "content": { "application/json": { "schema": { "type": "string" }, "example": "/files/web/example.pdf" } } }, "400": { "description": "Invalid file data\nor\nApi Error", "content": { "application/json": { "schema": {} } }, "x-expectedSchemas": [ { "description": "Invalid file data", "schema": { "$ref": "#/components/schemas/Void" } }, { "description": "Api Error", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WebApiErrorResponse" } ] } } ] }, "403": { "description": "Unauthenticated user" } } } }, "/odata/Agencies": { "get": { "tags": [ "OData · Agencies" ], "summary": "List Agencies (OData)", "description": "Soporta las opciones de consulta OData: $filter, $select, $expand, $orderby, $top, $skip, $count.", "operationId": "OData_Agencies_List", "parameters": [ { "name": "$filter", "in": "query", "schema": { "type": "string" } }, { "name": "$orderby", "in": "query", "schema": { "type": "string" } }, { "name": "$select", "in": "query", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "schema": { "type": "string" } }, { "name": "$top", "in": "query", "schema": { "type": "integer" } }, { "name": "$skip", "in": "query", "schema": { "type": "integer" } }, { "name": "$count", "in": "query", "schema": { "type": "boolean" } }, { "name": "q", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Agency2" } } } } } } } }, "/odata/Agencies({key})": { "get": { "tags": [ "OData · Agencies" ], "summary": "Get Agencies by key (OData)", "operationId": "OData_Agencies_Get", "parameters": [ { "name": "key", "in": "path", "required": true, "description": "Identificador del registro.", "schema": { "type": "integer" } }, { "name": "$select", "in": "query", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agency2" } } } } } } }, "/odata/BookingBrands": { "get": { "tags": [ "OData · BookingBrands" ], "summary": "List BookingBrands (OData)", "description": "Soporta las opciones de consulta OData: $filter, $select, $expand, $orderby, $top, $skip, $count.", "operationId": "OData_BookingBrands_List", "parameters": [ { "name": "$filter", "in": "query", "schema": { "type": "string" } }, { "name": "$orderby", "in": "query", "schema": { "type": "string" } }, { "name": "$select", "in": "query", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "schema": { "type": "string" } }, { "name": "$top", "in": "query", "schema": { "type": "integer" } }, { "name": "$skip", "in": "query", "schema": { "type": "integer" } }, { "name": "$count", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BookingBrand2" } } } } } } } }, "/odata/BookingBrands({key})": { "get": { "tags": [ "OData · BookingBrands" ], "summary": "Get BookingBrands by key (OData)", "operationId": "OData_BookingBrands_Get", "parameters": [ { "name": "key", "in": "path", "required": true, "description": "Identificador del registro.", "schema": { "type": "integer" } }, { "name": "$select", "in": "query", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookingBrand2" } } } } } } }, "/odata/Categories": { "get": { "tags": [ "OData · Categories" ], "summary": "List Categories (OData)", "description": "Soporta las opciones de consulta OData: $filter, $select, $expand, $orderby, $top, $skip, $count.", "operationId": "OData_Categories_List", "parameters": [ { "name": "$filter", "in": "query", "schema": { "type": "string" } }, { "name": "$orderby", "in": "query", "schema": { "type": "string" } }, { "name": "$select", "in": "query", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "schema": { "type": "string" } }, { "name": "$top", "in": "query", "schema": { "type": "integer" } }, { "name": "$skip", "in": "query", "schema": { "type": "integer" } }, { "name": "$count", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Category2" } } } } } } } }, "/odata/Categories({key})": { "get": { "tags": [ "OData · Categories" ], "summary": "Get Categories by key (OData)", "operationId": "OData_Categories_Get", "parameters": [ { "name": "key", "in": "path", "required": true, "description": "Identificador del registro.", "schema": { "type": "integer" } }, { "name": "$select", "in": "query", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Category2" } } } } } } }, "/odata/Customers": { "get": { "tags": [ "OData · Customers" ], "summary": "List Customers (OData)", "description": "Soporta las opciones de consulta OData: $filter, $select, $expand, $orderby, $top, $skip, $count.", "operationId": "OData_Customers_List", "parameters": [ { "name": "$filter", "in": "query", "schema": { "type": "string" } }, { "name": "$orderby", "in": "query", "schema": { "type": "string" } }, { "name": "$select", "in": "query", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "schema": { "type": "string" } }, { "name": "$top", "in": "query", "schema": { "type": "integer" } }, { "name": "$skip", "in": "query", "schema": { "type": "integer" } }, { "name": "$count", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Customer2" } } } } } } } }, "/odata/Customers({key})": { "get": { "tags": [ "OData · Customers" ], "summary": "Get Customers by key (OData)", "operationId": "OData_Customers_Get", "parameters": [ { "name": "key", "in": "path", "required": true, "description": "Identificador del registro.", "schema": { "type": "integer" } }, { "name": "$select", "in": "query", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "schema": { "type": "string" } }, { "name": "skipCache", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer2" } } } } } } }, "/odata/Models": { "get": { "tags": [ "OData · Models" ], "summary": "List Models (OData)", "description": "Soporta las opciones de consulta OData: $filter, $select, $expand, $orderby, $top, $skip, $count.", "operationId": "OData_Models_List", "parameters": [ { "name": "$filter", "in": "query", "schema": { "type": "string" } }, { "name": "$orderby", "in": "query", "schema": { "type": "string" } }, { "name": "$select", "in": "query", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "schema": { "type": "string" } }, { "name": "$top", "in": "query", "schema": { "type": "integer" } }, { "name": "$skip", "in": "query", "schema": { "type": "integer" } }, { "name": "$count", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Model2" } } } } } } } }, "/odata/Models({key})": { "get": { "tags": [ "OData · Models" ], "summary": "Get Models by key (OData)", "operationId": "OData_Models_Get", "parameters": [ { "name": "key", "in": "path", "required": true, "description": "Identificador del registro.", "schema": { "type": "integer" } }, { "name": "$select", "in": "query", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Model2" } } } } } } }, "/odata/Bookings": { "get": { "tags": [ "OData · Bookings" ], "summary": "List Bookings (OData)", "description": "Soporta las opciones de consulta OData: $filter, $select, $expand, $orderby, $top, $skip, $count.", "operationId": "OData_Bookings_List", "parameters": [ { "name": "$filter", "in": "query", "schema": { "type": "string" } }, { "name": "$orderby", "in": "query", "schema": { "type": "string" } }, { "name": "$select", "in": "query", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "schema": { "type": "string" } }, { "name": "$top", "in": "query", "schema": { "type": "integer" } }, { "name": "$skip", "in": "query", "schema": { "type": "integer" } }, { "name": "$count", "in": "query", "schema": { "type": "boolean" } }, { "name": "customerId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Booking2" } } } } } } } }, "/odata/Bookings({key})": { "get": { "tags": [ "OData · Bookings" ], "summary": "Get Bookings by key (OData)", "operationId": "OData_Bookings_Get", "parameters": [ { "name": "key", "in": "path", "required": true, "description": "Identificador del registro.", "schema": { "type": "integer" } }, { "name": "$select", "in": "query", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "schema": { "type": "string" } }, { "name": "skipCache", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Booking2" } } } } } } }, "/odata/Cars": { "get": { "tags": [ "OData · Cars" ], "summary": "List Cars (OData)", "description": "Soporta las opciones de consulta OData: $filter, $select, $expand, $orderby, $top, $skip, $count.", "operationId": "OData_Cars_List", "parameters": [ { "name": "$filter", "in": "query", "schema": { "type": "string" } }, { "name": "$orderby", "in": "query", "schema": { "type": "string" } }, { "name": "$select", "in": "query", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "schema": { "type": "string" } }, { "name": "$top", "in": "query", "schema": { "type": "integer" } }, { "name": "$skip", "in": "query", "schema": { "type": "integer" } }, { "name": "$count", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Car2" } } } } } } } }, "/odata/Cars('{key}')": { "get": { "tags": [ "OData · Cars" ], "summary": "Get Cars by key (OData)", "operationId": "OData_Cars_Get", "parameters": [ { "name": "key", "in": "path", "required": true, "description": "Identificador del registro.", "schema": { "type": "string" } }, { "name": "$select", "in": "query", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Car2" } } } } } } }, "/odata/MailAccounts": { "get": { "tags": [ "OData · MailAccounts" ], "summary": "List MailAccounts (OData)", "description": "Soporta las opciones de consulta OData: $filter, $select, $expand, $orderby, $top, $skip, $count.", "operationId": "OData_MailAccounts_List", "parameters": [ { "name": "$filter", "in": "query", "schema": { "type": "string" } }, { "name": "$orderby", "in": "query", "schema": { "type": "string" } }, { "name": "$select", "in": "query", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "schema": { "type": "string" } }, { "name": "$top", "in": "query", "schema": { "type": "integer" } }, { "name": "$skip", "in": "query", "schema": { "type": "integer" } }, { "name": "$count", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MailAccount" } } } } } } } }, "/odata/MailAccounts({key})": { "get": { "tags": [ "OData · MailAccounts" ], "summary": "Get MailAccounts by key (OData)", "operationId": "OData_MailAccounts_Get", "parameters": [ { "name": "key", "in": "path", "required": true, "description": "Identificador del registro.", "schema": { "type": "integer" } }, { "name": "$select", "in": "query", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailAccount" } } } } } } }, "/odata/Places": { "get": { "tags": [ "OData · Places" ], "summary": "List Places (OData)", "description": "Soporta las opciones de consulta OData: $filter, $select, $expand, $orderby, $top, $skip, $count.", "operationId": "OData_Places_List", "parameters": [ { "name": "$filter", "in": "query", "schema": { "type": "string" } }, { "name": "$orderby", "in": "query", "schema": { "type": "string" } }, { "name": "$select", "in": "query", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "schema": { "type": "string" } }, { "name": "$top", "in": "query", "schema": { "type": "integer" } }, { "name": "$skip", "in": "query", "schema": { "type": "integer" } }, { "name": "$count", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Place3" } } } } } } } }, "/odata/Places({key})": { "get": { "tags": [ "OData · Places" ], "summary": "Get Places by key (OData)", "operationId": "OData_Places_Get", "parameters": [ { "name": "key", "in": "path", "required": true, "description": "Identificador del registro.", "schema": { "type": "integer" } }, { "name": "$select", "in": "query", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "schema": { "type": "string" } }, { "name": "skipCache", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Place3" } } } } } } }, "/odata/PriceAgreements": { "get": { "tags": [ "OData · PriceAgreements" ], "summary": "List PriceAgreements (OData)", "description": "Soporta las opciones de consulta OData: $filter, $select, $expand, $orderby, $top, $skip, $count.", "operationId": "OData_PriceAgreements_List", "parameters": [ { "name": "$filter", "in": "query", "schema": { "type": "string" } }, { "name": "$orderby", "in": "query", "schema": { "type": "string" } }, { "name": "$select", "in": "query", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "schema": { "type": "string" } }, { "name": "$top", "in": "query", "schema": { "type": "integer" } }, { "name": "$skip", "in": "query", "schema": { "type": "integer" } }, { "name": "$count", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PriceAgreement" } } } } } } } }, "/odata/PriceAgreements({key})": { "get": { "tags": [ "OData · PriceAgreements" ], "summary": "Get PriceAgreements by key (OData)", "operationId": "OData_PriceAgreements_Get", "parameters": [ { "name": "key", "in": "path", "required": true, "description": "Identificador del registro.", "schema": { "type": "integer" } }, { "name": "$select", "in": "query", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceAgreement" } } } } } } }, "/odata/Rates": { "get": { "tags": [ "OData · Rates" ], "summary": "List Rates (OData)", "description": "Soporta las opciones de consulta OData: $filter, $select, $expand, $orderby, $top, $skip, $count.", "operationId": "OData_Rates_List", "parameters": [ { "name": "$filter", "in": "query", "schema": { "type": "string" } }, { "name": "$orderby", "in": "query", "schema": { "type": "string" } }, { "name": "$select", "in": "query", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "schema": { "type": "string" } }, { "name": "$top", "in": "query", "schema": { "type": "integer" } }, { "name": "$skip", "in": "query", "schema": { "type": "integer" } }, { "name": "$count", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Rate2" } } } } } } } }, "/odata/Rates({key})": { "get": { "tags": [ "OData · Rates" ], "summary": "Get Rates by key (OData)", "operationId": "OData_Rates_Get", "parameters": [ { "name": "key", "in": "path", "required": true, "description": "Identificador del registro.", "schema": { "type": "integer" } }, { "name": "$select", "in": "query", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rate2" } } } } } } }, "/auth/token": { "post": { "tags": [ "Authentication" ], "operationId": "Auth_Token", "summary": "Get an access token", "description": "Exchanges your API credentials for a Bearer access token using the OAuth2 `client_credentials` grant. Send the form-encoded body and use the returned `access_token` as `Authorization: Bearer ` on the other endpoints. The token is valid for one day.", "security": [], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "grant_type", "client_id", "client_secret" ], "properties": { "grant_type": { "type": "string", "default": "client_credentials", "description": "OAuth2 grant type. Use `client_credentials`." }, "client_id": { "type": "string", "description": "Your API username (client id)." }, "client_secret": { "type": "string", "description": "Your API password (client secret)." } } } } } }, "responses": { "200": { "description": "The access token.", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string", "description": "The Bearer token to send in the Authorization header on subsequent requests." }, "token_type": { "type": "string", "description": "Always `bearer`." }, "expires_in": { "type": "integer", "format": "int32", "description": "Token lifetime in seconds." } } }, "example": { "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...", "token_type": "bearer", "expires_in": 86399 } } } }, "400": { "description": "Invalid credentials or malformed request." } } } } }, "components": { "schemas": { "BradescoWebhookMessage": { "type": "object", "description": "Notificación que Bradesco envía al endpoint del webhook cuando cambia la situación de un boleto.", "additionalProperties": false, "properties": { "TipoEvento": { "type": "string", "description": "Tipo de evento. P es pago, el único con efecto económico.", "nullable": true }, "Produto": { "type": "string", "description": "Carteira del producto.", "nullable": true }, "Negociacao": { "type": "string", "description": "Negociación del convenio que notifica.", "nullable": true }, "NossoNumero": { "type": "string", "description": "Nosso número: identificador único del boleto y clave de conciliación.", "nullable": true }, "DataRegistro": { "type": "string", "description": "Fecha de registro del título.", "nullable": true }, "DataVencimento": { "type": "string", "description": "Fecha de vencimiento del título.", "nullable": true }, "ValorBoleto": { "type": "string", "description": "Importe original del título.", "nullable": true }, "BancoRecebedor": { "type": "string", "description": "Banco receptor del pago.", "nullable": true }, "CanalPagamento": { "type": "string", "description": "Canal de pago: 1 sucursal, 2 cajero, 3 internet, 4 Pix, 5 correspondiente, 6 call center, 7 archivo\nelectrónico, 8 débito directo autorizado, 9 correspondiente digital.", "nullable": true }, "DataPagamento": { "type": "string", "description": "Fecha de pago informada por el banco. Es la fecha contable de la acreditación.", "nullable": true }, "HoraPagamento": { "type": "string", "description": "Hora de pago.", "nullable": true }, "ValorPagamento": { "type": "string", "description": "Importe efectivamente pagado. Es el que se valida contra el emitido.", "nullable": true }, "ValorAbatimento": { "type": "string", "description": "Importe de abatimiento.", "nullable": true }, "ValorMulta": { "type": "string", "description": "Importe de multa.", "nullable": true }, "ValorJuros": { "type": "string", "description": "Importe de intereses.", "nullable": true }, "ValorDesc": { "type": "string", "description": "Importe de descuento.", "nullable": true } } }, "SantanderWebhookMessage": { "type": "object", "description": "Estructura del evento que Santander envía al endpoint de webhook cuando cambia el estado de un boleto.", "additionalProperties": false, "properties": { "EventId": { "type": "string", "nullable": true }, "EventType": { "type": "string", "description": "Tipo de evento (ej. PAYMENT). Forma anidada.", "nullable": true }, "EventDate": { "type": "string", "nullable": true }, "WorkspaceId": { "type": "string", "description": "Workspace del evento. Solo lo trae la forma anidada; el cross-check de\nSantanderController.IsAuthentic lo omite cuando no viene.", "nullable": true }, "Bill": { "description": "Datos del boleto en la forma ANIDADA. Null si el evento llegó plano.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SantanderWebhookBill" } ] }, "Function": { "type": "string", "description": "Operación notificada. PAGAMENTO equivale a una liquidación.", "nullable": true }, "BankNumber": { "type": "string", "description": "Nosso número del boleto en la forma plana (equivale a NossoNumero).", "nullable": true }, "ClientNumber": { "type": "string", "nullable": true }, "PaymentDate": { "type": "string", "nullable": true }, "PaidValue": { "type": "number", "format": "decimal", "nullable": true }, "Status": { "type": "string", "description": "Estado del boleto si la forma plana lo informa explícitamente, en lugar de a través de\nFunction.", "nullable": true } } }, "SantanderWebhookBill": { "type": "object", "additionalProperties": false, "properties": { "NossoNumero": { "type": "string", "nullable": true }, "ClientNumber": { "type": "string", "nullable": true }, "BarCode": { "type": "string", "nullable": true }, "Status": { "type": "string", "nullable": true }, "PaymentDate": { "type": "string", "nullable": true }, "PaidValue": { "type": "number", "format": "decimal", "nullable": true }, "PaidChannel": { "type": "string", "nullable": true } } }, "IndicationData": { "allOf": [ { "$ref": "#/components/schemas/IndicationCommonData" }, { "type": "object", "additionalProperties": false, "properties": { "scanIdentifier": { "type": "string", "nullable": true }, "secIndicationData": { "type": "string", "nullable": true } } } ] }, "IndicationCommonData": { "type": "object", "additionalProperties": false, "properties": { "requestType": { "type": "string", "nullable": true }, "hmac": { "type": "string", "nullable": true } } }, "WebApiErrorResponse": { "type": "object", "description": "Represents an error response from the web API", "additionalProperties": false, "properties": { "ErrorMessage": { "type": "string", "description": "A human-readable message describing the error", "nullable": true }, "ErrorCode": { "description": "A specific error code identifying the type of error", "oneOf": [ { "$ref": "#/components/schemas/ApiErrorCode" } ] }, "Id": { "type": "string", "description": "A unique identifier for tracking the error", "nullable": true } } }, "ApiErrorCode": { "type": "integer", "description": "Represents the error codes that can be returned by the API.\n\n| Value | Name | Description |\n| ---: | --- | --- |\n| 0 | `NoError` | No error occurred. |\n| 1 | `CustomerNotFound` | The requested customer was not found in the system. |\n| 2 | `CarNotFound` | The requested car was not found in the system. |\n| 3 | `CarNotAvailable` | The requested car is not available for the specified dates. |\n| 4 | `PriceMismatch` | The calculated price does not match the expected price. |\n| 5 | `CustomerDataNotValid` | The customer data provided is not valid. |\n| 6 | `LanguageNotSupported` | The requested language is not supported by the system. |\n| 7 | `InsuficientPermissions` | The user does not have sufficient permissions to perform the operation. |\n| 8 | `BookingNotFoundForCustomer` | No booking was found for the specified customer. |\n| 9 | `BookingStatusNotAllowCancel` | The current booking status does not allow cancellation. |\n| 10 | `CreditCardNotAvailable` | The credit card is not available for use. |\n| 11 | `GatewayNotSupported` | The requested payment gateway is not supported. |\n| 12 | `InfractionNotFound` | The requested infraction was not found. |\n| 13 | `InvlaidDates` | The provided dates are invalid. |\n| 14 | `UnquotedReserve` | The reservation has not been quoted. |\n| 15 | `MaxDayForQuotedReserve` | The maximum number of days for a quoted reservation has been exceeded. |\n| 21 | `TariffNotFound` | The requested tariff was not found. |\n| 22 | `BookingNotFound` | The requested booking was not found. |\n| 23 | `ReturnPlaceNotFound` | The specified return place was not found. |\n| 24 | `PromotionNotFound` | The requested promotion was not found. |\n| 25 | `DeliveryPlaceNotFound` | The specified delivery place was not found. |\n| 26 | `BookingStatusNotAllowUpdate` | The current booking status does not allow updates. |\n| 27 | `IlimitedKmNotEnabled` | Unlimited kilometers option is not enabled. |\n| 28 | `LimitedKmNotEnabled` | Limited kilometers option is not enabled. |\n| 29 | `MinimunDaysOfBookingNotReached` | The minimum number of days for booking has not been reached. |\n| 30 | `MaxDaysOfBookingReached` | The maximum number of days for booking has been exceeded. |\n| 31 | `AdditionalNotFound` | The requested additional item was not found. |\n| 32 | `AdditionalMaxQuantityExceeded` | The maximum quantity for the additional item has been exceeded. |\n| 33 | `DateFromForBookingNotEnabled` | The start date for the booking is not enabled. |\n| 34 | `DriverAgeNotAllowed` | The driver's age is not within the allowed range. |\n| 35 | `BookingVersionError` | There is a version mismatch with the booking. |\n| 36 | `BookingAlreadyDelivered` | The booking has already been delivered. |\n| 37 | `BookingAlreadyReturned` | The booking has already been returned. |\n| 38 | `BookingNeedsToCompleteDeposit` | The booking requires a deposit to be completed. |\n| 39 | `InvalidCarKilometers` | The car's kilometers value is invalid. |\n| 40 | `BookingStatusNotAllowDelivery` | The current booking status does not allow delivery. |\n| 41 | `DriverLicenseInvalid` | The driver's license is invalid. |\n| 42 | `BookingStatusNotAllowReturn` | The current booking status does not allow return. |\n| 43 | `NotificationRelatedEntityNotFound` | The notification's related entity was not found. |\n| 44 | `NotificationReceiverAddressInvalid` | The notification receiver's address is invalid. |\n| 45 | `MailNotificationDisabled` | Mail notifications are disabled. |\n| 46 | `ReturnPlaceNotAllowedForDeliveryPlace` | The return place is not allowed for the specified delivery place. |\n| 47 | `BookingOutOfOfficeHoursNotAllowed` | Booking outside of office hours is not allowed. |\n| 48 | `NotificationNotFound` | The requested notification was not found. |\n| 49 | `BlockedCustomerToBook` | The customer is blocked from making bookings. |\n| 50 | `MustHaveAtLeastOneInsurance` | The system configuration requires at least one insurance to be selected when creating or editing a booking. |\n| 51 | `InvalidCommercialAgreement` | The commercial agreement is invalid. |\n| 60 | `AppProtocolNotFound` | The application protocol was not found. |\n| 61 | `ServiceTypeInvalid` | The service type is invalid. |\n| 62 | `ServiceStatusInvalid` | The service status is invalid. |\n| 63 | `ServiceDatesInvalids` | The service dates are invalid. |\n| 64 | `ServiceProviderNotFound` | The service provider was not found. |\n| 65 | `ServiceCanNotCreate` | The service cannot be created. |\n| 66 | `ServiceCanNotEdit` | The service cannot be edited. |\n| 67 | `ServiceNotFound` | The requested service was not found. |\n| 68 | `CarLocationInvalidDriver` | The car location has an invalid driver. |\n| 69 | `ReturnPlaceIsCurrentPlaceError` | The return place is the same as the current place. |\n| 70 | `CarIsNotFree` | The car is not available for the requested operation. |\n| 71 | `CarTransferError` | An error occurred during car transfer. |\n| 72 | `InvalidCarGasoline` | The car's gasoline level is invalid. |\n| 73 | `CannotDeliverBookingWithBalance` | Cannot deliver a booking with an outstanding balance. |\n| 74 | `PlaceDoesNotAcceptCustomAddresses` | The place does not accept custom addresses. |\n| 75 | `PlaceCantOperatesLikePickUp` | The place cannot operate as a pick-up location. |\n| 76 | `PlaceCantOperatesLikeDropOff` | The place cannot operate as a drop-off location. |\n| 77 | `CannotPayQuote` | Cannot pay the quote. |\n| 80 | `FeatureNotEnabled` | The requested feature is not enabled. |\n| 98 | `ModelNotValid` | The model is not valid. |\n| 99 | `Unknown` | An unknown error occurred. |\n| 100 | `MissingCurrencyCode` | The currency code is missing. |\n| 101 | `TotalGreaterThanZero` | The total amount must be greater than zero. |\n| 102 | `InfractionAlreadyExists` | The infraction act or violation already exists in the system. |\n| 103 | `InvalidIncidentType` | The incident type is invalid |\n| 104 | `InvalidIncidentDate` | The incident date is invalid |\n| 105 | `SettingNotFound` | A required setting was not found |\n| 106 | `BookingBrandNotFound` | Booking Brand not found |\n| 107 | `BookingCannotBeUncancelled` | — |\n| 108 | `RateAlreadyExists` | A rate with the given code already exists and updates were not requested. |\n| 109 | `DuplicateCustomerGlobalId` | More than one active customer shares the same GlobalId, so the customer cannot be resolved unambiguously. Indicates a data-integrity problem (GlobalId must be unique). |\n| 110 | `AgencyNotConfigured` | A commercial agreement code was sent, but the external system user has no agency configured and no valid agency was sent in the booking, so the agreement cannot be applied. |\n| 499 | `Timeout` | — |\n| 1100 | `MappingAlreadyExists` | — |\n| 1101 | `ModelNotExists` | — |\n| 1102 | `CompanyCodeNotFound` | — |\n| 1103 | `CommercialAgreementNotSupported` | The commercial agreement is not supported. |\n| 1104 | `CommercialAgreementRequired` | — |\n| 1105 | `InfractionNoticeNotFound` | The referenced InfractionNotice was not found for the tenant. |\n| 1106 | `InfractionNoticeDismissed` | The referenced InfractionNotice is dismissed and cannot be linked. |\n| 1107 | `InfractionNoticeContextMismatch` | The infraction context (car, date, booking or driver) does not match the InfractionNotice. |\n| 1108 | `InfractionNoticeMainAlreadyLinked` | The InfractionNotice already has a main infraction linked. |\n| 1109 | `InfractionNoticeNicAlreadyLinked` | The InfractionNotice already has a NIC (driver non-identification penalty) infraction linked. |\n| 1110 | `InfractionNoticeInfractionAlreadyLinked` | The infraction is already linked to a different InfractionNotice. |\n| 1111 | `PriceAgreementNotFound` | The requested price agreement was not found. |\n", "x-enumNames": [ "NoError", "CustomerNotFound", "CarNotFound", "CarNotAvailable", "PriceMismatch", "CustomerDataNotValid", "LanguageNotSupported", "InsuficientPermissions", "BookingNotFoundForCustomer", "BookingStatusNotAllowCancel", "CreditCardNotAvailable", "GatewayNotSupported", "InfractionNotFound", "InvlaidDates", "UnquotedReserve", "MaxDayForQuotedReserve", "TariffNotFound", "BookingNotFound", "ReturnPlaceNotFound", "PromotionNotFound", "DeliveryPlaceNotFound", "BookingStatusNotAllowUpdate", "IlimitedKmNotEnabled", "LimitedKmNotEnabled", "MinimunDaysOfBookingNotReached", "MaxDaysOfBookingReached", "AdditionalNotFound", "AdditionalMaxQuantityExceeded", "DateFromForBookingNotEnabled", "DriverAgeNotAllowed", "BookingVersionError", "BookingAlreadyDelivered", "BookingAlreadyReturned", "BookingNeedsToCompleteDeposit", "InvalidCarKilometers", "BookingStatusNotAllowDelivery", "DriverLicenseInvalid", "BookingStatusNotAllowReturn", "NotificationRelatedEntityNotFound", "NotificationReceiverAddressInvalid", "MailNotificationDisabled", "ReturnPlaceNotAllowedForDeliveryPlace", "BookingOutOfOfficeHoursNotAllowed", "NotificationNotFound", "BlockedCustomerToBook", "MustHaveAtLeastOneInsurance", "InvalidCommercialAgreement", "AppProtocolNotFound", "ServiceTypeInvalid", "ServiceStatusInvalid", "ServiceDatesInvalids", "ServiceProviderNotFound", "ServiceCanNotCreate", "ServiceCanNotEdit", "ServiceNotFound", "CarLocationInvalidDriver", "ReturnPlaceIsCurrentPlaceError", "CarIsNotFree", "CarTransferError", "InvalidCarGasoline", "CannotDeliverBookingWithBalance", "PlaceDoesNotAcceptCustomAddresses", "PlaceCantOperatesLikePickUp", "PlaceCantOperatesLikeDropOff", "CannotPayQuote", "FeatureNotEnabled", "ModelNotValid", "Unknown", "MissingCurrencyCode", "TotalGreaterThanZero", "InfractionAlreadyExists", "InvalidIncidentType", "InvalidIncidentDate", "SettingNotFound", "BookingBrandNotFound", "BookingCannotBeUncancelled", "RateAlreadyExists", "DuplicateCustomerGlobalId", "AgencyNotConfigured", "Timeout", "MappingAlreadyExists", "ModelNotExists", "CompanyCodeNotFound", "CommercialAgreementNotSupported", "CommercialAgreementRequired", "InfractionNoticeNotFound", "InfractionNoticeDismissed", "InfractionNoticeContextMismatch", "InfractionNoticeMainAlreadyLinked", "InfractionNoticeNicAlreadyLinked", "InfractionNoticeInfractionAlreadyLinked", "PriceAgreementNotFound" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 80, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 499, 1100, 1101, 1102, 1103, 1104, 1105, 1106, 1107, 1108, 1109, 1110, 1111 ], "x-enumDescriptions": { "0": "No error occurred.", "1": "The requested customer was not found in the system.", "2": "The requested car was not found in the system.", "3": "The requested car is not available for the specified dates.", "4": "The calculated price does not match the expected price.", "5": "The customer data provided is not valid.", "6": "The requested language is not supported by the system.", "7": "The user does not have sufficient permissions to perform the operation.", "8": "No booking was found for the specified customer.", "9": "The current booking status does not allow cancellation.", "10": "The credit card is not available for use.", "11": "The requested payment gateway is not supported.", "12": "The requested infraction was not found.", "13": "The provided dates are invalid.", "14": "The reservation has not been quoted.", "15": "The maximum number of days for a quoted reservation has been exceeded.", "21": "The requested tariff was not found.", "22": "The requested booking was not found.", "23": "The specified return place was not found.", "24": "The requested promotion was not found.", "25": "The specified delivery place was not found.", "26": "The current booking status does not allow updates.", "27": "Unlimited kilometers option is not enabled.", "28": "Limited kilometers option is not enabled.", "29": "The minimum number of days for booking has not been reached.", "30": "The maximum number of days for booking has been exceeded.", "31": "The requested additional item was not found.", "32": "The maximum quantity for the additional item has been exceeded.", "33": "The start date for the booking is not enabled.", "34": "The driver's age is not within the allowed range.", "35": "There is a version mismatch with the booking.", "36": "The booking has already been delivered.", "37": "The booking has already been returned.", "38": "The booking requires a deposit to be completed.", "39": "The car's kilometers value is invalid.", "40": "The current booking status does not allow delivery.", "41": "The driver's license is invalid.", "42": "The current booking status does not allow return.", "43": "The notification's related entity was not found.", "44": "The notification receiver's address is invalid.", "45": "Mail notifications are disabled.", "46": "The return place is not allowed for the specified delivery place.", "47": "Booking outside of office hours is not allowed.", "48": "The requested notification was not found.", "49": "The customer is blocked from making bookings.", "50": "The system configuration requires at least one insurance to be selected when creating or editing a booking.", "51": "The commercial agreement is invalid.", "60": "The application protocol was not found.", "61": "The service type is invalid.", "62": "The service status is invalid.", "63": "The service dates are invalid.", "64": "The service provider was not found.", "65": "The service cannot be created.", "66": "The service cannot be edited.", "67": "The requested service was not found.", "68": "The car location has an invalid driver.", "69": "The return place is the same as the current place.", "70": "The car is not available for the requested operation.", "71": "An error occurred during car transfer.", "72": "The car's gasoline level is invalid.", "73": "Cannot deliver a booking with an outstanding balance.", "74": "The place does not accept custom addresses.", "75": "The place cannot operate as a pick-up location.", "76": "The place cannot operate as a drop-off location.", "77": "Cannot pay the quote.", "80": "The requested feature is not enabled.", "98": "The model is not valid.", "99": "An unknown error occurred.", "100": "The currency code is missing.", "101": "The total amount must be greater than zero.", "102": "The infraction act or violation already exists in the system.", "103": "The incident type is invalid", "104": "The incident date is invalid", "105": "A required setting was not found", "106": "Booking Brand not found", "107": "", "108": "A rate with the given code already exists and updates were not requested.", "109": "More than one active customer shares the same GlobalId, so the customer cannot be resolved unambiguously. Indicates a data-integrity problem (GlobalId must be unique).", "110": "A commercial agreement code was sent, but the external system user has no agency configured and no valid agency was sent in the booking, so the agreement cannot be applied.", "499": "", "1100": "", "1101": "", "1102": "", "1103": "The commercial agreement is not supported.", "1104": "", "1105": "The referenced InfractionNotice was not found for the tenant.", "1106": "The referenced InfractionNotice is dismissed and cannot be linked.", "1107": "The infraction context (car, date, booking or driver) does not match the InfractionNotice.", "1108": "The InfractionNotice already has a main infraction linked.", "1109": "The InfractionNotice already has a NIC (driver non-identification penalty) infraction linked.", "1110": "The infraction is already linked to a different InfractionNotice.", "1111": "The requested price agreement was not found." } }, "Booking": { "type": "object", "description": "Represents a car rental booking in the system.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "The unique identifier of the booking in the system", "format": "int32" }, "Version": { "type": "string", "description": "Version of the booking", "nullable": true }, "Customer": { "description": "The customer who made the booking, including their personal and contact information", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Customer" } ] }, "Balance": { "type": "number", "description": "The remaining amount to be paid for the booking", "format": "decimal" }, "TotalPayed": { "type": "number", "description": "The total amount that has been paid for the booking", "format": "decimal" }, "Extra": { "type": "string", "description": "Additional notes or special instructions for the booking", "nullable": true }, "Promotion": { "type": "integer", "description": "The identifier of any promotion applied to this booking", "format": "int32", "nullable": true }, "IsQuotation": { "type": "boolean", "description": "Indicates whether this is a price quotation rather than a confirmed booking" }, "Car": { "description": "The specific car being rented in this booking", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Car" } ] }, "Model": { "description": "The car model of the rented card", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Model" } ] }, "Category": { "description": "The category of the rented car (e.g., Economy, Luxury, SUV)", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CategoryBase" } ] }, "FromDate": { "type": "string", "description": "The local date and time when the rental period begins", "format": "date-time" }, "ToDate": { "type": "string", "description": "The local date and time when the rental period ends", "format": "date-time" }, "DeliveryPlace": { "description": "The location where the customer will pick up the vehicle", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Place" } ] }, "ReturnPlace": { "description": "The location where the customer will return the vehicle", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Place" } ] }, "TotalDaysString": { "type": "string", "description": "A formatted string representation of the total rental duration", "nullable": true }, "Price": { "type": "number", "description": "The total price of the booking before any discounts or promotions", "format": "decimal" }, "AgencyPrice": { "type": "number", "description": "The portion of the price to be paid by the travel agency", "format": "decimal" }, "CustomerPrice": { "type": "number", "description": "The portion of the price to be paid by the customer", "format": "decimal" }, "Currency": { "type": "string", "description": "The currency in which the booking was created", "nullable": true }, "Franchise": { "type": "number", "description": "The standard deposit amount required for the rental", "format": "decimal", "nullable": true }, "FranchiseDamage": { "type": "number", "description": "The deposit amount specifically for damage coverage", "format": "decimal", "nullable": true }, "FranchiseRollover": { "type": "number", "description": "The deposit amount specifically for rollover coverage", "format": "decimal", "nullable": true }, "FranchiseTheft": { "type": "number", "description": "The deposit amount specifically for theft coverage", "format": "decimal", "nullable": true }, "FranchiseHail": { "type": "number", "description": "The deposit amount specifically for hail damage coverage", "format": "decimal", "nullable": true }, "TotalDays": { "type": "number", "description": "The total duration of the rental in days (including partial days)", "format": "decimal" }, "IlimitedKm": { "type": "boolean", "description": "Indicates whether the rental includes unlimited mileage" }, "MaxAllowedDistance": { "type": "integer", "description": "The maximum allowed distance for the rental period", "format": "int32" }, "MaxAllowedDistanceByDay": { "type": "integer", "description": "The maximum allowed distance per day of rental", "format": "int32" }, "HasFranchiseModifiers": { "type": "boolean", "description": "Indicates if there are any modifications to the standard franchise amounts" }, "WillLeaveCountry": { "type": "boolean", "description": "Indicates whether the vehicle will be taken out of the country during the rental", "nullable": true }, "AverageDayPrice": { "type": "number", "description": "The average daily rate for the rental period", "format": "decimal" }, "PriceItems": { "type": "array", "description": "A detailed breakdown of all price components in the booking", "nullable": true, "items": { "$ref": "#/components/schemas/ItemPrice" } }, "Additionals": { "type": "array", "description": "Additional services or products included in the booking", "nullable": true, "items": { "$ref": "#/components/schemas/BookingAdditional" } }, "AvailablePromotions": { "type": "array", "description": "Gets or sets the list of available promotions with their pricing information.", "nullable": true, "items": { "$ref": "#/components/schemas/PromotionPriceItem" } }, "CurrentStatus": { "description": "The current status of the booking in the rental process", "oneOf": [ { "$ref": "#/components/schemas/BookingStatusEnum" } ] }, "CurrentStatusDate": { "type": "string", "description": "Date of the current status change", "format": "date-time" }, "DeliveryTransportationId": { "type": "string", "description": "The flight/bus/boat number for the customer's arrival", "nullable": true }, "ReturnTransportationId": { "type": "string", "description": "The flight/bus/boat number for the customer's departure", "nullable": true }, "IsCustomerOver25": { "type": "boolean", "description": "Indicates whether the customer is over 25 years old" }, "ExternalSystemId": { "type": "string", "description": "The booking identifier in an external reservation system", "nullable": true }, "PrepaidAmount": { "type": "number", "description": "The amount prepaid to the external system", "format": "decimal" }, "ElegibleSIPPCodeUpgrade": { "type": "string", "description": "The maximum SIPP code upgrade available at no additional cost", "nullable": true }, "Attributes": { "type": "object", "description": "Additional custom attributes associated with the booking", "nullable": true, "additionalProperties": { "type": "string" } }, "ExchangeRate": { "type": "number", "description": "The exchange rate used for currency conversion", "format": "decimal", "nullable": true }, "DailyRate": { "type": "number", "description": "The standard daily rate for the rental", "format": "decimal" }, "HourlyRate": { "type": "number", "description": "The hourly rate for the rental", "format": "decimal" }, "ExtraDayRate": { "type": "number", "description": "The rate for additional days beyond the standard rental period", "format": "decimal" }, "ExtraHourRate": { "type": "number", "description": "The rate for additional hours beyond the standard rental period", "format": "decimal" }, "RatePlan": { "type": "string", "description": "The specific rate plan applied to this booking", "nullable": true }, "IsOnRequest": { "type": "boolean", "description": "Indicates whether this is an on-request booking requiring special approval" }, "DeliveryInfo": { "description": "Information about the vehicle condition at delivery", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInfo" } ] }, "DropoffInfo": { "description": "Information about the vehicle condition at return", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInfo" } ] }, "Origin": { "description": "The source or origin of the booking", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BookingOrigin" } ] }, "CreationDate": { "type": "string", "description": "The date and time when the booking was created", "format": "date-time" }, "UpdatedOn": { "type": "string", "description": "The date and time when the booking (or any of its child lists) was last updated.", "format": "date-time", "nullable": true }, "UpdatedByUserName": { "type": "string", "description": "The user name of the user who performed the last update on the booking.", "nullable": true }, "PayedByAgency": { "type": "number", "description": "The total amount paid by the travel agency", "format": "decimal" }, "PayedByCustomer": { "type": "number", "description": "The total amount paid by the customer", "format": "decimal" }, "CommercialAgreementCode": { "type": "string", "description": "The code of the commercial agreement applied to this booking", "nullable": true }, "PurchaseOrder": { "type": "string", "description": "The purchase order number for agency or company bookings", "nullable": true }, "Brand": { "description": "The brand or company associated with the booking, identified by its Code or Id.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BookingBrand" } ] }, "SalesCommision": { "type": "number", "description": "The commission amount for agencies or external systems", "format": "decimal" }, "IsTransfer": { "type": "boolean", "description": "Indicates whether this is an internal transfer between company locations" }, "PriceDetails": { "description": "Detailed breakdown of prices and their allocation between customer and agency", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PriceDetails" } ] }, "Agency": { "description": "Agency associated with the booking", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Agency" } ] }, "IsSelfCheckin": { "type": "boolean", "description": "Indica si la reserva fue completada usando Self-Checkin" }, "Links": { "description": "Links associated with the booking", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BookingLinks" } ] }, "DistanceUnit": { "type": "string", "description": "The distance unit in which the booking was created", "nullable": true }, "Code": { "type": "string", "description": "Generated booking code", "nullable": true } } }, "Customer": { "type": "object", "description": "Represents a customer in the rental system.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the customer.", "format": "int32" }, "GlobalId": { "type": "string", "description": "Gets or sets the global unique identifier of the customer.", "format": "guid" }, "Name": { "type": "string", "description": "Gets or sets the full name of the customer.", "nullable": true }, "Lastname": { "type": "string", "description": "Gets or sets the last name of the customer.", "nullable": true }, "Firstname": { "type": "string", "description": "Gets or sets the first name of the customer.", "nullable": true }, "DocumentId": { "type": "string", "description": "Gets or sets the identification document number of the customer.", "nullable": true }, "DocumentTypeId": { "type": "integer", "description": "Gets or sets the type of identification document.", "format": "int32", "nullable": true }, "EmailAddress": { "type": "string", "description": "Gets or sets the email address of the customer.", "nullable": true }, "CellPhone": { "type": "string", "description": "Gets or sets the mobile phone number of the customer.", "nullable": true }, "Address": { "type": "string", "description": "Gets or sets the street address of the customer.", "nullable": true }, "AddressNumber": { "type": "string", "description": "Gets or sets the street number of the customer's address.", "nullable": true }, "AddressDepartment": { "type": "string", "description": "Gets or sets the apartment or department number of the customer's address.", "nullable": true }, "Country": { "type": "string", "description": "Gets or sets the country of the customer's nationality.", "nullable": true }, "BirthDate": { "type": "string", "description": "Gets or sets the birth date of the customer.", "format": "date-time", "nullable": true }, "CreditCards": { "type": "array", "description": "Gets or sets the list of credit cards associated with the customer.", "nullable": true, "items": { "$ref": "#/components/schemas/CreditCard" } }, "Memberships": { "type": "array", "description": "Gets or sets the list of memberships associated with the customer.", "nullable": true, "items": { "$ref": "#/components/schemas/CustomerMembership" } }, "Age": { "type": "integer", "description": "Gets or sets the age of the customer.", "format": "int32", "nullable": true }, "DriverLicenceNumber": { "type": "string", "description": "Gets or sets the driver's license number of the customer.", "nullable": true }, "DriverLicenceCountry": { "type": "string", "description": "Gets or sets the country that issued the driver's license.", "nullable": true }, "DriverLicenseExpiration": { "type": "string", "description": "Gets or sets the expiration date of the driver's license.", "format": "date-time", "nullable": true }, "DriverLicenseRenachNumber": { "type": "string", "description": "Gets or sets the RENACH number associated with the driver's license.", "nullable": true }, "DriverLicenseCategory": { "type": "string", "description": "Gets or sets the category of the driver's license.", "nullable": true }, "ZipCode": { "type": "string", "description": "Gets or sets the ZIP or postal code of the customer's address.", "nullable": true }, "FiscalConditionId": { "type": "integer", "description": "Gets or sets the fiscal condition identifier of the customer.", "format": "int32", "nullable": true }, "Notes": { "type": "string", "description": "Gets or sets any additional notes or comments about the customer.", "nullable": true }, "IsCompany": { "type": "boolean", "description": "Gets or sets a value indicating whether the customer is a company." }, "IsAgency": { "type": "boolean", "description": "Gets or sets a value indicating whether the customer is a travel agency." }, "IsProvider": { "type": "boolean", "description": "Gets or sets a value indicating whether the customer is a service provider." }, "IsHotel": { "type": "boolean", "description": "Gets or sets a value indicating whether the customer is a hotel." }, "City": { "type": "string", "description": "Gets or sets the city of the customer's address.", "nullable": true }, "State": { "type": "string", "description": "Gets or sets the state or province of the customer's address.", "nullable": true }, "Region": { "type": "string", "description": "Gets or sets the region of the customer's address.", "nullable": true }, "CommercialAgreements": { "type": "array", "description": "Gets or sets the list of commercial agreements associated with the customer.", "nullable": true, "items": { "type": "string" } }, "HasWebLogin": { "type": "boolean", "description": "Gets or sets a value indicating whether the customer has web login access." }, "IATACode": { "type": "string", "description": "Gets or sets the IATA code of the customer (if applicable).", "nullable": true }, "BirthCountry": { "type": "string", "description": "Gets or sets the country of birth of the customer.", "nullable": true }, "BirthState": { "type": "string", "description": "Gets or sets the state or province of birth of the customer.", "nullable": true }, "DriverLicenseIssuance": { "type": "string", "description": "Gets or sets the issuance date of the driver's license.", "format": "date-time", "nullable": true }, "DriverLicenseState": { "type": "string", "description": "Gets or sets the state or province that issued the driver's license.", "nullable": true }, "DocumentIdIssuance": { "type": "string", "description": "Gets or sets the issuance date of the identification document.", "format": "date-time", "nullable": true }, "DocumentIdExpiration": { "type": "string", "description": "Gets or sets the expiration date of the identification document.", "format": "date-time", "nullable": true }, "DocumentIdIssuanceState": { "type": "string", "description": "Gets or sets the state or province that issued the identification document.", "nullable": true }, "DocumentIdIssuanceCountry": { "type": "string", "description": "Gets or sets the country that issued the identification document.", "nullable": true }, "PersonalCode": { "type": "string", "description": "Gets or sets the personal code", "nullable": true }, "StateRegistration": { "type": "string", "description": "Gets or sets the state registration (Inscrição Estadual) for Brazilian legal entities.", "nullable": true }, "MunicipalRegistration": { "type": "string", "description": "Gets or sets the municipal registration (Inscrição Municipal) for Brazilian legal entities.", "nullable": true } } }, "CreditCard": { "type": "object", "description": "Represents a customer's credit card information.", "additionalProperties": false, "properties": { "Type": { "type": "string", "description": "Gets or sets the type of credit card (e.g., Visa, MasterCard, American Express).", "nullable": true }, "Number": { "type": "string", "description": "Gets or sets the credit card number.", "nullable": true }, "ExpirationMonth": { "type": "integer", "description": "Gets or sets the expiration month of the credit card.", "format": "int32" }, "ExpirationYear": { "type": "integer", "description": "Gets or sets the expiration year of the credit card.", "format": "int32" }, "SecurityCode": { "type": "string", "description": "Gets or sets the security code (CVV/CVC) of the credit card.", "nullable": true }, "CardHolderName": { "type": "string", "description": "Gets or sets the name of the cardholder as it appears on the credit card.", "nullable": true } } }, "CustomerMembership": { "type": "object", "description": "Represents a membership associated with a customer.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Identifica una membresia existente del cliente. Se ignora durante el alta.", "format": "int32", "nullable": true }, "MembershipType": { "description": "Gets or sets the type of membership.", "oneOf": [ { "$ref": "#/components/schemas/MembershipType" } ] }, "Description": { "type": "string", "description": "Gets or sets the description of the membership.", "nullable": true }, "Number": { "type": "string", "description": "Gets or sets the membership number or identifier.", "nullable": true }, "ExpirationDate": { "type": "string", "description": "Gets or sets the expiration date of the membership.", "format": "date-time", "nullable": true }, "UsedInBooking": { "type": "boolean", "description": "Gets or sets a value indicating whether this membership was used in a booking." }, "BookingBrandIds": { "type": "array", "description": "En updates, null conserva las marcas y una lista vacia elimina las restricciones. En altas, null equivale a una lista vacia.", "nullable": true, "items": { "type": "integer", "format": "int32" } } } }, "MembershipType": { "type": "integer", "description": "Specifies the types of memberships available in the system.\n\n| Value | Name | Description |\n| ---: | --- | --- |\n| 0 | `Other` | Represents a miscellaneous or unspecified membership type. |\n| 1 | `Company` | Represents a corporate or business membership. |\n| 2 | `Hotel` | Represents a hotel partnership membership. |\n| 3 | `FrequentTraveler` | Represents a frequent traveler or loyalty program membership. |\n", "x-enumNames": [ "Other", "Company", "Hotel", "FrequentTraveler" ], "enum": [ 0, 1, 2, 3 ], "x-enumDescriptions": { "0": "Represents a miscellaneous or unspecified membership type.", "1": "Represents a corporate or business membership.", "2": "Represents a hotel partnership membership.", "3": "Represents a frequent traveler or loyalty program membership." } }, "Car": { "type": "object", "description": "Represents a car in the rental system.", "additionalProperties": false, "properties": { "Id": { "type": "string", "description": "Gets or sets the unique identifier of the car.", "nullable": true }, "Model": { "description": "Gets or sets the model information of the vehicle.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Model" } ] }, "CurrentBranchOfficeId": { "type": "integer", "description": "Gets or sets the ID of the branch office where the car is currently located.", "format": "int32" }, "CurrentBranchOffice": { "type": "string", "description": "Gets or sets the name of the branch office where the car is currently located.", "nullable": true }, "BranchOfficeOwner": { "type": "string", "description": "Gets or sets the name of the branch office that owns the vehicle.", "nullable": true }, "CurrentKms": { "type": "integer", "description": "Gets or sets the current kilometers reading of the car.", "format": "int32" }, "FuelType": { "type": "string", "description": "Gets or sets the type of fuel used by the car.", "nullable": true }, "Gasoline": { "type": "integer", "description": "Gets or sets the current fuel level of the car.", "format": "int32" }, "FriendlyName": { "type": "string", "description": "Gets or sets the friendly name or nickname of the vehicle.", "nullable": true }, "CurrentPlateId": { "type": "string", "description": "Gets or sets the current license plate number of the vehicle.", "nullable": true }, "ChassisIdentification": { "type": "string", "description": "Gets or sets the chassis identification number (VIN) of the vehicle.", "nullable": true }, "CurrentPlate": { "description": "Gets or sets the current license plate information.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/LicensePlate" } ] }, "Color": { "type": "string", "description": "Gets or sets the color of the car.", "nullable": true }, "Year": { "type": "integer", "description": "Gets or sets the manufacturing year of the vehicle.", "format": "int32" }, "TollDeviceId": { "type": "string", "description": "Gets or sets the identifier of the toll device installed in the vehicle.", "nullable": true }, "BatteryNumber": { "type": "string", "description": "Gets or sets the battery serial number of the vehicle.", "nullable": true }, "CreationDate": { "type": "string", "description": "Date the car was added to the fleet", "format": "date-time" }, "InactiveDate": { "type": "string", "description": "Date the car is retired from the fleet", "format": "date-time", "nullable": true }, "LeasedToCompany": { "type": "string", "description": "Gets or sets Leased To Company", "nullable": true }, "SupplierFullName": { "type": "string", "description": "Gets or sets the full name of the supplier.", "nullable": true }, "LastReturnDate": { "type": "string", "description": "Gets or sets the date and time of the most recent return, or null if no returns have been made.", "format": "date-time", "nullable": true } } }, "Model": { "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "type": "object", "description": "Represents a detailed car model in the system", "additionalProperties": false, "properties": { "Description": { "type": "string", "description": "Gets or sets the detailed description of the car model", "nullable": true }, "ImagePath": { "type": "string", "description": "Gets or sets the absolute path to the model's image", "nullable": true }, "Franchise": { "type": "number", "description": "Gets or sets the standard deposit amount required for this model", "format": "decimal" }, "FranchiseDamage": { "type": "number", "description": "Gets or sets the deposit amount for damage coverage", "format": "decimal" }, "FranchiseRollover": { "type": "number", "description": "Gets or sets the deposit amount for rollover coverage", "format": "decimal" }, "FranchiseTheft": { "type": "number", "description": "Gets or sets the deposit amount for theft coverage", "format": "decimal" }, "FranchiseHail": { "type": "number", "description": "Gets or sets the deposit amount for hail damage coverage", "format": "decimal" }, "Brand": { "description": "Gets or sets the brand information for this model", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Brand" } ] }, "Doors": { "type": "integer", "description": "Gets or sets the number of doors in the vehicle", "format": "int32" }, "Passengers": { "type": "integer", "description": "Gets or sets the maximum number of passengers the vehicle can accommodate", "format": "int32" }, "BigLuggage": { "type": "integer", "description": "Gets or sets the number of large luggage items the vehicle can carry", "format": "int32" }, "SmallLuggage": { "type": "integer", "description": "Gets or sets the number of small luggage items the vehicle can carry", "format": "int32" }, "Steering": { "type": "string", "description": "Gets or sets the type of steering system", "nullable": true }, "SteeringType": { "description": "Gets or sets the normalized steering type enum", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SteeringType" } ] }, "Gearbox": { "type": "string", "description": "Gets or sets the type of gearbox/transmission", "nullable": true }, "TransmissionType": { "description": "Gets or sets the normalized transmission type enum", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TransmissionType" } ] }, "Multimedia": { "type": "string", "description": "Gets or sets the type of multimedia system", "nullable": true }, "AirConditioner": { "type": "string", "description": "Gets or sets the type of air conditioning system", "nullable": true }, "AirConditionerType": { "description": "Gets or sets the normalized air conditioner type enum", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AirConditionerType" } ] }, "FuelType": { "description": "Gets or sets the fuel type of the model", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FuelTypeEnum" } ] }, "DailyPrice": { "type": "number", "description": "Gets or sets the daily rental price for a 2-day rental without promotions", "format": "decimal" }, "ModelAttributes": { "type": "array", "description": "Gets or sets the customizable attributes of the model", "nullable": true, "items": { "$ref": "#/components/schemas/ModelAttribute" } }, "LowerPrice": { "type": "number", "description": "Gets or sets the lowest price in the tariff without considering distance or cuts", "format": "decimal" } } } ] }, "Brand": { "type": "object", "description": "Represents a vehicle manufacturer brand.", "additionalProperties": false, "properties": { "Name": { "type": "string", "description": "Gets or sets the name of the vehicle manufacturer brand.", "nullable": true } } }, "SteeringType": { "type": "integer", "description": "\n\n| Value | Name | Description |\n| ---: | --- | --- |\n| 1 | `RackAndPinion` | — |\n| 2 | `RecirculatingBall` | — |\n| 3 | `HydraulicPower` | — |\n| 4 | `ElectricPower` | — |\n| 5 | `ElectroHydraulicPower` | — |\n", "x-enumNames": [ "RackAndPinion", "RecirculatingBall", "HydraulicPower", "ElectricPower", "ElectroHydraulicPower" ], "enum": [ 1, 2, 3, 4, 5 ], "x-enumDescriptions": { "1": "", "2": "", "3": "", "4": "", "5": "" } }, "TransmissionType": { "type": "integer", "description": "\n\n| Value | Name | Description |\n| ---: | --- | --- |\n| 1 | `Manual` | — |\n| 2 | `Automatic` | — |\n", "x-enumNames": [ "Manual", "Automatic" ], "enum": [ 1, 2 ], "x-enumDescriptions": { "1": "", "2": "" } }, "AirConditionerType": { "type": "integer", "description": "\n\n| Value | Name | Description |\n| ---: | --- | --- |\n| 1 | `Yes` | — |\n| 2 | `No` | — |\n", "x-enumNames": [ "Yes", "No" ], "enum": [ 1, 2 ], "x-enumDescriptions": { "1": "", "2": "" } }, "FuelTypeEnum": { "type": "integer", "description": "\n\n| Value | Name | Description |\n| ---: | --- | --- |\n| 0 | `Gasoline` | — |\n| 1 | `Diesel` | — |\n| 2 | `Electric` | — |\n| 3 | `Hybrid` | — |\n| 4 | `Alcohol` | — |\n| 5 | `Gas` | — |\n| 6 | `Bencina` | — |\n| 7 | `CngAlcoholElectric` | — |\n| 8 | `AlcoholGasoline` | — |\n| 9 | `AlcoholGasolineCng` | — |\n| 10 | `GasolineElectric` | — |\n| 11 | `GasolineCng` | — |\n", "x-enumNames": [ "Gasoline", "Diesel", "Electric", "Hybrid", "Alcohol", "Gas", "Bencina", "CngAlcoholElectric", "AlcoholGasoline", "AlcoholGasolineCng", "GasolineElectric", "GasolineCng" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ], "x-enumDescriptions": { "0": "", "1": "", "2": "", "3": "", "4": "", "5": "", "6": "", "7": "", "8": "", "9": "", "10": "", "11": "" } }, "ModelAttribute": { "type": "object", "additionalProperties": false, "required": [ "Name", "Description", "Type", "Unit", "Value", "ModelId" ], "properties": { "Id": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "minLength": 1 }, "Description": { "type": "string", "minLength": 1 }, "Type": { "$ref": "#/components/schemas/ModelAttributeTypeEnum" }, "Unit": { "type": "string", "minLength": 1 }, "Value": { "type": "string", "minLength": 1 }, "ModelId": { "type": "integer", "format": "int32" } } }, "ModelAttributeTypeEnum": { "type": "integer", "description": "\n\n| Value | Name | Description |\n| ---: | --- | --- |\n| 0 | `Text` | — |\n| 1 | `Number` | — |\n| 2 | `Boolean` | — |\n| 3 | `Date` | — |\n", "x-enumNames": [ "Text", "Number", "Boolean", "Date" ], "enum": [ 0, 1, 2, 3 ], "x-enumDescriptions": { "0": "", "1": "", "2": "", "3": "" } }, "ModelBase": { "type": "object", "description": "Base class representing a car model in the system", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the car model", "format": "int32" }, "Name": { "type": "string", "description": "Gets or sets the name of the car model", "nullable": true }, "Category": { "description": "Gets or sets the category to which this model belongs", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CategoryBase" } ] }, "SIPP": { "type": "string", "description": "Gets or sets the SIPP (Standard International Passenger Protection) code for the model", "nullable": true } } }, "CategoryBase": { "type": "object", "description": "Represents a base class for vehicle categories in the system.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the vehicle category.", "format": "int32" }, "Name": { "type": "string", "description": "Gets or sets the name of the vehicle category.", "nullable": true }, "Order": { "type": "number", "description": "Gets or sets the display order of the category in lists and menus.", "format": "decimal" }, "PrincipalModelId": { "type": "integer", "description": "Gets or sets the identifier of the principal model representing this category.", "format": "int32", "nullable": true }, "Franchise": { "type": "number", "description": "Gets or sets the base deposit amount required for vehicles in this category.", "format": "decimal" }, "FranchiseDamage": { "type": "number", "description": "Gets or sets the deposit amount for damage coverage in this category.", "format": "decimal" }, "FranchiseRollover": { "type": "number", "description": "Gets or sets the deposit amount for rollover coverage in this category.", "format": "decimal" }, "FranchiseTheft": { "type": "number", "description": "Gets or sets the deposit amount for theft coverage in this category.", "format": "decimal" }, "FranchiseHail": { "type": "number", "description": "Gets or sets the deposit amount for hail damage coverage in this category.", "format": "decimal" }, "ImagePath": { "type": "string", "description": "Gets or sets the absolute path to the image representing this category.", "nullable": true } } }, "LicensePlate": { "type": "object", "description": "Represents a license plate in the system.", "additionalProperties": false, "properties": { "Id": { "type": "string", "description": "Gets or sets the license plate number.", "nullable": true }, "IssuingCountry": { "type": "string", "description": "Gets or sets the country that issued the license plate.", "nullable": true }, "IssuingState": { "type": "string", "description": "Gets or sets the state or province that issued the license plate.", "nullable": true } } }, "Place": { "allOf": [ { "$ref": "#/components/schemas/PlaceId" }, { "type": "object", "description": "Represents a pickup or dropoff location in the system.", "additionalProperties": false, "properties": { "Price": { "type": "number", "description": "Gets or sets the price associated with using this pickup/dropoff location.", "format": "decimal" }, "Name": { "type": "string", "description": "Gets or sets the friendly name of the pickup/dropoff location.", "nullable": true }, "Category": { "type": "string", "description": "Gets or sets the category or type of the pickup/dropoff location.", "nullable": true }, "Address": { "type": "string", "description": "Gets or sets the street address of the pickup/dropoff location.", "nullable": true }, "City": { "type": "string", "description": "Gets or sets the city where the pickup/dropoff location is situated.", "nullable": true }, "Country": { "type": "string", "description": "Gets or sets the country where the pickup/dropoff location is situated.", "nullable": true }, "BranchOfficeId": { "type": "integer", "description": "Gets or sets the unique identifier of the branch office managing this location.", "format": "int32" }, "BranchOfficeName": { "type": "string", "description": "Gets or sets the name of the branch office managing this location.", "nullable": true }, "BranchOfficeIATACode": { "type": "string", "description": "Gets or sets the IATA code of the branch office managing this location.", "nullable": true }, "IsFranchise": { "type": "boolean", "description": "Indicates if the pickup/dropoff location is part of a franchise or owned." }, "Latitude": { "type": "number", "description": "Gets or sets the latitude coordinate of the pickup/dropoff location.", "format": "decimal" }, "Longitude": { "type": "number", "description": "Gets or sets the longitude coordinate of the pickup/dropoff location.", "format": "decimal" }, "CanAddCustomAddress": { "type": "boolean", "description": "Gets or sets a value indicating whether custom addresses can be added to this location." }, "IsCustomAddress": { "type": "boolean", "description": "Gets or sets a value indicating whether this is a custom address location." }, "AvailableOperationOptions": { "type": "string", "description": "Gets or sets the available operation options for this location.", "nullable": true }, "AvailableReturnPlaces": { "type": "array", "description": "Gets or sets the list of location IDs where vehicles can be returned.", "nullable": true, "items": { "type": "integer", "format": "int32" } }, "AvailableBrandCodes": { "type": "array", "description": "Gets or sets the list of booking brand codes that operate at this location.\nWhen empty, the location operates with all active brands.", "nullable": true, "items": { "type": "string" } } } } ] }, "PlaceId": { "type": "object", "description": "Identifies a pickup/dropoff location by its unique identifier.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the pickup/dropoff location.", "format": "int32" } } }, "ItemPrice": { "type": "object", "description": "Represents a price item in a booking.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the price item. Set to 0 if not yet saved.", "format": "int32" }, "IsBookingPrice": { "type": "boolean", "description": "Gets or sets a value indicating whether this item represents the base booking price." }, "Description": { "type": "string", "description": "Gets or sets the description of the price item.", "nullable": true }, "Price": { "type": "number", "description": "Gets or sets the total price of the item.", "format": "decimal" }, "Type": { "description": "Gets or sets the type of entity this price item is associated with.", "oneOf": [ { "$ref": "#/components/schemas/ItemPriceTypeEnum" } ] }, "TypeId": { "type": "integer", "description": "Gets or sets the identifier of the related entity.", "format": "int32" }, "UnitPrice": { "type": "number", "description": "Gets or sets the unit price of the item.", "format": "decimal" }, "Quantity": { "type": "integer", "description": "Gets or sets the quantity of the item (can be days, hours, or other units).", "format": "int32" }, "Payer": { "description": "Gets or sets the type of payer responsible for this item.", "oneOf": [ { "$ref": "#/components/schemas/PayerType" } ] }, "TariffName": { "type": "string", "description": "Name of the applied rate", "nullable": true }, "AppliedCoverageBrackets": { "type": "array", "description": "The VDR coverage brackets applied to this rental line, as ranges of rental days.\nOnly lines billed per day declare them, and it is absent when the line was not priced by coverage brackets.", "nullable": true, "items": { "$ref": "#/components/schemas/AppliedCoverageBracket" } } } }, "ItemPriceTypeEnum": { "type": "integer", "description": "Represents the different types of price items in the system.\n\n| Value | Name | Description |\n| ---: | --- | --- |\n| 0 | `Booking` | Base booking price. |\n| 1 | `Additional` | Additional services or products. |\n| 2 | `Promotion` | Promotional discounts or offers. |\n| 3 | `Delivery` | Delivery charges. |\n| 4 | `Discount` | Discount applied to the investor's portion. |\n| 5 | `Expense` | General expenses. |\n| 6 | `ExpensePayment` | Payment for expenses. |\n| 7 | `ManualDiscount` | Manual discounts applied to the booking. Deducted from the investor's portion. |\n| 8 | `ManualPrice` | Manually set price. |\n| 9 | `ServiceBonus` | Service bonuses for late arrivals, extra kilometers, and fuel. Not deducted from the investor's portion. |\n| 10 | `OneWayDropOff` | One-way drop-off charges between different locations. |\n| 11 | `Return` | Return-related charges. |\n| 12 | `AdditionalKm` | Charges for additional kilometers driven. |\n| 13 | `Gasoline` | Charges for fuel shortage. |\n| 14 | `LateReturn` | Charges for late return. |\n| 15 | `Tax` | Tax charges. |\n| 16 | `Insurance` | Insurance charges. |\n| 17 | `Commission` | Commission discount for agencies (only applicable for commission-based billing). |\n| 18 | `Toll` | Toll charges. |\n| 19 | `FranchiseDamage` | Damage franchise charges. |\n| 20 | `AdministrativeFeeForCancellation` | No-show administrative fee. |\n| 21 | `Rounding` | Rounding adjustments. |\n", "x-enumNames": [ "Booking", "Additional", "Promotion", "Delivery", "Discount", "Expense", "ExpensePayment", "ManualDiscount", "ManualPrice", "ServiceBonus", "OneWayDropOff", "Return", "AdditionalKm", "Gasoline", "LateReturn", "Tax", "Insurance", "Commission", "Toll", "FranchiseDamage", "AdministrativeFeeForCancellation", "Rounding" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21 ], "x-enumDescriptions": { "0": "Base booking price.", "1": "Additional services or products.", "2": "Promotional discounts or offers.", "3": "Delivery charges.", "4": "Discount applied to the investor's portion.", "5": "General expenses.", "6": "Payment for expenses.", "7": "Manual discounts applied to the booking. Deducted from the investor's portion.", "8": "Manually set price.", "9": "Service bonuses for late arrivals, extra kilometers, and fuel. Not deducted from the investor's portion.", "10": "One-way drop-off charges between different locations.", "11": "Return-related charges.", "12": "Charges for additional kilometers driven.", "13": "Charges for fuel shortage.", "14": "Charges for late return.", "15": "Tax charges.", "16": "Insurance charges.", "17": "Commission discount for agencies (only applicable for commission-based billing).", "18": "Toll charges.", "19": "Damage franchise charges.", "20": "No-show administrative fee.", "21": "Rounding adjustments." } }, "PayerType": { "type": "integer", "description": "Represents the type of payer for a price item.\n\n| Value | Name | Description |\n| ---: | --- | --- |\n| 0 | `Customer` | The customer is responsible for payment. |\n| 1 | `Agency` | An agency, hotel, broker, or other third party is responsible for payment. |\n", "x-enumNames": [ "Customer", "Agency" ], "enum": [ 0, 1 ], "x-enumDescriptions": { "0": "The customer is responsible for payment.", "1": "An agency, hotel, broker, or other third party is responsible for payment." } }, "AppliedCoverageBracket": { "type": "object", "description": "Represents one range of rental days of a price line that a single VDR coverage bracket of the commercial\nagreement priced.", "additionalProperties": false, "properties": { "DaysFrom": { "type": "integer", "description": "The inclusive, 1-based first rental day covered by this range. The first day of the rental is 1.", "format": "int32" }, "DaysTo": { "type": "integer", "description": "The inclusive, 1-based last rental day covered by this range.", "format": "int32" }, "Amount": { "type": "number", "description": "The part of the line's Price that belongs to this range, paid by the payer of the line.", "format": "decimal" } } }, "BookingAdditional": { "type": "object", "description": "Represents an additional service or product associated with a booking.", "additionalProperties": false, "properties": { "Additional": { "description": "Gets or sets the additional service or product details.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Additional" } ] }, "Quantity": { "type": "integer", "description": "Gets or sets the quantity of the additional item requested.", "format": "int32" } } }, "Additional": { "allOf": [ { "$ref": "#/components/schemas/AdditionalBase" }, { "type": "object", "description": "Represents an additional service or product that can be added to a booking.", "additionalProperties": false, "properties": { "Name": { "type": "string", "description": "Gets or sets the name of the additional item.", "nullable": true }, "Description": { "type": "string", "description": "Gets or sets the detailed description of the additional item.", "nullable": true }, "ImagePath": { "type": "string", "description": "Gets or sets the absolute path to the image representing the additional item.", "nullable": true }, "IsPriceByDay": { "type": "boolean", "description": "Gets or sets a value indicating whether the price is calculated per day or per booking." }, "Price": { "type": "number", "description": "Gets or sets the base price of the additional item.", "format": "decimal" }, "MaxQuantityPerBooking": { "type": "integer", "description": "Gets or sets the maximum quantity of this additional item that can be selected per booking.", "format": "int32" }, "Type": { "type": "string", "description": "Gets or sets the category or type of the additional item.", "nullable": true }, "Stock": { "type": "integer", "description": "Gets or sets the current available stock of the additional item.", "format": "int32" }, "Order": { "type": "number", "description": "Gets or sets the display order of the additional item in the list.", "format": "decimal" } } } ] }, "AdditionalBase": { "type": "object", "description": "Base class for additional items, providing common properties.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the additional item.", "format": "int32" } } }, "PromotionPriceItem": { "type": "object", "description": "Represents a promotional price item with detailed pricing information.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the promotion.", "format": "int32" }, "Name": { "type": "string", "description": "Gets or sets the display name of the promotion.", "nullable": true }, "Description": { "type": "string", "description": "Gets or sets the detailed description of the promotion.", "nullable": true }, "ImagePath": { "type": "string", "description": "Gets or sets the absolute path to the promotion's image.", "nullable": true }, "Order": { "type": "number", "description": "Gets or sets the display order of the promotion.", "format": "decimal" }, "DiscountPrice": { "type": "number", "description": "Gets or sets the amount to be discounted from the booking price.", "format": "decimal" }, "Type": { "description": "Gets or sets the type of discount applied by the promotion.", "oneOf": [ { "$ref": "#/components/schemas/PromotionType" } ] }, "Discount": { "type": "number", "description": "Gets or sets the discount value configured in the promotion: a percentage for Percentage, a number of days\nfor Days, or an amount in the booking currency for FixedAmount.", "format": "decimal" }, "DiscountPercentage": { "type": "number", "description": "Gets or sets the discount as a percentage of the items the promotion applies to: the rental rate and, when\nthe promotion also discounts additionals, those additionals. It excludes taxes and already applies the\nmaximum discount, so it can be lower than the configured percentage. It is null when those items add up to\nzero.", "format": "decimal", "nullable": true }, "BookingFinalPrice": { "type": "number", "description": "Gets or sets the final booking price after applying the promotional discount.", "format": "decimal" }, "PriceWithoutTaxes": { "type": "number", "description": "Gets or sets the final booking price after applying the promotional discount, excluding taxes.", "format": "decimal" }, "ValidForPayment": { "description": "Gets or sets the valid payment type for the promotion.", "oneOf": [ { "$ref": "#/components/schemas/ValidPaymentTypeEnum" } ] }, "PriceDetails": { "description": "Gets or sets the detailed price breakdown between customer and agency.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PriceDetails" } ] } } }, "PromotionType": { "type": "integer", "description": "Type of discount applied by a promotion.\n\n| Value | Name | Description |\n| ---: | --- | --- |\n| 0 | `FixedAmount` | A fixed amount discounted from the booking price. |\n| 1 | `Percentage` | A percentage of the rental rate. |\n| 2 | `Days` | A number of rental days. |\n", "x-enumNames": [ "FixedAmount", "Percentage", "Days" ], "enum": [ 0, 1, 2 ], "x-enumDescriptions": { "0": "A fixed amount discounted from the booking price.", "1": "A percentage of the rental rate.", "2": "A number of rental days." } }, "ValidPaymentTypeEnum": { "type": "integer", "description": "Enumeration for valid payment types where a promotion can be applied.\n\n| Value | Name | Description |\n| ---: | --- | --- |\n| 0 | `Both` | Promotion can be used both at the counter and online |\n| 1 | `Counter` | Promotion can only be used at the rental counter |\n| 2 | `Online` | Promotion can only be used for online bookings |\n", "x-enumNames": [ "Both", "Counter", "Online" ], "enum": [ 0, 1, 2 ], "x-enumDescriptions": { "0": "Promotion can be used both at the counter and online", "1": "Promotion can only be used at the rental counter", "2": "Promotion can only be used for online bookings" } }, "PriceDetails": { "type": "object", "description": "Represents detailed pricing information for a rental transaction.", "additionalProperties": false, "properties": { "Price": { "type": "number", "description": "Gets or sets the base price of the rental.", "format": "decimal" }, "CustomerPrice": { "type": "number", "description": "Gets or sets the final price charged to the customer, including any applicable fees or taxes.", "format": "decimal" }, "AgencyPrice": { "type": "number", "description": "Gets or sets the price charged to the agency when the booking is made through an agency.", "format": "decimal" }, "SalesCommission": { "type": "number", "description": "Gets or sets the commission amount for the sales agent or channel.", "format": "decimal" }, "Currency": { "type": "string", "description": "Gets or sets the currency code for all monetary values in this price details object.", "nullable": true } } }, "BookingStatusEnum": { "type": "integer", "description": "Represents the possible statuses of a booking in the system.\n\n| Value | Name | Description |\n| ---: | --- | --- |\n| 0 | `Reserved` | The booking has been reserved but not yet confirmed. |\n| 1 | `Confirmed` | The booking has been confirmed and is awaiting delivery. |\n| 2 | `Delivered` | The vehicle has been delivered to the customer. |\n| 3 | `Closed` | The booking has been completed and closed. |\n| 4 | `Canceled` | The booking has been canceled. |\n| 5 | `Quoted` | The booking is in quotation status, not yet confirmed. |\n", "x-enumNames": [ "Reserved", "Confirmed", "Delivered", "Closed", "Canceled", "Quoted" ], "enum": [ 0, 1, 2, 3, 4, 5 ], "x-enumDescriptions": { "0": "The booking has been reserved but not yet confirmed.", "1": "The booking has been confirmed and is awaiting delivery.", "2": "The vehicle has been delivered to the customer.", "3": "The booking has been completed and closed.", "4": "The booking has been canceled.", "5": "The booking is in quotation status, not yet confirmed." } }, "CheckInfo": { "type": "object", "description": "Contains information about the vehicle condition at delivery or return", "additionalProperties": false, "properties": { "Kms": { "type": "integer", "description": "The odometer reading in kilometers", "format": "int32" }, "Gasoline": { "type": "integer", "description": "The fuel level percentage", "format": "int32" }, "Verificator": { "type": "string", "description": "The name of the person who performed the check", "nullable": true }, "Date": { "type": "string", "description": "The date and time when the check was performed", "format": "date-time" } } }, "BookingOrigin": { "type": "object", "description": "Represents the source or origin of a booking", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "The unique identifier of the booking origin", "format": "int32" }, "Name": { "type": "string", "description": "The name or description of the booking origin", "nullable": true } } }, "BookingBrand": { "type": "object", "description": "Represents a brand associated with a booking in the system.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the brand.", "format": "int32" }, "Name": { "type": "string", "description": "Gets or sets the display name of the brand.", "nullable": true }, "Code": { "type": "string", "description": "Gets or sets the unique code identifier for the brand.", "nullable": true }, "LogoImageUrl": { "type": "string", "description": "Gets or sets the LogoImageUrl for the brand", "nullable": true }, "PrimaryColor": { "type": "string", "description": "Gets or sets the primary color of the brand, in CSS notation: hexadecimal (#RGB, #RRGGBB or\n#RRGGBBAA) or functional (rgb(...) / rgba(...)).", "nullable": true }, "SecondaryColor": { "type": "string", "description": "Gets or sets the secondary color of the brand, in CSS notation: hexadecimal (#RGB, #RRGGBB or\n#RRGGBBAA) or functional (rgb(...) / rgba(...)).", "nullable": true } } }, "Agency": { "type": "object", "description": " ", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Agency ID", "format": "int32" }, "IATACode": { "type": "string", "description": "Ageancy IATA code", "nullable": true }, "Name": { "type": "string", "description": "Agency Name", "nullable": true }, "GlobalId": { "type": "string", "description": "Globa Id of the agency", "nullable": true } } }, "BookingLinks": { "type": "object", "description": " ", "additionalProperties": false, "properties": { "Payment": { "type": "string", "description": "Booking payment link", "nullable": true }, "Voucher": { "type": "string", "description": "Booking voucher link", "nullable": true }, "Cancel": { "type": "string", "description": "Booking cancel link", "nullable": true } } }, "SelfCheckinUpdateBookingModel": { "type": "object", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Identificador de la reserva a actualizar", "format": "int32" }, "Customer": { "description": "Datos actualizados del cliente", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Customer" } ] }, "Driver": { "description": "Datos actualizados del conductor (driver)", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Customer" } ] }, "Extra": { "type": "string", "description": "Información extra de la reserva", "nullable": true }, "Additionals": { "type": "array", "description": "Lista de adicionales de la reserva", "nullable": true, "items": { "$ref": "#/components/schemas/BookingAdditionalBase" } } } }, "BookingAdditionalBase": { "type": "object", "description": "Represents the base class for additional services or products in a booking.", "additionalProperties": false, "properties": { "Additional": { "description": "Gets or sets the base information about the additional service or product.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AdditionalBase" } ] }, "Quantity": { "type": "integer", "description": "Gets or sets the quantity of the additional item requested.", "format": "int32" } } }, "PagedResultOfBookingDescription": { "type": "object", "description": "Represents a paginated result set of items.", "additionalProperties": false, "properties": { "Offset": { "type": "integer", "description": "Gets or sets the starting index of the current page of results.", "format": "int32" }, "Limit": { "type": "integer", "description": "Gets or sets the maximum number of items to return per page.", "format": "int32" }, "Total": { "type": "integer", "description": "Gets or sets the total number of items available across all pages.", "format": "int32" }, "Results": { "type": "array", "description": "Gets or sets the list of items in the current page.", "nullable": true, "items": { "$ref": "#/components/schemas/BookingDescription" } }, "NextOffset": { "type": "integer", "description": "Gets the next offset to call.", "format": "int32" } } }, "BookingDescription": { "type": "object", "description": "Represents a car rental booking in the system.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "The unique identifier of the booking in the system", "format": "int32" }, "Version": { "type": "string", "description": "Version of the booking", "nullable": true }, "Customer": { "description": "The customer who made the booking, including their personal and contact information", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CustomerDescription" } ] }, "Balance": { "type": "number", "description": "The remaining amount to be paid for the booking", "format": "decimal" }, "IsFullBonus": { "type": "boolean", "description": "Indica si la reserva está bonificada completamente para devolver 0 al consultar Balance, BalanceClient o BalanceAgency()" }, "FeeNoShow": { "type": "number", "description": "Representa el precio del item del tipo ItemPriceTypeEnum.AdministrativeFeeForCancellation para acortar la query en el public decimal Balance", "format": "decimal" }, "TotalPayed": { "type": "number", "description": "The total amount that has been paid for the booking", "format": "decimal" }, "Extra": { "type": "string", "description": "Additional notes or special instructions for the booking", "nullable": true }, "Promotion": { "type": "integer", "description": "The identifier of any promotion applied to this booking", "format": "int32", "nullable": true }, "IsQuotation": { "type": "boolean", "description": "Indicates whether this is a price quotation rather than a confirmed booking" }, "Car": { "description": "The specific car being rented in this booking", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CarDescription" } ] }, "Model": { "description": "The car model of the rented card", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ModelDescription" } ] }, "Category": { "description": "The category of the rented car (e.g., Economy, Luxury, SUV)", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CategoryDescription" } ] }, "FromDate": { "type": "string", "description": "The local date and time when the rental period begins", "format": "date-time" }, "ToDate": { "type": "string", "description": "The local date and time when the rental period ends", "format": "date-time" }, "DeliveryPlaceId": { "type": "integer", "description": "The identifier of the location where the customer will pick up the vehicle", "format": "int32" }, "ReturnPlaceId": { "type": "integer", "description": "The identifier of the location where the customer will return the vehicle", "format": "int32" }, "Price": { "type": "number", "description": "The total price of the booking before any discounts or promotions", "format": "decimal" }, "AgencyPrice": { "type": "number", "description": "The portion of the price to be paid by the travel agency", "format": "decimal" }, "CustomerPrice": { "type": "number", "description": "The portion of the price to be paid by the customer", "format": "decimal" }, "Currency": { "type": "string", "description": "The currency in which the booking was created", "nullable": true }, "Franchise": { "type": "number", "description": "The standard deposit amount required for the rental", "format": "decimal", "nullable": true }, "FranchiseDamage": { "type": "number", "description": "The deposit amount specifically for damage coverage", "format": "decimal", "nullable": true }, "FranchiseRollover": { "type": "number", "description": "The deposit amount specifically for rollover coverage", "format": "decimal", "nullable": true }, "FranchiseTheft": { "type": "number", "description": "The deposit amount specifically for theft coverage", "format": "decimal", "nullable": true }, "FranchiseHail": { "type": "number", "description": "The deposit amount specifically for hail damage coverage", "format": "decimal", "nullable": true }, "TotalDays": { "type": "number", "description": "The total duration of the rental in days (including partial days)", "format": "decimal" }, "IlimitedKm": { "type": "boolean", "description": "Indicates whether the rental includes unlimited mileage" }, "MaxAllowedDistance": { "type": "integer", "description": "The maximum allowed distance for the rental period", "format": "int32" }, "MaxAllowedDistanceByDay": { "type": "integer", "description": "The maximum allowed distance per day of rental", "format": "int32" }, "WillLeaveCountry": { "type": "boolean", "description": "Indicates whether the vehicle will be taken out of the country during the rental", "nullable": true }, "AverageDayPrice": { "type": "number", "description": "The average daily rate for the rental period", "format": "decimal" }, "Additionals": { "type": "array", "description": "Additional services or products included in the booking", "nullable": true, "items": { "$ref": "#/components/schemas/BookingAdditionalDescription" } }, "CurrentStatus": { "description": "The current status of the booking in the rental process", "oneOf": [ { "$ref": "#/components/schemas/BookingStatusEnum" } ] }, "CurrentStatusDate": { "type": "string", "description": "Date of the current status change", "format": "date-time" }, "DeliveryTransportationId": { "type": "string", "description": "The flight/bus/boat number for the customer's arrival", "nullable": true }, "ReturnTransportationId": { "type": "string", "description": "The flight/bus/boat number for the customer's departure", "nullable": true }, "IsCustomerOver25": { "type": "boolean", "description": "Indicates whether the customer is over 25 years old" }, "ExternalSystemId": { "type": "string", "description": "The booking identifier in an external reservation system", "nullable": true }, "PrepaidAmount": { "type": "number", "description": "The amount prepaid to the external system", "format": "decimal" }, "ElegibleSIPPCodeUpgrade": { "type": "string", "description": "The maximum SIPP code upgrade available at no additional cost", "nullable": true }, "ExchangeRate": { "type": "number", "description": "The exchange rate used for currency conversion", "format": "decimal", "nullable": true }, "DailyRate": { "type": "number", "description": "The standard daily rate for the rental", "format": "decimal" }, "HourlyRate": { "type": "number", "description": "The hourly rate for the rental", "format": "decimal" }, "ExtraDayRate": { "type": "number", "description": "The rate for additional days beyond the standard rental period", "format": "decimal" }, "ExtraHourRate": { "type": "number", "description": "The rate for additional hours beyond the standard rental period", "format": "decimal" }, "RatePlan": { "type": "string", "description": "The specific rate plan applied to this booking", "nullable": true }, "IsOnRequest": { "type": "boolean", "description": "Indicates whether this is an on-request booking requiring special approval" }, "DeliveryInfo": { "description": "Information about the vehicle condition at delivery", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInfo" } ] }, "DropoffInfo": { "description": "Information about the vehicle condition at return", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CheckInfo" } ] }, "Origin": { "description": "The source or origin of the booking", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BookingOrigin" } ] }, "CreationDate": { "type": "string", "description": "The date and time when the booking was created", "format": "date-time" }, "PayedByAgency": { "type": "number", "description": "The total amount paid by the travel agency", "format": "decimal" }, "PayedByCustomer": { "type": "number", "description": "The total amount paid by the customer", "format": "decimal" }, "CommercialAgreementCode": { "type": "string", "description": "The code of the commercial agreement applied to this booking", "nullable": true }, "PurchaseOrder": { "type": "string", "description": "The purchase order number for agency or company bookings", "nullable": true }, "Brand": { "description": "The brand or company associated with the booking", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BookingBrand" } ] }, "SalesCommision": { "type": "number", "description": "The commission amount for agencies or external systems", "format": "decimal" }, "IsTransfer": { "type": "boolean", "description": "Indicates whether this is an internal transfer between company locations" }, "PriceDetails": { "description": "Detailed breakdown of prices and their allocation between customer and agency", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PriceDetails" } ] }, "Agency": { "description": "Agency associated with the booking", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Agency" } ] }, "IsSelfCheckin": { "type": "boolean", "description": "Indica si la reserva fue completada usando Self-Checkin" }, "Code": { "type": "string", "description": "Generated booking code", "nullable": true }, "UpdatedOn": { "type": "string", "description": "Timestamp of the last modification to the booking. Null for bookings that\npredate the audit fields and never received the backfill.", "format": "date-time", "nullable": true }, "UpdatedByUserName": { "type": "string", "description": "Username of the operator who performed the last modification. Null when\nthe user is unknown (anonymous flow or pre-audit booking).", "nullable": true } } }, "CustomerDescription": { "type": "object", "description": " ", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the customer.", "format": "int32" }, "GlobalId": { "type": "string", "description": "Gets or sets the global unique identifier of the customer.", "format": "guid" }, "Name": { "type": "string", "description": "Gets or sets the full name of the customer.", "nullable": true }, "Lastname": { "type": "string", "description": "Gets or sets the last name of the customer.", "nullable": true }, "DocumentId": { "type": "string", "description": "Gets or sets the identification document number of the customer.", "nullable": true }, "DocumentType": { "type": "string", "description": "Gets or sets the type of identification document.", "nullable": true }, "EmailAddress": { "type": "string", "description": "Gets or sets the email address of the customer.", "nullable": true }, "Notes": { "type": "string", "description": "Gets or sets any additional notes or comments about the customer.", "nullable": true }, "Country": { "type": "string", "description": "Gets or sets the country of the customer's nationality.", "nullable": true }, "CellPhone": { "type": "string", "description": "Gets or sets the mobile phone number of the customer.", "nullable": true }, "Birthday": { "type": "string", "description": "Gets or sets the birth date of the customer.", "format": "date-time", "nullable": true }, "Age": { "type": "integer", "description": "Gets or sets the age of the customer.", "format": "int32", "nullable": true }, "IsCompany": { "type": "boolean", "description": "Gets or sets a value indicating whether the customer is a company." }, "IsAgency": { "type": "boolean", "description": "Gets or sets a value indicating whether the customer is a travel agency." }, "IsProvider": { "type": "boolean", "description": "Gets or sets a value indicating whether the customer is a service provider." }, "IsHotel": { "type": "boolean", "description": "Gets or sets a value indicating whether the customer is a hotel." } } }, "CarDescription": { "type": "object", "description": "Represents a car in the rental system.", "additionalProperties": false, "properties": { "Id": { "type": "string", "description": "Gets or sets the unique identifier of the car.", "nullable": true }, "Model": { "description": "Gets or sets the base model information of the vehicle.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ModelDescription" } ] }, "CurrentPlate": { "description": "Gets or sets the current license plate information.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/LicensePlate" } ] } } }, "ModelDescription": { "type": "object", "description": "Base class representing a car model in the system", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the car model", "format": "int32" }, "Name": { "type": "string", "description": "Gets or sets the name of the car model", "nullable": true }, "SIPP": { "type": "string", "description": "Gets or sets the SIPP (Standard International Passenger Protection) code for the model", "nullable": true } } }, "CategoryDescription": { "type": "object", "description": "Represents a vehicle category identified by its id and name.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the vehicle category.", "format": "int32" }, "Name": { "type": "string", "description": "Gets or sets the name of the vehicle category.", "nullable": true } } }, "BookingAdditionalDescription": { "type": "object", "description": "Represents the base class for additional services or products in a booking.", "additionalProperties": false, "properties": { "Additional": { "description": "Gets or sets the base information about the additional service or product.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AdditionalDescription" } ] }, "Quantity": { "type": "integer", "description": "Gets or sets the quantity of the additional item requested.", "format": "int32" } } }, "AdditionalDescription": { "allOf": [ { "$ref": "#/components/schemas/AdditionalBase" }, { "type": "object", "description": "Base class for additional items, providing common properties.", "additionalProperties": false, "properties": { "Name": { "type": "string", "description": "Gets or sets the name of the additional item.", "nullable": true } } } ] }, "BookingStatusEnum2": { "type": "integer", "description": "", "x-enumNames": [ "Reserved", "Confirmed", "Delivered", "Closed", "Canceled", "Quoted" ], "enum": [ 0, 1, 2, 3, 4, 5 ] }, "PagedResultOfBooking": { "type": "object", "description": "Represents a paginated result set of items.", "additionalProperties": false, "properties": { "Offset": { "type": "integer", "description": "Gets or sets the starting index of the current page of results.", "format": "int32" }, "Limit": { "type": "integer", "description": "Gets or sets the maximum number of items to return per page.", "format": "int32" }, "Total": { "type": "integer", "description": "Gets or sets the total number of items available across all pages.", "format": "int32" }, "Results": { "type": "array", "description": "Gets or sets the list of items in the current page.", "nullable": true, "items": { "$ref": "#/components/schemas/Booking" } }, "NextOffset": { "type": "integer", "description": "Gets the next offset to call.", "format": "int32" } } }, "BookingCreationResponse": { "type": "object", "description": "Represents the response returned after successfully creating a booking.", "additionalProperties": false, "properties": { "BookingId": { "type": "integer", "description": "Gets or sets the unique identifier of the newly created booking.", "format": "int32" }, "CustomerId": { "type": "string", "description": "Gets or sets the global unique identifier of the customer associated with the booking.", "nullable": true } } }, "SaveBookingModel": { "type": "object", "description": "Represents the data required to create a booking through the API.", "additionalProperties": false, "properties": { "Customer": { "description": "The customer who is making the booking, including their personal and contact information.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Customer" } ] }, "Car": { "description": "The car being booked, referenced by its id and/or model (id or SIPP code).", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CarBase" } ] }, "Category": { "description": "The category of the car being booked (used when availability is category based),\nidentified by its Id or Name.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CategoryDescription" } ] }, "FromDate": { "type": "string", "description": "The local date and time when the rental period begins.", "format": "date-time" }, "ToDate": { "type": "string", "description": "The local date and time when the rental period ends.", "format": "date-time" }, "DeliveryPlace": { "description": "The location where the customer will pick up the vehicle.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BookingPlace" } ] }, "ReturnPlace": { "description": "The location where the customer will return the vehicle. When omitted, the delivery place is used.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BookingPlace" } ] }, "Additionals": { "type": "array", "description": "Additional services or products to include in the booking, referenced by id and quantity.", "nullable": true, "items": { "$ref": "#/components/schemas/BookingAdditionalBase" } }, "PriceItems": { "type": "array", "description": "A detailed breakdown of price components, used when supplying a fixed price.", "nullable": true, "items": { "$ref": "#/components/schemas/ItemPrice" } }, "Attributes": { "type": "object", "description": "Additional custom attributes associated with the booking.", "nullable": true, "additionalProperties": { "type": "string" } }, "Origin": { "description": "The source or origin of the booking.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BookingOrigin" } ] }, "Brand": { "description": "The brand or company associated with the booking, identified by its Code or Id.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BookingBrandReference" } ] }, "Agency": { "description": "Agency associated with the booking.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Agency" } ] }, "Currency": { "type": "string", "description": "The currency in which the booking is created.", "nullable": true }, "Price": { "type": "number", "description": "The total price of the booking. Used when supplying a fixed price.", "format": "decimal" }, "Franchise": { "type": "number", "description": "The standard deposit amount required for the rental.", "format": "decimal", "nullable": true }, "FranchiseDamage": { "type": "number", "description": "The deposit amount specifically for damage coverage.", "format": "decimal", "nullable": true }, "FranchiseRollover": { "type": "number", "description": "The deposit amount specifically for rollover coverage.", "format": "decimal", "nullable": true }, "FranchiseTheft": { "type": "number", "description": "The deposit amount specifically for theft coverage.", "format": "decimal", "nullable": true }, "FranchiseHail": { "type": "number", "description": "The deposit amount specifically for hail damage coverage.", "format": "decimal", "nullable": true }, "ExchangeRate": { "type": "number", "description": "The exchange rate used for currency conversion.", "format": "decimal", "nullable": true }, "Promotion": { "type": "integer", "description": "The identifier of any promotion applied to this booking.", "format": "int32", "nullable": true }, "PromotionCode": { "type": "string", "description": "The promotion code to apply to the booking.", "nullable": true }, "CommercialAgreementCode": { "type": "string", "description": "The code of the commercial agreement applied to this booking.", "nullable": true }, "ExternalSystemId": { "type": "string", "description": "The booking identifier in an external reservation system.", "nullable": true }, "PrepaidAmount": { "type": "number", "description": "The amount prepaid to the external system.", "format": "decimal" }, "IsQuotation": { "type": "boolean", "description": "Indicates whether this is a price quotation rather than a confirmed booking." }, "IsOnRequest": { "type": "boolean", "description": "Indicates whether this is an on-request booking requiring special approval." }, "Extra": { "type": "string", "description": "Additional notes or special instructions for the booking.", "nullable": true }, "DeliveryTransportationId": { "type": "string", "description": "The flight/bus/boat number for the customer's arrival.", "maxLength": 50, "minLength": 0, "nullable": true }, "ReturnTransportationId": { "type": "string", "description": "The flight/bus/boat number for the customer's departure.", "maxLength": 150, "minLength": 0, "nullable": true }, "ElegibleSIPPCodeUpgrade": { "type": "string", "description": "The maximum SIPP code upgrade available at no additional cost.", "nullable": true }, "IlimitedKm": { "type": "boolean", "description": "Indicates whether the rental includes unlimited mileage." }, "MaxAllowedDistanceByDay": { "type": "integer", "description": "The maximum allowed distance per day of rental. Determines the distance-tiered tariff applied\nwhen mileage is not unlimited.", "format": "int32" }, "MaxAllowedDistance": { "type": "integer", "description": "The maximum allowed distance for the whole rental period.", "format": "int32" }, "DistanceUnit": { "type": "string", "description": "The distance unit in which the booking is created.", "nullable": true }, "DailyRate": { "type": "number", "description": "The standard daily rate for the rental.", "format": "decimal" }, "HourlyRate": { "type": "number", "description": "The hourly rate for the rental.", "format": "decimal" }, "ExtraDayRate": { "type": "number", "description": "The rate for additional days beyond the standard rental period.", "format": "decimal" }, "ExtraHourRate": { "type": "number", "description": "The rate for additional hours beyond the standard rental period.", "format": "decimal" }, "RatePlan": { "type": "string", "description": "The specific rate plan applied to this booking.", "nullable": true }, "IsCustomerOver25": { "type": "boolean", "description": "Indicates whether the customer is over 25 years old. Informational only: this flag is not\npersisted on the booking or the customer." }, "Version": { "type": "string", "description": "The version of the booking in the external system, used for updates. On update, a version lower\nthan or equal to the stored one is rejected with `BookingVersionError`; a higher (or non-numeric)\nversion applies the update.", "nullable": true }, "CreationDate": { "type": "string", "description": "The date and time when the booking was created in the external system.", "format": "date-time" }, "FullResponse": { "type": "boolean", "description": "Indicates whether the response should include complete booking details." }, "IsFixedPrice": { "type": "boolean", "description": "Indicates whether the booking has a fixed price that should not be recalculated." }, "IsPriceAllInclusive": { "type": "boolean", "description": "Indicates whether the price includes all additional charges and fees." }, "ForceExchangeRate": { "type": "boolean", "description": "Indicates whether to use a specific exchange rate instead of the current market rate." }, "CurrentLanguage": { "type": "string", "description": "The current language for the booking.", "nullable": true }, "Language": { "type": "string", "description": "The language for the booking (legacy field).", "nullable": true } } }, "CarBase": { "type": "object", "description": "Base class for car-related models.", "additionalProperties": false, "properties": { "Id": { "type": "string", "description": "Gets or sets the unique identifier of the car.", "nullable": true }, "Model": { "description": "Gets or sets the base model information of the vehicle.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ModelBase" } ] } } }, "BookingPlace": { "allOf": [ { "$ref": "#/components/schemas/PlaceId" }, { "type": "object", "description": "Identifies a location for a booking, optionally overriding it with a custom address.", "additionalProperties": false, "properties": { "IsCustomAddress": { "type": "boolean", "description": "Gets or sets a value indicating whether a custom address is being supplied for this location." }, "Address": { "type": "string", "description": "Gets or sets the custom street address, applied only when IsCustomAddress is true\nand the referenced place accepts custom addresses.", "nullable": true }, "City": { "type": "string", "description": "Gets or sets the custom city, applied only when IsCustomAddress is true\nand the referenced place accepts custom addresses.", "nullable": true } } } ] }, "BookingBrandReference": { "type": "object", "description": "References a brand by its identifier or code.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the brand.", "format": "int32" }, "Code": { "type": "string", "description": "Gets or sets the unique code identifier for the brand.", "nullable": true } } }, "UpdateBookingModel": { "allOf": [ { "$ref": "#/components/schemas/SaveBookingModel" }, { "type": "object", "description": "Represents the data required to update an existing booking. The update modifies the booking in\nplace (same id and history); it is not a cancel-and-rebook operation.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "The unique identifier of the booking to update. Optional if ExternalSystemId\nis provided.", "format": "int32" }, "CurrentStatus": { "description": "The status the booking should transition to (e.g. confirming an on-request booking on update).", "oneOf": [ { "$ref": "#/components/schemas/BookingStatusEnum" } ] } } } ] }, "CancelBookingModel": { "allOf": [ { "$ref": "#/components/schemas/CancelBookingApiModel" }, { "type": "object", "description": "Model for canceling a booking in the system.", "additionalProperties": false, "properties": { "FullResponse": { "type": "boolean", "description": "Gets or sets a value indicating whether a full response should be returned." }, "ExternalCancellationReason": { "type": "string", "description": "External cancellation reasons", "maxLength": 500, "minLength": 0, "nullable": true }, "CancellationType": { "type": "string", "description": "CancellationType", "format": "guid", "nullable": true } } } ] }, "CancelBookingApiModel": { "type": "object", "description": "Represents the base model for canceling a booking in the system.", "additionalProperties": false, "required": [ "BookingId", "Lastname" ], "properties": { "BookingId": { "type": "integer", "description": "Gets or sets the unique identifier of the booking to be canceled.", "format": "int32" }, "Lastname": { "type": "string", "description": "Gets or sets the customer's last name for verification purposes.", "minLength": 1 } } }, "UncancelBookingModel": { "type": "object", "additionalProperties": false, "properties": { "BookingId": { "type": "integer", "format": "int32", "maximum": 2147483647.0, "minimum": 1.0 } } }, "CancelBookingExternalModel": { "type": "object", "additionalProperties": false, "required": [ "ExternalBookingId" ], "properties": { "ExternalBookingId": { "type": "string", "description": "Gets or sets the external system's booking identifier.", "minLength": 1 }, "FullResponse": { "type": "boolean", "description": "Gets or sets a value indicating whether to return the full booking details in the response." } } }, "ReserveBookingModel": { "allOf": [ { "$ref": "#/components/schemas/CancelBookingApiModel" }, { "type": "object", "additionalProperties": false, "properties": { "FullResponse": { "type": "boolean" } } } ] }, "UpdateExternalSystemIdModel": { "type": "object", "additionalProperties": false, "properties": { "ExternalSystemId": { "type": "string", "nullable": true } } }, "Attachment": { "type": "object", "description": "Represents an attached file or document in the system", "additionalProperties": false, "properties": { "Path": { "type": "string", "description": "The file system path or URL where the attachment is stored", "nullable": true }, "Name": { "type": "string", "description": "The original name of the attached file", "nullable": true }, "Category": { "type": "string", "description": "The classification or type of the attachment (e.g., \"Contract\", \"Insurance\", \"Photo\")", "nullable": true }, "Hash": { "type": "string", "description": "SHA-256 fingerprint (lowercase hex) of the original bytes uploaded by the client.\nPopulated by upload endpoints that compute it server-side so the per-file hash can\nbe persisted by the caller and used for later integrity verification. May be null\nfor endpoints that return attachments without computing a hash.", "nullable": true } } }, "AddFilesModel": { "type": "object", "description": "Represents a model for adding multiple files to various entities in the system.", "additionalProperties": false, "properties": { "InvoiceLegalId": { "type": "string", "description": "Gets or sets the legal identifier of the invoice to which the files will be attached.", "nullable": true }, "InvoiceId": { "type": "string", "description": "Gets or sets the identifier of the invoice to which the files will be attached.", "nullable": true }, "BookingId": { "type": "string", "description": "Gets or sets the identifier of the booking to which the files will be attached.", "nullable": true }, "CarId": { "type": "string", "description": "Gets or sets the identifier of the car to which the files will be attached.", "nullable": true }, "InfractionId": { "type": "integer", "description": "Gets or sets the identifier of the infraction to which the files will be attached.", "format": "int32" }, "Files": { "type": "array", "description": "Gets or sets the list of files to be added.", "nullable": true, "items": { "$ref": "#/components/schemas/FileModel" } } } }, "FileModel": { "type": "object", "description": "Represents a single file to be uploaded to the system.", "additionalProperties": false, "properties": { "Name": { "type": "string", "description": "Gets or sets the name of the file.", "nullable": true }, "Content": { "type": "string", "description": "Gets or sets the content of the file, typically in base64 encoded format.", "nullable": true }, "Type": { "type": "string", "description": "Gets or sets the type or category of the file.", "nullable": true } } }, "BookingComment": { "type": "object", "description": "Represents a comment or note associated with a booking.", "additionalProperties": false, "required": [ "Message" ], "properties": { "Message": { "type": "string", "description": "Gets or sets the content of the comment.", "minLength": 1 }, "CommentType": { "description": "Gets or sets the type of comment, indicating its purpose or origin.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CommentType" } ] }, "Important": { "type": "boolean", "description": "Gets or sets a value indicating whether this comment is marked as important." }, "BookingId": { "type": "integer", "description": "Gets or sets the identifier of the booking this comment is associated with.", "format": "int32" }, "ExternalSystemBookingId": { "type": "string", "description": "Gets or sets the identifier of the booking in an external system, if applicable.", "nullable": true } } }, "CommentType": { "type": "integer", "description": "Specifies the types of comments that can be associated with a booking.\n\n| Value | Name | Description |\n| ---: | --- | --- |\n| 0 | `Comment` | A general comment or note. |\n| 1 | `Info` | An informational message. |\n| 2 | `Warning` | A warning or cautionary message. |\n| 3 | `PhoneCall` | A record of a phone call interaction. |\n| 4 | `Mail` | A record of an email communication. |\n| 100 | `BookingCustomerChanged` | Indicates that the customer information was modified. |\n| 101 | `BookingCarChanged` | Indicates that the assigned vehicle was changed. |\n| 102 | `BookingStatusChanged` | Indicates that the booking status was updated. |\n| 103 | `BookingChanged` | Indicates that general booking details were modified. |\n| 104 | `BookingInfractionAssigned` | Indicates that an infraction was assigned to the booking. |\n| 105 | `BookingPriceChanged` | Indicates that the booking price was adjusted. |\n| 106 | `BookingDeliveryChange` | Indicates that the delivery details were modified. |\n", "x-enumNames": [ "Comment", "Info", "Warning", "PhoneCall", "Mail", "BookingCustomerChanged", "BookingCarChanged", "BookingStatusChanged", "BookingChanged", "BookingInfractionAssigned", "BookingPriceChanged", "BookingDeliveryChange" ], "enum": [ 0, 1, 2, 3, 4, 100, 101, 102, 103, 104, 105, 106 ], "x-enumDescriptions": { "0": "A general comment or note.", "1": "An informational message.", "2": "A warning or cautionary message.", "3": "A record of a phone call interaction.", "4": "A record of an email communication.", "100": "Indicates that the customer information was modified.", "101": "Indicates that the assigned vehicle was changed.", "102": "Indicates that the booking status was updated.", "103": "Indicates that general booking details were modified.", "104": "Indicates that an infraction was assigned to the booking.", "105": "Indicates that the booking price was adjusted.", "106": "Indicates that the delivery details were modified." } }, "Void": { "type": "object", "additionalProperties": false }, "BookingCancellationInfo": { "type": "object", "description": "Contains detailed information about a booking cancellation", "additionalProperties": false, "properties": { "CancellationType": { "type": "string", "description": "The unique identifier of the cancellation type", "format": "guid" }, "Reason": { "type": "string", "description": "The human-readable reason for the cancellation (e.g., \"No Show\", \"Customer Request\")", "nullable": true }, "CancelledDate": { "type": "string", "description": "The date and time when the booking was cancelled", "format": "date-time" }, "CancelledByUser": { "type": "string", "description": "The user who cancelled the booking", "nullable": true } } }, "PayBookingModel": { "type": "object", "description": "Represents a payment model specifically for booking payments.", "additionalProperties": false, "required": [ "BookingId", "GatewayId", "Amount" ], "properties": { "BookingId": { "type": "integer", "description": "ID of the booking to be paid", "format": "int32", "example": 123 }, "ExtraData": { "type": "string", "description": "Additional payment information", "nullable": true, "example": { "reference": "BOOK123" } }, "AccountId": { "type": "integer", "description": "Account ID for payment allocation. Uses default account if NULL.", "format": "int32", "nullable": true, "example": 1001 }, "Voucher_Number": { "type": "string", "description": "Payment voucher number", "nullable": true, "example": "VCH-2024-001" }, "IsPayedByAgency": { "type": "boolean", "description": "Indicates if the payment is made by the agency or the customer", "example": false }, "CreditCardNumber": { "type": "string", "description": "Credit card number", "nullable": true, "example": 4111111111111111 }, "CreditCardExpirationMonth": { "type": "integer", "description": "Credit card expiration month (1-12)", "format": "int32", "example": 12 }, "CreditCardExpirationYear": { "type": "integer", "description": "Credit card expiration year", "format": "int32", "example": 2025 }, "CreditCardType": { "type": "string", "description": "Type of credit card (e.g., VISA, MASTERCARD)", "nullable": true, "example": "VISA" }, "CreditCardPlaceHolder": { "type": "string", "description": "Name of the credit card holder", "nullable": true, "example": "John Doe" }, "CreditCardCode": { "type": "string", "description": "Credit card security code (CVV)", "nullable": true, "example": 123 }, "TransactionId": { "type": "string", "description": "Payment gateway transaction ID", "nullable": true, "example": "TX123" }, "GatewayId": { "type": "string", "description": "Payment gateway identifier (ML, PL, TBANKCL, CYBERSOURCE, etc.)", "minLength": 1, "example": "ML" }, "Amount": { "type": "number", "description": "Payment amount in the specified currency", "format": "decimal", "minimum": 0.01, "example": 175.0 }, "payerID": { "type": "string", "description": "PayPal payer ID", "nullable": true, "example": "PAYERID123" }, "paymentToken": { "type": "string", "description": "PayPal payment token", "nullable": true, "example": "EC-1234567890" }, "CurrencyCode": { "type": "string", "description": "Currency code in ISO format (e.g., USD, EUR)", "nullable": true, "example": "USD" }, "ExchangeRate": { "type": "number", "description": "Exchange rate from payment currency to booking currency", "format": "decimal", "nullable": true, "example": 1.0 }, "BillingInformation": { "description": "Billing information for the payment", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BillingInformation" } ] }, "ReturnUrl": { "type": "string", "description": "URL to return to after payment processing", "nullable": true, "example": "https://example.com/payment/callback" } } }, "BillingInformation": { "type": "object", "description": "Represents the billing information for a customer.", "additionalProperties": false, "properties": { "FirstName": { "type": "string", "description": "First name or business name", "nullable": true, "example": "John" }, "LastName": { "type": "string", "description": "Last name", "nullable": true, "example": "Doe" }, "DocumentTypeId": { "type": "integer", "description": "Document type ID (e.g., passport, national ID)", "format": "int32", "nullable": true, "example": 1 }, "DocumentId": { "type": "string", "description": "Document number", "nullable": true, "example": 123456789 }, "FiscalConditionId": { "type": "integer", "description": "Tax payer type ID", "format": "int32", "nullable": true, "example": 1 }, "EmailAddress": { "type": "string", "description": "Email address", "nullable": true, "example": "john.doe@example.com" }, "CellPhone": { "type": "string", "description": "Mobile phone number", "nullable": true, "example": "+1234567890" }, "Address": { "type": "string", "description": "Street address", "nullable": true, "example": "123 Main St" }, "AddressNumber": { "type": "string", "description": "Street number or apartment number", "nullable": true, "example": "Apt 4B" }, "ZipCode": { "type": "string", "description": "Postal/ZIP code", "nullable": true, "example": 12345 }, "Country": { "type": "string", "description": "Country name", "nullable": true, "example": "USA" }, "Birthday": { "type": "string", "description": "Date of birth", "format": "date-time", "nullable": true, "example": "1990-01-01" }, "City": { "type": "string", "description": "City name", "nullable": true, "example": "New York" }, "State": { "type": "string", "description": "State/Province name", "nullable": true, "example": "NY" }, "AddressDepartment": { "type": "string", "description": "Gets or sets the apartment or department number of the customer's address.", "nullable": true } } }, "BookingPayment": { "type": "object", "description": "Represents a payment made for a booking.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "The unique identifier of the payment.", "format": "int32" }, "Type": { "description": "The type of payment made.", "oneOf": [ { "$ref": "#/components/schemas/PaymentTypeEnum" } ] }, "Amount": { "type": "number", "description": "The amount of the payment.", "format": "decimal" }, "Status": { "description": "The current status of the payment.", "oneOf": [ { "$ref": "#/components/schemas/PaymentStatus" } ] }, "Date": { "type": "string", "description": "The date when the payment was made.", "format": "date-time" }, "CreatedBy": { "type": "string", "description": "The identifier of the user who created the payment.", "nullable": true }, "ConciliationStatus": { "description": "The reconciliation status of the payment.", "oneOf": [ { "$ref": "#/components/schemas/ConciliationStatus" } ] }, "ConciliatedOn": { "type": "string", "description": "The date when the payment was reconciled, if applicable.", "format": "date-time", "nullable": true }, "BookingBrandId": { "type": "integer", "description": "The identifier of the commercial brand the payment was collected under. Empty when the payment has no\nbrand recorded; the value is returned as stored, with no fallback to the default brand.", "format": "int32", "nullable": true } } }, "PaymentTypeEnum": { "type": "integer", "description": "Specifies the types of payment methods supported by the system.\n\n| Value | Name | Description |\n| ---: | --- | --- |\n| 0 | `Cash` | Payment made in cash. |\n| 1 | `CreditCard` | Payment made using a credit card. |\n| 2 | `Check` | Payment made using a check. |\n| 3 | `MercadoPago` | Payment made using MercadoPago payment system. |\n| 4 | `BankTransfer` | Payment made via bank transfer. |\n| 5 | `DebitCard` | Payment made using a debit card. |\n| 6 | `Paypal` | Payment made using PayPal. |\n| 7 | `Transbank` | Payment made using Transbank payment system. |\n| 8 | `CurrentAccount` | Payment made from a current account. |\n| 9 | `SWAP` | Payment made using SWAP payment system. |\n| 10 | `Retention` | Payment made through retention. |\n| 11 | `Voucher` | Payment made using a voucher. |\n| 12 | `BacCredomatic` | Payment made using BacCredomatic payment system. |\n| 13 | `Promerica` | Payment made using Promerica payment system. |\n| 14 | `Stripe` | Payment made using Stripe payment system. |\n| 15 | `Prisma` | Payment made using Prisma payment system. |\n| 16 | `Fiserv` | Payment made using Fiserv payment system. |\n| 17 | `Poynt` | Payment made using Poynt payment system. |\n| 18 | `FiservIpg` | Payment made using Fiserv IPG payment system. |\n| 19 | `Cecabank` | Payment made using Cecabank payment system. |\n| 20 | `Genius` | Payment made using Genius payment system. |\n| 21 | `Pix` | Payment made using Pix payment system. |\n| 22 | `Redsys` | Payment made using Redsys payment system. |\n| 23 | `ExternalSystem` | Payment made in external system. |\n| 24 | `OmieBankSlip` | Payment made with an Omie bank slip (boleto). The payment is accredited when the bank reports the slip as paid, so it can be listed before the money is collected. |\n| 25 | `GetNet` | Payment made using GetNet payment system. |\n| 26 | `CyberSource` | Payment made using CyberSource. |\n| 27 | `BradescoBankSlip` | Payment made with a Bradesco bank slip (boleto). Same deferred accreditation as OmieBankSlip. |\n| 28 | `PcPay` | Payment made using PC-Pay (AVASA) POS terminals. |\n| 29 | `SantanderBankSlip` | Payment made with a Santander bank slip (boleto). Same deferred accreditation as OmieBankSlip. |\n", "x-enumNames": [ "Cash", "CreditCard", "Check", "MercadoPago", "BankTransfer", "DebitCard", "Paypal", "Transbank", "CurrentAccount", "SWAP", "Retention", "Voucher", "BacCredomatic", "Promerica", "Stripe", "Prisma", "Fiserv", "Poynt", "FiservIpg", "Cecabank", "Genius", "Pix", "Redsys", "ExternalSystem", "OmieBankSlip", "GetNet", "CyberSource", "BradescoBankSlip", "PcPay", "SantanderBankSlip" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29 ], "x-enumDescriptions": { "0": "Payment made in cash.", "1": "Payment made using a credit card.", "2": "Payment made using a check.", "3": "Payment made using MercadoPago payment system.", "4": "Payment made via bank transfer.", "5": "Payment made using a debit card.", "6": "Payment made using PayPal.", "7": "Payment made using Transbank payment system.", "8": "Payment made from a current account.", "9": "Payment made using SWAP payment system.", "10": "Payment made through retention.", "11": "Payment made using a voucher.", "12": "Payment made using BacCredomatic payment system.", "13": "Payment made using Promerica payment system.", "14": "Payment made using Stripe payment system.", "15": "Payment made using Prisma payment system.", "16": "Payment made using Fiserv payment system.", "17": "Payment made using Poynt payment system.", "18": "Payment made using Fiserv IPG payment system.", "19": "Payment made using Cecabank payment system.", "20": "Payment made using Genius payment system.", "21": "Payment made using Pix payment system.", "22": "Payment made using Redsys payment system.", "23": "Payment made in external system.", "24": "Payment made with an Omie bank slip (boleto). The payment is accredited when the bank reports the slip as paid, so it can be listed before the money is collected.", "25": "Payment made using GetNet payment system.", "26": "Payment made using CyberSource.", "27": "Payment made with a Bradesco bank slip (boleto). Same deferred accreditation as OmieBankSlip.", "28": "Payment made using PC-Pay (AVASA) POS terminals.", "29": "Payment made with a Santander bank slip (boleto). Same deferred accreditation as OmieBankSlip." } }, "PaymentStatus": { "type": "integer", "description": "Specifies the possible statuses of a payment.\n\n| Value | Name | Description |\n| ---: | --- | --- |\n| 0 | `Accredited` | The payment has been successfully processed and accredited. |\n| 1 | `Pending` | The payment is pending processing. |\n| 2 | `Deleted` | The payment has been deleted. |\n", "x-enumNames": [ "Accredited", "Pending", "Deleted" ], "enum": [ 0, 1, 2 ], "x-enumDescriptions": { "0": "The payment has been successfully processed and accredited.", "1": "The payment is pending processing.", "2": "The payment has been deleted." } }, "ConciliationStatus": { "type": "integer", "description": "Specifies the possible statuses of payment reconciliation.\n\n| Value | Name | Description |\n| ---: | --- | --- |\n| 0 | `Pending` | The payment is pending reconciliation. |\n| 1 | `Conciliated` | The payment has been successfully reconciled. |\n| 2 | `ConciliationError` | There was an error during the reconciliation process. |\n", "x-enumNames": [ "Pending", "Conciliated", "ConciliationError" ], "enum": [ 0, 1, 2 ], "x-enumDescriptions": { "0": "The payment is pending reconciliation.", "1": "The payment has been successfully reconciled.", "2": "There was an error during the reconciliation process." } }, "FindByPlatesBookingModelResponse": { "type": "object", "description": "Represents the response containing booking information found by license plate search", "additionalProperties": false, "properties": { "ReqId": { "type": "integer", "description": "Unique identifier matching the original request", "format": "int32" }, "Booking": { "description": "The booking information if found, null if no booking matches the search criteria", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Booking" } ] } } }, "FindByPlatesBookingModel": { "type": "object", "description": "Represents a request to find bookings by license plate information", "additionalProperties": false, "properties": { "ReqId": { "type": "integer", "description": "Unique identifier for the request", "format": "int32" }, "Date": { "type": "string", "description": "The date to search for active bookings", "format": "date-time" }, "PlateId": { "type": "string", "description": "The license plate identifier to search for", "nullable": true }, "PlateState": { "type": "string", "description": "The state or province that issued the license plate", "nullable": true } } }, "FindByTransponderBookingModelResponse": { "type": "object", "description": "Represents the response containing booking information found by transponder search", "additionalProperties": false, "properties": { "ReqId": { "type": "integer", "description": "Unique identifier matching the original request", "format": "int32" }, "Booking": { "description": "The booking information if found, null if no booking matches the search criteria", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Booking" } ] } } }, "FindByTransponderBookingModel": { "type": "object", "description": "Represents a request to find bookings by toll transponder device", "additionalProperties": false, "properties": { "ReqId": { "type": "integer", "description": "Unique identifier for the request", "format": "int32" }, "Date": { "type": "string", "description": "The date to search for active bookings", "format": "date-time" }, "TollDeviceId": { "type": "string", "description": "The unique identifier of the toll transponder device", "nullable": true } } }, "AddTollsResponse": { "type": "object", "description": "Represents the response after adding toll charges to a booking", "additionalProperties": false, "properties": { "ReqId": { "type": "integer", "description": "Unique identifier matching the original request", "format": "int32" }, "Status": { "type": "string", "description": "The status of the toll payment (e.g., \"Paid\", \"NotPaid\", \"BookingNotFound\")", "nullable": true }, "TaxAmount": { "type": "number", "description": "The tax amount calculated for the toll charge", "format": "decimal", "nullable": true }, "PaymentUrl": { "type": "string", "description": "URL for online payment if the toll charge requires manual payment", "nullable": true } } }, "AddTollModel": { "type": "object", "description": "Represents a toll charge to be added to a booking", "additionalProperties": false, "properties": { "ReqId": { "type": "integer", "description": "Unique identifier for the request", "format": "int32" }, "BookingId": { "type": "integer", "description": "The booking identifier to which the toll will be added", "format": "int32" }, "PlateNumber": { "type": "string", "description": "The license plate number of the vehicle that incurred the toll", "nullable": true }, "Date": { "type": "string", "description": "The date and time when the toll was incurred", "format": "date-time" }, "TollAmount": { "type": "number", "description": "The amount charged for the toll", "format": "decimal" }, "TollChargeType": { "type": "string", "description": "The type of toll charge (e.g., bridge toll, highway toll)", "nullable": true }, "FeeAmount": { "type": "number", "description": "The administrative fee amount associated with the toll", "format": "decimal" }, "FeeChargeType": { "type": "string", "description": "The type of administrative fee (e.g., processing fee, service fee)", "nullable": true } } }, "CommercialAgreement": { "type": "object", "description": "Represents a commercial agreement between the rental company and an agency or branch office.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "The unique identifier of the commercial agreement.", "format": "int32" }, "Code": { "type": "string", "description": "The code that uniquely identifies the commercial agreement.", "nullable": true }, "ValidFrom": { "type": "string", "description": "Start date of the commercial agreement's validity period.", "format": "date-time" }, "ValidTo": { "type": "string", "description": "End date of the commercial agreement's validity period.", "format": "date-time" }, "Notes": { "type": "string", "description": "Notes regarding the commercial agreement", "nullable": true }, "BranchOffices": { "type": "array", "description": "The list of branch office ids associated with this commercial agreement. If empty, the agreement applies to all branch offices.", "nullable": true, "items": { "type": "integer", "format": "int32" } } } }, "CommercialAgreementExtended": { "allOf": [ { "$ref": "#/components/schemas/CommercialAgreement" }, { "type": "object", "additionalProperties": false, "properties": { "Agencies": { "type": "array", "description": "The List of agency codes associated with this commercial agreement. If empty, the agreement applies to all agencies.", "nullable": true, "items": { "type": "string" } } } } ] }, "CommercialAgreementComplete": { "allOf": [ { "$ref": "#/components/schemas/CommercialAgreementExtended" }, { "type": "object", "additionalProperties": false, "properties": { "Brands": { "type": "array", "description": "The list of booking brand codes associated with this commercial agreement.", "nullable": true, "items": { "type": "string" } }, "AcceptedPaymentMethods": { "type": "array", "description": "The list of payment methods accepted under this commercial agreement.", "nullable": true, "items": { "$ref": "#/components/schemas/PaymentType" } }, "Tariffs": { "type": "array", "description": "The list of tariff ids associated with this commercial agreement.", "nullable": true, "items": { "type": "integer", "format": "int32" } }, "RatePayedBy": { "type": "string", "description": "Indicates who pays the rate amount.", "nullable": true }, "RatePayment": { "type": "number", "description": "The rate amount paid under this commercial agreement.", "format": "decimal", "nullable": true }, "IsRatePaymentFixedAmount": { "type": "string", "description": "Indicates whether the rate payment is expressed as a fixed amount or as a percentage.", "nullable": true }, "RateCommision": { "type": "number", "description": "The commission applied over the rate.", "format": "decimal", "nullable": true }, "IsRateCommisionFixedAmount": { "type": "string", "description": "Indicates whether the rate commission is expressed as a fixed amount or as a percentage.", "nullable": true }, "DeliveryPayedBy": { "type": "string", "description": "Indicates who pays the delivery amount.", "nullable": true }, "DeliveryPaymentPercentage": { "type": "number", "description": "The delivery payment amount or percentage.", "format": "decimal", "nullable": true }, "IsDeliveryPaymentFixedAmount": { "type": "string", "description": "Indicates whether the delivery payment is expressed as a fixed amount or as a percentage.", "nullable": true }, "DeliveryCommision": { "type": "number", "description": "The commission applied over the delivery.", "format": "decimal", "nullable": true }, "IsDeliveryCommisionFixedAmount": { "type": "string", "description": "Indicates whether the delivery commission is expressed as a fixed amount or as a percentage.", "nullable": true }, "ReturnPayedBy": { "type": "string", "description": "Indicates who pays the return amount.", "nullable": true }, "ReturnPaymentPercentage": { "type": "number", "description": "The return payment amount or percentage.", "format": "decimal", "nullable": true }, "IsReturnPaymentFixedAmount": { "type": "string", "description": "Indicates whether the return payment is expressed as a fixed amount or as a percentage.", "nullable": true }, "ReturnCommision": { "type": "number", "description": "The commission applied over the return.", "format": "decimal", "nullable": true }, "IsReturnCommisionFixedAmount": { "type": "string", "description": "Indicates whether the return commission is expressed as a fixed amount or as a percentage.", "nullable": true }, "OneWayDropOffPayedBy": { "type": "string", "description": "Indicates who pays the one-way drop-off amount.", "nullable": true }, "OneWayDropOffPaymentPercentage": { "type": "number", "description": "The one-way drop-off payment amount or percentage.", "format": "decimal", "nullable": true }, "IsOneWayDropOffPaymentFixedAmount": { "type": "string", "description": "Indicates whether the one-way drop-off payment is expressed as a fixed amount or as a percentage.", "nullable": true }, "OneWayDropOffCommision": { "type": "number", "description": "The commission applied over the one-way drop-off.", "format": "decimal", "nullable": true }, "IsOneWayDropOffCommisionFixedAmount": { "type": "string", "description": "Indicates whether the one-way drop-off commission is expressed as a fixed amount or as a percentage.", "nullable": true }, "TariffApplyStrategyName": { "type": "string", "description": "The name of the strategy used to apply the tariff.", "nullable": true }, "AllowBookingWithoutFranchise": { "type": "boolean", "description": "Indicates whether bookings can be made without charging the franchise under this commercial agreement." }, "ExcludeTollCollection": { "type": "boolean", "description": "Indicates whether toll collection is excluded under this commercial agreement." }, "CommissionByPrice": { "type": "string", "description": "Indicates which price is used as the base to calculate commissions.", "nullable": true }, "PriceModificator": { "type": "number", "description": "A modifier applied over the price under this commercial agreement.", "format": "decimal" }, "CommissionableTaxes": { "type": "array", "description": "The list of taxes that are commissionable under this commercial agreement.", "nullable": true, "items": { "$ref": "#/components/schemas/CommercialAgreementCommissionableTax" } }, "Additionals": { "type": "array", "description": "The list of additionals configured for this commercial agreement.", "nullable": true, "items": { "$ref": "#/components/schemas/CommercialAgreementAdditional" } }, "CoverageBrackets": { "type": "array", "description": "The list of VDR coverage brackets configured for this commercial agreement. Ranges are inclusive and 1-based.", "nullable": true, "items": { "$ref": "#/components/schemas/CommercialAgreementCoverageBracket" } } } } ] }, "PaymentType": { "type": "object", "description": "Represents a payment method in the system.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the payment method.", "format": "int32" }, "Name": { "type": "string", "description": "Gets or sets the display name of the payment method.", "nullable": true } } }, "CommercialAgreementCommissionableTax": { "type": "object", "description": "Represents a tax that is commissionable under a commercial agreement.", "additionalProperties": false, "properties": { "TaxId": { "type": "integer", "description": "The identifier of the tax.", "format": "int32" }, "Commision": { "type": "number", "description": "The commission applied over the tax.", "format": "decimal", "nullable": true }, "IsFixedAmount": { "type": "string", "description": "Indicates whether the commission is expressed as a fixed amount or as a percentage.", "nullable": true }, "IsApplicable": { "type": "string", "description": "Indicates whether the tax is applicable under this commercial agreement.", "nullable": true }, "PayedBy": { "type": "string", "description": "Indicates who pays the tax.", "nullable": true } } }, "CommercialAgreementAdditional": { "type": "object", "description": "Represents an additional configured for a commercial agreement.", "additionalProperties": false, "properties": { "AdditionalId": { "type": "integer", "description": "The identifier of the additional.", "format": "int32" }, "Modifier": { "type": "number", "description": "The value that modifies the additional price.", "format": "decimal" }, "ModifierStrategy": { "type": "string", "description": "Indicates whether the modifier is expressed as a fixed amount or as a percentage.", "nullable": true }, "AdditionalAction": { "type": "string", "description": "The action to apply to the additional.", "nullable": true }, "Commision": { "type": "number", "description": "The commission applied over the additional.", "format": "decimal", "nullable": true }, "CommissionStrategy": { "type": "string", "description": "Indicates whether the commission is expressed as a fixed amount or as a percentage.", "nullable": true }, "PayedBy": { "type": "string", "description": "Indicates who pays the additional.", "nullable": true }, "Percentage": { "type": "number", "description": "The percentage applied to the additional.", "format": "decimal", "nullable": true }, "IsFixedAmount": { "type": "string", "description": "Indicates whether the additional is expressed as a fixed amount or as a percentage.", "nullable": true } } }, "CommercialAgreementCoverageBracket": { "type": "object", "description": "Represents a daily-rate coverage bracket by duration range for a commercial agreement.", "additionalProperties": false, "properties": { "DaysFrom": { "type": "integer", "description": "The inclusive, 1-based start day of the duration range this bracket applies to. The first day is 1.", "format": "int32" }, "DaysTo": { "type": "integer", "description": "The inclusive, 1-based end day of the duration range this bracket applies to. If null, the bracket has no upper bound.", "format": "int32", "nullable": true }, "PayedBy": { "type": "string", "description": "Indicates who pays the covered daily rate for this bracket.", "nullable": true }, "CoveragePercentage": { "type": "number", "description": "The percentage of the daily rate paid by the payer (mutually exclusive with CoverageFixedAmount).", "format": "decimal", "nullable": true }, "CoverageFixedAmount": { "type": "number", "description": "The fixed amount of the daily rate paid by the payer (mutually exclusive with CoveragePercentage).", "format": "decimal", "nullable": true } } }, "FileTypeConfiguration": { "type": "object", "additionalProperties": false, "properties": { "Types": { "type": "object", "nullable": true, "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "TaxPayerType": { "type": "object", "description": "Represents a type of tax payer in the system.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the tax payer type.", "format": "int32" }, "Name": { "type": "string", "description": "Gets or sets the name or description of the tax payer type.", "nullable": true }, "IsExempt": { "type": "boolean", "description": "Gets or sets a value indicating whether this type of tax payer is exempt from taxes." }, "IsEndConsumer": { "type": "boolean", "description": "Gets or sets a value indicating whether this type represents an end consumer." }, "IsRegisteredTaxPayer": { "type": "boolean", "description": "Gets or sets a value indicating whether this type represents a registered tax payer." }, "IsSelfEmployed": { "type": "boolean", "description": "Gets or sets a value indicating whether this type represents a self-employed individual." } } }, "BookingConfiguration": { "type": "object", "description": "Represents the configuration settings for car rental bookings.", "additionalProperties": false, "properties": { "DriverAgeAllowedMin": { "type": "integer", "description": "The minimum age allowed for drivers with caution.", "format": "int32" }, "DriverAgeAllowedMax": { "type": "integer", "description": "The maximum age allowed for drivers with caution.", "format": "int32" }, "MinDays": { "type": "integer", "description": "The minimum number of days allowed for a booking.", "format": "int32" }, "MaxDays": { "type": "integer", "description": "The maximum number of days allowed for a booking.", "format": "int32" }, "GasolineTankFractions": { "type": "integer", "description": "The number of fractions used for gasoline tank measurements.", "format": "int32" }, "ReturnToleranceInMinutes": { "type": "integer", "description": "The grace period in minutes allowed for vehicle returns.", "format": "int32" }, "HalfDayToleranceInHours": { "type": "integer", "description": "The number of hours that constitutes a half-day booking.", "format": "int32" }, "MinDaysToCharge": { "type": "integer", "description": "The minimum number of days to charge for a booking.", "format": "int32" }, "DriverAgeWithoutCautionMin": { "type": "integer", "description": "The minimum age allowed for drivers without caution.", "format": "int32" }, "DriverAgeWithoutCautionMax": { "type": "integer", "description": "The maximum age allowed for drivers without caution.", "format": "int32" }, "RequireDriverLicenceForDelivery": { "type": "boolean", "description": "Indicates whether a driver's license is required for vehicle delivery." }, "UseDriverAgeAllowed": { "type": "boolean", "description": "Indicates whether driver age restrictions are enforced." }, "CutsByDistance": { "type": "array", "description": "The distance thresholds used for calculating additional charges.", "nullable": true, "items": { "type": "integer", "format": "int32" } }, "UseDriverAgeWithoutCaution": { "type": "boolean", "description": "Indicates whether age restrictions without caution are enforced." }, "MustHaveAtLeastOneInsurance": { "type": "boolean", "description": "Indicates whether at least one insurance option must be selected." }, "DistanceUnit": { "type": "string", "description": "The unit of measurement used for distances (e.g., \"km\" or \"mi\").", "nullable": true }, "AvailabilityBased": { "$ref": "#/components/schemas/AvailabilityBasedType" }, "PriceBased": { "$ref": "#/components/schemas/PriceBasedType" } } }, "AvailabilityBasedType": { "type": "integer", "description": "Specifies how availability is determined for car rentals\n\n| Value | Name | Description |\n| ---: | --- | --- |\n| 0 | `Model` | Availability is based on specific car models |\n| 1 | `Category` | Availability is based on car categories |\n", "x-enumNames": [ "Model", "Category" ], "enum": [ 0, 1 ], "x-enumDescriptions": { "0": "Availability is based on specific car models", "1": "Availability is based on car categories" } }, "PriceBasedType": { "type": "integer", "description": "Specifies how pricing is calculated for car rentals\n\n| Value | Name | Description |\n| ---: | --- | --- |\n| 0 | `Model` | Pricing is based on specific car models |\n| 1 | `Category` | Pricing is based on car categories |\n", "x-enumNames": [ "Model", "Category" ], "enum": [ 0, 1 ], "x-enumDescriptions": { "0": "Pricing is based on specific car models", "1": "Pricing is based on car categories" } }, "NotificationsConfiguration": { "type": "object", "description": "Represents the configuration settings for system notifications.", "additionalProperties": false, "properties": { "Configurations": { "type": "object", "description": "A dictionary of notification configurations, keyed by notification type.", "nullable": true, "additionalProperties": { "$ref": "#/components/schemas/NotificationConfiguration" } } } }, "NotificationConfiguration": { "type": "object", "description": "Represents the configuration settings for a specific notification type.", "additionalProperties": false, "properties": { "IsEnabled": { "type": "boolean", "description": "Indicates whether this notification type is enabled in the system." }, "CustomNotificationReplacement": { "type": "integer", "description": "The ID of a custom notification template to use as a replacement.", "format": "int32", "nullable": true } } }, "DocumentType": { "type": "object", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "The unique identifier for the document type.", "format": "int32" }, "Name": { "type": "string", "description": "The name of the document type, limited to 50 characters.", "nullable": true }, "IsDriverLicense": { "type": "boolean", "description": "Indicates whether the document type is classified as a driver's license." } } }, "GatewayCredential": { "type": "object", "description": "Represents the configuration settings for a payment gateway.", "additionalProperties": false, "properties": { "Id": { "type": "string", "description": "The unique identifier for the payment gateway configuration.", "nullable": true }, "PaymentType": { "description": "The type of payment gateway being configured.", "oneOf": [ { "$ref": "#/components/schemas/PaymentTypeEnum" } ] }, "Configuration": { "type": "string", "description": "The JSON configuration string containing gateway-specific settings.", "nullable": true }, "BranchOffices": { "type": "array", "description": "The list of branch office IDs where this payment gateway is available.", "nullable": true, "items": { "type": "integer", "format": "int32" } }, "BookingBrandIds": { "type": "array", "description": "The list of booking brand IDs this payment gateway configuration is restricted to.", "nullable": true, "items": { "type": "integer", "format": "int32" } } } }, "PaymentAccount": { "type": "object", "description": "Represents a payment account configuration in the system.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "The unique identifier for the payment account.", "format": "int32" }, "Name": { "type": "string", "description": "The name of the payment account.", "nullable": true }, "PaymentTypes": { "type": "array", "description": "The list of payment types associated with this account.", "nullable": true, "items": { "type": "integer", "format": "int32" } }, "BranchOffices": { "type": "array", "description": "The list of branch offices where this payment account is available.", "nullable": true, "items": { "type": "integer", "format": "int32" } } } }, "TenantGeneralSettings": { "type": "object", "description": "Represents the general configuration settings for a tenant in the system.", "additionalProperties": false, "properties": { "CashBoxConfiguration": { "description": "Configuration settings for the cash box functionality.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CashBoxConfigurationModel" } ] }, "PaymentGatewayConfigs": { "type": "array", "description": "List of payment gateway configurations available to the tenant.", "nullable": true, "items": { "$ref": "#/components/schemas/PaymentGatewayConfigModel" } } } }, "CashBoxConfigurationModel": { "type": "object", "description": "Represents the configuration model for cash box settings.", "additionalProperties": false, "properties": { "NumberOfDecimals": { "type": "integer", "description": "The number of decimal places to use for monetary values.", "format": "int32" } } }, "PaymentGatewayConfigModel": { "type": "object", "description": "Represents the configuration model for a payment gateway.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "The unique identifier for this payment gateway configuration.", "format": "int32" }, "Name": { "type": "string", "description": "The display name of the payment gateway.", "nullable": true }, "PaymentType": { "description": "The type of payment this gateway handles.", "oneOf": [ { "$ref": "#/components/schemas/PaymentTypeEnum" } ] }, "BranchOfficeIds": { "type": "array", "description": "List of branch office IDs where this payment gateway is available.", "nullable": true, "items": { "type": "integer", "format": "int32" } }, "BookingBrandIds": { "type": "array", "description": "List of booking brand IDs this payment gateway is restricted to.", "nullable": true, "items": { "type": "integer", "format": "int32" } } } }, "PagedResultOfCustomer": { "type": "object", "description": "Represents a paginated result set of items.", "additionalProperties": false, "properties": { "Offset": { "type": "integer", "description": "Gets or sets the starting index of the current page of results.", "format": "int32" }, "Limit": { "type": "integer", "description": "Gets or sets the maximum number of items to return per page.", "format": "int32" }, "Total": { "type": "integer", "description": "Gets or sets the total number of items available across all pages.", "format": "int32" }, "Results": { "type": "array", "description": "Gets or sets the list of items in the current page.", "nullable": true, "items": { "$ref": "#/components/schemas/Customer" } }, "NextOffset": { "type": "integer", "description": "Gets the next offset to call.", "format": "int32" } } }, "PaymentGatewayInformationModel": { "type": "object", "description": "Represents payment gateway configuration and transaction information.", "additionalProperties": false, "properties": { "GatewayId": { "type": "string", "description": "Gets or sets the identifier of the payment gateway to be used.", "nullable": true }, "BranchOfficePaymentId": { "type": "integer", "description": "Gets or sets the identifier of the Rently branch office processing the payment.", "format": "int32", "nullable": true }, "RentlyCustomerId": { "type": "integer", "description": "Gets or sets the internal Rently customer identifier.", "format": "int32" }, "CreditCard": { "description": "Gets or sets the credit card information for the payment.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CreditCard" } ] }, "PaymentGatewayConfigId": { "type": "integer", "description": "Gets or sets the identifier of the payment gateway configuration to be used.", "format": "int32" }, "GatewayCustomerId": { "type": "string", "description": "Gets or sets the customer identifier in the payment gateway's system.", "nullable": true }, "GatewayPaymentMethodId": { "type": "string", "description": "Gets or sets the payment method identifier (token) in the payment gateway's system.", "nullable": true }, "Metadata": { "type": "string", "description": "Gets or sets additional metadata for the payment gateway.", "nullable": true } } }, "UpdateCustomerPriceAgreementModel": { "type": "object", "description": "Request payload for updating the price agreement assigned to a customer. The customer is taken\nfrom the route, so this contract only exposes the price agreement to assign.", "additionalProperties": false, "properties": { "PriceAgreementId": { "type": "integer", "description": "The identifier of the price agreement to assign to the customer. Send null (or omit it) to\nunassign the customer's current price agreement.", "format": "int32", "nullable": true, "example": 1 } } }, "AddCustomerCommentModel": { "type": "object", "description": "Request payload for adding a comment to a customer. The customer is taken from the route,\nso this contract only exposes the comment content and its metadata.", "additionalProperties": false, "properties": { "Message": { "type": "string", "description": "The content of the comment.", "nullable": true, "example": "Customer called to confirm their booking details. All information was correct." }, "CommentType": { "description": "The type of comment, indicating its purpose or category.", "nullable": true, "example": "Info", "oneOf": [ { "$ref": "#/components/schemas/CommentType" } ] }, "Important": { "type": "boolean", "description": "Indicates whether the comment is marked as important.", "example": true } } }, "CustomerDocumentImagesUploadResponse": { "type": "object", "description": "Represents the response after uploading customer document images.", "additionalProperties": false, "properties": { "CustomerId": { "type": "integer", "description": "Gets or sets the customer identifier.", "format": "int32" }, "UploadResults": { "type": "object", "description": "Gets or sets the upload results for each field (documentfront, documentback, licensefront, licenseback).", "nullable": true, "additionalProperties": { "$ref": "#/components/schemas/DocumentUploadResult" } }, "DocumentImages": { "description": "Gets or sets the identification document image information after upload.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DocumentImageInfo" } ] }, "DriverLicenseImages": { "description": "Gets or sets the driver license image information after upload.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DocumentImageInfo" } ] } } }, "DocumentUploadResult": { "type": "object", "description": "Represents the result of a single document upload operation.", "additionalProperties": false, "properties": { "Success": { "type": "boolean", "description": "Gets or sets a value indicating whether the upload was successful." }, "FileId": { "type": "integer", "description": "Gets or sets the file identifier if the upload was successful.", "format": "int32", "nullable": true }, "Url": { "type": "string", "description": "Gets or sets the URL of the uploaded file if successful.", "nullable": true }, "Error": { "type": "string", "description": "Gets or sets the error message if the upload failed.", "nullable": true } } }, "DocumentImageInfo": { "type": "object", "description": "Represents information about a document image (front and back).", "additionalProperties": false, "properties": { "FrontImageId": { "type": "integer", "description": "Gets or sets the front image file ID.", "format": "int32", "nullable": true }, "FrontImageUrl": { "type": "string", "description": "Gets or sets the front image URL.", "nullable": true }, "BackImageId": { "type": "integer", "description": "Gets or sets the back image file ID.", "format": "int32", "nullable": true }, "BackImageUrl": { "type": "string", "description": "Gets or sets the back image URL.", "nullable": true } } }, "DamageStatusEnum": { "type": "integer", "description": "Estados del ciclo de vida de un Damage.", "x-enumNames": [ "PendingValidation", "Active", "PossibleDuplicate", "InRepair", "Resolved", "Rejected" ], "enum": [ 1, 2, 3, 4, 5, 6 ] }, "DamageCreateModel": { "type": "object", "description": "Alta de un daño marcado por un empleado.", "additionalProperties": false, "required": [ "CarId", "DamageType", "DiagramPanel" ], "properties": { "CarId": { "type": "string", "minLength": 1 }, "BookingId": { "type": "integer", "format": "int32", "nullable": true }, "AppProtocolResponseId": { "type": "integer", "format": "int32", "nullable": true }, "FileId": { "type": "integer", "format": "int32", "nullable": true }, "DamageType": { "$ref": "#/components/schemas/DamageTypeEnum" }, "Description": { "type": "string", "maxLength": 500, "minLength": 0, "nullable": true }, "Price": { "type": "number", "format": "decimal", "nullable": true }, "ColorOverride": { "type": "string", "maxLength": 9, "minLength": 0, "nullable": true }, "ImageBoxX1": { "type": "number", "format": "float", "nullable": true }, "ImageBoxY1": { "type": "number", "format": "float", "nullable": true }, "ImageBoxX2": { "type": "number", "format": "float", "nullable": true }, "ImageBoxY2": { "type": "number", "format": "float", "nullable": true }, "DiagramBoxX1": { "type": "number", "format": "float", "nullable": true }, "DiagramBoxY1": { "type": "number", "format": "float", "nullable": true }, "DiagramBoxX2": { "type": "number", "format": "float", "nullable": true }, "DiagramBoxY2": { "type": "number", "format": "float", "nullable": true }, "DiagramPanel": { "$ref": "#/components/schemas/DiagramPanelEnum" } } }, "DamageTypeEnum": { "type": "integer", "description": "Catálogo de tipos de daño. Es un enum (no una tabla): los tenants no pueden crear/borrar\ntipos, solo configurar presentación/comportamiento por tipo vía DamageTypeSetting.\n \nRegla de evolución: SOLO se pueden agregar valores nuevos (con su default en\nDamageTypeDefaults). Nunca renumerar ni reusar un id existente: rompe la data\nhistórica de la columna DamageType. Para deprecar, marcar inactivo por\ndefault y ocultar en UI, pero mantener el valor.", "x-enumNames": [ "Scratch", "Dent", "PaintDamage", "GlassCrack", "LightDamage", "TireDamage", "MirrorDamage", "Deformation", "Other" ], "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 99 ] }, "DiagramPanelEnum": { "type": "integer", "description": "Panel del croquis del auto donde se ubica un daño. Es un enum (no una tabla): el conjunto de\npaneles es fijo y compartido por todos los tenants.\n \nRegla de evolución: SOLO se pueden agregar valores nuevos. Nunca renumerar ni reusar un id\nexistente: rompe la data histórica de la columna DiagramPanel.", "x-enumNames": [ "Front", "PassengerFront", "PassengerRear", "DriversFront", "DriversRear", "Rear", "PassengerSide", "DriversSide", "Dashboard", "NoPanel" ], "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ] }, "DamageUpdateModel": { "type": "object", "description": "Edición manual de un daño (\"Editar marca\"). No modifica el estado del daño.", "additionalProperties": false, "required": [ "DamageType", "DiagramPanel" ], "properties": { "DamageType": { "$ref": "#/components/schemas/DamageTypeEnum" }, "Description": { "type": "string", "maxLength": 500, "minLength": 0, "nullable": true }, "Price": { "type": "number", "format": "decimal", "nullable": true }, "ColorOverride": { "type": "string", "maxLength": 9, "minLength": 0, "nullable": true }, "DiagramPanel": { "$ref": "#/components/schemas/DiagramPanelEnum" }, "ImageBoxX1": { "type": "number", "format": "float", "nullable": true }, "ImageBoxY1": { "type": "number", "format": "float", "nullable": true }, "ImageBoxX2": { "type": "number", "format": "float", "nullable": true }, "ImageBoxY2": { "type": "number", "format": "float", "nullable": true } } }, "DamageValidateModel": { "type": "object", "additionalProperties": false, "properties": { "Approve": { "type": "boolean" } } }, "ConfirmDuplicateModel": { "type": "object", "additionalProperties": false, "properties": { "DuplicateOfId": { "type": "integer", "format": "int32", "maximum": 2147483647.0, "minimum": 1.0 } } }, "LinkDamagesToServiceModel": { "type": "object", "additionalProperties": false, "required": [ "DamageIds" ], "properties": { "ServiceId": { "type": "integer", "format": "int32", "maximum": 2147483647.0, "minimum": 1.0 }, "DamageIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "DamageTypeSettingUpdateModel": { "type": "object", "additionalProperties": false, "properties": { "IsActive": { "type": "boolean", "nullable": true }, "Color": { "type": "string", "maxLength": 9, "minLength": 0, "nullable": true }, "IncidentItemTypeId": { "type": "integer", "format": "int32", "nullable": true } } }, "InstanceInformation": { "type": "object", "additionalProperties": false, "properties": { "Name": { "type": "string", "nullable": true }, "PrincipalColor": { "type": "string", "nullable": true }, "SecondaryColor": { "type": "string", "nullable": true }, "BaseUrl": { "type": "string", "nullable": true }, "Logo": { "type": "string", "nullable": true }, "Languages": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/Language" } }, "FuelFranctions": { "type": "integer", "format": "int32" }, "UseKilometers": { "type": "boolean" }, "AutoRunAppCustomerProtocol": { "type": "boolean" }, "RequireDriverLicenceForDelivery": { "type": "boolean" }, "EnforceFranchiseForDelivery": { "type": "boolean" } } }, "Language": { "type": "object", "description": "Represents a language supported by the system with its various naming conventions and codes", "additionalProperties": false, "properties": { "Name": { "type": "string", "description": "The primary name of the language as used in the system", "nullable": true }, "DisplayName": { "type": "string", "description": "The localized display name of the language in the current UI culture", "nullable": true }, "EnglishName": { "type": "string", "description": "The English name of the language", "nullable": true }, "NativeName": { "type": "string", "description": "The native name of the language in its own script", "nullable": true }, "ThreeLetterWindowsLanguageName": { "type": "string", "description": "The three-letter Windows language name (e.g., \"ENU\" for English)", "nullable": true }, "ThreeLetterISOLanguageName": { "type": "string", "description": "The three-letter ISO 639-2 language code (e.g., \"eng\" for English)", "nullable": true }, "TwoLetterISOLanguageName": { "type": "string", "description": "The two-letter ISO 639-1 language code (e.g., \"en\" for English)", "nullable": true } } }, "FeatureFlags": { "type": "object", "additionalProperties": false, "properties": { "Garage": { "type": "boolean" }, "Damages": { "type": "boolean" } } }, "BranchOffice": { "type": "object", "description": "Represents a branch office location with its operational settings", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Unique identifier of the branch office", "format": "int32", "example": 1 }, "Name": { "type": "string", "description": "Name of the branch office", "nullable": true, "example": "Downtown Branch" }, "IATACode": { "type": "string", "description": "IATA code of the branch office location", "nullable": true, "example": "NYC" }, "DeliveryProtocolExecutesDelivery": { "type": "boolean", "description": "Indicates if the delivery protocol is executed by the branch office", "example": true }, "ReturnProtocolExecutesReturn": { "type": "boolean", "description": "Indicates if the return protocol is executed by the branch office", "example": true }, "AutoRunAppCustomerProtocol": { "type": "boolean", "description": "Indicates if the customer protocol should be automatically run in the app", "example": true } } }, "BookingItem": { "type": "object", "description": "Represents a booking item for the mobile application", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Booking Id", "format": "int32" }, "CustomerName": { "type": "string", "description": "Customer full name", "nullable": true }, "Type": { "description": "Type of action allowed on the booking", "oneOf": [ { "$ref": "#/components/schemas/BookingItemType" } ] }, "Category": { "type": "string", "description": "Booking Category name", "nullable": true }, "CarId": { "type": "string", "description": "Car identifier", "nullable": true }, "CarFriendlyName": { "type": "string", "description": "Car friendly name", "nullable": true }, "Date": { "type": "string", "description": " ", "format": "date-time" }, "CarImg": { "type": "string", "description": "Car image", "nullable": true }, "DeliveryPlace": { "description": "Booking delivery place", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Place2" } ] }, "ReturnPlace": { "description": "Booking return place", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Place2" } ] } } }, "BookingItemType": { "type": "integer", "description": "\n\n| Value | Name | Description |\n| ---: | --- | --- |\n| 0 | `Delivery` | — |\n| 1 | `Dropoff` | — |\n| 2 | `None` | — |\n| 3 | `Canceled` | — |\n", "x-enumNames": [ "Delivery", "Dropoff", "None", "Canceled" ], "enum": [ 0, 1, 2, 3 ], "x-enumDescriptions": { "0": "", "1": "", "2": "", "3": "" } }, "Place2": { "type": "object", "additionalProperties": false, "properties": { "Id": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "nullable": true }, "Address": { "type": "string", "nullable": true } } }, "UpdateDropoffPlaceModel": { "type": "object", "additionalProperties": false, "properties": { "PlaceId": { "type": "integer", "format": "int32" } } }, "BookingItemDetail": { "type": "object", "additionalProperties": false, "properties": { "Id": { "type": "integer", "format": "int32" }, "CustomerId": { "type": "integer", "format": "int32" }, "CustomerName": { "type": "string", "nullable": true }, "Category": { "type": "string", "nullable": true }, "CarId": { "type": "string", "nullable": true }, "CarFriendlyName": { "type": "string", "nullable": true }, "FromDate": { "type": "string", "format": "date-time" }, "ToDate": { "type": "string", "format": "date-time" }, "Type": { "$ref": "#/components/schemas/BookingItemType" }, "CarImg": { "type": "string", "nullable": true }, "TotalDays": { "type": "number", "format": "double" }, "Model": { "type": "string", "nullable": true }, "Balance": { "type": "number", "format": "decimal" }, "IsDepositComplete": { "type": "boolean" }, "IsCustomerInfoComplete": { "type": "boolean" }, "CarKilometers": { "type": "integer", "format": "int32", "nullable": true }, "Gasoline": { "type": "integer", "format": "int32" }, "FuelType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FuelTypeEnum2" } ] }, "Currency": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CurrencyInfo" } ] }, "AdditionalDrivers": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/AdditionalDriver" } }, "Additionals": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/Additional2" } }, "DeliveryProtocolPDF": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Attachment" } ] }, "ReturnProtocolPDF": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Attachment" } ] }, "ReturnBranchOffice": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BranchOffice" } ] }, "DeliveryPlace": { "description": "Booking delivery place", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Place2" } ] }, "ReturnPlace": { "description": "Booking return place", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Place2" } ] }, "PurchaseOrder": { "type": "string", "description": "The purchase order number for agency or company bookings", "nullable": true }, "TransportationId": { "type": "string", "description": "The flight/bus/boat number for the customer's arrival", "nullable": true }, "ReturnTransportationId": { "type": "string", "description": "The flight/bus/boat number for the customer's departure", "nullable": true } } }, "FuelTypeEnum2": { "type": "integer", "description": "Si se agrega otro enum hay que agregar en la tabla FuelType un registro con un id que coincida con el nuevo enum", "x-enumNames": [ "Gasoline", "Diesel", "Electric", "Hybrid", "Alcohol", "Gas", "Bencina", "CngAlcoholElectric", "AlcoholGasoline", "AlcoholGasolineCng", "GasolineElectric", "GasolineCng" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ] }, "CurrencyInfo": { "type": "object", "additionalProperties": false, "properties": { "Name": { "type": "string", "description": "Friendly name of the currency", "nullable": true }, "Symbol": { "type": "string", "description": "Symbol used on the system for the currency", "nullable": true } } }, "AdditionalDriver": { "type": "object", "additionalProperties": false, "properties": { "Id": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "nullable": true }, "CellPhone": { "type": "string", "nullable": true }, "EmailAddress": { "type": "string", "nullable": true }, "Status": { "$ref": "#/components/schemas/AdditionalDriverStatusEnum" } } }, "AdditionalDriverStatusEnum": { "type": "integer", "description": "\n\n| Value | Name | Description |\n| ---: | --- | --- |\n| 0 | `Valid` | — |\n| 1 | `MissingInformation` | — |\n| 2 | `ExpiredDriverLicense` | — |\n", "x-enumNames": [ "Valid", "MissingInformation", "ExpiredDriverLicense" ], "enum": [ 0, 1, 2 ], "x-enumDescriptions": { "0": "", "1": "", "2": "" } }, "Additional2": { "type": "object", "additionalProperties": false, "properties": { "Id": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "nullable": true }, "Quantity": { "type": "integer", "format": "int32" }, "CheckStock": { "type": "boolean" } } }, "AppProtocolResponseSave": { "type": "object", "additionalProperties": false, "required": [ "AppProtocolId", "ResponseData", "Kilometers", "Gasoline" ], "properties": { "AppProtocolId": { "type": "integer", "format": "int32" }, "ResponseData": { "type": "array", "items": { "$ref": "#/components/schemas/Answer" } }, "BookingId": { "type": "integer", "format": "int32", "nullable": true }, "CarId": { "type": "string", "nullable": true }, "Kilometers": { "type": "integer", "format": "int32" }, "Gasoline": { "type": "integer", "format": "int32" }, "Notes": { "type": "string", "nullable": true }, "ResponseId": { "type": "integer", "format": "int32" }, "Type": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BookingItemType" } ] }, "IncidentTypeId": { "type": "integer", "description": "Si no viene IncidentTypeId, NO devolvió con siniestro", "format": "int32", "nullable": true }, "ConsentAcceptedOn": { "type": "string", "description": "Auditoría reenviada por la app mobile cuando captura el flow de cliente con vista web embebida.\n`Submit()` del `CustomerProtocolController` ya recibe estos mismos campos en su propio DTO; las\ncapturas hechas a través del operador (esta API) los reciben para mantener la traza idéntica.\nTodas son opcionales: apps viejas que no las mandan persisten `null` (comportamiento previo).", "format": "date-time", "nullable": true }, "SignatureCapturedOn": { "type": "string", "format": "date-time", "nullable": true }, "CompletedOn": { "type": "string", "format": "date-time", "nullable": true }, "Latitude": { "type": "number", "format": "double", "nullable": true }, "Longitude": { "type": "number", "format": "double", "nullable": true }, "Language": { "type": "string", "description": "Código BCP-47 / ISO-639 de la interfaz que mostró el flujo (es, en, pt…). Recibido para\npreservar paridad con `CustomerProtocolSubmission`; no se persiste como columna en\n`AppProtocolResponse` porque tampoco el flujo de cliente lo guarda. Reservado para uso\nfuturo (PDF render, mails) sin obligar a un cambio de schema.", "nullable": true } } }, "Answer": { "type": "object", "additionalProperties": false, "properties": { "Id": { "type": "integer", "format": "int32" }, "Type": { "type": "string", "nullable": true }, "Value": { "type": "string", "nullable": true }, "Metadata": { "description": "Optional per-step metadata captured by the customer-protocol web app:\nstartedAt, completedAt, firstAnsweredAt, activeDurationMs, visitCount, editCount,\nretakes (Picture only), clearCount (Signature only). Untyped JObject so the shape\ncan evolve without lockstep changes here. Null for protocols that don't carry it\n(legacy / operator-side responses).", "nullable": true } } }, "CustomerInfo": { "type": "object", "additionalProperties": false, "required": [ "DocumentTypeId", "DocumentId", "Name" ], "properties": { "Id": { "type": "integer", "format": "int32" }, "DocumentTypeId": { "title": "Document Type", "type": "integer", "format": "int32" }, "DocumentId": { "title": "Id number", "type": "string", "minLength": 1 }, "Name": { "title": "Name", "type": "string", "minLength": 1 }, "LastName": { "type": "string", "nullable": true }, "Address": { "type": "string", "nullable": true }, "StreetNumber": { "type": "integer", "format": "int32", "nullable": true }, "Apartment": { "type": "string", "nullable": true }, "City": { "type": "string", "nullable": true }, "State": { "type": "string", "nullable": true }, "Country": { "type": "string", "nullable": true }, "PostalCode": { "type": "string", "nullable": true }, "CellPhone": { "title": "Mobile Phone", "type": "string", "nullable": true }, "HomePhone": { "title": "Phone", "type": "string", "nullable": true }, "EmailAddress": { "title": "e-Mail", "type": "string", "format": "email", "nullable": true }, "TaxPayerTypeId": { "type": "integer", "format": "int32", "nullable": true }, "Birthday": { "type": "string", "format": "date-time", "nullable": true }, "DocumentExpeditedBy": { "type": "string", "nullable": true }, "DriverLicenseNumber": { "type": "string", "nullable": true }, "DriverLicenseExpeditedBy": { "type": "string", "nullable": true }, "DriverLicenseExpeditedState": { "type": "string", "nullable": true }, "DriverLicenseExpirationDate": { "type": "string", "format": "date-time", "nullable": true }, "TaxExempt": { "title": "Tax exempt", "type": "boolean" }, "Notes": { "title": "Notes", "type": "string", "nullable": true }, "PreferredLanguage": { "type": "string", "nullable": true }, "IsCompany": { "type": "boolean" }, "IsProvider": { "type": "boolean" }, "IsHotel": { "type": "boolean" }, "BirthCountry": { "type": "string", "nullable": true }, "BirthState": { "type": "string", "nullable": true }, "DriverLicenseIssuance": { "type": "string", "format": "date-time", "nullable": true }, "DriverLicenseState": { "type": "string", "nullable": true }, "DocumentIdIssuance": { "type": "string", "format": "date-time", "nullable": true }, "DocumentIdExpiration": { "type": "string", "format": "date-time", "nullable": true }, "DocumentIdIssuanceState": { "type": "string", "nullable": true }, "DocumentPictures": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/PictureAnswerValue" } }, "DriverLicensePictures": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/PictureAnswerValue" } } } }, "PictureAnswerValue": { "type": "object", "additionalProperties": false, "properties": { "Name": { "type": "string", "nullable": true }, "Url": { "type": "string", "nullable": true } } }, "CarAvailability": { "type": "object", "additionalProperties": false, "properties": { "Id": { "type": "string", "nullable": true }, "FriendlyName": { "type": "string", "nullable": true }, "CarImg": { "type": "string", "nullable": true }, "Model": { "type": "string", "nullable": true }, "Category": { "type": "string", "nullable": true }, "Color": { "type": "string", "nullable": true }, "Kilometers": { "type": "integer", "format": "int32" }, "Gasoline": { "type": "integer", "format": "int32" }, "FuelType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FuelTypeEnum2" } ] } } }, "IncidentType": { "type": "object", "description": "Represents a type or category of incident that can occur with a vehicle.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier for the incident type.", "format": "int32" }, "Name": { "type": "string", "description": "Gets or sets the name or description of the incident type.", "nullable": true } } }, "Incident": { "type": "object", "description": "Represents an incident that occurred with a vehicle.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier for the incident.", "format": "int32" }, "IncidentDate": { "type": "string", "description": "Gets or sets the date and time when the incident occurred.", "format": "date-time" }, "CarId": { "type": "string", "description": "Gets or sets the identifier of the vehicle involved in the incident.", "nullable": true }, "IncidentTypeId": { "type": "integer", "description": "Gets or sets the identifier of the incident type.", "format": "int32" }, "BookingId": { "type": "integer", "description": "Gets or sets the booking identifier associated with the incident, if applicable.", "format": "int32", "nullable": true }, "Notes": { "type": "string", "description": "Gets or sets additional notes or comments about the incident.", "nullable": true }, "HasRecovery": { "type": "boolean", "description": "Gets or sets a value indicating whether the incident has recovery associated with it.", "nullable": true }, "Files": { "type": "array", "description": " ", "nullable": true, "items": { "$ref": "#/components/schemas/IncidentFile" } } } }, "IncidentFile": { "type": "object", "description": " ", "additionalProperties": false, "properties": { "Path": { "type": "string", "description": "The file system path or URL where the attachment is stored", "nullable": true }, "Name": { "type": "string", "description": "The original name of the attached file", "nullable": true } } }, "AddIncidentModel": { "type": "object", "additionalProperties": false, "required": [ "IncidentDate", "CarId" ], "properties": { "IncidentDate": { "type": "string", "format": "date-time" }, "CarId": { "type": "string", "minLength": 1 }, "IncidentTypeId": { "type": "integer", "format": "int32", "maximum": 2147483647.0, "minimum": 1.0 }, "BookingId": { "type": "integer", "format": "int32", "nullable": true }, "Notes": { "type": "string", "maxLength": 1000, "nullable": true }, "HasRecovery": { "type": "boolean", "nullable": true } } }, "AddInfractionResponse": { "type": "object", "description": "Response model for infraction addition request", "additionalProperties": false, "properties": { "ReqId": { "type": "integer", "description": "Original request identifier for correlation", "format": "int32", "example": 1 }, "Status": { "type": "string", "description": "Status of the infraction addition (Paid, NotPaid, Error, BookingNotFound)", "nullable": true, "example": "Paid" }, "InfractionId": { "type": "integer", "description": "ID of the created infraction", "format": "int32", "example": 456 }, "PaymentUrl": { "type": "string", "description": "URL for online payment if payment is required", "nullable": true, "example": "https://example.com/payment/456" }, "StatusDescription": { "type": "string", "nullable": true } } }, "AddInfractionModel": { "type": "object", "description": "Model for adding a new infraction to a booking", "additionalProperties": false, "required": [ "BookingId", "Date", "InfractionAmount" ], "properties": { "ReqId": { "type": "integer", "description": "Request identifier for tracking purposes", "format": "int32", "example": 1 }, "BookingId": { "type": "integer", "description": "ID of the booking associated with this infraction", "format": "int32", "example": 123 }, "Date": { "type": "string", "description": "Date and time when the infraction occurred", "format": "date-time", "example": "2024-04-24T10:00:00" }, "Act": { "type": "string", "description": "The infraction act or violation code", "nullable": true, "example": "SPEED_VIOLATION" }, "InfractionAmount": { "type": "number", "description": "The amount of the infraction fine", "format": "decimal", "minimum": 0.01, "example": 150.0 }, "FeeAmount": { "type": "number", "description": "Additional administrative fee amount", "format": "decimal", "minimum": 0.0, "example": 25.0 }, "PrincipalAmount": { "type": "number", "description": "Optional principal amount (full fine value before discounts). If omitted, it is initialized on creation from the reported amount.", "format": "decimal", "minimum": 0.0, "nullable": true, "example": 150.0 }, "AmountToPay": { "type": "number", "description": "Optional amount to pay to the issuing entity. If omitted, it is resolved by fallback on read (no copy is persisted).", "format": "decimal", "minimum": 0.0, "nullable": true, "example": 120.0 }, "AmountToPayAfterDueDate": { "type": "number", "description": "Optional amount to pay to the issuing entity after the voluntary-payment deadline. If omitted, it is resolved by fallback on read.", "format": "decimal", "minimum": 0.0, "nullable": true, "example": 180.0 }, "Jurisdiction": { "type": "string", "description": "The jurisdiction where the infraction occurred", "nullable": true, "example": "New York" }, "InfractionType": { "type": "string", "description": "Type of infraction (e.g., SpeedingTicket, ParkingViolation)", "nullable": true, "example": "SpeedingTicket" }, "InfractionNoticeId": { "type": "integer", "description": "Optional InfractionNotice id to associate this infraction with (Brazil notice feature).", "format": "int32", "nullable": true, "example": 123 } } }, "Infraction": { "type": "object", "description": "Represents a traffic infraction associated with a rental vehicle.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the infraction.", "format": "int32" }, "BookingId": { "type": "integer", "description": "Gets or sets the identifier of the booking associated with the infraction.", "format": "int32", "nullable": true }, "CreationDate": { "type": "string", "description": "Gets or sets the date when the infraction record was created in the system.", "format": "date-time" }, "Date": { "type": "string", "description": "Gets or sets the date when the infraction occurred.", "format": "date-time" }, "Amount": { "type": "number", "description": "Gets or sets the monetary amount of the infraction.", "format": "decimal" }, "PrincipalAmount": { "type": "number", "description": "Gets or sets the principal amount of the infraction (full fine value before discounts), when available.", "format": "decimal", "nullable": true }, "CurrentCollectionStatus": { "description": "Gets or sets the current collection status of the infraction.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/InfractionCollectionStatus" } ] }, "Booking": { "description": "Gets or sets the booking associated with this infraction.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Booking" } ] }, "Car": { "description": "Gets or sets the car associated with this infraction.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Car" } ] }, "Attachment": { "type": "string", "description": "Gets or sets the path to the attachment containing evidence of the infraction.", "nullable": true }, "Act": { "type": "string", "description": "Gets or sets the official act or document number associated with the infraction.", "nullable": true }, "InfractionNoticeId": { "type": "integer", "description": "Gets or sets the identifier of the InfractionNotice this infraction is linked to, if any (Brazil notice feature).", "format": "int32", "nullable": true } } }, "InfractionCollectionStatus": { "type": "object", "description": "Represents the collection status of an infraction.", "additionalProperties": false, "properties": { "Date": { "type": "string", "description": "Gets or sets the date when the collection status was last changed.", "format": "date-time" }, "Status": { "description": "Gets or sets the current status of the infraction collection.", "oneOf": [ { "$ref": "#/components/schemas/InfractionCollectionStatusEnum" } ] } } }, "InfractionCollectionStatusEnum": { "type": "integer", "description": "Represents the possible collection statuses of an infraction.\n\n| Value | Name | Description |\n| ---: | --- | --- |\n| 0 | `Collected` | The infraction has been successfully collected from the customer. |\n| 1 | `NotCollected` | The infraction has not yet been collected from the customer. |\n| 2 | `CollectionNotPossible` | It is not possible to collect payment for this infraction. |\n", "x-enumNames": [ "Collected", "NotCollected", "CollectionNotPossible" ], "enum": [ 0, 1, 2 ], "x-enumDescriptions": { "0": "The infraction has been successfully collected from the customer.", "1": "The infraction has not yet been collected from the customer.", "2": "It is not possible to collect payment for this infraction." } }, "PagedResultOfInfraction": { "type": "object", "description": "Represents a paginated result set of items.", "additionalProperties": false, "properties": { "Offset": { "type": "integer", "description": "Gets or sets the starting index of the current page of results.", "format": "int32" }, "Limit": { "type": "integer", "description": "Gets or sets the maximum number of items to return per page.", "format": "int32" }, "Total": { "type": "integer", "description": "Gets or sets the total number of items available across all pages.", "format": "int32" }, "Results": { "type": "array", "description": "Gets or sets the list of items in the current page.", "nullable": true, "items": { "$ref": "#/components/schemas/Infraction" } }, "NextOffset": { "type": "integer", "description": "Gets the next offset to call.", "format": "int32" } } }, "PayInfractionModel": { "type": "object", "description": "Represents a payment made for an infraction.", "additionalProperties": false, "required": [ "InfractionId", "GatewayId", "Amount" ], "properties": { "InfractionId": { "type": "integer", "description": "ID of the infraction to be paid", "format": "int32", "example": 123 }, "ExtraData": { "type": "string", "description": "Additional payment information in JSON format", "nullable": true, "example": { "reference": "INF123" } }, "CreditCardNumber": { "type": "string", "description": "Credit card number", "nullable": true, "example": 4111111111111111 }, "CreditCardExpirationMonth": { "type": "integer", "description": "Credit card expiration month (1-12)", "format": "int32", "example": 12 }, "CreditCardExpirationYear": { "type": "integer", "description": "Credit card expiration year", "format": "int32", "example": 2025 }, "CreditCardType": { "type": "string", "description": "Type of credit card (e.g., VISA, MASTERCARD)", "nullable": true, "example": "VISA" }, "CreditCardPlaceHolder": { "type": "string", "description": "Name of the credit card holder", "nullable": true, "example": "John Doe" }, "CreditCardCode": { "type": "string", "description": "Credit card security code (CVV)", "nullable": true, "example": 123 }, "TransactionId": { "type": "string", "description": "Payment gateway transaction ID", "nullable": true, "example": "TX123" }, "GatewayId": { "type": "string", "description": "Payment gateway identifier (ML, PL, TBANKCL, etc.)", "minLength": 1, "example": "ML" }, "Amount": { "type": "number", "description": "Payment amount in the specified currency", "format": "decimal", "minimum": 0.01, "example": 175.0 }, "payerID": { "type": "string", "description": "PayPal payer ID", "nullable": true, "example": "PAYERID123" }, "paymentToken": { "type": "string", "description": "PayPal payment token", "nullable": true, "example": "EC-1234567890" }, "CurrencyCode": { "type": "string", "description": "Currency code in ISO format (e.g., USD, EUR)", "nullable": true, "example": "USD" }, "ExchangeRate": { "type": "number", "description": "Exchange rate from payment currency to booking currency", "format": "decimal", "nullable": true, "example": 1.0 }, "BillingInformation": { "description": "Billing information for the payment", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BillingInformation" } ] }, "ReturnUrl": { "type": "string", "description": "URL to return to after payment processing", "nullable": true, "example": "https://example.com/payment/callback" } } }, "AddInfractionWithNoBookingResponse": { "type": "object", "additionalProperties": false, "properties": { "Id": { "type": "integer", "format": "int32" }, "CarId": { "type": "string", "nullable": true }, "BookingId": { "type": "integer", "format": "int32", "nullable": true }, "NotificationsSent": { "type": "boolean" }, "IsPaid": { "type": "boolean" }, "IsNew": { "type": "boolean" }, "SaveResult": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SaveInfractionResultResponse" } ] } } }, "SaveInfractionResultResponse": { "type": "object", "additionalProperties": false, "properties": { "Success": { "type": "boolean" }, "InfractionCreated": { "type": "boolean" }, "InfractionCharged": { "type": "boolean" }, "InfractionInvoiced": { "type": "boolean" }, "InfractionNotificationSent": { "type": "boolean" }, "BookingCommentAdded": { "type": "boolean" }, "Exception": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ExceptionResponse" } ] } } }, "ExceptionResponse": { "type": "object", "additionalProperties": false, "properties": { "Message": { "type": "string", "nullable": true }, "StackTrace": { "type": "array", "nullable": true, "items": { "type": "string" } } } }, "AddInfractionModelWithNoBooking": { "type": "object", "additionalProperties": false, "properties": { "Plate": { "type": "string", "nullable": true }, "Date": { "type": "string", "format": "date-time" }, "VoluntaryPaymentDueDate": { "type": "string", "format": "date-time", "nullable": true }, "Act": { "type": "string", "nullable": true }, "Amount": { "type": "number", "format": "decimal" }, "AmountAfterDueDate": { "type": "number", "format": "decimal", "nullable": true }, "PrincipalAmount": { "type": "number", "description": "Optional principal amount (full fine value before discounts). If omitted, it is initialized on creation from the reported amount (AmountAfterDueDate ?? Amount).", "format": "decimal", "minimum": 0.0, "nullable": true, "example": 200.0 }, "AmountToPay": { "type": "number", "description": "Optional amount to pay to the issuing entity. If omitted, it is resolved by fallback on read (no copy is persisted).", "format": "decimal", "minimum": 0.0, "nullable": true, "example": 120.0 }, "AmountToPayAfterDueDate": { "type": "number", "description": "Optional amount to pay to the issuing entity after the voluntary-payment deadline. If omitted, it is resolved by fallback on read.", "format": "decimal", "minimum": 0.0, "nullable": true, "example": 180.0 }, "Jurisdiction": { "type": "string", "nullable": true }, "InfractionType": { "type": "string", "nullable": true }, "InfractionTypeId": { "type": "integer", "format": "int32", "nullable": true }, "Notes": { "type": "string", "nullable": true }, "File": { "type": "string", "nullable": true }, "AdministrativeCharge": { "type": "number", "format": "decimal", "nullable": true }, "FileName": { "type": "string", "nullable": true }, "InfractionNoticeId": { "type": "integer", "description": "Optional InfractionNotice id to associate this infraction with (Brazil notice feature).", "format": "int32", "nullable": true, "example": 123 } } }, "TryChargeInfractionResponse": { "type": "object", "additionalProperties": false, "properties": { "IsSuccess": { "type": "boolean" }, "Message": { "type": "string", "nullable": true } } }, "MailNotificationTemplateModel": { "type": "object", "description": "Represents a mail notification template configuration", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Unique identifier of the mail notification template", "format": "int32" }, "Name": { "type": "string", "description": "Display name of the mail notification template", "nullable": true }, "From": { "type": "string", "description": "Default sender email address for notifications using this template", "nullable": true }, "MailAccountId": { "type": "integer", "description": "Identifier of the mailbox this template sends from", "format": "int32", "nullable": true }, "To": { "type": "string", "description": "Default recipient email address for notifications using this template", "nullable": true }, "ReplyTos": { "type": "string", "description": "Comma-separated list of reply-to email addresses", "nullable": true }, "EntityType": { "type": "string", "description": "Type of entity this notification template is associated with", "nullable": true }, "Description": { "type": "string", "description": "Detailed description of the mail notification template", "nullable": true } } }, "SendMailNotificacionResponse": { "type": "object", "description": "Represents the response from a mail notification request", "additionalProperties": false, "properties": { "NotificationId": { "type": "integer", "description": "Unique identifier of the created notification record", "format": "int32" } } }, "SendMailNotificacionRequest": { "allOf": [ { "$ref": "#/components/schemas/SendMailNotificacionRequestBase" }, { "type": "object", "description": "Represents a request to send a mail notification", "additionalProperties": false, "required": [ "MailNotificationId" ], "properties": { "MailNotificationId": { "type": "integer", "description": "Unique identifier of the mail notification template to be sent", "format": "int32", "minimum": 1.0 } } } ] }, "SendMailNotificacionRequestBase": { "type": "object", "description": " ", "additionalProperties": false, "required": [ "EntityId" ], "properties": { "EntityId": { "type": "string", "description": "Identifier of the entity associated with the notification", "minLength": 1 }, "SelectedLanguage": { "type": "string", "description": "Language code to be used for the notification template", "nullable": true }, "To": { "type": "string", "description": "Optional override for the notification recipient's email address", "nullable": true } } }, "OmieWebhookMessage": { "type": "object", "additionalProperties": false, "properties": { "messageId": { "type": "string", "format": "guid" }, "topic": { "type": "string", "nullable": true }, "author": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AuthorInfo" } ] }, "appKey": { "type": "string", "nullable": true }, "appHash": { "type": "string", "nullable": true }, "origin": { "type": "string", "nullable": true }, "event": { "nullable": true } } }, "AuthorInfo": { "type": "object", "additionalProperties": false, "properties": { "email": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "userId": { "type": "integer", "format": "int32" } } }, "DeliveryModel": { "type": "object", "description": "Represents the delivery information for a vehicle booking.", "additionalProperties": false, "properties": { "BookingId": { "type": "integer", "description": "The unique identifier of the booking associated with this delivery.", "format": "int32" }, "Kilometers": { "type": "integer", "description": "The current kilometer reading of the vehicle at delivery.", "format": "int32" }, "Gasoline": { "type": "integer", "description": "The fuel level percentage of the vehicle at delivery.", "format": "int32" }, "Notes": { "type": "string", "description": "Additional notes or observations about the vehicle condition at delivery.", "nullable": true }, "Verificator": { "type": "string", "description": "The name or identifier of the person verifying the delivery.", "nullable": true }, "MakeDelivery": { "type": "boolean", "description": "Flag indicating whether to proceed with the delivery process." }, "RunValidations": { "type": "boolean", "description": "Flag indicating whether to run validation checks during the delivery process." } } }, "ReturnModel": { "type": "object", "description": "Represents the return information for a vehicle booking.", "additionalProperties": false, "properties": { "BookingId": { "type": "integer", "description": "The unique identifier of the booking associated with this return.", "format": "int32" }, "Kilometers": { "type": "integer", "description": "The current kilometer reading of the vehicle at return.", "format": "int32" }, "Gasoline": { "type": "integer", "description": "The fuel level percentage of the vehicle at return.", "format": "int32" }, "Notes": { "type": "string", "description": "Additional notes or observations about the vehicle condition at return.", "nullable": true }, "Verificator": { "type": "string", "description": "The name or identifier of the person verifying the return.", "nullable": true }, "MakeReturn": { "type": "boolean", "description": "Flag indicating whether to proceed with the return process." }, "RunValidations": { "type": "boolean", "description": "Flag indicating whether to run validation checks during the return process." }, "Date": { "type": "string", "description": "The date and time of the vehicle return. If null, the current date and time will be used.", "format": "date-time", "nullable": true } } }, "UserProfile": { "type": "object", "description": "Represents a user's profile information including personal details and branch office associations", "additionalProperties": false, "properties": { "UserName": { "type": "string", "description": "The unique username of the user", "nullable": true, "example": "johndoe" }, "FullName": { "type": "string", "description": "The full name of the user", "nullable": true, "example": "John Doe" }, "Email": { "type": "string", "description": "The email address of the user", "nullable": true, "example": "john.doe@example.com" }, "ProfilePicture": { "type": "string", "description": "URL to the user's profile picture", "nullable": true, "example": "/Content/Images/ProfilePictures/johndoe.jpg" }, "CurrentBranchOffice": { "description": "The current branch office where the user is working", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BranchOffice" } ] }, "AvailableBranchOffices": { "type": "array", "description": "List of branch offices that the user has access to based on their roles", "nullable": true, "items": { "$ref": "#/components/schemas/BranchOffice" } }, "Roles": { "type": "array", "description": "List of roles assigned to the user", "nullable": true, "example": [ "Administrator", "Supervisor" ], "items": { "type": "string" } } } }, "Availability": { "type": "object", "description": "Represents the availability and pricing information for a car rental.", "additionalProperties": false, "properties": { "Car": { "description": "Gets or sets the car for which this availability information applies.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Car" } ] }, "Category": { "description": "Gets or sets the category to which the car belongs.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CategoryBase" } ] }, "FromDate": { "type": "string", "description": "Gets or sets the start date and time of the rental (in the branch's local time).", "format": "date-time" }, "ToDate": { "type": "string", "description": "Gets or sets the end date and time of the rental (in the branch's local time).", "format": "date-time" }, "DeliveryPlace": { "description": "Gets or sets the delivery location for the rental.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Place" } ] }, "ReturnPlace": { "description": "Gets or sets the return location for the rental.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Place" } ] }, "TotalDaysString": { "type": "string", "description": "Gets or sets the text representation of the total rental duration.", "nullable": true }, "Price": { "type": "number", "description": "Gets or sets the total price of the rental.", "format": "decimal" }, "AgencyPrice": { "type": "number", "description": "Gets or sets the total price to be paid by the agency.", "format": "decimal" }, "CustomerPrice": { "type": "number", "description": "Gets or sets the total price to be paid by the customer.", "format": "decimal" }, "Franchise": { "type": "number", "description": "Gets or sets the franchise amount to be blocked during the rental.", "format": "decimal" }, "FranchiseDamage": { "type": "number", "description": "Gets or sets the damage franchise amount based on the selected category/model.", "format": "decimal" }, "FranchiseRollover": { "type": "number", "description": "Gets or sets the rollover franchise amount based on the selected category/model.", "format": "decimal" }, "FranchiseTheft": { "type": "number", "description": "Gets or sets the theft franchise amount based on the selected category/model.", "format": "decimal" }, "FranchiseHail": { "type": "number", "description": "Gets or sets the hail damage franchise amount based on the selected category/model.", "format": "decimal" }, "TotalDays": { "type": "number", "description": "Gets or sets the total number of rental days (including half-days).", "format": "decimal" }, "IlimitedKm": { "type": "boolean", "description": "Gets or sets a value indicating whether the rental includes unlimited mileage." }, "MaxAllowedDistance": { "type": "integer", "description": "Gets or sets the maximum allowed distance for the rental.", "format": "int32" }, "MaxAllowedDistanceByDay": { "type": "integer", "description": "Gets or sets the maximum allowed distance per day for the rental.", "format": "int32" }, "HasFranchiseModifiers": { "type": "boolean", "description": "Gets or sets a value indicating whether there are any modifications to the franchise amounts." }, "WillLeaveCountry": { "type": "boolean", "description": "Gets or sets a value indicating whether the vehicle will leave the country during the rental.", "nullable": true }, "AverageDayPrice": { "type": "number", "description": "Gets or sets the average daily price of the rental.", "format": "decimal" }, "PriceItems": { "type": "array", "description": "Gets or sets the detailed breakdown of the rental price.", "nullable": true, "items": { "$ref": "#/components/schemas/ItemPrice" } }, "Additionals": { "type": "array", "description": "Gets or sets the list of additional services included in the rental.", "nullable": true, "items": { "$ref": "#/components/schemas/BookingAdditional" } }, "AdditionalsPrice": { "type": "array", "description": "Gets or sets the list of additional services with detailed pricing information.", "nullable": true, "items": { "$ref": "#/components/schemas/AdditionalPriceItem" } }, "AvailablePromotions": { "type": "array", "description": "Gets or sets the list of available promotions with their pricing information.", "nullable": true, "items": { "$ref": "#/components/schemas/PromotionPriceItem" } }, "Currency": { "type": "string", "description": "Gets or sets the currency in which the rental price is displayed.", "nullable": true }, "WebDeepLink": { "type": "string", "description": "Gets or sets the deep link to the customer's web page for completing the purchase.", "nullable": true }, "OnlyQuote": { "type": "boolean", "description": "Gets or sets a value indicating whether this is only a quote and not an actual booking." }, "SalesCommision": { "type": "number", "description": "Gets or sets the sales commission for agencies or external systems.", "format": "decimal" }, "PriceDetails": { "description": "Gets or sets the detailed price breakdown between different payers (customer and agency).", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PriceDetails" } ] }, "DistanceUnit": { "type": "string", "description": "Gets or sets the distance unit configured in this tenant", "nullable": true }, "BookingOrigin": { "description": "Origen de la reserva", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BookingOrigin" } ] }, "Brand": { "description": "The brand or company associated with the booking", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BookingBrand" } ] } } }, "AdditionalPriceItem": { "type": "object", "description": "Represents the pricing information for an additional item in a booking.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the additional item.", "format": "int32" }, "Name": { "type": "string", "description": "Gets or sets the name of the additional item.", "nullable": true }, "Description": { "type": "string", "description": "Gets or sets the description of the additional item.", "nullable": true }, "ImagePath": { "type": "string", "description": "Gets or sets the URL to the image representing the additional item.", "nullable": true }, "IsPriceByDay": { "type": "boolean", "description": "Gets or sets a value indicating whether the price is calculated per day." }, "Price": { "type": "number", "description": "Gets or sets the total price including taxes.", "format": "decimal" }, "Taxes": { "type": "number", "description": "Gets or sets the amount of taxes applied to the price.", "format": "decimal" }, "PriceWithoutTaxes": { "type": "number", "description": "Gets or sets the price before taxes are applied.", "format": "decimal" }, "DailyPrice": { "type": "number", "description": "Gets or sets the daily price of the additional item when IsPriceByDay is true.", "format": "decimal" }, "MaxQuantityPerBooking": { "type": "integer", "description": "Gets or sets the maximum quantity allowed per booking.", "format": "int32" }, "Currency": { "type": "string", "description": "Gets or sets the ISO code of the currency used for pricing.", "nullable": true }, "AvailableStock": { "type": "integer", "description": "Gets or sets the available stock for the selected dates.", "format": "int32" }, "Type": { "type": "string", "description": "Gets or sets the category or type of the additional item.", "nullable": true }, "IsRequired": { "type": "boolean", "description": "Gets or sets a value indicating whether this additional item is mandatory for the booking." }, "IsDefault": { "type": "boolean", "description": "Gets or sets a value indicating whether this additional item is selected by default." }, "Excludes": { "type": "array", "description": "Gets or sets the list of additional item IDs that are excluded when this item is selected.", "nullable": true, "items": { "type": "integer", "format": "int32" } }, "Order": { "type": "number", "description": "Gets or sets the display order of the additional item in the list.", "format": "decimal" } } }, "CustomerRequestModel": { "type": "object", "description": "Representa el modelo de cliente", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Id del cliente", "format": "int32" }, "GlobalId": { "type": "string", "description": "Id global del cliente", "format": "guid" }, "Name": { "type": "string", "description": "Nombre del cliente", "nullable": true }, "LastName": { "type": "string", "description": "Apellido del cliente", "nullable": true }, "DocumentId": { "type": "string", "description": "Numero de documento del cliente", "nullable": true }, "DocumentType": { "type": "string", "description": "Tipo de documento del cliente", "nullable": true }, "EmailAddress": { "type": "string", "description": "Mail del cliente", "nullable": true }, "Address": { "type": "string", "description": "Direccion del cliente", "nullable": true }, "FullName": { "type": "string", "description": "Nombre completo del cliente", "nullable": true } } }, "Rate": { "type": "object", "description": "Request/response model for a booking tariff (rate), including its price matrix.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the rate. Ignored on creation.", "format": "int32" }, "Name": { "type": "string", "description": "Gets or sets the display name of the rate.", "nullable": true }, "Code": { "type": "string", "description": "Gets or sets the business code that identifies the rate. Used as the key for upsert operations.", "nullable": true }, "IsActive": { "type": "boolean", "description": "Gets or sets a value indicating whether the rate is active. Defaults to true.\nSending false on create/update is rejected: rates are deactivated through the DELETE operation." }, "ValidFrom": { "type": "string", "description": "Gets or sets the date from which the rate is valid.", "format": "date-time", "nullable": true }, "ValidTo": { "type": "string", "description": "Gets or sets the date until which the rate is valid.", "format": "date-time", "nullable": true }, "CurrencyId": { "type": "integer", "description": "Gets or sets the identifier of the currency the rate prices are expressed in.", "format": "int32", "nullable": true }, "MinDays": { "type": "integer", "description": "Gets or sets the minimum number of rental days the rate applies to.", "format": "int32", "nullable": true }, "MaxDays": { "type": "integer", "description": "Gets or sets the maximum number of rental days the rate applies to.", "format": "int32", "nullable": true }, "ValidPickupDays": { "type": "integer", "description": "Gets or sets the bitmask of week days on which a pickup is valid for this rate.", "format": "int32", "nullable": true }, "ValidDropoffDays": { "type": "integer", "description": "Gets or sets the bitmask of week days on which a dropoff is valid for this rate.", "format": "int32", "nullable": true }, "AvailableForManualSelection": { "type": "boolean", "description": "Gets or sets a value indicating whether the rate can be selected manually on a booking." }, "OnlyAvailableForManualSelection": { "type": "boolean", "description": "Gets or sets a value indicating whether the rate is only available for manual selection." }, "CutByDistanceMode": { "description": "Gets or sets how the rate cuts prices by distance.", "oneOf": [ { "$ref": "#/components/schemas/RateCutByDistanceMode" } ] }, "ParentId": { "type": "integer", "description": "Gets or sets the identifier of the parent rate. When set, prices are inherited from the parent\nand the Prices collection is ignored.", "format": "int32", "nullable": true }, "IncrementOverParent": { "type": "number", "description": "Gets or sets the percentage increment applied over the parent rate prices. Only used when\nParentId is set.", "format": "decimal", "nullable": true }, "ModelIds": { "type": "array", "description": "Gets or sets the identifiers of the models the rate applies to. Empty means all models.", "nullable": true, "items": { "type": "integer", "format": "int32" } }, "CategoryIds": { "type": "array", "description": "Gets or sets the identifiers of the categories the rate applies to. Empty means all categories.", "nullable": true, "items": { "type": "integer", "format": "int32" } }, "BranchOfficeIds": { "type": "array", "description": "Gets or sets the identifiers of the branch offices the rate applies to. Empty means all branch offices.", "nullable": true, "items": { "type": "integer", "format": "int32" } }, "BookingBrandIds": { "type": "array", "description": "Gets or sets the identifiers of the booking brands the rate applies to. Empty means all brands.", "nullable": true, "items": { "type": "integer", "format": "int32" } }, "Prices": { "type": "array", "description": "Gets or sets the price matrix of the rate. Each entry targets a model or a category.\nOn create/update (POST/PUT) this is the full matrix and replaces any existing one — omitting it clears\nevery price. To edit individual cells without touching the rest, use PATCH /api/rates/{id}/prices.", "nullable": true, "items": { "$ref": "#/components/schemas/RatePrice" } } } }, "RateCutByDistanceMode": { "type": "integer", "description": "How a rate cuts prices by distance. Mirrors the core CutByDistanceModeEnum.\n\n| Value | Name | Description |\n| ---: | --- | --- |\n| 0 | `IndividualCuts` | Distance cuts are defined individually. |\n| 1 | `DependentOnDays` | Distance cuts depend on the number of days. |\n", "x-enumNames": [ "IndividualCuts", "DependentOnDays" ], "enum": [ 0, 1 ], "x-enumDescriptions": { "0": "Distance cuts are defined individually.", "1": "Distance cuts depend on the number of days." } }, "RatePrice": { "type": "object", "description": "A single cell of a rate price matrix, targeting either a model or a category.", "additionalProperties": false, "properties": { "ModelId": { "type": "integer", "description": "Gets or sets the identifier of the model this price applies to. Set this for model-based tenants.", "format": "int32", "nullable": true }, "CategoryId": { "type": "integer", "description": "Gets or sets the identifier of the category this price applies to. Set this for category-based tenants.", "format": "int32", "nullable": true }, "UnitOfTimeType": { "description": "Gets or sets the unit of time the price range is expressed in.", "oneOf": [ { "$ref": "#/components/schemas/RateUnitOfTimeType" } ] }, "UnitOfTimeFrom": { "type": "integer", "description": "Gets or sets the lower bound (inclusive) of the time range.", "format": "int32" }, "UnitOfTimeTo": { "type": "integer", "description": "Gets or sets the upper bound (inclusive) of the time range.", "format": "int32" }, "UnitOfDistanceFrom": { "type": "integer", "description": "Gets or sets the lower bound (inclusive) of the distance range.", "format": "int32" }, "UnitOfDistanceTo": { "type": "integer", "description": "Gets or sets the upper bound (inclusive) of the distance range. Null means unlimited.", "format": "int32", "nullable": true }, "Price": { "type": "number", "description": "Gets or sets the price for this cell.", "format": "decimal" } } }, "RateUnitOfTimeType": { "type": "integer", "description": "Unit of time a rate price range is expressed in. Mirrors the core UnitOfTimeTypeEnum.\n\n| Value | Name | Description |\n| ---: | --- | --- |\n| 0 | `Days` | Price range expressed in days. |\n| 1 | `Hours` | Price range expressed in hours. |\n", "x-enumNames": [ "Days", "Hours" ], "enum": [ 0, 1 ], "x-enumDescriptions": { "0": "Price range expressed in days.", "1": "Price range expressed in hours." } }, "PagedResultOfCar": { "type": "object", "description": "Represents a paginated result set of items.", "additionalProperties": false, "properties": { "Offset": { "type": "integer", "description": "Gets or sets the starting index of the current page of results.", "format": "int32" }, "Limit": { "type": "integer", "description": "Gets or sets the maximum number of items to return per page.", "format": "int32" }, "Total": { "type": "integer", "description": "Gets or sets the total number of items available across all pages.", "format": "int32" }, "Results": { "type": "array", "description": "Gets or sets the list of items in the current page.", "nullable": true, "items": { "$ref": "#/components/schemas/Car" } }, "NextOffset": { "type": "integer", "description": "Gets the next offset to call.", "format": "int32" } } }, "CarTransferReturn": { "type": "object", "description": "Represents the result of a vehicle transfer operation.", "additionalProperties": false, "properties": { "Success": { "type": "boolean", "description": "Gets or sets a value indicating whether the transfer was successful." }, "BookingId": { "type": "integer", "description": "Gets or sets the identifier of the booking created for this transfer.", "format": "int32", "nullable": true } } }, "CarRealocate": { "type": "object", "description": "Represents a car relocation request, moving a car from its current location to a new branch office.", "additionalProperties": false, "required": [ "CarId" ], "properties": { "CarId": { "type": "string", "description": "Gets or sets the unique identifier of the car to be relocated.", "minLength": 1, "example": "ABC123" }, "PlaceId": { "type": "integer", "description": "Gets or sets the identifier of the destination place where the car will be relocated.", "format": "int32", "example": 1 }, "DriverId": { "type": "integer", "description": "Gets or sets the identifier of the driver who will perform the relocation.", "format": "int32", "nullable": true, "example": 42 }, "Km": { "type": "integer", "description": "Gets or sets the current kilometers reading of the car at the time of relocation.", "format": "int32", "example": 50000 }, "Gasoline": { "type": "integer", "description": "Gets or sets the fuel level of the car at the time of relocation (0-100).", "format": "int32", "example": 75 } } }, "CarTransfer": { "type": "object", "description": "Represents a vehicle transfer request between locations.", "additionalProperties": false, "required": [ "CarId", "FromDate", "ToDate" ], "properties": { "CarId": { "type": "string", "description": "Gets or sets the unique identifier of the vehicle to be transferred.", "minLength": 1 }, "FromDate": { "type": "string", "description": "Gets or sets the start date and time of the transfer.", "format": "date-time" }, "ToDate": { "type": "string", "description": "Gets or sets the expected completion date and time of the transfer.", "format": "date-time" }, "PlaceId": { "type": "integer", "description": "Gets or sets the identifier of the destination location.", "format": "int32" }, "DriverId": { "type": "integer", "description": "Gets or sets the identifier of the driver assigned to perform the transfer.", "format": "int32", "nullable": true } } }, "PlaceType": { "type": "object", "description": "Represents a type of pickup/dropoff location.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the place type.", "format": "int32" }, "Name": { "type": "string", "description": "Gets or sets the name of the place type.", "nullable": true } } }, "BranchOffice2": { "type": "object", "description": "Represents a branch office in the rental system.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the branch office.", "format": "int32" }, "BusinessName": { "type": "string", "description": "Gets or sets the legal business name of the branch office.", "nullable": true }, "Name": { "type": "string", "description": "Gets or sets the display name of the branch office.", "nullable": true }, "Street": { "type": "string", "description": "Gets or sets the street name of the branch office address.", "nullable": true }, "Number": { "type": "string", "description": "Gets or sets the street number of the branch office address.", "nullable": true }, "Door": { "type": "string", "description": "Gets or sets the door or apartment number of the branch office address.", "nullable": true }, "City": { "type": "string", "description": "Gets or sets the city where the branch office is located.", "nullable": true }, "Country": { "type": "string", "description": "Gets or sets the country where the branch office is located.", "nullable": true }, "PostalCode": { "type": "string", "description": "Gets or sets the postal or ZIP code of the branch office address.", "nullable": true }, "Latitude": { "type": "number", "description": "Gets or sets the latitude coordinate of the branch office location.", "format": "decimal" }, "Longitude": { "type": "number", "description": "Gets or sets the longitude coordinate of the branch office location.", "format": "decimal" }, "Telephone": { "type": "string", "description": "Gets or sets the primary telephone number of the branch office.", "nullable": true }, "GuardTelephone": { "type": "string", "description": "Gets or sets the emergency or after-hours contact number for the branch office.", "nullable": true }, "Email": { "type": "string", "description": "Gets or sets the email address for contacting the branch office.", "nullable": true }, "IATACode": { "type": "string", "description": "Gets or sets the International Air Transport Association (IATA) code for the branch office.", "nullable": true }, "IsFranchise": { "type": "boolean", "description": "Gets or sets a value indicating whether this branch office operates as a franchise." }, "PublicWebSite": { "type": "string", "description": "Gets or sets the public website URL for the branch office.", "nullable": true } } }, "Holiday": { "type": "object", "description": "Represents a holiday or special date in the system.", "additionalProperties": false, "properties": { "Date": { "type": "string", "description": "Gets or sets the date of the holiday.", "format": "date-time" }, "Description": { "type": "string", "description": "Gets or sets the description or name of the holiday.", "nullable": true }, "Ids": { "type": "array", "description": "Gets or sets the list of branch office IDs where this holiday is observed.", "nullable": true, "items": { "type": "integer", "format": "int32" } } } }, "AttentionSchedule": { "type": "object", "description": "Represents the attention schedule for a specific location.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the branch office.", "format": "int32" }, "Schedule": { "description": "Gets or sets the schedule configuration for different days of the week and holidays.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AttentionScheduleDays" } ] }, "TimezoneId": { "type": "string", "description": "Gets or sets the time zone identifier for the location.", "nullable": true }, "TimezoneUTCOffset": { "type": "string", "description": "Gets or sets the UTC offset for the location's time zone.", "format": "duration" }, "GapForBookingTime": { "type": "integer", "description": "Gets or sets the time gap in minutes between available booking slots.", "format": "int32" }, "Gap": { "type": "integer", "description": "Gets or sets the time gap in hours for external systems.", "format": "int32" }, "AllowAfterHours": { "type": "boolean", "description": "Gets or sets a value indicating whether the location operates outside regular business hours." }, "BeforeHoursMaxMinutes": { "type": "integer", "description": "Gets or sets the maximum number of minutes allowed for deliveries/returns before opening hours.", "format": "int32" }, "AfterHoursMaxMinutes": { "type": "integer", "description": "Gets or sets the maximum number of minutes allowed for deliveries/returns after closing hours.", "format": "int32" }, "ChangeOfDayWithFixedSchedule": { "type": "boolean", "description": "Gets or sets a value indicating whether the location uses a fixed schedule for day changes." }, "CheckOutTime": { "type": "string", "description": "Gets or sets the fixed check-out time for the location.", "format": "duration", "nullable": true } } }, "AttentionScheduleDays": { "type": "object", "description": "Represents the attention schedule for different days of the week and holidays.", "additionalProperties": false, "properties": { "Monday": { "type": "array", "description": "Gets or sets the schedule ranges for Monday.", "nullable": true, "items": { "$ref": "#/components/schemas/AttentionScheduleRange" } }, "Tuesday": { "type": "array", "description": "Gets or sets the schedule ranges for Tuesday.", "nullable": true, "items": { "$ref": "#/components/schemas/AttentionScheduleRange" } }, "Wednesday": { "type": "array", "description": "Gets or sets the schedule ranges for Wednesday.", "nullable": true, "items": { "$ref": "#/components/schemas/AttentionScheduleRange" } }, "Thursday": { "type": "array", "description": "Gets or sets the schedule ranges for Thursday.", "nullable": true, "items": { "$ref": "#/components/schemas/AttentionScheduleRange" } }, "Friday": { "type": "array", "description": "Gets or sets the schedule ranges for Friday.", "nullable": true, "items": { "$ref": "#/components/schemas/AttentionScheduleRange" } }, "Saturday": { "type": "array", "description": "Gets or sets the schedule ranges for Saturday.", "nullable": true, "items": { "$ref": "#/components/schemas/AttentionScheduleRange" } }, "Sunday": { "type": "array", "description": "Gets or sets the schedule ranges for Sunday.", "nullable": true, "items": { "$ref": "#/components/schemas/AttentionScheduleRange" } }, "Holiday": { "type": "array", "description": "Gets or sets the schedule ranges for holidays.", "nullable": true, "items": { "$ref": "#/components/schemas/AttentionScheduleRange" } }, "ScheduleDates": { "type": "array", "description": "Gets or sets the list of date-specific schedules.", "nullable": true, "items": { "$ref": "#/components/schemas/AttentionScheduleDates" } }, "ClosedDays": { "type": "array", "description": "Gets or sets the list of dates when the location is closed.", "nullable": true, "items": { "type": "string", "format": "date-time" } } } }, "AttentionScheduleRange": { "type": "object", "description": "Represents a time range within an attention schedule.", "additionalProperties": false, "properties": { "OpenedFrom": { "type": "string", "description": "Gets or sets the time when the location opens for this range.", "format": "duration" }, "OpenedTo": { "type": "string", "description": "Gets or sets the time when the location closes for this range.", "format": "duration" } } }, "AttentionScheduleDates": { "type": "object", "description": "Represents a specific date's attention schedule.", "additionalProperties": false, "properties": { "Date": { "type": "string", "description": "Gets or sets the specific date for this schedule.", "format": "date-time" }, "Range": { "type": "array", "description": "Gets or sets the list of time ranges for this date.", "nullable": true, "items": { "$ref": "#/components/schemas/AttentionScheduleRange" } } } }, "Category": { "allOf": [ { "$ref": "#/components/schemas/CategoryBase" }, { "type": "object", "description": "Represents a vehicle category with its associated models.", "additionalProperties": false, "properties": { "Models": { "type": "array", "description": "Gets or sets the list of vehicle models that belong to this category.", "nullable": true, "items": { "$ref": "#/components/schemas/Model" } } } } ] }, "Promotion": { "type": "object", "description": "Represents a promotional offer in the system.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the promotion.", "format": "int32" }, "Name": { "type": "string", "description": "Gets or sets the name of the promotion.", "nullable": true }, "Description": { "type": "string", "description": "Gets or sets the detailed description of the promotion.", "nullable": true }, "ImagePath": { "type": "string", "description": "Gets or sets the absolute path to the promotion's image.", "nullable": true }, "Order": { "type": "number", "description": "Gets or sets the order of importance for displaying promotions.", "format": "decimal" }, "Models": { "type": "array", "description": "Gets or sets the list of vehicle models to which the promotion applies.", "nullable": true, "items": { "$ref": "#/components/schemas/ModelBase" } }, "AcceptedPaymentTypes": { "type": "array", "description": "Gets or sets the list of payment types accepted for this promotion.", "nullable": true, "items": { "$ref": "#/components/schemas/PaymentType" } }, "ValidForPayment": { "description": "Gets or sets the valid payment type for the promotion.", "oneOf": [ { "$ref": "#/components/schemas/ValidPaymentTypeEnum" } ] } } }, "Currency": { "type": "object", "description": "Represents a currency that can be used on the system", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Unique identifier of the currency", "format": "int32" }, "Name": { "type": "string", "description": "Friendly name of the currency", "nullable": true }, "Symbol": { "type": "string", "description": "Symbol used on the system for the currency", "nullable": true }, "ExchangeRate": { "type": "number", "description": "Current exchange rate for the currency", "format": "decimal" }, "IsSystemDefault": { "type": "boolean", "description": "If the currency is the default for the system" }, "ISOCode": { "type": "string", "description": "ISO Code of the currency", "nullable": true } } }, "Service": { "type": "object", "description": "Represents a complete vehicle service record.", "additionalProperties": false, "required": [ "ServiceType", "FromDate", "ToDate", "Status" ], "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the service record.", "format": "int32" }, "CarId": { "type": "string", "description": "Gets or sets the unique identifier of the vehicle receiving service.", "nullable": true }, "Km": { "type": "integer", "description": "Gets or sets the current odometer reading in kilometers.", "format": "int32" }, "ServiceType": { "description": "Gets or sets the type of service being performed.", "oneOf": [ { "$ref": "#/components/schemas/ServiceType" } ] }, "Notes": { "type": "string", "description": "Gets or sets additional notes or comments about the service.", "nullable": true }, "FromDate": { "type": "string", "description": "Gets or sets the start date of the service.", "format": "date-time" }, "ToDate": { "type": "string", "description": "Gets or sets the completion date of the service.", "format": "date-time" }, "Status": { "description": "Gets or sets the current status of the service.", "oneOf": [ { "$ref": "#/components/schemas/ServiceStatusEnum" } ] }, "Provider": { "description": "Gets or sets the service provider information.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Provider" } ] }, "Price": { "type": "number", "description": "Gets or sets the cost of the service.", "format": "decimal" }, "IsFixed": { "type": "boolean", "description": "Gets or sets a value indicating whether this is a fixed service schedule." }, "IsLockedForEdit": { "type": "boolean", "description": "Gets or sets a value indicating whether the service record can be edited." } } }, "ServiceType": { "type": "object", "description": "Represents a type of vehicle service or maintenance.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the service type.", "format": "int32" }, "Name": { "type": "string", "description": "Gets or sets the name or description of the service type.", "nullable": true } } }, "ServiceStatusEnum": { "type": "integer", "description": "\n\n| Value | Name | Description |\n| ---: | --- | --- |\n| 0 | `Programed` | — |\n| 1 | `InExecution` | — |\n| 2 | `Finished` | — |\n| 3 | `Canceled` | — |\n", "x-enumNames": [ "Programed", "InExecution", "Finished", "Canceled" ], "enum": [ 0, 1, 2, 3 ], "x-enumDescriptions": { "0": "", "1": "", "2": "", "3": "" } }, "Provider": { "type": "object", "description": "Represents a service provider.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the service provider.", "format": "int32" }, "Name": { "type": "string", "description": "Gets or sets the name of the service provider.", "nullable": true } } }, "CreateService": { "allOf": [ { "$ref": "#/components/schemas/ServiceBase" }, { "type": "object", "description": "Represents a model for creating a new vehicle service record.", "additionalProperties": false, "required": [ "CarId" ], "properties": { "CarId": { "type": "string", "description": "Gets or sets the unique identifier of the vehicle receiving service.", "minLength": 1 } } } ] }, "ServiceBase": { "type": "object", "description": "Represents the base class for service-related operations.", "additionalProperties": false, "required": [ "Km", "ServiceTypeId", "FromDate", "ToDate", "Status" ], "properties": { "Km": { "type": "integer", "description": "Gets or sets the current odometer reading in kilometers.", "format": "int32" }, "ServiceTypeId": { "type": "integer", "description": "Gets or sets the type of service being performed.", "format": "int32" }, "Notes": { "type": "string", "description": "Gets or sets additional notes or comments about the service.", "nullable": true }, "FromDate": { "type": "string", "description": "Gets or sets the start date of the service.", "format": "date-time" }, "ToDate": { "type": "string", "description": "Gets or sets the completion date of the service.", "format": "date-time" }, "Status": { "description": "Gets or sets the current status of the service.", "oneOf": [ { "$ref": "#/components/schemas/ServiceStatusEnum" } ] }, "ProviderId": { "type": "integer", "description": "Gets or sets the identifier of the service provider.", "format": "int32", "nullable": true }, "Price": { "type": "number", "description": "Gets or sets the cost of the service.", "format": "decimal" }, "IsFixed": { "type": "boolean", "description": "Gets or sets a value indicating whether this is a fixed service schedule." }, "IsLockedForEdit": { "type": "boolean", "description": "Gets or sets a value indicating whether the service record can be edited." } } }, "UpdateService": { "allOf": [ { "$ref": "#/components/schemas/ServiceBase" }, { "type": "object", "description": "Represents a model for updating an existing vehicle service record.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the service record.", "format": "int32" }, "CarId": { "type": "string", "description": "Gets or sets the unique identifier of the vehicle receiving service.", "nullable": true } } } ] }, "ApiFileModel": { "type": "object", "description": "Represents a file model used for API file uploads and transfers.", "additionalProperties": false, "properties": { "FileName": { "type": "string", "description": "The name of the file, including its extension.", "nullable": true }, "Base64File": { "type": "string", "description": "The content of the file encoded in Base64 format.\nThis encoding ensures safe transmission of binary data through text-based protocols.", "nullable": true } } }, "Agency2": { "type": "object", "description": " ", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Agency ID", "format": "int32" }, "IATACode": { "type": "string", "description": "Ageancy IATA code", "nullable": true }, "Name": { "type": "string", "description": "Agency Name", "nullable": true }, "GlobalId": { "type": "string", "description": "Globa Id of the agency", "nullable": true } } }, "BookingBrand2": { "type": "object", "additionalProperties": false, "properties": { "Id": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "nullable": true }, "Code": { "type": "string", "nullable": true }, "LogoImageUrl": { "type": "string", "nullable": true }, "PrimaryColor": { "type": "string", "nullable": true }, "SecondaryColor": { "type": "string", "nullable": true } } }, "Category2": { "type": "object", "description": "Base OData category without navigation properties to avoid circular references", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the vehicle category.", "format": "int32" }, "Name": { "type": "string", "description": "Gets or sets the name of the vehicle category.", "nullable": true }, "Order": { "type": "number", "description": "Gets or sets the display order of the category in lists and menus.", "format": "decimal" }, "PrincipalModelId": { "type": "integer", "description": "Gets or sets the identifier of the principal model representing this category.", "format": "int32", "nullable": true }, "PrincipalModel": { "description": "Gets or sets the principal model that represents this category.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Model2" } ] }, "Franchise": { "type": "number", "description": "Gets or sets the base deposit amount required for vehicles in this category.", "format": "decimal" }, "FranchiseDamage": { "type": "number", "description": "Gets or sets the deposit amount for damage coverage in this category.", "format": "decimal" }, "FranchiseRollover": { "type": "number", "description": "Gets or sets the deposit amount for rollover coverage in this category.", "format": "decimal" }, "FranchiseTheft": { "type": "number", "description": "Gets or sets the deposit amount for theft coverage in this category.", "format": "decimal" }, "FranchiseHail": { "type": "number", "description": "Gets or sets the deposit amount for hail damage coverage in this category.", "format": "decimal" }, "ImagePath": { "type": "string", "description": "Gets or sets the absolute path to the image representing this category.", "nullable": true }, "AvailableForExternalSystems": { "type": "boolean", "description": "Gets or sets a value indicating whether this category is available for external systems and integrations." }, "IsInactiveActiveOrDeleted": { "type": "boolean", "description": "Gets or sets a value indicating whether this category is inactive or deleted." } } }, "Model2": { "type": "object", "description": "OData-specific car model optimized for efficient queries", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the car model", "format": "int32" }, "Name": { "type": "string", "description": "Gets or sets the name of the car model", "nullable": true }, "SIPP": { "type": "string", "description": "Gets or sets the SIPP code for the model", "nullable": true }, "Description": { "type": "string", "description": "Gets or sets the detailed description of the car model", "nullable": true }, "ImagePath": { "type": "string", "description": "Gets or sets the absolute path to the model's image", "nullable": true }, "Franchise": { "type": "number", "description": "Gets or sets the standard deposit amount required for this model", "format": "decimal" }, "FranchiseDamage": { "type": "number", "description": "Gets or sets the deposit amount for damage coverage", "format": "decimal" }, "FranchiseRollover": { "type": "number", "description": "Gets or sets the deposit amount for rollover coverage", "format": "decimal" }, "FranchiseTheft": { "type": "number", "description": "Gets or sets the deposit amount for theft coverage", "format": "decimal" }, "FranchiseHail": { "type": "number", "description": "Gets or sets the deposit amount for hail damage coverage", "format": "decimal" }, "Doors": { "type": "integer", "description": "Gets or sets the number of doors in the vehicle", "format": "int32" }, "Passengers": { "type": "integer", "description": "Gets or sets the maximum number of passengers the vehicle can accommodate", "format": "int32" }, "BigLuggage": { "type": "integer", "description": "Gets or sets the number of large luggage items the vehicle can carry", "format": "int32" }, "SmallLuggage": { "type": "integer", "description": "Gets or sets the number of small luggage items the vehicle can carry", "format": "int32" }, "Steering": { "type": "string", "description": "Gets or sets the type of steering system", "nullable": true }, "SteeringType": { "description": "Gets or sets the normalized steering type enum", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SteeringType" } ] }, "Gearbox": { "type": "string", "description": "Gets or sets the type of gearbox/transmission", "nullable": true }, "TransmissionType": { "description": "Gets or sets the normalized transmission type enum", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TransmissionType" } ] }, "Multimedia": { "type": "string", "description": "Gets or sets the type of multimedia system", "nullable": true }, "AirConditioner": { "type": "string", "description": "Gets or sets the type of air conditioning system", "nullable": true }, "AirConditionerType": { "description": "Gets or sets the normalized air conditioner type enum", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AirConditionerType" } ] }, "FuelType": { "description": "Gets or sets the fuel type of the model", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FuelTypeEnum" } ] }, "DailyPrice": { "type": "number", "description": "Gets or sets the daily rental price for a 2-day rental without promotions", "format": "decimal" }, "LowerPrice": { "type": "number", "description": "Gets or sets the lowest price in the tariff without considering distance or cuts", "format": "decimal" }, "CreationDate": { "type": "string", "description": "Gets or sets the date when the model was created in the system", "format": "date-time" }, "Brand": { "description": "Gets or sets the brand information for this model", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Brand2" } ] }, "ModelAttributes": { "type": "array", "description": "Gets or sets the customizable attributes of the model", "nullable": true, "items": { "$ref": "#/components/schemas/ModelAttribute2" } }, "Category": { "description": "Gets or sets the category to which this model belongs.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Category2" } ] }, "AvailableForExternalSystems": { "type": "boolean", "description": "Gets or sets a value indicating whether this model is available for external systems and integrations." }, "IsInactiveActiveOrDeleted": { "type": "boolean", "description": "Gets or sets a value indicating whether this model is inactive or deleted." } } }, "Brand2": { "type": "object", "description": "OData-specific brand model optimized for efficient queries", "additionalProperties": false, "properties": { "Id": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "description": "Gets or sets the name of the vehicle manufacturer brand.", "nullable": true } } }, "ModelAttribute2": { "type": "object", "description": "OData-specific model attribute optimized for efficient queries", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the model attribute", "format": "int32" }, "Name": { "type": "string", "description": "Gets or sets the name of the attribute", "nullable": true }, "Description": { "type": "string", "description": "Gets or sets the description of the attribute", "nullable": true }, "Type": { "description": "Gets or sets the type of the attribute", "oneOf": [ { "$ref": "#/components/schemas/ModelAttributeTypeEnum2" } ] }, "Unit": { "type": "string", "description": "Gets or sets the unit of measurement for the attribute", "nullable": true }, "Value": { "type": "string", "description": "Gets or sets the value of the attribute", "nullable": true }, "ModelId": { "type": "integer", "description": "Gets or sets the model identifier this attribute belongs to", "format": "int32" } } }, "ModelAttributeTypeEnum2": { "type": "integer", "description": "Enumeration for model attribute types", "x-enumNames": [ "Text", "Number", "Boolean", "Date" ], "enum": [ 0, 1, 2, 3 ] }, "Customer2": { "type": "object", "description": "Represents a customer entity for OData queries.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the customer.", "format": "int32" }, "GlobalId": { "type": "string", "description": "Gets or sets the global unique identifier of the customer.", "nullable": true }, "Firstname": { "type": "string", "description": "Gets or sets the first name of the customer.", "nullable": true }, "Lastname": { "type": "string", "description": "Gets or sets the last name of the customer.", "nullable": true }, "EmailAddress": { "type": "string", "description": "Gets or sets the email address of the customer.", "nullable": true }, "PriceAgreementId": { "type": "integer", "description": "Gets or sets the identifier of the price agreement assigned to the customer, when any.", "format": "int32", "nullable": true } } }, "Booking2": { "type": "object", "description": "OData-specific Booking model optimized for efficient queries", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "The unique identifier of the booking in the system", "format": "int32" }, "Version": { "type": "string", "description": "Version of the booking", "nullable": true }, "Customer": { "description": "The customer who made the booking, including their personal and contact information", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Customer2" } ] }, "TotalPayed": { "type": "number", "description": "The total amount that has been paid for the booking", "format": "decimal" }, "Extra": { "type": "string", "description": "Additional notes or special instructions for the booking", "nullable": true }, "IsQuotation": { "type": "boolean", "description": "Indicates whether this is a price quotation rather than a confirmed booking" }, "Category": { "description": "The category of the rented car (e.g., Economy, Luxury, SUV)", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Category2" } ] }, "FromDate": { "type": "string", "description": "The local date and time when the rental period begins", "format": "date-time" }, "ToDate": { "type": "string", "description": "The local date and time when the rental period ends", "format": "date-time" }, "DeliveryPlace": { "description": "The location where the customer will pick up the vehicle", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Place3" } ] }, "ReturnPlace": { "description": "The location where the customer will return the vehicle", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Place3" } ] }, "Price": { "type": "number", "description": "The total price of the booking before any discounts or promotions", "format": "decimal" }, "AgencyPrice": { "type": "number", "description": "The portion of the price to be paid by the travel agency", "format": "decimal" }, "CustomerPrice": { "type": "number", "description": "The portion of the price to be paid by the customer", "format": "decimal" }, "Currency": { "type": "string", "description": "The currency in which the booking was created", "nullable": true }, "CurrentStatusDate": { "type": "string", "description": "Date of the current status change", "format": "date-time" }, "Franchise": { "type": "number", "description": "The standard deposit amount required for the rental", "format": "decimal", "nullable": true }, "FranchiseDamage": { "type": "number", "description": "The deposit amount specifically for damage coverage", "format": "decimal", "nullable": true }, "FranchiseRollover": { "type": "number", "description": "The deposit amount specifically for rollover coverage", "format": "decimal", "nullable": true }, "FranchiseTheft": { "type": "number", "description": "The deposit amount specifically for theft coverage", "format": "decimal", "nullable": true }, "FranchiseHail": { "type": "number", "description": "The deposit amount specifically for hail damage coverage", "format": "decimal", "nullable": true }, "TotalDays": { "type": "number", "description": "The total duration of the rental in days (including partial days)", "format": "decimal" }, "IlimitedKm": { "type": "boolean", "description": "Indicates whether the rental includes unlimited mileage" }, "MaxAllowedDistance": { "type": "integer", "description": "The maximum allowed distance for the rental period", "format": "int32" }, "MaxAllowedDistanceByDay": { "type": "integer", "description": "The maximum allowed distance per day of rental", "format": "int32" }, "WillLeaveCountry": { "type": "boolean", "description": "Indicates whether the vehicle will be taken out of the country during the rental", "nullable": true }, "CurrentStatus": { "type": "string", "description": "The current status of the booking in the rental process.\nString representation of BookingStatusEnum (Reserved, Confirmed, Delivered, Closed, Canceled, Quoted).", "nullable": true }, "DeliveryTransportationId": { "type": "string", "description": "The flight/bus/boat number for the customer's arrival", "nullable": true }, "ReturnTransportationId": { "type": "string", "description": "The flight/bus/boat number for the customer's departure", "nullable": true }, "ExternalSystemId": { "type": "string", "description": "The booking identifier in an external reservation system", "nullable": true }, "PrepaidAmount": { "type": "number", "description": "The amount prepaid to the external system", "format": "decimal" }, "ElegibleSIPPCodeUpgrade": { "type": "string", "description": "The maximum SIPP code upgrade available at no additional cost", "nullable": true }, "ExchangeRate": { "type": "number", "description": "The exchange rate used for currency conversion", "format": "decimal", "nullable": true }, "DailyRate": { "type": "number", "description": "The standard daily rate for the rental", "format": "decimal" }, "HourlyRate": { "type": "number", "description": "The hourly rate for the rental", "format": "decimal" }, "ExtraDayRate": { "type": "number", "description": "The rate for additional days beyond the standard rental period", "format": "decimal" }, "ExtraHourRate": { "type": "number", "description": "The rate for additional hours beyond the standard rental period", "format": "decimal" }, "RatePlan": { "type": "string", "description": "The specific rate plan applied to this booking", "nullable": true }, "IsOnRequest": { "type": "boolean", "description": "Indicates whether this is an on-request booking requiring special approval" }, "CreationDate": { "type": "string", "description": "The date and time when the booking was created", "format": "date-time" }, "CreatedByUserName": { "type": "string", "description": "The user name of the user who created the booking.", "nullable": true }, "UpdatedOn": { "type": "string", "description": "The date and time when the booking (or any of its child lists) was last updated.", "format": "date-time", "nullable": true }, "UpdatedByUserName": { "type": "string", "description": "The user name of the user who performed the last update on the booking.", "nullable": true }, "PayedByAgency": { "type": "number", "description": "The total amount paid by the travel agency", "format": "decimal" }, "PayedByCustomer": { "type": "number", "description": "The total amount paid by the customer", "format": "decimal" }, "CommercialAgreementCode": { "type": "string", "description": "The code of the commercial agreement applied to this booking", "nullable": true }, "PurchaseOrder": { "type": "string", "description": "The purchase order number for agency or company bookings", "nullable": true }, "Brand": { "description": "The brand or company associated with the booking", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BookingBrand2" } ] }, "SalesCommision": { "type": "number", "description": "The commission amount for agencies or external systems", "format": "decimal" }, "IsTransfer": { "type": "boolean", "description": "Indicates whether this is an internal transfer between company locations" }, "PriceDetails": { "description": "Detailed breakdown of prices and their allocation between customer and agency", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PriceDetails2" } ] }, "Agency": { "description": "Agency associated with the booking", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Agency2" } ] }, "IsSelfCheckin": { "type": "boolean", "description": "Indica si la reserva fue completada usando Self-Checkin" }, "DistanceUnit": { "type": "string", "description": "The distance unit in which the booking was created", "nullable": true }, "Code": { "type": "string", "description": "Generated booking code", "nullable": true }, "Balance": { "type": "number", "description": "The remaining amount to be paid for the booking", "format": "decimal" } } }, "Place3": { "type": "object", "description": "Represents a pickup or dropoff location in the system.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the pickup/dropoff location.", "format": "int32" }, "Price": { "type": "number", "description": "Gets or sets the price associated with using this pickup/dropoff location.", "format": "decimal" }, "Name": { "type": "string", "description": "Gets or sets the friendly name of the pickup/dropoff location.", "nullable": true }, "Category": { "type": "string", "description": "Gets or sets the category or type of the pickup/dropoff location.", "nullable": true }, "Address": { "type": "string", "description": "Gets or sets the street address of the pickup/dropoff location.", "nullable": true }, "City": { "type": "string", "description": "Gets or sets the city where the pickup/dropoff location is situated.", "nullable": true }, "Country": { "type": "string", "description": "Gets or sets the country where the pickup/dropoff location is situated.", "nullable": true }, "BranchOfficeId": { "type": "integer", "description": "Gets or sets the unique identifier of the branch office managing this location.", "format": "int32" }, "BranchOfficeName": { "type": "string", "description": "Gets or sets the name of the branch office managing this location.", "nullable": true }, "BranchOfficeIATACode": { "type": "string", "description": "Gets or sets the IATA code of the branch office managing this location.", "nullable": true }, "IsFranchise": { "type": "boolean", "description": "Indicates if the pickup/dropoff location is part of a franchise or owned." }, "Latitude": { "type": "number", "description": "Gets or sets the latitude coordinate of the pickup/dropoff location.", "format": "decimal" }, "Longitude": { "type": "number", "description": "Gets or sets the longitude coordinate of the pickup/dropoff location.", "format": "decimal" }, "CanAddCustomAddress": { "type": "boolean", "description": "Gets or sets a value indicating whether custom addresses can be added to this location." }, "IsCustomAddress": { "type": "boolean", "description": "Gets or sets a value indicating whether this is a custom address location." }, "AvailableForExternalSystems": { "type": "boolean", "description": "Gets or sets a value indicating whether this place is available for external systems and integrations." }, "PlaceType": { "description": "Gets or sets the type classification of this place.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PlaceType2" } ] }, "AvailableOperationOptions": { "$ref": "#/components/schemas/AvailableOperationOptions" }, "AvailableReturnPlaces": { "type": "array", "description": "Gets or sets the list of place IDs available for vehicle return when picking up from this location.", "nullable": true, "items": { "type": "integer", "format": "int32" } }, "AvailableBookingBrandIds": { "type": "array", "description": "Gets or sets the list of booking brand IDs that have this place available.", "nullable": true, "items": { "type": "integer", "format": "int32" } } } }, "PlaceType2": { "type": "object", "description": "Represents a type of pickup/dropoff location.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the place type.", "format": "int32" }, "Name": { "type": "string", "description": "Gets or sets the name of the place type.", "nullable": true }, "IsActive": { "type": "boolean", "description": "Gets or sets a value indicating whether this place type is active." } } }, "AvailableOperationOptions": { "type": "string", "description": "\n\n| Value | Name | Description |\n| ---: | --- | --- |\n| 0 | `DeliveryAndReturn` | — |\n| 1 | `DeliveryOnly` | — |\n| 2 | `ReturnOnly` | — |\n", "x-enumNames": [ "DeliveryAndReturn", "DeliveryOnly", "ReturnOnly" ], "enum": [ "DeliveryAndReturn", "DeliveryOnly", "ReturnOnly" ], "x-enumDescriptions": { "0": "", "1": "", "2": "" } }, "PriceDetails2": { "type": "object", "description": " ", "additionalProperties": false, "properties": { "Price": { "type": "number", "description": "Gets or sets the base price of the rental.", "format": "decimal" }, "CustomerPrice": { "type": "number", "description": "Gets or sets the final price charged to the customer, including any applicable fees or taxes.", "format": "decimal" }, "AgencyPrice": { "type": "number", "description": "Gets or sets the price charged to the agency when the booking is made through an agency.", "format": "decimal" }, "SalesCommission": { "type": "number", "description": "Gets or sets the commission amount for the sales agent or channel.", "format": "decimal" }, "Currency": { "type": "string", "description": "Gets or sets the currency code for all monetary values in this price details object.", "nullable": true } } }, "Car2": { "type": "object", "description": "OData-specific car model optimized for efficient queries.\nNavigation properties (Model, CurrentPlate) are only projected\nwhen the client explicitly requests them with $expand, avoiding unnecessary JOINs.", "additionalProperties": false, "properties": { "Id": { "type": "string", "description": "Gets or sets the unique identifier of the car (its license plate number).", "nullable": true }, "Model": { "description": "Gets or sets the model information of the vehicle. Expandable navigation property ($expand=Model).", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Model2" } ] }, "CurrentBranchOfficeId": { "type": "integer", "description": "Gets or sets the ID of the branch office where the car is currently located.", "format": "int32" }, "CurrentBranchOffice": { "type": "string", "description": "Gets or sets the name of the branch office where the car is currently located.", "nullable": true }, "BranchOfficeOwner": { "type": "string", "description": "Gets or sets the name of the branch office that owns the vehicle.", "nullable": true }, "CurrentKms": { "type": "integer", "description": "Gets or sets the current kilometers reading of the car.", "format": "int32" }, "FuelType": { "description": "Gets or sets the fuel type of the vehicle (taken from its model).", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FuelTypeEnum" } ] }, "Gasoline": { "type": "integer", "description": "Gets or sets the current fuel level of the car.", "format": "int32" }, "FriendlyName": { "type": "string", "description": "Gets or sets the friendly name or nickname of the vehicle.", "nullable": true }, "CurrentPlateId": { "type": "string", "description": "Gets or sets the current license plate number of the vehicle.", "nullable": true }, "ChassisIdentification": { "type": "string", "description": "Gets or sets the chassis identification number (VIN) of the vehicle.", "nullable": true }, "CurrentPlate": { "description": "Gets or sets the current license plate information. Expandable navigation property ($expand=CurrentPlate).", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/LicensePlate2" } ] }, "Color": { "type": "string", "description": "Gets or sets the color of the car.", "nullable": true }, "Year": { "type": "integer", "description": "Gets or sets the manufacturing year of the vehicle.", "format": "int32" }, "TollDeviceId": { "type": "string", "description": "Gets or sets the identifier of the toll device installed in the vehicle.", "nullable": true }, "BatteryNumber": { "type": "string", "description": "Gets or sets the battery serial number of the vehicle.", "nullable": true }, "CreationDate": { "type": "string", "description": "Date the car was added to the fleet.", "format": "date-time" }, "InactiveDate": { "type": "string", "description": "Date the car is retired from the fleet.", "format": "date-time", "nullable": true }, "LeasedToCompany": { "type": "string", "description": "Gets or sets the company the car is leased to.", "nullable": true }, "SupplierFullName": { "type": "string", "description": "Gets or sets the full name of the supplier.", "nullable": true }, "LastReturnDate": { "type": "string", "description": "Gets or sets the date and time of the most recent return, or null if no returns have been made.", "format": "date-time", "nullable": true } } }, "LicensePlate2": { "type": "object", "description": "OData projection of a vehicle license plate, exposed as an expandable navigation of a car.", "additionalProperties": false, "properties": { "Id": { "type": "string", "description": "Gets or sets the license plate number.", "nullable": true }, "IssuingCountry": { "type": "string", "description": "Gets or sets the country that issued the license plate.", "nullable": true }, "IssuingState": { "type": "string", "description": "Gets or sets the state or province that issued the license plate.", "nullable": true } } }, "MailAccount": { "type": "object", "description": "Mail account of the tenant exposed through OData, carrying its effective default assignments.\nOnly non-sensitive fields are exposed: credentials, transport settings and connection state are never returned.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the mail account.", "format": "int32" }, "Email": { "type": "string", "description": "Gets or sets the email address of the account. It can be null for basic SMTP accounts that use the server default credentials.\nOData string filters on this entity set compare case-sensitively because the query runs in memory.", "nullable": true }, "IsSystemDefault": { "type": "boolean", "description": "Gets or sets a value indicating whether this account is the tenant's default sender.\nExactly one account is the system default when the tenant has at least one: the chosen one if it still exists, otherwise the oldest." }, "DefaultForBookingBrandIds": { "type": "array", "description": "Gets or sets the ids of the booking brands whose effective default sender is this account.\nAssignments pointing to deleted accounts are omitted, and tenants with fewer than two brands always get empty lists because brand defaults do not apply there.", "nullable": true, "items": { "type": "integer", "format": "int32" } } } }, "PriceAgreement": { "type": "object", "description": "Simple OData projection of a price agreement.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the price agreement.", "format": "int32" }, "Name": { "type": "string", "description": "Gets or sets the display name of the price agreement.", "nullable": true }, "Description": { "type": "string", "description": "Gets or sets the description of the price agreement.", "nullable": true }, "PriceModificator": { "type": "number", "description": "Gets or sets the price modificator applied by the agreement, expressed as a percentage\n(negative values are discounts).", "format": "decimal" }, "ApplyPriceModificatorToAdditionals": { "type": "boolean", "description": "Gets or sets a value indicating whether the price modificator also applies to additionals." }, "Rates": { "type": "array", "description": "Gets or sets the rates (booking tariffs) associated to the price agreement. Empty means no\nspecific rates. Navigation property: only returned when requested with $expand=Rates.", "nullable": true, "items": { "$ref": "#/components/schemas/Rate2" } }, "BookingBrands": { "type": "array", "description": "Gets or sets the booking brands the price agreement applies to. Empty means all brands.\nNavigation property: only returned when requested with $expand=BookingBrands.", "nullable": true, "items": { "$ref": "#/components/schemas/BookingBrand2" } } } }, "Rate2": { "type": "object", "description": "Simple OData projection of a booking tariff (rate).", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the rate.", "format": "int32" }, "Name": { "type": "string", "description": "Gets or sets the display name of the rate.", "nullable": true }, "Code": { "type": "string", "description": "Gets or sets the business code that identifies the rate.", "nullable": true }, "IsActive": { "type": "boolean", "description": "Gets or sets a value indicating whether the rate is currently active." }, "ValidFrom": { "type": "string", "description": "Gets or sets the date from which the rate is valid.", "format": "date-time", "nullable": true }, "ValidTo": { "type": "string", "description": "Gets or sets the date until which the rate is valid.", "format": "date-time", "nullable": true }, "CurrencyId": { "type": "integer", "description": "Gets or sets the identifier of the currency the rate prices are expressed in.", "format": "int32", "nullable": true }, "MinDays": { "type": "integer", "description": "Gets or sets the minimum number of rental days the rate applies to.", "format": "int32", "nullable": true }, "MaxDays": { "type": "integer", "description": "Gets or sets the maximum number of rental days the rate applies to.", "format": "int32", "nullable": true }, "ParentId": { "type": "integer", "description": "Gets or sets the identifier of the parent rate, when this rate inherits its prices from another one.", "format": "int32", "nullable": true }, "LastUpdatedOn": { "type": "string", "description": "Gets or sets the date and time the rate was last updated.", "format": "date-time" }, "Duration": { "type": "integer", "description": "Gets the number of days the rate is valid for (inclusive). Null when the validity range is open.\nComputed from ValidFrom and ValidTo.", "format": "int32", "nullable": true }, "ValidPickupDays": { "type": "integer", "description": "Gets or sets the bitmask of week days on which a pickup is valid for this rate.", "format": "int32", "nullable": true }, "ValidDropoffDays": { "type": "integer", "description": "Gets or sets the bitmask of week days on which a dropoff is valid for this rate.", "format": "int32", "nullable": true }, "AvailableForManualSelection": { "type": "boolean", "description": "Gets or sets a value indicating whether the rate can be selected manually on a booking." }, "OnlyAvailableForManualSelection": { "type": "boolean", "description": "Gets or sets a value indicating whether the rate is only available for manual selection." }, "CutByDistanceMode": { "type": "integer", "description": "Gets or sets how the rate cuts prices by distance (0 = IndividualCuts, 1 = DependentOnDays).", "format": "int32" }, "Models": { "type": "array", "description": "Gets or sets the models the rate applies to. Empty means all models.\nNavigation property: only returned when requested with $expand=Models.", "nullable": true, "items": { "$ref": "#/components/schemas/Model2" } }, "Categories": { "type": "array", "description": "Gets or sets the categories the rate applies to. Empty means all categories.\nNavigation property: only returned when requested with $expand=Categories.", "nullable": true, "items": { "$ref": "#/components/schemas/Category2" } }, "BranchOffices": { "type": "array", "description": "Gets or sets the branch offices the rate applies to. Empty means all branch offices.\nNavigation property: only returned when requested with $expand=BranchOffices.", "nullable": true, "items": { "$ref": "#/components/schemas/BranchOffice3" } }, "Prices": { "type": "array", "description": "Gets or sets the price matrix of the rate. Each entry targets a model or a category.\nContained navigation property: only returned when requested with $expand=Prices.", "nullable": true, "items": { "$ref": "#/components/schemas/RatePrice2" } } } }, "BranchOffice3": { "type": "object", "description": "Simple OData projection of a branch office, exposed as an expandable navigation of a rate.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the branch office.", "format": "int32" }, "Name": { "type": "string", "description": "Gets or sets the display name of the branch office.", "nullable": true }, "BusinessName": { "type": "string", "description": "Gets or sets the legal/business name of the branch office.", "nullable": true }, "IATACode": { "type": "string", "description": "Gets or sets the IATA code of the branch office.", "nullable": true }, "Order": { "type": "number", "description": "Gets or sets the display order of the branch office in lists.", "format": "decimal" } } }, "RatePrice2": { "type": "object", "description": "A single cell of a rate price matrix, exposed as an expandable (contained) navigation of a rate.\nEach cell targets either a model or a category.", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Gets or sets the unique identifier of the price cell.", "format": "int32" }, "ModelId": { "type": "integer", "description": "Gets or sets the identifier of the model this price applies to, when the rate is model-based.", "format": "int32", "nullable": true }, "CategoryId": { "type": "integer", "description": "Gets or sets the identifier of the category this price applies to, when the rate is category-based.", "format": "int32", "nullable": true }, "UnitOfTimeType": { "type": "integer", "description": "Gets or sets the unit of time the price range is expressed in (0 = Days, 1 = Hours).", "format": "int32" }, "UnitOfTimeFrom": { "type": "integer", "description": "Gets or sets the lower bound (inclusive) of the time range.", "format": "int32" }, "UnitOfTimeTo": { "type": "integer", "description": "Gets or sets the upper bound (inclusive) of the time range.", "format": "int32" }, "UnitOfDistanceFrom": { "type": "integer", "description": "Gets or sets the lower bound (inclusive) of the distance range.", "format": "int32" }, "UnitOfDistanceTo": { "type": "integer", "description": "Gets or sets the upper bound (inclusive) of the distance range. Null means unlimited.", "format": "int32", "nullable": true }, "Price": { "type": "number", "description": "Gets or sets the price for this cell.", "format": "decimal" } } } }, "securitySchemes": { "bearer": { "type": "http", "description": "OAuth2 bearer token. Send as: Authorization: Bearer {token}", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "bearer": [] } ] }