Taslaktaki Faturayı Güncelleme

Önemli Bilgi

Bu endpoint, taslak faturalar üzerinde güncelleme yapmak için kullanılır. Halihazırda taslaklara gönderilmiş olan faturanızı
body.document.External.ID ve body.document.External.Type bilgisi üzerinden güncelleme sağlayabilirsiniz. Request body bilgisi fatura oluşturma ucu ile aynıdır. Dolayısıyla body.document.External.ID ve body.document.External.Type taslaklardaki bir belge ile eşleşmesi durumunda fatura güncellemesi yapılır.

DANGER

Resmi olarak gönderilmiş faturalar üzerinde güncelleme YAPILAMAZ

TIP

Eğer bu uca gönderilen belge, halihazırda taslaklarda bulunmuyor ise, uç oluşturma ucu gibi davranır ve ilgili bilgiler ile taslaklarda yeni bir belge oluşturur.

DANGER

Dolayısıyla içerideki bir belgeyi güncellerken, hatalı document.External.ID ve document.External.Type gönderim durumuna istenmeyen faturalar taslaklara kaydedilebilir. Hatta draft parametresinin falsegönderilme durumunda ise istenilmeyen faturalar doğrudan gönderilebilir. Bu duruma kesinlikle dikkat edilmelidir.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/json

draft

boolean

optional

Faturanın taslaklara mı yoksa doğrudan gönderim mi sağlanacağının bilgisi

Default:

true

document

object

required

Fatura Bilgisi

External

object

required

Entegre uygulama bilgileri

Type

enum<string>

optional

Fatura Tipi (Gönderilmez ise otomatik alır)

Allowed values:

SATISIADETEVKIFATISTISNAIHRACKAYITLIOZELMATRAHSGK

Examples:

SATISIADE

Profile

enum<string>

optional

Fatura Profili (Gönderilmez ise otomatik alır)

Allowed values:

TEMELFATURATICARIFATURAIHRACATKAMUEARSIVFATURA

NumberOrSerie

optional

Fatura Seri veya Numarası (Gönderilmez ise portalda tanımlanan varsayılan serileri alır)

UUID

string <uuid>

optional

Fatura UUID bilgisi (Gönderilmez ise otomatik alır ve Response olarak UUID bilgisi döner)

IssueDateTime

string

required

Fatura Tarih ve Saat Bilgisi (YYYY-MM-DDTHH:mm:ss formatında gönderilmelidir)

Notes

array[string]

optional

Fatura notları

CurrencyCode

string

optional

Para Birimi (Gönderilmez ise otomatik TRY alır) (Geçerli kodlar için kod listesine bakınız)

>= 3 characters<= 3 characters

Default:

TRY

Examples:

USDEURTRY

ExchangeRate

number

optional

Döviz Kuru

TaxExemptions

object

optional

Vergi istisna kodları

Order

object

optional

Sipariş bilgisi

Despatches

array [object {2}]

optional

İrsaliye bilgileri

Customer

object

required

Fatura Alıcı Bilgileri

BuyerCustomer

object

optional

Aracı Kurum Bilgileri

PaymentMeans

object

optional

Ödeme bilgileri

SGK

object

optional

SGK bilgileri

Lines

array [object {9}]

required

Fatura Kalemleri

>= 1 items

Example

{
  "draft": true,
  "document": {
    "External": {
      "ID": "string",
      "RefNo": "MEA11152",
      "Type": "Müthiş Entegre App"
    },
    "Type": "SATIS",
    "Profile": "TEMELFATURA",
    "NumberOrSerie": "RS",
    "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30",
    "IssueDateTime": "string",
    "Notes": [
      "string"
    ],
    "CurrencyCode": "TRY",
    "ExchangeRate": 0,
    "TaxExemptions": {
      "KDV": 322
    },
    "Order": {
      "Date": "2023-10-19",
      "Value": "SIP0001"
    },
    "Despatches": [
      {
        "Date": "2023-10-19",
        "Value": "IRS0001"
      }
    ],
    "Customer": {
      "TaxNumber": "string",
      "TaxOffice": "string",
      "Name": "string",
      "Alias": "string",
      "Address": "string",
      "District": "string",
      "City": "string",
      "Country": "string",
      "PostalCode": "strin",
      "Phone": "string",
      "Fax": "string",
      "Mail": "string",
      "Website": "string"
    },
    "BuyerCustomer": {
      "TaxNumber": "string",
      "TaxOffice": "string",
      "Name": "string",
      "Address": "string",
      "District": "string",
      "City": "string",
      "Country": "string",
      "PostalCode": "strin",
      "Phone": "string",
      "Fax": "string",
      "Mail": "string",
      "Website": "string"
    },
    "PaymentMeans": {
      "DueDate": "string",
      "ChannelCode": "string",
      "AccountNumber": "string",
      "PaymentNote": "string",
      "MeansCode": "string"
    },
    "SGK": {
      "Type": "string",
      "CompCode": "string",
      "CompName": "string",
      "DocNo": "string",
      "StartDate": "string",
      "EndDate": "string"
    },
    "Lines": [
      {
        "Name": "Örnek mal hizmet adı",
        "Quantity": 19.1,
        "UnitCode": "ADET",
        "Price": 19.05,
        "KDV": {
          "Percent": 0,
          "Amount": 0
        },
        "Allowance": {
          "Percent": 20,
          "Price": 0
        },
        "WithholdingTax": {
          "Code": 621
        },
        "AdditionalNames": {
          "Description": "string",
          "Brand": "string",
          "Model": "string",
          "BuyerCode": "string",
          "SellerCode": "string",
          "ManufacturerCode": "string",
          "Origin": "string",
          "Note": "string"
        },
        "Taxes": [
          {
            "Percent": 20,
            "Code": "0053"
          }
        ]
      }
    ]
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://apidemo.rahatsistem.com.tr/v2/documents/invoice.update' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "draft": true,
    "document": {
        "External": {
            "ID": "string",
            "RefNo": "MEA11152",
            "Type": "Müthiş Entegre App"
        },
        "Type": "SATIS",
        "Profile": "TEMELFATURA",
        "NumberOrSerie": "RS",
        "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30",
        "IssueDateTime": "string",
        "Notes": [
            "string"
        ],
        "CurrencyCode": "TRY",
        "ExchangeRate": 0,
        "TaxExemptions": {
            "KDV": 322
        },
        "Order": {
            "Date": "2023-10-19",
            "Value": "SIP0001"
        },
        "Despatches": [
            {
                "Date": "2023-10-19",
                "Value": "IRS0001"
            }
        ],
        "Customer": {
            "TaxNumber": "string",
            "TaxOffice": "string",
            "Name": "string",
            "Alias": "string",
            "Address": "string",
            "District": "string",
            "City": "string",
            "Country": "string",
            "PostalCode": "strin",
            "Phone": "string",
            "Fax": "string",
            "Mail": "string",
            "Website": "string"
        },
        "BuyerCustomer": {
            "TaxNumber": "string",
            "TaxOffice": "string",
            "Name": "string",
            "Address": "string",
            "District": "string",
            "City": "string",
            "Country": "string",
            "PostalCode": "strin",
            "Phone": "string",
            "Fax": "string",
            "Mail": "string",
            "Website": "string"
        },
        "PaymentMeans": {
            "DueDate": "string",
            "ChannelCode": "string",
            "AccountNumber": "string",
            "PaymentNote": "string",
            "MeansCode": "string"
        },
        "SGK": {
            "Type": "string",
            "CompCode": "string",
            "CompName": "string",
            "DocNo": "string",
            "StartDate": "string",
            "EndDate": "string"
        },
        "Lines": [
            {
                "Name": "Örnek mal hizmet adı",
                "Quantity": 19.1,
                "UnitCode": "ADET",
                "Price": 19.05,
                "KDV": {
                    "Percent": 0,
                    "Amount": 0
                },
                "Allowance": {
                    "Percent": 20,
                    "Price": 0
                },
                "WithholdingTax": {
                    "Code": 621
                },
                "AdditionalNames": {
                    "Description": "string",
                    "Brand": "string",
                    "Model": "string",
                    "BuyerCode": "string",
                    "SellerCode": "string",
                    "ManufacturerCode": "string",
                    "Origin": "string",
                    "Note": "string"
                },
                "Taxes": [
                    {
                        "Percent": 20,
                        "Code": "0053"
                    }
                ]
            }
        ]
    }
}'

Responses

🟢200OK

application/json

Body

data

object

required

İstek sonucunda dönülmesi gereken bir şey varsa data objesi altında döner

uuid

string <uuid>

required

Gönderidiğiniz veya otomatik oluşturulan fatura UUIDsi (Bu bilgiyi SAKLAYINIZ. Daha sonraki isteklerde gerekli olacak)

warns

array[string]

required

Fatura ile ilgili verilmesi gereken bilgiler

Example

{
  "data": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "warns": [
      "Fatura tipi SATIS olarak belirlendi!"
    ]
  }
}

🟠400Bad Request

Taslaktaki Faturayı Güncelleme

Önemli Bilgi#

Request

Request samples

Responses

Önemli Bilgi