> ## 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.

# Overdue receivables

> Overdue receivables grouped by customer, each tiered (gentle/firm/final/escalation) with a suggested action and tone, last-reminder timing, and payment behaviour.



## OpenAPI

````yaml /api-reference/openapi.json get /receivables/overdue
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:
  /receivables/overdue:
    get:
      tags:
        - Receivables
      summary: Overdue receivables
      description: >-
        Overdue receivables grouped by customer, each tiered
        (gentle/firm/final/escalation) with a suggested action and tone,
        last-reminder timing, and payment behaviour.
      parameters:
        - name: asOf
          in: query
          schema:
            type: string
            format: date
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OverdueResponse'
components:
  schemas:
    OverdueResponse:
      required:
        - totals
      type: object
      properties:
        asOf:
          type: string
          format: date
        totals:
          $ref: '#/components/schemas/OverdueTotals'
        aging:
          type: array
          items:
            $ref: '#/components/schemas/CurrencyAging'
        customers:
          type: array
          items:
            $ref: '#/components/schemas/OverdueCustomerRow'
          description: >-
            One row per customer per currency — a customer overdue in multiple
            currencies appears once per currency. Amounts are never summed
            across currencies. Org default currency rows first, most days
            overdue first within each currency.
    OverdueTotals:
      type: object
      properties:
        customerCount:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          description: >-
            Distinct customers with overdue invoices. May be lower than the
            number of Customers rows, which are per (customer, currency).
          format: int32
        invoiceCount:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          format: int32
        overdueByCurrency:
          type: array
          items:
            $ref: '#/components/schemas/CurrencyTotal'
    CurrencyAging:
      required:
        - currency
        - buckets
      type: object
      properties:
        currency:
          type: string
        buckets:
          $ref: '#/components/schemas/AgingBuckets'
    OverdueCustomerRow:
      required:
        - customerName
        - currency
        - tier
        - suggestedAction
        - suggestedTone
      type: object
      properties:
        customerId:
          type: string
          format: uuid
        customerName:
          type: string
        currency:
          type: string
        totalOverdue:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
          type:
            - number
            - string
          format: double
        invoiceCount:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          format: int32
        oldestInvoice:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/InvoiceSummary'
        tier:
          type: string
          description: gentle | firm | final | escalation
        suggestedAction:
          type: string
          description: send_reminder | call_or_escalate | wait
        suggestedTone:
          type: string
          description: friendly | direct | formal
        lastReminderSentAt:
          type:
            - 'null'
            - string
          format: date-time
        daysSinceLastReminder:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - 'null'
            - integer
            - string
          format: int32
        paymentBehaviour:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/PaymentBehaviour'
        invoiceIds:
          type: array
          items:
            type: string
            format: uuid
    CurrencyTotal:
      required:
        - currency
        - amount
        - count
      type: object
      properties:
        currency:
          type: string
        amount:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
          type:
            - number
            - string
          format: double
        count:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          description: Invoices for receivables, bills for payables.
          format: int32
    AgingBuckets:
      type: object
      properties:
        current:
          $ref: '#/components/schemas/AgingBucket'
          description: Issued but not yet due.
        d1To30:
          $ref: '#/components/schemas/AgingBucket'
        d31To60:
          $ref: '#/components/schemas/AgingBucket'
        d61To90:
          $ref: '#/components/schemas/AgingBucket'
        d90Plus:
          $ref: '#/components/schemas/AgingBucket'
    InvoiceSummary:
      required:
        - status
      type: object
      properties:
        invoiceId:
          type: string
          format: uuid
        invoiceNumber:
          type:
            - 'null'
            - string
        totalAmount:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
          type:
            - number
            - string
          format: double
        outstanding:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
          type:
            - number
            - string
          format: double
        dueDate:
          type:
            - 'null'
            - string
          format: date
        daysOverdue:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          format: int32
        status:
          type: string
    PaymentBehaviour:
      type: object
      properties:
        averageDaysLate:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$
          type:
            - number
            - string
          format: double
        onTimeRate:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$
          type:
            - number
            - string
          format: double
        totalInvoicesPaid:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          description: Invoices paid in the last 12 months.
          format: int32
    AgingBucket:
      type: object
      properties:
        amount:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
          type:
            - number
            - string
          format: double
        count:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          description: Invoices for receivables, bills for payables.
          format: int32

````