Faktury

více o fakturaci v Upgates e-shopech naleznete zde.

Seznam faktur

GET

/api/v2/invoices

Některé údaje nejsou dostupné přímo ve faktuře, ale v detailu související objednávky. Seznam faktur je dostupný po jednotlivých stranách, výstup je omezený na 100 položek na stránku.

Seznam faktur › query Parameters

invoice_numbers

QueryParameterArrayString

Čísla faktur oddělená středníkem ; nebo jako pole

creation_time_from

DateTime · date-time

vrátí faktury vytvořené od tohoto data

datum a čas zapsaný jako řeťezec znaků dle ISO 8601

creation_time_to

DateTime · date-time

vrátí faktury vytvořené do tohoto data

datum a čas zapsaný jako řeťezec znaků dle ISO 8601

last_update_time_from

DateTime · date-time

vrátí faktury změněné od tohoto data

datum a čas zapsaný jako řeťezec znaků dle ISO 8601

page

integer

stránka

Default: 1

paid_yn

boolean

pokud je true, vrátí zaplacené faktury

type

string · enum

typ dokladu

Enum values:

invoice

creditNote

receipt

Seznam faktur › Responses

200

current_page

integer · min: 1

aktuální strana

current_page_items

integer

počet položek na aktuální straně

number_of_items

integer

celkový počet položek

number_of_pages

integer

celkový počet stran

object[]

pole objektů s fakturami

GET/api/v2/invoices

curl --request GET \
  --url /api/v2/invoices

shell

Example Responses

{
  "current_page": 1,
  "current_page_items": 1,
  "number_of_items": 1,
  "number_of_pages": 1,
  "invoices": [
    {
      "invoice_number": "invoice_number",
      "related_invoice_number": "related_invoice_number",
      "type": "invoice",
      "order_number": "order_number",
      "external_order_number": "external_order_number",
      "case_number": "case_number",
      "language_id": "cz",
      "currency_id": "CZK",
      "date_of_issuance": "2026-04-28",
      "date_of_vat_revenue_recognition": "2026-04-28",
      "date_of_expiration": "2026-04-28",
      "creation_time": "2026-04-28T13:57:48+02:00",
      "variable_symbol": "variable_symbol",
      "specific_symbol": "specific_symbol",
      "payment": "payment",
      "paid_yn": true,
      "paid_date": "2026-04-28",
      "oss_yn": true,
      "oss_country_id": "oss_country_id",
      "total_rest": 0,
      "total_with_vat": 0,
      "total_without_vat": 0,
      "note": "note",
      "invoice_pdf_url": "https://www.example.com/path/to/resource",
      "supplier": {
        "email": "test@example.com",
        "phone": "phone",
        "name": "name",
        "street": "street",
        "city": "city",
        "zip": "zip",
        "country_id": "country_id",
        "company_yn": true,
        "var_payer_yn": true,
        "ico": "ico",
        "dic": "dic",
        "account_number": "account_number",
        "iban": "iban",
        "swift": "swift",
        "web": "web"
      },
      "customer": {
        "email": "test@example.com",
        "phone": "phone",
        "name": "name",
        "street": "street",
        "city": "city",
        "zip": "zip",
        "country_id": "country_id",
        "company_yn": true,
        "ico": "ico",
        "dic": "dic"
      },
      "items": [
        {
          "code": "code",
          "name": "name",
          "description": "description",
          "quantity": 0,
          "unit": "unit",
          "vat": 0,
          "price_per_unit_with_vat": 0,
          "price_per_unit_without_vat": 0,
          "price_with_vat": 0,
          "price_without_vat": 0,
          "recycling_fee": 0,
          "type": "product"
        }
      ],
      "eet": {
        "send_yn": true,
        "production_yn": true,
        "id_provoz": "id_provoz",
        "id_pokl": "id_pokl",
        "rezim": "common",
        "bkp": "bkp",
        "fik": "fik",
        "pkp": "pkp"
      },
      "recapitulation_currency_id": "CZK",
      "recapitulation_currency_rate": 0,
      "recapitulation_vats": [
        {
          "base": 0,
          "vat": 0,
          "total": 0
        }
      ],
      "recapitulation_vats_total": {
        "base": 0,
        "vat": 0,
        "total": 0
      }
    }
  ]
}

json

application/json

Detail faktury

GET

/api/v2/invoices/{invoice_number}

Detail faktury › path Parameters

invoice_number

string · required

Číslo faktury

Detail faktury › Responses

200

current_page

integer · min: 1

aktuální strana

current_page_items

integer

počet položek na aktuální straně

number_of_items

integer

celkový počet položek

number_of_pages

integer

celkový počet stran

object[]

pole objektů s fakturami

GET/api/v2/invoices/{invoice_number}

curl --request GET \
  --url /api/v2/invoices/:invoice_number

shell

Example Responses

{
  "current_page": 1,
  "current_page_items": 1,
  "number_of_items": 1,
  "number_of_pages": 1,
  "invoices": [
    {
      "invoice_number": "invoice_number",
      "related_invoice_number": "related_invoice_number",
      "type": "invoice",
      "order_number": "order_number",
      "external_order_number": "external_order_number",
      "case_number": "case_number",
      "language_id": "cz",
      "currency_id": "CZK",
      "date_of_issuance": "2026-04-28",
      "date_of_vat_revenue_recognition": "2026-04-28",
      "date_of_expiration": "2026-04-28",
      "creation_time": "2026-04-28T13:57:48+02:00",
      "variable_symbol": "variable_symbol",
      "specific_symbol": "specific_symbol",
      "payment": "payment",
      "paid_yn": true,
      "paid_date": "2026-04-28",
      "oss_yn": true,
      "oss_country_id": "oss_country_id",
      "total_rest": 0,
      "total_with_vat": 0,
      "total_without_vat": 0,
      "note": "note",
      "invoice_pdf_url": "https://www.example.com/path/to/resource",
      "supplier": {
        "email": "test@example.com",
        "phone": "phone",
        "name": "name",
        "street": "street",
        "city": "city",
        "zip": "zip",
        "country_id": "country_id",
        "company_yn": true,
        "var_payer_yn": true,
        "ico": "ico",
        "dic": "dic",
        "account_number": "account_number",
        "iban": "iban",
        "swift": "swift",
        "web": "web"
      },
      "customer": {
        "email": "test@example.com",
        "phone": "phone",
        "name": "name",
        "street": "street",
        "city": "city",
        "zip": "zip",
        "country_id": "country_id",
        "company_yn": true,
        "ico": "ico",
        "dic": "dic"
      },
      "items": [
        {
          "code": "code",
          "name": "name",
          "description": "description",
          "quantity": 0,
          "unit": "unit",
          "vat": 0,
          "price_per_unit_with_vat": 0,
          "price_per_unit_without_vat": 0,
          "price_with_vat": 0,
          "price_without_vat": 0,
          "recycling_fee": 0,
          "type": "product"
        }
      ],
      "eet": {
        "send_yn": true,
        "production_yn": true,
        "id_provoz": "id_provoz",
        "id_pokl": "id_pokl",
        "rezim": "common",
        "bkp": "bkp",
        "fik": "fik",
        "pkp": "pkp"
      },
      "recapitulation_currency_id": "CZK",
      "recapitulation_currency_rate": 0,
      "recapitulation_vats": [
        {
          "base": 0,
          "vat": 0,
          "total": 0
        }
      ],
      "recapitulation_vats_total": {
        "base": 0,
        "vat": 0,
        "total": 0
      }
    }
  ]
}

json

application/json

Faktura v PDF

GET

/api/v2/invoices/{invoice_number}/pdf

Vrací dokument objednávky ve formátu PDF.

Faktura v PDF › path Parameters

invoice_number

string · required

Číslo faktury

Faktura v PDF › Responses

200

string · binary

Dopravy Grafika - editor kódu

Seznam faktur

GET

/api/v2/invoices

Některé údaje nejsou dostupné přímo ve faktuře, ale v detailu související objednávky. Seznam faktur je dostupný po jednotlivých stranách, výstup je omezený na 100 položek na stránku.

Seznam faktur › query Parameters

invoice_numbers

QueryParameterArrayString

Čísla faktur oddělená středníkem ; nebo jako pole

creation_time_from

DateTime · date-time

vrátí faktury vytvořené od tohoto data

datum a čas zapsaný jako řeťezec znaků dle ISO 8601

creation_time_to

DateTime · date-time

vrátí faktury vytvořené do tohoto data

datum a čas zapsaný jako řeťezec znaků dle ISO 8601

last_update_time_from

DateTime · date-time

vrátí faktury změněné od tohoto data

datum a čas zapsaný jako řeťezec znaků dle ISO 8601

page

integer

stránka

Default: 1

paid_yn

boolean

pokud je true, vrátí zaplacené faktury

type

string · enum

typ dokladu

Enum values:

invoice

creditNote

receipt

Seznam faktur › Responses

200

current_page

integer · min: 1

aktuální strana

current_page_items

integer

počet položek na aktuální straně

number_of_items

integer

celkový počet položek

number_of_pages

integer

celkový počet stran

object[]

pole objektů s fakturami

Detail faktury

GET

/api/v2/invoices/{invoice_number}

Detail faktury › path Parameters

invoice_number

string · required

Číslo faktury

Detail faktury › Responses

200

current_page

integer · min: 1

aktuální strana

current_page_items

integer

počet položek na aktuální straně

number_of_items

integer

celkový počet položek

number_of_pages

integer

celkový počet stran

object[]

pole objektů s fakturami