İstek header'ları

Token hangi kuruluşa eriştiğinizi belirler. Hangi kullanıcı adına ve hangi şirkette işlem yaptığınızı ise header’larla belirtirsiniz.

integer

gerekli

İşlemi yapan Noyax kullanıcısının ID’si. Kullanıcı silinmemiş olmalıdır. Oluşturma, güncelleme ve silme kayıtlarında bu kullanıcı işlemi yapan kişi olarak görünür. Kullanıcının paylaşım kodları hangi kayıtları görebileceğini belirler.

integer

gerekli

İşlem yapılan şirketin ID’si. Kullanıcı bu şirkete tanımlı olmalıdır. Tüm okuma işlemleri bu şirketle sınırlıdır ve yeni kayıtlar bu şirkete yazılır.

integer

Muhasebe döneminin ID’si. Cari endpoint’lerinde isteğe bağlıdır; gönderilirse yeni kayıtlara yazılır. Muhasebe endpoint’lerinde zorunlu olacaktır.

Doğrulama kuralları

Değerler 0’dan büyük tam sayı olmalıdır. İsteğe bağlı X-PeriodID de gönderildiyse bu kurala uymalıdır; geçersiz değerler yok sayılmaz.
Header hatalarının hepsi tek yanıtta, 400 ile döner:

{
  "Success": false,
  "ResultCode": "0201",
  "Message": "X-UserID header is required. X-CompanyID header must be an integer greater than 0. Received: 'abc'.",
  "Errors": [
    { "Code": "0201", "Message": "X-UserID header is required." },
    { "Code": "0204", "Message": "X-CompanyID header must be an integer greater than 0. Received: 'abc'." }
  ]
}

Kod	Mesaj	Sebep
`0201` / `0203`	`X-UserID header is required.`	Zorunlu header gönderilmedi
`0202` / `0204` / `0205`	`... must be an integer greater than 0.`	Değer sayı değil ya da 0 veya negatif
`0210`	`User not found.`	Kullanıcı yok ya da silinmiş
`0211`	`Company not found or the user has no access to this company.`	Şirket yok, silinmiş ya da kullanıcı bu şirkete tanımlı değil

Kullanıcı ve şirket doğrulaması önbellekte tutulur. Noyax tarafında kullanıcının şirket tanımı ya da paylaşım kodları değiştiyse değişikliğin API’ye yansıması 30 dakikayı bulabilir.

Başlarken

Temel kavramlar

Modüller

Sürüm notları

İstek header'ları

Doğrulama kuralları

​Doğrulama kuralları

Doğrulama kuralları