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

# Read an authorized historical invoice or receipt

> Independently rechecks the original credential, current payment-link and target module viewing permission, exact document ID, team and current mode. Saved and nested references grant no authority. Current runtime project bucket and exact invoice/files-subdocument storage path are enforced. No document generation, download-token minting, Storage metadata writes or provider writes occur. Current authority and document/files snapshots are checked again after read-only Storage awaits. Returns the entire mapped public invoice/receipt DTO. files.pdf and files.xml are existing safe HTTPS URLs or null; file_status separately reports existing file availability. Ordinary history reads never return inline bytes.



## OpenAPI

````yaml openapi.json GET /payments/links/{linkId}/history/{resourceType}/{resourceId}
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:
  /payments/links/{linkId}/history/{resourceType}/{resourceId}:
    get:
      tags:
        - Payments
      summary: Read an authorized historical invoice or receipt
      description: >-
        Independently rechecks the original credential, current payment-link and
        target module viewing permission, exact document ID, team and current
        mode. Saved and nested references grant no authority. Current runtime
        project bucket and exact invoice/files-subdocument storage path are
        enforced. No document generation, download-token minting, Storage
        metadata writes or provider writes occur. Current authority and
        document/files snapshots are checked again after read-only Storage
        awaits. Returns the entire mapped public invoice/receipt DTO. files.pdf
        and files.xml are existing safe HTTPS URLs or null; file_status
        separately reports existing file availability. Ordinary history reads
        never return inline bytes.
      operationId: getPaymentLinkHistoryV2
      parameters:
        - name: linkId
          in: path
          required: true
          schema:
            type: string
        - name: resourceType
          in: path
          required: true
          schema:
            enum:
              - invoices
              - receipts
            type: string
        - name: resourceId
          in: path
          required: true
          schema:
            pattern: ^[A-Za-z0-9_-]{1,160}$
            type: string
        - $ref: '#/components/parameters/TeamParameter'
      responses:
        '200':
          description: Full independently authorized public document projection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentLinkHistoryResponse'
        '400':
          description: Invalid kind or identifier
        '403':
          description: Current credential or module permission refused
        '404':
          description: Missing or out-of-scope link, saved reference or resource
        '409':
          description: Resource, files or selected mode changed while reading
        '503':
          description: Read unconfirmed
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:
    PaymentLinkHistoryResponse:
      type: object
      additionalProperties: false
      required:
        - success
        - data
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          properties:
            resource_type:
              enum:
                - invoices
                - receipts
              type: string
            resource_id:
              type: string
            team_id:
              type: string
            livemode:
              type: boolean
            storage_project_id:
              pattern: ^[a-z][a-z0-9-]{4,62}$
              type: string
            document:
              anyOf:
                - $ref: '#/components/schemas/PaymentLinkHistoryInvoice'
                - $ref: '#/components/schemas/PaymentLinkHistoryReceipt'
              description: >-
                Full mapped public invoice or receipt. All nested related IDs
                remain hints requiring separate authorization.
            file_status:
              properties:
                pdf:
                  enum:
                    - available
                    - unavailable
                  type: string
                xml:
                  enum:
                    - available
                    - unavailable
                  type: string
              additionalProperties: false
              required:
                - pdf
                - xml
              type: object
          additionalProperties: false
          required:
            - resource_type
            - resource_id
            - team_id
            - livemode
            - storage_project_id
            - document
            - file_status
          type: object
    PaymentLinkHistoryInvoice:
      properties:
        uuid:
          type: string
          nullable: true
        client:
          properties:
            id:
              type: string
              nullable: true
            address:
              additionalProperties: false
              properties:
                country:
                  maxLength: 3
                  type: string
                  nullable: true
                street:
                  type: string
                  nullable: true
                zip:
                  type: string
                  nullable: true
                city:
                  type: string
                  nullable: true
                state:
                  type: string
                  nullable: true
                exterior:
                  type: string
                  nullable: true
                interior:
                  type: string
                  nullable: true
                municipality:
                  type: string
                  nullable: true
                neighborhood:
                  type: string
                  nullable: true
              type: object
              nullable: true
            name:
              type: string
              nullable: true
            company:
              type: string
              nullable: true
            phone:
              type: string
              nullable: true
            email:
              type: string
              nullable: true
            bcc:
              items:
                type: string
                nullable: true
              type: array
              nullable: true
            metadata:
              additionalProperties: true
              type: object
              nullable: true
            is_valid:
              type: boolean
              nullable: true
            from:
              type: string
              nullable: true
            legal_name:
              type: string
              nullable: true
            livemode:
              type: boolean
              nullable: true
            owner:
              type: string
              nullable: true
            tax_id:
              type: string
              nullable: true
            use:
              type: string
              nullable: true
            tax_system:
              type: string
              nullable: true
            team:
              type: string
              nullable: true
            created_at:
              type: number
              nullable: true
            efos:
              properties:
                is_valid:
                  type: boolean
                  nullable: true
              additionalProperties: false
              type: object
              nullable: true
            fiscal_validation:
              properties:
                status:
                  type: string
                  nullable: true
                message:
                  type: string
                  nullable: true
              additionalProperties: false
              type: object
              nullable: true
            sat_status:
              properties:
                is_risky:
                  type: boolean
                  nullable: true
                efos:
                  properties:
                    is_valid:
                      type: boolean
                      nullable: true
                  additionalProperties: false
                  type: object
                  nullable: true
                hits:
                  items:
                    properties:
                      list:
                        type: string
                        nullable: true
                      label:
                        type: string
                        nullable: true
                      source:
                        type: string
                        nullable: true
                      is_risky:
                        type: boolean
                        nullable: true
                      detail:
                        additionalProperties: true
                        type: object
                        nullable: true
                    additionalProperties: false
                    type: object
                    nullable: true
                  type: array
                  nullable: true
                checked_at:
                  type: number
                  nullable: true
              additionalProperties: false
              type: object
              nullable: true
            defaults:
              properties:
                keep_full_legal_name:
                  type: boolean
                  nullable: true
                issue_automatic_invoices:
                  type: boolean
                  nullable: true
                issue_invoiceable_receipts:
                  type: boolean
                  nullable: true
              additionalProperties: false
              type: object
              nullable: true
            document_type:
              type: string
              nullable: true
            organization_type:
              anyOf:
                - type: integer
                  nullable: true
                - type: string
            tribute_code:
              type: string
              nullable: true
            fiscal_responsibilities:
              items:
                type: string
                nullable: true
              type: array
              nullable: true
            dv:
              type: string
              nullable: true
            municipality_code:
              type: string
              nullable: true
          additionalProperties: false
          type: object
          nullable: true
        created_at:
          type: number
          nullable: true
        currency:
          type: string
          nullable: true
        exchange_rate:
          type: number
          nullable: true
        total:
          type: number
          nullable: true
        subtotal:
          type: number
          nullable: true
        taxes:
          type: number
          nullable: true
        discount:
          type: number
          nullable: true
        withholding_taxes:
          type: number
          nullable: true
        series:
          type: string
          nullable: true
        folio_number:
          type: number
          nullable: true
        invoice_type:
          type: string
          nullable: true
        use:
          type: string
          nullable: true
        payment_form:
          type: string
          nullable: true
        payment_method:
          type: string
          nullable: true
        status:
          type: string
          nullable: true
        livemode:
          type: boolean
        owner:
          type: string
          nullable: true
        from:
          type: string
          nullable: true
        items:
          items:
            properties:
              id:
                type: string
                nullable: true
              description:
                type: string
                nullable: true
              product_key:
                type: string
                nullable: true
              quantity:
                type: number
                nullable: true
              unit_price:
                type: number
                nullable: true
              unit_key:
                type: string
                nullable: true
              unit_name:
                type: string
                nullable: true
              sku:
                type: string
                nullable: true
              taxability:
                type: string
                nullable: true
              taxes:
                items:
                  properties:
                    base:
                      anyOf:
                        - type: number
                          nullable: true
                        - type: string
                    rate:
                      anyOf:
                        - type: number
                          nullable: true
                        - type: string
                    type:
                      type: string
                      nullable: true
                    factor:
                      type: string
                      nullable: true
                    inclusive:
                      type: boolean
                      nullable: true
                    withholding:
                      type: boolean
                      nullable: true
                  additionalProperties: false
                  type: object
                  nullable: true
                type: array
                nullable: true
              discount:
                type: number
                nullable: true
              customs_request:
                type: string
                nullable: true
              complement:
                type: string
                nullable: true
              property_tax_account:
                type: string
                nullable: true
              third_party:
                properties:
                  legal_name:
                    type: string
                    nullable: true
                  tax_id:
                    type: string
                    nullable: true
                  tax_system:
                    type: string
                    nullable: true
                  zip:
                    type: string
                    nullable: true
                additionalProperties: false
                type: object
                nullable: true
            additionalProperties: false
            type: object
            nullable: true
          type: array
          nullable: true
        payments:
          items:
            type: string
            nullable: true
          type: array
          nullable: true
        invoices:
          items:
            type: string
            nullable: true
          type: array
          nullable: true
        stamp:
          properties:
            sello:
              type: string
              nullable: true
            stamp_at:
              type: number
              nullable: true
            provider:
              type: string
              nullable: true
          additionalProperties: false
          type: object
          nullable: true
        cancellation:
          properties:
            cancellation_status:
              type: string
              nullable: true
            cancelled_at:
              type: number
              nullable: true
            motive:
              type: string
              nullable: true
            code:
              type: string
              nullable: true
            requested_by:
              type: string
              nullable: true
            cancellation_receipt:
              type: string
              nullable: true
            cancellation_type:
              type: string
              nullable: true
            last_checked:
              type: number
              nullable: true
            requested_at:
              type: number
              nullable: true
            substitution_uuid:
              type: string
              nullable: true
          additionalProperties: false
          type: object
          nullable: true
        verification_url:
          type: string
          nullable: true
        exports:
          type: string
          nullable: true
        addenda:
          type: string
          nullable: true
        invoice_pdf_notes:
          type: string
          nullable: true
        files:
          properties:
            pdf:
              type: string
              nullable: true
            xml:
              type: string
              nullable: true
          additionalProperties: false
          required:
            - pdf
            - xml
          type: object
        idempotency_key:
          type: string
          nullable: true
        team:
          type: string
        billing_account:
          type: string
          nullable: true
        date:
          type: integer
          nullable: true
        payment_conditions:
          type: string
          nullable: true
        global:
          type: object
          additionalProperties: false
          properties:
            year:
              type: number
              nullable: true
            months:
              type: string
              nullable: true
            periodicity:
              type: string
              nullable: true
          nullable: true
        related_documents:
          items:
            properties:
              relationship:
                type: string
                nullable: true
              documents:
                items:
                  type: string
                  nullable: true
                type: array
                nullable: true
            additionalProperties: false
            type: object
            nullable: true
          type: array
          nullable: true
        complements:
          items:
            properties:
              type:
                type: string
                nullable: true
              data:
                type: string
                nullable: true
            additionalProperties: false
            type: object
            nullable: true
          type: array
          nullable: true
        metadata:
          additionalProperties: true
          type: object
          nullable: true
        emails:
          items:
            type: string
            nullable: true
          type: array
          nullable: true
        issuer_info:
          properties:
            legal_name:
              type: string
              nullable: true
            tax_id:
              type: string
              nullable: true
            tax_system:
              type: string
              nullable: true
            zip:
              type: string
              nullable: true
          additionalProperties: false
          type: object
          nullable: true
        namespaces:
          items:
            properties:
              prefix:
                type: string
                nullable: true
              uri:
                type: string
                nullable: true
              schema_location:
                type: string
                nullable: true
            additionalProperties: false
            type: object
            nullable: true
          type: array
          nullable: true
        id:
          pattern: ^[A-Za-z0-9_-]{1,160}$
          type: string
        payment_complements:
          type: number
          nullable: true
        last_balance:
          type: number
          nullable: true
        installments:
          type: number
          nullable: true
        automations:
          items:
            properties:
              type:
                type: string
                nullable: true
              from:
                type: string
                nullable: true
              ref:
                type: string
                nullable: true
              action:
                type: string
                nullable: true
            additionalProperties: false
            type: object
            nullable: true
          type: array
          nullable: true
      additionalProperties: false
      required:
        - id
        - team
        - livemode
        - files
      type: object
    PaymentLinkHistoryReceipt:
      properties:
        id:
          type: string
        client:
          properties:
            id:
              type: string
              nullable: true
            address:
              additionalProperties: false
              properties:
                country:
                  maxLength: 3
                  type: string
                  nullable: true
                street:
                  type: string
                  nullable: true
                zip:
                  type: string
                  nullable: true
                city:
                  type: string
                  nullable: true
                state:
                  type: string
                  nullable: true
                exterior:
                  type: string
                  nullable: true
                interior:
                  type: string
                  nullable: true
                municipality:
                  type: string
                  nullable: true
                neighborhood:
                  type: string
                  nullable: true
              type: object
              nullable: true
            name:
              type: string
              nullable: true
            company:
              type: string
              nullable: true
            phone:
              type: string
              nullable: true
            email:
              type: string
              nullable: true
            bcc:
              items:
                type: string
                nullable: true
              type: array
              nullable: true
            metadata:
              additionalProperties: true
              type: object
              nullable: true
            is_valid:
              type: boolean
              nullable: true
            from:
              type: string
              nullable: true
            legal_name:
              type: string
              nullable: true
            livemode:
              type: boolean
              nullable: true
            owner:
              type: string
              nullable: true
            tax_id:
              type: string
              nullable: true
            use:
              type: string
              nullable: true
            tax_system:
              type: string
              nullable: true
            team:
              type: string
              nullable: true
            created_at:
              type: number
              nullable: true
            efos:
              properties:
                is_valid:
                  type: boolean
                  nullable: true
              additionalProperties: false
              type: object
              nullable: true
            fiscal_validation:
              properties:
                status:
                  type: string
                  nullable: true
                message:
                  type: string
                  nullable: true
              additionalProperties: false
              type: object
              nullable: true
            sat_status:
              properties:
                is_risky:
                  type: boolean
                  nullable: true
                efos:
                  properties:
                    is_valid:
                      type: boolean
                      nullable: true
                  additionalProperties: false
                  type: object
                  nullable: true
                hits:
                  items:
                    properties:
                      list:
                        type: string
                        nullable: true
                      label:
                        type: string
                        nullable: true
                      source:
                        type: string
                        nullable: true
                      is_risky:
                        type: boolean
                        nullable: true
                      detail:
                        additionalProperties: true
                        type: object
                        nullable: true
                    additionalProperties: false
                    type: object
                    nullable: true
                  type: array
                  nullable: true
                checked_at:
                  type: number
                  nullable: true
              additionalProperties: false
              type: object
              nullable: true
            defaults:
              properties:
                keep_full_legal_name:
                  type: boolean
                  nullable: true
                issue_automatic_invoices:
                  type: boolean
                  nullable: true
                issue_invoiceable_receipts:
                  type: boolean
                  nullable: true
              additionalProperties: false
              type: object
              nullable: true
            document_type:
              type: string
              nullable: true
            organization_type:
              anyOf:
                - type: integer
                  nullable: true
                - type: string
            tribute_code:
              type: string
              nullable: true
            fiscal_responsibilities:
              items:
                type: string
                nullable: true
              type: array
              nullable: true
            dv:
              type: string
              nullable: true
            municipality_code:
              type: string
              nullable: true
          additionalProperties: false
          type: object
          nullable: true
        currency:
          type: string
          nullable: true
        exchange_rate:
          type: number
          nullable: true
        from:
          type: string
          nullable: true
        url:
          type: string
          nullable: true
        created_at:
          type: number
          nullable: true
        invoices:
          type: array
          nullable: true
          items:
            type: string
        items:
          items:
            properties:
              id:
                type: string
                nullable: true
              description:
                type: string
                nullable: true
              from:
                type: string
                nullable: true
              sku:
                type: string
                nullable: true
              product_key:
                type: string
                nullable: true
              unit_key:
                type: string
                nullable: true
              unit_name:
                type: string
                nullable: true
              unit_price:
                type: number
                nullable: true
              taxes:
                items:
                  properties:
                    base:
                      anyOf:
                        - type: number
                          nullable: true
                        - type: string
                    rate:
                      anyOf:
                        - type: number
                          nullable: true
                        - type: string
                    type:
                      type: string
                      nullable: true
                    factor:
                      type: string
                      nullable: true
                    inclusive:
                      type: boolean
                      nullable: true
                    withholding:
                      type: boolean
                      nullable: true
                  additionalProperties: false
                  type: object
                  nullable: true
                type: array
                nullable: true
              team:
                type: string
                nullable: true
              created_at:
                type: number
                nullable: true
              quantity:
                type: number
                nullable: true
              discount:
                type: number
                nullable: true
              third_party:
                properties:
                  legal_name:
                    type: string
                    nullable: true
                  tax_id:
                    type: string
                    nullable: true
                  tax_system:
                    type: string
                    nullable: true
                  zip:
                    type: string
                    nullable: true
                additionalProperties: false
                type: object
                nullable: true
              item_complement:
                properties:
                  hydrocarbons:
                    properties:
                      permit_type:
                        type: string
                        nullable: true
                      permit_number:
                        type: string
                        nullable: true
                      fuel_code:
                        type: string
                        nullable: true
                      fuel_sub_product:
                        type: string
                        nullable: true
                    additionalProperties: false
                    type: object
                    nullable: true
                additionalProperties: false
                type: object
                nullable: true
            additionalProperties: false
            type: object
            nullable: true
          type: array
          nullable: true
        livemode:
          type: boolean
        metadata:
          additionalProperties: true
          type: object
          nullable: true
        owner:
          type: string
          nullable: true
        payments:
          type: array
          nullable: true
          items:
            type: string
        periodicity:
          type: string
          nullable: true
        short_url:
          type: string
          nullable: true
        status:
          type: string
          nullable: true
        team:
          type: string
        valid_until:
          type: number
          nullable: true
        invoice_config:
          properties:
            serie:
              type: string
              nullable: true
            folio:
              anyOf:
                - type: number
                  nullable: true
                - type: string
            date:
              type: number
              nullable: true
            global:
              type: object
              additionalProperties: false
              properties:
                year:
                  type: number
                  nullable: true
                months:
                  type: string
                  nullable: true
                periodicity:
                  type: string
                  nullable: true
              nullable: true
            validUntil:
              type: number
              nullable: true
          additionalProperties: false
          type: object
          nullable: true
        automatic_invoice_error:
          type: string
          nullable: true
        payment_form:
          type: string
          nullable: true
        files:
          properties:
            pdf:
              type: string
              nullable: true
            xml:
              type: string
              nullable: true
          additionalProperties: false
          required:
            - pdf
            - xml
          type: object
        total:
          type: number
          nullable: true
        total_refunded:
          type: number
          nullable: true
        subtotal:
          type: number
          nullable: true
        taxes:
          type: number
          nullable: true
        discount:
          type: number
          nullable: true
        withholding_taxes:
          type: number
          nullable: true
        idempotency_key:
          type: string
          nullable: true
      additionalProperties: false
      required:
        - id
        - team
        - livemode
        - files
      type: object
  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.