KCI Reason Codes

When sending a KCI, the reason for the KCI must be populated along with any supporting fields:

UPDATE

Supplier has updated the order.

  • serviceOrder must be updated with the latest details

DELAY

There is a problem causing a delay.

  • problemCode must be provided
  • supplierCode can be provided if available
  • serviceOrder:status may be updated (this KCI is usually accompanied with a status change to HELD)
  • text can be used to provide further information

COMMITTED

Supplier has committed to the order.

  • serviceOrder:committedDate must be updated
  • serviceOrder:targetDate must be updated
Note

targetDate can be updated based on delays etc. but committedDate is set-once at committed.

INFORMATION_REQUIRED

Tenant must pass an amend order request with the specified additional information.

  • problemCode can be provided if relevant
  • supplierCode can be provided if available
  • text must contain the required information

REAPPOINT

Tenant must reserve a new appointment and pass an amend order request with the new reservation.

  • problemCode must be provided
  • supplierCode can be provided if available
  • text can be used to provide further information

AMENDED

Supplier has accepted and applied the tenant requested order amendment.

  • serviceOrder must be updated
  • serviceOrderAmendmentId or serviceOrderAmendmentReference must be provided

CANCELLED

Supplier has cancelled the order

  • problemCode must be provided
  • supplierCode can be provided if available
  • serviceOrderCancellationId or serviceOrderCancellationReference must be provided where cancellation was requested by tenant
  • text can be used to provide frther information

ORDER_REJECTED

The order has been rejected

  • text must contain the reason for rejection
  • problemCode can be provided
  • supplierCode can be provided if available

AMENDMENT_REJECTED

Tenant has previously sent an amendment request that has been rejected

  • text must contain the reason for rejection
  • problemCode can be provided
  • supplierCode can be provided if available
  • serviceOrderAmendmentId or serviceOrderAmendmentReference must be provided

CANCELLATION_REJECTED

Tenant has previously sent a cancellation request that has been rejected

  • text must contain the reason for rejection
  • problemCode can be provided
  • supplierCode can be provided if available
  • serviceOrderCancellationId or serviceOrderCancellationReference must be provided
Note

KCIs received by the gateway that do not follow these rules may be rejected as 422 Unprocessible Entity

Refer to Order KCIs for more information on problem codes.