Skip to main content
GET
Get mandate correspondence item

Authorizations

Authorization
string
header
required

Company-bound Case Management API key — the standard credential for this API.

Headers

X-On-Behalf-Of-Company
string<uuid>

Required when a Partner key calls the Case Management API; rejected for direct Case keys. Contains the entitled paywise company UUID.

If-None-Match
string

Return 304 with an empty body when the current ETag matches one of the supplied validators (or *).

Path Parameters

id
string<uuid>
required

UUID of the correspondence item in this request.

mandate_id
string<uuid>
required

UUID of the parent accepted case in this request.

Response

List row plus the projected text and the attachment inventory.

attachments
object[]
required
read-only

Attachments of the message that a creditor may download.

body
object | null
required

Projected plain text, or null when no body is stored.

channel
string
required
read-only

Communication channel. Open enumeration: email today; clients must tolerate new values.

direction
enum<string>
required

Whether paywise received or sent the message.

Available options:
inbound,
outbound
email
object
required

Email-channel details; present when channel is email.

history_entry_ids
string<uuid>[]
required
read-only

Published history entries that surface this message; empty for messages reachable only through a client request.

id
string<uuid>
required
read-only

Stable identifier of the correspondence item.

occurred_at
string<date-time>
required
read-only

Time the message was received or sent.

pdf_url
string<uri>
required
read-only

Authenticated URL of the message rendered as PDF (header block and plain text).

source_mandate
object
required

Main case or subcase the message belongs to.

subject
string | null
required
read-only

Subject line, or null.

updated_at
string<date-time>
required
read-only

Latest change to this item; use for incremental synchronization.

url
string<uri>
required
read-only

Authenticated API URL of this item.