Worldwide (English)
Türkiye (Türkçe)
BaşlangıçGetInvoice
Belirtilen faturanın tüm detaylarını alın.
Method / Endpoint
GET/ {{API_URL}} Billing/GetInvoice/ {{ID}}
İstek Parametreleri
| Parametre Adı | Türü | Açıklama |
|---|---|---|
| {{ID}} | Integer | Fatura ID numarası |
Harici Örnek
curl --location 'https://example.com/api/Billing/GetInvoice/123' \
--header 'Apikey: [YOUR_API_KEY]'Dahili Örnek
Helper::Load("Api");
try {
$result = Api::Billing()->GetInvoice(123);
print_r($result);
}
catch (Exception $e)
{
echo 'Error: '.$e->getMessage();
}Örnek JSON Yanıtı
{
"status": "successful",
"data": {
"id": 367,
"number": "#367",
"user": {
"id": 2,
"lang": "en",
"identity": null,
"type": "corporate",
"name": "James",
"surname": "Roddy",
"full_name": "James Roddy",
"email": "[email protected]",
"phone": "16055762309",
"company_name": "TEST1 LLC",
"company_tax_number": "659898989",
"company_tax_office": "testoffice",
"address": {
"country_code": "US",
"country_name": "United States",
"city": "Anchorage",
"state": "Alaska",
"detail": "test example123",
"zipcode": "1234"
}
},
"taxation_type": "exclusive",
"notes": "Invoice note test123",
"created_at": "2023-03-11 19:49:00",
"due_date": "2023-03-11 23:59:00",
"payment_date": "2023-03-11 19:53:49",
"refund_date": "0000-00-00 00:00:00",
"status": "paid",
"formalize": true,
"local": true,
"taxfree": false,
"formalize_file": "https://example.com/resources/uploads/invoices/aa2f3fasd3fa3f4ed.pdf",
"exchange_rate": 1,
"currency": "USD",
"tax_rate": 18,
"subtotal": 21,
"tax": 3.779999999999999804600747665972448885440826416015625,
"total": 24.780000000000001136868377216160297393798828125,
"payment_method": "Credit Card (Stripe)",
"payment_method_data": {
"Transaction ID": "PM12345"
},
"payment_method_commission": 1,
"payment_method_commission_rate": 5,
"send_bill_to_address": 0,
"share": {
"token": "VCsxZWZPQkI0bDFhdDNqV0RWZHdyQllGbmN5cGkzcGhRd09tWEc0VTIyMD0=",
"link": "https://example.com/invoice?token=VCsxZWZPQkI0bDFhdDNqV0RWZHdyQllGbmN5cGkzcGhRd09tWEc0VTIyMD0="
},
"discounts": [],
"items": [
{
"id": 458,
"description": "Lorem Ipsum Dolor",
"quantity": 1,
"tax_exempt": false,
"amount": 20,
"total": 20,
"order_id": 0,
"due_date": "0000-00-00 00:00:00",
"attributes" : []
}
]
}
}Yanıt Parametreleri
| Parametre Adı | Türü | Açıklama |
|---|---|---|
| status | String | Eylem Durumu "successful" veya "error" |
| message | String | Eylem durumu "error" gelmişse hata mesajı |
| data.id | Integer | Fatura ID Numarası |
| data.number | String | Fatura seri numarası eğer etkinleştirilmişse, proforma iken veya ödendikten sonra değişebilmektedir. |
| data.user.id | Integer | Müşterinin ID Numarası |
| data.user.lang | String | ISO 639-1 formatına göre müşterinin dil bilgisi. Örneğin: "en" , "de" , "tr" gibi. |
| data.user.identity | Integer | Müşterinin 11 haneli T.C. kimlik numarası |
| data.user.type | String | Müşterinin hesap türü. "individual": Bireysel, "corporate": Kurumsal |
| data.user.name | String | Müşterinin Adı |
| data.user.surname | String | Müşterinin Soyadı |
| data.user.full_name | String | Müşterinin Tam Adı |
| data.user.email | String | Müşterinin E-Posta Adresi |
| data.user.phone | Integer | Müşterinin Telefon Numarası. (Ülke alan kodu dahil). Örneğin: Şöyle ise: +1 (123) 456-7890 şu şekilde olmalı: 11234567890 |
| data.user.company_name | String | Müşterinin Firma Ünvanı |
| data.user.company_tax_number | String | Müşterinin Vergi Numarası |
| data.user.company_tax_office | String | Müşterinin Vergi Dairesi |
| data.user.custom_fields | Object | Faturada müşteriye ait özel alanlar |
| data.user.custom_fields.field_id | Integer | Özel Alan ID Numarası |
| data.user.custom_fields.name | String | Özel Alan Adı |
| data.user.custom_fields.value | String | Özel Alan İçeriği |
| data.user.address.country_code | String | Müşterinin Ülke Kodu. (ISO 3166-1 Alpha-2) Örn: US, FR, DE |
| data.user.address.country_name | String | Müşterinin Ülke Adı. Örn: United States, Germany, France, Turkey |
| data.user.city | String | Müşterinin Şehir Bilgisi |
| data.user.state | String | Müşterinin İlçesi |
| data.user.detail | String | Müşterinin Adres Detayları |
| data.user.zipcode | String | Müşterinin Posta Kodu |
| data.taxation_type | String | Faturanın Vergi Türü: "exclusive": Vergi Hariç, "inclusive" Vergi Dahil |
| data.notes | String | Fatura ile İlgili Notlar |
| data.created_at | String | Faturanın Oluşturulma Tarihi. Format: YYYY-MM-DD HH:ii:ss |
| data.due_date | String | Faturanın Son Ödeme Tarihi. Format: YYYY-MM-DD HH:ii:ss |
| data.payment_date | Sstring | Faturanın Ödenme Tarihi. Format: YYYY-MM-DD HH:ii:ss |
| data.refund_date | String | Faturanın İade Tarihi. Format: YYYY-MM-DD HH:ii:ss |
| data.status | String | Faturanın Durumu: "unpaid": Ödenmedi, "pending": Onay Bekliyor, "paid": Ödendi, "refunded": İade Edildi, "cancelled": İptal Edildi. |
| data.formalize | Boolean | Faturanın Resmileştirilme Durumu, "true" Resmileştirildi, "false": Resmileştirilmedi |
| data.local | Boolean | Faturanın Yerellik durumu, "true": Yerel bir fatura. "false": Yerel olmayan bir fatura. Bu bilgi müşterinin adresine göre vergi oranı varsa yereldir, vergi oranı yoksa yerel değildir. |
| data.taxfree | Boolean | Faturaya vergi uygulanma durumu: "true" vergi uygulanabilir. "false" vergi uygulanamaz. |
| data.formalize_file | String | Faturanın PDF dosyası URL olarak belirtilir. |
| data.exchange_rate | Double | Faturanın Döviz Kuru Oranı |
| data.currency | String | Faturanın Para Birimi. Format: ISO 4217. Örneğin: USD, EUR, GBP |
| data.tax_rate | Double | Faturanın Vergi Oranı |
| data.subtotal | Double | Faturanın Ara Toplam Tutarı |
| data.tax | Double | Faturanın Toplam Vergi Tutarı |
| data.total | Double | Faturanın Vergi Dahil Toplam Tutarı |
| data.payment_method | String | Faturada Görünen Ödeme Yöntemi |
| data.payment_method_data | Object | Faturadaki Ödeme Yöntemi Ayrıntıları |
| data.payment_method_commission | Double | Toplam Ödeme Yöntemi Komisyon Tutarı |
| data.payment_method_commission_rate | Double | Ödeme Yöntemi Komisyon Oranı |
| data.send_bill_to_address | Double | Adrese Fatura Gönderim Bedeli. (Eğer adrese fatura gönderimi etkin ise.) |
| data.share | Object | Fatura Paylaşımı ile İlgili Bilgiler |
| data.share.token | String | Fatura Paylaşım Jetonu |
| data.share.link | String | Fatura Paylaşım Bağlantısı |
| data.discounts | Object | Faturaya Uygulanan İndirimler |
| data.discounts.type | String | İndirim Türü. ("promotion": Promosyon, "coupon": Kupon, "dealership": Bayi) |
| data.discounts.item_id | Integer | İndirimin uygulandığı fatura öğe ID numarası |
| data.discounts.rate | Double | İndirim Yüzdesi |
| data.discounts.description | String | İndirim Adı: Kupon Kodu, Promosyon Adı vb. |
| data.discounts.amount | Double | Uygulanan İndirim Tutarı |
| data.discounts.dkey | String | Bayilik indiriminin hangi üründen veya ürün grubundan elde edildiği. |
| data.items | Object | Faturanın Öğeleri |
| data.items.id | Integer | Fatura öğe ID Numarası |
| data.items.owner_id | Integer | Fatura ID Numarası |
| data.items.description | String | Fatura Öğe Açıklaması |
| data.items.quantity | Integer | Fatura Öğe Miktarı |
| data.items.tax_exempt | Boolean | Fatura öğe vergi muafiyeti durumu. "true": Muaf. "false": Muaf değil. |
| data.items.amount | Double | Fatura Öğe Birim Tutarı |
| data.items.total | Double | Fatura Öğe Toplam Tutarı |
| data.items.order_id | Integer | Fatura öğesinin bağlı olduğu ürün/hizmet ID numarası. Bu bilgi, veri tabanında "users_products " tablosundaki "id" alanından elde edilebilir. |
| data.items.due_date | String | Fatura öğesi eğer bir ürün/hizmete bağlıysa ürün/hizmetin bitiş tarihi ile aynı olmalıdır. Format: YYYY-MM-DD HH:ii:ss |
| data.items.attributes | Object | Fatura öğesi eğer bir ürün/hizmete bağlıysa, bağlı olduğu ürün/hizmetin satın alımıyla veya yenilenmesiyle alakalı bilgiler yer almaktadır. |
