Buk Accounting Structures API

openapi: 3.2.0
info:
  description: '# Buk Data Access API.


    To use the API, you need to obtain an **API Key**.

    You can manage access within the platform, in **Settings => API Access.**


    Once an API Key is created, you must send the value as a header in the HTTP request, in the `auth_token` field.


    ## For more details, you can review the article "How to integrate with Buk through an API"


    # Endpoints'
  title: Buk Accounting Structures API
servers:
- url: https://demo.buk.cl/api/v1/brasil
tags:
- name: Accounting Structures
paths:
  /accounting_structure/structures:
    get:
      summary: Get accounting structures for a company
      description: Returns the accounting structures assigned to a company
      tags:
      - Accounting Structures
      parameters:
      - name: empresa_id
        description: Company ID
        in: query
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Accounting structures successfully found
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: array
                    items:
                      properties:
                        id:
                          type: integer
                          description: Accounting structure code
                        codigo:
                          type: string
                          description: Unique code of the structure
                        nombre:
                          type: string
                          description: Scale name
                        separador:
                          type: string
                          description: Separator type (semicolon, comma, etc.)
                        extension_archivo:
                          type: string
                          description: File extension (xlsx, csv, txt, etc.)
                        created_at:
                          type: string
                          format: datetime
                        updated_at:
                          type: string
                          format: datetime
            application/pdf:
              schema:
                properties:
                  data:
                    type: array
                    items:
                      properties:
                        id:
                          type: integer
                          description: Accounting structure code
                        codigo:
                          type: string
                          description: Unique code of the structure
                        nombre:
                          type: string
                          description: Scale name
                        separador:
                          type: string
                          description: Separator type (semicolon, comma, etc.)
                        extension_archivo:
                          type: string
                          description: File extension (xlsx, csv, txt, etc.)
                        created_at:
                          type: string
                          format: datetime
                        updated_at:
                          type: string
                          format: datetime
        '400':
          description: Missing or invalid parameters
          content:
            application/json:
              schema:
                properties:
                  errors:
                    type: array
                    items:
                      type: string
            application/pdf:
              schema:
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '404':
          description: Company not found
          content:
            application/json:
              schema:
                properties:
                  errors:
                    type: array
                    items:
                      type: string
            application/pdf:
              schema:
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '401':
          description: Unauthorized - No read permissions
      operationId: getAccountingStructureStructures
      x-operation-id-source: derived
  /accounting_structure/assignments:
    get:
      summary: Get accounting structure assignments
      description: Returns assignments filtered by company_id or accounting_structure_id
      tags:
      - Accounting Structures
      parameters:
      - name: empresa_id
        description: Company ID (required if accounting_structure_id is not provided)
        in: query
        required: false
        schema:
          type: integer
      - name: accounting_structure_id
        description: Accounting structure ID (required if company_id is not provided)
        in: query
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: Allocations approved successfully
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: array
                    items:
                      properties:
                        id:
                          type: integer
                        accounting_structure_id:
                          type: integer
                        empresa_id:
                          type: integer
                        accounting_structure:
                          properties:
                            id:
                              type: integer
                            codigo:
                              type: string
                            nombre:
                              type: string
                            separador:
                              type: string
                            extension_archivo:
                              type: string
                        empresa:
                          properties:
                            id:
                              type: integer
                            nombre:
                              type: string
                            rut:
                              type: string
                        created_at:
                          type: string
                          format: datetime
                        updated_at:
                          type: string
                          format: datetime
            application/pdf:
              schema:
                properties:
                  data:
                    type: array
                    items:
                      properties:
                        id:
                          type: integer
                        accounting_structure_id:
                          type: integer
                        empresa_id:
                          type: integer
                        accounting_structure:
                          properties:
                            id:
                              type: integer
                            codigo:
                              type: string
                            nombre:
                              type: string
                            separador:
                              type: string
                            extension_archivo:
                              type: string
                        empresa:
                          properties:
                            id:
                              type: integer
                            nombre:
                              type: string
                            rut:
                              type: string
                        created_at:
                          type: string
                          format: datetime
                        updated_at:
                          type: string
                          format: datetime
        '400':
          description: Missing or invalid parameters
          content:
            application/json:
              schema:
                properties:
                  errors:
                    type: array
                    items:
                      type: string
            application/pdf:
              schema:
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '404':
          description: Company or structure not found
          content:
            application/json:
              schema:
                properties:
                  errors:
                    type: array
                    items:
                      type: string
            application/pdf:
              schema:
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '401':
          description: Unauthorized - No read permissions
      operationId: getAccountingStructureAssignments
      x-operation-id-source: derived
  /accounting_structure/export:
    get:
      summary: Export accounting data
      description: Exports the accounting data of an assignment. Supports optional pagination.
      tags:
      - Accounting Structures
      parameters:
      - name: accounting_structure_assignment_id
        description: Accounting structure assignment ID
        in: query
        required: true
        schema:
          type: integer
      - name: month
        description: Month (1-12)
        in: query
        required: true
        schema:
          type: integer
      - name: year
        description: Year
        in: query
        required: true
        schema:
          type: integer
      - name: page
        description: Page number
        in: query
        required: false
        schema:
          type: integer
      - name: page_size
        description: Size of the page
        in: query
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: Accounting data successfully exported
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: object
                    description: Hash where the key is the unique identifier of the company and the value is an array of objects with the accounting data
                    example:
                      12.345.678-9:
                      - Column0: '92101'
                        Column1: Base salary
                        Column2: '500000'
                        Column3: '101'
                  pagination:
                    description: Added Item Information
                    properties:
                      current_page:
                        type: integer
                      total_pages:
                        type: integer
                      total_count:
                        type: integer
            application/pdf:
              schema:
                properties:
                  data:
                    type: object
                    description: Hash where the key is the unique identifier of the company and the value is an array of objects with the accounting data
                    example:
                      12.345.678-9:
                      - Column0: '92101'
                        Column1: Base salary
                        Column2: '500000'
                        Column3: '101'
                  pagination:
                    description: Added Item Information
                    properties:
                      current_page:
                        type: integer
                      total_pages:
                        type: integer
                      total_count:
                        type: integer
        '400':
          description: Missing or invalid parameters
          content:
            application/json:
              schema:
                properties:
                  errors:
                    type: array
                    items:
                      type: string
            application/pdf:
              schema:
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '404':
          description: Assignment not found or variable not found for the specified period
          content:
            application/json:
              schema:
                properties:
                  errors:
                    type: array
                    items:
                      type: string
            application/pdf:
              schema:
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '401':
          description: Unauthorized - No read permissions
      operationId: getAccountingStructureExport
      x-operation-id-source: derived
  /accounting_structure/export_process_differences:
    get:
      summary: Accounting of the reprocessing with accounting structure
      description: Obtains in JSON format the accounting data for the differences generated in a subprocess as a result of a reprocess, using the assigned accounting structure
      tags:
      - Accounting Structures
      parameters:
      - name: accounting_structure_assignment_id
        description: Accounting structure assignment ID. REQUIRED
        in: query
        required: true
        schema:
          type: integer
      - name: process_id
        description: Subprocess ID. REQUIRED
        in: query
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Returns the accounting information corresponding to the payroll reprocessing, formatted according to the assigned accounting structure
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: object
                    description: Hash where the key is the company RUT and the value is an array with the accounting difference data
                    example:
                      12.345.678-9:
                      - Column0: '92101'
                        Column1: Base salary
                        Column2: '500000'
                        Column3: '101'
            application/pdf:
              schema:
                properties:
                  data:
                    type: object
                    description: Hash where the key is the company RUT and the value is an array with the accounting difference data
                    example:
                      12.345.678-9:
                      - Column0: '92101'
                        Column1: Base salary
                        Column2: '500000'
                        Column3: '101'
        '400':
          description: The sent request does not comply with the required format
          content:
            application/json:
              schema:
                properties:
                  errors:
                    type: array
                    items:
                      type: string
            application/pdf:
              schema:
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '404':
          description: There is no information for the entered parameters
          content:
            application/json:
              schema:
                properties:
                  errors:
                    type: array
                    items:
                      type: string
            application/pdf:
              schema:
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '401':
          description: Unauthorized - No read permissions
      operationId: getAccountingStructureExportProcessDifferences
      x-operation-id-source: derived
components:
  securitySchemes:
    auth_token:
      type: apiKey
      name: auth_token
      in: header