PartnerDto

Example Json Object

 1{
 2  "id": 0,
 3  "status": "CREATED",
 4  "displayId": "string",
 5  "erpSystemId": 0,
 6  "erpSystemDisplayId": "string",
 7  "name": "string",
 8  "fax": "string",
 9  "phone": "string",
10  "parentId": 0,
11  "parentName": "string",
12  "parentDisplayId": "string",
13  "companyId": 0,
14  "partnerRoleId": 0,
15  "partnerContactId": 0
16}

📄 Description: Data transfer object representing a business partner, encapsulating essential information such as partner identification, contact details, and engagement status to facilitate effective collaboration and relationship management.

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

Unique identifier for the resource

status

string

false

none

Status of the resource

displayId

string

true

none

Unique identifier for the display

erpSystemId

integer(int64)

false

none

Unique identifier for the erp system

erpSystemDisplayId

string

false

none

Unique identifier for the erp system display

name

string

false

none

Name of the resource

fax

string

false

none

Fax number associated with the partner, used for communication and document transmission.

phone

string

false

none

Contact number for the partner, facilitating communication and collaboration within business operations.

parentId

integer(int64)

false

none

Unique identifier for the parent

parentName

string

false

none

Name of the parent

parentDisplayId

string

false

none

Unique identifier for the parent display

companyId

integer(int64)

false

none

Unique identifier for the company

partnerRoleId

integer(int64)

false

none

Unique identifier for the partner role

partnerContactId

integer(int64)

false

none

Unique identifier for the partner contact

Enumerated Values

Attribute

Value

status

ACTIVE, CREATED, DECOMMISSIONED, DISABLED