ASAP Fiscal API

openapi: 3.2.0
info:
  title: ASAP Platform Fiscal API
  description: 'Public HTTP API for ASAP Platform (api.asap.cool).


    All `/v1` responses are wrapped in a standard envelope. Success responses are `{ "data": , "meta": { "request_id", "next_cursor"?, "has_more"? } }` — the schema documented for each operation describes the inner `data` value. Errors are `{ "error": { "code", "message", "field"?, "request_id" } }`. Every response also carries an `X-Request-Id` header matching `meta.request_id` / `error.request_id`.'
  license:
    name: BUSL-1.1
  version: 0.0.0
servers:
- url: https://api.asap.cool
  description: Production
tags:
- name: fiscal
  description: 'Micro-entrepreneur fiscal estimates: social-charge provision, VAT-franchise thresholds, declaration deadline (decision support, never an official declaration).'
paths:
  /v1/fiscal/accounting-export:
    get:
      tags:
      - fiscal
      summary: GET /v1/fiscal/accounting-export
      operationId: getFiscalAccountingExport
      parameters:
      - name: from
        in: query
        description: Inclusive lower bound (`YYYY-MM-DD`, required).
        required: true
        schema:
          type: string
      - name: to
        in: query
        description: Inclusive upper bound (`YYYY-MM-DD`, required).
        required: true
        schema:
          type: string
      - name: format
        in: query
        description: Output format; only `csv` (the default) exists.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: 'CSV attachment: the sales journal then the receipts journal, one row per debit or credit line (`;`-separated, UTF-8 with BOM, amounts with a decimal comma).'
          content:
            text/csv:
              schema:
                type: string
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing invoice:read scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '422':
          description: Invalid window or unsupported format.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - api_key:
        - invoice:read
      - session: []
  /v1/fiscal/cashflow:
    get:
      tags:
      - fiscal
      summary: GET /v1/fiscal/cashflow
      operationId: getFiscalCashflow
      parameters:
      - name: from
        in: query
        description: Inclusive lower bound (`YYYY-MM-DD`). Given together with `to`.
        required: false
        schema:
          type: string
      - name: to
        in: query
        description: Inclusive upper bound (`YYYY-MM-DD`). Given together with `from`.
        required: false
        schema:
          type: string
      - name: document_id
        in: query
        description: 'Narrow to the payments of one document. Required when there is no

          window.'
        required: false
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: 'Cash flow estimate: what is really available out of the cash collected (never an official declaration).'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FiscalCashflowView'
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing invoice:read scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '422':
          description: Invalid window, or neither a window nor a document.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - api_key:
        - invoice:read
      - session: []
  /v1/fiscal/receipts-ledger:
    get:
      tags:
      - fiscal
      summary: GET /v1/fiscal/receipts-ledger
      operationId: getFiscalReceiptsLedger
      parameters:
      - name: year
        in: query
        description: Calendar year of the ledger (collection date, UTC).
        required: true
        schema:
          type: integer
          format: int32
      - name: format
        in: query
        description: Output format; only `csv` (the default) exists.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: 'CSV attachment: one row per payment received during the year (`;`-separated, UTF-8 with BOM, amounts with a decimal comma).'
          content:
            text/csv:
              schema:
                type: string
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing invoice:read scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '422':
          description: Invalid year or unsupported format.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - api_key:
        - invoice:read
      - session: []
  /v1/fiscal/sales-journal-fec:
    get:
      tags:
      - fiscal
      summary: GET /v1/fiscal/sales-journal-fec
      operationId: getFiscalSalesJournalFec
      parameters:
      - name: from
        in: query
        description: Inclusive lower bound (`YYYY-MM-DD`, required).
        required: true
        schema:
          type: string
      - name: to
        in: query
        description: Inclusive upper bound (`YYYY-MM-DD`, required).
        required: true
        schema:
          type: string
      responses:
        '200':
          description: 'Text attachment: the sales and receipts entries of the window in the 18-field FEC layout (tab-delimited, UTF-8, amounts with a decimal comma). Not a compliant FEC.'
          content:
            text/plain:
              schema:
                type: string
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing invoice:read scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '422':
          description: Invalid window.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - api_key:
        - invoice:read
      - session: []
  /v1/fiscal/summary:
    get:
      tags:
      - fiscal
      summary: GET /v1/fiscal/summary
      operationId: getFiscalSummary
      parameters:
      - name: from
        in: query
        description: Inclusive lower bound (`YYYY-MM-DD`, required).
        required: true
        schema:
          type: string
      - name: to
        in: query
        description: Inclusive upper bound (`YYYY-MM-DD`, required).
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Fiscal estimate for the window (never an official declaration).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FiscalSummaryView'
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing invoice:read scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '422':
          description: Invalid window.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - api_key:
        - invoice:read
      - session: []
components:
  schemas:
    FiscalConfigView:
      type: object
      description: The fiscal configuration the estimate was computed with.
      required:
      - rate_source
      - acre_applied
      - versement_liberatoire
      - declaration_frequency
      properties:
        acre_applied:
          type: boolean
          description: Whether the ACRE abatement applies today.
        activity_category:
          type:
          - string
          - 'null'
          description: Activity category token, `None` when not set on the profile.
        declaration_frequency:
          type: string
          description: URSSAF declaration cadence (`monthly` / `quarterly`).
        rate_source:
          $ref: '#/components/schemas/RateSourceView'
          description: Where the rate comes from.
        social_rate_bps:
          type:
          - integer
          - 'null'
          format: int32
          description: 'Effective total rate in basis points (ACRE and versement libératoire

            applied), `None` when `rate_source` is `unknown`.'
        versement_liberatoire:
          type: boolean
          description: Option "versement libératoire" of income tax.
    FiscalCashflowView:
      type: object
      description: Response body of `GET /v1/fiscal/cashflow`.
      required:
      - collected_cents
      - vat_collected_cents
      - expenses_cents
      - payments
      - estimate
      properties:
        available_cents:
          type:
          - integer
          - 'null'
          format: int64
          description: 'Collected minus provision minus VAT minus expenses (centimes), before

            bank data; `None` when the rate is unknown. May be negative. The VAT

            recoverable on expenses is not given back, so a VAT-registered org

            may have slightly more than this.'
        collected_cents:
          type: integer
          format: int64
          description: Cash collected (centimes).
        estimate:
          type: boolean
          description: 'Always `true`: an estimate, never an official declaration.'
        expenses_cents:
          type: integer
          format: int64
          description: 'Confirmed expenses incurred over the window (centimes, VAT included);

            `0` for a document-only request, which has no window.'
        payments:
          type: array
          items:
            $ref: '#/components/schemas/CashflowPaymentView'
          description: The payments, oldest first.
        period:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/FiscalPeriodView'
            description: The window, `None` when only a document was requested.
        provision_cents:
          type:
          - integer
          - 'null'
          format: int64
          description: 'Sum of the per-payment provisions (centimes); `None` when the rate is

            unknown.'
        vat_collected_cents:
          type: integer
          format: int64
          description: VAT included in the cash collected (centimes), owed to the State.
    FranchiseTvaView:
      type: object
      description: VAT-franchise thresholds of the activity.
      required:
      - base_cents
      - tolerance_cents
      properties:
        base_cents:
          type: integer
          format: int64
          description: 'Base threshold (centimes): VAT is due from the next year.'
        tolerance_cents:
          type: integer
          format: int64
          description: 'Tolerance threshold (centimes): VAT is due immediately.'
    RateSourceView:
      type: string
      description: Where the effective social rate comes from.
      enum:
      - override
      - category
      - unknown
    FiscalPeriodView:
      type: object
      description: The window the collected cash is summed over.
      required:
      - from
      - to
      properties:
        from:
          type: string
          description: Inclusive lower bound (`YYYY-MM-DD`).
        to:
          type: string
          description: Inclusive upper bound (`YYYY-MM-DD`).
    FiscalSummaryView:
      type: object
      description: Response body of `GET /v1/fiscal/summary`.
      required:
      - period
      - config
      - collected_cents
      - franchise_tva
      - micro_ceiling_cents
      - next_declaration_deadline
      - estimate
      properties:
        collected_cents:
          type: integer
          format: int64
          description: Cash collected over the window (centimes).
        config:
          $ref: '#/components/schemas/FiscalConfigView'
          description: The configuration the figures were computed with.
        estimate:
          type: boolean
          description: 'Always `true`: an estimate, never an official declaration.'
        franchise_tva:
          $ref: '#/components/schemas/FranchiseTvaView'
          description: VAT-franchise thresholds.
        micro_ceiling_cents:
          type: integer
          format: int64
          description: Micro-entreprise revenue ceiling (centimes).
        net_after_charges_cents:
          type:
          - integer
          - 'null'
          format: int64
          description: Collected minus provision (centimes); `None` when the rate is unknown.
        next_declaration_deadline:
          type: string
          description: Next URSSAF declaration deadline (`YYYY-MM-DD`).
        period:
          $ref: '#/components/schemas/FiscalPeriodView'
          description: The window.
        provision_cents:
          type:
          - integer
          - 'null'
          format: int64
          description: 'Social charges to set aside (centimes); `None` when the rate is unknown,

            never a silent zero.'
    ErrorBody:
      type: object
      description: 'Generic error body returned by API handlers when they fail. `code` is a

        stable machine-readable token; `message` is human-friendly and meant for

        surfacing to end users.'
      required:
      - code
      - message
      properties:
        code:
          type: string
          description: Stable machine token (e.g. `invalid_credentials`).
        field:
          type:
          - string
          - 'null'
          description: Offending request field for validation errors, when known.
        message:
          type: string
          description: Human-readable message.
    CashflowPaymentView:
      type: object
      description: One payment with its share of social charges and VAT.
      required:
      - payment_id
      - document_id
      - paid_on
      - amount_cents
      - vat_cents
      properties:
        amount_cents:
          type: integer
          format: int64
          description: Amount received (centimes, VAT included).
        contact_name:
          type:
          - string
          - 'null'
          description: Displayable client name, `None` when it can't be resolved.
        document_id:
          type: string
          format: uuid
          description: Document the payment settles.
        document_number:
          type:
          - string
          - 'null'
          description: Document number, `None` for an un-numbered draft.
        paid_on:
          type: string
          description: Day the payment was received (`YYYY-MM-DD`, UTC).
        payment_id:
          type: string
          format: uuid
          description: The payment itself.
        provision_cents:
          type:
          - integer
          - 'null'
          format: int64
          description: 'Social charges to set aside, at the rate in force on `paid_on`; `None`

            when the rate is unknown, never a silent zero.'
        vat_cents:
          type: integer
          format: int64
          description: VAT included in the payment (centimes); `0` without VAT.
  securitySchemes:
    api_key:
      type: http
      scheme: bearer
    session:
      type: apiKey
      in: cookie
      name: asap_session