Ana içeriğe atla
PATCH

Ne yapar?

id gönderilmezse otomasyon taslağı oluşturur; gönderilirse ilgili kaydı günceller. Çalışmakta olan otomasyon için 409 döner. Tek invoice aksiyonu desteklenir. Etkinleştirme için en az bir TRY banka hesabı, etkin fatura bağlantısı, seri, belge şablonu, alıcı adresi ve toplamı yüzde 100 olan satır oranları gerekir. settings ve actions gönderildiğinde mevcut değerleri bütünüyle değiştirir. Kaydetme isteği otomasyonu çalıştırmaz; çalıştırma ve sonuç takibi ayrı işlemlerdir.

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

Gövde

application/json

id yoksa yeni taslak, varsa firma kaydı güncellenir; yeni kayıtta actions zorunludur. Gönderilen settings/actions nesneleri bütün olarak değiştirilir. Aktif durumda hesap, tam fatura ayarları ve oran toplamı 100 gerekir.

title
string
gerekli
Required string length: 1 - 300
id
string

24 karakterli Muhasip kayıt kimliği.

Pattern: ^[a-fA-F0-9]{24}$
description
string | null
Maximum string length: 5000
status
enum<string>

Yeni kayıtta verilmezse draft.

Mevcut seçenekler:
active,
draft,
archive
template
enum<string>

Yeni kayıtta bankInvoice.

Mevcut seçenekler:
bankInvoice
type
enum<string>

Yeni kayıtta integration.

Mevcut seçenekler:
integration,
manuel
integration
enum<string>

Yeni kayıtta bank.

Mevcut seçenekler:
bank
settings
object
actions
object[]
Required array length: 1 element

Yanıt

İşlem cevabı; örnek 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.