CisCollectPaymentsExecutionStateDto

Execution state of a Collect CIS payments step. Read-only: written by the system.
Staff mode records only the month and organisation until the step is completed.

Properties

Name Type Description
taxMonthEndstring

The 5th the tax month ends on

The 5th the tax month ends on

organisationCodestring

The client's CIS Manager organisation (its tenant code)

The client's CIS Manager organisation (its tenant code)

tokenSentAtstring

UTC time the link was emailed (client mode)

UTC time the link was emailed (client mode)

submittedAtstring

UTC time the payments were submitted, or the step completed by staff

UTC time the payments were submitted, or the step completed by staff

submittedByEmailstring

Email address of the recipient who submitted (from their magic link), or of the staff user

Email address of the recipient who submitted (from their magic link), or of the staff user

noPaymentsDeclaredboolean

Whether the submission declared that no payments were made in the tax month

Whether the submission declared that no payments were made in the tax month

paymentCountinteger

The number of payments in CIS Manager for the month when submitted

The number of payments in CIS Manager for the month when submitted

totalGrossnumber

The month's gross payments when submitted

The month's gross payments when submitted

totalDeductionsnumber

The month's deductions when submitted

The month's deductions when submitted

addedSubcontractorsarray of CisAddedSubcontractorDto

The subcontractors the client added to CIS Manager from the payments page: unverified, so deducted at 30% until a
Verify subcontractors step (or the practice) verifies them

The subcontractors the client added to CIS Manager from the payments page: unverified, so deducted at 30% until a
Verify subcontractors step (or the practice) verifies them

JSON Example

{
  "taxMonthEnd": "2024-01-01",
  "organisationCode": "string",
  "tokenSentAt": "2024-01-01T00:00:00Z",
  "submittedAt": "2024-01-01T00:00:00Z",
  "submittedByEmail": "string"
}

Contained in Schemas