Resolve the email subject for a fiscal document

Returns the subject the service would put on the email, so a UI can seed an editable Subject
field from the same resolution the send uses rather than reimplementing it.

Give documentId for a document that exists. The answer is then exactly what a send with no
subject override produces: a token the service holds no value for resolves to an empty
string, as it would in the delivered email.

Give documentKind, sourceKind and sourceId instead for a document about to be created.
A token whose value is only assigned at creation is then returned verbatim, for example
Grand Hotel - Invoice #[Invoice Number]. Send the string back, edited or not, on the create
request and the service fills those tokens in once the values exist.

Supplying the chosen recipient lets the guest's language win when the property has
"use guest language" enabled; without it the subject falls back to the property's language.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
length ≥ 1

An existing fiscal document. When given, the document parameters below are ignored - everything is derived from the document itself.

string
enum

Required when documentId is absent.

string
enum

Required when documentId is absent.

Allowed:
int64
≥ 1

Required when documentId is absent.

string
enum

The chosen Bill-to recipient. Supply together with recipientId. Optional because a manually entered recipient has no stored record to point at; the subject then resolves in the property's language rather than the guest's.

Allowed:
int64
≥ 1

The chosen Bill-to recipient. Supply together with recipientType.

Headers
int64
required
≥ 1

Property id

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json