---
openapi: 3.0.0
info:
  title: Nimbo billing
  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:
  "/invoices/{id}/sign":
    post:
      summary: POST /invoices/{id}/sign
      parameters:
      - name: id
        in: query
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    type: object
                    properties:
                      id:
                        type: integer
                      payment_type:
                        type: string
                      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
                        properties:
                          use_cfdi:
                            type: string
                          payment_form:
                            type: string
                          payment_method:
                            type: string
                      signed_at:
                        type: string
                        format: date-time
                      globally_invoiced:
                        type: boolean
                      cause:
                        type: string
                      starts_at:
                        type: string
                        format: date-time
          description: Successful response
      security:
      - BearerAuth: []
      operationId: legacy_nimbo_facturacion_post__invoices_id_sign
  "/reports/consultation_invoice_items":
    get:
      summary: GET /reports/consultation_invoice_items
      parameters:
      - name: start
        in: query
        schema:
          type: string
      - name: end
        in: query
        schema:
          type: string
      - name: status
        in: query
        schema:
          type: string
      - name: person
        in: query
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  encounters:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        created_at:
                          type: string
                          format: date-time
                        cause:
                          type: string
                        invoice_id:
                          type: integer
                        total_discount_cents:
                          type: integer
                        total_tax_cents:
                          type: integer
                        total_cents:
                          type: integer
                        signed_at:
                          type: string
                          format: date-time
                        charges_count:
                          type: integer
                        full_name:
                          type: string
                        payment_type:
                          type: string
                        subtotal:
                          type: integer
                        payment:
                          type: integer
                        physician_name:
                          type: string
                        status:
                          type: string
                  invoice_metrics:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          nullable: true
                        total_cents:
                          type: integer
                        total_items:
                          type: integer
                        total_items_payments:
                          type: integer
                        average:
                          type: integer
                        total_payments:
                          type: string
          description: Successful response
      security:
      - BearerAuth: []
      operationId: legacy_nimbo_facturacion_get__reports_consultation_invoice_items
  "/invoices/{id}/download_cfdi.pdf":
    get:
      summary: GET /invoices/{id}/download_cfdi.pdf
      parameters:
      - name: token
        in: query
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      operationId: legacy_nimbo_facturacion_get__invoices_id_download_cfdi_pdf
  "/invoices/{id}/download_cfdi.xml":
    get:
      summary: GET /invoices/{id}/download_cfdi.xml
      parameters:
      - name: token
        in: query
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      operationId: legacy_nimbo_facturacion_get__invoices_id_download_cfdi_xml
  "/invoices/{id}/email_invoice":
    post:
      summary: POST /invoices/{id}/email_invoice
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    type: object
                    properties:
                      id:
                        type: integer
                      payment_type:
                        type: string
                      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
                        properties:
                          use_cfdi:
                            type: string
                          payment_form:
                            type: string
                          payment_method:
                            type: string
                      signed_at:
                        type: string
                        format: date-time
                      globally_invoiced:
                        type: boolean
                      cause:
                        type: string
                      starts_at:
                        type: string
                        format: date-time
          description: Successful response
      security:
      - BearerAuth: []
      operationId: legacy_nimbo_facturacion_post__invoices_id_email_invoice
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer