post https://testapi.hepsiburadaefaturam.com/api/BasicIntegrationApi
Oluşturulan fatura nesnelerinin GİB’e gönderilmesini sağlar.
Test servisinde Username/Password geneldir. Canlıda bu bilgileri müşteri bazlı kullanılacaktır. Üyelik alım sonrasında verilen bilgilerle login sağlanır. Username/Password bilgisi body içinde userInfo altında giriş sağlanmaktadır.
Test hepsiburadaefaturam Portaline buradan erişebilirsiniz.
Username: HBTest1
Password: HBTest1
Parametreler
invoices: GIB sistemine gönderilecek olan Fatura bilgileridir. Bir yada daha çok fatura aynı anda bu metod aracılığı ile gönderilmek üzere kuyruğa eklenebilir.
- InvoiceInfo: Gönderilecek olan bir faturanın bilgisini içermektedir.
- Invoice: InvoiceType (UBL-TR Fatura) formatında gönderilecek olan fatura bilgisidir. Faturanın UBLExtensions, UUID, ID, Signature alanlarının doldurulması zorunlu değildir. Bu alanlar sistem tarafından kuyruğa eklenirken ve imzalama esnasında otomatik olarak doldurulacaktır. Gönderim requestinin response’u taraflardan herhangi birinin sistemindeki bir problemden dolayı gönderici tarafından alınamaması riski dolayısıyla UUID alanının gönderici tarafından set edilmesi tercih edilmelidir. Bu sayede sorun yaşanan şüphe duyulan faturanın gerçek durumu sistemden sorgulanarak durum senkronizasyonu sağlanabilir. Invoice içerisindeki ID alanının (Fatura No, Seri No) kullanımı için ile ilgili açıklamalar için Fatura Seri Numarası Yönetimi başlığına bakınız.
- TargetCustomer: Gönderilecek Faturanın müşteri bilgisini içerir. VKN: Vergi Kimlik Numarası veya Kimlik Numarası bilgilerini içerir. Alias: Gönderilecek Posta Kutusu adresini içerir. Title: Müşteri adını içerir.
- LocalDocumentId: String formatında gönderilecek olan faturanın müşteri ortamında ki tekilliğini sağlayan doküman idsi. Müşteriler kendi ortamları ile daha rahat entegre olabilmek ya da faturayı gönderdikleri müşterileri ile daha rahat anlaşabilmek adına faturanın kendi ortamlarında ki muhasebe döküman nosu, fatura nosu gibi bir alanı bu parametre ile gönderebilirler. Bu alan aynı zamanda E-Fatura portalde sorgulama amacı ile de kullanılabilinecektir.LocalDocumentId alanı istenilirse firmanın Hepsiburada e-faturam bildirimine istinaden tekil alan olarak belirlenebilir. Bu fatura mükerrerliğini engelleme amacıyla kullanılabilmektedir. Gönderici e-faturada kullandığı bir LocalDocumentId’yi bir önceki hata almadığı sürece tekrar sisteme gönderemez.
Return Değerleri
Return tipi Response<List> olan metod da Response’un value alanı bir yada daha fazla InvoiceNumber içeren bir liste/array olacaktır. Tüm gönderilen faturalar için bir adet InvoiceNumber nesnesi Response.Value alanı içerisinde olacaktır.
- InvoiceNumber: Bir faturanın sistem üzerinde ifade edilmesi için gerekli olan bazı Id alanlarını içermektedir. Fatura gönderiminde Id ve UUID alanlarının üretilmesi sistem tarafından yapılacağı için üretilen bu değerlerin müşteriye iletilmesi amacı ile kullanılır.
- Id: Faturanın Id’sini belirtir. Id değeri E-Fatura sistemindeki bu faturanın tekil idsi olan ve UBL-TR de UUID olarak belirlenen alandır.
- Number: Faturanın ID alanı olan ve müşteri için tekil olan değeridir. AAAYYYYNNNNNNNNN formatındadır. AAA bir prefix i belirtir ve müşteriye göre farklılık gösterebilir. YYYY 4 haneli yılı belirtir. NNNNNNNNN ise o yıldaki müşterinin fatura nosunu sıralı olarak belirten 9 haneli numara değeridir.
- InvoiceScenario: Gönderilen faturada hangi senaryonun kullanıldığı bilgisini döner. Eğer fatura e-Fatura olarak oluştu ise “einvoice”, e-Arşiv faturası olarak oluştu ise “earchive” değeri döner.
{
"Action": "SendInvoice",
"parameters": {
"invoices": [
{
"Invoice": {
"UblVersionId": {
"value": 2.1
},
"CustomizationId": {
"value": "TR1.2"
},
"ProfileId": {
"value": "TICARIFATURA"
},
"CopyIndicator": {
"value": false
},
"IssueDate": {
"value": "2023-04-02"
},
"IssueTime": {
"value": "00:00:00.0000000+03:00"
},
"InvoiceTypeCode": {
"value": "SATIS"
},
"Note": [
{
"value": "Fatura Notu -1"
},
{
"value": "Yalnýz #Yüz Altmýþ Bir Türk Lirasý Elli Üç Kuruþ#"
}
],
"DocumentCurrencyCode": {
"value": "TRY"
},
"LineCountNumeric": {
"value": 1
},
"OrderReference": {
"Id": {
"value": "ORD1234567890"
},
"IssueDate": {
"value": "2023-04-02"
}
},
"AccountingSupplierParty": {
"Party": {
"PartyIdentification": [
{
"Id": {
"schemeId": "VKN",
"value": "9000500394"
}
},
{
"Id": {
"schemeId": "MERSISNO",
"value": "0900006841800028-111"
}
},
{
"Id": {
"schemeId": "TICARETSICILNO",
"value": "123456909-111"
}
}
],
"PartyName": {
"Name": {
"value": "Uyumsoft Bilgi Sistemleri ve Teknolojileri A.Þ."
}
},
"PostalAddress": {
"Room": {
"value": "401"
},
"StreetName": {
"value": "YTÜ Davutpaþa Kampüsü"
},
"BuildingNumber": {
"value": "401"
},
"CitySubdivisionName": {
"value": "Esenler"
},
"CityName": {
"value": "Ýstanbul"
},
"Country": {
"Name": {
"value": "Türkiye"
}
}
},
"PartyTaxScheme": {
"TaxScheme": {
"Name": {
"value": "Esenler"
}
}
},
"Person": {
"FirstName": {
"value": "Yunus Emre"
},
"FamilyName": {
"value": "BAYRAM"
}
}
}
},
"AccountingCustomerParty": {
"Party": {
"WebsiteURI": {
"Value": "Web Sitesi"
},
"PartyIdentification": [
{
"ID": {
"schemeID": "VKN",
"Value": "2150240232"
}
}
],
"PartyName": {
"Name": {
"value": "XYZ Company Gmbh."
}
},
"PostalAddress": {
"Room": {
"value": ""
},
"StreetName": {
"value": "Ostersunds"
},
"BuildingNumber": {
"value": "10"
},
"CitySubdivisionName": {
"value": "Esenler"
},
"CityName": {
"value": "Berlin"
},
"Country": {
"Name": {
"value": "Germany"
}
}
},
"PartyTaxScheme": {
"TaxScheme": {
"Name": {
"value": ""
}
}
},
"Contact": {
"Telephone": {
"value": "02122000022"
},
"Telefax": {
"value": "22111222",
"ElectronicMail": {
"value": "[email protected]"
}
}
}
}
},
"TaxTotal": [
{
"TaxAmount": {
"currencyId": "TRY",
"value": 24.64
},
"TaxSubtotal": [
{
"TaxableAmount": {
"currencyId": "TRY",
"value": 136.89
},
"TaxAmount": {
"currencyId": "TRY",
"value": 24.64
},
"Percent": {
"value": 18
},
"TaxCategory": {
"TaxScheme": {
"Name": {
"value": "KDV"
},
"TaxTypeCode": {
"value": "0015"
}
}
}
}
]
}
],
"LegalMonetaryTotal": {
"LineExtensionAmount": {
"currencyId": "TRY",
"value": 1500
},
"TaxExclusiveAmount": {
"currencyId": "TRY",
"value": 1390
},
"TaxInclusiveAmount": {
"currencyId": "TRY",
"value": 1390
},
"AllowanceTotalAmount": {
"currencyId": "TRY",
"value": 110
},
"PayableAmount": {
"currencyId": "TRY",
"value": 110
}
},
"InvoiceLine": [
{
"Id": {
"value": "1"
},
"Note": [
{
"value": "Satýr Notu"
}
],
"InvoicedQuantity": {
"unitCode": "NIU",
"value": "1"
},
"LineExtensionAmount": {
"currencyId": "TRY",
"value": "136.89"
},
"TaxTotal": {
"TaxAmount": {
"currencyId": "TRY",
"value": "24.64"
},
"TaxSubtotal": [
{
"TaxableAmount": {
"currencyId": "TRY",
"value": "136.89"
},
"TaxAmount": {
"currencyId": "TRY",
"value": "24.64"
},
"Percent": {
"value": "18"
},
"TaxCategory": {
"TaxScheme": {
"Name": {
"value": "KDV"
},
"TaxTypeCode": {
"value": "0015"
}
}
}
}
]
},
"Item": {
"Description": {
"value": "Sipariþ No: TS160416150 Sipariþ Tarihi: 16.04.2019 Sipariþ Satýr No: 1"
},
"Name": {
"value": "RASPBERRY PÝ POE HAT"
},
"ModelName": {
"value": "MP00371"
}
},
"Price": {
"PriceAmount": {
"currencyId": "TRY",
"value": "24.64"
}
}
}
]
},
"EArchiveInvoiceInfo": {
"DeliveryType": "Electronic"
},
"Scenario": 0,
"Notification": {
"Mailing": [
{
"Subject": "1234567890 abone nonuza ait faturanýz.",
"EnableNotification": true,
"To": "[email protected]",
"Attachment": {
"Xml": true,
"Pdf": true
}
}
]
},
"LocalDocumentId": "E-FATURA-001"
}
],
"userInfo": {
"Username": "HBTest1",
"Password": "HBTest1"
}
}
}