API
Request → UBL XML Mapping
Entegratörün gönderdiği JSON alanlarının UBL Invoice XML'deki karşılığını gösteren referans tablo.
Mapping Kapsamı
Kısa kural: Entegratör üç farklı gövde formatından birini gönderebilir: JSON (
AddOutgoingInvoice), platformun düz XML modeli (AddOutgoingInvoiceByXml) veya UBL-TR Invoice belgesi (AddOutgoingInvoiceByUbl). Bir model alanının UBL standardında tanımlanması ile platformun UBL girişinde o alanı okuması ayrı sözleşmelerdir; aşağıdaki tablo platformun gözlenebilir dönüşümünü gösterir.Referans Tablo
| JSON/Model Alanı | Gerçek UBL Invoice XML Karşılığı | Not |
|---|---|---|
ProfileId | cbc:ProfileID | Belgenin e-Arşiv profilini taşır. |
InvoiceTypeCode | cbc:InvoiceTypeCode | Satış, iade veya istisna gibi fatura tipini taşır. |
IssueDate | cbc:IssueDate ve cbc:IssueTime | Request tarih-zamanı UBL'de tarih ve saat olarak ayrılır. |
DocumentCurrencyCode | cbc:DocumentCurrencyCode | Belge tutarlarının para birimini belirler. |
AccountingSupplierParty | cac:AccountingSupplierParty | Faturayı düzenleyen tarafın kimlik ve adres bilgilerini taşır. |
AccountingCustomerParty | cac:AccountingCustomerParty | Alıcının kimlik ve adres bilgilerini taşır. |
AllowanceCharge[] | cac:AllowanceCharge | Belge seviyesindeki indirim ve artırımları taşır. |
TaxTotal[] | cac:TaxTotal | Belge seviyesindeki vergi toplamlarını taşır. |
LegalMonetaryTotal | cac:LegalMonetaryTotal | Vergi hariç, vergi dahil ve ödenecek toplamları taşır. |
InvoiceLine[] | cac:InvoiceLine | Her fatura kalemi kendi miktar, fiyat, vergi ve mal/hizmet bilgisiyle aktarılır. |
BillingReference[] | cac:BillingReference | ÖKC, iade ve önceki belge referanslarını taşır. |
Delivery[] | cac:Delivery | Teslim tarihi, adresi, tarafı ve teslim koşullarını taşır. |
PaymentMeans[] | cac:PaymentMeans | Ödeme yöntemini ve ilgili ödeme bilgilerini taşır. |
WithholdingTaxTotal[] | cac:WithholdingTaxTotal | Tevkifat toplamlarını belge seviyesinde taşır. |
InternetPayment | Platformun UBL girişinden request modeline aktarılmaz. | İnternet satışı alanları JSON veya platformun düz XML modeliyle gönderilmelidir. |
İnternet satışı alanlarının giriş biçimi: Platformun UBL giriş işlemi
InternetPayment alanını request modeline aktarmaz. Bu bilgileri gönderecek entegratörler JSON (AddOutgoingInvoice) veya platformun düz XML modelini (AddOutgoingInvoiceByXml) kullanmalıdır. Düz XML biçimi platform model alanlarını kullanır; UBL cac:/cbc: isim alanlarıyla karıştırılmamalıdır.Uygulama Notları
ÖKC referansı gönderilirken DocumentTypeCode alanının literal olarak OKCBF, DocumentType alanının literal olarak OKCBilgiFisi değerini taşıması zorunludur; bu ikisi ve Id/IssueDate/DocumentDescription/Attachment./IssuerParty./ValidityPeriod. alanlarından herhangi biri eksik veya uyumsuzsa istek "SCHEME" koduyla reddedilir (bkz. Teknik Referans — Katman A). İnternet satışı senaryosunda faturanın Note alanına "Bu satış internet üzerinden yapılmıştır." ibaresinin eklenmesi VUK 509 md. IV.2.4.5 gereğidir; bu ibare için UBL tarafında ayrı bir zorunlu eleman yoktur, serbest metin olarak cbc:Note'a taşınır.