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

# Invoice

> Returns one invoice with its lines: concept, quantity, price, discount, VAT and the charge each documents.

**When to use it:** When you have an invoice id and need its lines or totals. Amounts are in cents.


## OpenAPI

````yaml /api-reference/openapi.en.json get /invoices/{id}
openapi: 3.1.0
info:
  title: Brelio API
  version: '1'
  description: >-
    Everything a person can do in Brelio, a program can do, with the same
    permissions, audit and limits. Every endpoint is derived from the operation
    catalogue.
servers:
  - url: https://api.brelio.app/v1
security: []
tags:
  - name: Calendar
  - name: Scheduling
  - name: Appointments
  - name: Patients
  - name: Professionals
  - name: Services
  - name: Webhooks
  - name: Organizations
  - name: Platform policy
  - name: Billing
paths:
  /invoices/{id}:
    get:
      tags:
        - Billing
      summary: Invoice
      description: >-
        Returns one invoice with its lines: concept, quantity, price, discount,
        VAT and the charge each documents.


        **When to use it:** When you have an invoice id and need its lines or
        totals. Amounts are in cents.
      operationId: invoices.get
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
            description: The invoice id.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    pattern: >-
                      ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                  number:
                    anyOf:
                      - type: string
                      - type: 'null'
                    description: >-
                      The fiscal number given on issue, such as 2026-0042; null
                      while the invoice is a draft.
                  series:
                    type: string
                    description: >-
                      Numbering series: INV for ordinary invoices, R for
                      rectificativas, S for simplified.
                  documentType:
                    type: string
                    enum:
                      - ordinary
                      - simplified
                    description: Factura ordinaria or factura simplificada.
                  status:
                    type: string
                    enum:
                      - draft
                      - issued
                      - paid
                      - partial
                      - void
                      - overdue
                      - credit_note_issued
                      - refunded
                    description: >-
                      draft, issued, partial (part collected), paid, void, or a
                      legacy refund status.
                  patientId:
                    type: string
                    format: uuid
                    pattern: >-
                      ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                    description: The patient the invoice is for.
                  billToId:
                    anyOf:
                      - type: string
                        format: uuid
                        pattern: >-
                          ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                      - type: 'null'
                    description: >-
                      The third-party payer the invoice is addressed to; null
                      when it is addressed to the patient.
                  subtotal:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: Taxable base after discounts, in cents.
                  tax:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: VAT and other taxes, in cents.
                  total:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: Total, in cents.
                  currency:
                    type: string
                    description: ISO 4217 code, such as EUR.
                  correctsInvoiceId:
                    anyOf:
                      - type: string
                        format: uuid
                        pattern: >-
                          ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                      - type: 'null'
                    description: >-
                      For a rectificativa, the invoice it corrects; null
                      otherwise.
                  replacesInvoiceId:
                    anyOf:
                      - type: string
                        format: uuid
                        pattern: >-
                          ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                      - type: 'null'
                    description: The invoice this one replaced, if any.
                  invoiceDate:
                    anyOf:
                      - type: string
                        format: date-time
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                        description: ISO 8601, UTC.
                      - type: 'null'
                    description: Fecha de expedición; null while the invoice is a draft.
                  issuedAt:
                    anyOf:
                      - type: string
                        format: date-time
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                        description: ISO 8601, UTC.
                      - type: 'null'
                  dueAt:
                    anyOf:
                      - type: string
                        format: date-time
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                        description: ISO 8601, UTC.
                      - type: 'null'
                  paidAt:
                    anyOf:
                      - type: string
                        format: date-time
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                        description: ISO 8601, UTC.
                      - type: 'null'
                  voidedAt:
                    anyOf:
                      - type: string
                        format: date-time
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                        description: ISO 8601, UTC.
                      - type: 'null'
                  createdAt:
                    type: string
                    format: date-time
                    pattern: >-
                      ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                    description: ISO 8601, UTC.
                  updatedAt:
                    type: string
                    format: date-time
                    pattern: >-
                      ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                    description: ISO 8601, UTC.
                  lines:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          pattern: >-
                            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                        concept:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: What the line charges, as printed.
                        description:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Extra detail printed under the concept.
                        quantity:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                        unitPrice:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                          description: Unit price before tax, in cents.
                        discount:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                          description: >-
                            Discount off quantity × unit price, before tax, in
                            cents.
                        taxRate:
                          type: number
                          description: VAT rate, in percent.
                        tax:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                          description: Tax of the line, in cents.
                        total:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                          description: Line total with tax, in cents.
                        chargeId:
                          anyOf:
                            - type: string
                              format: uuid
                              pattern: >-
                                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                            - type: 'null'
                          description: >-
                            The charge (charges.list) this line documents, if
                            any.
                        correctsLineId:
                          anyOf:
                            - type: string
                              format: uuid
                              pattern: >-
                                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                            - type: 'null'
                          description: For a rectificativa line, the line it corrects.
                      required:
                        - id
                        - concept
                        - description
                        - quantity
                        - unitPrice
                        - discount
                        - taxRate
                        - tax
                        - total
                        - chargeId
                        - correctsLineId
                      additionalProperties: false
                required:
                  - id
                  - number
                  - series
                  - documentType
                  - status
                  - patientId
                  - billToId
                  - subtotal
                  - tax
                  - total
                  - currency
                  - correctsInvoiceId
                  - replacesInvoiceId
                  - invoiceDate
                  - issuedAt
                  - dueAt
                  - paidAt
                  - voidedAt
                  - createdAt
                  - updatedAt
                  - lines
                additionalProperties: false
        '401':
          description: Problem Details (RFC 9457) with a stable `code`
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '402':
          description: Problem Details (RFC 9457) with a stable `code`
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: Problem Details (RFC 9457) with a stable `code`
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '422':
          description: Problem Details (RFC 9457) with a stable `code`
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: Problem Details (RFC 9457) with a stable `code`
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '503':
          description: Problem Details (RFC 9457) with a stable `code`
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      security:
        - bearer: []
components:
  schemas:
    Problem:
      type: object
      required:
        - type
        - title
        - status
        - code
        - detail
        - request_id
        - params
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        code:
          type: string
        detail:
          type: string
        request_id:
          type: string
        hint:
          type: string
        retryAfterSeconds:
          type: integer
        params:
          type: object
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: Brelio API key (organization or user) or a WorkOS access token.

````

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