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

# Tanımlar

> Kayıt oluştururken kullanılan ID'leri (ilçe, döviz, grup, ...) öğrenmek.

Cari, ürün ya da fatura gibi kayıtlar bazı alanlarda serbest metin yerine Noyax'ta tanımlı bir kaydın **ID'sini** ister. Örneğin adres için ilçe adı değil `DistrictId` gönderilir. Bu ID'leri tanım endpoint'lerinden alırsınız.

## Hangi ID nereden gelir?

| Alan                    | Kullanıldığı yer     | Endpoint                                                                                          |
| ----------------------- | -------------------- | ------------------------------------------------------------------------------------------------- |
| `DistrictId`            | Cari adresleri       | [`GET /definitions/districts`](/tr/v1/definitions/districts/list)                                 |
| `CurrencyId`            | Cari banka hesapları | [`GET /definitions/currencies`](/tr/v1/definitions/currencies/list)                               |
| `ShipmentDefinitionId`  | Cari                 | [`GET /definitions/shipment-definitions`](/tr/v1/definitions/shipment-definitions/list)           |
| `GroupDetailId`         | Cari grup üyelikleri | [`GET /customers/groups`](/tr/v1/customers/definitions/groups)                                    |
| `ParameterDefinitionId` | Cari parametreleri   | [`GET /customers/parameter-definitions`](/tr/v1/customers/definitions/parameter-definitions/list) |

Ülke ve il listeleri, ilçeyi bulmak için kullanılır: [ülke](/tr/v1/definitions/countries/list) → [il](/tr/v1/definitions/cities/list) (`countryId`) → [ilçe](/tr/v1/definitions/districts/list) (`cityId`).

## Örnek: adres için ilçe bulmak

<Steps>
  <Step title="İli bulun">
    ```bash theme={null}
    curl "https://api.noyax.com/api/v1/definitions/cities" \
      -H "Authorization: Bearer ACCESS_TOKEN" -H "X-UserID: 12" -H "X-CompanyID: 3"
    ```
  </Step>

  <Step title="İlçeyi bulun">
    ```bash theme={null}
    curl "https://api.noyax.com/api/v1/definitions/districts?cityId=IL_ID&search=Kadıköy" \
      -H "Authorization: Bearer ACCESS_TOKEN" -H "X-UserID: 12" -H "X-CompanyID: 3"
    ```
  </Step>

  <Step title="Adreste kullanın">
    Dönen ilçenin `Id` değerini adresin `DistrictId` alanına yazın.
  </Step>
</Steps>

## Bilinmesi gerekenler

* **Tanımlar şirket bazlıdır.** Listeler `X-CompanyID` ile gönderilen şirketin kayıtlarını döner. Bir şirketin ID'si başka bir şirkette kullanılamaz.
* **Yetki:** `/definitions` altındaki listeler her geçerli API anahtarıyla okunabilir. Ülke, il, ilçe ve sevkiyat tanımı eklemek, güncellemek ya da silmek için anahtarın **herhangi bir modülde yazma yetkisi** olmalıdır. Cari tanımları (`/customers/groups`, `/customers/parameter-definitions`) cari okuma yetkisi ister.
* **Önbelleğe alın.** Tanımlar nadiren değişir. Her kayıt öncesinde tekrar sorgulamak yerine kendi tarafınızda saklayıp örneğin günde bir kez yenileyin; [günlük istek limitinizi](/tr/v1/guides/rate-limits) korur.

## Yazma kuralları

| Tanım                                                             | Zorunlu                                                                              | Benzersiz          | Silinemez, eğer                                        |
| ----------------------------------------------------------------- | ------------------------------------------------------------------------------------ | ------------------ | ------------------------------------------------------ |
| [Ülke](/tr/v1/definitions/countries/create)                       | `Name`                                                                               | Şirkette ad        | Silinmemiş ili varsa                                   |
| [İl](/tr/v1/definitions/cities/create)                            | `CountryId`, `Name`                                                                  | Ülkede ad          | Silinmemiş ilçesi varsa                                |
| [İlçe](/tr/v1/definitions/districts/create)                       | `CityId`, `Name`                                                                     | İlde ad            | Bir cari adresinde kullanılıyorsa                      |
| [Birim](/tr/v1/definitions/units/create)                          | `Name`                                                                               | Şirkette ad        | Bir üründe ana birimse                                 |
| [Döviz](/tr/v1/definitions/currencies/create)                     | `Name`, `Code`                                                                       | Şirkette ad ve kod | Varsayılansa ya da herhangi bir kayıtta kullanılıyorsa |
| [Sevkiyat tanımı](/tr/v1/definitions/shipment-definitions/create) | `Code`, `TransportMode` (1-4), `TransportInfo1`; taşıyıcı firma ya da sürücü bilgisi | Şirkette kod       | Bir caride kullanılıyorsa                              |

KDV oranları ve cari tanımları API üzerinden yalnızca okunur. Güncellemeler tam değiştirme şeklinde çalışır; gönderilmeyen alanlar temizlenir.