Retrieve a list of settlements

GET 
/odata/v2/Settlement

Response is limited to 3000 records. Follow '@odata.nextLink' to retrieve the next page.

Request

Query Parameters

$skip number

Skip N. See https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionskip

Responses

200

OK

application/json

Schema

Schema

value

object[]

nullable

required

Array [

settlementId stringnullable

description stringnullable

note stringnullable

rowNumber int32

createdBy stringnullable

createdDateTime date-time

modifiedBy stringnullable

modifiedDateTime date-timenullable

versionStamp int32

documentsExists boolean

]

@odata.context stringnullable
@odata.count int32nullable
@odata.nextLink stringnullable

Example (from schema)

{
  "value": [
    {
      "settlementId": "string",
      "description": "string",
      "note": "string",
      "rowNumber": 0,
      "createdBy": "string",
      "createdDateTime": "2026-03-25T15:10:39.213Z",
      "modifiedBy": "string",
      "modifiedDateTime": "2026-03-25T15:10:39.213Z",
      "versionStamp": 0,
      "documentsExists": true
    }
  ],
  "@odata.context": "string",
  "@odata.count": 0,
  "@odata.nextLink": "string"
}

400

Bad request. Occurs if the request payload or querystring contains invalid data

application/json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

401

Unauthorized

Loading...