Get contracts

Get contracts

Query Parameters

• ContinuationToken string

  Token is needed, unless all records have been returned in previous request. Do not forget to pass also all other parameters.

Responses

• 200
• 400

---

Success

application/json

• Schema
• Example (from schema)

---

Schema

• ContinuationToken string nullable
• Items object[] nullable

  Array [

  Guid guid

  Revision int64

  PersonCreated guid nullable

  PersonChanged guid nullable

  TimestampCreated date-time nullable

  TimestampChanged date-time nullable

  Name string nullable required

  Code string nullable

  Customer guid nullable

  ResponsiblePerson guid nullable

  Description string nullable

  StartDate date nullable

  EndDate date nullable

  Billable BillableFlags

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

  Note string nullable

  CostsPlanned int64 nullable

  HoursPlanned int64 nullable

  CustomFields object nullable

  ExternalKey string nullable

  ]

{
  "ContinuationToken": "string",
  "Items": [
    {
      "Guid": "string",
      "Revision": 0,
      "PersonCreated": "string",
      "PersonChanged": "string",
      "TimestampCreated": "2023-05-24T12:25:00Z",
      "TimestampChanged": "2023-05-24T12:25:00Z",
      "Name": "string",
      "Code": "string",
      "Customer": "string",
      "ResponsiblePerson": "string",
      "Description": "string",
      "StartDate": "2023-05-24",
      "EndDate": "2023-05-24",
      "Billable": "None",
      "Note": "string",
      "CostsPlanned": 0,
      "HoursPlanned": 0,
      "CustomFields": {
        "MyCustomField": "value",
        "MyNestedObject": {
          "MyNestedProperty": "value"
        }
      },
      "ExternalKey": "string"
    }
  ]
}

Error

application/json

• Schema
• Example (from schema)

---

Schema

• Error object required

  Code string nullable

  Message string nullable

{
  "Error": {
    "Code": "string",
    "Message": "string"
  }
}

Loading...