> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dolfinai.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Send a payment reminder now

> Immediately emails a payment reminder for the invoice — rendering the chaser copy that matches how overdue it is, or the supplied subject/message overrides — and records it. Idempotent within 60 seconds.



## OpenAPI

````yaml post /invoices/{invoiceId}/reminders
openapi: 3.1.1
info:
  title: Dolfin API
  description: >-
    Dolfin API for AR & AP. Authenticate using the `x-dolfin-api-key` header
    with the API key distributed to your organisation.
  version: v1
servers:
  - url: https://api.dolfinai.co
    description: Production
security:
  - {}
tags:
  - name: Webhooks
  - name: Users
  - name: TaxRates
  - name: Suppliers
  - name: Supplier Credit Notes
  - name: Bills
  - name: SpendCategories
  - name: Payables
  - name: RecurringInvoices
  - name: Receivables
  - name: Purchase Orders
  - name: Products
  - name: Payments
  - name: Invoices
  - name: Organisations
  - name: Members
  - name: MCP
  - name: Matching
  - name: Invoice Reminders
  - name: Industries
  - name: Gmail
  - name: Delivery Notes
  - name: Customers
  - name: Currencies
  - name: Credit Notes
  - name: Clients
  - name: ClientInvites
  - name: BankPayments
  - name: Bank details
  - name: Auth
  - name: ApprovalPolicies
  - name: ApiKeys
  - name: Agent
paths:
  /invoices/{invoiceId}/reminders:
    post:
      tags:
        - Invoice Reminders
      summary: Send a payment reminder now
      description: >-
        Immediately emails a payment reminder for the invoice — rendering the
        chaser copy that matches how overdue it is, or the supplied
        subject/message overrides — and records it. Idempotent within 60
        seconds.
      parameters:
        - name: invoiceId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - type: 'null'
                - $ref: '#/components/schemas/SendReminderRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceReminderResponse'
        '400':
          description: Invoice.CustomerMissingEmail — the customer has no email address
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Invoice.NotFound — no invoice with that id for this organisation
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '409':
          description: >-
            InvoiceReminder.InvoiceNotRemindable — the invoice is not Sent or
            PartiallyPaid
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '422':
          description: >-
            Invoice.RecipientInactive — the recipient address is suppressed at
            the email provider
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '502':
          description: Invoice.EmailSendFailed — the email provider rejected the send
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    SendReminderRequest:
      type: object
      properties:
        subject:
          type:
            - 'null'
            - string
        message:
          type:
            - 'null'
            - string
    InvoiceReminderResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        invoiceId:
          type: string
          format: uuid
        offset:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/InvoiceReminderOffset'
              description: >-
                The preset offset this reminder was auto-scheduled from, or null
                for ad-hoc reminders created via POST /invoices/{id}/reminders
                with an explicit scheduledAt.
        scheduledAt:
          type: string
          format: date-time
        status:
          $ref: '#/components/schemas/InvoiceReminderStatus'
        subject:
          type:
            - 'null'
            - string
        body:
          type:
            - 'null'
            - string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        sentAt:
          type:
            - 'null'
            - string
          format: date-time
        cancelledAt:
          type:
            - 'null'
            - string
          format: date-time
        failureReason:
          type:
            - 'null'
            - string
    ProblemDetails:
      type: object
      properties:
        type:
          type:
            - 'null'
            - string
        title:
          type:
            - 'null'
            - string
        status:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - 'null'
            - integer
            - string
          format: int32
        detail:
          type:
            - 'null'
            - string
        instance:
          type:
            - 'null'
            - string
    InvoiceReminderOffset:
      enum:
        - OneWeekBefore
        - TwoDaysBefore
        - OnDueDate
        - TwoDaysAfter
        - OneWeekAfter
    InvoiceReminderStatus:
      enum:
        - Pending
        - Sent
        - Cancelled
        - Failed

````