SuccessResultResponseOfInstructionListResponseDto

result objectnullablerequired

totalCountinteger<int32>required

The total number of instructions.

previousPagestringnullablerequired

The URL to the previous page of results.

nextPagestringnullablerequired

The URL to the next page of results.

currentPageinteger<int32>required

The current page number.

result object[]required

The list of instructions.

Array [

idstring<uuid>required

The unique kaunt identifier of the instruction.

Example: 227aebd0-36a4-4d17-b96d-c5b5d071abd4

companyNamestringnullablerequired

The company name this instruction is scoped to.

namestringnullablerequired

The name of the instruction.

Example: Merge all lines

descriptionstringnullablerequired

The description of the instruction.

scopeInstructionScopeDto2required

The scope of the instruction.

Possible values: [Vendor, Buyer, Company, Tenant]

Example: Vendor

scopePartyReference objectnullablerequired

The party reference associated with the scope.

partyNamestringnullablerequired

partyIdentifierstringnullablerequired

]

correlationIdstring<uuid>

A unique ID of the request

Example: fb0ccbbc-62bc-447f-a47e-02b490e25690

isSuccessboolean

Indication of whether the request was successfull

SuccessResultResponseOfInstructionListResponseDto

{
  "result": {
    "totalCount": 0,
    "previousPage": "string",
    "nextPage": "string",
    "currentPage": 0,
    "result": [
      {
        "id": "227aebd0-36a4-4d17-b96d-c5b5d071abd4",
        "companyName": "string",
        "name": "Merge all lines",
        "description": "string",
        "scope": "Vendor",
        "scopePartyReference": {
          "partyName": "string",
          "partyIdentifier": "string"
        }
      }
    ]
  },
  "correlationId": "fb0ccbbc-62bc-447f-a47e-02b490e25690",
  "isSuccess": true
}