Get Subcontract

GET 
/api/v2/Contracts/Subcontracts/:key

Get Subcontract

Request

Path Parameters

key stringrequired

Guid or ExternalKey

Responses

200

Success

application/json

Schema

Schema

Guid guid
Revision int64
PersonCreated guidnullable
PersonChanged guidnullable
TimestampCreated date-timenullable
TimestampChanged date-timenullable
Name stringnullablerequired
Code stringnullable
Contract guid
Description stringnullable
EndDate datenullable
Billable BillableFlags (string)

Possible values: [None, Billable, ChangeAllowed, BillableChangeAllowed]

Note stringnullable
CostsPlanned int64nullable
HoursPlanned int64nullable
CustomFields objectnullable
ExternalKey stringnullable
States string[]nullable
ResponsiblePerson guidnullable
CompletionDate date-timenullable

Example (from schema)

{
  "Guid": "string",
  "Revision": 0,
  "PersonCreated": "string",
  "PersonChanged": "string",
  "TimestampCreated": "2024-03-29T06:55:00Z",
  "TimestampChanged": "2024-03-29T06:55:00Z",
  "Name": "string",
  "Code": "string",
  "Contract": "string",
  "Description": "string",
  "EndDate": "2024-03-29",
  "Billable": "None",
  "Note": "string",
  "CostsPlanned": 0,
  "HoursPlanned": 0,
  "CustomFields": {
    "MyCustomField": "value",
    "MyNestedObject": {
      "MyNestedProperty": "value"
    }
  },
  "ExternalKey": "string",
  "States": [
    "string"
  ],
  "ResponsiblePerson": "string",
  "CompletionDate": "2024-03-29T06:57:03.544Z"
}

404

Not found

application/json

Schema

Schema

Guid guid
Revision int64
PersonCreated guidnullable
PersonChanged guidnullable
TimestampCreated date-timenullable
TimestampChanged date-timenullable
Name stringnullablerequired
Code stringnullable
Type object

oneOf

ActivityType

string

Possible values: [Work, Absence, Break]

Default boolean
TimeEntry object

oneOf

ActivityTypeTimeEntry

string

Possible values: [Optional, TotalTime, FromTo]

Inactive boolean
Movement boolean
Icon stringnullable
ExternalKey stringnullable

Example (from schema)

{
  "Guid": "string",
  "Revision": 0,
  "PersonCreated": "string",
  "PersonChanged": "string",
  "TimestampCreated": "2024-03-29T06:55:00Z",
  "TimestampChanged": "2024-03-29T06:55:00Z",
  "Name": "string",
  "Code": "string",
  "Type": "Work",
  "Default": true,
  "TimeEntry": "Optional",
  "Inactive": true,
  "Movement": true,
  "Icon": "string",
  "ExternalKey": "string"
}

Loading...