Ana içeriğe atla
PATCH
Linki kısmi güncelle
Gövdede yalnızca değiştirmek istediğiniz alanları gönderirsiniz; gönderilmeyen alanlar mevcut değerleriyle kalır. Kural ve örnekler: kısmi güncelleme.
  • Gönderilmeyen alan değişmez, null gönderilen alan temizlenir.
  • Doğrulama birleştirilmiş kaydın tamamı üzerinde çalışır; zorunlu bir alanı null yaparsanız istek reddedilir.

Hata kodları

Bu endpoint’in dönebileceği kodlar. Her endpoint için geçerli olan genel hatalar (kimlik doğrulama, yetki, istek header’ları, istek limitleri) burada tekrarlanmaz.

Yetkilendirmeler

Authorization
string
header
gerekli

Access token obtained from the Noyax auth service with your API key.

Başlıklar

X-UserID
integer<int32>
gerekli

İsteğin adına yapıldığı Noyax kullanıcısının ID'si. Oluşturulan, güncellenen ve silinen kayıtların denetim alanlarına yazılır.

Gerekli aralık: x >= 1
X-CompanyID
integer<int32>
gerekli

Şirketin ID'si. Kullanıcı bu şirkete tanımlı olmalıdır. Bütün okuma ve yazma işlemleri bu şirketle sınırlıdır.

Gerekli aralık: x >= 1
X-PeriodID
integer<int32>

Muhasebe döneminin ID'si. İsteğe bağlıdır; gönderilirse oluşturulan kayıtlara yazılır.

Gerekli aralık: x >= 1

Yol Parametreleri

customerId
string<uuid>
gerekli

Cari ID'si.

Link ID'si.

Gövde

Value
null | string

Zorunlu. E-posta adresi ya da URL. LinkType 1 ise geçerli bir e-posta adresi olmalıdır.

0: Diğer, 1: E-posta, 2: Web sitesi, 3: LinkedIn, 4: Instagram, 5: X.

Örnek:

1

Description
null | string

Açıklama.

Örnek:

"Invoices"

Yanıt

OK

Success
boolean
gerekli

İşlemin başarılı olup olmadığı.

Örnek:

true

ResultCode
string
gerekli

Başarıda "0000". Hatada ilk hatanın kodu; hataların tamamı Errors içinde listelenir.

Örnek:

"0000"

Data
object
gerekli
Message
null | string

Success false olduğunda hata mesajı. Bütün hataların mesajları tek metinde birleştirilir.