Ana içeriğe geç

Müstahsil Gönderim - Send CreditNote (JSON)

POST https://webservis.ekupbilisim.com/api/outsource/credit-note/send-json
Bu, canlı tabandır. Geliştirme ve entegrasyon testleri için /api/outsource-test tabanını kullanın — bkz. Test Ortamı / Sandbox.

JSON formatında müstahsil gönderim işlemleri için gerekli olan API uç noktası. Bu uç nokta, UBL yapısına uygun JSON verilerini alır, XML'e dönüştürür, sisteme kaydeder ve GİB'e gönderir.

ipucu

XML oluşturmaya gerek kalmadan doğrudan JSON verileriyle müstahsil gönderebilirsiniz. Sistem, JSON'u otomatik olarak UBL-TR CreditNote formatına dönüştürür.

Üst Bilgi (Header) Parametreleri​

Authorization string required
Bearer token ile kimlik doğrulama yapılmalıdır.

JSON Parametreleri​

receiver_alias string
Özel bir etikete gönderilmek isteniyorsa kullanılır. Sistem otomatik ilk sıradakine gönderir
ProfileID string required
Belge profili. Örn: EARSIVBELGE
DocumentCurrencyCode string required
Para birimi kodu. Örn: TRY, USD, EUR
IssueDate string required
Müstahsil düzenleme tarihi. YYYY-MM-DD formatında
AccountingSupplierParty object required
Satıcı bilgileri. UBL-TR AccountingSupplierParty yapısına uygun JSON nesnesi
AccountingCustomerParty object required
Alıcı bilgileri. UBL-TR AccountingCustomerParty yapısına uygun JSON nesnesi
bilgi

Yukarıda listelenmemiş tüm UBL-TR alanları opsiyonel olarak gönderilebilir. Detaylı alan listesi için GİB UBL-TR kılavuzlarına bakınız.

Cevaplar ( Responses )​

200
OK
{
        "error": 0,
        "message": "İşlem başarıyla tamamlandı",
        "extra": {
          "id": "01k1x8rykgcnjv07zgf8h07sey",
          "envelopeId": "32a0fa61-1aa9-47ef-123d-30f72e326369",
          "signedXml": [
            "base64"
          ]
        }
      }
422
İş Kuralı Hatası — Gönderici Etiketi
{
"error": 1,
"message": "Gönderici etiketi bulunamadı."
}
422
İş Kuralı Hatası — İçerik
{
"error": 1,
"message": "XML içerisinde zorunlu alan bulunamadı: :field"
}
422
İş Kuralı Hatası — İmza Doğrulama
{
"error": 1,
"message": "Belge imzalandı ancak doğrulama başarısız."
}
401
Unauthorized
{
  "error": 1,
  "message": "e-Posta veya şifre hatalı."
}
404
Not Found
{
  "error": 1,
  "message": "The route api/outsource/auth/login1 could not be found."
}
500
Server Error
{
  "error": 1,
  "message": "Sunucu Hatası"
}

Örnek İstek ( Curl )​


curl -X POST --location 'https://webservis.ekupbilisim.com/api/outsource-test/credit-note/send-json' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: ••••••' \
--data '{
"ProfileID": "EARSIVBELGE",
"DocumentCurrencyCode": "TRY",
"IssueDate": "2025-01-15",
"AccountingSupplierParty": {
"Party": {
"PartyIdentification": [{"ID": {"@schemeID": "VKN", "Value": "1234567890"}}],
"PartyName": {"Name": "Satıcı Firma Ünvanı"},
"PostalAddress": {
"CitySubdivisionName": "İlçe",
"CityName": "İl",
"Country": {"Name": "Türkiye"}
}
}
},
"AccountingCustomerParty": {
"Party": {
"PartyIdentification": [{"ID": {"@schemeID": "VKN", "Value": "0987654321"}}],
"PartyName": {"Name": "Alıcı Firma Ünvanı"},
"PostalAddress": {
"CitySubdivisionName": "İlçe",
"CityName": "İl",
"Country": {"Name": "Türkiye"}
}
}
},
"CreditNoteLine": [
{
"ID": "1",
"CreditedQuantity": {"@unitCode": "C62", "Value": "1"},
"LineExtensionAmount": {"@currencyID": "TRY", "Value": "100.00"},
"Item": {"Name": "Ürün Adı"},
"Price": {"PriceAmount": {"@currencyID": "TRY", "Value": "100.00"}}
}
]
}'