ResponseSegmentDto

Example Json Object

 1{
 2  "code": "UPDATED",
 3  "message": "string",
 4  "defaultMessage": "string",
 5  "debugMessage": "string",
 6  "errors": {
 7    "all": [
 8      {
 9        "type": "GENERIC",
10        "errorMessage": "string",
11        "source": {},
12        "field": "string",
13        "errorKey": "string"
14      }
15    ]
16  },
17  "object": {
18    "id": 0,
19    "status": "CREATED",
20    "displayId": "string",
21    "erpSystemId": 0,
22    "erpSystemDisplayId": "string",
23    "name": "string"
24  }
25}

📄 Description: Data transfer object representing a segment of the financial organization structure, detailing the hierarchical relationships and attributes of financial entities within the organization.

Properties

Name

Type

Required

Restrictions

Description

code

string

false

none

Code identifier for the resource

message

string

false

write-only

Textual representation of the message conveying relevant information about the financial organization’s structure and hierarchy.

defaultMessage

string

false

write-only

Default message to be displayed for the financial organization structure, providing essential context for users navigating the hierarchy of financial entities.

debugMessage

string

false

write-only

Provides detailed information regarding any issues encountered during the processing of financial organization structure requests.

errors

Errors

false

none

Value for errors field

object

SegmentDto

false

none

Value for object field

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