Skip to navigation

Revise Premium

Teklif Primini Revize Et

Endpoint Bilgileri

AlanDeğer
MethodPUT
URL{{baseUrl}}/api/Offline/jobs/{jobId}/Premiums/revise
Content-Typeapplication/json
YetkilendirmeBearer Token + Update politikası

Acentenin açtığı teklif revize talebine karşılık, sigorta şirketinin revize teklif primlerini iletmesi için kullanılır.

Başarılı istekte önceki primlerin yerine yeni prim seçenekleri ve taksit detayları (taksit komisyonu dahil) kaydedilir, primler platform servisine yazılır, iş Teklif Revize Talebi Gerçekleşti (PremiumRevised) aşamasına geçer, aksiyon kaydı oluşturulup platforma iletilir ve gönderilen PDF’ler asenkron olarak kaydedilir.

İşin aşaması Teklif Revize Talebi (PremiumReviseRequested) olmalıdır; aksi halde geçiş reddedilir.


Route Parametreleri

ParametreTipZorunluAçıklama
jobIdintegerEvetRevize teklif primlerinin kaydedileceği işin Id bilgisi

Kimlik Doğrulama

Geçerli bir bearer token gerektirir. Token şunları içermelidir:

  • Tanınan bir rol (InsuranceCompanyAPIUser, InsuranceCompanyAPIAdmin veya Supervizor)
  • İlgili route için Update yetkisi
  • Geçerli bir sigorta şirketi ataması
  • Çözümlenebilir bir kullanıcı kimliği

InsuranceCompanyAPIUser yalnızca kendi sahibi olduğu işleri işleyebilir. InsuranceCompanyAPIAdmin ve Supervizor için iş sahipliği kontrolü yapılmaz.


İstek Modeli — RevisePremiumRequest

AlanTipZorunluAçıklamaDoğrulama
InsuranceCompanyProposalNumberstringEvetSigorta şirketi teklif numarasıBoş olamaz: "Insurance company proposal number is required."
RenewalNumberintegerEvetYenileme numarasıZorunlu: "Renewal number is required."
0’dan büyük veya eşit olmalı: "Renewal number must be greater than or equal to 0."
ProductIdintegerEvetTeklifin verildiği ürün IdZorunlu: "Product ID is required."
MessagestringHayırTeklife iliştirilen notMaks. 500 karakter: "Message cannot exceed 500 characters."
OfferPdfPremiumFileRequestHayırTeklif PDF’iGönderilirse PremiumFileRequest doğrulamaları uygulanır
InformationPdfPremiumFileRequestHayırBilgilendirme formu PDF’iGönderilirse PremiumFileRequest doğrulamaları uygulanır
PremiumsPremiumEntryRequest[]EvetPrim seçenekleriZorunlu: "Premium list is required."
Boş olamaz: "Premium list cannot be empty."
Tekil olmalı: "Duplicate premium entries are not allowed for the same installment, payment type, and installment option."

JobId gövdeden alınmaz ([JsonIgnore]); route parametresinden set edilir. Bu uçta JobId için ayrı bir doğrulama kuralı tanımlı değildir; route kısıtı ({jobId:int}) yeterlidir.

Tekillik kuralı: Aynı IsInstallmentsEqual + PaymentOptionType + InstallmentNumber kombinasyonuna sahip birden fazla prim seçeneği gönderilemez.

Prim Seçeneği — PremiumEntryRequest

AlanTipZorunluAçıklamaDoğrulama
PaymentOptionTypeintegerEvetÖdeme tipiZorunlu: "PaymentOptionType is required."
Tanımlı bir değer olmalı: "PaymentOptionType must be a valid payment type."
CurrencyTypeintegerEvetPara birimiZorunlu: "CurrencyType is required."
Tanımlı bir değer olmalı: "CurrencyType must be a valid currency type."
IsInstallmentsEqualbooleanEvetTaksitler eşit tutarlı mı?—
FirstInstallmentRateintegerHayırİlk taksit oranı (%)Gönderilirse 1–100 arasında olmalı: "FirstInstallmentRate must be between 1 and 100."
InstallmentNumberintegerEvetTaksit sayısıZorunlu: "InstallmentNumber is required."
0’dan büyük olmalı: "InstallmentNumber must be greater than 0."
GrossPremiumdecimalEvetBrüt prim (işlem para biriminde)Zorunlu: "GrossPremium is required."
0’dan büyük olmalı: "GrossPremium must be greater than 0."
NetPremiumdecimalEvetNet prim (işlem para biriminde)Zorunlu: "NetPremium is required."
0’dan büyük olmalı: "NetPremium must be greater than 0."
CommissiondecimalEvetKomisyon (işlem para biriminde)Zorunlu: "Commission is required."
0’dan büyük veya eşit olmalı: "Commission must be greater than or equal to 0."
ExchangeRatedecimalKoşulluİşlem para biriminin TL kuruCurrencyType TL değilse zorunlu: "ExchangeRate is required when CurrencyType is not TL."
0’dan büyük olmalı: "ExchangeRate must be greater than 0."
InstallmentExplanationstringHayırTaksit açıklaması—
PremiumInstallmentDetailsPremiumInstallmentDetailRequest[]KoşulluTaksit detaylarıInstallmentNumber 1’den büyükse zorunlu: "Premium installment details are required when InstallmentNumber is greater than 1."
Boş olamaz: "Premium installment details cannot be empty when InstallmentNumber is greater than 1."

TL karşılığı alanlar: Bu uçta TL karşılığı alan (GrossPremiumTL, CommissionTL vb.) bulunmaz. Tutarlar işlem para biriminde ve ExchangeRate ile gönderilir; TL karşılığı tutar × ExchangeRate ile hesaplanır. Bu alanlar gövdede gönderilirse yok sayılır, hata dönülmez.

Taksit Detayı — PremiumInstallmentDetailRequest

AlanTipZorunluAçıklamaDoğrulama
InstallmentNumberintegerEvetToplam taksit sayısıZorunlu: "InstallmentNumber is required"
0’dan büyük olmalı: "InstallmentNumber must be greater than 0."
InstallmentNointegerEvetTaksit sıra numarasıZorunlu: "InstallmentNo is required"
0’dan büyük olmalı: "InstallmentNo must be greater than 0."
PaymentAmountdecimalEvetTaksit tutarıZorunlu: "PaymentAmount is required"
0’dan büyük olmalı: "PaymentAmount must be greater than 0."
CommissiondecimalEvetTaksit komisyonuZorunlu: "Commission is required."
0’dan büyük veya eşit olmalı: "Commission must be greater than or equal to 0."
PaymentDatedatetimeEvetÖdeme tarihiZorunlu: "PaymentDate is required"
Boş olamaz: "PaymentDate must not be empty."

Taksit komisyonu (Commission) taksit detayıyla birlikte kaydedilir ve prim bilgileri okunurken dolu döner.

Ödeme Tipi Değerleri

DeğerÖdeme Tipi
1Hesaptan
2Kredi Kartı
3Tümü

Para Birimi Değerleri

DeğerPara Birimi
1TL
2Dolar
3Euro
4İngiliz Sterlini
5Japon Yeni
6İsviçre Frangı
7İsveç Kronu

PDF Dosyası — PremiumFileRequest

AlanTipZorunluAçıklamaDoğrulama
FileNamestringEvet*Dosya adıBoş olamaz: "FileName must not be empty."
.pdf ile bitmeli: "Only PDF files are allowed."
Base64ContentstringEvet*Base64 kodlu dosya içeriğiBoş olamaz: "Base64Content must not be empty."
Geçerli base64 olmalı: "Base64Content must be a valid base64 encoded string."
İçerik geçerli bir PDF olmalı: "File content is not a valid PDF."
ContentTypestringHayırMIME türüDoğrulanmaz

* Bu alanlar yalnızca OfferPdf veya InformationPdf gönderildiğinde doğrulanır.


İş Kuralları

State geçişi sırasında sırasıyla aşağıdaki kontroller yapılır:

  1. İş Teklif Revize Talebi aşamasında olmalıdır.
  2. İşe ait teklif (Proposal) kaydı bulunmalıdır.
  3. Teklife ait poliçe bulunmamalıdır.
  4. Teklif + ürün için OperationWatch kaydı bulunmalıdır.
  5. Primler platform servisine yazılabilmelidir.
  6. Aksiyonu karşılayacak platform kullanıcısı bulunmalı ve aksiyon platforma iletilebilmelidir.

Geri alma davranışı: 5. kural başarısız olursa yeni primler silinir, önceki primler geri yüklenir, OperationWatch başarısız işaretlenir ve iş Teklif Revize Talebi aşamasına geri döndürülür. 6. kuralda aksiyon platforma iletilemezse oluşturulan aksiyon kaydı silinir.

Bu uçta iş kuralı hatalarının tamamı OfflinePremium.StateTransitionFailed koduyla döner; Message alanı hatanın detayını içerir.


Yanıt

204 No Content — Başarılı Yanıt

Gövde boştur.


Hata Senaryoları

400 Bad Request — Doğrulama Hatası

İstek modeli doğrulamadan geçemediğinde döner. Hatalı alanlar Response içinde listelenir.

{
"Status": false,
"Code": "Validation.General",
"Message": "One or more validation errors occurred",
"Response": [
{
"Field": "Premiums[0].GrossPremium",
"Message": "GrossPremium must be greater than 0."
},
{
"Field": "Premiums[0].Commission",
"Message": "Commission is required."
},
{
"Field": "Premiums[0].PaymentOptionType",
"Message": "PaymentOptionType must be a valid payment type."
},
{
"Field": "Premiums[0].CurrencyType",
"Message": "CurrencyType must be a valid currency type."
},
{
"Field": "Premiums[0].ExchangeRate",
"Message": "ExchangeRate is required when CurrencyType is not TL."
},
{
"Field": "Premiums[0].PremiumInstallmentDetails[0].PaymentAmount",
"Message": "PaymentAmount must be greater than 0."
},
{
"Field": "Premiums[0].PremiumInstallmentDetails[0].Commission",
"Message": "Commission is required."
}
]
}

403 Forbidden — Geçerli Sigorta Şirketi Ataması Bulunamadı

Token’da geçerli bir sigorta şirketi ataması bulunmadığında döner.

{
"Status": false,
"Code": "OfflineUsers.InsuranceCompanyNotFound",
"Message": "No valid insurance company assignment found in token.",
"Response": null
}

403 Forbidden — Kullanıcı Kimliği Çözümlenemedi

Token’dan kullanıcı kimliği okunamadığında döner.

{
"Status": false,
"Code": "OfflineUsers.UserIdentityNotResolved",
"Message": "User identity could not be resolved from token.",
"Response": null
}

403 Forbidden — İşe Erişim Reddedildi

İş, çağıranın sahipliğinde değilse döner.

{
"Status": false,
"Code": "OfflineJobs.JobOwnershipDenied",
"Message": "You do not have permission to access this job.",
"Response": null
}

403 Forbidden — Rol veya Yetki Yetersiz

Kullanıcı tanınan rollerden birine sahip değilse ya da Update yetkisi yoksa döner. Gövde boştur.


401 Unauthorized — Token Yok veya Geçersiz

Token gönderilmediğinde, geçersiz olduğunda veya süresi dolduğunda döner. Gövde boştur.


404 Not Found — İş Bulunamadı

Belirtilen jobId ile bir iş bulunamadığında döner.

{
"Status": false,
"Code": "OfflineJobs.JobNotFound",
"Message": "No job found for the requested JobId: 999999999.",
"Response": null
}

500 Internal Server Error — İş Kuralı İhlali

Yukarıdaki iş kurallarından biri sağlanmadığında döner. Message alanı Premium revision state transition failed: ön ekiyle hatanın detayını içerir:

DurumDetay
Geçersiz aşama'Prim İsteği' aşamasından 'Teklif Revize Talebi Gerçekleşti' aşamasına geçiş yapılamaz. ...
Teklif kaydı yok100931 nolu iş için teklif kaydı bulunamadı!
Teklife ait poliçe var100931 nolu iş için 538561 nolu teklife ait poliçe bilgisi mevcuttur! Teklif girişi yapamazsınız.
Operation Watch yok100931 nolu iş için operation watch kaydı bulunamadı!
Platform servisi hatasıPrim bilgileri platform servisine yazdırılamadı! Servisten dönen hata: ...
Platform kullanıcısı yokİş(100931) için aksiyonu karşılayacak kullanıcı bulunamadı! Aksiyon kaydedilemiyor.
Aksiyon iletilemediAksiyon bilgileri platforma iletilemedi! Hata Mesajı: ...
{
"Status": false,
"Code": "OfflinePremium.StateTransitionFailed",
"Message": "Premium revision state transition failed: 100931 nolu iş için operation watch kaydı bulunamadı!",
"Response": null
}

500 Internal Server Error — Beklenmeyen Hata

Geçiş sırasında iş kuralı dışında bir hata oluştuğunda döner.

{
"Status": false,
"Code": "JobState.TransitionError",
"Message": "An unexpected error occurred during job state transition.",
"Response": null
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

jobIdstringRequired

Request

This endpoint expects an object.

Response

No Content

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error