Ana içeriğe atla
POST
Bu çağrı kayıt değiştirir. Idempotency-Key zorunludur. Zaman aşımından sonra yeni anahtarla tekrar başlatmadan işlem durumunu okuyun.

Ne yapar?

collection tahsilat, disbursement verilen ödeme kaydeder. Gerçek banka/POS para transferi başlatmaz. allocations boşsa avans kalır; doluysa belirtilen belgelere tam/kısmi dağıtılır. Aynı cari, yön, para birimi ve kur zorunludur.

Ön koşullar ve izin

Gereken izin: muhasip:payments:write. Bu kaynak için açık izin tanımlanmalıdır; genel erişim veya yönetici yetkisi bu iznin yerine geçmez. İlişkili bütün kimlikler aynı firma kapsamında olmalıdır. Yeni mali kayıt için kullanılan cari, kasa veya hesap aktif olmalıdır. Ürün/depo kimlikleri verilirse geçerli, aynı firmaya ait ve yeni işlem için aktif olmalıdır. Kimlik ve izinler · Muhasebe veri kuralları

İstek örnekleri

Kimlikleri kendi kayıtlarınızla değiştirin. Yazmada iş niyetine özel anahtarı istekten önce saklayın; örnek anahtarını farklı işler için yeniden kullanmayın. Alan ve cevap tanımları bu sayfanın API referansında yer alır.

Cevabı değerlendirin

Aşağıdaki cevap temsilîdir.
İlk başarılı çağrı result ile kayıt sonucunu ve operation ile makbuzu döndürür. Aynı iş anahtarıyla tamamlanmış tekrar 200 ve replayed:true döndürür; ilk ayrıntı gövdesi tekrarlanmaz. Sonuç kimliğiyle ilgili okuma ucunu kullanın. reviewRequired:true sonucunu başarılı mali işlem kabul etmeyin.

Hata durumunda

Hata yönetimi · İşlem takibi 409 ALLOCATION_ROUNDING_MISMATCH: yerel para ve TRY açık tutarı birlikte kapanmıyor. Mevcut ödeme dağılımlarını inceleyin; yuvarlama farkını fazla tahsilatla kapatmayın.

Sonraki adım

Ödeme ve mahsuplaşma akışını izleyin. Dönen kimlikleri ve version değerini saklayın; mali yazma sonrasında ilgili belge ve cari bakiyesini okuyun.

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.

Başlıklar

Idempotency-Key
string
gerekli

Her yeni iş niyeti için kalıcı, farklı anahtar. Aynı anahtar+işlem+firma ve farklı içerik 409 üretir; tamamlanmış tekrar 200 replay makbuzu döner.

Required string length: 1 - 128
Pattern: ^[!-~]+$

Gövde

application/json

allocations gönderilmezse ödeme avans olarak kalır; otomatik mahsuplaşmaz. Aktif nakit/banka hesabı, aynı para birimi ve cari gerekir.

contactId
string
gerekli

24 karakterli kayıt kimliği.

Pattern: ^[a-f0-9A-F]{24}$
accountId
string
gerekli

24 karakterli kayıt kimliği.

Pattern: ^[a-f0-9A-F]{24}$
direction
enum<string>
gerekli

collection tahsilat/kasa girişi, disbursement ödeme/kasa çıkışıdır.

Mevcut seçenekler:
collection,
disbursement
paymentDate
string<date>
gerekli

YYYY-MM-DD; 1900-01-01–2199-12-31. Saat gönderilmez.

amount
gerekli

Pozitif ödeme tutarı; hesabın para biriminde.

Gerekli aralık: 0 < x <= 999999999.99Şunun katı olmalıdır 0.01
currencyCode
enum<string>

İşlem para birimi. Uygulama tutar hassasiyeti bütün bu birimlerde 2 basamaktır.

Mevcut seçenekler:
TRY,
USD,
EUR,
GBP,
CHF,
CAD,
AUD,
JPY,
CNY,
AED,
SAR,
RUB,
DKK,
NOK,
SEK
exchangeRate

1 birim dövizin TRY karşılığı; pozitif, en fazla 6 basamak. TRY için 1; diğer para birimlerinde zorunlu.

Gerekli aralık: 0 < x <= 999999.999999Şunun katı olmalıdır 0.000001
description
string
Maximum string length: 2000
receiptNumber
string
Maximum string length: 100
allocations
object[]
Maximum array length: 100

Yanıt

Aynı anahtarla daha önce tamamlanan işlem; ilk ayrıntı gövdesi yerine güvenli sonuç kimlikleri.

status
boolean
gerekli
replayed
enum<boolean>
gerekli
Mevcut seçenekler:
true
operation
object
gerekli
operations
object[]
gerekli
resultId
string
transactionId
string
uuid
string
id
string
providerId
string
documentId
string
paymentId
string
orderId
string
uuids
string[]
sourcePaymentId
string

24 karakterli kayıt kimliği.

Pattern: ^[a-f0-9A-F]{24}$
destinationPaymentId
string

24 karakterli kayıt kimliği.

Pattern: ^[a-f0-9A-F]{24}$