API Docs / Operations / Remittance Advice / Update Remittance Advice Settings

Update Remittance Advice Settings

PUT /tenants/{tenant}/settings/remittance-advice

Replaces the tenant's remittance advice settings. A text whose switch is off is discarded.

Parameters

NameTypeDescription
tenant* path string

The tenant code (the organisation's URL stub)

The tenant code (the organisation's URL stub)

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

Responses

400 Bad Request
application/problem+json
401 Unauthorized – Invalid or missing API key
403 Forbidden
application/problem+json
404 Not Found
application/problem+json