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

# Create receipts for paid payments

> Create one pending receipt for every paid payment in a date range that has neither an
invoice nor a receipt yet, so each client can invoice it from the self-invoicing portal.
The range is on the payment's creation date and defaults to the current month
(Mexico City time); it can span at most one year.

Send `dry_run: true` first: it only counts (`count`, `total`, `with_email`) and works
on any plan. Creating the receipts is only available on Pricing v3 plans (`403 v3_only`
on earlier plans), and live v3 teams need the self-invoice portal (`self_invoice_portal`,
`403 feature_not_enabled` otherwise). Each call creates at most 200
receipts, oldest first; `remaining` says how many are left, so call again until it is 0.
Payments that got a receipt meanwhile are skipped, so repeating a call is safe.

The receipt is dated when the payment was made (`date`), is billed when it is created,
and is valid until the end of the current month. Clients are emailed the link only with
`send_email: true`. Teams with receipts turned off (`avoid_receipts`) get `409`.

**gigstack Connect:** create other teams' receipts with the `team` parameter.




## OpenAPI

````yaml openapi.json POST /receipts/from-payments
openapi: 3.0.3
info:
  title: gigstack API v2
  description: >
    # gigstack API v2


    Build customer, invoice and payment integrations. Start with the
    [quickstart](https://docs.gigstack.io/quickstart), then select the [issuing
    country](https://docs.gigstack.io/concepts/shared-fields).


    ## Authentication and environments


    Use Authorization: Bearer YOUR_API_KEY. Standard live and test keys use
    https://api.gigstack.io/v2. Internal staging uses
    https://gigstack-staging-9z9nnaat.uc.gateway.dev/v2 and separate keys. Test
    mode is a data mode within an environment; a body field does not switch a
    key's mode.


    See [authentication](https://docs.gigstack.io/authentication) for key
    handling, OAuth team scope and gigstack Connect. Internal partner
    provisioning is outside this public contract; health probes have their own
    security declarations. Operations marked unavailable have no configured
    public gateway route.


    ## Read the operation contract


    Response envelopes, pagination and retry rules differ by endpoint. HTTP
    success alone does not prove external fiscal completion or movement of
    money. Reconcile ambiguous writes before retrying. Use [responses and
    recovery](https://docs.gigstack.io/responses) and the operation's error
    codes; document credits and daily limits are not generic retryable rate
    limits.


    The issuing team's configuration selects Mexico or Colombia; customer
    country and currency do not. Read
    [Mexico](https://docs.gigstack.io/countries/mexico) or
    [Colombia](https://docs.gigstack.io/countries/colombia) before choosing
    fiscal fields. Accepted public input differs from a provider's direct
    payload.


    Examples and schema checks do not imply every operation has been executed
    live. [Verification coverage](https://docs.gigstack.io/verification)
    distinguishes source review, offline checks and observed staging behavior.
    Documentation describes operations and does not authorize execution.
  version: 2.0.0
  contact:
    name: Gigstack API Support
    url: https://gigstack.io
    email: support@gigstack.io
  license:
    name: Proprietary
    url: https://gigstack.io/terms
  termsOfService: https://gigstack.io/terms
servers:
  - url: https://api.gigstack.io/v2
    description: >
      Public API for standard live and test-mode keys. Test data is isolated by
      the key mode

      (`livemode: false`). Internal staging is a separate deployment and key
      store; see

      https://docs.gigstack.io/authentication#environments for its base URL.
security:
  - bearerAuth: []
externalDocs:
  description: Complete API Documentation & Guides
  url: https://docs.gigstack.io
paths:
  /receipts/from-payments:
    post:
      tags:
        - Receipts
      summary: Create receipts for paid payments
      description: >
        Create one pending receipt for every paid payment in a date range that
        has neither an

        invoice nor a receipt yet, so each client can invoice it from the
        self-invoicing portal.

        The range is on the payment's creation date and defaults to the current
        month

        (Mexico City time); it can span at most one year.


        Send `dry_run: true` first: it only counts (`count`, `total`,
        `with_email`) and works

        on any plan. Creating the receipts is only available on Pricing v3 plans
        (`403 v3_only`

        on earlier plans), and live v3 teams need the self-invoice portal
        (`self_invoice_portal`,

        `403 feature_not_enabled` otherwise). Each call creates at most 200

        receipts, oldest first; `remaining` says how many are left, so call
        again until it is 0.

        Payments that got a receipt meanwhile are skipped, so repeating a call
        is safe.


        The receipt is dated when the payment was made (`date`), is billed when
        it is created,

        and is valid until the end of the current month. Clients are emailed the
        link only with

        `send_email: true`. Teams with receipts turned off (`avoid_receipts`)
        get `409`.


        **gigstack Connect:** create other teams' receipts with the `team`
        parameter.
      operationId: createReceiptsFromPayments
      parameters:
        - $ref: '#/components/parameters/TeamParameter'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                start:
                  type: number
                  nullable: true
                  example: 1790834400000
                  description: 'Range start (ms). Default: first day of the current month.'
                end:
                  type: number
                  nullable: true
                  example: 1793512799000
                  description: 'Range end (ms). Default: now.'
                dry_run:
                  type: boolean
                  nullable: true
                  example: true
                  description: Only count; create nothing.
                send_email:
                  type: boolean
                  nullable: true
                  example: false
                  description: Email each client the self-invoicing link. Default false.
            example:
              dry_run: true
      responses:
        '200':
          description: Preview (`dry_run`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardSuccessResponse'
              example:
                success: true
                data:
                  start: 1790834400000
                  end: 1793041200000
                  count: 24
                  total: 52310.5
                  with_email: 24
                  truncated: false
                  dry_run: true
                message: Preview of receipts to create
                timestamp: 1793041200000
        '201':
          description: Receipts created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardSuccessResponse'
              example:
                success: true
                data:
                  start: 1790834400000
                  end: 1793041200000
                  count: 24
                  total: 52310.5
                  with_email: 24
                  truncated: false
                  dry_run: false
                  created: 24
                  skipped: 0
                  remaining: 0
                  stopped_reason: null
                  receipts:
                    - receipt: receipt_1234567890
                      payment: payment_1234567890
                message: 24 receipts created
                timestamp: 1793041200000
        '400':
          description: >-
            `start`/`end` are not timestamps, `end` is before `start`, or the
            range is longer than a year.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: >-
            `v3_only`: creating receipts from payments needs a Pricing v3 plan.
            `feature_not_enabled`: the self-invoice portal is not on for this
            live v3 team.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '409':
          description: Receipts are turned off for this team (`avoid_receipts`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - bearerAuth: []
components:
  parameters:
    TeamParameter:
      name: team
      in: query
      required: false
      schema:
        type: string
      description: >
        **gigstack Connect:** Target team ID for multi-team access.


        Requires gigstack Connect enabled on your team and shared billing
        account.


        Also requires the `multipleIssuerAccounts` feature on your plan.
        Requests targeting a

        team other than the one your API key belongs to return `403` without it.


        Only API keys can use it: an OAuth access token sent with another team's
        id is rejected with

        `403 Team mismatch with OAuth token`.


        **Optional — omit it entirely** unless you are acting on another team.
        It deliberately

        carries no example value so generated snippets do not emit
        `?team=undefined`; when the

        parameter is absent, the team is derived from your API key.


        **Example:** `?team=team_xyz789`
  schemas:
    StandardSuccessResponse:
      type: object
      description: |
        Standardized success envelope emitted by `sendSuccessResponse`.
      required:
        - success
        - data
        - timestamp
      properties:
        success:
          type: boolean
          enum:
            - true
          example: true
        data:
          type: object
          description: The operation payload.
        message:
          type: string
          description: Human-readable summary. Present only when the handler supplies one.
          example: Operation completed successfully
        timestamp:
          type: integer
          format: int64
          description: Server time in **epoch milliseconds** (`Luxon.now().toMillis()`).
          example: 1767225600000
    ValidationErrorResponse:
      allOf:
        - $ref: '#/components/schemas/StandardErrorResponse'
      description: >
        Body validation failure. Unknown top-level keys are rejected — the
        validator runs in

        strict allowlist mode (`allowUnknown: false`), so a field not declared
        in the request

        schema produces an `unexpected_key` detail rather than being ignored.
      example:
        success: false
        error:
          code: validation_failed
          message: Request validation failed
          details:
            - 'currency: Field is required'
            - 'client_id: Unexpected field'
        timestamp: 1767225600000
    StandardErrorResponse:
      type: object
      description: >
        Standardized error envelope emitted by `sendErrorResponse` and its
        helpers

        (`sendValidationError`, `sendNotFoundError`, `sendUnauthorizedError`,

        `sendForbiddenError`, `sendConflictError`, `sendBadRequestError`,

        `sendInternalServerError`).
      required:
        - success
        - error
        - timestamp
      properties:
        success:
          type: boolean
          enum:
            - false
          example: false
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: >
                Stable machine-readable code. Values emitted by the shared
                helpers:

                `unauthorized`, `forbidden`, `invalid_token`,
                `validation_failed`,

                `invalid_request_body`, `missing_required_field`,
                `invalid_field_value`,

                `resource_not_found`, `resource_already_exists`,
                `resource_conflict`,

                `business_rule_violation`, `operation_not_allowed`,

                `insufficient_permissions`, `external_service_error`,

                `payment_processor_error`, `cfdi_service_error`,

                `internal_server_error`, `service_unavailable`,
                `rate_limit_exceeded`,

                `database_error`, `data_integrity_error`, `file_not_found`,

                `file_upload_error`, `invalid_file_format`. Individual handlers
                may

                emit additional endpoint-specific codes, documented per
                operation.
              example: validation_failed
            message:
              type: string
              example: Request validation failed
            details:
              oneOf:
                - type: string
                - type: array
                  items:
                    type: string
              description: >
                Present only when the handler supplies detail. Validation
                failures

                emit an array of `"<field path>: <message>"` strings.
              example:
                - 'currency: Field is required'
        timestamp:
          type: integer
          format: int64
          description: Server time in epoch milliseconds.
          example: 1767225600000
    AuthMiddlewareError:
      type: object
      description: >
        Raw error body produced by the authentication layer (before any endpoint
        runs). It is not

        the standardized envelope: there is no `success` and no `timestamp`.
      required:
        - message
      properties:
        message:
          type: string
          description: >-
            Human-readable reason. Some messages are in Spanish; branch on the
            HTTP status, not on this text.
          example: Unauthorized
        error:
          type: string
          description: >-
            OAuth error code. Present only when an OAuth access token was
            presented.
          enum:
            - invalid_token
            - token_expired
            - token_revoked
            - server_error
          example: token_expired
        error_description:
          type: string
          description: Same text as `message`. Present only alongside `error`.
          example: Access token has expired. Please refresh your token.
        details:
          description: >-
            Extra detail, e.g. `Invalid API Key` when a revoked key is rejected
            with `403`.
          oneOf:
            - type: string
            - type: object
          example: Invalid API Key
    UnauthorizedError:
      allOf:
        - $ref: '#/components/schemas/StandardErrorResponse'
      example:
        success: false
        error:
          code: unauthorized
          message: Unauthorized access
        timestamp: 1767225600000
  responses:
    Unauthorized:
      description: >
        Authentication failed. Two different bodies can come back with a `401`:


        1. **From the authentication layer**, before the endpoint runs: a raw
        object with
           `message` and — for OAuth access tokens only — `error` / `error_description`. It does
           **not** use the standardized envelope (`success` and `timestamp` are absent). Messages:
           `Unauthorized` (missing header, missing `Bearer ` prefix, unparseable token),
           `Unauthorized, missing team in token`, `Unauthorized, not a master team` and
           `Unauthorized, no matched teams` (gigstack Connect), `Invalid access token`,
           `Access token has expired. Please refresh your token.`, `Access token has been revoked`.
        2. **From the endpoint itself**: the standardized envelope with
        `error.code: unauthorized`.


        Branch on the HTTP status, not on the body shape.
      content:
        application/json:
          schema:
            anyOf:
              - $ref: '#/components/schemas/AuthMiddlewareError'
              - $ref: '#/components/schemas/UnauthorizedError'
          examples:
            missing_or_invalid_key:
              summary: Authentication layer — missing or unparseable API key
              value:
                message: Unauthorized
            oauth_token_expired:
              summary: Authentication layer — expired OAuth access token
              value:
                message: Access token has expired. Please refresh your token.
                error: token_expired
                error_description: Access token has expired. Please refresh your token.
            connect_not_master_team:
              summary: >-
                Authentication layer — `team` sent by a team without gigstack
                Connect
              value:
                message: Unauthorized, not a master team
            endpoint_envelope:
              summary: Endpoint — standardized envelope
              value:
                success: false
                error:
                  code: unauthorized
                  message: Unauthorized access
                timestamp: 1767225600000
    ServerError:
      description: >-
        Unexpected server error (`error.code: internal_server_error`). The
        failure is logged on gigstack's side.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/StandardErrorResponse'
          example:
            success: false
            error:
              code: internal_server_error
              message: An internal server error occurred
            timestamp: 1767225600000
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        **Authentication Method:** HTTP Bearer token.


        The runtime requires the literal `Bearer ` prefix — a bare token in the

        `Authorization` header is rejected with `401 unauthorized`.


        **Header Format:** `Authorization: Bearer YOUR_API_KEY`


        Your API key is a JWT. Live keys operate on live data (`livemode:
        true`);

        test keys operate on isolated test data (`livemode: false`).


        **Get your key at:**
        [app.gigstack.pro/settings?tab=api](https://app.gigstack.pro/settings?tab=api)


        **Errors:** credential failures are answered by the authentication layer
        with a raw

        `{ "message": … }` body, not the standardized envelope — `401` for a
        missing, malformed or

        expired token, `403` for a revoked key or a plan without API access. See
        the `Unauthorized`

        and `AuthForbidden` responses.

````

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