openapi: 3.2.0
info:
  title: Atlar API (v2) Forecasted Transactions 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: Forecasted Transactions
  description: Forecasted transactions are transactions that are expected to occur in the future. They can be used to predict future cash flows.
  x-displayName: Forecasted Transactions
paths:
  /analytics/v2beta/forecasted-transactions:
    post:
      summary: Create forecasted transaction
      description: Create a forecasted transaction.
      tags:
      - Forecasted Transactions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateForecastedTransactionRequest'
      responses:
        '201':
          description: The created forecasted transaction.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForecastedTransaction'
        '400':
          $ref: '#/components/responses/BadRequest'
        '409':
          $ref: '#/components/responses/Conflict'
      security:
      - basicAuth:
        - accounts:read
        - forecasted_transactions:create
      operationId: postAnalyticsV2betaForecastedTransactions
      x-operation-id-source: derived
    get:
      summary: List forecasted transactions
      description: Returns a list of forecasted transactions. For further details on Pagination, see general section above.
      tags:
      - Forecasted Transactions
      parameters:
      - description: Only include forecasted transactions with the given account.
        in: query
        name: accountId
        schema:
          type: string
          examples:
          - 31d593d7-fff9-4783-aa1d-92acb7b21a19
      - description: Only include forecasted transactions that belong to the given batch.
        in: query
        name: batchId
        schema:
          type: string
          examples:
          - fc80aa63-d8e7-45cc-a241-1ac76e0e9454
      - description: Include only forecasted transactions with property `date` matching the given value. The parameter value may be either a string for equality matching, or an object for range-like matching criteria.
        in: query
        name: date
        explode: true
        style: deepObject
        schema:
          oneOf:
          - type: string
            format: date
            example: '2022-01-15'
            description: Include only forecasted transactions with `date` equal to the given value.
          - type: object
            properties:
              gte:
                type: string
                format: date
                example: '2022-01-01'
                description: Include only forecasted transactions with `date` after or equal to given date.
              lte:
                type: string
                format: date
                example: '2022-01-31'
                description: Include only forecasted transactions with `date` before or equal to given date.
              eq:
                type: string
                format: date
                example: '2022-01-15'
                description: Include only forecasted transactions with `date` equal to given date.
      - $ref: '#/components/parameters/QueryLimit'
      - $ref: '#/components/parameters/PaginationToken'
      responses:
        '200':
          description: List of forecasted transactions.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ListResponse'
                - properties:
                    items:
                      items:
                        $ref: '#/components/schemas/ForecastedTransaction'
                      type: array
                  type: object
        '400':
          $ref: '#/components/responses/BadRequest'
      security:
      - basicAuth:
        - forecasted_transactions:read
      operationId: getAnalyticsV2betaForecastedTransactions
      x-operation-id-source: derived
  /analytics/v2beta/forecasted-transactions/{id}:
    get:
      summary: Get forecasted transaction
      description: Get the forecasted transaction with the specified ID.
      tags:
      - Forecasted Transactions
      parameters:
      - $ref: '#/components/parameters/ResourceIDOrExternalID'
      responses:
        '200':
          description: A forecasted transaction.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForecastedTransaction'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - basicAuth:
        - forecasted_transactions:read
      operationId: getAnalyticsV2betaForecastedTransactionsById
      x-operation-id-source: derived
    delete:
      summary: Delete forecasted transaction
      description: Delete the forecasted transaction with the specified ID.
      tags:
      - Forecasted Transactions
      parameters:
      - $ref: '#/components/parameters/ResourceID'
        description: Forecasted transaction ID
      responses:
        '204':
          description: The forecasted transaction was deleted.
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - basicAuth:
        - forecasted_transactions:delete
      operationId: deleteAnalyticsV2betaForecastedTransactionsById
      x-operation-id-source: derived
    patch:
      summary: Update forecasted transaction
      description: Update the forecasted transaction with the specified ID using JSON Patch operations, given that the provided ETag matches. Some fields can only be updated if the forecasted transaction was manually created by a user (origin type USER). For example, if the forecasted transaction was automatically generated from accounting data, the counterpartyId cannot be changed.
      tags:
      - Forecasted Transactions
      parameters:
      - $ref: '#/components/parameters/ResourceID'
      - $ref: '#/components/parameters/IfMatchETag'
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ForecastedTransactionJSONPatchRequest'
            examples:
              replaceDescription:
                summary: Replace the description
                value:
                - op: replace
                  path: /description
                  value: New description
      responses:
        '200':
          description: The updated forecasted transaction.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForecastedTransaction'
        '400':
          $ref: '#/components/responses/BadRequest'
      security:
      - basicAuth:
        - accounts:read
        - forecasted_transactions:update
      operationId: patchAnalyticsV2betaForecastedTransactionsById
      x-operation-id-source: derived
  /analytics/v2beta/forecasted-transactions/{id}/events:
    get:
      summary: List forecasted transaction events
      description: Retrieve events for a specific forecasted transaction. Returns a list of events. For further details on Pagination, see the section above.
      tags:
      - Forecasted Transactions
      parameters:
      - $ref: '#/components/parameters/ResourceID'
      - $ref: '#/components/parameters/QueryLimit'
      - $ref: '#/components/parameters/PaginationToken'
      responses:
        '200':
          description: List of forecasted transaction events.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ListResponse'
                - properties:
                    items:
                      items:
                        $ref: '#/components/schemas/Event'
                      type: array
                  type: object
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - basicAuth:
        - forecasted_transactions:read
      operationId: getAnalyticsV2betaForecastedTransactionsByIdEvents
      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.
    Conflict:
      description: Conflict.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            status: 409
            message: Resource already exists.
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            status: 404
            message: Resource not found.
  schemas:
    ForecastedTransaction:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ResourceID'
          readOnly: true
        organizationId:
          $ref: '#/components/schemas/OrganizationID'
          readOnly: true
        scenarioId:
          $ref: '#/components/schemas/ResourceID'
        externalId:
          $ref: '#/components/schemas/ExternalID'
        parent:
          $ref: '#/components/schemas/ForecastedTransactionParent'
        accountId:
          type: string
          description: 'The account this forecasted transaction belongs to. Present when parent.type is ACCOUNT; omitted when parent.type is ENTITY.

            '
          readOnly: true
        amount:
          $ref: '#/components/schemas/Amount'
        date:
          $ref: '#/components/schemas/Date'
        description:
          type: string
        origin:
          $ref: '#/components/schemas/ForecastedTransactionOrigin'
          readOnly: true
        metadata:
          $ref: '#/components/schemas/Metadata'
        counterparty:
          $ref: '#/components/schemas/CounterpartyDetails'
          readOnly: true
        created:
          $ref: '#/components/schemas/CreatedTimestamp'
          readOnly: true
        updated:
          $ref: '#/components/schemas/UpdatedTimestamp'
          readOnly: true
        version:
          $ref: '#/components/schemas/ResourceVersion'
          readOnly: true
        etag:
          $ref: '#/components/schemas/ETag'
      required:
      - id
      - organizationId
      - scenarioId
      - parent
      - date
      - amount
      - description
      - created
      - updated
      - version
      - etag
      - origin
    RoutingIdentifierType:
      type: string
      enum:
      - BIC
      - AT_BLZ
      - AU_BSB
      - BD_BRN
      - BR_BRANCH
      - BR_COMPE
      - BR_ISP
      - CA_CPA
      - CH_BCC
      - CH_SIC
      - CL_SBIF
      - CN_APS
      - CZ_NBC
      - DE_BLZ
      - ES_NCC
      - GB_DSC
      - GR_BIC
      - HK_NCC
      - IE_NCC
      - IL_NCC
      - IN_FSC
      - IT_NCC
      - JP_ZGN
      - KR_BOK
      - KR_KFTC
      - MX_ABM
      - MY_NCC
      - NZ_NCC
      - PH_BRSTN
      - PL_KNR
      - PT_NCC
      - RU_CBC
      - SE_SBA
      - SG_IBG
      - TH_CBC
      - TW_NCC
      - US_ABA
      - US_PID
      - VN_CITAD
      - ZA_NCC
      description: A routing identifier of type `BIC` must be provided to support cross-border/SWIFT payments.
      example: BIC
    ForecastedTransactionJSONPatchReplaceMetadataKey:
      description: Set or replace the value of a specific metadata key.
      type: object
      properties:
        op:
          type: string
          enum:
          - replace
        path:
          type: string
          minLength: 11
          maxLength: 74
          pattern: ^/metadata/[A-Za-z0-9_\.\+\-]{1,64}$
        value:
          type: string
          minLength: 1
          maxLength: 512
      additionalProperties: false
      required:
      - op
      - path
      - value
    Amount:
      type: object
      properties:
        currency:
          $ref: '#/components/schemas/CurrencyCode'
        stringValue:
          description: 'A string representation of the amount value. This will be

            a decimal number if the currency has decimals. The number

            is not formatted for display purposes (e.g. with locale

            specific thousand separator) and always contains the dot

            `.` character as decimal separator.'
          example: '15.02'
          type: string
        value:
          description: 'The amount value as an integer (int64) represented in

            currency minor units (e.g. 15.02 EUR is represented as the

            value 1502).'
          example: 1502
          type: integer
          format: int64
      required:
      - currency
      - stringValue
      - value
    ForecastedTransactionJSONPatchReplaceAmountStringValue:
      description: Change the amount.
      type: object
      properties:
        op:
          type: string
          enum:
          - replace
        path:
          type: string
          enum:
          - /amount/stringValue
        value:
          description: A string representation of the amount value, which will be a decimal number if the currency has decimals. The number is not formatted for display purposes (e.g. with thousand separator) and always contains the dot `.` character as decimal separator.
          example: '15.02'
          type: string
      additionalProperties: false
      required:
      - op
      - path
      - value
    ForecastedTransactionJSONPatchReplaceAmountValue:
      description: Change the amount.
      type: object
      properties:
        op:
          type: string
          enum:
          - replace
        path:
          type: string
          enum:
          - /amount/value
        value:
          description: The amount value as an integer (int64) represented in currency minor units (e.g. 15.02 EUR is represented as the value 1502).
          example: 1502
          type: integer
          format: int64
      additionalProperties: false
      required:
      - op
      - path
      - value
    ForecastedTransactionJSONPatchRemoveMetadataKey:
      description: Remove a specific metadata key.
      type: object
      properties:
        op:
          type: string
          enum:
          - remove
        path:
          type: string
          minLength: 11
          maxLength: 74
          pattern: ^/metadata/[A-Za-z0-9_\.\+\-]{1,64}$
      additionalProperties: false
      required:
      - op
      - path
    CounterpartyDetails:
      type: object
      properties:
        partyType:
          type: string
          description: The legal type of the counterparty.
          readOnly: true
          enum:
          - INDIVIDUAL
          - COMPANY
          example: INDIVIDUAL
        name:
          type: string
          description: Name of the counterparty.
          readOnly: true
          example: 'Customer #312'
        nationalIdentifier:
          $ref: '#/components/schemas/NationalIdentifier'
          readOnly: true
        address:
          description: Address details of the counterparty.
          type: object
          properties:
            country:
              $ref: '#/components/schemas/CountryCode'
              x-go-type-skip-optional-pointer: true
            countrySubdivision:
              $ref: '#/components/schemas/CountrySubdivision'
              x-go-type-skip-optional-pointer: true
            city:
              example: Stockholm
              type: string
              maxLength: 64
            postalCode:
              example: '11111'
              type: string
              maxLength: 16
            streetName:
              example: Example street
              type: string
              maxLength: 64
            streetNumber:
              example: '47'
              type: string
              maxLength: 16
            rawAddressLines:
              type: array
              description: International unstructured address lines, as they might appear on a mailing label.
              items:
                type: string
                maxLength: 255
              maxItems: 5
          readOnly: true
        account:
          $ref: '#/components/schemas/CounterpartyAccount'
          readOnly: true
    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
    ForecastedTransactionOriginType:
      type: string
      enum:
      - USER
      - ACCOUNTS_RECEIVABLE
      - ACCOUNTS_PAYABLE
      - GENERATED
      - ACCOUNTING_DOCUMENT
    ResourceID:
      type: string
      description: Unique resource identifier.
      minLength: 32
      maxLength: 64
      examples:
      - 2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8
    ForecastedTransactionEntityRef:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ResourceID'
        type:
          $ref: '#/components/schemas/ForecastedTransactionParentType'
      required:
      - id
      - type
    ForecastedTransactionParent:
      oneOf:
      - $ref: '#/components/schemas/ForecastedTransactionAccountRef'
      - $ref: '#/components/schemas/ForecastedTransactionEntityRef'
      discriminator:
        propertyName: type
        mapping:
          ACCOUNT: '#/components/schemas/ForecastedTransactionAccountRef'
          ENTITY: '#/components/schemas/ForecastedTransactionEntityRef'
    MarketCode:
      type: string
      description: Two-letter ISO 3166-1 alpha2 country code.
      example: DE
      minLength: 2
      maxLength: 2
      pattern: ^[A-Z]{2,2}$
    Date:
      type: string
      format: date
      description: '`full-date` notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), for example, `2017-07-21`.'
      example: '2022-05-07'
    RoutingConstraints:
      description: Constraints on a `RoutingIdentifier`.
      type: object
      properties:
        accountNumberType:
          $ref: '#/components/schemas/AccountIdentifierType'
          x-go-type-skip-optional-pointer: true
        scheme:
          type: string
    AccountIdentifierType:
      type: string
      enum:
      - IBAN
      - NUMBER
      - ADYEN
      - AU_BPAY_BILLER_CODE
      - DK_FIK
      - INVESTMENT_NUMBER
      - NATIONAL_ID_NUMBER
      - PAYPAL
      - PROPRIETARY
      - SE_BANKGIRO
      - SE_PLUSGIRO
      - SOLDO
      - WALLET_ADYEN_BALANCE_PLATFORM
      - WALLET_AIRWALLEX
      - WALLET_AIRWALLEX_NUMBER
      - WALLET_CURRENCYCLOUD
      - WALLET_FLASH_PAYMENTS
      - WALLET_FREEMARKET
      - WALLET_HYPERWALLET
      - WALLET_INPAY
      - WALLET_LEAD
      - WALLET_MERCURY
      - WALLET_MONEYCORP
      - WALLET_PAYHAWK
      - WALLET_REVOLUT
      - WALLET_SKRILL
      - WALLET_STRIPE
      - WALLET_SWISSQUOTE
      - WALLET_UNIT
      description: 'Account Identifier type. Choose among:

        <ul>

        <li><code>IBAN</code> — IBAN</li>

        <li><code>NUMBER</code> — Account number</li>

        <li><code>ADYEN</code> — Adyen identifier</li>

        <li><code>AU_BPAY_BILLER_CODE</code> — Australian BPAY Biller Code</li>

        <li><code>DK_FIK</code> — FIK creditor number</li>

        <li><code>INVESTMENT_NUMBER</code> — Investment number</li>

        <li><code>NATIONAL_ID_NUMBER</code> — National Identification Number</li>

        <li><code>PAYPAL</code> — PayPal wallet identifier</li>

        <li><code>PROPRIETARY</code> — Proprietary identifier</li>

        <li><code>SE_BANKGIRO</code> — <a href="https://www.bankgirot.se/en/">Bankgiro number</a></li>

        <li><code>SE_PLUSGIRO</code> — <a href="https://www.nordea.se/foretag/produkter/betala/plusgirot.html">Plusgiro number</a></li>

        <li><code>SOLDO</code> — Soldo entity identifier</li>

        <li><code>WALLET_ADYEN_BALANCE_PLATFORM</code> — Adyen balance platform wallet identifier</li>

        <li><code>WALLET_AIRWALLEX</code> — Airwallex wallet identifier</li>

        <li><code>WALLET_AIRWALLEX_NUMBER</code> — Airwallex account number</li>

        <li><code>WALLET_CURRENCYCLOUD</code> — Currencycloud wallet identifier</li>

        <li><code>WALLET_FLASH_PAYMENTS</code> — Flash Payments wallet identifier</li>

        <li><code>WALLET_FREEMARKET</code> — Freemarket wallet identifier</li>

        <li><code>WALLET_HYPERWALLET</code> — Hyperwallet wallet identifier</li>

        <li><code>WALLET_INPAY</code> — Inpay account identifier</li>

        <li><code>WALLET_LEAD</code> — Lead wallet identifier</li>

        <li><code>WALLET_MERCURY</code> — Mercury wallet identifier</li>

        <li><code>WALLET_MONEYCORP</code> — Moneycorp wallet identifier</li>

        <li><code>WALLET_PAYHAWK</code> — Payhawk wallet identifier</li>

        <li><code>WALLET_REVOLUT</code> — Revolut wallet identifier</li>

        <li><code>WALLET_SKRILL</code> — Skrill wallet identifier</li>

        <li><code>WALLET_STRIPE</code> — Stripe wallet identifier</li>

        <li><code>WALLET_SWISSQUOTE</code> — Swissquote wallet identifier</li>

        <li><code>WALLET_UNIT</code> — Unit wallet identifier</li>

        </ul>

        For further information please refer to <a href="https://docs.atlar.com/v2.0/docs/payment-details#account-identifiers">Account Identifiers</a>'
      example: IBAN
    RoutingIdentifier:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/RoutingIdentifierType'
        number:
          type: string
          description: The form of the routing number depends on `type`. E.g. for `BIC` the value should be an 8 or 11 character BIC/SWIFT code. For `GB_DSC` (UK domestic routing) the value should be a six digit sort code.
          minLength: 1
          maxLength: 255
        invalid:
          type: boolean
          description: Will be `true` if the routing identifier is invalid according to Atlar validation rules.
          readOnly: true
        constraints:
          $ref: '#/components/schemas/RoutingConstraints'
      required:
      - type
      - number
      examples:
      - type: BIC
        number: BUKBGB22
      - type: US_ABA
        number: '123456789'
      - type: DE_BLZ
        number: '12345678'
      - type: SE_SBA
        number: '9960'
      - type: BIC
        number: '123'
        invalid: true
    ForecastedTransactionAccountRef:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ResourceID'
        type:
          $ref: '#/components/schemas/ForecastedTransactionParentType'
      required:
      - id
      - type
    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
    ForecastedTransactionJSONPatchReplaceDate:
      description: Change execution date.
      type: object
      properties:
        op:
          type: string
          enum:
          - replace
        path:
          type: string
          enum:
          - /date
        value:
          $ref: '#/components/schemas/Date'
          example: '2022-05-08'
      additionalProperties: false
      required:
      - op
      - path
      - value
    CountrySubdivision:
      type: string
      description: 'Country subdivision code (second part of the ISO 3166-2 code).

        E.g. state code `CA` for the state of California in the USA, `ON` for the province of Ontario in Canada, `NSW` for the state of New South Wales in Australia.

        ISO 3166-2 codes can be found on the ISO website, for example, for the USA: https://www.iso.org/obp/ui/#iso:code:3166:US.

        In the USA the state code is required for domestic payments, in Canada the province code is required for domestic payments.'
      example: US-CA
      maxLength: 6
      pattern: ^[A-Z]{2,2}-[A-Z0-9]{1,3}$
    CreatedTimestamp:
      type: string
      format: date-time
      description: Time at which the resource was created.
      example: '2022-05-04T18:31:12.889104898Z'
      readOnly: true
    CounterpartyAccount:
      type: object
      description: Account information about the counterparty in the transaction.
      properties:
        market:
          $ref: '#/components/schemas/MarketCode'
          readOnly: true
        identifiers:
          type: array
          items:
            $ref: '#/components/schemas/AccountIdentifier'
          uniqueItems: true
          readOnly: true
        routing:
          type: array
          items:
            $ref: '#/components/schemas/RoutingIdentifier'
          uniqueItems: true
          readOnly: true
          x-omitempty: true
        rawIdentifier:
          type: string
          readOnly: true
      required:
      - identifiers
      - rawIdentifier
    AmountIntegerValueInput:
      type: object
      properties:
        currency:
          $ref: '#/components/schemas/CurrencyCode'
        value:
          description: The amount value as an integer (int64) represented in currency minor units (e.g. 15.02 EUR is represented as the value 1502).
          example: 1502
          type: integer
          format: int64
      required:
      - currency
      - value
    ForecastedTransactionJSONPatchReplaceDescription:
      description: Change the description.
      type: object
      properties:
        op:
          type: string
          enum:
          - replace
        path:
          type: string
          enum:
          - /description
        value:
          type: string
      additionalProperties: false
      required:
      - op
      - path
      - value
    CountryCode:
      type: string
      description: Two-letter ISO 3166-1 alpha2 country code.
      example: DE
      minLength: 2
      maxLength: 2
      pattern: ^[A-Z]{2,2}$
    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
    AmountStringValueInput:
      type: object
      properties:
        currency:
          $ref: '#/components/schemas/CurrencyCode'
        stringValue:
          description: A string representation of the amount value, which will be a decimal number if the currency has decimals. The number is not formatted for display purposes (e.g. with thousand separator) and always contains the dot `.` character as decimal separator.
          example: '15.02'
          type: string
      required:
      - currency
      - stringValue
    EventType:
      type: string
      description: Event type.
      enum:
      - CREATED
      - UPDATED
      - DELETED
    ForecastedTransactionJSONPatchReplaceAmount:
      description: Change the amount and currency together, atomically.
      type: object
      properties:
        op:
          type: string
          enum:
          - replace
        path:
          type: string
          enum:
          - /amount
        value:
          $ref: '#/components/schemas/AmountInput'
      additionalProperties: false
      required:
      - op
      - path
      - value
    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
    CreateForecastedTransactionRequest:
      type: object
      properties:
        parent:
          description: All forecasted transactions must be associated with either an account or an entity.
          $ref: '#/components/schemas/ForecastedTransactionParent'
        amount:
          $ref: '#/components/schemas/AmountInput'
        date:
          $ref: '#/components/schemas/Date'
        description:
          type: string
        origin:
          x-atlar-mcp-ignore: true
          $ref: '#/components/schemas/ForecastedTransactionOrigin'
        counterparty:
          $ref: '#/components/schemas/CounterpartyDetails'
        metadata:
          description: 'Optional key-value metadata. Set the cash-flow category with key `atlar.category` (e.g. `{"atlar.category": "Sales"}`); there is no separate category field.'
          $ref: '#/components/schemas/Metadata'
        externalId:
          $ref: '#/components/schemas/ExternalID'
      required:
      - parent
      - description
      - amount
      - date
    ForecastedTransactionParentType:
      type: string
      enum:
      - ACCOUNT
      - ENTITY
    OrganizationID:
      type: string
      description: Unique resource identifier for an Organization.
      examples:
      - 0160f6ab-5741-49e1-af46-9138927e547e
    AmountInput:
      oneOf:
      - $ref: '#/components/schemas/AmountIntegerValueInput'
      - $ref: '#/components/schemas/AmountStringValueInput'
    Metadata:
      type:
      - object
      - 'null'
      additionalProperties:
        type: string
      description: 'Metadata is a `string-string` key-value container that

        can be used to store information known at the time of resource

        creation. This can be retrieved later on, for instance when a

        payment or expected transaction is reconciled with the booked

        transaction on the bank statement.


        Metadata can have at most 20 entries. Keys may have a

        maximum length of 64 chars and values a maximum length of 512

        chars.


        By default, this field is optional. It is possible to make it

        required in the Atlar Dashboard by visiting the [Metadata keys

        page](https://app.atlar.com/metadata-keys). Requirement rules

        can be specified per API resource. Both the Dashboard and the

        API will then enforce these rules and give validation errors

        when the required fields are not set.'
      maxProperties: 20
      example:
        my_metadata_key: 2a9a79b9-601c-449b-aa05-432f41dbbc4a
      x-omitempty: true
    ForecastedTransactionJSONPatchRequest:
      description: JSON Patch Request.
      externalDocs:
        url: https://jsonpatch.com/
      type: array
      items:
        oneOf:
        - $ref: '#/components/schemas/ForecastedTransactionJSONPatchReplaceAmountValue'
        - $ref: '#/components/schemas/ForecastedTransactionJSONPatchReplaceAmountStringValue'
        - $ref: '#/components/schemas/ForecastedTransactionJSONPatchReplaceAmount'
        - $ref: '#/components/schemas/ForecastedTransactionJSONPatchReplaceDescription'
        - $ref: '#/components/schemas/ForecastedTransactionJSONPatchReplaceDate'
        - $ref: '#/components/schemas/ForecastedTransactionJSONPatchReplaceMetadataKey'
        - $ref: '#/components/schemas/ForecastedTransactionJSONPatchRemoveMetadataKey'
    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
    Event:
      type: object
      description: A resource event.
      properties:
        id:
          type: integer
          description: The ID of the event.
          example: 1
        organizationId:
          $ref: '#/components/schemas/OrganizationID'
        entityId:
          description: The ID of the API resource that this event belongs to.
          $ref: '#/components/schemas/ResourceID'
        type:
          $ref: '#/components/schemas/EventType'
        name:
          type: string
          description: The event name. Different resources have different sets of event names.
          example: CREATED
        timestamp:
          description: When the event happened.
          type: string
          format: date-time
          example: '2022-08-20T12:20:40.866061374Z'
        details:
          description: Additional details describing this event.
          type: object
          additionalProperties:
            type: string
          examples:
          - approvalStepId: e741c062-19f6-46a0-be31-63dded5b0341
        message:
          type: string
          description: A message which could either be a message from the bank or an explanation of the event.
        originator:
          description: The originator of the event which could be either a user ID, BANK or ATLAR.
          type: string
          example: ATLAR
      required:
      - id
      - organizationId
      - entityId
      - type
      - name
      - originator
      - timestamp
    AccountIdentifier:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/AccountIdentifierType'
        market:
          $ref: '#/components/schemas/MarketCode'
          description: 'The market of the `AccountIdentifier` specifies in which market-context the identifier should be treated.


            A `NUMBER` from Sweden does not look and does not validate in the same way as a `NUMBER` from GB. The market

            code is, in most cases, the same as where the account itself is domiciled, but not necessarily. An examples

            of this discrepancy is Jersey which may have domiciled accounts with market `JE`, but the account identifier

            would be an `IBAN` with country code `GB`.'
        number:
          type: string
          description: The unformatted identifier itself. For type `NUMBER` the structure of the account number is country-specific.
          minLength: 1
          maxLength: 255
        invalid:
          type: boolean
          description: Will be `true` if the account identifier is invalid according to Atlar account identifier validation rules.
          readOnly: true
      required:
      - type
      - market
      - number
      examples:
      - type: IBAN
        market: DE
        number: DE75512108001245126199
      - type: NUMBER
        market: GB
        number: '12345678'
      - type: NUMBER
        market: SE
        number: '6114517182351'
      - type: IBAN
        market: DE
        number: '123'
        invalid: true
    NationalIdentifier:
      type: object
      properties:
        type:
          type: string
          description: Type of the national identifier.
          enum:
          - CIVIC
          - COMPANY
          example: CIVIC
        market:
          $ref: '#/components/schemas/MarketCode'
        number:
          type: string
          description: The identifier itself.
          example: '2012121212'
      required:
      - type
      - market
      - number
    ForecastedTransactionOrigin:
      description: The origin of this forecasted transaction, e.g. manual user input or AP/AR data.
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ResourceID'
        type:
          $ref: '#/components/schemas/ForecastedTransactionOriginType'
      required:
      - id
      - type
  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