Get Subcontract
GET/api/v2/Contracts/Subcontracts/:key
Get Subcontract
Request
Path Parameters
key stringrequired
Guid or ExternalKey
Responses
- 200
- 404
Success
- application/json
- Schema
- Example (from schema)
Schema
Guid guid
Revision int64
PersonCreated guidnullable
PersonChanged guidnullable
TimestampCreated date-timenullable
Example:
2024-10-07T12:48:00Z
TimestampChanged date-timenullable
Example:
2024-10-07T12:48:00Z
Name stringnullablerequired
Code stringnullable
Contract guid
Description stringnullable
EndDate datenullable
Billable BillableFlags (string)
Possible values: [None
, Billable
, ChangeAllowed
, BillableChangeAllowed
]
Note stringnullable
CustomFields objectnullable
Example:
{"MyCustomField":"value","MyNestedObject":{"MyNestedProperty":"value"}}
ExternalKey stringnullable
States string[]nullable
ResponsiblePerson guidnullable
CompletionDate date-timenullable
{
"Guid": "string",
"Revision": 0,
"PersonCreated": "string",
"PersonChanged": "string",
"TimestampCreated": "2024-10-07T12:48:00Z",
"TimestampChanged": "2024-10-07T12:48:00Z",
"Name": "string",
"Code": "string",
"Contract": "string",
"Description": "string",
"EndDate": "2024-07-29",
"Billable": "None",
"Note": "string",
"CustomFields": {
"MyCustomField": "value",
"MyNestedObject": {
"MyNestedProperty": "value"
}
},
"ExternalKey": "string",
"States": [
"string"
],
"ResponsiblePerson": "string",
"CompletionDate": "2024-07-29T15:51:28.071Z"
}
Not found
- application/json
- Schema
- Example (from schema)
Schema
- ActivityType
- ActivityTypeTimeEntry
Guid guid
Revision int64
PersonCreated guidnullable
PersonChanged guidnullable
TimestampCreated date-timenullable
Example:
2024-10-07T12:48:00Z
TimestampChanged date-timenullable
Example:
2024-10-07T12:48:00Z
Name stringnullablerequired
Code stringnullable
Type
object
oneOf
string
Possible values: [Work
, Absence
, Break
]
Default boolean
TimeEntry
object
oneOf
string
Possible values: [Optional
, TotalTime
, FromTo
]
Inactive boolean
Movement boolean
Icon stringnullable
ExternalKey stringnullable
{
"Guid": "string",
"Revision": 0,
"PersonCreated": "string",
"PersonChanged": "string",
"TimestampCreated": "2024-10-07T12:48:00Z",
"TimestampChanged": "2024-10-07T12:48:00Z",
"Name": "string",
"Code": "string",
"Type": "Work",
"Default": true,
"TimeEntry": "Optional",
"Inactive": true,
"Movement": true,
"Icon": "string",
"ExternalKey": "string"
}
Loading...