Context of the itinerary, an itinerary may belong to one or several travel requests or expense reports
itineraryPeriodAssignments
object[]
Yes
—
List of periods for the current itinerary with their unique assignment to a given context
Show inputSchema
{ "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" }, "context": { "type": "string", "description": "Context of the itinerary, an itinerary may belong to one or several travel requests or expense reports", "enum": [ "TRAVEL_REQUEST", "EXPENSE_REPORT" ] }, "itineraryPeriodAssignments": { "type": "array", "items": { "type": "object" }, "description": "List of periods for the current itinerary with their unique assignment to a given context" } }, "required": [ "PCID", "userId", "itineraryId", "context", "itineraryPeriodAssignments" ]}
Header with general information about the itinerary
segments
object[]
Yes
—
List of itinerary segments constructing the current itinerary
Show inputSchema
{ "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" }, "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" }, "description": "List of itinerary segments constructing the current itinerary" } }, "required": [ "PCID", "userId", "itineraryId", "header", "segments" ]}
List of itinerary segments constructing the current itinerary
header
object
Yes
—
Header with general information about the itinerary
segments
object[]
Yes
—
List of itinerary segments constructing the current itinerary
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "string", "description": "User id" }, "companyId": { "type": "string", "description": "Company id" }, "assignment": { "type": "object", "description": "List of itinerary segments constructing the current itinerary", "properties": { "context": { "type": "string", "description": "Context of the itinerary, an itinerary may belong to one or several travel requests or expense reports" }, "contextId": { "type": "string", "description": "Context Id to which current itinerary should be assigned" } }, "required": [ "context" ] }, "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" }, "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" } } }, "segments": { "type": "array", "items": { "type": "object" }, "description": "List of itinerary segments constructing the current itinerary" } }, "required": [ "PCID", "userId", "assignment", "header", "segments" ]}