API Docs / Schemas / CisDetailsRequestDto

CisDetailsRequestDto

A request for a subcontractor's CIS details: the tenant emails the subcontractor a link to a public form, what
they enter is held on the request (not on the contact), and the tenant reviews it and accepts it onto the contact.

Properties

Name Type Description
code*string

The request's identifier, also the key of its public form

The request's identifier, also the key of its public form

status*enum

Pending (waiting for the subcontractor), Submitted (details received, awaiting review) or Accepted

Pending Submitted Accepted

Pending (waiting for the subcontractor), Submitted (details received, awaiting review) or Accepted

Pending Submitted Accepted

contact*string

The code of the subcontractor the request is for

The code of the subcontractor the request is for

contactName*string

The subcontractor's display name

The subcontractor's display name

emailedTo*string

Where the request was last sent

Where the request was last sent

detailsSubmittedCisDetailsDto

What the subcontractor sent; null until they have

What the subcontractor sent; null until they have

sdcStatementstring

The SDC statement sent with the request, when one was

The SDC statement sent with the request, when one was

submittedDatestring

When the subcontractor sent their details

When the subcontractor sent their details

acceptedDatestring

When the tenant accepted them onto the contact

When the tenant accepted them onto the contact

createdDate*string

When the request was created

When the request was created

updatedDatestring

When it was last changed

When it was last changed

JSON Example

{
  "code": "00000000-0000-0000-0000-000000000000",
  "status": "Pending",
  "contact": "string",
  "contactName": "string",
  "emailedTo": "string",
  "createdDate": "2024-01-01T00:00:00Z"
}

Used By Operations