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

# List invoices

> Lists the organization's fiscal invoices over a range of calendar days, newest first. The days are read exactly as `GET /invoices/summary` reads them, so for the same range and filters this returns the invoices the summary counted. Pro-formas are never included.




## OpenAPI

````yaml /openapi-platform.json get /v1/platform/invoices
openapi: 3.0.0
info:
  title: 1club Platform API
  version: 1.0.0
  description: >-
    The 1club Platform API lets you programmatically access and manage your
    organization's data.


    ## Official API Contract


    This documentation is the official source of truth for the 1club Platform
    API.

    If an integration relies on undocumented endpoints, fields, response shapes,
    or internal behavior outside this spec, we can't guarantee backward
    compatibility.

    Build against what's documented here to stay stable as the platform evolves.


    ## Authentication


    All requests require a customer API key passed as a Bearer token:


    ```

    Authorization: Bearer 1club_sk_live_...

    ```


    Generate API keys from the admin portal under **Settings > API Tokens**.

    The key is tied to your organization - all responses are scoped to your
    org's data.


    ## Rate Limiting


    - **100 requests per minute** per API key

    - When exceeded, the API returns `429 Too Many Requests` with a
    `Retry-After` header

    - Rate limit headers are included in every response:
      - `X-RateLimit-Limit` - max requests per window
      - `X-RateLimit-Remaining` - requests remaining
      - `X-RateLimit-Reset` - seconds until the window resets

    ## Errors


    | Status | Meaning |

    |--------|---------|

    | `400` | Invalid request parameters |

    | `401` | Missing or invalid API key |

    | `404` | Resource not found (or doesn't belong to your organization) |

    | `429` | Rate limit exceeded |

    | `500` | Internal server error |
  contact:
    name: 1club API Support
    email: support@1club.ai
servers:
  - url: https://api.1club.ai
    description: Production API
security:
  - customerApiAuth: []
tags: []
paths:
  /v1/platform/invoices:
    get:
      tags:
        - Invoices
      summary: List invoices
      description: >
        Lists the organization's fiscal invoices over a range of calendar days,
        newest first. The days are read exactly as `GET /invoices/summary` reads
        them, so for the same range and filters this returns the invoices the
        summary counted. Pro-formas are never included.
      parameters:
        - in: query
          name: startDate
          schema:
            type: string
            format: date
          description: First day, inclusive. Defaults to endDate, or today.
        - in: query
          name: endDate
          schema:
            type: string
            format: date
          description: Last day, inclusive. Defaults to startDate.
        - in: query
          name: billingEntityId
          schema:
            type: integer
        - in: query
          name: contactId
          schema:
            type: integer
        - in: query
          name: status
          schema:
            type: string
            enum:
              - pending
              - paid
              - void
              - failed
              - settled
              - overdue
              - partially_paid
              - refunded
              - cancelled
        - in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
        - in: query
          name: offset
          schema:
            type: integer
            minimum: 0
            default: 0
      responses:
        '200':
          description: Page of invoices
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformInvoicePage'
        '400':
          $ref: '#/components/responses/PlatformBadRequest'
        '401':
          $ref: '#/components/responses/PlatformUnauthorized'
        '403':
          description: Missing `invoices:read` scope
        '429':
          $ref: '#/components/responses/PlatformRateLimited'
      security:
        - customerApiAuth: []
components:
  schemas:
    PlatformInvoicePage:
      allOf:
        - type: object
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/PlatformInvoice'
            total:
              type: integer
              description: Total invoices matching the filters, ignoring pagination
            limit:
              type: integer
            offset:
              type: integer
        - type: object
          properties:
            timezone:
              type: string
            startDate:
              type: string
              format: date
            endDate:
              type: string
              format: date
    PlatformInvoice:
      type: object
      description: A fiscal invoice. Pro-formas are never returned.
      properties:
        id:
          type: integer
        invoiceNumber:
          type: string
        invoiceDate:
          type: string
          format: date
          description: The calendar day the invoice belongs to, on the organization's clock
        dueDate:
          type: string
          format: date
        status:
          type: string
          enum:
            - pending
            - paid
            - void
            - failed
            - settled
            - overdue
            - partially_paid
            - refunded
            - cancelled
        overdue:
          type: boolean
          description: Unpaid and past its due date
        currency:
          type: string
        subtotal:
          type: number
        taxAmount:
          type: number
        totalAmount:
          type: number
        sentAt:
          type: string
          format: date-time
          nullable: true
        createdAt:
          type: string
          format: date-time
        contact:
          type: object
          nullable: true
          properties:
            id:
              type: integer
            name:
              type: string
        billingEntity:
          type: object
          properties:
            id:
              type: integer
            name:
              type: string
    PlatformError:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
          description: >-
            A stable, machine-readable reason, when the error has one (e.g.
            `CONTACT_EXISTS`).
        details:
          type: object
          additionalProperties: true
          description: >-
            Structured values behind the error. A 409 naming an existing record
            carries its id here, e.g. `contactId`.
  responses:
    PlatformBadRequest:
      description: Invalid request (bad parameters, or a body that fails validation)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlatformError'
    PlatformUnauthorized:
      description: Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlatformError'
    PlatformRateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlatformError'
  securitySchemes:
    customerApiAuth:
      type: http
      scheme: bearer
      description: >-
        Organization-scoped bearer credential: a customer API key
        (1club_sk_live_...) or an MCP OAuth access token.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.