SuccessResultResponseOfInstructionListResponseDto

result objectrequired

totalCountint32required

The total number of instructions.

previousPagestringnullablerequired

The URL to the previous page of results.

nextPagestringnullablerequired

The URL to the next page of results.

currentPageint32required

The current page number.

result object[]required

The list of instructions.

Array [

iduuidrequired

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.

originalFeedbackTextstringnullablerequired

The original feedback text provided by the user.

scopestringrequired

The scope of the instruction.

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

Example: Vendor

scopePartyReference objectnullablerequired

The party reference associated with the scope.

partyNamestringnullablerequired

partyIdentifierstringnullablerequired

lockedboolean

True when this instruction comes from a partner pack and therefore cannot be edited or deleted at tenant level. False for the tenant's own instructions.

Example: false

sourcestringnullable

The partner pack this instruction belongs to, when it comes from one. Null for the tenant's own instructions.

Example: dutch-invoices

]

correlationIduuid

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",
        "originalFeedbackText": "string",
        "scope": "Vendor",
        "scopePartyReference": {
          "partyName": "string",
          "partyIdentifier": "string"
        },
        "locked": false,
        "source": "dutch-invoices"
      }
    ]
  },
  "correlationId": "fb0ccbbc-62bc-447f-a47e-02b490e25690",
  "isSuccess": true
}