Essence Supplier Management API

All OpenAPI documents

Version v1 · OpenAPI 3.0.1 · 227 operations · Download the JSON document

API for managing suppliers, vendors, and performance tracking

Generated from the Supplier service's code at build time (api-specs/generated/Supplier/Essence.Compliance.Supplier.Api.json) and drift-checked in CI. It describes what the code registers, which is not the same as what any one deployment has routed.

ComplianceGate

GET/api/v1/suppliers/compliance-gate/webhook-dead-letters

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	query	string (uuid)	no	—
includeDelivered	query	boolean	no	—
limit	query	integer (int32)	no	—

Request body

No request body.

Responses

200OK — ComplianceWebhookDeadLetterDto[]

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

POST/api/v1/suppliers/compliance-gate/webhook-dead-letters/{attemptId}/replay

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
attemptId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — ComplianceWebhookReplayResultDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/suppliers/compliance-gate/webhooks

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
activeOnly	query	boolean	no	—

Request body

No request body.

Responses

200OK — ComplianceGateWebhookDto[]

401Unauthorized — ProblemDetails

POST/api/v1/suppliers/compliance-gate/webhooks

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• RegisterWebhookRequestDto as application/*+json, application/json, text/json

Responses

201Created — RegisterWebhookResponseDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

DELETE/api/v1/suppliers/compliance-gate/webhooks/{webhookId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
webhookId	path	string (uuid)	yes	—

Request body

No request body.

Responses

204No Content

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/suppliers/{id}/compliance-status

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
fresh	query	boolean	no	—
purchaseOrderReference	query	string	no	—
invoiceReference	query	string	no	—
supplyValueAed	query	number (double)	no	—

Request body

No request body.

Responses

200OK — ComplianceStatusDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

503Service Unavailable

EudrConsignments

GET/api/v1/suppliers/eudr/consignments

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — EudrRegisterEntryDto[]

403Forbidden — ProblemDetails

POST/api/v1/suppliers/eudr/consignments

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• DeclareEudrConsignmentCommand as application/*+json, application/json, text/json

Responses

200OK — EudrConsignmentWorkspaceDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/suppliers/eudr/consignments/{consignmentRef}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
consignmentRef	path	string	yes	—

Request body

No request body.

Responses

200OK — EudrConsignmentWorkspaceDto

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/suppliers/eudr/consignments/{consignmentRef}/authority-response

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
consignmentRef	path	string	yes	—

Request body

Not marked as required in the document.

• RecordEudrAuthorityResponseCommand as application/*+json, application/json, text/json

Responses

200OK — EudrConsignmentWorkspaceDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/suppliers/eudr/consignments/{consignmentRef}/evidence-pack

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
consignmentRef	path	string	yes	—

Request body

No request body.

Responses

200OK — EudrConsignmentWorkspaceDto

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/suppliers/eudr/consignments/{consignmentRef}/filings

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
consignmentRef	path	string	yes	—

Request body

No request body.

Responses

200OK — EudrConsignmentWorkspaceDto

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

503Service Unavailable

GET/api/v1/suppliers/eudr/consignments/{consignmentRef}/inspection

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
consignmentRef	path	string	yes	—
audience	query	string	no	—

Request body

No request body.

Responses

200OK — EudrInspectionRecordDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/suppliers/eudr/consignments/{consignmentRef}/inspections

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
consignmentRef	path	string	yes	—

Request body

No request body.

Responses

200OK — EudrInspectionLogEntryDto[]

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/suppliers/eudr/consignments/{consignmentRef}/signer-sign-off

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
consignmentRef	path	string	yes	—

Request body

No request body.

Responses

200OK — EudrConsignmentWorkspaceDto

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

Form1Issuances

GET/api/v1/suppliers/form1/issuances

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	query	string (uuid)	no	—
lotReference	query	string	no	—

Request body

No request body.

Responses

200OK — Form1IssuanceDto[]

403Forbidden — ProblemDetails

POST/api/v1/suppliers/form1/issuances

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• IssueForm1Command as application/*+json, application/json, text/json

Responses

201Created — Form1IssuanceDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/suppliers/form1/issuances/batch

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• IssueForm1BatchCommand as application/*+json, application/json, text/json

Responses

200OK — Form1IssuanceDto[]

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/suppliers/form1/issuances/{trackingNumber}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
trackingNumber	path	string	yes	—

Request body

No request body.

Responses

200OK — Form1IssuanceDto

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/suppliers/form1/issuances/{trackingNumber}/supersede

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
trackingNumber	path	string	yes	—

Request body

Not marked as required in the document.

• SupersedeForm1Command as application/*+json, application/json, text/json

Responses

200OK — Form1IssuanceDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/suppliers/form1/issuances/{trackingNumber}/withdraw

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
trackingNumber	path	string	yes	—

Request body

Not marked as required in the document.

• WithdrawForm1Command as application/*+json, application/json, text/json

Responses

200OK — Form1IssuanceDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/suppliers/form1/templates

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — Form1TemplateDto[]

403Forbidden — ProblemDetails

PUT/api/v1/suppliers/form1/templates

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• SaveForm1TemplateCommand as application/*+json, application/json, text/json

Responses

200OK — Form1TemplateDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

409Conflict — ProblemDetails

Form1Registry

GET/api/v1/suppliers/form1/registry/resolve

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
reference	query	string	no	—
partSerialNumber	query	string	no	—

Request body

No request body.

Responses

200OK — Form1ResolutionDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

OrganizationCarbonCredits

GET/api/v1/organizations/{organizationId}/carbon-credits/purchases

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — CarbonPurchaseDto[]

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

POST/api/v1/organizations/{organizationId}/carbon-credits/purchases

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• RecordCarbonPurchaseRequestDto as application/*+json, application/json, text/json

Responses

201Created — CarbonPurchaseDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/organizations/{organizationId}/carbon-credits/retirements

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — CarbonRetirementDto[]

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

POST/api/v1/organizations/{organizationId}/carbon-credits/retirements

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• RecordCarbonRetirementRequestDto as application/*+json, application/json, text/json

Responses

201Created — CarbonRetirementDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/organizations/{organizationId}/carbon-credits/retirements/{retirementId}/anchor

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
retirementId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• AttachCarbonAnchorRequestDto as application/*+json, application/json, text/json

Responses

200OK — CarbonRetirementDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/organizations/{organizationId}/carbon-credits/retirements/{retirementId}/check

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
retirementId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• ApplyCarbonCheckRequestDto as application/*+json, application/json, text/json

Responses

200OK — CarbonRetirementDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/organizations/{organizationId}/carbon-credits/retirements/{retirementId}/failure

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
retirementId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• FailCarbonRetirementRequestDto as application/*+json, application/json, text/json

Responses

200OK — CarbonRetirementDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/organizations/{organizationId}/carbon-credits/retirements/{retirementId}/receipt

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
retirementId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• ConfirmCarbonRetirementRequestDto as application/*+json, application/json, text/json

Responses

200OK — CarbonRetirementDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

OrganizationEsgAttestations

GET/api/v1/organizations/{organizationId}/esg-attestations

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — EsgAttestationDto[]

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

POST/api/v1/organizations/{organizationId}/esg-attestations

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• StoreEsgAttestationRequestDto as application/*+json, application/json, text/json

Responses

201Created — EsgAttestationDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/organizations/{organizationId}/esg-attestations/{attestationId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
attestationId	path	string	yes	—

Request body

No request body.

Responses

200OK — EsgAttestationDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

OrganizationFoodSafetyAttestations

GET/api/v1/organizations/{organizationId}/food-safety-attestations

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — FoodSafetyAttestationDto[]

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

POST/api/v1/organizations/{organizationId}/food-safety-attestations

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• RecordFoodSafetyAttestationRequestDto as application/*+json, application/json, text/json

Responses

201Created — FoodSafetyAttestationDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/organizations/{organizationId}/food-safety-issuer-keys

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — FoodSafetyIssuerKeyDto[]

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

POST/api/v1/organizations/{organizationId}/food-safety-issuer-keys

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• EnrolFoodSafetyIssuerKeyRequestDto as application/*+json, application/json, text/json

Responses

201Created — FoodSafetyIssuerKeyDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

409Conflict — ProblemDetails

DELETE/api/v1/organizations/{organizationId}/food-safety-issuer-keys/{keyId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
keyId	path	string	yes	—

Request body

No request body.

Responses

200OK — FoodSafetyIssuerKeyDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

Reassessment

GET/api/v1/suppliers/reassessment-activity

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — SweepActivityEntryDto[]

403Forbidden — ProblemDetails

GET/api/v1/suppliers/reassessment-authority

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — CycleAuthorityDto

403Forbidden — ProblemDetails

GET/api/v1/suppliers/reassessment-cycles

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — CycleRunDto[]

403Forbidden — ProblemDetails

POST/api/v1/suppliers/reassessment-cycles

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• LaunchCycleRequestDto as application/*+json, application/json, text/json

Responses

200OK — CycleRunDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/suppliers/reassessment-cycles/{cycleId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
cycleId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — CycleRunDto

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/suppliers/reassessment-cycles/{cycleId}/approve

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
cycleId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — CycleRunDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/suppliers/reassessment-cycles/{cycleId}/cancel

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
cycleId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — CycleRunDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/suppliers/reassessment-cycles/{cycleId}/remediation-notices

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
cycleId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — RemediationNoticeDto[]

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/suppliers/reassessment-cycles/{cycleId}/remediation-notices

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
cycleId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• SendRemediationNoticesRequestDto as application/*+json, application/json, text/json

Responses

200OK — RemediationNoticeDto[]

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/suppliers/reassessment-policies

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — ReassessmentPolicyDto[]

403Forbidden — ProblemDetails

POST/api/v1/suppliers/reassessment-policies

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• ReassessmentPolicyDto as application/*+json, application/json, text/json

Responses

200OK — ReassessmentPolicyDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

PUT/api/v1/suppliers/reassessment-policies/{policyId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
policyId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• ReassessmentPolicyDto as application/*+json, application/json, text/json

Responses

200OK — ReassessmentPolicyDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/suppliers/reassessment-remediation-sla

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — RemediationSlaDto

403Forbidden — ProblemDetails

PUT/api/v1/suppliers/reassessment-remediation-sla

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• RemediationSlaDto as application/*+json, application/json, text/json

Responses

200OK — RemediationSlaDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

RosterEligibility

GET/api/v1/roster-eligibility/rules/{organizationId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — RosterEligibilityRuleDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

PUT/api/v1/roster-eligibility/rules/{organizationId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• RosterEligibilityRuleDto as application/*+json, application/json, text/json

Responses

200OK — RosterEligibilityRuleDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

409Conflict — ProblemDetails

SupplierBankDetailChanges

GET/api/v1/suppliers/{supplierId}/bank-detail-changes

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — SupplierBankDetailChangeDto[]

404Not Found — ProblemDetails

GET/api/v1/suppliers/{supplierId}/bank-detail-changes/{changeId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—
changeId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — SupplierBankDetailChangeDto

404Not Found — ProblemDetails

POST/api/v1/suppliers/{supplierId}/bank-detail-changes/{changeId}/approve

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—
changeId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• DecideSupplierBankDetailChangeRequest as application/*+json, application/json, text/json

Responses

200OK — SupplierBankDetailChangeDto

403Forbidden — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/suppliers/{supplierId}/bank-detail-changes/{changeId}/cancel

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—
changeId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• CancelSupplierBankDetailChangeRequest as application/*+json, application/json, text/json

Responses

200OK — SupplierBankDetailChangeDto

403Forbidden — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/suppliers/{supplierId}/bank-detail-changes/{changeId}/refuse

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—
changeId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• DecideSupplierBankDetailChangeRequest as application/*+json, application/json, text/json

Responses

200OK — SupplierBankDetailChangeDto

403Forbidden — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/suppliers/{supplierId}/bank-detail-changes/{changeId}/verify

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—
changeId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• VerifySupplierBankDetailChangeRequest as application/*+json, application/json, text/json

Responses

200OK — SupplierBankDetailChangeDto

403Forbidden — ProblemDetails

409Conflict — ProblemDetails

SupplierBondCalls

GET/api/v1/suppliers/bond-calls

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	query	string (uuid)	no	—

Request body

No request body.

Responses

200OK — BondCallSummaryDto[]

403Forbidden — ProblemDetails

POST/api/v1/suppliers/bond-calls

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• DeclareContractorDefaultCommand as application/*+json, application/json, text/json

Responses

201Created — BondCallDetailDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/suppliers/bond-calls/{bondCallId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
bondCallId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — BondCallDetailDto

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/suppliers/bond-calls/{bondCallId}/approvals

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
bondCallId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• RecordBondCallApprovalCommand as application/*+json, application/json, text/json

Responses

200OK — BondCallDetailDto

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/suppliers/bond-calls/{bondCallId}/demand

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
bondCallId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• IssueBondDemandCommand as application/*+json, application/json, text/json

Responses

200OK — BondCallDetailDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/suppliers/bond-calls/{bondCallId}/links

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
bondCallId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• AddBondCallLinkCommand as application/*+json, application/json, text/json

Responses

200OK — BondCallDetailDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/suppliers/bond-calls/{bondCallId}/links/{linkId}/anchor

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
bondCallId	path	string (uuid)	yes	—
linkId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• AnchorBondCallLinkCommand as application/*+json, application/json, text/json

Responses

200OK — BondCallDetailDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/suppliers/bond-calls/{bondCallId}/surety-response

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
bondCallId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• RecordSuretyResponseCommand as application/*+json, application/json, text/json

Responses

200OK — BondCallDetailDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

SupplierBulkImport

POST/api/v1/suppliers/import

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• object as multipart/form-data

Responses

200OK — BulkImportSummary

400Bad Request — ProblemDetails

SupplierComplianceLifecycle

GET/api/v1/suppliers/{id}/audit

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
action	query	string	no	—

Request body

No request body.

Responses

200OK — SupplierAuditEntryDto[]

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/suppliers/{id}/credentials

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — SupplierCredentialDto[]

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/suppliers/{id}/credentials/{credentialId}/verify

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
credentialId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — SupplierCredentialDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/suppliers/{id}/reinstate

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• ReinstateSupplierRequestDto as application/*+json, application/json, text/json

Responses

204No Content

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/suppliers/{id}/sanctions-cases

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — SanctionsCaseDto[]

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/suppliers/{id}/sanctions-cases/{caseId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
caseId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — SanctionsCaseDetailDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/suppliers/{id}/sanctions-cases/{caseId}/adjudication

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
caseId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• AdjudicateSanctionsCaseRequestDto as application/*+json, application/json, text/json

Responses

200OK — SanctionsCaseDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

503Service Unavailable — ProblemDetails

POST/api/v1/suppliers/{id}/sanctions-cases/{caseId}/override

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
caseId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• GrantSanctionsOverrideRequestDto as application/*+json, application/json, text/json

Responses

200OK — SanctionsCaseDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

SupplierContinuityPlans

GET/api/v1/suppliers/continuity-plans

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
category	query	string	no	—

Request body

No request body.

Responses

200OK — ContinuityPlanDto[]

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

POST/api/v1/suppliers/continuity-plans

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• CreateContinuityPlanRequestDto as application/*+json, application/json, text/json

Responses

201Created — ContinuityPlanDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/suppliers/continuity-plans/{planId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
planId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — ContinuityPlanDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

DELETE/api/v1/suppliers/continuity-plans/{planId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
planId	path	string (uuid)	yes	—

Request body

No request body.

Responses

204No Content

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/suppliers/continuity-plans/{planId}/activation

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
planId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• ActivateContinuityAlternateRequestDto as application/*+json, application/json, text/json

Responses

200OK — ContinuityPlanDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/suppliers/continuity-plans/{planId}/activation/close

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
planId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• CloseContinuityFailoverRequestDto as application/*+json, application/json, text/json

Responses

200OK — ContinuityPlanDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/suppliers/continuity-plans/{planId}/activation/override

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
planId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• OverrideContinuityActivationRequestDto as application/*+json, application/json, text/json

Responses

200OK — ContinuityPlanDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

PUT/api/v1/suppliers/continuity-plans/{planId}/alternate

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
planId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• NameContinuityAlternateRequestDto as application/*+json, application/json, text/json

Responses

200OK — ContinuityPlanDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

SupplierDashboard

GET/api/v1/organizations/{organizationId}/dashboard

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — SupplierDashboardSnapshotDto

SupplierDelivery

GET/api/v1/suppliers/{supplierId}/delivery/goods-receipts

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—
purchaseOrderReference	query	string	no	—

Request body

No request body.

Responses

200OK — GoodsReceivedRecordDto[]

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/suppliers/{supplierId}/delivery/goods-receipts

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• RecordGoodsReceivedCommand as application/*+json, application/json, text/json

Responses

201Created — GoodsReceivedRecordDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/suppliers/{supplierId}/delivery/issues

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• LogDeliveryIssueCommand as application/*+json, application/json, text/json

Responses

201Created — SupplierIncidentDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/suppliers/{supplierId}/delivery/metrics

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — SupplierDeliveryMetricsDto[]

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/suppliers/{supplierId}/delivery/metrics

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• RecordDeliveryMetricsCommand as application/*+json, application/json, text/json

Responses

201Created — SupplierDeliveryMetricsDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/suppliers/{supplierId}/delivery/trends

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—
from	query	string (date-time)	no	—
to	query	string (date-time)	no	—

Request body

No request body.

Responses

200OK — DeliveryTrendsDto

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

SupplierEsg

GET/api/v1/suppliers/esg/report

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — EsgReportDto

403Forbidden — ProblemDetails

GET/api/v1/suppliers/{supplierId}/esg

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — SupplierEsgProfileDto

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

PATCH/api/v1/suppliers/{supplierId}/esg

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• UpdateEsgProfileCommand as application/*+json, application/json, text/json

Responses

200OK — SupplierEsgProfileDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/suppliers/{supplierId}/esg/evidence-sources

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — EsgEvidenceSourceDto[]

403Forbidden — ProblemDetails

POST/api/v1/suppliers/{supplierId}/esg/evidence-sources

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• BindEsgEvidenceSourceRequestDto as application/*+json, application/json, text/json

Responses

200OK — EsgEvidenceSourceDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

409Conflict — ProblemDetails

DELETE/api/v1/suppliers/{supplierId}/esg/evidence-sources/{sourceId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—
sourceId	path	string (uuid)	yes	—

Request body

No request body.

Responses

204No Content

403Forbidden — ProblemDetails

SupplierFinancial

GET/api/v1/suppliers/financial/concentration

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — SupplierConcentrationDto

403Forbidden — ProblemDetails

GET/api/v1/suppliers/{supplierId}/financial

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — SupplierFinancialProfileDto

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

PATCH/api/v1/suppliers/{supplierId}/financial

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• UpdateFinancialProfileCommand as application/*+json, application/json, text/json

Responses

200OK — SupplierFinancialProfileDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/suppliers/{supplierId}/financial/credit-check

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — CreditCheckResultDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

429Too Many Requests — ProblemDetails

GET/api/v1/suppliers/{supplierId}/financial/spend

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — SupplierSpendDto

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

SupplierFoodSafetyAttestations

GET/api/v1/supplier-food-safety-attestations

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	query	string (uuid)	no	—
consignmentReference	query	string	no	—

Request body

No request body.

Responses

200OK — FoodSafetyAttestationEvidenceDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

SupplierGatePolicy

GET/api/v1/organizations/{organizationId}/supplier-gate-policy

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — GatePolicyDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

PUT/api/v1/organizations/{organizationId}/supplier-gate-policy

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• GatePolicyDto as application/*+json, application/json, text/json

Responses

200OK — GatePolicyDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/organizations/{organizationId}/supplier-gate-policy/changes

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — GatePolicyChangeDto[]

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

POST/api/v1/organizations/{organizationId}/supplier-gate-policy/preview

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• GatePolicyDto as application/*+json, application/json, text/json

Responses

200OK — PolicyPreviewRowDto[]

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

SupplierInsurance

GET/api/v1/suppliers/{supplierId}/insurance

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — SupplierInsuranceDto[]

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/suppliers/{supplierId}/insurance

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• AddInsuranceCommand as application/*+json, application/json, text/json

Responses

201Created — SupplierInsuranceDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/suppliers/{supplierId}/insurance/adequacy

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — InsuranceAdequacyDto

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

DELETE/api/v1/suppliers/{supplierId}/insurance/{insuranceId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—
insuranceId	path	string (uuid)	yes	—

Request body

No request body.

Responses

204No Content

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

PATCH/api/v1/suppliers/{supplierId}/insurance/{insuranceId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—
insuranceId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• UpdateInsuranceCommand as application/*+json, application/json, text/json

Responses

200OK — SupplierInsuranceDto

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/suppliers/{supplierId}/insurance/{insuranceId}/renew

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—
insuranceId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• RenewInsuranceCommand as application/*+json, application/json, text/json

Responses

200OK — SupplierInsuranceDto

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

SupplierKpi

GET/api/v1/organizations/{organizationId}/kpi-definitions

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — KpiDefinitionDto[]

403Forbidden — ProblemDetails

POST/api/v1/organizations/{organizationId}/kpi-definitions

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• CreateKpiDefinitionRequest as application/*+json, application/json, text/json

Responses

201Created — KpiDefinitionDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

SupplierPortal

POST/api/v1/supplier-portal/sessions

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• SupplierPortalSessionRequest as application/*+json, application/json, text/json

Responses

200OK — SupplierPortalSessionResponse

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

GET/api/v1/supplier-portal/suppliers/{supplierId}/profile

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — SupplierPortalProfileDto

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/supplier-portal/suppliers/{supplierId}/remediation-notices

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — RemediationNoticeDto[]

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

SupplierPortalBankDetailChanges

GET/api/v1/supplier-portal/suppliers/{supplierId}/bank-detail-changes

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — SupplierBankDetailChangeDto[]

404Not Found — ProblemDetails

POST/api/v1/supplier-portal/suppliers/{supplierId}/bank-detail-changes

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• RaiseSupplierBankDetailChangeRequest as application/*+json, application/json, text/json

Responses

201Created — SupplierBankDetailChangeDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

422Unprocessable Content — ProblemDetails

POST/api/v1/supplier-portal/suppliers/{supplierId}/bank-detail-changes/{changeId}/cancel

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—
changeId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• CancelSupplierBankDetailChangeRequest as application/*+json, application/json, text/json

Responses

200OK — SupplierBankDetailChangeDto

404Not Found — ProblemDetails

409Conflict — ProblemDetails

SupplierPortalContext

GET/api/v1/suppliers/portal/me

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — SupplierPortalContextDto

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

SupplierPortalCredentialUploads

POST/api/v1/supplier-portal/suppliers/{supplierId}/credential-uploads

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• UploadSupplierPortalCredentialRequest as application/*+json, application/json, text/json

Responses

201Created — SupplierCredentialDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/supplier-portal/suppliers/{supplierId}/credential-uploads/target

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — SupplierPortalCredentialUploadTargetDto

404Not Found — ProblemDetails

409Conflict — ProblemDetails

SupplierPortalExit

POST/api/v1/supplier-portal/suppliers/{supplierId}/exit

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• SupplierExitRequestDto as application/*+json, application/json, text/json

Responses

200OK — SupplierExitDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

SupplierPortalInvitations

POST/api/v1/suppliers/{supplierId}/portal-invitations

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

No request body.

Responses

201Created — IssueSupplierPortalInviteResult

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

SupplierPortalProfileChanges

GET/api/v1/supplier-portal/suppliers/{supplierId}/profile-changes

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — SupplierProfileChangeDto[]

404Not Found — ProblemDetails

POST/api/v1/supplier-portal/suppliers/{supplierId}/profile-changes

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• SubmitSupplierProfileChangeRequest as application/*+json, application/json, text/json

Responses

201Created — SupplierProfileChangeDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

SupplierProfileChanges

GET/api/v1/suppliers/{supplierId}/profile-changes

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — SupplierProfileChangeDto[]

404Not Found — ProblemDetails

POST/api/v1/suppliers/{supplierId}/profile-changes/{changeId}/accept

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—
changeId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• DecideSupplierProfileChangeRequest as application/*+json, application/json, text/json

Responses

200OK — SupplierProfileChangeDto

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/suppliers/{supplierId}/profile-changes/{changeId}/reject

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—
changeId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• DecideSupplierProfileChangeRequest as application/*+json, application/json, text/json

Responses

200OK — SupplierProfileChangeDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

SupplierReports

GET/api/v1/organizations/{organizationId}/supplier-reports/compliance

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
format	query	string	no	—

Request body

No request body.

Responses

200OK — SupplierComplianceReport

403Forbidden — ProblemDetails

GET/api/v1/organizations/{organizationId}/supplier-reports/esg

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
format	query	string	no	—

Request body

No request body.

Responses

200OK — SupplierEsgReport

GET/api/v1/organizations/{organizationId}/supplier-reports/expiry-forecast

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
daysAhead	query	integer (int32)	no	—
format	query	string	no	—

Request body

No request body.

Responses

200OK — SupplierExpiryForecastReport

403Forbidden — ProblemDetails

GET/api/v1/organizations/{organizationId}/supplier-reports/risk

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
format	query	string	no	—

Request body

No request body.

Responses

200OK — SupplierRiskReport

403Forbidden — ProblemDetails

GET/api/v1/organizations/{organizationId}/supplier-reports/spend

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
format	query	string	no	—

Request body

No request body.

Responses

200OK — SupplierSpendReport

SupplierRiskMitigation

POST/api/v1/suppliers/{supplierId}/risk-assessment

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — RiskAssessmentResultDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

429Too Many Requests — ProblemDetails

GET/api/v1/suppliers/{supplierId}/risk-mitigation-plans

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — RiskMitigationPlanDto[]

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/suppliers/{supplierId}/risk-mitigation-plans

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• CreateMitigationPlanCommand as application/*+json, application/json, text/json

Responses

201Created — RiskMitigationPlanDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/suppliers/{supplierId}/risk-mitigation-plans/{planId}/activate

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—
planId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — RiskMitigationPlanDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/suppliers/{supplierId}/risk-mitigation-plans/{planId}/cancel

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—
planId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — RiskMitigationPlanDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/suppliers/{supplierId}/risk-mitigation-plans/{planId}/complete

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—
planId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — RiskMitigationPlanDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

SupplierRiskSettings

GET/api/v1/suppliers/risk-settings

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — RiskSettingsDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

PUT/api/v1/suppliers/risk-settings

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• SaveRiskSettingsRequestDto as application/*+json, application/json, text/json

Responses

200OK — RiskSettingsDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

409Conflict — ProblemDetails

Suppliers

POST/api/v1/Suppliers

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• CreateSupplierCommand as application/*+json, application/json, text/json

Responses

201Created — SupplierDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

GET/api/v1/Suppliers/linked-buyers

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — LinkedBuyerDto[]

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

POST/api/v1/Suppliers/linked-buyers/{buyerOrganizationId}/exit

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
buyerOrganizationId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• SupplierExitRequestDto as application/*+json, application/json, text/json

Responses

200OK — SupplierExitDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/Suppliers/organization/{organizationId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
cursor	query	string	no	—
limit	query	integer (int32)	no	—

Request body

No request body.

Responses

200OK — SupplierDtoCursorResult

401Unauthorized — ProblemDetails

GET/api/v1/Suppliers/organization/{organizationId}/credentials/expiring

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
daysThreshold	query	integer (int32)	no	—

Request body

No request body.

Responses

200OK — SupplierDto[]

401Unauthorized — ProblemDetails

GET/api/v1/Suppliers/organization/{organizationId}/requiring-review

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — SupplierDto[]

401Unauthorized — ProblemDetails

GET/api/v1/Suppliers/organization/{organizationId}/risk-level/{riskLevel}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
riskLevel	path	SupplierRiskLevel	yes	—
cursor	query	string	no	—
limit	query	integer (int32)	no	—

Request body

No request body.

Responses

200OK — SupplierDtoCursorResult

401Unauthorized — ProblemDetails

GET/api/v1/Suppliers/organization/{organizationId}/status/{status}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
organizationId	path	string (uuid)	yes	—
status	path	SupplierStatus	yes	—
cursor	query	string	no	—
limit	query	integer (int32)	no	—

Request body

No request body.

Responses

200OK — SupplierDtoCursorResult

401Unauthorized — ProblemDetails

GET/api/v1/Suppliers/{id}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — SupplierDto

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/Suppliers/{id}/approve

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• ApproveSupplierCommand as application/*+json, application/json, text/json

Responses

204No Content

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

PUT/api/v1/Suppliers/{id}/contract

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• UpdateContractCommand as application/*+json, application/json, text/json

Responses

204No Content

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/Suppliers/{id}/credentials

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• AddCredentialCommand as application/*+json, application/json, text/json

Responses

204No Content

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/Suppliers/{id}/credentials/expiry

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
daysThreshold	query	integer (int32)	no	—

Request body

No request body.

Responses

200OK — SupplierCredentialDto[]

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

DELETE/api/v1/Suppliers/{id}/credentials/{credentialId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
credentialId	path	string (uuid)	yes	—

Request body

No request body.

Responses

204No Content

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

PATCH/api/v1/Suppliers/{id}/credentials/{credentialId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
credentialId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• RenewCredentialCommand as application/*+json, application/json, text/json

Responses

200OK — SupplierCredentialDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

PUT/api/v1/Suppliers/{id}/data-categories

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• UpdateDataCategoriesCommand as application/*+json, application/json, text/json

Responses

204No Content

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/Suppliers/{id}/dpa

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• AttachDpaCommand as application/*+json, application/json, text/json

Responses

204No Content

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/Suppliers/{id}/escalate

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• EscalateSupplierRequestDto as application/*+json, application/json, text/json

Responses

204No Content

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/Suppliers/{id}/generate-contract

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• GenerateSupplierContractCommand as application/*+json, application/json, text/json

Responses

200OK — GenerateSupplierContractResult

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

502Bad Gateway

POST/api/v1/Suppliers/{id}/hold

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• PutOnHoldCommand as application/*+json, application/json, text/json

Responses

204No Content

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/Suppliers/{id}/link

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• DeclareSupplierOrgLinkRequestDto as application/*+json, application/json, text/json

Responses

204No Content

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

DELETE/api/v1/Suppliers/{id}/link

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

204No Content

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/Suppliers/{id}/offboard

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• OffboardSupplierRequestDto as application/*+json, application/json, text/json

Responses

200OK — SupplierOffboardingDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/Suppliers/{id}/offboarding

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — SupplierOffboardingDto

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/Suppliers/{id}/offboarding/steps/{step}/complete

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
step	path	OffboardingStepKind	yes	—

Request body

Not marked as required in the document.

• CompleteOffboardingStepRequestDto as application/*+json, application/json, text/json

Responses

200OK — SupplierOffboardingDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/Suppliers/{id}/offboarding/steps/{step}/waive

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
step	path	OffboardingStepKind	yes	—

Request body

Not marked as required in the document.

• WaiveOffboardingStepRequestDto as application/*+json, application/json, text/json

Responses

200OK — SupplierOffboardingDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/Suppliers/{id}/reactivate

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

204No Content

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/Suppliers/{id}/register-verification

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — SupplierRegisterVerificationDto

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/Suppliers/{id}/register-verification/manual-review

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• RecordSupplierRegisterReviewRequest as application/*+json, application/json, text/json

Responses

200OK — SupplierRegisterVerificationDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

PUT/api/v1/Suppliers/{id}/risk-level

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• UpdateRiskLevelCommand as application/*+json, application/json, text/json

Responses

204No Content

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/Suppliers/{id}/schedule-review

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• ScheduleReviewCommand as application/*+json, application/json, text/json

Responses

204No Content

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/Suppliers/{id}/suspend

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• SuspendSupplierRequestDto as application/*+json, application/json, text/json

Responses

204No Content

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/Suppliers/{id}/terminate

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• TerminateSupplierCommand as application/*+json, application/json, text/json

Responses

204No Content

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

SupplierScorecards

GET/api/v1/suppliers/{supplierId}/scorecards

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—
limit	query	integer (int32)	no	—

Request body

No request body.

Responses

200OK — ScorecardDto[]

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/suppliers/{supplierId}/scorecards

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• ComputeScorecardRequest as application/*+json, application/json, text/json

Responses

201Created — ScorecardDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

SupplierSizeAndDiversity

GET/api/v1/suppliers/{id}/diversity-status

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — SupplierDiversityStatusDto

404Not Found — ProblemDetails

GET/api/v1/suppliers/{id}/sme-size

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — SupplierSmeSizeDto

404Not Found — ProblemDetails

PUT/api/v1/suppliers/{id}/sme-size

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• SetSupplierSmeSizeRequestDto as application/*+json, application/json, text/json

Responses

200OK — SupplierSmeSizeDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

SupplierVerification

GET/api/v1/suppliers/verification-attestations

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — VerificationAttestationDto[]

POST/api/v1/suppliers/verification-attestations

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• AttestVerificationPeriodRequestDto as application/*+json, application/json, text/json

Responses

201Created — VerificationAttestationDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/suppliers/verification-files/{fileId}/inspection

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
fileId	path	string (uuid)	yes	—
X-Inspection-Token	header	string	no	—
format	query	string	no	—

Request body

No request body.

Responses

200OK

404Not Found — ProblemDetails

GET/api/v1/suppliers/verification-policy

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — VerificationPolicyStateDto

403Forbidden — ProblemDetails

PUT/api/v1/suppliers/verification-policy

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• AdoptVerificationPolicyRequestDto as application/*+json, application/json, text/json

Responses

200OK — VerificationPolicyDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

GET/api/v1/suppliers/verification-policy/versions

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — VerificationPolicyDto[]

403Forbidden — ProblemDetails

POST/api/v1/suppliers/verification-presets/uae-vat-decision-13

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — VerificationPresetAdoptionDto

403Forbidden — ProblemDetails

GET/api/v1/suppliers/{id}/check-reviews

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — SupplierCheckReviewDto[]

404Not Found — ProblemDetails

POST/api/v1/suppliers/{id}/check-reviews

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• ReviewSupplierCheckRequestDto as application/*+json, application/json, text/json

Responses

201Created — SupplierCheckReviewDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

PUT/api/v1/suppliers/{id}/legal-form

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• SetSupplierLegalFormRequestDto as application/*+json, application/json, text/json

Responses

200OK — SetSupplierLegalFormRequestDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/suppliers/{id}/verification-files

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — VerificationFileSummaryDto[]

404Not Found — ProblemDetails

POST/api/v1/suppliers/{id}/verification-files

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• IssueVerificationFileRequestDto as application/*+json, application/json, text/json

Responses

201Created — VerificationFileSummaryDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/suppliers/{id}/verification-files/{fileId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
fileId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — VerificationFileSummaryDto

404Not Found — ProblemDetails

POST/api/v1/suppliers/{id}/verification-files/{fileId}/anchor

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
fileId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• RecordVerificationFileAnchorRequestDto as application/*+json, application/json, text/json

Responses

200OK — VerificationFileSummaryDto

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/suppliers/{id}/verification-files/{fileId}/inspector-grants

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
fileId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — InspectorGrantDto[]

404Not Found — ProblemDetails

POST/api/v1/suppliers/{id}/verification-files/{fileId}/inspector-grants

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
fileId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• IssueInspectorGrantRequestDto as application/*+json, application/json, text/json

Responses

201Created — InspectorGrantIssuedDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/suppliers/{id}/verification-files/{fileId}/inspector-grants/{grantId}/revoke

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
fileId	path	string (uuid)	yes	—
grantId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — InspectorGrantDto

404Not Found — ProblemDetails

GET/api/v1/suppliers/{id}/verification-files/{fileId}/manifest

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
fileId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK

404Not Found — ProblemDetails

GET/api/v1/suppliers/{id}/verification-files/{fileId}/pdf

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
fileId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK

404Not Found — ProblemDetails

GET/api/v1/suppliers/{id}/verification-receipts

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — VerificationReceiptsDto

404Not Found — ProblemDetails

POST/api/v1/suppliers/{id}/verification-receipts/{receiptId}/anchor

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
receiptId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• RecordVerificationReceiptAnchorRequestDto as application/*+json, application/json, text/json

Responses

200OK — VerificationReceiptDto

404Not Found — ProblemDetails

409Conflict — ProblemDetails

SupplyVerifications

GET/api/v1/suppliers/{supplierId}/supply-verifications

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—
purchaseOrderReference	query	string	no	—
invoiceReference	query	string	no	—
take	query	integer (int32)	no	—

Request body

No request body.

Responses

200OK — SupplyVerificationDto[]

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/suppliers/{supplierId}/supply-verifications

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
supplierId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• RecordSupplyVerificationRequest as application/*+json, application/json, text/json

Responses

201Created — SupplyVerificationDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

Tenders

GET/api/v1/tenders

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — TenderSummaryDto[]

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

POST/api/v1/tenders

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• PublishTenderRequestDto as application/*+json, application/json, text/json

Responses

201Created — TenderDetailDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

GET/api/v1/tenders/invitations

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — TenderInvitationDto[]

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

GET/api/v1/tenders/{id}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — TenderDetailDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/tenders/{id}/access-log

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — BidAccessLogEntryDto[]

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/tenders/{id}/available-evidence

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — EvidenceReferenceDto[]

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/tenders/{id}/award

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — AwardOutcomeDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/tenders/{id}/award

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• AwardRequestDto as application/*+json, application/json, text/json

Responses

200OK — AwardOutcomeDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/tenders/{id}/bid/access-log

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — BidAccessLogEntryDto[]

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/tenders/{id}/bids

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — BidDto[]

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/tenders/{id}/cancel

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• CancelTenderRequestDto as application/*+json, application/json, text/json

Responses

200OK — TenderDetailDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/tenders/{id}/coi-attestations

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — CoiAttestationDto[]

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/tenders/{id}/coi-attestations

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• AttestConflictOfInterestRequestDto as application/*+json, application/json, text/json

Responses

200OK — CoiAttestationDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/tenders/{id}/debrief

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — DebriefPackDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/tenders/{id}/responses

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• RespondToTenderRequestDto as application/*+json, application/json, text/json

Responses

200OK — RespondToTenderResultDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/tenders/{id}/scores

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — BidScoreDto[]

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

PUT/api/v1/tenders/{id}/scores

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• SaveBidScoresRequestDto as application/*+json, application/json, text/json

Responses

200OK — BidScoreDto[]

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/tenders/{id}/stages/{stageId}/outcome

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
stageId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — StageOutcomeResultDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/tenders/{id}/withdraw

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200OK — WithdrawTenderResponseResultDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

Schemas

ActivateContinuityAlternateRequestDto

Property	Type	Required	Description
reason	string | null	no	—

AddBondCallLinkCommand

Property	Type	Required	Description
anchorId	string | null	no	—
anchoredAt	string (date-time) | null	no	—
bondCallChainId	string (uuid)	no	—
contentHash	string | null	no	—
derivedFromLinkId	string (uuid) | null	no	—
linkType	string | null	no	—
referenceId	string (uuid) | null	no	—
referenceLabel	string | null	no	—
requestingOrganizationId	string (uuid)	no	—

AddCredentialCommand

Property	Type	Required	Description
attributes	map<string, string> | null	no	—
certificateNumber	string | null	no	—
expirationDate	string (date-time)	no	—
isRequired	boolean	no	—
issueDate	string (date-time)	no	—
issuer	string | null	no	—
name	string | null	no	—
requestingOrganizationId	string (uuid)	no	—
supplierId	string (uuid)	no	—
type	CredentialType	no	—

AddInsuranceCommand

Property	Type	Required	Description
coverageAmount	number (double)	no	—
coverageCurrency	string | null	no	—
documentId	string (uuid) | null	no	—
expiryDate	string (date-time)	no	—
insuranceType	InsuranceType	no	—
meetsMinimum	boolean	no	—
notes	string | null	no	—
policyNumber	string | null	no	—
provider	string | null	no	—
requestingOrganizationId	string (uuid)	no	—
startDate	string (date-time)	no	—
supplierId	string (uuid)	no	—
territory	string | null	no	—

AdjudicateSanctionsCaseRequestDto

Property	Type	Required	Description
reason	string | null	no	—
verdict	SanctionsCaseStatus	no	—

AdoptVerificationPolicyRequestDto

Property	Type	Required	Description
performerRoles	string[] | null	no	—
reviewerRoles	string[] | null	no	—
statement	string | null	no	—
supervisorRoles	string[] | null	no	—

AnchorBondCallLinkCommand

Property	Type	Required	Description
actorUserId	string (uuid)	no	—
anchorId	string | null	no	—
anchoredAt	string (date-time)	no	—
bondCallChainId	string (uuid)	no	—
linkId	string (uuid)	no	—
requestingOrganizationId	string (uuid)	no	—

AnchorProofDto

Property	Type	Required	Description
anchorId	string | null	no	—
anchoredAt	string (date-time) | null	no	—
blockHeight	integer (int64)	no	—
contentHashHex	string | null	no	—
state	string | null	no	—
txHash	string | null	no	—

ApplyCarbonCheckRequestDto

Property	Type	Required	Description
report	unspecified	no	—

ApproveSupplierCommand

Property	Type	Required	Description
approvedBy	string (uuid)	no	—
requestingOrganizationId	string (uuid)	no	—
supplierId	string (uuid)	no	—

AttachCarbonAnchorRequestDto

Property	Type	Required	Description
anchorId	string | null	no	—
anchoredAt	string (date-time) | null	no	—
blockHeight	integer (int64)	no	—
contentHashHex	string | null	no	—
state	string | null	no	—
txHash	string | null	no	—

AttachDpaCommand

Property	Type	Required	Description
dpaReference	string | null	no	—
requestingOrganizationId	string (uuid)	no	—
supplierId	string (uuid)	no	—

AttestConflictOfInterestRequestDto

Property	Type	Required	Description
conflictDeclared	boolean	no	—
declaredInterest	string | null	no	—

AttestVerificationPeriodRequestDto

Property	Type	Required	Description
periodEnd	string (date-time)	no	—
periodStart	string (date-time)	no	—
statement	string | null	no	—

AwardEvaluatorDto

Property	Type	Required	Description
coiAttested	boolean	no	—
coiEntries	CoiAttestationEntryDto[] | null	no	—
conflictDeclared	boolean	no	—
declaredInterest	string | null	no	—
evaluatorId	string (uuid)	no	—
evaluatorName	string | null	no	—

AwardEvidenceLineDto

Property	Type	Required	Description
bidId	string (uuid)	no	—
changedSinceAward	boolean	no	—
credentialId	string (uuid)	no	—
currentStatus	string | null	no	—
expiresAtAward	string (date-time) | null	no	—
flagged	boolean	no	—
label	string | null	no	—
statusAtAward	string | null	no	—
typeCode	string | null	no	—
verifiedAtAward	boolean	no	—

AwardOutcomeDto

Property	Type	Required	Description
awardId	string (uuid)	no	—
bidderReasons	string | null	no	—
consentExpiryLedger	ConsentExpiryLedgerEntryDto[] | null	no	—
decidedAt	string (date-time)	no	—
decidedByName	string | null	no	—
evaluators	AwardEvaluatorDto[] | null	no	—
evidenceProvenance	AwardEvidenceLineDto[] | null	no	—
evidenceProvenanceRecorded	boolean	no	—
flaggedEvidenceCount	integer (int32)	no	—
notifiedCount	integer (int32)	no	—
rationale	string | null	no	—
scores	AwardScoreLineDto[] | null	no	—
tenderId	string (uuid)	no	—
winningBidId	string (uuid)	no	—
winningSupplierName	string | null	no	—

AwardRequestDto

Property	Type	Required	Description
bidderReasons	string | null	no	—
rationale	string | null	no	—
winningBidId	string (uuid)	no	—

AwardScoreLineDto

Property	Type	Required	Description
belowGate	boolean	no	—
bidId	string (uuid)	no	—
evidenceFlagged	boolean	no	—
notified	boolean	no	—
outcome	string | null	no	—
supplierName	string | null	no	—
weightedTotal	number (double)	no	—

BidAccessLogEntryDto

Property	Type	Required	Description
actorName	string | null	no	—
bidId	string (uuid)	no	—
evidenceTypeCode	string | null	no	—
id	string (uuid)	no	—
occurredAt	string (date-time)	no	—
supplierName	string | null	no	—

BidDto

Property	Type	Required	Description
consentExpiresAt	string (date-time) | null	no	—
consentGrantId	string (uuid) | null	no	—
evidence	EvidenceReferenceDto[] | null	no	—
id	string (uuid)	no	—
stageGrants	BidStageGrantDto[] | null	no	—
stageOutcomes	BidStageOutcomeDto[] | null	no	—
status	string | null	no	—
submittedAt	string (date-time) | null	no	—
supplierId	string (uuid)	no	—
supplierName	string | null	no	—
tenderId	string (uuid)	no	—

BidScoreDto

Property	Type	Required	Description
bidId	string (uuid)	no	—
comment	string | null	no	—
criterionId	string (uuid)	no	—
score	integer (int32) | null	no	—

BidStageGrantDto

Property	Type	Required	Description
closedAt	string (date-time) | null	no	—
expiresAt	string (date-time)	no	—
grantId	string (uuid)	no	—
stageId	string (uuid)	no	—
stageKind	string | null	no	—
status	string | null	no	—

BidStageOutcomeDto

Property	Type	Required	Description
bidId	string (uuid)	no	—
failedCriterionIds	(string (uuid))[] | null	no	—
outcome	string | null	no	—
recordedAt	string (date-time)	no	—
stageId	string (uuid)	no	—
stageKind	string | null	no	—

BindEsgEvidenceSourceRequestDto

Property	Type	Required	Description
component	string | null	no	—
feedId	string | null	no	—
feedLabel	string | null	no	—
freshnessMaxAgeHours	integer (int32)	no	—
metric	string | null	no	—
minimumReadings	integer (int32)	no	—
requireAnchoredReadings	boolean	no	—
unit	string | null	no	—

BlockingIssueDto

Property	Type	Required	Description
category	string | null	no	—
code	string | null	no	—
description	string | null	no	—
relatedEntityId	string (uuid) | null	no	—
since	string (date-time) | null	no	—

BondCallApprovalDto

Property	Type	Required	Description
approvedAt	string (date-time)	no	—
approverUserId	string (uuid)	no	—
id	string (uuid)	no	—
note	string | null	no	—

BondCallChainLinkDto

Property	Type	Required	Description
anchorId	string | null	no	—
anchoredAt	string (date-time) | null	no	—
contentHash	string | null	no	—
createdAt	string (date-time)	no	—
derivedFromLinkId	string (uuid) | null	no	—
id	string (uuid)	no	—
isAnchored	boolean	no	—
linkType	string | null	no	—
referenceId	string (uuid) | null	no	—
referenceLabel	string | null	no	—
sourceEpic	integer (int32)	no	—

BondCallDetailDto

Property	Type	Required	Description
amountDemanded	number (double) | null	no	—
approvals	BondCallApprovalDto[] | null	no	—
bondCallRecordId	string (uuid) | null	no	—
bondExpiresOn	string (date-time)	no	—
bondInstrumentId	string (uuid) | null	no	—
bondReference	string | null	no	—
bondSource	string | null	no	—
bondValue	number (double)	no	—
contractReference	string | null	no	—
currency	string | null	no	—
declaredAt	string (date-time)	no	—
declaredByUserId	string (uuid)	no	—
defaultSummary	string | null	no	—
demandChannel	string | null	no	—
demandIssuedAt	string (date-time) | null	no	—
id	string (uuid)	no	—
isAuthorised	boolean	no	—
links	BondCallChainLinkDto[] | null	no	—
readiness	BondCallReadinessDto	no	—
requiredApprovals	integer (int32)	no	—
status	string | null	no	—
supplierId	string (uuid)	no	—
suretyName	string | null	no	—
timeline	BondCallStatusEventDto[] | null	no	—
title	string | null	no	—

BondCallReadinessCheckDto

Property	Type	Required	Description
blocking	boolean	no	—
detail	string | null	no	—
id	string | null	no	—
label	string | null	no	—
satisfied	boolean	no	—

BondCallReadinessDto

Property	Type	Required	Description
checks	BondCallReadinessCheckDto[] | null	no	—
isReady	boolean	no	—

BondCallStatusEventDto

Property	Type	Required	Description
id	string (uuid)	no	—
note	string | null	no	—
occurredAt	string (date-time)	no	—
recordedByUserId	string (uuid)	no	—
status	string | null	no	—

BondCallSummaryDto

Property	Type	Required	Description
amountDemanded	number (double) | null	no	—
bondExpiresOn	string (date-time)	no	—
bondReference	string | null	no	—
bondSource	string | null	no	—
bondValue	number (double)	no	—
contractReference	string | null	no	—
currency	string | null	no	—
declaredAt	string (date-time)	no	—
demandIssuedAt	string (date-time) | null	no	—
id	string (uuid)	no	—
status	string | null	no	—
supplierId	string (uuid)	no	—
suretyName	string | null	no	—
title	string | null	no	—

BreachedMilestoneInput

Property	Type	Required	Description
label	string | null	no	—
milestoneId	string (uuid) | null	no	—

BulkImportRowResult

Property	Type	Required	Description
errorCode	string | null	no	—
externalSupplierKey	string | null	no	—
message	string | null	no	—
row	integer (int32)	no	—
status	string | null	no	—
supplierId	string (uuid) | null	no	—

BulkImportSummary

Property	Type	Required	Description
cancelled	boolean	no	—
created	integer (int32)	no	—
errors	integer (int32)	no	—
results	BulkImportRowResult[] | null	no	—
skipped	integer (int32)	no	—
totalRows	integer (int32)	no	—
updated	integer (int32)	no	—

CancelSupplierBankDetailChangeRequest

Property	Type	Required	Description
reason	string | null	no	—

CancelTenderRequestDto

Property	Type	Required	Description
reason	string | null	no	—

CarbonPurchaseDto

Property	Type	Required	Description
currency	string | null	no	—
evidenceDocumentId	string (uuid) | null	no	—
id	string (uuid)	no	—
organizationId	string (uuid)	no	—
paymentReference	string | null	no	—
pricePaidMinorUnits	integer (int64) | null	no	—
purchasedOn	string (date-time)	no	—
recordedAt	string (date-time)	no	—
recordedBy	string | null	no	—
registryCode	string | null	no	—
serials	CreditSerialDto[] | null	no	—
tonnesCo2e	number (double)	no	—
vintageYear	integer (int32)	no	—

CarbonRetirementDto

Property	Type	Required	Description
anchor	AnchorProofDto	no	—
check	unspecified | null	no	—
createdAt	string (date-time)	no	—
failureReason	string | null	no	—
id	string (uuid)	no	—
organizationId	string (uuid)	no	—
purchaseRecordId	string (uuid)	no	—
receipt	RegistryReceiptDto	no	—
registryCode	string | null	no	—
retiredBy	string | null	no	—
serials	CreditSerialDto[] | null	no	—
status	string | null	no	—
tonnesCo2e	number (double)	no	—

CategoryRequirementDto

Property	Type	Required	Description
category	string | null	no	—
ndaRequired	boolean	no	—
requiredCredentialTypes	string[] | null	no	—

CloseContinuityFailoverRequestDto

Property	Type	Required	Description
note	string | null	no	—
outcome	string | null	no	—

CohortFilterDto

Property	Type	Required	Description
categories	string[] | null	no	—
countries	string[] | null	no	—
riskLevels	string[] | null	no	—
spendBands	string[] | null	no	—
statuses	string[] | null	no	—

CoiAttestationDto

Property	Type	Required	Description
attestedAt	string (date-time)	no	—
conflictDeclared	boolean	no	—
conflictWithdrawn	boolean	no	—
declaredInterest	string | null	no	—
entries	CoiAttestationEntryDto[] | null	no	—
evaluatorId	string (uuid)	no	—
evaluatorName	string | null	no	—
tenderId	string (uuid)	no	—

CoiAttestationEntryDto

Property	Type	Required	Description
attestedAt	string (date-time)	no	—
conflictDeclared	boolean	no	—
declaredInterest	string | null	no	—

CompleteOffboardingStepRequestDto

Property	Type	Required	Description
note	string | null	no	—

ComplianceGateWebhookDto

Property	Type	Required	Description
active	boolean	no	—
createdAt	string (date-time)	no	—
description	string | null	no	—
disabledAt	string (date-time) | null	no	—
failureCount	integer (int32)	no	—
id	string (uuid)	no	—
lastDeliveryAt	string (date-time) | null	no	—
organizationId	string (uuid)	no	—
url	string | null	no	—

ComplianceStatusDto

Property	Type	Required	Description
blockingIssues	BlockingIssueDto[] | null	no	—
compliant	boolean	no	—
compositeRiskScore	number (double)	no	—
computedAt	string (date-time)	no	—
expiringItems	ExpiringItemDto[] | null	no	—
outcome	string | null	no	—
riskLevel	SupplierRiskLevel	no	—
suspended	boolean	no	—
warnings	BlockingIssueDto[] | null	no	—

ComplianceWebhookDeadLetterDto

Property	Type	Required	Description
attemptId	string (uuid)	no	—
attemptNumber	integer (int32)	no	—
blockingIssueCodes	string[] | null	no	—
changedAt	string (date-time) | null	no	—
currentlyCompliant	boolean | null	no	—
deliveredSince	boolean	no	—
eventId	string (uuid)	no	—
lastAttemptedAt	string (date-time)	no	—
lastError	string | null	no	—
lastStatusCode	integer (int32) | null	no	—
supplierId	string (uuid) | null	no	—
webhookId	string (uuid)	no	—
webhookUrl	string | null	no	—

ComplianceWebhookReplayResultDto

Property	Type	Required	Description
attemptId	string (uuid)	no	—
deadLetteredAgain	boolean	no	—
delivered	boolean	no	—
endpointUnavailable	boolean	no	—
rateLimited	boolean	no	—

ComputeScorecardRequest

Property	Type	Required	Description
observations	KpiObservationDto[] | null	no	—
periodEnd	string (date-time)	no	—
periodStart	string (date-time)	no	—

ConcentrationEntry

Property	Type	Required	Description
annualSpendGbp	number (double)	no	—
sharePct	number (double)	no	—
supplierId	string (uuid)	no	—
supplierName	string | null	no	—

ConfirmCarbonRetirementRequestDto

Property	Type	Required	Description
beneficiary	string | null	no	—
receiptId	string | null	no	—
registryCode	string | null	no	—
retiredAt	string (date-time)	no	—

ConsentBasisRecordDto

Property	Type	Required	Description
epoch	integer (int32) | null	no	—
expiresAt	string (date-time) | null	no	—
grantId	string (uuid) | null	no	—
grantedAt	string (date-time) | null	no	—
kind	string | null	no	—
supplierId	string (uuid)	no	—

ConsentExpiryLedgerEntryDto

Property	Type	Required	Description
bidId	string (uuid)	no	—
consentGrantId	string (uuid)	no	—
expiredAt	string (date-time) | null	no	—
failureReason	string | null	no	—
outcome	string | null	no	—
supplierName	string | null	no	—

ContinuityFailoverDto

Property	Type	Required	Description
activatedAt	string (date-time)	no	—
activatedBy	string (uuid)	no	—
alternateSupplierId	string (uuid)	no	—
closeNote	string | null	no	—
closedAt	string (date-time) | null	no	—
closedBy	string (uuid) | null	no	—
id	string (uuid)	no	—
outcome	string | null	no	—
overridden	boolean	no	—
overriddenBy	string (uuid) | null	no	—
overrideJustification	string | null	no	—
postureAtActivation	ContinuityPostureDto	no	—
reason	string | null	no	—

ContinuityPlanDto

Property	Type	Required	Description
alternateState	string | null	no	—
alternateSupplierId	string (uuid) | null	no	—
category	string | null	no	—
createdAt	string (date-time)	no	—
failovers	ContinuityFailoverDto[] | null	no	—
id	string (uuid)	no	—
lastActivatedAt	string (date-time) | null	no	—
primarySupplierId	string (uuid)	no	—
status	string | null	no	—
switchConditions	string | null	no	—
timesExercised	integer (int32)	no	—
updatedAt	string (date-time) | null	no	—

ContinuityPostureDto

Property	Type	Required	Description
blockingIssues	ContinuityPostureIssueDto[] | null	no	—
compliant	boolean	no	—
evaluatedAt	string (date-time)	no	—
expiringItems	ContinuityPostureIssueDto[] | null	no	—
outcome	string | null	no	—
supplierStatus	string | null	no	—

ContinuityPostureIssueDto

Property	Type	Required	Description
code	string | null	no	—
date	string (date-time) | null	no	—
description	string | null	no	—

CreateContinuityPlanRequestDto

Property	Type	Required	Description
alternateSupplierId	string (uuid) | null	no	—
category	string | null	no	—
primarySupplierId	string (uuid)	no	—
switchConditions	string | null	no	—

CreateKpiDefinitionRequest

Property	Type	Required	Description
aggregation	string | null	no	—
amberThreshold	number (double) | null	no	—
category	string | null	no	—
code	string | null	no	—
description	string | null	no	—
greenThreshold	number (double) | null	no	—
lowerIsBetter	boolean	no	—
name	string | null	no	—
unit	string | null	no	—
weight	number (double)	no	—

CreateMitigationPlanCommand

Property	Type	Required	Description
actionsJson	string | null	no	—
description	string | null	no	—
requestingOrganizationId	string (uuid)	no	—
riskDomain	RiskDomain	no	—
supplierId	string (uuid)	no	—
targetRiskReduction	number (double) | null	no	—
title	string | null	no	—

CreateSupplierCommand

Property	Type	Required	Description
address	string | null	no	—
contactEmail	string | null	no	—
contactPhone	string | null	no	—
contractEndDate	string (date-time) | null	no	—
contractStartDate	string (date-time)	no	—
country	string | null	no	—
legalEntityName	string | null	no	—
organizationId	string (uuid)	no	—
registerAuthority	string | null	no	—
registrationNumber	string | null	no	—
supplierName	string | null	no	—
taxId	string | null	no	—
type	SupplierType	no	—

CredentialType

"ISO27001" | "SOC2TypeII" | "SOC3" | "GDPRCompliance" | "HIPAACompliance" | "PCIDSS" | "CyberInsurance" | "LiabilityInsurance" | "ProfessionalIndemnity" | "PenetrationTest" | "BusinessContinuityPlan" | "DriverCpcDqc" | "DriverVocationalEntitlement" | "DriverMedicalD4" | "DigitalTachographCard" | "TradeLicence" | "TaxRegistrationCertificate" | "AuthorisedSignatory" | "BankAccountConfirmation" | "PlaceOfBusinessEvidence" | "ReputationalReview" | "MinorityOwned" | "WomenOwned" | "VeteranOwned" | "DisabilityOwned" with no declared properties.

CreditCheckResultDto

Property	Type	Required	Description
checkedAtUtc	string (date-time)	no	—
creditLimitGbp	number (double) | null	no	—
provider	string | null	no	—
rating	string | null	no	—
reference	string | null	no	—
score	integer (int32)	no	—
supplierId	string (uuid)	no	—

CreditSerialDto

Property	Type	Required	Description
registryCode	string | null	no	—
serial	string | null	no	—

CycleAuthorityDto

Property	Type	Required	Description
capabilities	string[] | null	no	—
delegatedTo	string | null	no	—
makerCheckerRequired	boolean	no	—

CycleRunDto

Property	Type	Required	Description
approvedBy	string | null	no	—
cohort	CohortFilterDto	no	—
completedAt	string (date-time) | null	no	—
consentBasis	string | null	no	—
id	string (uuid)	no	—
launchedAt	string (date-time)	no	—
launchedBy	string | null	no	—
organizationId	string (uuid)	no	—
policyId	string (uuid)	no	—
policyName	string | null	no	—
rows	ScorecardRowDto[] | null	no	—
scope	ScopePreviewDto	no	—
state	string | null	no	—
summary	PortfolioSummaryDto	no	—

DataCategory

"PersonalData" | "SensitivePersonalData" | "FinancialData" | "HealthData" | "BiometricData" | "NoPersonalData" with no declared properties.

DebriefPackDto

Property	Type	Required	Description
belowGateCriteria	string[] | null	no	—
bidId	string (uuid)	no	—
decidedAt	string (date-time)	no	—
outcome	string | null	no	—
ownScores	DebriefScoreDto[] | null	no	—
ownWeightedTotal	number (double) | null	no	—
reasonsForBidders	string | null	no	—
tenderId	string (uuid)	no	—
tenderReference	string | null	no	—

DebriefScoreDto

Property	Type	Required	Description
criterionLabel	string | null	no	—
maxScore	integer (int32)	no	—
score	number (double) | null	no	—

DecideSupplierBankDetailChangeRequest

Property	Type	Required	Description
reason	string | null	no	—

DecideSupplierProfileChangeRequest

Property	Type	Required	Description
reason	string | null	no	—

DeclareContractorDefaultCommand

Property	Type	Required	Description
bondExpiresOn	string (date-time)	no	—
bondReference	string | null	no	—
bondValue	number (double)	no	—
breachedMilestones	BreachedMilestoneInput[] | null	no	—
contractDocumentId	string (uuid) | null	no	—
contractDocumentLabel	string | null	no	—
contractReference	string | null	no	—
currency	string | null	no	—
declaredByUserId	string (uuid)	no	—
defaultSummary	string | null	no	—
requestingOrganizationId	string (uuid)	no	—
requiredApprovals	integer (int32)	no	—
supplierId	string (uuid)	no	—
suretyName	string | null	no	—
title	string | null	no	—

DeclareEudrConsignmentCommand

Property	Type	Required	Description
attestations	EudrAttestationDto[] | null	no	—
commodity	string | null	yes	—
consignmentRef	string | null	yes	—
countryCode	string | null	yes	—
countryTier	string | null	yes	—
evidence	EudrEvidenceItemDto[] | null	no	—
hsCode	string | null	yes	—
netMassKg	number (double)	yes	—
plots	EudrPlotDto[] | null	no	—
requestingOrganizationId	string (uuid)	no	—
ruleSet	EudrRiskRuleSetDto	no	—

DeclareSupplierOrgLinkRequestDto

Property	Type	Required	Description
linkedOrgId	string (uuid)	no	—

DeliveryNoteState

"Matched" | "Discrepant" | "Missing" with no declared properties.

DeliveryTrendsDto

Property	Type	Required	Description
averageDefectRatePct	number (double) | null	no	—
averageOnTimePct	number (double) | null	no	—
defectChangePct	number (double) | null	no	—
from	string (date-time)	no	—
onTimeChangePct	number (double) | null	no	—
periods	SupplierDeliveryMetricsDto[] | null	no	—
supplierId	string (uuid)	no	—
to	string (date-time)	no	—

DiversityAttestationDto

Property	Type	Required	Description
certificateNumber	string | null	no	—
credentialId	string (uuid) | null	no	—
expiresAt	string (date-time) | null	no	—
issuer	string | null	no	—
state	string | null	no	—
type	string | null	no	—
verifiedAt	string (date-time) | null	no	—

DraftTenderCriterionDto

Property	Type	Required	Description
label	string | null	no	—
maxScore	integer (int32)	no	—
passMark	integer (int32) | null	no	—
weight	number (double)	no	—

DraftTenderStageDto

Property	Type	Required	Description
closesAt	string (date-time)	no	—
criteria	DraftTenderCriterionDto[] | null	no	—
kind	string | null	no	—
label	string | null	no	—
requiredEvidence	string[] | null	no	—

EnrolFoodSafetyIssuerKeyRequestDto

Property	Type	Required	Description
issuerReference	string | null	no	—
publicJwk	string | null	no	—
schemeCode	string | null	no	—

EscalateSupplierRequestDto

Property	Type	Required	Description
escalationLevel	integer (int32)	no	—
reason	string | null	no	—

EsgAttestationDto

Property	Type	Required	Description
anchor	JsonNode	no	—
content	JsonNode	no	—
storedAt	string | null	no	—

EsgEvidenceSourceDto

Property	Type	Required	Description
boundAt	string | null	no	—
component	string | null	no	—
feedId	string | null	no	—
feedLabel	string | null	no	—
freshnessMaxAgeHours	integer (int32)	no	—
id	string | null	no	—
metric	string | null	no	—
minimumReadings	integer (int32)	no	—
requireAnchoredReadings	boolean	no	—
unit	string | null	no	—

EsgReportDto

Property	Type	Required	Description
averageComposite	number (double) | null	no	—
averageEnvironmental	number (double) | null	no	—
averageGovernance	number (double) | null	no	—
averageSocial	number (double) | null	no	—
modernSlaveryStatementCount	integer (int32)	no	—
organizationId	string (uuid)	no	—
profiles	SupplierEsgProfileDto[] | null	no	—
supplierCount	integer (int32)	no	—
totalCarbonFootprintTonnes	number (double) | null	no	—

EudrAnchorReceiptDto

Property	Type	Required	Description
anchorId	string | null	yes	—
artifactKind	string | null	yes	—
blockHeight	integer (int64)	yes	—
contentHashHex	string | null	yes	—
state	string | null	yes	—

EudrAttestationDto

Property	Type	Required	Description
attestedOn	string | null	no	—
attestingOrgId	string | null	no	—
grade	string | null	yes	—
plotId	string | null	yes	—
source	string | null	yes	—
validUntil	string | null	no	—

EudrChainStageDto

Property	Type	Required	Description
detail	string | null	yes	—
key	string | null	yes	—
label	string | null	yes	—
owningEpic	integer (int32)	yes	—
status	string | null	yes	—

EudrConsignmentDto

Property	Type	Required	Description
attestations	EudrAttestationDto[] | null	yes	—
commodity	string | null	yes	—
consignmentRef	string | null	yes	—
countryCode	string | null	yes	—
countryTier	string | null	yes	—
hsCode	string | null	yes	—
netMassKg	number (double)	yes	—
organizationId	string | null	yes	—
plots	EudrPlotDto[] | null	yes	—

EudrConsignmentWorkspaceDto

Property	Type	Required	Description
asOf	string | null	yes	—
consignment	EudrConsignmentDto	yes	—
evidenceReceipt	EudrAnchorReceiptDto	no	—
filingOutcome	EudrFilingOutcomeDto	no	—
pack	EudrEvidencePackDto	no	—
railAvailable	boolean | null	no	—
ruleSet	EudrRiskRuleSetDto	no	—
signerName	string | null	no	—
signerSignedOff	boolean | null	no	—
statementReceipt	EudrAnchorReceiptDto	no	—

EudrCorrectionItemDto

Property	Type	Required	Description
code	string | null	yes	—
detail	string | null	yes	—
plotId	string | null	no	—

EudrEvidenceItemDto

Property	Type	Required	Description
contentHashHex	string | null	yes	—
documentId	string | null	yes	—
kind	string | null	yes	—
plotId	string | null	no	—
sizeBytes	integer (int64)	yes	—
title	string | null	yes	—

EudrEvidencePackDto

Property	Type	Required	Description
consignmentRef	string | null	yes	—
contractVersion	integer (int32)	yes	—
items	EudrEvidenceItemDto[] | null	yes	—
kinds	string[] | null	yes	—
packHashHex	string | null	yes	—
totalBytes	integer (int64)	yes	—

EudrFilingOutcomeDto

Property	Type	Required	Description
corrections	EudrCorrectionItemDto[] | null	yes	—
headline	string | null	yes	—
receipt	EudrFilingReceiptDto	no	—
recoverable	boolean	yes	—
state	string | null	yes	—

EudrFilingReceiptDto

Property	Type	Required	Description
correlationKey	string | null	yes	—
ddsReference	string | null	yes	—
issuedAt	string | null	yes	—
retainUntil	string | null	yes	—

EudrInspectionLogEntryDto

Property	Type	Required	Description
actorId	string | null	yes	—
audience	string | null	yes	—
disclosedAt	string | null	yes	—
evidencePackDisclosed	boolean	yes	—
plotsDisclosed	integer (int32)	yes	—
stateAtDisclosure	string | null	yes	—

EudrInspectionRecordDto

Property	Type	Required	Description
audience	string | null	yes	—
chainComplete	boolean	yes	—
consignmentRef	string | null	yes	—
ddsReference	string | null	no	—
discrepancies	EudrChainStageDto[] | null	yes	—
headline	string | null	yes	—
organizationId	string | null	yes	—
plots	EudrPlotAttestationRowDto[] | null	yes	—
retainUntil	string | null	no	—
stages	EudrChainStageDto[] | null	yes	—
state	string | null	yes	—

EudrPlotAttestationRowDto

Property	Type	Required	Description
areaHectares	number (double)	yes	—
attestedOn	string | null	no	—
geolocation	string | null	yes	—
grade	string | null	yes	—
isPolygon	boolean	yes	—
lapsedSinceAttested	boolean	yes	—
plotId	string | null	yes	—
source	string | null	yes	—
validUntil	string | null	no	—

EudrPlotDto

Property	Type	Required	Description
areaHectares	number (double)	yes	—
boundary	((number (double))[])[] | null	no	—
countryCode	string | null	yes	—
geometry	string | null	yes	—
latitude	number (double)	yes	—
longitude	number (double)	yes	—
plotId	string | null	yes	—
productionFrom	string | null	yes	—
productionTo	string | null	yes	—

EudrRegisterEntryDto

Property	Type	Required	Description
blockingPlots	integer (int32)	yes	—
commodity	string | null	yes	—
consignmentRef	string | null	yes	—
countryCode	string | null	yes	—
ddsReference	string | null	no	—
retainUntil	string | null	no	—
state	string | null	yes	—

EudrRiskRuleSetDto

Property	Type	Required	Description
commodity	string | null	yes	—
countryTier	string | null	yes	—
permitSelfDeclared	boolean	yes	—
requireAuthorisedSigner	boolean	yes	—
requiredEvidence	string[] | null	yes	—

EvidenceAssessmentDto

Property	Type	Required	Description
currentEvidenceRatio	number (double)	no	—
daysToSoonestExpiry	integer (int32) | null	no	—
evidenceAsOf	string (date-time) | null	no	—
evidenceAsOfUnknown	boolean	no	—
expiredTypes	string[] | null	no	—
freshness	string | null	no	—
missingTypes	string[] | null	no	—
supplierId	string (uuid)	no	—

EvidenceReferenceDto

Property	Type	Required	Description
credentialId	string (uuid)	no	—
expiresAt	string (date-time) | null	no	—
issuer	string | null	no	—
label	string | null	no	—
lastVerifiedAt	string (date-time) | null	no	—
revalidation	string | null	no	—
stageId	string (uuid) | null	no	—
typeCode	string | null	no	—
verified	boolean	no	—

ExpiringItemDto

Property	Type	Required	Description
daysRemaining	integer (int32)	no	—
expiryDate	string (date-time)	no	—
itemId	string (uuid) | null	no	—
itemName	string | null	no	—
itemType	string | null	no	—

FailCarbonRetirementRequestDto

Property	Type	Required	Description
reason	string | null	no	—

FinancialRiskBandDto

Property	Type	Required	Description
base	number (double)	no	—
minScore	integer (int32)	no	—

FoodSafetyAttestationDto

Property	Type	Required	Description
attestationReference	string | null	no	—
attestationTypes	string[] | null	no	—
boundConsignmentReference	string | null	no	—
documentDigest	string | null	no	—
documentDigestAlgorithm	string | null	no	—
expiresAt	string (date-time) | null	no	—
isStanding	boolean	no	—
issuedAt	string (date-time)	no	—
producerOrganizationReference	string | null	no	—
recordedAt	string | null	no	—
schemeCode	string | null	no	—
signatureVerified	boolean	no	—
supersededAt	string (date-time) | null	no	—
supersededByReference	string | null	no	—
vaultDocumentReference	string | null	no	—
verifiedByKeyId	string | null	no	—

FoodSafetyAttestationEvidenceDto

Property	Type	Required	Description
attestationReference	string | null	no	—
attestationTypes	string[] | null	no	—
boundConsignmentReference	string | null	no	—
expiresAt	string (date-time) | null	no	—
issuedAt	string (date-time)	no	—
producerOrganizationReference	string | null	no	—
schemeCode	string | null	no	—
signatureVerified	boolean	no	—

FoodSafetyIssuerKeyDto

Property	Type	Required	Description
enrolledAt	string | null	no	—
isActive	boolean	no	—
issuerReference	string | null	no	—
keyId	string | null	no	—
revokedAt	string (date-time) | null	no	—
schemeCode	string | null	no	—

Form1BatchMemberDto

Property	Type	Required	Description
items	Form1LineItemDto[] | null	yes	—
remarks	string | null	no	—
trackingNumber	string | null	yes	—
workOrderReference	string | null	no	—

Form1IssuanceDto

Property	Type	Required	Description
approvalReference	string | null	yes	—
approvingAuthority	string | null	yes	—
batchId	string (uuid) | null	no	—
certifiesThat	string | null	yes	—
certifiesThatPreamble	string | null	yes	—
id	string (uuid)	yes	—
issuedAt	string (date-time)	yes	—
issuerAddress	string | null	no	—
issuerName	string | null	yes	—
items	Form1LineItemDto[] | null	yes	—
lotReference	string | null	no	—
organizationId	string (uuid)	yes	—
releaseKind	string | null	yes	—
remarks	string | null	no	—
signatoryName	string | null	yes	—
status	string | null	yes	—
supersededAt	string (date-time) | null	no	—
supersededByTrackingNumber	string | null	no	—
supplierId	string (uuid) | null	no	—
trackingNumber	string | null	yes	—
withdrawnAt	string (date-time) | null	no	—
withdrawnReason	string | null	no	—
workOrderReference	string | null	no	—

Form1LineItemDto

Property	Type	Required	Description
description	string | null	yes	—
itemNumber	integer (int32)	yes	—
partNumber	string | null	yes	—
quantity	number (double)	yes	—
quantityUom	string | null	no	—
serialNumber	string | null	no	—
statusWork	string | null	yes	—

Form1ResolutionDto

Property	Type	Required	Description
approvalReference	string | null	no	—
approvingAuthority	string | null	no	—
contractVersion	integer (int32)	yes	—
explanation	string | null	yes	—
issuedAt	string (date-time) | null	no	—
issuerName	string | null	no	—
issuerOrganizationId	string (uuid) | null	no	—
outcome	string | null	yes	—
partNumber	string | null	no	—
partSerialNumber	string | null	yes	—
releaseKind	string | null	no	—
status	string | null	no	—
statusChangedAt	string (date-time) | null	no	—
statusWork	string | null	no	—
supersededByTrackingNumber	string | null	no	—
trackingNumber	string | null	yes	—
withdrawnReason	string | null	no	—

Form1TemplateDto

Property	Type	Required	Description
approvalReference	string | null	yes	—
approvingAuthority	string | null	yes	—
certifiesThat	string | null	yes	—
defaultSignatoryName	string | null	no	—
id	string (uuid)	yes	—
isActive	boolean	yes	—
issuerAddress	string | null	no	—
issuerName	string | null	yes	—
name	string | null	yes	—
organizationId	string (uuid)	yes	—
releaseKind	string | null	yes	—
supplierId	string (uuid) | null	no	—

GatePolicyChangeDto

Property	Type	Required	Description
changedAt	string (date-time)	no	—
changedByName	string | null	no	—
id	string (uuid)	no	—
resultingVersion	integer (int32)	no	—
summary	string | null	no	—

GatePolicyDto

Property	Type	Required	Description
alertCadenceDays	(integer (int32))[] | null	no	—
approvalWorkflow	string | null	no	—
blockUnconfiguredSuppliers	boolean | null	no	—
categoryRequirements	CategoryRequirementDto[] | null	no	—
organizationId	string (uuid)	no	—
riskWeights	RiskWeightsDto	no	—
rules	GateRuleDto[] | null	no	—
updatedAt	string (date-time) | null	no	—
updatedByName	string | null	no	—
version	integer (int32) | null	no	—

GateRuleDto

Property	Type	Required	Description
category	string | null	no	—
credentialType	string | null	no	—
enabled	boolean	no	—
id	string | null	no	—
outcome	string | null	no	—
threshold	number (double) | null	no	—
trigger	string | null	no	—

GenerateSupplierContractCommand

Property	Type	Required	Description
callbackUrl	string | null	no	—
contractType	string | null	no	—
effectiveDate	string (date-time)	no	—
expirationDate	string (date-time)	no	—
initiatedBy	string (uuid)	no	—
organizationId	string (uuid)	no	—
primaryJurisdiction	string | null	no	—
requestSignature	boolean	no	—
requestingOrganizationId	string (uuid)	no	—
signatureProviderHint	string | null	no	—
supplierId	string (uuid)	no	—
templateId	string (uuid) | null	no	—

GenerateSupplierContractResult

Property	Type	Required	Description
contractId	string (uuid)	yes	—
contractReference	string | null	yes	—
signerUrl	string | null	no	—
status	string | null	yes	—

GoodsReceivedRecordDto

Property	Type	Required	Description
createdAt	string (date-time)	no	—
currency	string | null	no	—
deliveryNoteReference	string | null	no	—
deliveryNoteState	DeliveryNoteState	no	—
id	string (uuid)	no	—
isOverDelivery	boolean	no	—
isShortDelivery	boolean	no	—
lineValue	number (double) | null	no	—
note	string | null	no	—
orderedQuantity	number (double)	no	—
purchaseOrderLineNumber	integer (int32)	no	—
purchaseOrderReference	string | null	no	—
receiptReference	string | null	no	—
receivedAt	string (date-time)	no	—
receivedByName	string | null	no	—
receivedByStaffId	string | null	no	—
receivedQuantity	number (double)	no	—
supplierId	string (uuid)	no	—
unitPrice	number (double) | null	no	—
updatedAt	string (date-time) | null	no	—
valueSource	GoodsReceivedValueSource	no	—

GoodsReceivedValueSource

"Unvalued" | "StatedAtReceipt" with no declared properties.

GrantSanctionsOverrideRequestDto

Property	Type	Required	Description
expiresAt	string (date-time) | null	no	—
justification	string | null	no	—

IncidentSeverity

"Low" | "Medium" | "High" | "Critical" with no declared properties.

IncidentStatus

"Open" | "Investigating" | "Resolved" | "Closed" with no declared properties.

IncidentType

"Outage" | "Breach" | "QualityIssue" | "DeliveryFailure" | "Compliance" | "Security" | "DataIncident" | "Other" with no declared properties.

InspectorGrantDto

Property	Type	Required	Description
accessCount	integer (int32)	no	—
expiresAt	string (date-time)	no	—
fileId	string (uuid)	no	—
grantId	string (uuid)	no	—
inspectorLabel	string | null	no	—
issuedAt	string (date-time)	no	—
issuedByUserId	string (uuid)	no	—
lastAccessedAt	string (date-time) | null	no	—
revokedAt	string (date-time) | null	no	—
state	string | null	no	—

InspectorGrantIssuedDto

Property	Type	Required	Description
expiresAt	string (date-time)	no	—
fileId	string (uuid)	no	—
grantId	string (uuid)	no	—
inspectionPath	string | null	no	—
inspectorLabel	string | null	no	—
token	string | null	no	—

InsuranceAdequacyDto

Property	Type	Required	Description
entries	InsuranceAdequacyEntry[] | null	no	—
meetsAllMinimums	boolean	no	—
supplierId	string (uuid)	no	—

InsuranceAdequacyEntry

Property	Type	Required	Description
hasActivePolicy	boolean	no	—
insuranceType	InsuranceType	no	—
meetsMinimum	boolean	no	—
nextExpiry	string (date-time) | null	no	—

InsuranceStatus

"Active" | "ExpiringSoon" | "Expired" | "Lapsed" | "Cancelled" with no declared properties.

InsuranceType

"Cyber" | "PublicLiability" | "ProfessionalIndemnity" | "ProductLiability" | "EmployersLiability" | "DirectorsAndOfficers" | "BusinessInterruption" with no declared properties.

IssueBondDemandCommand

Property	Type	Required	Description
actorUserId	string (uuid)	no	—
amountDemanded	number (double)	no	—
bondCallChainId	string (uuid)	no	—
demandChannel	string | null	no	—
demandLetterHash	string | null	no	—
demandLetterId	string (uuid)	no	—
demandLetterLabel	string | null	no	—
requestingOrganizationId	string (uuid)	no	—

IssueForm1BatchCommand

Property	Type	Required	Description
approvalReference	string | null	no	—
approvingAuthority	string | null	no	—
certifiesThat	string | null	no	—
issuedAt	string (date-time) | null	no	—
issuerAddress	string | null	no	—
issuerName	string | null	no	—
lotReference	string | null	yes	—
members	Form1BatchMemberDto[] | null	yes	—
releaseKind	string | null	no	—
requestingOrganizationId	string (uuid)	no	—
signatoryName	string | null	no	—
supplierId	string (uuid) | null	no	—
templateId	string (uuid) | null	no	—

IssueForm1Command

Property	Type	Required	Description
approvalReference	string | null	no	—
approvingAuthority	string | null	no	—
certifiesThat	string | null	no	—
issuedAt	string (date-time) | null	no	—
issuerAddress	string | null	no	—
issuerName	string | null	no	—
items	Form1LineItemDto[] | null	yes	—
lotReference	string | null	no	—
releaseKind	string | null	no	—
remarks	string | null	no	—
requestingOrganizationId	string (uuid)	no	—
signatoryName	string | null	no	—
supplierId	string (uuid) | null	no	—
templateId	string (uuid) | null	no	—
trackingNumber	string | null	yes	—
workOrderReference	string | null	no	—

IssueInspectorGrantRequestDto

Property	Type	Required	Description
expiresAt	string (date-time)	no	—
inspectorLabel	string | null	no	—

IssueSupplierPortalInviteResult

Property	Type	Required	Description
expiresAt	string (date-time)	no	—
invitationId	string (uuid)	no	—
token	string | null	no	—

IssueVerificationFileRequestDto

Property	Type	Required	Description
from	string (date-time)	no	—
to	string (date-time)	no	—

JsonNode

Property	Type	Required	Description
options	JsonNodeOptions	no	—
parent	JsonNode	no	—
root	JsonNode	no	—

JsonNodeOptions

Property	Type	Required	Description
propertyNameCaseInsensitive	boolean	no	—

KpiDefinitionDto

Property	Type	Required	Description
active	boolean	no	—
aggregation	string | null	no	—
amberThreshold	number (double) | null	no	—
category	string | null	no	—
code	string | null	no	—
description	string | null	no	—
greenThreshold	number (double) | null	no	—
id	string (uuid)	no	—
lowerIsBetter	boolean	no	—
name	string | null	no	—
organizationId	string (uuid)	no	—
unit	string | null	no	—
weight	number (double)	no	—

KpiObservationDto

Property	Type	Required	Description
kpiCode	string | null	no	—
kpiDefinitionId	string (uuid) | null	no	—
observedAt	string (date-time)	no	—
value	number (double)	no	—

LaunchCycleRequestDto

Property	Type	Required	Description
cohort	CohortFilterDto	no	—
confirmedSweepCount	integer (int32)	no	—
consentBasis	string | null	no	—
excludedSupplierIds	(string (uuid))[] | null	no	—
policyId	string (uuid)	no	—

LinkedBuyerDto

Property	Type	Required	Description
buyerOrganizationId	string (uuid)	no	—

LogDeliveryIssueCommand

Property	Type	Required	Description
description	string | null	no	—
impactDescription	string | null	no	—
requestingOrganizationId	string (uuid)	no	—
severity	IncidentSeverity	no	—
supplierId	string (uuid)	no	—
title	string | null	no	—

MitigationStatus

"Draft" | "Active" | "Completed" | "Cancelled" with no declared properties.

NameContinuityAlternateRequestDto

Property	Type	Required	Description
alternateSupplierId	string (uuid)	no	—
switchConditions	string | null	no	—

OffboardingStepKind

"DataDestruction" | "AccessRevocation" | "ContractTermination" | "PaymentReconciliation" | "KnowledgeTransfer" with no declared properties.

OffboardingStepState

"Outstanding" | "Complete" | "Waived" with no declared properties.

OffboardSupplierRequestDto

Property	Type	Required	Description
reason	string | null	no	—

OverrideContinuityActivationRequestDto

Property	Type	Required	Description
justification	string | null	no	—
reason	string | null	no	—

PolicyPreviewRowDto

Property	Type	Required	Description
currentOutcome	string | null	no	—
newlyTriggeredRules	string[] | null	no	—
proposedOutcome	string | null	no	—
supplierId	string (uuid)	no	—
supplierName	string | null	no	—

PortfolioSummaryDto

Property	Type	Required	Description
evidenceCoverage	number (double)	no	—
flagged	integer (int32)	no	—
greenOnExpiredEvidence	integer (int32)	no	—
inScope	integer (int32)	no	—
refreshed	integer (int32)	no	—
scoringModel	ScoringModelRefDto	no	—
trustedGreen	integer (int32)	no	—
unscoreable	integer (int32)	no	—

ProblemDetails

Property	Type	Required	Description
detail	string | null	no	—
instance	string | null	no	—
status	integer (int32) | null	no	—
title	string | null	no	—
type	string | null	no	—

ProfileChangeStatus

"Submitted" | "Accepted" | "Rejected" with no declared properties.

PublishTenderRequestDto

Property	Type	Required	Description
enforcesSeparationOfDuties	boolean	no	—
evaluationWindowEndsAt	string (date-time)	no	—
invitedSupplierIds	(string (uuid))[] | null	no	—
reference	string | null	no	—
requiresCoiAttestation	boolean	no	—
scope	string | null	no	—
stages	DraftTenderStageDto[] | null	no	—
targeting	string | null	no	—
title	string | null	no	—

PutOnHoldCommand

Property	Type	Required	Description
reason	string | null	no	—
requestingOrganizationId	string (uuid)	no	—
supplierId	string (uuid)	no	—

RaiseSupplierBankDetailChangeRequest

Property	Type	Required	Description
accountNumber	string | null	no	—
iban	string | null	no	—
reason	string | null	no	—
scheme	string | null	no	—
sortCode	string | null	no	—

ReassessmentPolicyDto

Property	Type	Required	Description
active	boolean	no	—
agingLeadDays	integer (int32)	no	—
cadence	string | null	no	—
cohort	CohortFilterDto	no	—
consentBasis	string | null	no	—
description	string | null	no	—
id	string (uuid)	no	—
isSystemDefault	boolean	no	—
name	string | null	no	—
organizationId	string (uuid)	no	—
requiredEvidenceTypes	string[] | null	no	—
scoreOnExpiredEvidence	boolean	no	—
updatedAt	string (date-time) | null	no	—

RecordBondCallApprovalCommand

Property	Type	Required	Description
approverUserId	string (uuid)	no	—
bondCallChainId	string (uuid)	no	—
note	string | null	no	—
requestingOrganizationId	string (uuid)	no	—

RecordCarbonPurchaseRequestDto

Property	Type	Required	Description
currency	string | null	no	—
evidenceDocumentId	string (uuid) | null	no	—
paymentReference	string | null	no	—
pricePaidMinorUnits	integer (int64) | null	no	—
purchasedOn	string (date-time)	no	—
serials	CreditSerialDto[] | null	no	—
tonnesCo2e	number (double)	no	—
vintageYear	integer (int32)	no	—

RecordCarbonRetirementRequestDto

Property	Type	Required	Description
purchaseRecordId	string (uuid)	no	—
serials	CreditSerialDto[] | null	no	—
tonnesCo2e	number (double)	no	—

RecordDeliveryMetricsCommand

Property	Type	Required	Description
lateDeliveries	integer (int32)	no	—
leadTimeAccuracyPct	number (double) | null	no	—
periodEnd	string (date-time)	no	—
periodStart	string (date-time)	no	—
rejectedDeliveries	integer (int32)	no	—
requestingOrganizationId	string (uuid)	no	—
supplierId	string (uuid)	no	—
totalDeliveries	integer (int32)	no	—

RecordEudrAuthorityResponseCommand

Property	Type	Required	Description
consignmentRef	string | null	yes	—
corrections	EudrCorrectionItemDto[] | null	no	—
correlationKey	string | null	no	—
ddsReference	string | null	no	—
issuedAt	string | null	no	—
requestingOrganizationId	string (uuid)	no	—
response	string | null	yes	—

RecordFoodSafetyAttestationRequestDto

Property	Type	Required	Description
attestationReference	string | null	no	—
attestationTypes	string[] | null	no	—
consignmentReference	string | null	no	—
documentDigest	string | null	no	—
documentDigestAlgorithm	string | null	no	—
expiresAt	string (date-time) | null	no	—
issuedAt	string (date-time) | null	no	—
issuerSignature	string | null	no	—
producerOrganizationReference	string | null	no	—
schemeCode	string | null	no	—
supersedesAttestationReference	string | null	no	—
vaultDocumentReference	string | null	no	—

RecordGoodsReceivedCommand

Property	Type	Required	Description
currency	string | null	no	—
deliveryNoteReference	string | null	no	—
deliveryNoteState	DeliveryNoteState	no	—
note	string | null	no	—
orderedQuantity	number (double)	no	—
purchaseOrderLineNumber	integer (int32)	no	—
purchaseOrderReference	string | null	no	—
receiptReference	string | null	no	—
receivedAt	string (date-time)	no	—
receivedByName	string | null	no	—
receivedByStaffId	string | null	no	—
receivedQuantity	number (double)	no	—
requestingOrganizationId	string (uuid)	no	—
supplierId	string (uuid)	no	—
unitPrice	number (double) | null	no	—

RecordSupplierRegisterReviewRequest

Property	Type	Required	Description
evidenceReference	string | null	no	—
note	string | null	no	—
register	string | null	no	—

RecordSupplyVerificationRequest

Property	Type	Required	Description
cashReason	string | null	no	—
checks	SupplyCheckResultDto[] | null	no	—
invoiceReference	string | null	no	—
paymentMethod	SupplyPaymentMethod	no	—
purchaseOrderReference	string | null	no	—
supplyValueAed	number (double)	no	—

RecordSuretyResponseCommand

Property	Type	Required	Description
actorUserId	string (uuid)	no	—
bondCallChainId	string (uuid)	no	—
note	string | null	no	—
occurredAt	string (date-time)	no	—
requestingOrganizationId	string (uuid)	no	—
response	string | null	no	—

RecordVerificationFileAnchorRequestDto

Property	Type	Required	Description
anchorId	string (uuid)	no	—

RecordVerificationReceiptAnchorRequestDto

Property	Type	Required	Description
anchorId	string (uuid)	no	—

RegisterStatusSeverity

"Unclassified" | "Recovered" | "Distressed" | "Ended" with no declared properties.

RegisterVerificationStatus

"NotChecked" | "RegisterVerified" | "NotFound" | "Mismatch" | "RegisterUnavailable" | "EvidenceVerified" with no declared properties.

RegisterWebhookRequestDto

Property	Type	Required	Description
description	string | null	no	—
url	string | null	no	—

RegisterWebhookResponseDto

Property	Type	Required	Description
secret	string | null	no	—
webhookId	string (uuid)	no	—

RegistryReceiptDto

Property	Type	Required	Description
beneficiary	string | null	no	—
receiptId	string | null	no	—
registryCode	string | null	no	—
retiredAt	string (date-time)	no	—

ReinstateSupplierRequestDto

Property	Type	Required	Description
evidenceCredentialId	string (uuid)	no	—
justification	string | null	no	—

RemediationNoticeDto

Property	Type	Required	Description
acknowledgedAt	string (date-time) | null	no	—
cycleId	string (uuid)	no	—
deliveredAt	string (date-time) | null	no	—
dueBy	string (date-time)	no	—
escalatedAt	string (date-time) | null	no	—
evidenceLabel	string | null	no	—
evidenceType	string | null	no	—
id	string (uuid)	no	—
lastRemindedAt	string (date-time) | null	no	—
reason	string | null	no	—
remindersSent	integer (int32)	no	—
resolvedAt	string (date-time) | null	no	—
reuploadHref	string | null	no	—
sentAt	string (date-time)	no	—
sentBy	string | null	no	—
state	string | null	no	—
supplierId	string (uuid)	no	—
supplierName	string | null	no	—

RemediationSlaDto

Property	Type	Required	Description
autoSuspendAfterMissedCycles	integer (int32)	no	—
configured	boolean	no	—
escalateAfterDays	integer (int32)	no	—
graceDays	integer (int32)	no	—
reminderEveryDays	integer (int32)	no	—

RenewCredentialCommand

Property	Type	Required	Description
credentialId	string (uuid)	no	—
newCertificateNumber	string | null	no	—
newExpirationDate	string (date-time)	no	—
requestingOrganizationId	string (uuid)	no	—
supplierId	string (uuid)	no	—

RenewInsuranceCommand

Property	Type	Required	Description
insuranceId	string (uuid)	no	—
newExpiryDate	string (date-time)	no	—
newPolicyNumber	string | null	no	—
requestingOrganizationId	string (uuid)	no	—
supplierId	string (uuid)	no	—

RequirementItemDto

Property	Type	Required	Description
credentialType	string | null	no	—
dueAt	string (date-time) | null	no	—
expiresAt	string (date-time) | null	no	—
id	string (uuid)	no	—
name	string | null	no	—
rejectionReason	string | null	no	—
required	boolean	no	—
status	string | null	no	—

RespondToTenderRequestDto

Property	Type	Required	Description
consentAcknowledged	boolean	no	—
credentialIds	(string (uuid))[] | null	no	—

RespondToTenderResultDto

Property	Type	Required	Description
attachedEvidence	EvidenceReferenceDto[] | null	no	—
bidId	string (uuid)	no	—
consentExpiresAt	string (date-time) | null	no	—
consentGrantId	string (uuid) | null	no	—
status	string | null	no	—
submittedAt	string (date-time)	no	—

ReviewSupplierCheckRequestDto

Property	Type	Required	Description
checkId	string (uuid)	no	—
note	string | null	no	—
outcome	string | null	no	—
source	string | null	no	—

RiskAssessmentResultDto

Property	Type	Required	Description
assessedAtUtc	string (date-time)	no	—
factorScores	map<string, number (double)> | null	no	—
grade	string | null	no	—
overallScore	number (double)	no	—
provider	string | null	no	—
reference	string | null	no	—
supplierId	string (uuid)	no	—

RiskDomain

"Compliance" | "Financial" | "Performance" | "Delivery" | "Esg" | "Insurance" with no declared properties.

RiskMitigationPlanDto

Property	Type	Required	Description
actionsJson	string | null	no	—
createdAt	string (date-time)	no	—
description	string | null	no	—
id	string (uuid)	no	—
riskDomain	RiskDomain	no	—
status	MitigationStatus	no	—
supplierId	string (uuid)	no	—
targetRiskReduction	number (double) | null	no	—
title	string | null	no	—
updatedAt	string (date-time) | null	no	—

RiskSettingsDto

Property	Type	Required	Description
financialCreditBands	FinancialRiskBandDto[] | null	no	—
financialFlagThreshold	number (double)	no	—
isConfigured	boolean	no	—
settingsVersion	integer (int32) | null	no	—
suppliersRescored	integer (int32) | null	no	—
updatedAt	string (date-time) | null	no	—
updatedByName	string | null	no	—

RiskWeightsDto

Property	Type	Required	Description
compliance	number (double)	no	—
delivery	number (double)	no	—
esg	number (double)	no	—
financial	number (double)	no	—
insurance	number (double)	no	—

RosterEligibilityRuleDto

Property	Type	Required	Description
expiringWindowDays	integer (int32)	no	—
gatingCredentials	string[] | null	no	—
grace	RosterGracePolicyDto	no	—
jobTypeOverrides	RosterJobTypeOverrideDto[] | null	no	—
organizationId	string (uuid)	no	—
updatedAt	string (date-time) | null	no	—
updatedByName	string | null	no	—
version	integer (int32) | null	no	—

RosterGracePolicyDto

Property	Type	Required	Description
appliesTo	string[] | null	no	—
maxDays	integer (int32) | null	no	—
mode	string | null	no	—

RosterJobTypeOverrideDto

Property	Type	Required	Description
additionalGating	string[] | null	no	—
jobType	string | null	no	—

SanctionsCandidateDto

Property	Type	Required	Description
countries	string[] | null	no	—
entityId	string | null	no	—
listName	string | null	no	—
name	string | null	no	—
programId	string | null	no	—
score	number (double)	no	—
topics	string[] | null	no	—

SanctionsCaseDetailDto

Property	Type	Required	Description
candidates	SanctionsCandidateDto[] | null	no	—
candidatesAvailable	boolean	no	—
case	SanctionsCaseDto	no	—

SanctionsCaseDto

Property	Type	Required	Description
adjudicatedAt	string (date-time) | null	no	—
adjudicatedBy	string (uuid) | null	no	—
adjudicationReason	string | null	no	—
candidateKeys	string[] | null	no	—
carriedFromCaseId	string (uuid) | null	no	—
id	string (uuid)	no	—
listVersion	string | null	no	—
matchedListName	string | null	no	—
overrideActive	boolean	no	—
overrideExpiresAt	string (date-time) | null	no	—
overrideGrantedAt	string (date-time) | null	no	—
overrideGrantedBy	string (uuid) | null	no	—
overrideJustification	string | null	no	—
raisedAt	string (date-time)	no	—
raisedOutcome	SanctionsScreeningStatus	no	—
screenedBy	string (uuid) | null	no	—
screeningReference	string | null	no	—
status	SanctionsCaseStatus	no	—
supersededAt	string (date-time) | null	no	—
supplierId	string (uuid)	no	—

SanctionsCaseStatus

"Open" | "TrueMatch" | "FalsePositive" | "Suppressed" | "Superseded" with no declared properties.

SanctionsScreeningStatus

"NotScreened" | "Clear" | "PotentialMatch" | "Match" | "NoVerdict" with no declared properties.

SaveBidScoresRequestDto

Property	Type	Required	Description
scores	BidScoreDto[] | null	no	—

SaveForm1TemplateCommand

Property	Type	Required	Description
approvalReference	string | null	yes	—
approvingAuthority	string | null	yes	—
certifiesThat	string | null	yes	—
defaultSignatoryName	string | null	no	—
issuerAddress	string | null	no	—
issuerName	string | null	yes	—
name	string | null	yes	—
releaseKind	string | null	yes	—
requestingOrganizationId	string (uuid)	no	—
supplierId	string (uuid) | null	no	—
templateId	string (uuid) | null	no	—

SaveRiskSettingsRequestDto

Property	Type	Required	Description
financialCreditBands	FinancialRiskBandDto[] | null	no	—
financialFlagThreshold	number (double)	no	—
settingsVersion	integer (int32) | null	no	—

ScheduleReviewCommand

Property	Type	Required	Description
requestingOrganizationId	string (uuid)	no	—
reviewDate	string (date-time)	no	—
supplierId	string (uuid)	no	—

ScopePreviewDto

Property	Type	Required	Description
consentBlocked	(string (uuid))[] | null	no	—
excluded	(string (uuid))[] | null	no	—
matched	(string (uuid))[] | null	no	—
reconsentNeeded	(string (uuid))[] | null	no	—
willSweep	(string (uuid))[] | null	no	—

ScorecardDto

Property	Type	Required	Description
compositeScore	number (double)	no	—
computedAt	string (date-time)	no	—
entries	ScorecardEntryDto[] | null	no	—
id	string (uuid)	no	—
organizationId	string (uuid)	no	—
overallStatus	string | null	no	—
periodEnd	string (date-time)	no	—
periodStart	string (date-time)	no	—
supplierId	string (uuid)	no	—

ScorecardEntryDto

Property	Type	Required	Description
category	string | null	no	—
kpiCode	string | null	no	—
kpiDefinitionId	string (uuid)	no	—
kpiName	string | null	no	—
normalisedScore	number (double)	no	—
observed	number (double)	no	—
status	string | null	no	—
weight	number (double)	no	—

ScorecardRowDto

Property	Type	Required	Description
category	string | null	no	—
companyName	string | null	no	—
compositeRiskScore	number (double)	no	—
consent	ConsentBasisRecordDto	no	—
delta	number (double) | null	no	—
disposition	string | null	no	—
evidence	EvidenceAssessmentDto	no	—
flagReasons	string[] | null	no	—
flagged	boolean	no	—
lastRefreshedAt	string (date-time) | null	no	—
riskLevel	string | null	no	—
supplierId	string (uuid)	no	—

ScoringModelRefDto

Property	Type	Required	Description
owner	string | null	no	—
thresholds	ScoringThresholdsDto	no	—
weightsProfile	string | null	no	—

ScoringThresholdsDto

Property	Type	Required	Description
high	number (double)	no	—
low	number (double)	no	—
medium	number (double)	no	—

SendRemediationNoticesRequestDto

Property	Type	Required	Description
supplierIds	(string (uuid))[] | null	no	—

SetSupplierLegalFormRequestDto

Property	Type	Required	Description
legalForm	string | null	no	—

SetSupplierSmeSizeRequestDto

Property	Type	Required	Description
balanceSheetBand	string | null	no	—
basis	string | null	no	—
evidenceReference	string | null	no	—
headcountBand	string | null	no	—
turnoverBand	string | null	no	—

StageOutcomeResultDto

Property	Type	Required	Description
outcomes	BidStageOutcomeDto[] | null	no	—
recordedAt	string (date-time)	no	—
recordedByName	string | null	no	—
stageId	string (uuid)	no	—
tenderId	string (uuid)	no	—

StoreEsgAttestationRequestDto

Property	Type	Required	Description
anchor	JsonNode	no	—
content	JsonNode	no	—

SubmitSupplierProfileChangeRequest

Property	Type	Required	Description
field	SupplierProfileField	no	—
newValue	string | null	no	—
reason	string | null	no	—

SupersedeForm1Command

Property	Type	Required	Description
requestingOrganizationId	string (uuid)	no	—
supersededByTrackingNumber	string | null	yes	—
trackingNumber	string | null	yes	—

SupplierActorType

"OrgAdmin" | "ComplianceOfficer" | "System" | "Supplier" with no declared properties.

SupplierAgreementDto

Property	Type	Required	Description
contractId	string (uuid)	no	—
contractReference	string | null	no	—
contractType	string | null	no	—
envelopeId	string (uuid) | null	no	—
issuedAt	string (date-time) | null	no	—
signedAt	string (date-time) | null	no	—
signerId	string (uuid) | null	no	—
status	string | null	no	—

SupplierAuditEntryDto

Property	Type	Required	Description
action	string | null	no	—
actorId	string (uuid) | null	no	—
actorType	string | null	no	—
detail	string | null	no	—
eventReference	string | null	no	—
id	string (uuid)	no	—
justification	string | null	no	—
occurredAt	string (date-time)	no	—
reason	string | null	no	—
relatedEntityId	string (uuid) | null	no	—
supplierId	string (uuid)	no	—

SupplierBankDetailChangeDto

Property	Type	Required	Description
cancellationReason	string | null	no	—
cancelledAt	string (date-time) | null	no	—
cancelledBy	string | null	no	—
decidedAt	string (date-time) | null	no	—
decidedByUserId	string (uuid) | null	no	—
decisionReason	string | null	no	—
id	string (uuid)	no	—
maskedDetails	string | null	no	—
noticeDispatchedAt	string (date-time) | null	no	—
noticeQueuedAt	string (date-time)	no	—
noticeSentTo	string | null	no	—
objectionWindowEndsAt	string (date-time) | null	no	—
reason	string | null	no	—
requestedAt	string (date-time)	no	—
scheme	string | null	no	—
status	string | null	no	—
supplierId	string (uuid)	no	—
verificationEvidenceReference	string | null	no	—
verificationMethod	string | null	no	—
verifiedAt	string (date-time) | null	no	—
verifiedByUserId	string (uuid) | null	no	—

SupplierCheckReviewDto

Property	Type	Required	Description
checkAction	string | null	no	—
checkId	string (uuid)	no	—
checkPerformedAt	string (date-time)	no	—
id	string (uuid)	no	—
note	string | null	no	—
outcome	string | null	no	—
performerId	string (uuid) | null	no	—
policyVersion	integer (int32)	no	—
reviewedAt	string (date-time)	no	—
reviewerId	string (uuid)	no	—
source	string | null	no	—
supplierId	string (uuid)	no	—

SupplierComplianceReport

Property	Type	Required	Description
compliantCount	integer (int32)	yes	—
generatedAt	string (date-time)	yes	—
nonCompliantCount	integer (int32)	yes	—
organizationId	string (uuid)	yes	—
rows	SupplierComplianceReportRow[] | null	yes	—

SupplierComplianceReportRow

Property	Type	Required	Description
companyName	string | null	yes	—
complianceScore	number (double)	yes	—
dpaSignedDate	string (date-time) | null	no	—
isCompliant	boolean	yes	—
reasons	string[] | null	yes	—
status	string | null	yes	—
supplierId	string (uuid)	yes	—

SupplierConcentrationDto

Property	Type	Required	Description
organizationId	string (uuid)	no	—
top10SharePct	number (double) | null	no	—
top5SharePct	number (double) | null	no	—
topSuppliers	ConcentrationEntry[] | null	no	—
totalAnnualSpendGbp	number (double)	no	—

SupplierCredentialDto

Property	Type	Required	Description
attributes	map<string, string> | null	no	—
autoRenewal	boolean	no	—
certificateNumber	string | null	no	—
daysUntilExpiration	integer (int32)	no	—
descriptorPublishedAt	string (date-time) | null	no	—
expirationDate	string (date-time)	no	—
id	string (uuid)	no	—
isRequired	boolean	no	—
issueDate	string (date-time) | null	no	—
issuer	string | null	no	—
issuerSupersededAt	string (date-time) | null	no	—
lastVerifiedDate	string (date-time) | null	no	—
name	string | null	no	—
nameDerived	boolean	no	—
status	string | null	no	—
type	string | null	no	—
vaultSource	boolean	no	—

SupplierDashboardSnapshotDto

Property	Type	Required	Description
averageComplianceScore	number (double)	yes	—
averageCompositeScore	number (double)	yes	—
byRiskLevel	map<string, integer (int32)> | null	yes	—
byStatus	map<string, integer (int32)> | null	yes	—
criticalRiskCount	integer (int32)	yes	—
expiringCredentialsCount	integer (int32)	yes	—
generatedAt	string (date-time)	yes	—
highRiskCount	integer (int32)	yes	—
organizationId	string (uuid)	yes	—
reviewsDueCount	integer (int32)	yes	—
totalSuppliers	integer (int32)	yes	—

SupplierDeliveryMetricsDto

Property	Type	Required	Description
createdAt	string (date-time)	no	—
defectRatePct	number (double) | null	no	—
fulfilmentRatePct	number (double) | null	no	—
id	string (uuid)	no	—
lateDeliveries	integer (int32)	no	—
leadTimeAccuracyPct	number (double) | null	no	—
onTimeDeliveryPct	number (double) | null	no	—
periodEnd	string (date-time)	no	—
periodStart	string (date-time)	no	—
rejectedDeliveries	integer (int32)	no	—
supplierId	string (uuid)	no	—
totalDeliveries	integer (int32)	no	—
updatedAt	string (date-time) | null	no	—

SupplierDiversityStatusDto

Property	Type	Required	Description
attestations	DiversityAttestationDto[] | null	no	—
supplierId	string (uuid)	no	—

SupplierDto

Property	Type	Required	Description
address	string | null	no	—
approvedAt	string (date-time) | null	no	—
approvedBy	string (uuid) | null	no	—
category	string | null	no	—
complianceScore	number (double)	no	—
compositeRiskScore	number (double)	no	—
consentGrantId	string (uuid) | null	no	—
contactEmail	string | null	no	—
contactPhone	string | null	no	—
contractEndDate	string (date-time) | null	no	—
contractStartDate	string (date-time)	no	—
country	string | null	no	—
createdAt	string (date-time)	no	—
dataCategoriesAccessed	DataCategory[] | null	no	—
deliveryScore	number (double)	no	—
dpaDocumentId	string (uuid) | null	no	—
dpaReference	string | null	no	—
dpaSignedDate	string (date-time) | null	no	—
esgScore	number (double) | null	no	—
financialRiskIndicator	boolean	no	—
financialRiskScore	number (double) | null	no	—
financialRiskSettingsVersion	integer (int32) | null	no	—
hasDpaAttached	boolean	no	—
id	string (uuid)	no	—
insuranceScore	number (double)	no	—
legalEntityName	string | null	no	—
linkedOrgId	string (uuid) | null	no	—
nextReviewDate	string (date-time) | null	no	—
orgLinkStatus	SupplierOrgLinkStatus	no	—
organizationId	string (uuid)	no	—
performanceScore	number (double)	no	—
registerAuthority	string | null	no	—
registerVerification	SupplierRegisterVerificationDto	no	—
registrationNumber	string | null	no	—
riskLevel	SupplierRiskLevel	no	—
sanctionsListVersion	string | null	no	—
sanctionsMatchedListName	string | null	no	—
sanctionsScreenedAt	string (date-time) | null	no	—
sanctionsScreeningReference	string | null	no	—
sanctionsStatus	SanctionsScreeningStatus	no	—
status	SupplierStatus	no	—
supplierName	string | null	no	—
taxId	string | null	no	—
terminationDate	string (date-time) | null	no	—
terminationReason	string | null	no	—
type	SupplierType	no	—
updatedAt	string (date-time) | null	no	—

SupplierDtoCursorResult

Property	Type	Required	Description
hasMore	boolean	no	—
items	SupplierDto[] | null	no	—
nextCursor	string | null	no	—
pageSize	integer (int32)	no	—
previousCursor	string | null	no	—

SupplierEsgProfileDto

Property	Type	Required	Description
carbonFootprintTonnes	number (double) | null	no	—
carbonReductionTarget	string | null	no	—
certificationsJson	string | null	no	—
compositeEsgScore	number (double) | null	no	—
createdAt	string (date-time)	no	—
environmentalReportsJson	string | null	no	—
environmentalScore	number (double) | null	no	—
governanceScore	number (double) | null	no	—
id	string (uuid)	no	—
modernSlaveryDate	string (date-time) | null	no	—
modernSlaveryStatement	boolean	no	—
socialScore	number (double) | null	no	—
supplierId	string (uuid)	no	—
updatedAt	string (date-time) | null	no	—

SupplierEsgReport

Property	Type	Required	Description
assessedSupplierCount	integer (int32)	yes	—
averageEsgScore	number (double) | null	yes	—
generatedAt	string (date-time)	yes	—
organizationId	string (uuid)	yes	—
rows	SupplierEsgReportRow[] | null	yes	—
supplierCount	integer (int32)	yes	—

SupplierEsgReportRow

Property	Type	Required	Description
carbonScopeOneCo2Tonnes	number (double) | null	no	—
carbonScopeThreeCo2Tonnes	number (double) | null	no	—
carbonScopeTwoCo2Tonnes	number (double) | null	no	—
companyName	string | null	yes	—
esgCertifications	string | null	no	—
esgScore	number (double) | null	yes	—
supplierId	string (uuid)	yes	—

SupplierExitDto

Property	Type	Required	Description
buyerOrganizationId	string (uuid)	no	—
channel	string | null	no	—
reason	string | null	no	—
requestedAt	string (date-time)	no	—
status	string | null	no	—
supplierId	string (uuid)	no	—

SupplierExitRequestDto

Property	Type	Required	Description
reason	string | null	no	—

SupplierExpiryForecastReport

Property	Type	Required	Description
generatedAt	string (date-time)	yes	—
organizationId	string (uuid)	yes	—
rows	SupplierExpiryForecastRow[] | null	yes	—
within30Days	integer (int32)	yes	—
within60Days	integer (int32)	yes	—
within90Days	integer (int32)	yes	—

SupplierExpiryForecastRow

Property	Type	Required	Description
companyName	string | null	yes	—
credentialType	string | null	yes	—
daysUntilExpiry	integer (int32)	yes	—
expiresAt	string (date-time)	yes	—
supplierId	string (uuid)	yes	—

SupplierFinancialProfileDto

Property	Type	Required	Description
accountsFiled	boolean | null	no	—
annualRevenueGbp	number (double) | null	no	—
annualSpendGbp	number (double)	no	—
ccjCount	integer (int32)	no	—
companyAgeYears	integer (int32) | null	no	—
createdAt	string (date-time)	no	—
creditAgency	string | null	no	—
creditLastChecked	string (date-time) | null	no	—
creditRating	string | null	no	—
creditScore	integer (int32) | null	no	—
financialYearEnd	string | null	no	—
financialYearEndDay	integer (int32) | null	no	—
financialYearEndMonth	integer (int32) | null	no	—
financialYearEndStatus	string | null	no	—
id	string (uuid)	no	—
paymentTermsDays	integer (int32) | null	no	—
previousYearSpendGbp	number (double) | null	no	—
riskIndicatorsJson	string | null	no	—
supplierId	string (uuid)	no	—
updatedAt	string (date-time) | null	no	—

SupplierIncidentDto

Property	Type	Required	Description
correctiveAction	string | null	no	—
description	string | null	no	—
id	string (uuid)	no	—
impactDescription	string | null	no	—
incidentType	IncidentType	no	—
reportedAt	string (date-time)	no	—
resolvedAt	string (date-time) | null	no	—
rootCause	string | null	no	—
severity	IncidentSeverity	no	—
status	IncidentStatus	no	—
supplierId	string (uuid)	no	—
title	string | null	no	—

SupplierInsuranceDto

Property	Type	Required	Description
coverageAmount	number (double) | null	no	—
coverageCurrency	string | null	no	—
createdAt	string (date-time)	no	—
descriptorPublishedAt	string (date-time) | null	no	—
documentId	string (uuid) | null	no	—
expiryDate	string (date-time)	no	—
id	string (uuid)	no	—
insuranceType	InsuranceType	no	—
meetsMinimum	boolean	no	—
notes	string | null	no	—
policyNumber	string | null	no	—
provider	string | null	no	—
startDate	string (date-time) | null	no	—
status	InsuranceStatus	no	—
supplierId	string (uuid)	no	—
territory	string | null	no	—
updatedAt	string (date-time) | null	no	—
vaultSource	boolean	no	—

SupplierOffboardingDto

Property	Type	Required	Description
outstanding	OffboardingStepKind[] | null	no	—
status	SupplierStatus	no	—
steps	SupplierOffboardingStepDto[] | null	no	—
supplierId	string (uuid)	no	—

SupplierOffboardingStepDto

Property	Type	Required	Description
note	string | null	no	—
resolvedAt	string (date-time) | null	no	—
resolvedBy	string (uuid) | null	no	—
resolvedByType	SupplierActorType	no	—
state	OffboardingStepState	no	—
step	OffboardingStepKind	no	—

SupplierOrgLinkStatus

"NotLinked" | "PendingConsent" | "Linked" with no declared properties.

SupplierPortalBlockingItemDto

Property	Type	Required	Description
category	string | null	no	—
code	string | null	no	—
description	string | null	no	—
relatedEntityId	string (uuid) | null	no	—
since	string (date-time) | null	no	—

SupplierPortalContextDto

Property	Type	Required	Description
agreements	SupplierAgreementDto[] | null	no	—
buyerOrganizationId	string (uuid)	no	—
buyerOrganizationName	string | null	no	—
category	string | null	no	—
complianceGate	SupplierPortalGateDto	no	—
insurance	SupplierPortalInsuranceDto[] | null	no	—
invitedAt	string (date-time) | null	no	—
linkedToEssenceOrganization	boolean	no	—
onboarded	boolean	no	—
purpose	string | null	no	—
requirements	RequirementItemDto[] | null	no	—
supplierId	string (uuid)	no	—
supplierName	string | null	no	—
supplierStatus	string | null	no	—

SupplierPortalCredentialDto

Property	Type	Required	Description
certificateNumber	string | null	no	—
credentialId	string (uuid)	no	—
expirationDate	string (date-time)	no	—
isRequired	boolean	no	—
issueDate	string (date-time) | null	no	—
issuer	string | null	no	—
name	string | null	no	—
status	string | null	no	—
type	string | null	no	—

SupplierPortalCredentialUploadTargetDto

Property	Type	Required	Description
algorithm	string | null	no	—
maxBytes	integer (int64)	no	—
publicKey	string | null	no	—

SupplierPortalExpiringItemDto

Property	Type	Required	Description
daysRemaining	integer (int32)	no	—
expiryDate	string (date-time)	no	—
itemId	string (uuid) | null	no	—
itemName	string | null	no	—
itemType	string | null	no	—

SupplierPortalGateDto

Property	Type	Required	Description
blockingIssues	SupplierPortalBlockingItemDto[] | null	no	—
compliant	boolean	no	—
computedAt	string (date-time)	no	—
expiringItems	SupplierPortalExpiringItemDto[] | null	no	—
suspended	boolean	no	—
unconfigured	boolean	no	—

SupplierPortalInsuranceDto

Property	Type	Required	Description
expiresAt	string (date-time)	no	—
id	string (uuid)	no	—
insuranceType	string | null	no	—
provider	string | null	no	—
status	string | null	no	—

SupplierPortalProfileDto

Property	Type	Required	Description
address	string | null	no	—
companyName	string | null	no	—
contactEmail	string | null	no	—
contactName	string | null	no	—
contactPhone	string | null	no	—
contractEndDate	string (date-time) | null	no	—
contractStartDate	string (date-time)	no	—
country	string | null	no	—
credentials	SupplierPortalCredentialDto[] | null	no	—
dpaSigned	boolean	no	—
dpaSignedDate	string (date-time) | null	no	—
legalName	string | null	no	—
registrationNumber	string | null	no	—
servicesDescription	string | null	no	—
status	string | null	no	—
supplierId	string (uuid)	no	—
website	string | null	no	—

SupplierPortalSessionRequest

Property	Type	Required	Description
email	string | null	no	—
token	string | null	no	—

SupplierPortalSessionResponse

Property	Type	Required	Description
accessToken	string | null	no	—
expiresAt	string (date-time)	no	—
supplierId	string (uuid)	no	—

SupplierProfileChangeDto

Property	Type	Required	Description
decidedAt	string (date-time) | null	no	—
decidedBy	string (uuid) | null	no	—
decisionReason	string | null	no	—
field	SupplierProfileField	no	—
id	string (uuid)	no	—
newValue	string | null	no	—
oldValue	string | null	no	—
reason	string | null	no	—
status	ProfileChangeStatus	no	—
submittedAt	string (date-time)	no	—
supplierId	string (uuid)	no	—

SupplierProfileField

"Address" | "TradingName" with no declared properties.

SupplierRegisterVerificationDto

Property	Type	Required	Description
checkedAt	string (date-time) | null	no	—
detail	string | null	no	—
evidenceReference	string | null	no	—
isCurrent	boolean	no	—
providerReference	string | null	no	—
register	string | null	no	—
registeredActivities	string[] | null	no	—
registeredName	string | null	no	—
registeredStatus	string | null	no	—
registeredStatusObservedAt	string (date-time) | null	no	—
registeredStatusSeverity	RegisterStatusSeverity	no	—
reviewedBy	string (uuid) | null	no	—
status	RegisterVerificationStatus	no	—

SupplierRiskLevel

"Low" | "Medium" | "High" | "Critical" with no declared properties.

SupplierRiskReport

Property	Type	Required	Description
byRiskLevel	map<string, integer (int32)> | null	yes	—
generatedAt	string (date-time)	yes	—
organizationId	string (uuid)	yes	—
rows	SupplierRiskReportRow[] | null	yes	—
totalSuppliers	integer (int32)	yes	—

SupplierRiskReportRow

Property	Type	Required	Description
companyName	string | null	yes	—
complianceScore	number (double)	yes	—
compositeRiskScore	number (double)	yes	—
deliveryScore	number (double)	yes	—
esgScore	number (double) | null	yes	—
financialRiskScore	number (double) | null	yes	—
riskLevel	string | null	yes	—
status	string | null	yes	—
supplierId	string (uuid)	yes	—

SupplierSmeSizeDto

Property	Type	Required	Description
balanceSheetBand	string | null	no	—
balanceSheetConsidered	boolean | null	no	—
basis	string | null	no	—
classification	string | null	no	—
definition	string | null	no	—
evidenceReference	string | null	no	—
headcountBand	string | null	no	—
isSme	boolean | null	no	—
recordedAt	string (date-time) | null	no	—
recordedBy	string (uuid) | null	no	—
state	string | null	no	—
supplierId	string (uuid)	no	—
turnoverBand	string | null	no	—

SupplierSpendDto

Property	Type	Required	Description
annualSpendGbp	number (double)	no	—
previousYearSpendGbp	number (double) | null	no	—
supplierId	string (uuid)	no	—
yoyChangePct	number (double) | null	no	—

SupplierSpendReport

Property	Type	Required	Description
generatedAt	string (date-time)	yes	—
organizationId	string (uuid)	yes	—
rows	SupplierSpendReportRow[] | null	yes	—
totalAnnualSpendGbp	number (double)	yes	—

SupplierSpendReportRow

Property	Type	Required	Description
annualSpendGbp	number (double)	yes	—
companyName	string | null	yes	—
concentrationPercentage	number (double) | null	no	—
previousYearSpendGbp	number (double) | null	no	—
supplierId	string (uuid)	yes	—

SupplierStatus

"PendingApproval" | "Active" | "OnHold" | "Terminated" | "Offboarding" | "UnderReview" | "Suspended" | "Escalated" with no declared properties.

SupplierType

"DataProcessor" | "SubProcessor" | "CloudProvider" | "SaasVendor" | "ProfessionalServices" | "ManagedServiceProvider" | "SecurityVendor" with no declared properties.

SupplyCheck

"CommercialReason" | "PriceAndMargin" | "LicensedActivity" | "TitleAndOrigin" | "IntermediaryRole" | "PaymentTrail" with no declared properties.

SupplyCheckOutcome

"Passed" | "Failed" | "NotApplicable" with no declared properties.

SupplyCheckResultDto

Property	Type	Required	Description
check	SupplyCheck	no	—
evidenceReference	string | null	no	—
note	string | null	no	—
outcome	SupplyCheckOutcome	no	—

SupplyPaymentMethod

"BankTransfer" | "Card" | "DirectDebit" | "Cheque" | "Cash" with no declared properties.

SupplyVerificationDto

Property	Type	Required	Description
cashReason	string | null	no	—
checks	SupplyCheckResultDto[] | null	no	—
hasFailedCheck	boolean	no	—
historyCheckId	string (uuid)	no	—
id	string (uuid)	no	—
invoiceReference	string | null	no	—
paymentMethod	SupplyPaymentMethod	no	—
performedAt	string (date-time)	no	—
performedByUserId	string (uuid)	no	—
purchaseOrderReference	string | null	no	—
supplierId	string (uuid)	no	—
supplyValueAed	number (double)	no	—

SuspendSupplierRequestDto

Property	Type	Required	Description
reason	string | null	no	—

SweepActivityEntryDto

Property	Type	Required	Description
action	string | null	no	—
actor	string | null	no	—
at	string (date-time)	no	—
cycleId	string (uuid)	no	—
id	string (uuid)	no	—
outcome	string | null	no	—
scopeSummary	string | null	no	—
supplierCount	integer (int32)	no	—

TenderCriterionDto

Property	Type	Required	Description
id	string (uuid)	no	—
label	string | null	no	—
maxScore	integer (int32)	no	—
passMark	integer (int32) | null	no	—
weight	number (double)	no	—

TenderDetailDto

Property	Type	Required	Description
awardedAt	string (date-time) | null	no	—
bidCount	integer (int32)	no	—
closesAt	string (date-time)	no	—
enforcesSeparationOfDuties	boolean	no	—
evaluationWindowEndsAt	string (date-time)	no	—
id	string (uuid)	no	—
invitedSupplierIds	(string (uuid))[] | null	no	—
organizationId	string (uuid)	no	—
publishedAt	string (date-time) | null	no	—
reference	string | null	no	—
requiresCoiAttestation	boolean	no	—
scope	string | null	no	—
stages	TenderStageDto[] | null	no	—
status	string | null	no	—
targeting	string | null	no	—
title	string | null	no	—

TenderInvitationDto

Property	Type	Required	Description
bidId	string (uuid) | null	no	—
buyerName	string | null	no	—
buyerOrganizationId	string (uuid)	no	—
closesAt	string (date-time)	no	—
evaluationWindowEndsAt	string (date-time)	no	—
reference	string | null	no	—
requiredEvidence	string[] | null	no	—
status	string | null	no	—
tenderId	string (uuid)	no	—
title	string | null	no	—

TenderStageDto

Property	Type	Required	Description
closesAt	string (date-time)	no	—
criteria	TenderCriterionDto[] | null	no	—
id	string (uuid)	no	—
kind	string | null	no	—
label	string | null	no	—
outcomeRecordedAt	string (date-time) | null	no	—
requiredEvidence	string[] | null	no	—

TenderSummaryDto

Property	Type	Required	Description
awardedAt	string (date-time) | null	no	—
bidCount	integer (int32)	no	—
closesAt	string (date-time)	no	—
id	string (uuid)	no	—
organizationId	string (uuid)	no	—
publishedAt	string (date-time) | null	no	—
reference	string | null	no	—
status	string | null	no	—
targeting	string | null	no	—
title	string | null	no	—

TerminateSupplierCommand

Property	Type	Required	Description
reason	string | null	no	—
requestingOrganizationId	string (uuid)	no	—
supplierId	string (uuid)	no	—

UpdateContractCommand

Property	Type	Required	Description
annualValue	number (double) | null	no	—
contractEndDate	string (date-time) | null	no	—
currency	string | null	no	—
requestingOrganizationId	string (uuid)	no	—
supplierId	string (uuid)	no	—

UpdateDataCategoriesCommand

Property	Type	Required	Description
dataCategories	DataCategory[] | null	no	—
requestingOrganizationId	string (uuid)	no	—
supplierId	string (uuid)	no	—

UpdateEsgProfileCommand

Property	Type	Required	Description
carbonFootprintTonnes	number (double) | null	no	—
carbonReductionTarget	string | null	no	—
certificationsJson	string | null	no	—
environmentalReportsJson	string | null	no	—
environmentalScore	number (double) | null	no	—
governanceScore	number (double) | null	no	—
modernSlaveryStatementDate	string (date-time) | null	no	—
requestingOrganizationId	string (uuid)	no	—
socialScore	number (double) | null	no	—
supplierId	string (uuid)	no	—

UpdateFinancialProfileCommand

Property	Type	Required	Description
accountsFiled	boolean | null	no	—
annualRevenueGbp	number (double) | null	no	—
ccjCount	integer (int32) | null	no	—
companyAgeYears	integer (int32) | null	no	—
creditAgency	string | null	no	—
creditRating	string | null	no	—
creditScore	integer (int32) | null	no	—
financialYearEnd	string | null	no	—
paymentTermsDays	integer (int32) | null	no	—
requestingOrganizationId	string (uuid)	no	—
riskIndicatorsJson	string | null	no	—
supplierId	string (uuid)	no	—

UpdateInsuranceCommand

Property	Type	Required	Description
documentId	string (uuid) | null	no	—
insuranceId	string (uuid)	no	—
meetsMinimum	boolean | null	no	—
notes	string | null	no	—
requestingOrganizationId	string (uuid)	no	—
supplierId	string (uuid)	no	—

UpdateRiskLevelCommand

Property	Type	Required	Description
newRiskLevel	SupplierRiskLevel	no	—
reason	string | null	no	—
requestingOrganizationId	string (uuid)	no	—
supplierId	string (uuid)	no	—

UploadSupplierPortalCredentialRequest

Property	Type	Required	Description
algorithmVersion	integer (int32)	no	—
authenticationTag	string | null	no	—
certificateNumber	string | null	no	—
encryptedContent	string (byte) | null	no	—
expirationDate	string (date-time)	no	—
fileName	string | null	no	—
initializationVector	string | null	no	—
issueDate	string (date-time)	no	—
issuer	string | null	no	—
keyGeneration	integer (int32)	no	—
keyId	string | null	no	—
mimeType	string | null	no	—
name	string | null	no	—
type	string | null	no	—

VerificationAttestationDto

Property	Type	Required	Description
attestedAt	string (date-time)	no	—
id	string (uuid)	no	—
periodEnd	string (date-time)	no	—
periodStart	string (date-time)	no	—
policyVersion	integer (int32)	no	—
rejectedInPeriod	integer (int32)	no	—
reviewsInPeriod	integer (int32)	no	—
statement	string | null	no	—
supervisorId	string (uuid)	no	—

VerificationFileAnchorDto

Property	Type	Required	Description
anchorId	string (uuid) | null	no	—
anchoredAt	string (date-time) | null	no	—
artifactId	string | null	no	—
artifactKind	string | null	no	—
hash	string | null	no	—
verifyPath	string | null	no	—

VerificationFileSummaryDto

Property	Type	Required	Description
anchor	VerificationFileAnchorDto	no	—
checkCount	integer (int32)	no	—
generatedAt	string (date-time)	no	—
generatedByUserId	string (uuid)	no	—
id	string (uuid)	no	—
manifestDigest	string | null	no	—
periodFrom	string (date-time)	no	—
periodTo	string (date-time)	no	—
supplierId	string (uuid)	no	—

VerificationPolicyDto

Property	Type	Required	Description
adoptedAt	string (date-time)	no	—
adoptedByUserId	string (uuid)	no	—
performerRoles	string[] | null	no	—
reviewerRoles	string[] | null	no	—
statement	string | null	no	—
supervisorRoles	string[] | null	no	—
version	integer (int32)	no	—

VerificationPolicyStateDto

Property	Type	Required	Description
adopted	boolean	no	—
assignableRoles	string[] | null	no	—
current	VerificationPolicyDto	no	—

VerificationPresetAdoptionDto

Property	Type	Required	Description
gatePolicyVersion	integer (int32)	no	—
gateRulesAdded	string[] | null	no	—
gateRulesAlreadyPresent	string[] | null	no	—
preset	string | null	no	—
reassessmentPolicy	ReassessmentPolicyDto	no	—
reassessmentPolicyCreated	boolean	no	—

VerificationReceiptAnchorDto

Property	Type	Required	Description
anchorId	string (uuid) | null	no	—
anchoredAt	string (date-time) | null	no	—
artifactId	string | null	no	—
artifactKind	string | null	no	—
hash	string | null	no	—
status	string | null	no	—
verifyPath	string | null	no	—

VerificationReceiptDto

Property	Type	Required	Description
anchor	VerificationReceiptAnchorDto	no	—
canonicalForm	string | null	no	—
consentId	string (uuid)	no	—
credentialType	string | null	no	—
digest	string | null	no	—
digestAlgorithm	string | null	no	—
id	string (uuid)	no	—
issuerRef	string | null	no	—
issuerRefAbsentReason	string | null	no	—
lastVerifiedAbsentReason	string | null	no	—
lastVerifiedAt	string (date-time) | null	no	—
recordedAt	string (date-time)	no	—
supplierId	string (uuid)	no	—
validFrom	string (date-time) | null	no	—
validFromAbsentReason	string | null	no	—
validTo	string (date-time)	no	—

VerificationReceiptsDto

Property	Type	Required	Description
legalForm	string | null	no	—
receipts	VerificationReceiptDto[] | null	no	—
withheld	VerificationReceiptWithheldDto[] | null	no	—

VerificationReceiptWithheldDto

Property	Type	Required	Description
at	string (date-time)	no	—
consentId	string (uuid) | null	no	—
evidencePurged	integer (int32)	no	—
reason	string | null	no	—
trigger	string | null	no	—

VerifySupplierBankDetailChangeRequest

Property	Type	Required	Description
evidenceReference	string | null	no	—
method	string | null	no	—

WaiveOffboardingStepRequestDto

Property	Type	Required	Description
reason	string | null	no	—

WithdrawForm1Command

Property	Type	Required	Description
reason	string | null	yes	—
requestingOrganizationId	string (uuid)	no	—
trackingNumber	string | null	yes	—

WithdrawTenderResponseResultDto

Property	Type	Required	Description
bidId	string (uuid)	no	—
revokedGrantIds	(string (uuid))[] | null	no	—
status	string | null	no	—