Send reminders
const url = 'https://api.shypr.app/rest/billing/invoices/send-reminders';const options = { method: 'POST', headers: {'X-API-KEY': '<X-API-KEY>', 'Content-Type': 'application/json'}, body: '{"invoiceIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.shypr.app/rest/billing/invoices/send-reminders \ --header 'Content-Type: application/json' \ --header 'X-API-KEY: <X-API-KEY>' \ --data '{ "invoiceIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }'Creates a InvoiceBulkSendReminderInput resource.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”The new InvoiceBulkSendReminderInput resource
Sends a payment reminder for each selected invoice. The handler checks each invoice now and answers for each one. A remindable invoice gets an InvoiceSendReminderInput, which makes its own audit row, so this input has none.
object
Example generated
{ "invoiceIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ]}Sends a payment reminder for each selected invoice. The handler checks each invoice now and answers for each one. A remindable invoice gets an InvoiceSendReminderInput, which makes its own audit row, so this input has none.
object
Responses
Section titled “Responses”InvoiceBulkSendReminderInput resource created
Sends a payment reminder for each selected invoice. The handler checks each invoice now and answers for each one. A remindable invoice gets an InvoiceSendReminderInput, which makes its own audit row, so this input has none.
object
Example generated
{ "invoiceIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ]}Sends a payment reminder for each selected invoice. The handler checks each invoice now and answers for each one. A remindable invoice gets an InvoiceSendReminderInput, which makes its own audit row, so this input has none.
object
Invalid input
A representation of common errors.
object
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
Example
{ "status": 400}A representation of common errors.
object
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
Example
{ "status": 400}Forbidden
A representation of common errors.
object
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
Example
{ "status": 400}A representation of common errors.
object
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
Example
{ "status": 400}An error occurred
Unprocessable entity
object
object
The property path of the violation
The message associated with the violation
The code of the violation
An extra hint to understand the violation
The serialized payload of the violation
object
Example
{ "status": 422}Unprocessable entity
object
object
The property path of the violation
The message associated with the violation
The code of the violation
An extra hint to understand the violation
The serialized payload of the violation
object
Example
{ "status": 422}