VendorRequestDto

Example Json Object

  1{
  2  "id": 0,
  3  "displayId": "string",
  4  "state": "INV_DRAFT",
  5  "vendorId": 0,
  6  "vendorDisplayId": "string",
  7  "vendorName": "string",
  8  "vendorPhone": "string",
  9  "vendorFax": "string",
 10  "erpSystem": {
 11    "id": 0,
 12    "displayId": "string",
 13    "status": "CREATED",
 14    "name": "string",
 15    "type": "NAKISA",
 16    "sapVersion": "ECC_EHP5"
 17  },
 18  "vendorParent": {
 19    "id": 0,
 20    "displayId": "string",
 21    "status": "CREATED",
 22    "name": "string",
 23    "erpSystemDisplayId": "string"
 24  },
 25  "operation": "VENDOR_CREATE",
 26  "operationReason": "string",
 27  "companies": [
 28    {
 29      "id": 0,
 30      "displayId": "string",
 31      "changeType": "ADD",
 32      "vendorRequestId": 0,
 33      "vendorRequestDisplayId": "string",
 34      "company": {
 35        "id": 0,
 36        "displayId": "string",
 37        "status": "CREATED",
 38        "erpSystemId": 0,
 39        "erpSystemDisplayId": "string",
 40        "countryId": 0,
 41        "countryDisplayId": "string",
 42        "name": "string",
 43        "postingPeriodVariantId": 0,
 44        "fiscalVariantId": 0
 45      },
 46      "allowsSystemGenerateNewId": true,
 47      "numberRangeIdentifierValue": "string",
 48      "numberRangeIdentifierType": {
 49        "name": "string"
 50      },
 51      "numberRangeType": {
 52        "name": "string"
 53      }
 54    }
 55  ],
 56  "companiesTotal": 0,
 57  "partnerRoles": [
 58    {
 59      "id": 0,
 60      "displayId": "string",
 61      "changeType": "ADD",
 62      "vendorRequestId": 0,
 63      "vendorRequestDisplayId": "string",
 64      "partnerRole": {
 65        "id": 0,
 66        "displayId": "string",
 67        "status": "CREATED",
 68        "name": "string"
 69      },
 70      "allowsSystemGenerateNewId": true,
 71      "numberRangeIdentifierValue": "string",
 72      "numberRangeIdentifierType": {
 73        "name": "string"
 74      },
 75      "numberRangeType": {
 76        "name": "string"
 77      }
 78    }
 79  ],
 80  "partnerRolesTotal": 0,
 81  "partnerContacts": [
 82    {
 83      "id": 0,
 84      "displayId": "string",
 85      "changeType": "ADD",
 86      "vendorRequestId": 0,
 87      "vendorRequestDisplayId": "string",
 88      "createdPartnerContactDisplayId": "string",
 89      "name": "string",
 90      "email": "string",
 91      "phone": "string",
 92      "position": "string",
 93      "address": "string",
 94      "group": "string",
 95      "buildingName": "string",
 96      "fax": "string",
 97      "erpSystem": {
 98        "id": 0,
 99        "displayId": "string",
100        "status": "CREATED",
101        "name": "string",
102        "type": "NAKISA",
103        "sapVersion": "ECC_EHP5"
104      },
105      "partnerContact": {
106        "id": 0,
107        "displayId": "string",
108        "status": "CREATED",
109        "name": "string"
110      },
111      "allowsSystemGenerateNewId": true,
112      "numberRangeIdentifierValue": "string",
113      "numberRangeIdentifierType": {
114        "name": "string"
115      },
116      "numberRangeType": {
117        "name": "string"
118      }
119    }
120  ],
121  "partnerContactsTotal": 0,
122  "allowsSystemGenerateNewId": true,
123  "numberRangeIdentifierValue": "string",
124  "numberRangeIdentifierType": {
125    "name": "string"
126  },
127  "numberRangeType": {
128    "name": "string"
129  }
130}

📄 Description: Data transfer object representing a request for vendor engagement, encapsulating essential details such as vendor information, requested services, and associated timelines to facilitate streamlined procurement processes.

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

Unique identifier for the resource

displayId

string

false

none

Unique identifier for the display

state

string

false

none

Represents the current status of the vendor request, indicating its progress within the approval workflow.

vendorId

integer(int64)

false

none

Unique identifier for the vendor

vendorDisplayId

string

false

none

Unique identifier for the vendor display

vendorName

string

false

none

Name of the vendor

vendorPhone

string

false

none

Contact number for the vendor, used to facilitate communication and coordination regarding service delivery.

vendorFax

string

false

none

Fax number of the vendor, used for communication and document transmission in business transactions.

erpSystem

ErpSystemLite

false

none

Indicates the specific ERP system associated with the vendor request, facilitating streamlined integration and data management.

vendorParent

PartnerLite

false

none

Identifier for the parent vendor associated with the current vendor request, facilitating hierarchical vendor management.

operation

string

false

none

Specifies the type of operation being requested in the vendor management process.

operationReason

string

false

none

Description of the reason for the vendor request, providing context for the operation’s purpose within the business process.

companies

[VendorRequestPartnerCompanyDto]

false

none

An array of vendor request details, allowing for the submission of multiple company entries within a single API call.

companiesTotal

integer(int64)

false

none

Total companies

partnerRoles

[VendorRequestPartnerRoleDto]

false

none

An array of roles assigned to the partner, defining their responsibilities and access levels within the vendor request process.

partnerRolesTotal

integer(int64)

false

none

Total partner roles

partnerContacts

[VendorRequestPartnerContactDto]

false

none

An array of contact details for partners associated with the vendor request, facilitating effective communication and collaboration.

partnerContactsTotal

integer(int64)

false

none

Total partner contacts

allowsSystemGenerateNewId

boolean

false

none

Unique identifier for the allows system generate new

numberRangeIdentifierValue

string

false

none

String value representing the specific range identifier for the vendor request, facilitating accurate tracking and management of vendor-related data.

numberRangeIdentifierType

INumberRangeIdentifierType

false

none

Type of the number range identifier

numberRangeType

INumberRangeType

false

none

Type of the number range

Enumerated Values

Attribute

Value

operation

VENDOR_CREATE, VENDOR_DELETE, VENDOR_RESTORE, VENDOR_UPDATE

state

GOODS_RECEIPT_DRAFT, GOODS_RECEIPT_MATCHED, GOODS_RECEIPT_RECEIVED, GOODS_RECEIPT_REJECTED, INVOICE_PAYMENT_DRAFT, INVOICE_PAYMENT_JOURNALS_GENERATING, INVOICE_PAYMENT_POSTED, INVOICE_PAYMENT_POSTING, INVOICE_PAYMENT_REVIEW, INV_APPROVED, INV_DRAFT, INV_GENERATING_JOURNALS, INV_PAID, INV_POSTED, INV_POSTING, INV_REJECTED, INV_REVIEW, INV_WAITING_FOR_APPROVAL, PURCHASE_ORDER_APPROVED, PURCHASE_ORDER_DRAFT, PURCHASE_ORDER_REJECTED, PURCHASE_ORDER_WAITING_FOR_APPROVAL, PURCHASE_REQUISITION_APPROVED, PURCHASE_REQUISITION_DRAFT, PURCHASE_REQUISITION_REJECTED, PURCHASE_REQUISITION_WAITING_FOR_APPROVAL, VENDOR_REQUEST_APPROVED, VENDOR_REQUEST_DRAFT, VENDOR_REQUEST_PENDING_APPROVAL, VENDOR_REQUEST_REJECTED, WORKSPACE_CLOSED, WORKSPACE_JOURNALS_GENERATING, WORKSPACE_OPEN, WORKSPACE_POSTING, WORKSPACE_REVIEW