Merge Subpackage Accounting Periods API

openapi: 3.2.0
info:
  title: Subpackage Accounting Periods API
  version: 1.0.0
servers:
- url: https://api.merge.dev/api
- url: https://api-eu.merge.dev/api
- url: https://api-ap.merge.dev/api
tags:
- name: subpackage_accountingPeriods
paths:
  /accounting/v1/accounting-periods:
    get:
      operationId: list
      summary: List
      description: Returns a list of `AccountingPeriod` objects.{/* BEGIN_ACCOUNTING_PERIOD_FETCH_SUPPORTED_FIELDS */}{/* END_ACCOUNTING_PERIOD_FETCH_SUPPORTED_FIELDS */}
      tags:
      - subpackage_accountingPeriods
      parameters:
      - name: cursor
        in: query
        description: The pagination cursor value.
        required: false
        schema:
          type: string
      - name: include_deleted_data
        in: query
        description: Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
        required: false
        schema:
          type: boolean
      - name: include_remote_data
        in: query
        description: Whether to include the original data Merge fetched from the third-party to produce these models.
        required: false
        schema:
          type: boolean
      - name: include_shell_data
        in: query
        description: Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
        required: false
        schema:
          type: boolean
      - name: page_size
        in: query
        description: Number of results to return per page. The maximum limit is 100.
        required: false
        schema:
          type: integer
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedAccountingPeriodList'
  /accounting/v1/accounting-periods/{id}:
    get:
      operationId: retrieve
      summary: Retrieve
      description: Returns an `AccountingPeriod` object with the given `id`.{/* BEGIN_ACCOUNTING_PERIOD_FETCH_SUPPORTED_FIELDS */}{/* END_ACCOUNTING_PERIOD_FETCH_SUPPORTED_FIELDS */}
      tags:
      - subpackage_accountingPeriods
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: include_remote_data
        in: query
        description: Whether to include the original data Merge fetched from the third-party to produce these models.
        required: false
        schema:
          type: boolean
      - name: include_shell_data
        in: query
        description: Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
        required: false
        schema:
          type: boolean
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountingPeriod'
components:
  schemas:
    Status895Enum:
      type: string
      enum:
      - ACTIVE
      - INACTIVE
      title: Status895Enum
    RemoteData:
      type: object
      properties:
        path:
          type: string
          description: The third-party API path that is being called.
        data:
          description: The data returned from the third-party for this object in its original, unnormalized format.
      required:
      - path
      description: '# The RemoteData Object

        ### Description

        The `RemoteData` object is used to represent the full data pulled from the third-party API for an object.


        ### Usage Example

        TODO'
      title: RemoteData
    AccountingPeriod:
      type: object
      properties:
        id:
          type: string
          format: uuid
        remote_id:
          type:
          - string
          - 'null'
          description: The third-party API ID of the matching object.
        created_at:
          type: string
          format: date-time
          description: The datetime that this object was created by Merge.
        modified_at:
          type: string
          format: date-time
          description: The datetime that this object was modified by Merge.
        name:
          type:
          - string
          - 'null'
          description: Name of the accounting period.
        status:
          oneOf:
          - $ref: '#/components/schemas/Status895Enum'
          - type: 'null'
        start_date:
          type:
          - string
          - 'null'
          format: date-time
          description: Beginning date of the period
        end_date:
          type:
          - string
          - 'null'
          format: date-time
          description: End date of the period
        field_mappings:
          oneOf:
          - $ref: '#/components/schemas/AccountingPeriodFieldMappings'
          - type: 'null'
        remote_data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RemoteData'
      description: '# The AccountingPeriod Object

        ### Description

        The `AccountingPeriod` object is used to define a period of time in which events occurred.


        ### Usage Example

        Common models like `Invoice` and `Transaction` will have `AccountingPeriod` objects which will denote when they occurred.'
      title: AccountingPeriod
    PaginatedAccountingPeriodList:
      type: object
      properties:
        next:
          type:
          - string
          - 'null'
        previous:
          type:
          - string
          - 'null'
        results:
          type: array
          items:
            $ref: '#/components/schemas/AccountingPeriod'
      title: PaginatedAccountingPeriodList
    AccountingPeriodFieldMappings:
      type: object
      properties:
        organization_defined_targets:
          type: object
          additionalProperties:
            description: Any type
        linked_account_defined_targets:
          type: object
          additionalProperties:
            description: Any type
      title: AccountingPeriodFieldMappings
  securitySchemes:
    tokenAuth:
      type: http
      scheme: bearer
      description: Token-based authentication with required prefix "Bearer"