Tinvio Organization Report Templates API

openapi: 3.2.0
info:
  title: Tinvio Com Organization Report Templates API
  version: '1.0'
  contact:
    email: build.with@jaz.ai
    name: API Support
    url: https://jaz.ai
  description: 'Operations tagged Organization Report Templates across 2 of this provider''s published API definitions: tinvio-com-openapi-original.yaml, tinvio-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.getjaz.com
tags:
- description: Create, update, search, and delete the organization's report templates, and set the default template for each report type.
  name: Organization Report Templates
paths:
  /api/v1/organization-report-template:
    get:
      description: List the organization's report templates.
      operationId: list-organization-report-template
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: List Organization Report Templates
      tags:
      - Organization Report Templates
    post:
      description: Create a report template. When templateConfiguration is omitted, the template starts from the system default layout for the report type, the same layout Get Default Report Template Configuration returns. A report pack needs both templateConfiguration and packTemplates. The first template of a report type becomes its default; any later template is not made the default, so use Set Default Organization Report Template for that. For PROFIT_AND_LOSS and CASHFLOW, default layouts exist for the IAS_1 and IFRS_18 frameworks only; with GAAP, IND_AS, or IFRS_SME, pass templateConfiguration.
      operationId: create-organization-report-template
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/ReportTemplateResourceResponse'
                  type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Create Organization Report Template
      tags:
      - Organization Report Templates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOrganizationReportTemplateRequest'
        description: The report template to create.
        required: true
    servers:
    - url: https://api.getjaz.com
  /api/v1/organization-report-template/default-configuration:
    get:
      description: 'Get the system default layout for a report type: the layout a new template starts from when Create Organization Report Template is called without templateConfiguration. Edit it and pass it to Create Organization Report Template to start from a customized layout. Report packs have no default layout.'
      operationId: list-organization-report-template-default-configuration
      parameters:
      - description: Report type to get the default layout for.
        in: query
        name: reportType
        required: true
        schema:
          type: string
          enum:
          - PROFIT_AND_LOSS
          - BALANCE_SHEET
          - CASHFLOW
          - EQUITY_MOVEMENT
          - TRIAL_BALANCE
          - GENERAL_LEDGER
          - VAT_LEDGER
          - CASH_BALANCE
          - AGED_RECEIVABLES_DETAILS
          - AGED_RECEIVABLES_SUMMARY
          - AGED_PAYABLES_DETAILS
          - AGED_PAYABLES_SUMMARY
      - description: Reporting framework whose default layout to return (default IAS_1). PROFIT_AND_LOSS and CASHFLOW only. Default layouts exist for IAS_1 and IFRS_18.
        in: query
        name: framework
        schema:
          type: string
          enum:
          - IAS_1
          - IFRS_18
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/DefaultReportTemplateConfigurationResponse'
                  type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Get Default Report Template Configuration
      tags:
      - Organization Report Templates
    servers:
    - url: https://api.getjaz.com
  /api/v1/organization-report-template/search:
    post:
      description: Search report templates with filters and sort. templateName supports every text operator; resourceId and reportCategory support an exact match (eq) only.
      operationId: search-organization-report-template
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Search Organization Report Templates
      tags:
      - Organization Report Templates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchOrganizationReportTemplateRequest'
        description: Search filters, sort, and pagination.
        required: true
    servers:
    - url: https://api.getjaz.com
  /api/v1/organization-report-template/{resourceId}:
    delete:
      description: Delete a report template and remove it from every report pack that includes it. The default template of a report type cannot be deleted, nor can the only template of a report type, nor a template that is the last one left in a report pack. Report packs can always be deleted.
      operationId: delete-organization-report-template
      parameters:
      - description: Resource ID of the report template.
        in: path
        name: resourceId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/ReportTemplateResourceResponse'
                  type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Delete Organization Report Template
      tags:
      - Organization Report Templates
    get:
      description: Get a single report template by its resource ID.
      operationId: get-organization-report-template
      parameters:
      - description: Resource ID of the report template.
        in: path
        name: resourceId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Get Organization Report Template
      tags:
      - Organization Report Templates
    put:
      description: Update a report template's name, layout, or included templates. Fields left out keep their current values; templateConfiguration and packTemplates each replace the stored value in full. The report type and framework cannot be changed, and a request that sends them, or any other field not listed here, is rejected. Send the hash from the last read to have the update refused, rather than overwrite a change made since.
      operationId: update-organization-report-template
      parameters:
      - description: Resource ID of the report template.
        in: path
        name: resourceId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/ReportTemplateResourceResponse'
                  type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Update Organization Report Template
      tags:
      - Organization Report Templates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOrganizationReportTemplateRequest'
        description: The report template fields to update.
        required: true
    servers:
    - url: https://api.getjaz.com
  /api/v1/organization-report-template/{resourceId}/set-default:
    post:
      description: Make a report template the default for its report type. The template that was the default before stops being the default.
      operationId: create-organization-report-template-set-default
      parameters:
      - description: Resource ID of the report template.
        in: path
        name: resourceId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/ReportTemplateResourceResponse'
                  type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Set Default Organization Report Template
      tags:
      - Organization Report Templates
    servers:
    - url: https://api.getjaz.com
components:
  schemas:
    ErrorResponse:
      properties:
        error:
          allOf:
          - $ref: '#/components/schemas/ErrorResponseData'
          description: Error details.
      type: object
    OrganizationReportTemplateSortFilter:
      properties:
        order:
          description: Sort direction, ASC or DESC.
          enum:
          - ASC
          - asc
          - DESC
          - desc
          type: string
        sortBy:
          description: Fields to sort by, in priority order.
          items:
            type: string
          maxItems: 13
          type: array
          uniqueItems: true
      required:
      - sortBy
      type: object
    OrganizationReportTemplateFilter:
      properties:
        isDefault:
          allOf:
          - $ref: '#/components/schemas/BooleanExpression'
          description: Match only default templates (true) or only non-default templates (false).
        reportCategory:
          allOf:
          - $ref: '#/components/schemas/ReportTemplateStringExpression'
          description: Match templates in this report category.
        reportType:
          description: Match templates that lay out this report.
          enum:
          - PROFIT_AND_LOSS
          - BALANCE_SHEET
          - CASHFLOW
          - EQUITY_MOVEMENT
          - TRIAL_BALANCE
          - GENERAL_LEDGER
          - VAT_LEDGER
          - CASH_BALANCE
          - AGED_RECEIVABLES_DETAILS
          - AGED_RECEIVABLES_SUMMARY
          - AGED_PAYABLES_DETAILS
          - AGED_PAYABLES_SUMMARY
          - REPORT_PACK
          example: PROFIT_AND_LOSS
          type: string
        reportTypes:
          description: Match templates that lay out any of these reports.
          items:
            type: string
          maxItems: 13
          type: array
        resourceId:
          allOf:
          - $ref: '#/components/schemas/ReportTemplateStringExpression'
          description: Match the template with this resource ID.
        templateName:
          allOf:
          - $ref: '#/components/schemas/StringExpression'
          description: Match templates by display name. Every text operator is supported.
      type: object
    BaseResponse:
      properties:
        data:
          description: The response object.
      type: object
    PackTemplateRequest:
      properties:
        templateOrder:
          description: Position of the template in the pack, starting at 1. Must be unique within the pack.
          example: 1
          minimum: 1
          type: integer
        templateResourceId:
          description: Resource ID of the report template to include in the pack.
          example: 41f626a3-9635-410c-bb5b-f34443e6903e
          type: string
      required:
      - templateOrder
      - templateResourceId
      type: object
    SearchOrganizationReportTemplateRequest:
      properties:
        filter:
          allOf:
          - $ref: '#/components/schemas/OrganizationReportTemplateFilter'
          description: Filter criteria.
        sort:
          allOf:
          - $ref: '#/components/schemas/OrganizationReportTemplateSortFilter'
          description: Sort order. Required when offset is set.
      type: object
    BooleanExpression:
      properties:
        eq:
          description: Match values equal to this.
          type: boolean
      type: object
    StringExpression:
      properties:
        contains:
          description: Match values containing this substring.
          type: string
        endWith:
          description: Match values ending with this term (case sensitive).
          type: string
        eq:
          description: Match values equal to this.
          type: string
        in:
          description: Match values equal to any of these.
          items:
            type: string
          maxItems: 100
          type: array
        isBlank:
          description: Match records where the field is null or empty ("true") or neither ("false").
          type: string
        isNotBlank:
          description: Match records where the field is neither null nor empty ("true").
          type: string
        isNull:
          description: Match records where the field is null ("true") or not null ("false").
          type: string
        likeIn:
          description: Match values containing any of these substrings.
          items:
            type: string
          maxItems: 100
          type: array
        neq:
          description: Match values not equal to this.
          type: string
        notContains:
          description: Match values not containing this substring.
          type: string
        notEndWith:
          description: Match values not ending with this term (case sensitive).
          type: string
        notStartWith:
          description: Match values not starting with this term (case sensitive).
          type: string
        reg:
          description: Match values containing any of these terms. This is a substring match, not a regular expression, despite the name.
          items:
            type: string
          maxItems: 100
          type: array
        startWith:
          description: Match values starting with this term (case sensitive).
          type: string
      required:
      - in
      - likeIn
      - reg
      type: object
    ReportTemplateStringExpression:
      properties:
        eq:
          description: Match values equal to this.
          type: string
      required:
      - eq
      type: object
    UpdateOrganizationReportTemplateRequest:
      properties:
        hash:
          description: The hash of the template as last read from Get, List, or Search. When sent, the update is refused with 422 INVALID_CHECK_SUM if the template has changed since, so a concurrent edit is not overwritten. Read the template again and reapply the change.
          example: 9e107d9d372bb6826bd81d3542a419d6
          maxLength: 64
          type: string
        packTemplates:
          description: Templates included in the pack, in order. Replaces the pack's current list. Report packs only. When the included templates change, update the includedComponents of templateConfiguration in the same request so the two stay in step.
          items:
            $ref: '#/components/schemas/PackTemplateRequest'
          maxItems: 100
          minItems: 1
          type: array
        templateConfiguration:
          description: Template layout, as a JSON-encoded string. Replaces the stored layout in full.
          type: string
        templateName:
          description: Display name of the template. Must be unique among the organization's templates of the same report type.
          example: Monthly Profit and Loss
          maxLength: 255
          type: string
      type: object
    DefaultReportTemplateConfigurationResponse:
      properties:
        templateConfiguration:
          description: System default layout, as a JSON-encoded string. Pass it, edited or not, as templateConfiguration to Create Organization Report Template.
          type: string
      type: object
    ReportTemplateResourceResponse:
      properties:
        resourceId:
          description: Resource ID of the report template.
          example: 41f626a3-9635-410c-bb5b-f34443e6903e
          type: string
      type: object
    ErrorResponseData:
      properties:
        error_type:
          description: Error category, for example validation_error, invalid_request_body, or internal_server_error.
          example: validation_error
          type: string
        errors:
          description: Error messages describing what went wrong.
          items:
            type: string
          type: array
      type: object
    CreateOrganizationReportTemplateRequest:
      properties:
        framework:
          description: Reporting framework, for PROFIT_AND_LOSS, BALANCE_SHEET, CASHFLOW, and EQUITY_MOVEMENT only. Defaults to IAS_1 for those report types. For PROFIT_AND_LOSS and CASHFLOW, also selects which system default layout is used when templateConfiguration is omitted; default layouts exist for IAS_1 and IFRS_18 only, so GAAP, IND_AS, and IFRS_SME need templateConfiguration.
          enum:
          - IAS_1
          - IFRS_18
          - GAAP
          - IND_AS
          - IFRS_SME
          example: IAS_1
          type: string
        packTemplates:
          description: 'Templates included in the pack, in order. Required for REPORT_PACK, and rejected for every other report type. List the same templates as the TEMPLATE entries in the includedComponents of templateConfiguration: the pack renders from includedComponents, and delete checks read it too.'
          items:
            $ref: '#/components/schemas/PackTemplateRequest'
          maxItems: 100
          minItems: 1
          type: array
        reportType:
          description: Report the template lays out. REPORT_PACK bundles other templates into one document.
          enum:
          - PROFIT_AND_LOSS
          - BALANCE_SHEET
          - CASHFLOW
          - EQUITY_MOVEMENT
          - TRIAL_BALANCE
          - GENERAL_LEDGER
          - VAT_LEDGER
          - CASH_BALANCE
          - AGED_RECEIVABLES_DETAILS
          - AGED_RECEIVABLES_SUMMARY
          - AGED_PAYABLES_DETAILS
          - AGED_PAYABLES_SUMMARY
          - REPORT_PACK
          example: PROFIT_AND_LOSS
          type: string
        templateConfiguration:
          description: Template layout, as a JSON-encoded string. When omitted, the template starts from the system default layout for the report type (see Get Default Report Template Configuration). Required for REPORT_PACK.
          type: string
        templateName:
          description: Display name of the template. Must be unique among the organization's templates of the same report type.
          example: Monthly Profit and Loss
          maxLength: 255
          type: string
      required:
      - reportType
      - templateName
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: Organization API key. Pass it in the x-jk-api-key header on every request.
      in: header
      name: x-jk-api-key
      type: apiKey
x-refined-from:
- tinvio-com-openapi-original.yaml
- tinvio-com-openapi.yml