API Docs / Schemas / EngagementAcceptanceDto

EngagementAcceptanceDto

Response DTO for anonymous engagement acceptance page

Properties

Name Type Description
codestring

Engagement code

Engagement code

typeenum

ProposalAndEngagementLetter EngagementLetter

ProposalAndEngagementLetter EngagementLetter

numberOfServicesinteger

Number of services included in this engagement

Number of services included in this engagement

totalValuenumber

Total value of all services in this engagement (annualised recurring + one-off fees)

Total value of all services in this engagement (annualised recurring + one-off fees)

monthlyTotalnumber

Sum of monthly service prices (per-month amount, not annualised)

Sum of monthly service prices (per-month amount, not annualised)

quarterlyTotalnumber

Sum of quarterly service prices (per-quarter amount)

Sum of quarterly service prices (per-quarter amount)

annualTotalnumber

Sum of annual service prices

Sum of annual service prices

oneOffTotalnumber

Sum of one-off service prices

Sum of one-off service prices

tenantTenantInfoDto
introContentHtmlstring

Intro content block HTML (if configured in EngagementSettings)

Intro content block HTML (if configured in EngagementSettings)

thankYouContentHtmlstring

Thank you content block HTML (if configured in EngagementSettings)

Thank you content block HTML (if configured in EngagementSettings)

recipientFirstNamestring

Recipient first name

Recipient first name

recipientLastNamestring

Recipient last name

Recipient last name

recipientEmailstring

Recipient email

Recipient email

showPracticeNameboolean

Whether to show the practice name on the acceptance page

Whether to show the practice name on the acceptance page

clientCodeAndNameDto
directDebitMandateUrlstring

Direct debit mandate setup URL (if RequestDDMandate is enabled and tenant has DD connection)

Direct debit mandate setup URL (if RequestDDMandate is enabled and tenant has DD connection)

JSON Example

{
  "code": "string",
  "type": "ProposalAndEngagementLetter",
  "numberOfServices": 0,
  "totalValue": 0,
  "monthlyTotal": 0
}

Used By Operations