API Docs / Schemas / RemittanceAdviceSettingsDto

RemittanceAdviceSettingsDto

How the tenant's remittance advices are laid out: which columns they show and the custom texts they carry.
A tenant that has never saved settings gets the defaults.

Properties

Name Type Description
useCustomPaymentText*boolean

Whether paymentText replaces the default "The above amount has been paid by BACS."

Whether paymentText replaces the default "The above amount has been paid by BACS."

paymentTextstring

The custom payment text; null unless useCustomPaymentText

The custom payment text; null unless useCustomPaymentText

useCustomFooterText*boolean

Whether footerText is printed

Whether footerText is printed

footerTextstring

The custom footer text; null unless useCustomFooterText

The custom footer text; null unless useCustomFooterText

includeInvoiceNumber*boolean

Show the invoice number column

Show the invoice number column

includeInvoiceDate*boolean

Show the invoice date column

Show the invoice date column

includeContractorRef*boolean

Show the contractor's reference column

Show the contractor's reference column

contractorRefHeaderTextstring

The contractor's reference column heading (default "Reference"); null unless includeContractorRef

The contractor's reference column heading (default "Reference"); null unless includeContractorRef

includeSubcontractorRef*boolean

Show the subcontractor's reference column

Show the subcontractor's reference column

subcontractorRefHeaderTextstring

The subcontractor's reference column heading (default "Your Ref"); null unless includeSubcontractorRef

The subcontractor's reference column heading (default "Your Ref"); null unless includeSubcontractorRef

includeSubcontractorUtr*boolean

Print the subcontractor's UTR

Print the subcontractor's UTR

includeFooterSummary*boolean

Print the deduction summary in the footer

Print the deduction summary in the footer

useCustomDrcText*boolean

Whether drcText replaces the default domestic reverse charge note

Whether drcText replaces the default domestic reverse charge note

drcTextstring

The custom domestic reverse charge note; null unless useCustomDrcText

The custom domestic reverse charge note; null unless useCustomDrcText

JSON Example

{
  "useCustomPaymentText": false,
  "paymentText": "string",
  "useCustomFooterText": false,
  "footerText": "string",
  "includeInvoiceNumber": false,
  "includeInvoiceDate": false,
  "includeContractorRef": false,
  "includeSubcontractorRef": false,
  "includeSubcontractorUtr": false,
  "includeFooterSummary": false,
  "useCustomDrcText": false
}

Used By Operations