Invoices

Send a payment reminder

Emails a payment reminder to the customer for this invoice. Accepts optional email, subject, message, cc, bcc overrides.

post/companies/{company}/invoices/{invoice}/send-reminder

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/invoices/{invoice}/send-reminder
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

invoicestring uuid required

Public identifier (UUID v7) of the invoice.

Headers

Idempotency-Keystring required
Example:01928f10-7c0e-7c4a-9b7d-2f8a6e3c1d4b

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 422 idempotency_key_reused; the values of secret fields (password, secret…) count as part of the body, so retrying with a corrected secret under the same key is a different request, never the replay of the earlier answer. See the Idempotency guide. Required on this operation: repeating it delivers an effect that cannot be taken back (an email sent, a file generated, a third-party call, a charge), so a request without this header is rejected with 422 idempotency_key_required before any business logic runs.

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Request body

emailstring email nullable

Recipient other than the client email.

subjectstring nullable

Custom subject for the reminder.

messagestring nullable

Additional message for the reminder body.

ccstring[] nullable

Carbon copy addresses.

bccstring[] nullable

Blind carbon copy addresses.

attach_pdfboolean nullable

Per-send override for "attach the invoice PDF". If omitted (or null), the company default (email_settings) is used.

stripe_payment_buttonboolean nullable

Per-send override for the "Stripe payment button". If omitted (or null), the company default is used.

Response

Example response

{
  "data": {
    "id": "feb47de0-d6ed-40de-a4d4-8825182f5a6d",
    "message": "Recordatorio enviado correctamente."
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.