> ## 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 customer

> Returns a customer with all sub-records.

Customer visibility depends on the sharing code. A customer the user cannot see returns **404**. See [Sharing codes](/en/v1/guides/sharing-codes).


## OpenAPI

````yaml api-reference/openapi.json GET /api/v1/customers/{customerId}
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://api.noyax.com
security:
  - Bearer: []
tags:
  - name: Sections
  - name: Warehouses
  - name: Product Critical Stock
  - name: Product groups
  - name: Product Parameter Definitions
  - name: Product Parameters
  - name: Product Prices
  - name: Products
  - name: Cities
  - name: Countries
  - name: Currencies
  - name: Districts
  - 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/customers/{customerId}:
    get:
      tags:
        - Customers
      summary: Get customer
      description: >-
        Returns the customer with all sub-records: addresses, telephones, links,
        representatives, bank accounts, group memberships, parameters and
        e-invoice labels.
      parameters:
        - name: customerId
          in: path
          description: Customer 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/DataResultOfCustomerDetailDto'
        '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: '1000'
                Message: Customer not found.
                Errors:
                  - Code: '1000'
                    Message: Customer 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:
    DataResultOfCustomerDetailDto:
      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/CustomerDetailDto'
    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.
    CustomerDetailDto:
      type: object
      properties:
        Id:
          type: string
          description: Customer ID.
          format: uuid
        CustomerCode:
          type:
            - 'null'
            - string
          description: >-
            Required. Unique within the company. Send "Next" on create to
            generate the code from the company's customer number series.
          example: '0000382026'
        Name:
          type:
            - 'null'
            - string
          description: Required. Customer name.
          example: Örnek Ticaret A.Ş.
        TaxNumber:
          type:
            - 'null'
            - string
          description: >-
            Required. Digits only: 10 digits for a tax number (VKN) or 11 digits
            for a national ID number (TCKN).
          example: '1234567890'
        TaxOffice:
          type:
            - 'null'
            - string
          description: Tax office name.
          example: Kadıköy
        InvoiceTitle:
          type:
            - 'null'
            - string
          description: Title used on invoices. If empty, Name is used.
          example: Örnek Ticaret Anonim Şirketi
        Note:
          type:
            - 'null'
            - string
          description: Free text note. Required when any ShowNoteOn* field is true.
          example: Deliveries on weekdays only.
        DueDays:
          type: integer
          description: Payment term in days. Cannot be less than 0.
          format: int32
          example: 30
        DiscountRate:
          type: number
          description: Default discount rate (%) between 0 and 100.
          format: double
          example: 5
        Blacklisted:
          type: boolean
          description: Marks the customer as blacklisted.
          example: false
        MovementType:
          type: integer
          description: '1: Supplier, 2: Buyer, 3: Supplier and buyer. 0 is saved as 1.'
          format: int32
          example: 2
        RiskLimit:
          type: number
          description: Risk limit amount. Cannot be less than 0. 0 means no risk limit.
          format: double
          example: 250000
        RiskControl:
          type: integer
          description: >-
            How the risk limit is checked. 1: Current balance, 2: Sales amount.
            Must be 1 or 2 when RiskLimit is greater than 0.
          format: int32
          example: 1
        RiskAction:
          type: integer
          description: >-
            What happens when the risk limit is exceeded. 0: Continue, 1: Warn
            the user, 2: Stop the operation.
          format: int32
          example: 1
        EInvoiceUser:
          type: boolean
          description: Whether the customer is a registered e-invoice user.
          example: true
        EInvoiceScenario:
          type: integer
          description: >-
            E-invoice scenario. Must be 1-9 when EInvoiceUser is true, 0
            otherwise. 1: Commercial, 2: Basic, 3: Export, 4: Public, 5: HKS, 6:
            Energy, 7: Pharmaceutical/Medical device, 8: Investment incentive,
            9: IDIS.
          format: int32
          example: 1
        ShipmentDefinitionId:
          type:
            - 'null'
            - string
          description: >-
            ID of a shipment definition from GET
            /api/v1/definitions/shipment-definitions.
          format: uuid
        SharingCodeId:
          type:
            - 'null'
            - string
          description: >-
            Sharing code that limits who can see the customer. Empty means
            visible to everyone; otherwise it must be one of the user's sharing
            codes.
          format: uuid
        ShowNoteOnQuote:
          type: boolean
          description: Show the note on quotes.
          example: false
        ShowNoteOnOrder:
          type: boolean
          description: Show the note on orders.
          example: false
        ShowNoteOnWaybill:
          type: boolean
          description: Show the note on waybills.
          example: true
        ShowNoteOnInvoice:
          type: boolean
          description: Show the note on invoices.
          example: false
        IdentitySchemes:
          type: array
          items:
            $ref: '#/components/schemas/IdentitySchemeDto'
          description: >-
            Additional identifiers (e.g. MERSISNO). Each SchemeID can be sent
            only once.
        CreateDate:
          type:
            - 'null'
            - string
          description: Creation date.
          format: date-time
        ModifyDate:
          type:
            - 'null'
            - string
          description: Last modification date.
          format: date-time
        Addresses:
          type: array
          items:
            $ref: '#/components/schemas/CustomerAddressDto'
          description: Addresses.
        Telephones:
          type: array
          items:
            $ref: '#/components/schemas/CustomerTelephoneDto'
          description: Telephone numbers.
        Links:
          type: array
          items:
            $ref: '#/components/schemas/CustomerLinkDto'
          description: E-mail addresses, websites and social media links.
        Representatives:
          type: array
          items:
            $ref: '#/components/schemas/CustomerRepresentativeDto'
          description: Contact persons.
        BankAccounts:
          type: array
          items:
            $ref: '#/components/schemas/CustomerBankAccountDto'
          description: Bank accounts.
        GroupMembers:
          type: array
          items:
            $ref: '#/components/schemas/CustomerGroupMemberDto'
          description: Group memberships.
        Parameters:
          type: array
          items:
            $ref: '#/components/schemas/CustomerParameterDto'
          description: Custom parameter values.
        EInvoiceLabels:
          type: array
          items:
            $ref: '#/components/schemas/CustomerEInvoiceLabelDto'
          description: E-invoice labels (read-only; filled from the e-invoice integrator).
      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.
    IdentitySchemeDto:
      type: object
      properties:
        SchemeID:
          type:
            - 'null'
            - string
          description: UBL identity scheme code, e.g. MERSISNO, TICARETSICILNO, MUSTERINO.
          example: MERSISNO
        Value:
          type:
            - 'null'
            - string
          description: Required. Identifier value.
          example: '0123456789000015'
    CustomerAddressDto:
      type: object
      properties:
        Id:
          type: string
          description: Address ID.
          format: uuid
        CustomerId:
          type: string
          description: Customer ID.
          format: uuid
        DistrictId:
          type:
            - 'null'
            - string
          description: District ID.
          format: uuid
        DistrictName:
          type:
            - 'null'
            - string
          description: District name.
          example: Kadıköy
        CityName:
          type:
            - 'null'
            - string
          description: City name.
          example: İstanbul
        CountryName:
          type:
            - 'null'
            - string
          description: Country name.
          example: Türkiye
        Address:
          type:
            - 'null'
            - string
          description: Street address.
          example: 'Caferağa Mah. Moda Cad. No: 10'
        FullAddress:
          type:
            - 'null'
            - string
          description: Full address including district, city and country (read-only).
        PostalCode:
          type:
            - 'null'
            - string
          description: Postal code.
          example: '34710'
        IsInvoiceAddress:
          type: boolean
          description: Whether this is the invoice address.
          example: true
        CoordinateX:
          type:
            - 'null'
            - number
          description: Location coordinate X.
          format: double
          example: 40.9877
        CoordinateY:
          type:
            - 'null'
            - number
          description: Location coordinate Y.
          format: double
          example: 29.0254
    CustomerTelephoneDto:
      type: object
      properties:
        Id:
          type: string
          description: Telephone ID.
          format: uuid
        CustomerId:
          type: string
          description: Customer ID.
          format: uuid
        Number:
          type:
            - 'null'
            - string
          description: Required. Telephone number.
          example: '02165550000'
        NumberType:
          type:
            - 'null'
            - integer
          description: '1: Landline, 2: Mobile.'
          format: int32
          example: 1
        Extension:
          type:
            - 'null'
            - string
          description: Extension number.
          example: '101'
        Description:
          type:
            - 'null'
            - string
          description: Description.
          example: Accounting
    CustomerLinkDto:
      type: object
      properties:
        Id:
          type: string
          description: Link ID.
          format: uuid
        CustomerId:
          type: string
          description: Customer ID.
          format: uuid
        Value:
          type:
            - 'null'
            - string
          description: >-
            Required. E-mail address or URL. Must be a valid e-mail address when
            LinkType is 1.
          example: accounting@example.com
        LinkType:
          type: integer
          description: '0: Other, 1: E-mail, 2: Website, 3: LinkedIn, 4: Instagram, 5: X.'
          format: int32
          example: 1
        Description:
          type:
            - 'null'
            - string
          description: Description.
          example: Invoices
    CustomerRepresentativeDto:
      type: object
      properties:
        Id:
          type: string
          description: Representative ID.
          format: uuid
        CustomerId:
          type: string
          description: Customer ID.
          format: uuid
        FullName:
          type:
            - 'null'
            - string
          description: Required. Full name of the contact person.
          example: Ayşe Yılmaz
        Position:
          type:
            - 'null'
            - string
          description: Job title or position.
          example: Purchasing Manager
        Gsm:
          type:
            - 'null'
            - string
          description: Mobile phone number.
          example: '05325550000'
        Email:
          type:
            - 'null'
            - string
          description: E-mail address. Must be valid if sent.
          example: ayse.yilmaz@example.com
        Phone:
          type:
            - 'null'
            - string
          description: Landline phone number.
          example: '02165550000'
        Extension:
          type:
            - 'null'
            - string
          description: Extension number.
          example: '105'
        Link:
          type:
            - 'null'
            - string
          description: Link, e.g. a LinkedIn profile.
          example: https://www.linkedin.com/in/example
        Description:
          type:
            - 'null'
            - string
          description: Description.
    CustomerBankAccountDto:
      type: object
      properties:
        Id:
          type: string
          description: Bank account ID.
          format: uuid
        CustomerId:
          type: string
          description: Customer ID.
          format: uuid
        CurrencyName:
          type:
            - 'null'
            - string
          description: Currency name.
          example: TL
        BankName:
          type:
            - 'null'
            - string
          description: Required. Bank name.
          example: Example Bank
        Branch:
          type:
            - 'null'
            - string
          description: Branch. Required together with AccountNumber when Iban is empty.
          example: Kadıköy
        AccountNumber:
          type:
            - 'null'
            - string
          description: Account number. Required together with Branch when Iban is empty.
          example: '12345678'
        Iban:
          type:
            - 'null'
            - string
          description: IBAN. Required when Branch and AccountNumber are empty.
          example: TR330006100519786457841326
        CurrencyId:
          type:
            - 'null'
            - string
          description: Required. ID of a currency from GET /api/v1/definitions/currencies.
          format: uuid
        Description:
          type:
            - 'null'
            - string
          description: Description.
    CustomerGroupMemberDto:
      type: object
      properties:
        Id:
          type: string
          description: Group membership ID.
          format: uuid
        CustomerId:
          type: string
          description: Customer ID.
          format: uuid
        GroupDetailId:
          type:
            - 'null'
            - string
          description: Group detail ID.
          format: uuid
        GroupDetailName:
          type:
            - 'null'
            - string
          description: Group detail name.
          example: Marmara
        GroupId:
          type:
            - 'null'
            - string
          description: Group ID.
          format: uuid
        GroupName:
          type:
            - 'null'
            - string
          description: Group name.
          example: Region
    CustomerParameterDto:
      type: object
      properties:
        Id:
          type: string
          description: Parameter ID.
          format: uuid
        CustomerId:
          type: string
          description: Customer ID.
          format: uuid
        ParameterDefinitionId:
          type:
            - 'null'
            - string
          description: Parameter definition ID.
          format: uuid
        ParameterName:
          type:
            - 'null'
            - string
          description: Parameter definition name.
          example: Segment
        ParameterType:
          type:
            - 'null'
            - integer
          description: >-
            0: Text, 1: Yes/No, 2: Integer, 3: Decimal, 4: Date, 5: Time, 6:
            Date and time.
          format: int32
          example: 0
        Value:
          description: Value in the format of ParameterType.
          example: Priority
    CustomerEInvoiceLabelDto:
      type: object
      properties:
        Id:
          type: string
          description: Label ID.
          format: uuid
        CustomerId:
          type: string
          description: Customer ID.
          format: uuid
        Label:
          type:
            - 'null'
            - string
          description: E-invoice alias, e.g. "urn:mail:defaultpk@example.com".
          example: urn:mail:defaultpk@example.com
        Description:
          type:
            - 'null'
            - string
          description: Description (the title returned by the integrator).
          example: ÖRNEK TİCARET A.Ş.
        Type:
          type: integer
          description: Label type. Always 0 (PK, mailbox) for labels from this query.
          format: int32
          example: 0
        IsDefault:
          type: boolean
          description: Whether this is the default label.
          example: true
  securitySchemes:
    Bearer:
      type: http
      description: Access token obtained from the Noyax auth service with your API key.
      scheme: bearer
      bearerFormat: JWT

````