Ana içeriğe atla
POST
Teklif oluştur
Teklif, satırları ve satırların indirimleri tek transaction’da yazılır: herhangi biri geçersizse hiçbiri kaydedilmez, bütün hatalar tek Message’da döner. Satır hataları satır numarasıyla başlar, örneğin Line 2: Quantity must be greater than 0.

Alan kuralları

Zorunlu alanlar, satırlar, durum ve paylaşım.

Hesaplamalar

Tutarlar ve toplamlar nasıl hesaplanır.
API satır tutarlarını hesaplamaz, ama birbirini tuttuğunu denetler (5118); bkz. hesaplamalar. Teklif toplamları ve AverageExchangeRate satırlardan doldurulur. UnitPrice’ı KDV hariç gönderin.
  • QuoteNumber yerine "Next" gönderilirse numara, teklif tipinin numara serisinden üretilir.
  • Teklif 0 (beklemede) durumuyla oluşturulur.
  • Başarılı yanıt 201 Created döner; Location header’ı yeni teklifi gösterir.

Asgari istek

Yalnızca zorunlu alanlarla çalışan bir istek; satır tutarları birbirini tutar (API bunu denetler), başlık toplamları satırlardan doldurulur. Kod ve adları kendi şirketinizdekilerle değiştirin.

Hata kodları

Bu endpoint’in dönebileceği kodlar. Her endpoint için geçerli olan genel hatalar (kimlik doğrulama, yetki, istek header’ları, istek limitleri) burada tekrarlanmaz.

Yetkilendirmeler

Authorization
string
header
gerekli

Access token obtained from the Noyax auth service with your API key.

Başlıklar

X-UserID
integer<int32>
gerekli

İsteğin adına yapıldığı Noyax kullanıcısının ID'si. Oluşturulan, güncellenen ve silinen kayıtların denetim alanlarına yazılır.

Gerekli aralık: x >= 1
X-CompanyID
integer<int32>
gerekli

Şirketin ID'si. Kullanıcı bu şirkete tanımlı olmalıdır. Bütün okuma ve yazma işlemleri bu şirketle sınırlıdır.

Gerekli aralık: x >= 1
X-PeriodID
integer<int32>

Muhasebe döneminin ID'si. İsteğe bağlıdır; gönderilirse oluşturulan kayıtlara yazılır.

Gerekli aralık: x >= 1

Gövde

QuoteType
integer<int32>
gerekli

Zorunlu. 1: Alış teklifi (alınan), 2: Satış teklifi (verilen). Teklif oluşturulduktan sonra değiştirilemez.

Örnek:

2

QuoteNumber
null | string
gerekli

Zorunlu. Teklif numarası, şirkette aynı QuoteType için benzersiz. Oluştururken "Next" gönderilirse şirketin o tip için teklif numarası serisinden üretilir. En fazla 10 karakter.

Örnek:

"TKL0000125"

Date
null | string<date-time>
gerekli

Zorunlu. Teklif tarihi. Tarih kısmı teklif tarihi olarak saklanır; saat gönderilirse teklif saati olarak saklanır, gönderilmezse şimdiki saat kullanılır.

Örnek:

"2026-09-21T10:30:00"

CustomerCode
null | string
gerekli

Zorunlu. Cari kodu (GET /api/v1/customers'taki carinin CustomerCode değeri).

Örnek:

"C-0001"

Lines
object[]
gerekli

Zorunlu, en az bir satır. Güncellemede satırlar değiştirilir: teklifin mevcut satırları kaldırılır, yerine bunlar kaydedilir.

DocumentNumber
null | string

Belge numarası (serbest metin). En fazla 20 karakter.

Örnek:

"2026-15"

Description
null | string

Açıklama. En fazla 1000 karakter.

RepresentativeName
null | string

Carinin bir yetkilisinin adı soyadı (GET /api/v1/customers/{customerId}/representatives'teki FullName). Cariye ait olmalı.

DueDays
integer<int32>

Gün olarak vade. 0'dan küçük olamaz.

Örnek:

30

DeliveryDate
null | string<date>

Teslim tarihi. Yalnızca tarih (yyyy-MM-dd), saat içermez.

Örnek:

"2026-10-15"

SharingCode
null | string

Teklifi kimin görebileceğini sınırlayan paylaşım kodu. Boşsa herkes görebilir; doluysa kullanıcının paylaşım kodlarından biri olmalıdır.

DiscountTotal
number<double>

Toplam indirim: satırların DiscountAmount toplamı. Satırlardan doldurulur; istekte gönderilen değer kullanılmaz.

Örnek:

100

SubTotal
number<double>

Ara toplam: satırların AmountExcludingTax toplamı. Satırlardan doldurulur; istekte gönderilen değer kullanılmaz.

Örnek:

900

VatTotal
number<double>

Tevkifat sonrası toplam KDV: satırların VatAmount toplamından WithholdingTotal düşülür. Satırlardan doldurulur; istekte gönderilen değer kullanılmaz.

Örnek:

225

AdditionalTaxTotal
number<double>

Toplam ek vergi: satırların ek vergi tutarlarının toplamı. Satırlardan doldurulur; istekte gönderilen değer kullanılmaz.

Örnek:

225

WithholdingTotal
number<double>

Toplam tevkif edilen KDV: satırların WithheldVatAmount toplamı. Satırlardan doldurulur; istekte gönderilen değer kullanılmaz.

Örnek:

0

GrandTotal
number<double>

Genel toplam: satırların AmountIncludingTax toplamından WithholdingTotal düşülür. Satırlardan doldurulur; istekte gönderilen değer kullanılmaz.

Örnek:

1350

AverageExchangeRate
number<double>

Ağırlıklı ortalama kur: bütün satırların dövizi aynıysa Σ(AmountExcludingTax × ExchangeRate) / Σ AmountExcludingTax; satırların dövizleri farklıysa 1'dir ve toplamlar her satırın ExchangeRate'iyle varsayılan dövize çevrilir. Satırlardan doldurulur; istekte gönderilen değer kullanılmaz.

Örnek:

1

Yanıt

Created

Success
boolean
gerekli

İşlemin başarılı olup olmadığı.

Örnek:

true

ResultCode
string
gerekli

Başarıda "0000". Hatada ilk hatanın kodu; hataların tamamı Errors içinde listelenir.

Örnek:

"0000"

Data
object
gerekli

Response data. Null when Success is false.

Message
null | string

Success false olduğunda hata mesajı. Bütün hataların mesajları tek metinde birleştirilir.