> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.noyax.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get bank transfer

> Returns the bank transfer voucher with its lines.

## Error codes

Codes this endpoint can return. The [general errors](/en/v1/guides/result-codes) that apply to every endpoint (authentication, permissions, request headers, daily limit) are not repeated here.

| Code   | HTTP | Meaning                 |
| ------ | ---- | ----------------------- |
| `8100` | 404  | Bank transfer not found |


## OpenAPI

````yaml api-reference/openapi.json GET /api/v1/finance/bank-transfers/{bankTransferId}
openapi: 3.1.1
info:
  title: Noyax API
  description: Server-to-server API for integrations to access Noyax data.
  version: '1.0'
servers:
  - url: https://dev.noyax.com/services/noyax_api
security:
  - Bearer: []
tags:
  - name: Sections
  - name: Warehouses
  - name: Quotes
  - name: Product Critical Stock
  - name: Product groups
  - name: Product Parameter Definitions
  - name: Product Parameters
  - name: Product Prices
  - name: Products
  - name: Orders
  - name: Bank Accounts
  - name: Bank Internal Transfers
  - name: Bank Openings
  - name: Banks
  - name: Bank Transfers
  - name: Credit Card Collections
  - name: Repayment Plans
  - name: Despatches
  - name: Cities
  - name: Countries
  - name: Currencies
  - name: Districts
  - name: Line Groups
  - name: Shipment Definitions
  - name: Units
  - name: VAT rates
  - name: Customer Addresses
  - name: Customer Bank Accounts
  - name: Customer Definitions
  - name: Customer Group Members
  - name: Customer Links
  - name: Customer Parameters
  - name: Customer Representatives
  - name: Customers
  - name: Customer Statement
  - name: Customer Telephones
paths:
  /api/v1/finance/bank-transfers/{bankTransferId}:
    get:
      tags:
        - Bank Transfers
      summary: Get bank transfer
      description: Returns the bank transfer voucher with its lines.
      parameters:
        - name: bankTransferId
          in: path
          description: Bank transfer ID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-UserID
          in: header
          description: >-
            ID of the Noyax user the request is made on behalf of. Written to
            the audit fields of created, updated and deleted records.
          required: true
          schema:
            minimum: 1
            type: integer
            format: int32
        - name: X-CompanyID
          in: header
          description: >-
            ID of the company. The user must be assigned to this company. All
            reads and writes are limited to this company.
          required: true
          schema:
            minimum: 1
            type: integer
            format: int32
        - name: X-PeriodID
          in: header
          description: >-
            ID of the accounting period. Optional for customer endpoints; if
            sent, it is written to created records.
          schema:
            minimum: 1
            type: integer
            format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResultOfBankTransferDetailDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResult'
              example:
                Success: false
                ResultCode: '0201'
                Message: X-UserID header is required.
                Errors:
                  - Code: '0201'
                    Message: X-UserID header is required.
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResult'
              example:
                Success: false
                ResultCode: '0102'
                Message: Token has expired. Obtain a new token using the refresh token.
                Errors:
                  - Code: '0102'
                    Message: >-
                      Token has expired. Obtain a new token using the refresh
                      token.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResult'
              example:
                Success: false
                ResultCode: '0110'
                Message: You do not have permission for this operation.
                Errors:
                  - Code: '0110'
                    Message: You do not have permission for this operation.
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResult'
              example:
                Success: false
                ResultCode: '8100'
                Message: Bank transfer not found.
                Errors:
                  - Code: '8100'
                    Message: Bank transfer not found.
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResult'
              example:
                Success: false
                ResultCode: '0120'
                Message: Daily request limit (10000) exceeded.
                Errors:
                  - Code: '0120'
                    Message: Daily request limit (10000) exceeded.
components:
  schemas:
    DataResultOfBankTransferDetailDto:
      required:
        - Success
        - ResultCode
        - Data
      type: object
      properties:
        Success:
          type: boolean
          description: Whether the operation succeeded.
          example: true
        ResultCode:
          type: string
          description: >-
            "0000" on success. On failure, the code of the first error; all
            errors are listed in Errors.
          example: '0000'
        Message:
          type:
            - 'null'
            - string
          description: >-
            Error message when Success is false. Messages of all errors are
            joined into a single text.
        Data:
          $ref: '#/components/schemas/BankTransferDetailDto'
    ErrorResult:
      type: object
      properties:
        Success:
          type: boolean
          description: Whether the operation succeeded.
          example: false
        ResultCode:
          type:
            - 'null'
            - string
          description: >-
            "0000" on success. On failure, the code of the first error; all
            errors are listed in Errors.
        Message:
          type:
            - 'null'
            - string
          description: >-
            Error message when Success is false. Messages of all errors are
            joined into a single text.
        Errors:
          type:
            - 'null'
            - array
          items:
            $ref: '#/components/schemas/ResultError'
          description: All errors with their codes. Only present when Success is false.
    BankTransferDetailDto:
      type: object
      properties:
        Id:
          type: string
          description: Bank transfer voucher ID.
          format: uuid
        TransferType:
          type: integer
          description: >-
            1: Incoming transfer (Gelen EFT/Havale), 2: Outgoing transfer (Giden
            EFT/Havale).
          format: int32
          example: 1
        VoucherNumber:
          type:
            - 'null'
            - string
          description: Voucher number.
          example: 5466CACC0016
        Date:
          type:
            - 'null'
            - string
          description: Voucher date.
          format: date-time
        BankAccountCode:
          type:
            - 'null'
            - string
          description: Bank account name.
          example: TEST POS
        BankAccountId:
          type:
            - 'null'
            - string
          description: Bank account ID.
          format: uuid
        CurrencyCode:
          type:
            - 'null'
            - string
          description: Currency code of the bank account (and of every line's Amount).
        CurrencyId:
          type:
            - 'null'
            - string
          description: Currency ID of the bank account.
          format: uuid
        ExchangeRate:
          type: number
          description: >-
            Weighted average exchange rate across the lines: sum(Amount x
            ExchangeRate) / sum(Amount).
          format: double
        Amount:
          type: number
          description: Total amount (sum of the lines' Amount).
          format: double
        Description:
          type:
            - 'null'
            - string
          description: Description.
        SharingCode:
          type:
            - 'null'
            - string
          description: Sharing code that limits who can see the voucher.
        SharingCodeId:
          type:
            - 'null'
            - string
          description: Sharing code ID.
          format: uuid
        IsPosted:
          type: boolean
          description: >-
            Whether the voucher has been posted to accounting. A posted voucher
            cannot be updated or deleted.
        CreateDate:
          type:
            - 'null'
            - string
          format: date-time
        ModifyDate:
          type:
            - 'null'
            - string
          format: date-time
        Lines:
          type: array
          items:
            $ref: '#/components/schemas/BankTransferLineDto'
          description: Lines, in line order.
      description: Response data. Null when Success is false.
    ResultError:
      required:
        - Code
        - Message
      type: object
      properties:
        Code:
          type: string
          description: Error code. See the result codes page for the full list.
        Message:
          type: string
          description: Error description.
    BankTransferLineDto:
      type: object
      properties:
        CustomerName:
          type:
            - 'null'
            - string
          description: Customer name.
        CustomerId:
          type:
            - 'null'
            - string
          format: uuid
        CustomerCurrencyId:
          type:
            - 'null'
            - string
          format: uuid
        CustomerCode:
          type:
            - 'null'
            - string
          description: >-
            Required. Customer code (the customer's CustomerCode from GET
            /api/v1/customers).
          example: C-0001
        Amount:
          type: number
          description: >-
            Required. Amount, in the bank account's own currency. Must be
            greater than 0.
          format: double
          example: 500
        ExchangeRate:
          type:
            - 'null'
            - number
          description: >-
            Exchange rate of the bank account's currency against the company's
            default currency. Required, and must be greater than 0, only when
            the bank account's currency differs from the default currency;
            otherwise treated as 1.
          format: double
          example: 1
        Description:
          type:
            - 'null'
            - string
          description: Description. At most 255 characters.
        CustomerAmount:
          type:
            - 'null'
            - number
          description: >-
            Overrides the amount recorded on the customer's own account (send
            together with CustomerCurrencyCode and CustomerExchangeRate, or
            leave all three empty to record the customer movement with the same
            amount, currency and rate as the bank movement). CustomerAmount
            multiplied by CustomerExchangeRate must equal Amount multiplied by
            ExchangeRate.
          format: double
        CustomerCurrencyCode:
          type:
            - 'null'
            - string
          description: >-
            Currency code for the customer movement override (from GET
            /api/v1/definitions/currencies). Send together with CustomerAmount
            and CustomerExchangeRate.
        CustomerExchangeRate:
          type:
            - 'null'
            - number
          description: >-
            Exchange rate for the customer movement override. Required, and must
            be greater than 0, when CustomerCurrencyCode differs from the
            company's default currency.
          format: double
  securitySchemes:
    Bearer:
      type: http
      description: Access token obtained from the Noyax auth service with your API key.
      scheme: bearer
      bearerFormat: JWT

````