ResponseListContractPartnerDto

Example Json Object

 1{
 2  "code": "OK",
 3  "message": "Successfully retrieved list of contract partners.",
 4  "defaultMessage": "Operation completed successfully.",
 5  "debugMessage": "No errors occurred during the query execution.",
 6  "errors": {
 7    "all": [
 8      {
 9        "type": "GENERIC",
10        "source": {},
11        "field": "string",
12        "errorKey": "string",
13        "errorMessage": "string"
14      }
15    ]
16  },
17  "object": [
18    {
19      "id": 10000010,
20      "displayId": "1382331350-20250820-173902",
21      "partner": {
22        "id": 10000012,
23        "displayId": "0000100003",
24        "status": "ACTIVE",
25        "name": "TEST VENDOR GB",
26        "erpSystemDisplayId": "FINQ8S-300"
27      },
28      "partnerRole": {
29        "id": 10000004,
30        "displayId": "40",
31        "status": "ACTIVE",
32        "name": "Lessor"
33      },
34      "fromDate": "2019-08-24",
35      "toDate": "2019-08-24",
36      "masterAgreementPartnerId": 50000001,
37      "replacedPartner": {},
38      "replacedByPartner": {},
39      "parentContractPartnerId": 60000000,
40      "contractRevisionId": 10000044,
41      "contractId": 10000010,
42      "contractDisplayId": "CTR-0001",
43      "numberRangeIdentifierType": {
44        "name": "COMPANY_CODE"
45      },
46      "numberRangeIdentifierValue": "0001",
47      "numberRangeType": {
48        "name": "CONTRACT"
49      },
50      "allowsSystemGenerateNewId": false
51    }
52  ]
53}

📄 Description: Represents a standard response wrapper for returning a list of Contract partners entities.

Properties

Name

Type

Required

Restrictions

Description

code

string

false

none

Response code indicating success or failure.

message

string

false

none

A short message describing the response status.

defaultMessage

string

false

none

Default message in case no specific message is set.

debugMessage

string

false

none

Detailed message useful for debugging purposes.

errors

Errors

false

none

none

object

[ContractPartnerDto]

false

none

List of Contract partner entities returned by the request.

Enumerated Values

Attribute

Value

code

API_CALL_FAILED, ATTACHED, BAD_REQUEST, DATA_VALIDATION_ERROR, DELETED, DETACHED, INTERNAL_SYSTEM_ERROR, NULL_RESPONSE, OK, OK_BUT_RESPONSE_INVALID, REQUEST_VALIDATION_ERROR, SERVICE_VALIDATION_ERROR, UPDATED