openapi: 3.2.0
info:
  title: Atlar API (v2) GL Entities API
  description: Atlar API (v2)
  version: '0.1'
  contact:
    email: support@atlar.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.txt
servers:
- url: https://api.atlar.com
tags:
- name: GL Entities
  description: 'A GL entity represents a legal entity in your ERP system.

    It can have a one-to-one relationship with an Atlar Entity.'
  x-displayName: GL Entities
paths:
  /accounting/v2beta/gl-entities:
    post:
      summary: Create entity
      description: Create a new GL entity.
      tags:
      - GL Entities
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGLEntityRequest'
      responses:
        '201':
          description: The created GL entity.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GLEntity'
        '400':
          $ref: '#/components/responses/BadRequest'
      security:
      - basicAuth:
        - connections:read
        - gl_entities:create
      operationId: postAccountingV2betaGlEntities
      x-operation-id-source: derived
    get:
      summary: List entities
      description: Returns a list of GL entities.
      tags:
      - GL Entities
      parameters:
      - description: Only include entities that are associated with the specified connection.
        in: query
        name: connectionId
        schema:
          $ref: '#/components/schemas/ResourceID'
      - $ref: '#/components/parameters/QueryLimit'
      - $ref: '#/components/parameters/PaginationToken'
      responses:
        '200':
          description: A list of GL entities.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ListResponse'
                - properties:
                    items:
                      items:
                        $ref: '#/components/schemas/GLEntity'
                      type: array
                  type: object
        '400':
          $ref: '#/components/responses/BadRequest'
      security:
      - basicAuth:
        - gl_entities:read
      operationId: getAccountingV2betaGlEntities
      x-operation-id-source: derived
  /accounting/v2beta/gl-entities/{id}:
    get:
      summary: Get entity
      description: Retrieve a specific GL entity.
      tags:
      - GL Entities
      parameters:
      - $ref: '#/components/parameters/ResourceIDOrExternalID'
      responses:
        '200':
          description: An entity.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GLEntity'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - basicAuth:
        - gl_entities:read
      operationId: getAccountingV2betaGlEntitiesById
      x-operation-id-source: derived
    patch:
      summary: Update entity
      description: Update a GL entity.
      tags:
      - GL Entities
      parameters:
      - $ref: '#/components/parameters/ResourceID'
      - $ref: '#/components/parameters/IfMatchETag'
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/GLEntityJSONPatchRequest'
            examples:
              replaceEntityId:
                summary: Assign the Atlar entity resource ID that corresponds to this GL entity.
                value:
                - op: replace
                  path: /entityId
                  value: f2d12456-f579-4d86-8e77-90168b3bcb99
      responses:
        '202':
          description: The updated entity.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GLEntity'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - basicAuth:
        - entities:read
        - gl_entities:read
        - gl_entities:update
      operationId: patchAccountingV2betaGlEntitiesById
      x-operation-id-source: derived
components:
  responses:
    BadRequest:
      description: Bad request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            status: 400
            message: There is some problem with the data you submitted.
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            status: 404
            message: Resource not found.
  schemas:
    GLEntityJSONPatchRemoveEntityId:
      description: Unset the Atlar entity identifier that corresponds to this GL entity.
      type: object
      properties:
        op:
          type: string
          enum:
          - remove
        path:
          type: string
          enum:
          - /entityId
      additionalProperties: false
      required:
      - op
      - path
    GLEntityJSONPatchRequest:
      description: JSON Patch Request
      externalDocs:
        url: https://jsonpatch.com/
      type: array
      items:
        oneOf:
        - $ref: '#/components/schemas/GLEntityJSONPatchReplaceEntityId'
        - $ref: '#/components/schemas/GLEntityJSONPatchRemoveEntityId'
        - $ref: '#/components/schemas/GLEntityJSONPatchReplaceCurrency'
    UpdatedTimestamp:
      type: string
      format: date-time
      description: Time at which the resource was last updated.
      example: '2022-05-04T18:47:32.213842599Z'
      readOnly: true
    ETag:
      type: string
      description: '[ETag](https://en.wikipedia.org/wiki/HTTP_ETag) based on the

        resource version. This can be passed along in `If-Match` HTTP

        header when updating a resource to perform a conditional

        update.'
      pattern: ^version:\d{1,4}$
      example: version:3
      readOnly: true
      externalDocs:
        url: https://en.wikipedia.org/wiki/HTTP_ETag
    ListResponse:
      type: object
      properties:
        items:
          description: A list of resources.
        nextToken:
          description: 'Pagination token for next page.

            The value will be a non-empty string if there are more resources to be fetched.

            The value will be an empty string if there are no more resources to be fetched.'
          type: string
          example: eyIxIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9
        token:
          description: 'The pagination token that was used for this request.

            The value will be an empty string if no `token` query parameter was provided with the request.'
          type: string
          example: eyIwIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9
        limit:
          description: The page limit that was used for this request.
          example: 100
          type: integer
      required:
      - items
      - nextToken
      - token
      - limit
    GLEntity:
      type: object
      description: 'A GL entity represents a legal entity in your ERP system.

        It can have a one-to-one relationship with an Atlar Entity.

        '
      properties:
        currency:
          $ref: '#/components/schemas/CurrencyCode'
          description: Base currency of the GL entity when known (e.g. subsidiary currency from the ERP).
        id:
          $ref: '#/components/schemas/ResourceID'
        externalId:
          $ref: '#/components/schemas/ExternalID'
        organizationId:
          $ref: '#/components/schemas/OrganizationID'
        entityId:
          $ref: '#/components/schemas/ResourceID'
          description: The Atlar entity resource id that correlates to this GL entity.
        thirdPartyId:
          description: ID of the associated third-party, e.g. the ERP in which the entity is held.
          example: 9a8b1372-5c80-44a5-81a9-553a34041eb7
          type: string
          readOnly: true
        associatedConnections:
          type: array
          items:
            $ref: '#/components/schemas/AssociatedConnection'
          x-omitempty: true
        name:
          type: string
          description: The name of the GL entity.
          example: Acme Corporation
          minLength: 1
          maxLength: 64
        version:
          $ref: '#/components/schemas/ResourceVersion'
        etag:
          $ref: '#/components/schemas/ETag'
        created:
          $ref: '#/components/schemas/CreatedTimestamp'
        updated:
          $ref: '#/components/schemas/UpdatedTimestamp'
      required:
      - id
      - externalId
      - organizationId
      - name
      - version
      - etag
      - created
      - updated
    ResourceID:
      type: string
      description: Unique resource identifier.
      minLength: 32
      maxLength: 64
      examples:
      - 2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8
    GLEntityJSONPatchReplaceCurrency:
      description: Set the base currency of the GL entity when known from the ERP.
      type: object
      properties:
        op:
          type: string
          enum:
          - replace
        path:
          type: string
          enum:
          - /currency
        value:
          $ref: '#/components/schemas/CurrencyCode'
      additionalProperties: false
      required:
      - op
      - path
      - value
    ErrorDetails:
      type: object
      description: Error detail.
      properties:
        code:
          description: An error code for this error. Not always present.
          example: invalid_value
          type: string
        error:
          description: A description of this specific error.
          example: Must be one of [direct_debits mandates payments]
          type: string
        field:
          description: The field which has an error. This only set if the error has to do with a specific field, such as for validation errors. Nested fields are concatenated with `.`, as well as indexed fields in lists.
          example: filter.0.resource
          type: string
    AssociatedConnection:
      type: object
      properties:
        connectionId:
          type: string
      required:
      - connectionId
    CreatedTimestamp:
      type: string
      format: date-time
      description: Time at which the resource was created.
      example: '2022-05-04T18:31:12.889104898Z'
      readOnly: true
    ResourceVersion:
      type: integer
      description: 'Resource version. Starts at value `1` when the resource is

        created and increases by one for each successive update.'
      example: 1
      minimum: 1
      readOnly: true
    CurrencyCode:
      type: string
      description: Three-letter ISO 4217 currency code.
      example: EUR
      minLength: 3
      maxLength: 3
      pattern: ^[A-Z]{3,3}$
    ErrorResponse:
      type: object
      description: Error response.
      properties:
        status:
          description: The HTTP status code.
          example: 400
          type: integer
          readOnly: true
        message:
          description: A top-level message describing the error(s).
          example: There is some problem with the data you submitted.
          type: string
          readOnly: true
        details:
          description: A list of details for each error that occurred.
          items:
            $ref: '#/components/schemas/ErrorDetails'
          type: array
          readOnly: true
          x-omitempty: true
    OrganizationID:
      type: string
      description: Unique resource identifier for an Organization.
      examples:
      - 0160f6ab-5741-49e1-af46-9138927e547e
    GLEntityJSONPatchReplaceEntityId:
      description: Set the Atlar entity identifier that corresponds to this GL entity.
      type: object
      properties:
        op:
          type: string
          enum:
          - replace
        path:
          type: string
          enum:
          - /entityId
        value:
          $ref: '#/components/schemas/ResourceID'
      additionalProperties: false
      required:
      - op
      - path
      - value
    ExternalID:
      type: string
      pattern: ^[a-zA-Z0-9._\-+=]{1,64}$
      description: External ID is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique across all resources. It is possible to retrieve a resource using the external ID using the prefix `external:`.
      example: walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl
      x-omitempty: true
    CreateGLEntityRequest:
      type: object
      properties:
        currency:
          $ref: '#/components/schemas/CurrencyCode'
          description: Base currency of the GL entity when known (e.g. subsidiary currency from the ERP).
        externalId:
          $ref: '#/components/schemas/ExternalID'
        name:
          type: string
          description: The name of the GL entity.
          example: Acme Inc.
          minLength: 1
          maxLength: 64
        thirdPartyId:
          description: ID of the associated third-party, e.g. the ERP in which the account is held.
          example: 9a8b1372-5c80-44a5-81a9-553a34041eb7
          type: string
        associatedConnections:
          type: array
          items:
            $ref: '#/components/schemas/AssociatedConnection'
          x-omitempty: true
      required:
      - externalId
      - name
  parameters:
    PaginationToken:
      in: query
      name: token
      description: If a query response contains a non-empty `nextToken`, use that value as `token` query parameter to continue pagination.
      schema:
        type: string
    ResourceIDOrExternalID:
      in: path
      name: id
      description: Atlar resource ID or External ID. Prefix External IDs with `external:`.
      schema:
        type: string
        pattern: ^external:[a-zA-Z0-9._\-+=]{1,64}$|^[a-zA-Z0-9\-]{1,256}$
      required: true
    ResourceID:
      in: path
      name: id
      description: Atlar resource ID.
      schema:
        type: string
        pattern: ^[a-zA-Z0-9\-]{1,256}$
      required: true
    IfMatchETag:
      in: header
      name: If-Match
      description: ETag (version) of resource to be updated.
      schema:
        type: string
        pattern: ^version:\d{1,4}$
      examples:
        versionNumberETag:
          value: version:1
    QueryLimit:
      in: query
      name: limit
      description: Limit the number of items in resulting query response.
      schema:
        type: integer
        default: 100
        minimum: 1
        maximum: 500
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
x-tagGroups:
- name: Atlar Accounting API
  tags:
  - Documents
  - GL Entities
  - GL Accounts
- name: Atlar Analytics API
  tags:
  - Forecasted Transactions
- name: Atlar Connectivity API
  tags:
  - Connections
- name: Atlar Payments API
  tags:
  - Credit Transfers
  - Direct Debits
  - External Accounts
  - Counterparties
  - Mandates
  - Events (webhooks)
  - Regulatory Reporting
- name: Atlar Financial Data API
  tags:
  - Accounts
  - Transactions
  - Pending Transactions
  - Entities
  - Investments
- name: Atlar IAM API
  tags:
  - OAuth
  - Audit logs
- name: Atlar Platform API
  tags:
  - Webhooks
x-provenance:
  method: searched
  source: https://docs.atlar.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.atlar.com/reference/delete_accounting-v2beta-documents-id.md
  - https://docs.atlar.com/reference/delete_analytics-v2beta-forecasted-transactions-id.md
  - https://docs.atlar.com/reference/delete_financial-data-v2-entities-id-1.md
  - https://docs.atlar.com/reference/delete_payments-v2-counterparties-id-1.md
  - https://docs.atlar.com/reference/delete_payments-v2-external-accounts-id-1.md
  - https://docs.atlar.com/reference/delete_platform-v2beta-webhooks-id-keys-kid.md
  - https://docs.atlar.com/reference/delete_platform-v2beta-webhooks-id.md
  - https://docs.atlar.com/reference/get_accounting-v2beta-documents-batch.md
  - https://docs.atlar.com/reference/get_accounting-v2beta-documents-id.md
  - https://docs.atlar.com/reference/get_accounting-v2beta-documents.md
  - https://docs.atlar.com/reference/get_accounting-v2beta-gl-accounts-id.md
  - https://docs.atlar.com/reference/get_accounting-v2beta-gl-accounts.md
  - https://docs.atlar.com/reference/get_accounting-v2beta-gl-entities-id.md
  - https://docs.atlar.com/reference/get_accounting-v2beta-gl-entities.md
  - https://docs.atlar.com/reference/get_analytics-v2beta-forecasted-transactions-id-events.md
  - https://docs.atlar.com/reference/get_analytics-v2beta-forecasted-transactions-id.md
  - https://docs.atlar.com/reference/get_analytics-v2beta-forecasted-transactions.md
  - https://docs.atlar.com/reference/get_connectivity-v2beta-connections-1.md
  - https://docs.atlar.com/reference/get_connectivity-v2beta-connections-cid-reports-1.md
  - https://docs.atlar.com/reference/get_connectivity-v2beta-connections-cid-reports-id-bank-statements-1.md
  - https://docs.atlar.com/reference/get_connectivity-v2beta-connections-cid-reports-id-content-1.md
  - https://docs.atlar.com/reference/get_connectivity-v2beta-connections-cid-reports-rid-bank-statements-id-content-1.md
  - https://docs.atlar.com/reference/get_financial-data-v2-accounts-1.md
  - https://docs.atlar.com/reference/get_financial-data-v2-accounts-id-1.md
  - https://docs.atlar.com/reference/get_financial-data-v2-accounts-id-balances-1.md
  - https://docs.atlar.com/reference/get_financial-data-v2-entities-1.md
  - https://docs.atlar.com/reference/get_financial-data-v2-entities-id-1.md
  - https://docs.atlar.com/reference/get_financial-data-v2-pending-transactions-1.md
  - https://docs.atlar.com/reference/get_financial-data-v2-pending-transactions-id-1.md
  - https://docs.atlar.com/reference/get_financial-data-v2-pending-transactions-id-events-1.md
  - https://docs.atlar.com/reference/get_financial-data-v2-transactions-1.md
  - https://docs.atlar.com/reference/get_financial-data-v2-transactions-id-1.md
  - https://docs.atlar.com/reference/get_financial-data-v2-transactions-id-events.md
  - https://docs.atlar.com/reference/get_financial-data-v2beta-accounts-id-end-of-day-summaries.md
  - https://docs.atlar.com/reference/get_financial-data-v2beta-internal-transfers-id.md
  - https://docs.atlar.com/reference/get_financial-data-v2beta-internal-transfers.md
  - https://docs.atlar.com/reference/get_financial-data-v2beta-portfolios-id-holdings.md
  - https://docs.atlar.com/reference/get_financial-data-v2beta-portfolios-id.md
  - https://docs.atlar.com/reference/get_financial-data-v2beta-portfolios-pid-holdings-hid-activities-id.md
  - https://docs.atlar.com/reference/get_financial-data-v2beta-portfolios-pid-holdings-hid-activities.md
  - https://docs.atlar.com/reference/get_financial-data-v2beta-portfolios-pid-holdings-hid-positions-id.md
  - https://docs.atlar.com/reference/get_financial-data-v2beta-portfolios-pid-holdings-hid-positions.md
  - https://docs.atlar.com/reference/get_financial-data-v2beta-portfolios-pid-holdings-id.md
  - https://docs.atlar.com/reference/get_financial-data-v2beta-portfolios.md
  - https://docs.atlar.com/reference/get_iam-v2beta-audit-log-entries.md
  - https://docs.atlar.com/reference/get_payments-v2-counterparties-1.md
  - https://docs.atlar.com/reference/get_payments-v2-counterparties-id-1.md
  - https://docs.atlar.com/reference/get_payments-v2-counterparties-id-events-1.md
  - https://docs.atlar.com/reference/get_payments-v2-credit-transfers-1.md
  - https://docs.atlar.com/reference/get_payments-v2-credit-transfers-id-1.md
  - https://docs.atlar.com/reference/get_payments-v2-credit-transfers-id-events-1.md
  - https://docs.atlar.com/reference/get_payments-v2-direct-debits-1.md
  - https://docs.atlar.com/reference/get_payments-v2-direct-debits-id-1.md
  - https://docs.atlar.com/reference/get_payments-v2-direct-debits-id-events-1.md
  - https://docs.atlar.com/reference/get_payments-v2-external-accounts-1.md
  - https://docs.atlar.com/reference/get_payments-v2-external-accounts-id-1.md
  - https://docs.atlar.com/reference/get_payments-v2-mandates-1.md
  - https://docs.atlar.com/reference/get_payments-v2-mandates-id-1.md
  - https://docs.atlar.com/reference/get_payments-v2-mandates-id-events-1.md
  - https://docs.atlar.com/reference/get_payments-v2-regulatory-reporting-codes.md
  - https://docs.atlar.com/reference/get_payments-v2beta-credit-transfer-batches-1.md
  - https://docs.atlar.com/reference/get_payments-v2beta-credit-transfer-batches-id-1.md
  - https://docs.atlar.com/reference/get_payments-v2beta-credit-transfer-batches-id-results-1.md
  - https://docs.atlar.com/reference/get_payments-v2beta-direct-debit-batches-id-results.md
  - https://docs.atlar.com/reference/get_payments-v2beta-direct-debit-batches-id.md
  - https://docs.atlar.com/reference/get_payments-v2beta-direct-debit-batches.md
  - https://docs.atlar.com/reference/get_platform-v2beta-webhooks-id-keys.md
  - https://docs.atlar.com/reference/get_platform-v2beta-webhooks-id.md
  - https://docs.atlar.com/reference/get_platform-v2beta-webhooks.md
  - https://docs.atlar.com/reference/patch_accounting-v2beta-documents-id.md
  - https://docs.atlar.com/reference/patch_accounting-v2beta-gl-accounts-id.md
  - https://docs.atlar.com/reference/patch_accounting-v2beta-gl-entities-id.md
  - https://docs.atlar.com/reference/patch_analytics-v2beta-forecasted-transactions-id.md
  - https://docs.atlar.com/reference/patch_financial-data-v2-accounts-id-1.md
  - https://docs.atlar.com/reference/patch_financial-data-v2-entities-id-1.md
  - https://docs.atlar.com/reference/patch_financial-data-v2-transactions-id-1.md
  - https://docs.atlar.com/reference/patch_financial-data-v2beta-pending-transactions-id.md
  - https://docs.atlar.com/reference/patch_payments-v2-counterparties-id-1.md
  - https://docs.atlar.com/reference/patch_payments-v2-credit-transfers-id-1.md
  - https://docs.atlar.com/reference/patch_payments-v2-external-accounts-id-1.md
  - https://docs.atlar.com/reference/patch_platform-v2beta-webhooks-id.md
  - https://docs.atlar.com/reference/post_accounting-v2beta-documents.md
  - https://docs.atlar.com/reference/post_accounting-v2beta-gl-accounts.md
  - https://docs.atlar.com/reference/post_accounting-v2beta-gl-entities.md
  - https://docs.atlar.com/reference/post_analytics-v2beta-forecasted-transactions.md
  - https://docs.atlar.com/reference/post_connectivity-v2beta-connections-cid-reports.md
  - https://docs.atlar.com/reference/post_financial-data-v2-entities-1.md
  - https://docs.atlar.com/reference/post_iam-v2-oauth2-token.md
  - https://docs.atlar.com/reference/post_payments-v2-counterparties-1.md
  - https://docs.atlar.com/reference/post_payments-v2-credit-transfers-1.md
  - https://docs.atlar.com/reference/post_payments-v2-credit-transfers-id-approve-1.md
  - https://docs.atlar.com/reference/post_payments-v2-credit-transfers-id-reject-1.md
  - https://docs.atlar.com/reference/post_payments-v2-direct-debits-1.md
  - https://docs.atlar.com/reference/post_payments-v2-direct-debits-id-approve-1.md
  - https://docs.atlar.com/reference/post_payments-v2-direct-debits-id-reject-1.md
  - https://docs.atlar.com/reference/post_payments-v2-external-accounts-1.md
  - https://docs.atlar.com/reference/post_payments-v2-mandates-1.md
  - https://docs.atlar.com/reference/post_payments-v2-mandates-id-cancel-1.md
  - https://docs.atlar.com/reference/post_payments-v2beta-credit-transfer-batches-1.md
  - https://docs.atlar.com/reference/post_payments-v2beta-credit-transfer-batches-id-approve.md
  - https://docs.atlar.com/reference/post_payments-v2beta-credit-transfer-batches-id-reject.md
  - https://docs.atlar.com/reference/post_payments-v2beta-direct-debit-batches-id-approve.md
  - https://docs.atlar.com/reference/post_payments-v2beta-direct-debit-batches-id-reject.md
  - https://docs.atlar.com/reference/post_payments-v2beta-direct-debit-batches.md
  - https://docs.atlar.com/reference/post_platform-v2beta-webhooks-id-keys.md
  - https://docs.atlar.com/reference/post_platform-v2beta-webhooks.md
  merge:
    pages: 106
    deduped: 3049
    conflicts_kept_first: 0