Geliştirici Merkezi

TR

CreateInvoiceItem

Belirtilen parametrelere göre faturaya yeni bir öge oluştur.

Method / Endpoint

POST/ {{API_URL}} Billing/CreateInvoiceItem/ {{ID}}

İstek Parametreleri

Parametre Adı Türü Zorunlu Açıklama
{{ID}} Integer Evet Fatura ID Numarası
sequence Integer Hayır Fatura Öge Sıra Numarası
description String Evet Fatura Öge Açıklaması
quantity Integer Hayır Fatura Öge Miktarı. Varsayılan : 1
amount Double Evet Fatura Öge Birim Fiyatı
total Double Hayır Fatura Öge Toplam Tutar. Varsayılan: Birim Fiyatı
order_id Integer Hayır Fatura ögesinin bağlı olduğu ürün/hizmet ID numarası. Bu bilgi, veri tabanında "users_products " tablosundaki "id" alanından elde edilebilir.
due_date String Hayır Fatura ögesi 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
attributes Object Hayır Fatura ögesi 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.

Harici Örnek

curl --location 'https://exampe.com/api/Billing/CreateInvoiceItem/123' \
--header 'Content-Type: application/json' \
--header 'Apikey: [YOUR_API_KEY]' \
--data '{
    "description": "test description 3",
    "quantity": 1,
    "tax_exempt": false,
    "amount": 250,
    "total": 250,
    "order_id": 0,
    "due_date": "2023-12-20 23:59:59",
    "attributes": {
        "sample3": "Example test 3"
    }
}'

Dahili Örnek

Helper::Load("Api");
try {
    $result = Api::Billing()->CreateInvoiceItem([
        'invoice_id'  => 123,
        'description' => 'test description 3',
        'quantity'    => 1,
        'tax_exempt'  => false,
        'amount'      => 250,
        'total'       => 250,
        'order_id'    => 0,
        'due_date'    => '2023-12-20 23:59:59',
        'attributes'  => [
            'sample3' => 'Example test 3',
        ],
    ]);
    print_r($result);
}
catch (Exception $e)
{
    echo 'Error: '.$e->getMessage();
}

Örnek JSON Yanıtı

{
    "status": "successful",
    "data": {
        "id": 572,
        "owner_id": 123,
        "description": "test description 3",
        "quantity": 1,
        "tax_exempt": false,
        "amount": 250,
        "total": 250,
        "order_id": 0,
        "due_date": "2023-12-20 23:59:59",
        "attributes": {
            "sample3": "Example test 3"
        }
    }
}

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 Object "GetInvoice" dokümanındaki yanıt parametrelerinde geçen "items" parametreleri ile aynı değerler içerir.
DeleteInvoice UpdateInvoiceItem

Bir Sorunuz mu Var?

Bize yazmaktan çekinmeyin. En kısa sürede yanıt göndereceğiz.
Bize Ulaşın.
Copyright © 2024. All Rights Reserved.
Join Our Discord Channel
Top