Ana içeriğe geç
YouSoftGeliştirici Portalı
Dokümanlar

Uç haritası

Aradığınız ucu bulun: önce sık sorulan işlerin kısayolları, altında sözleşmedeki 32 ucun tamamı kaynağına göre gruplanmış halde. Liste her yayımda sözleşmeden üretilir; elle bakım gerektirmez.

Ne yapmak istiyorsunuz?

En sık sorulan işler ve onları yapan uçlar. Yola tıklamak ucu OpenAPI referansında açar.

İşUç ve not
Cari kart (firmanın müşterisi ya da tedarikçisi) açmak
POST /v1/contacts
Dış API cari kartları listelemez ve okumaz: yanıttaki id değerini saklayın, fatura bu id ile kesilir. Carinin ekstresine ve bakiyesine panelden bakılır.
Fatura kesmek
POST /v1/invoices
POST /v1/invoices/{id}/send
Adım adım: Fatura kesme akışı.
Gönderilen faturanın durumunu izlemek
GET /v1/invoices/{id}
Faturayı cari bilgisiyle birlikte okumak
GET /v1/invoices/{id}
Sorgu parametresi: include=contact.
Fatura listesi ve fatura no / ETTN / zarf ile bulma
GET /v1/invoices
Liste belge tarihine göre sıralanır; filter[issue_date][gte] ile son 30 günü (gelen faturada 45 günü) her turda yeniden okumak kendi kaydınızla eşitlemenin önerilen yoludur. Sorgu parametresi: filter[invoice_no][eq], filter[uuid][eq], filter[envelope_id][eq]. Adım adım: Faturaları listeleme ve bulma.
Fatura XML’ini ya da PDF’ini indirmek
GET /v1/invoices/{id}/xml
GET /v1/invoices/{id}/pdf
Yalnız gönderilmiş belge indirilir; taslak 422 alır. İndirme uçlarının ayrı kotası ve firma başına aynı anda 4 indirme sınırı vardır. Adım adım: XML ve PDF indirme.
Gelen faturaları listelemek ve indirmek
GET /v1/inbox-invoices
GET /v1/inbox-invoices/{id}
GET /v1/inbox-invoices/{id}/xml
GET /v1/inbox-invoices/{id}/pdf
Adım adım: Gelen faturalar.
Gönderilmiş faturayı iptal etmek
POST /v1/invoices/{id}/cancel
Geri alınamaz. e-Arşiv iptali belgenin GİB’e iletildiği günden itibaren 8 gün içinde ve yalnız GIB kanalıyla yapılır; e-Faturada bu istek dış kanalda yapılmış iptalin kaydıdır. Adım adım: İptal.
Alıcının e-Fatura mükellefi olup olmadığına bakmak
GET /v1/e-invoice-inboxes/{tax_number}

Tüm uçlar

Uçlar yol önekindeki kaynağa göre gruplanır. Her satırın altındaki kapsam, anahtarın o ucu çağırabilmesi için taşıması gereken kapsamdır; taşımayan anahtar 403 forbidden alır. Kapsamlar anahtar üretilirken seçilir ve sonradan değiştirilemez: Kapsamlar. Bütün uçlarda yanıt zarfı, sayfalama ve hata biçimi ortaktır: Sorgu sözleşmesi.

Kimlik ve sözleşme

UçNe yapar, gereken kapsam
GET /v1/openapi.yaml
Bu sözleşmenin kendisi
Kapsam istemez
GET /v1/me
Anahtarın kimliği
Kapsam istemez

Cari kartlar

UçNe yapar, gereken kapsam
POST /v1/contacts
Cari kart oluştur
Kart.MusteriTedarikciDuzenleyebilir
PATCH /v1/contacts/{id}
Cari kart güncelle
Kart.MusteriTedarikciDuzenleyebilir
POST /v1/contacts/{id}/people
Cari karta iletişim kişisi ekle
Kart.MusteriTedarikciDuzenleyebilir
PATCH /v1/contacts/{id}/people/{person_id}
İletişim kişisini güncelle
Kart.MusteriTedarikciDuzenleyebilir

Ürünler ve stok

UçNe yapar, gereken kapsam
POST /v1/products
Stok kartı oluştur
Kart.Stok
PATCH /v1/products/{id}
Stok kartı güncelle
Kart.Stok
POST /v1/stock-movements
Stok hareketi oluştur
Kart.Stok
POST /v1/item-categories
Stok kategorisi oluştur
Kart.Stok
PATCH /v1/item-categories/{id}
Stok kategorisi güncelle
Kart.Stok

Giden faturalar

UçNe yapar, gereken kapsam
GET /v1/invoices
Fatura listesi
EFatura.GidenKutusuIzleyebilir
POST /v1/invoices
Fatura taslağı oluştur
Fatura.SatisFaturasiDuzenleyebilir
GET /v1/invoices/{id}
Fatura detayı
EFatura.GidenKutusuIzleyebilir
PATCH /v1/invoices/{id}
Fatura taslağı güncelle
Fatura.SatisFaturasiDuzenleyebilir
POST /v1/invoices/{id}/send
Faturayı gönderime al
EFatura.TaslaktanGonderimYapabilir
POST /v1/invoices/{id}/cancel
Gönderilmiş faturayı iptal et
EFatura.IptalEdebilir
GET /v1/invoices/{id}/xml
Fatura XML indir
EFatura.GidenKutusuIzleyebilir
GET /v1/invoices/{id}/pdf
Fatura PDF indir
EFatura.GidenKutusuIzleyebilir

Gelen faturalar

UçNe yapar, gereken kapsam
GET /v1/inbox-invoices
Gelen fatura listesi
EFatura.GelenKutusuIzleyebilir
GET /v1/inbox-invoices/{id}
Gelen fatura detayı
EFatura.GelenKutusuIzleyebilir
GET /v1/inbox-invoices/{id}/xml
Gelen fatura XML indir
EFatura.GelenKutusuIzleyebilir
GET /v1/inbox-invoices/{id}/pdf
Gelen fatura PDF indir
EFatura.GelenKutusuIzleyebilir

e-Makbuz ve e-İrsaliye

UçNe yapar, gereken kapsam
GET /v1/receipts/{id}
Makbuz detayı
Makbuz.GidenKutusuIzleyebilir
GET /v1/despatches/{id}
İrsaliye detayı
EIrsaliye.GidenKutusuIzleyebilir

e-Fatura posta kutuları

UçNe yapar, gereken kapsam
GET /v1/e-invoice-inboxes/{tax_number}
GİB posta kutusu sorgusu
Diger.EBelgeMukellefBilgileriIzleyebilir

Döviz kurları

UçNe yapar, gereken kapsam
GET /v1/exchange-rates
TCMB döviz kurları
Sistem.FirmaBilgileriIzleyebilir

Birimler ve etiketler

UçNe yapar, gereken kapsam
POST /v1/tags
Belge sınıfı (etiket) oluştur
Kart.BelgeSiniflari
PATCH /v1/tags/{id}
Belge sınıfı güncelle
Kart.BelgeSiniflari
GET /v1/units
Ürün birimleri
Sistem.FirmaBilgileriIzleyebilir
GET /v1/units/{id}
Ürün birimi
Sistem.FirmaBilgileriIzleyebilir

Vergi oranları

UçNe yapar, gereken kapsam
GET /v1/tax-rates
Faaliyet koduna göre izinli KDV oranları
Sistem.FirmaBilgileriIzleyebilir