e-SMM Listeleme

Açıklama

Bu endpoint, giden makbuzlarınızı listelemek için kullanılır.

TIP

sortBy bilgisi issue_date olarak gönderilirse, belirtilen başlangıç ve bitiş tarihleri, makbuz tarihi üzerinden filtrelenerek yanıt dönülür. Eğer received_at olarak gönderilse, makbuzlar zarf tarihlerine göre filtrelenerek yanıt dönülür.

Request

Authorization

Add parameter in header

x-api-key

Example:

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

Body Params application/json

query

object

required

Makbuz Objesi

startDate

string

required

Makbuz listesinin hangi tarihten itibaren listeleneceği (YYYY-MM-DD formatında gönderilmeli)

endDate

string

required

Makbuz listesinin hangi tarihe kadar listeneceği (YYYY-MM-DD formatında gönderilmeli)

sortBy

enum<string>

optional

Bu bilgi listelemede hangi tarihin baz alınacağı bilgisidir

Allowed values:

received_atissue_date

Default:

issue_date

sortDefs

array [object {2}]

optional

Listenin hangi bilgi ile sıralanacağının bilgisini içerir

Default:

{"field":"issue_date","direction":"asc"}

string | null

optional

Kelime ile arama filtresi

<= 250 characters

pageSize

integer

optional

Sayfanın kaç makbuz içereceği bilgisi

>= 1<= 100

Default:

page

integer

optional

Kaçıncı sayfanın talep edildiğinin bilgisi

>= 1

Default:

statusCodes

array[number]

optional

Makbuzların durum koduna göre filtrelemek için kullanılır (Geçerli kodlar için listeleye bakınız)

Allowed values:

2001200720082009

includeErp

boolean

optional

Erp işareti konulmuş belgeleri ayrımak için kullanılır

printed

boolean

optional

Yazdırıldı işareti konulmuş belgeleri ayırmak için kullanılır

readMarked

boolean

optional

Okundu işareti konulmuş belgeleri ayırma için kullanılır

Example

{
  "query": {
    "startDate": "string",
    "endDate": "string",
    "sortBy": "issue_date",
    "sortDefs": [
      {
        "field": "issue_date",
        "direction": "asc"
      }
    ],
    "search": "string",
    "pageSize": 10,
    "page": 1,
    "statusCodes": [
      2001
    ],
    "includeErp": true,
    "printed": true,
    "readMarked": true
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

data

object

required

pagination

object

required

items

array [object {33}]

required

Makbuz listesi

Example

{
  "data": {
    "pagination": {
      "count": 0,
      "count_unfiltered": 0,
      "page_size": 0,
      "page_index": 0
    },
    "items": [
      {
        "integrator": "string",
        "uuid": "string",
        "id": "string",
        "profile_id": "string",
        "type_code": "string",
        "issue_date": "string",
        "issue_time": "string",
        "currency": "string",
        "note": "string",
        "notes": [
          "string"
        ],
        "sender": {
          "name": "string",
          "vkn_tckn": "string",
          "city": "string",
          "city_subdivision": "string",
          "tax_office": "string",
          "email": "string"
        },
        "receiver": {
          "name": "string",
          "vkn_tckn": "string",
          "city": "string",
          "city_subdivision": "string",
          "email": "string"
        },
        "line_extension": 0,
        "line_extension_currency": "string",
        "tax_exclusive": 0,
        "tax_exclusive_currency": "string",
        "tax_inclusive": 0,
        "tax_inclusive_currency": "string",
        "allowance": 0,
        "allowance_currency": "string",
        "payable": 0,
        "payable_currency": "string",
        "tax": {
          "amount": 0,
          "amount_currency": "string",
          "subtotals": [
            {
              "name": "string",
              "code": "string",
              "percent": 0,
              "taxable": 0,
              "taxable_currency": "string",
              "amount": 0,
              "amount_currency": "string"
            }
          ]
        },
        "tax_totals": [
          {
            "amount": 0,
            "amount_currency": "string",
            "subtotals": [
              {
                "name": "string",
                "code": "string",
                "percent": 0,
                "taxable": 0,
                "taxable_currency": "string",
                "amount": 0,
                "amount_currency": "string"
              }
            ]
          }
        ],
        "received_at": "string",
        "is_archived": true,
        "is_printed": true,
        "send_method": "string",
        "is_online_sale": true,
        "status": {
          "summary": "string",
          "status_code": 0,
          "status": "string",
          "gib_status_code": 0,
          "message": "string",
          "progress": {
            "step": 0,
            "step_count": 0,
            "percentage": 0
          }
        },
        "short_id": "string",
        "app_name": null,
        "lines": [
          {
            "id": "string",
            "name": "string",
            "quantity": 0,
            "quantity_unit": "string",
            "price": 0,
            "price_currency": "string",
            "extension_amount": 0,
            "extension_amount_currency": "string",
            "tax_totals": [
              {
                "amount": 0,
                "amount_currency": "string",
                "subtotals": [
                  {
                    "name": "string",
                    "code": "string",
                    "percent": 0,
                    "taxable": 0,
                    "taxable_currency": "string",
                    "amount": 0,
                    "amount_currency": "string"
                  }
                ]
              }
            ],
            "tax": {
              "amount": 0,
              "amount_currency": "string",
              "subtotals": [
                {
                  "name": "string",
                  "code": "string",
                  "percent": 0,
                  "taxable": 0,
                  "taxable_currency": "string",
                  "amount": 0,
                  "amount_currency": "string"
                }
              ]
            }
          }
        ]
      }
    ]
  }
}

🟠400Bad Request

Açıklama#

Request

Request samples

Responses

Açıklama