sendInvoiceReminder

Requires at least one of the permissions payments:invoice:send or purchase:purchase_invoice:send.

Emails the customer a payment reminder for an invoice. Refused for an invoice that is already fully paid, and when the customer has no email address.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation SendInvoiceReminder($invoiceId: ID!) {
  sendInvoiceReminder(invoiceId: $invoiceId)
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation SendInvoiceReminder($invoiceId: ID!) {\n  sendInvoiceReminder(invoiceId: $invoiceId)\n}",
  "variables": {
    "invoiceId": "id"
  }
}
EOF

Variables:

{
  "invoiceId": "id"
}

Response:

{
  "data": {
    "sendInvoiceReminder": true
  }
}

sendInvoiceReminder(
  customerEmail: String
  invoiceId: ID!
): Boolean!

Arguments

sendInvoiceReminder.customerEmail ● String scalar

The recipient's email address. When omitted the customer's email contact on file is used.

sendInvoiceReminder.invoiceId ● ID! non-null scalar

The ID of the invoice the reminder is about.

Type

Boolean scalar

The Boolean scalar type represents true or false.