API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · complaints

Complaint Schema

Schema-ID
complaint
Collection
complaints
Permissions
  • Lesencomplaint_view
  • Anlegencomplaint_create
  • Änderncomplaint_edit
  • Löschencomplaint_delete

Felder

Complaint Schema

complaints4 Permissions

Schema for validating Reklamationen (complaint/claim) entities

titlestringerforderlich

Complaint title

1–300 Zeichen
statusstringerforderlich

Workflow status (tenant-configurable)

categorystringoptional

Complaint category (tenant-configurable)

max 100 Zeichennullable
directionstringoptional

INCOMING = customer to us, OUTGOING = us to supplier

INCOMINGOUTGOING
Default: "INCOMING"nullable
prioritystringoptional

Complaint priority

LOWMEDIUMHIGHCRITICAL
Default: "MEDIUM"nullable
sourcestringoptional

How the complaint was received

EMAILPHONEPORTALIN_PERSONLETTERSYSTEM_ALERTOTHER
nullable
descriptionstringoptional

Detailed complaint description

max 10000 Zeichennullable
customerStatementstringoptional

Verbatim customer statement

max 5000 Zeichennullable
internalNotestringoptional

Internal-only note

max 5000 Zeichennullable
partyIduuidoptional

Customer/supplier party UUID

nullable
partyAddressIduuidoptional

Specific site/address of the associated party

Default: nullnullable
contactPartyIduuidoptional

Contact person UUID

nullable
assignedToIduuidoptional

Assigned employee user UUID

nullable
orgUnitIduuidoptional

Responsible department UUID

nullable
linkedTicketIduuidoptional

Linked ticket UUID

nullable
linkedOrderIduuidoptional

Linked sales order UUID

nullable
linkedContractIduuidoptional

Linked contract UUID

nullable
linkedAssetIduuidoptional

Linked asset UUID

nullable
linkedInvoiceIduuidoptional

Linked invoice UUID

nullable
articleIduuidoptional

Related article/product UUID

nullable
responseDeadlinedateoptional

Response deadline (YYYY-MM-DD)

nullable
resolutionDeadlinedateoptional

Resolution deadline (YYYY-MM-DD)

nullable
claimedAmountstringoptional

Claimed amount (Decimal128 as string)

Patternnullable
creditNoteAmountstringoptional

Credit note amount (Decimal128 as string)

Patternnullable
replacementCoststringoptional

Replacement cost (Decimal128 as string)

Patternnullable
currencyCodestringoptional

ISO 4217 currency code

max 3 ZeichenDefault: "EUR"
estimatedCoststringoptional

Estimated total cost (Decimal128 as string)

Patternnullable
actualCoststringoptional

Actual total cost (Decimal128 as string)

Patternnullable
resolutionNotestringoptional

How the complaint was resolved

max 5000 Zeichennullable
rootCauseCategorystringoptional

Root cause category (configurable list)

max 100 Zeichennullable
rootCausestringoptional

Root cause analysis

max 3000 Zeichennullable
correctiveActionstringoptional

Corrective action taken

max 3000 Zeichennullable
preventiveActionstringoptional

Preventive action for future

max 3000 Zeichennullable
isAcceptedbooleanoptional

Whether the complaint was accepted as valid

nullable
rejectionReasonstringoptional

Reason for rejection

max 2000 Zeichennullable
customerSatisfactionRatingnumberoptional

Post-resolution customer satisfaction (1-5)

1 – 5nullable
mergedIntoComplaintIduuidoptional

If set, this complaint was merged into the referenced complaint

nullable
mergedIntoComplaintNumberstringoptional

Complaint number of the complaint this was merged into (denormalized for display)

nullable
receivedAtdatetimeoptional
nullable
acknowledgedAtdatetimeoptional
nullable
acceptedAtdatetimeoptional
nullable
rejectedAtdatetimeoptional
nullable
resolvedAtdatetimeoptional
nullable
closedAtdatetimeoptional
nullable
inboundReplyAckedAtdatetimeoptional

Timestamp at which the latest inbound customer email on this complaint was acknowledged as "handled, no reply needed". Clears the awaiting-reply badge when >= the last inbound email time; a newer inbound email re-arms it. Independent of resolvedAt/closedAt — the badge is shown regardless of workflow state. Mirrors opportunity.inboundReplyAckedAt.

nullable
inboundReplyAckedBystringoptional

User who acknowledged the latest inbound customer email (see inboundReplyAckedAt).

nullable
tagsstring[]optional

Tags

Default: []nullable
attachmentsobject[]optional
Default: []nullable
s3Keystringerforderlich
fileNamestringerforderlich
mimeTypestringerforderlich
sizeBytesnumbererforderlich
uploadedAtdatetimeerforderlich
uploadedByuuiderforderlich
isInternalbooleanerforderlich
linkedEntitiesobject[]optional
Default: []nullable
entityTypestringerforderlich
partyassetticketprojectuseropportunitysales_orderinvoicecontract
entityIduuiderforderlich
rolestringerforderlich
convertedToobjectoptional

Set when this complaint was converted to another entity (ticket). The complaint is kept — not deleted — so linked records stay reachable. Written only by the conversion routes.

read-onlynullable
entityTypestringerforderlich
ticketopportunitycomplaint
entityIduuiderforderlich
convertedAtdatetimeoptional
nullable
convertedBystringoptional
nullable
convertedFromobjectoptional

Set when this complaint was created by converting another entity (ticket). Written only by the conversion routes.

read-onlynullable
entityTypestringerforderlich
ticketopportunitycomplaint
entityIduuiderforderlich
convertedAtdatetimeoptional
nullable
convertedBystringoptional
nullable
statusChangedAtdatetimeoptional

Timestamp of the last status change (drives time_in_status / time_to_status targets, ADR 0117a)

nullable
respondedAtdatetimeoptional

Timestamp of the first agent response to the complaint (drives time_to_first_response targets, ADR 0117a)

nullable
targetsobject[]optional

Denormalized active service targets (ADR 0117a)

nullable
stageIdstringerforderlich
stageKindstringerforderlich
time_to_first_responsetime_in_statustime_to_statustime_to_close
stageStatusstringoptional
nullable
stageLabelstringoptional
nullable
bindingnessstringerforderlich
contractualinternal
deadlinedatetimeerforderlich
breachedAtdatetimeoptional
nullable
completedAtdatetimeoptional
nullable
profileIduuiderforderlich

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/complaints — Liste, paginiert + filterbar
  • GET /api/v1/complaints/<id> — Einzelne Entity
  • POST /api/v1/complaints — Anlegen
  • PATCH /api/v1/complaints/<id> — Teil-Update
  • DELETE /api/v1/complaints/<id> — Soft-Delete
  • GET /api/v1/complaints/<id>/timeline — Audit + Aktivitäten

Suche