Send a test reminder

Authentication

AuthorizationBearer

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

Path parameters

receivable_idstringRequired
ID of an existing invoice for which you want to send a payment reminder or overview reminder.

Headers

x-monite-versionstringRequired
x-monite-entity-idstringRequired
The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.
reminder_typeenumRequired
The type of the reminder to be sent.
Allowed values:
recipientsobjectOptional

Response

Successful Response
mail_idslist of strings

Errors

400
Post Receivables ID Send Test Reminder Request Bad Request Error
401
Post Receivables ID Send Test Reminder Request Unauthorized Error
403
Post Receivables ID Send Test Reminder Request Forbidden Error
404
Post Receivables ID Send Test Reminder Request Not Found Error
409
Post Receivables ID Send Test Reminder Request Conflict Error
422
Post Receivables ID Send Test Reminder Request Unprocessable Entity Error
429
Post Receivables ID Send Test Reminder Request Too Many Requests Error