{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"companyId": {
"type": "string",
"description": "Company id"
},
"userId": {
"type": "string",
"description": "User id"
},
"itineraryId": {
"type": "integer",
"description": "Itinerary id"
},
"If-Match": {
"type": "string",
"description": "Client generated request identifier passed through all requests"
},
"header": {
"type": "object",
"description": "Header with general information about the itinerary",
"properties": {
"configurationCode": {
"type": "string",
"description": "The configuration code used to calculate the settlement for the itinerary"
},
"description": {
"type": "string",
"description": "Description of the itinerary"
},
"hasNoLodging": {
"type": "boolean",
"description": "Traveller indicates that the itinerary has no overnight stays, e.g. a truck driver is driving overnight"
},
"id": {
"type": "integer",
"description": "Identification of the itinerary"
},
"overlapTypeCode": {
"type": "string",
"description": "Overlap type; can be used to handle different kinds of (overlapping) trips within a trip, e.g. TRIP_HOME or BUSINESS_TRIP"
},
"tripTypeCode": {
"type": "string",
"description": "Trip type; can be used to apply different calculation rules or allowance rates"
},
"userId": {
"type": "string",
"description": "Identification of the owner of the itinerary, i.e. the traveller"
}
},
"required": [
"configurationCode",
"id",
"userId"
]
},
"segments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"departureDate": {
"type": "string",
"description": "Date of starting the travel at the departure location"
},
"departureTime": {
"type": "string",
"description": "Time of starting the travel at the departure location"
},
"departureLocationNameId": {
"type": "string",
"format": "uuid",
"description": "Id of the departure location; is either home/office when itinerary begins with the current stop or the arrival location of the last itinerary stop"
},
"borderCrossingDate": {
"type": "string",
"description": "Date of border crossing, this could be first or last border crossing dependent on the legal regulations"
},
"borderCrossingTime": {
"type": "string",
"description": "Time of border crossing, this could be first or last border crossing dependent on the legal regulations"
},
"arrivalDate": {
"type": "string",
"description": "Date of ending the travel at the arrival location"
},
"arrivalTime": {
"type": "string",
"description": "Time of ending the travel at the arrival location"
},
"arrivalLocationNameId": {
"type": "string",
"format": "uuid",
"description": "Id of the arrival location; is either departure location of the next itinerary stop or home/office when itinerary ends with the current stop"
},
"address": {
"type": "object",
"description": "Address of the professional activity (required for german 3-month-rule) at arrival location"
}
},
"required": [
"arrivalDate",
"arrivalLocationNameId",
"arrivalTime",
"borderCrossingDate",
"borderCrossingTime",
"departureDate",
"departureLocationNameId",
"departureTime"
]
},
"description": "List of itinerary segments constructing the current itinerary"
}
},
"required": [
"PCID",
"userId",
"itineraryId",
"header",
"segments"
]
}