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

# Total received summary

> Cash collected (succeeded payments) over a fixed window, with the trend vs the prior equal-length window, a per-bucket time series, a Stripe-vs-Manual split, and top customers.



## OpenAPI

````yaml /api-reference/openapi.json get /receivables/received
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/received:
    get:
      tags:
        - Receivables
      summary: Total received summary
      description: >-
        Cash collected (succeeded payments) over a fixed window, with the trend
        vs the prior equal-length window, a per-bucket time series, a
        Stripe-vs-Manual split, and top customers.
      parameters:
        - name: period
          in: query
          schema:
            $ref: '#/components/schemas/LookbackPeriod'
            default: Last30Days
        - name: currency
          in: query
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReceivedResponse'
components:
  schemas:
    LookbackPeriod:
      enum:
        - Last7Days
        - Last30Days
        - Last90Days
        - Last12Months
        - MonthToDate
        - QuarterToDate
        - YearToDate
    ReceivedResponse:
      required:
        - granularity
        - currency
        - summary
        - trend
      type: object
      properties:
        asOf:
          type: string
          format: date
        period:
          $ref: '#/components/schemas/LookbackPeriod'
        periodStart:
          type: string
          format: date
        periodEnd:
          type: string
          format: date
        granularity:
          type: string
          description: daily | weekly | monthly
        currency:
          type: string
          description: >-
            The primary currency the Summary, Trend, Buckets, ByMethod and
            TopCustomers fields are reported in. See ReceivedByCurrency for
            activity in every currency.
        receivedByCurrency:
          type: array
          items:
            $ref: '#/components/schemas/CurrencyTotal'
          description: >-
            Total received per currency across the period — covers ALL
            currencies, not just the primary one. Use this for the headline
            figure when the org collects in multiple currencies so amounts are
            never reported as zero.
        summary:
          $ref: '#/components/schemas/ReceivedTotals'
        trend:
          $ref: '#/components/schemas/ReceivedTrend'
        buckets:
          type: array
          items:
            $ref: '#/components/schemas/ReceivedBucket'
        byMethod:
          type: array
          items:
            $ref: '#/components/schemas/MethodTotal'
        topCustomers:
          type: array
          items:
            $ref: '#/components/schemas/CustomerReceived'
    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
    ReceivedTotals:
      type: object
      properties:
        totalReceived:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
          type:
            - number
            - string
          format: double
        paymentCount:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          format: int32
        uniqueCustomers:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          format: int32
        averagePayment:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
          type:
            - number
            - string
          format: double
    ReceivedTrend:
      required:
        - direction
      type: object
      properties:
        previousPeriodStart:
          type: string
          format: date
        previousPeriodEnd:
          type: string
          format: date
        previousTotal:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
          type:
            - number
            - string
          format: double
        deltaAmount:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
          type:
            - number
            - string
          format: double
        deltaPercent:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$
          type:
            - 'null'
            - number
            - string
          description: >-
            Fractional change vs the prior equal-length window. Null when the
            prior window collected nothing.
          format: double
        direction:
          type: string
          description: up | down | flat
    ReceivedBucket:
      type: object
      properties:
        periodStart:
          type: string
          format: date
        periodEnd:
          type: string
          format: date
        received:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
          type:
            - number
            - string
          format: double
        paymentCount:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          format: int32
    MethodTotal:
      required:
        - method
      type: object
      properties:
        method:
          type: string
          description: Stripe | Manual
        received:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
          type:
            - number
            - string
          format: double
        paymentCount:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          format: int32
    CustomerReceived:
      required:
        - customerName
      type: object
      properties:
        customerId:
          type: string
          format: uuid
        customerName:
          type: string
        received:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
          type:
            - number
            - string
          format: double
        paymentCount:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          format: int32

````