---
openapi: 3.0.0
info:
  title: Nimbo ERP
  version: 1.0.0
  description: Nimbo API reference. Use the API host and integration access provided
    by Nimbo.
servers:
- url: https://api.example.test
  description: Reference only; confirm your integration host with Nimbo
paths:
  "/consultations/{consultation_id}":
    get:
      summary: GET /consultations/{consultation_id}
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  consultation:
                    type: object
                    properties:
                      id:
                        type: integer
                      cause:
                        type: string
                      created_at:
                        type: string
                        format: date-time
                      links:
                        type: object
                        properties:
                          person:
                            type: string
                          prescriptions:
                            type: string
                          encounter:
                            type: string
                          physical_test_samples:
                            type: string
                          consultation_diagnostics:
                            type: string
                          consultation_procedures:
                            type: string
                          consultation_lab_tests:
                            type: string
                          consultation_lab_test_result:
                            type: string
                          consultation_prescription_drugs:
                            type: string
                          consultation_schedule:
                            type: string
                          disability_leave:
                            type: string
                          invoice:
                            type: string
                          vital_signs_set:
                            type: string
                          odontogram:
                            type: string
                          medical_note:
                            type: string
                          physiotherapy_records:
                            type: string
                          medical_history_attachments:
                            type: string
                          location:
                            type: string
                          operating_room_requests:
                            type: string
                      medical_instructions:
                        type: string
                      physical_examination:
                        nullable: true
                      subjective_symptoms:
                        nullable: true
                      cause_extended:
                        nullable: true
                      account_id:
                        type: integer
                      finished_at:
                        nullable: true
                      encounter_id:
                        type: integer
                      treatment_plan:
                        nullable: true
                      starts_at:
                        type: string
                        format: date-time
                      sis:
                        type: object
                      lab_test:
                        type: object
                      procedure:
                        nullable: true
                      encode_id:
                        type: string
                      consultation_attributes:
                        type: object
                      account_medical_instructions:
                        nullable: true
                      cirrus_prescription_status:
                        nullable: true
          description: Successful response
      operationId: legacy_nimbo_erp_get__consultations_consultation_id
      parameters:
      - name: consultation_id
        in: path
        required: true
        schema:
          type: string
  "/encounters/{encounter_id}/invoice":
    get:
      summary: GET /encounters/{encounter_id}/invoice
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    type: object
                    properties:
                      id:
                        type: integer
                      payment_type:
                        nullable: true
                      encounter_id:
                        type: integer
                      person_id:
                        type: integer
                      discount_rate:
                        nullable: true
                      discount_amount:
                        nullable: true
                      tax_rate:
                        nullable: true
                      tax_amount:
                        nullable: true
                      total_cents:
                        type: integer
                      total_discount_cents:
                        type: integer
                      total_tax_cents:
                        type: integer
                      links:
                        type: object
                        properties:
                          consultation:
                            type: string
                          consultation_invoice_items:
                            type: string
                          consultation_schedule:
                            type: string
                          encounter:
                            type: string
                      tax_attributes:
                        type: object
                      signed_at:
                        nullable: true
                      globally_invoiced:
                        type: boolean
                      cause:
                        type: string
                      starts_at:
                        type: string
                        format: date-time
          description: Successful response
      operationId: legacy_nimbo_erp_get__encounters_encounter_id_invoice
      parameters:
      - name: encounter_id
        in: path
        required: true
        schema:
          type: string
  "/invoices/{invoice_id}/consultation_invoice_items":
    get:
      summary: GET /invoices/{invoice_id}/consultation_invoice_items
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  consultation_invoice_items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        quantity:
                          type: integer
                        amount:
                          type: integer
                        value:
                          type: integer
                        account_id:
                          type: integer
                        invoice_item_id:
                          type: integer
                        invoice_id:
                          type: integer
                        invoice_item_sku:
                          nullable: true
                        accounting_type:
                          type: string
                        created_at:
                          type: string
                          format: date-time
                        tax_attributes:
                          type: object
                        kop_key:
                          nullable: true
                        kop_description:
                          nullable: true
                        uom_key:
                          nullable: true
                        uom_description:
                          nullable: true
          description: Successful response
      operationId: legacy_nimbo_erp_get__invoices_invoice_id_consultation_invoice_items
      parameters:
      - name: invoice_id
        in: path
        required: true
        schema:
          type: string
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
security:
- BearerAuth: []