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

# Create Payment Reconciliation



## OpenAPI

````yaml post /v1/payment-reconciliations
openapi: 3.1.0
info:
  title: ClinikAPI
  version: 1.0.0
  description: >
    ClinikAPI is a managed healthcare infrastructure platform providing a
    developer-friendly REST API

    for storing, querying, and managing clinical data using the FHIR R4
    standard.


    ## Authentication

    All endpoints (except `/v1/metadata` and `/health`) require an API key via
    the `x-api-key` header.

    - Production keys: `clk_live_*`

    - Test/sandbox keys: `clk_test_*`


    ## Response Format

    All responses are wrapped in `{ data: T, meta: { requestId, timestamp,
    status, rateLimitTotal, rateLimitRemaining, rateLimitReset } }`.


    ## Rate Limits

    Rate limits are plan-based and returned in response headers:

    - `X-RateLimit-Limit` — total requests allowed per window

    - `X-RateLimit-Remaining` — requests remaining

    - `X-RateLimit-Reset` — seconds until window resets


    ## Overages

    Requests beyond your plan limit are charged at $0.003/request.
  contact:
    name: ClinikAPI Support
    email: support@clinikapi.com
    url: https://clinikapi.com
  license:
    name: Proprietary
servers:
  - url: https://api.clinikapi.com
    description: Production
  - url: http://localhost:3000
    description: Local development
security:
  - ApiKeyAuth: []
tags:
  - name: System
    description: Health check and metadata
  - name: Patients
    description: Patient demographics and records
  - name: Practitioners
    description: Healthcare providers and clinicians
  - name: PractitionerRoles
    description: Practitioner roles, specialties, and availability
  - name: Encounters
    description: Clinical visits and interactions
  - name: Observations
    description: Vitals, lab values, and clinical measurements
  - name: Medications
    description: Drug catalog entries
  - name: Appointments
    description: Scheduling and booking
  - name: Prescriptions
    description: Medication orders (MedicationRequest)
  - name: Intakes
    description: Questionnaire responses and intake forms
  - name: Consents
    description: Privacy and treatment consent directives
  - name: Labs
    description: Diagnostic reports and lab results
  - name: Notes
    description: Clinical notes and documents (DocumentReference)
  - name: Assessments
    description: Clinical impressions and evaluations
  - name: Documents
    description: Structured clinical documents (Composition)
  - name: Devices
    description: Medical devices, equipment, and implantable hardware
  - name: DeviceRequests
    description: Orders and proposals for device use
  - name: DeviceUseStatements
    description: Records of device use on patients
  - name: Goals
    description: Patient care goals and targets
  - name: Invoices
    description: Healthcare billing invoices
  - name: MedicationDispenses
    description: Pharmacy medication dispensing records
  - name: MedicationKnowledge
    description: Drug reference data and formulary information
  - name: MedicationStatements
    description: Patient-reported medication usage records
  - name: PaymentNotices
    description: Payment status notifications between payers and providers
  - name: PaymentReconciliations
    description: Detailed payment settlement information with line-item breakdowns
  - name: Specimens
    description: Biological samples collected from patients for laboratory testing
  - name: ImagingStudies
    description: Radiology and diagnostic imaging exams with series-level detail
  - name: EnrollmentRequests
    description: Insurance enrollment requests for patients
  - name: EnrollmentResponses
    description: Insurer responses to enrollment requests
  - name: ImmunizationEvaluations
    description: Evaluation of immunization events against protocol requirements
  - name: Media
    description: Clinical images, videos, and audio recordings
  - name: AuditEvents
    description: Security-relevant event records for compliance and audit trails
  - name: Measures
    description: Quality measures and clinical performance metric definitions
  - name: MeasureReports
    description: Results of evaluating quality measures against populations or patients
  - name: ImmunizationRecommendations
    description: Patient-specific vaccine recommendations based on immunization history
  - name: Bulk
    description: Bulk import and export operations
  - name: FHIR Passthrough
    description: Raw FHIR R4 access with tenant isolation
paths:
  /v1/payment-reconciliations:
    post:
      tags:
        - PaymentReconciliations
      summary: Create payment reconciliation
      operationId: createPaymentReconciliation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentReconciliationCreate'
      responses:
        '201':
          description: Payment reconciliation created
components:
  schemas:
    PaymentReconciliationCreate:
      type: object
      required:
        - status
        - paymentDate
        - paymentAmount
      properties:
        status:
          type: string
          enum:
            - active
            - cancelled
            - draft
        created:
          type: string
          maxLength: 50
        paymentIssuerId:
          type: string
          maxLength: 128
        requestId:
          type: string
          maxLength: 128
        requestorId:
          type: string
          maxLength: 128
        outcome:
          type: string
          enum:
            - queued
            - complete
            - error
            - partial
        disposition:
          type: string
          maxLength: 2000
        paymentDate:
          type: string
          maxLength: 50
        paymentAmount:
          type: object
          required:
            - value
          properties:
            value:
              type: number
            currency:
              type: string
              maxLength: 10
        period:
          type: object
          properties:
            start:
              type: string
            end:
              type: string
        detail:
          type: array
          maxItems: 50
          items:
            type: object
            required:
              - type
            properties:
              type:
                type: string
                maxLength: 200
              requestId:
                type: string
                maxLength: 128
              submitterId:
                type: string
                maxLength: 128
              payeeId:
                type: string
                maxLength: 128
              date:
                type: string
                maxLength: 50
              amount:
                type: object
                properties:
                  value:
                    type: number
                  currency:
                    type: string
                    maxLength: 10
        processNote:
          type: array
          maxItems: 20
          items:
            type: object
            required:
              - text
            properties:
              type:
                type: string
                maxLength: 50
              text:
                type: string
                maxLength: 5000
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Your ClinikAPI secret key (clk_live_* or clk_test_*)

````