Ana içeriğe atla
PUT

Ne yapar?

Firma iş akışını günceller. title zorunludur; slug başlıktan yeniden üretilir. usersId aktif firma üyeleri olmalıdır; null boş diziye dönüşür. Eksik/yabancı 404; icon boşsa varsayılan uygulanır. Bağlı öznitelikler otomatik değiştirilmez.

Ön koşullar ve izin

Etkin API anahtarı ve muhasip:bank:write izni gerekir. İlişkili kayıtlar aynı firmaya ait olmalıdır. Erişim ayarları için kimlik ve izinler rehberini inceleyin. İstek ve cevap şemalarını indirin.

İstek örnekleri

Örnekler temsilîdir. Kimlikleri, belge tarihlerini ve iş verisini kendi yetkili kayıtlarınızla değiştirin. Node.js örnekleri Node.js 20 veya üzeri içindir; PHP örnekleri cURL uzantısını kullanır. Hiçbiri otomatik tekrar yapmaz.

Cevabı değerlendirin

Önce HTTP durumunu, ardından bu kaynağın status ve sonuç alanlarını değerlendirin. Bütün uçlar aynı sonuç zarfını veya oluşturma için 201 kodunu kullanmaz. Temsilî başarılı cevap; gerçek hizmet çağrısından alınmamıştır:

Hata durumunda

Ağ kesintisi, zaman aşımı veya JSON olmayan cevap mali etkinin oluşmadığını kanıtlamaz. Ham istek/cevapları genel loglara yazmayın. Hata yönetimi

Sonraki adım

İlgili liste veya detay çağrısıyla kaydı ve bağlı iş sonucunu doğrulayın. Fiziksel silme, arşiv ve mali iptali ayrı değerlendirin. Kaynak akışı · İşlem takibi · Kapsam ve sınırlamalar

Yetkilendirmeler

Authorization
string
header
gerekli

Kullanıcı adı apiUserId, parola secretKey. Aktif ve süresi geçmemiş API kullanıcısı ve uygun firma gerekir.

Yol Parametreleri

id
string
gerekli

İşlem yapılacak kayıt kimliği. 24 haneli kayıt kimliği; firma API kimliğinden belirlenir.

Pattern: ^[a-fA-F0-9]{24}$

Gövde

application/json
title
string
gerekli
Required string length: 1 - 300
status
boolean
usersId
string[] | null
Maximum array length: 250

24 karakterli Muhasip kayıt kimliği.

Pattern: ^[a-fA-F0-9]{24}$
description
string | null
Maximum string length: 5000
icon
string | null
varsayılan:i-tabler-user-screen
Maximum string length: 100

Yanıt

İşlem tamamlandı. Örnek değerler temsilîdir.

status
boolean
gerekli
result
object
gerekli

İşleme göre yalnız ilgili sayımlar bulunur. matchedCount eşleşen, modifiedCount değişen, deletedCount silinen kayıt sayısıdır.