Skip to main content
POST
Send a test reminder

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-finops-version
string<date>
required
authorization
string
x-organization-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Path Parameters

receivable_id
string<uuid>
required

Body

application/json

Payload for sending a test reminder email

reminder_type
enum<string>
required

The type of the reminder to be sent.

Available options:
term_1,
term_2,
term_final,
overdue
recipients
object

Response

Successful Response

A schema for returning a response with list of ids by which user check sending status

mail_ids
string<uuid>[]
required