Get contracts

GET 
/api/v2/Contracts

Get contracts

Request

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

Success

application/json

Schema

Schema

ContinuationToken stringnullable
Items object[]nullable
Array [
Guid guid
Revision int64
PersonCreated guidnullable
PersonChanged guidnullable
TimestampCreated date-timenullable
TimestampChanged date-timenullable
Name stringnullablerequired
Code stringnullable
Customer guidnullable
ResponsiblePerson guidnullable
Description stringnullable
StartDate datenullable
EndDate datenullable
Billable BillableFlags (string)
Possible values: [None, Billable, ChangeAllowed, BillableChangeAllowed]
Note stringnullable
CostsPlanned int64nullable
HoursPlanned int64nullable
CustomFields objectnullable
ExternalKey stringnullable
States string[]nullable
ContactPerson stringnullable
Possible values: <= 50 characters
ContactPhone stringnullable
Possible values: <= 30 characters
ContactEmail stringnullable
Possible values: <= 65 characters
CompletionDate date-timenullable
Branch guidnullable
]

Example (from schema)

{
  "ContinuationToken": "string",
  "Items": [
    {
      "Guid": "string",
      "Revision": 0,
      "PersonCreated": "string",
      "PersonChanged": "string",
      "TimestampCreated": "2024-03-29T06:55:00Z",
      "TimestampChanged": "2024-03-29T06:55:00Z",
      "Name": "string",
      "Code": "string",
      "Customer": "string",
      "ResponsiblePerson": "string",
      "Description": "string",
      "StartDate": "2024-03-29",
      "EndDate": "2024-03-29",
      "Billable": "None",
      "Note": "string",
      "CostsPlanned": 0,
      "HoursPlanned": 0,
      "CustomFields": {
        "MyCustomField": "value",
        "MyNestedObject": {
          "MyNestedProperty": "value"
        }
      },
      "ExternalKey": "string",
      "States": [
        "string"
      ],
      "ContactPerson": "string",
      "ContactPhone": "string",
      "ContactEmail": "string",
      "CompletionDate": "2024-03-29T06:57:03.079Z",
      "Branch": "string"
    }
  ]
}

400

Error

application/json

Schema

Schema

Error objectrequired
Code stringnullable
Message stringnullable

Example (from schema)

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

Loading...