Přeskočit na hlavní obsah

ProformaInvoiceIssuedDetail

Detail zálohové faktury vydané.

_links object

HAL odkaz na samotný zdroj.

self objectpovinné
hrefstringpovinné

Cesta ke zdroji včetně prefixu verze API, například /1.3/{zdroj}/{id}.

customer objectpovinné

Detail zákazníka.

_links object

HAL odkaz na samotný zdroj.

self objectpovinné
hrefstringpovinné

Cesta ke zdroji včetně prefixu verze API, například /1.3/{zdroj}/{id}.

idintegerpovinné

ID zákazníka.

namestringpovinnémax. délka 100

Jméno nebo název zákazníka.

např. Jan Novák
comidstringmax. délka 20

IČO.

např. 12345679
emailstringmax. délka 100

E-mail.

např. novak.jan@example.org
phonestringmax. délka 20

Telefon.

např. +420123123123
cellphonestringmax. délka 20

Mobil.

např. +420123123123
customer_group_idinteger
external_codestringmax. délka 50

Vlastní identifikátor zákazníka v cizím systému.

např. CC123
vat_payerbooleanpovinné

Zákazník je plátce DPH.

vatidstringmax. délka 20

DIČ. Vyplňuje se u plátce DPH.

např. CZ12345679
name_displaystringmax. délka 100

Jméno zobrazované na dokladech, když se liší od názvu.

např. Jan Novák ml.
wwwstringmax. délka 40

Webová adresa.

např. https://www.iucto.cz
usual_maturityintegerpovinné

Obvyklá splatnost ve dnech, předvyplní se na dokladu.

např. 30
preferred_payment_methodPreferredPaymentMethodpovinnétransfercashproformacheckcreditcardcashondelivery

Preferovaný způsob platby kontaktu. Popisy hodnot vrací Preferované metody platby.

invoice_languageInvoiceLangpovinnécsenskdepl

Jazyk, ve kterém se tiskne faktura.

address objectpovinné

Poštovní adresa kontaktu.

streetstring

Ulice a číslo popisné.

např. Stodolní 123
citystring

Město.

např. Ostrava
postalcodestring

Poštovní směrovací číslo.

např. 385 02
countryCountryCodepovinné

Země.

např. CZ
notestringmax. délka 1000

Interní poznámka.

např. Věrný zákazník
account_number1string | nullmůže být null

Číslo bankovního účtu zákazníka.

např. 1234567890/0100
account_number2string | nullmůže být null

Druhé číslo bankovního účtu zákazníka.

např. 1234-1234567890/4400
account_number3string | nullmůže být null

Třetí číslo bankovního účtu zákazníka.

např. null
account_number4string | nullmůže být null

Čtvrté číslo bankovního účtu zákazníka.

např. null
default_department_idinteger

ID střediska předvyplněného na dokladu.

default_contract_idinteger

ID zakázky předvyplněné na dokladu.

bank_account object

Detail bankovního účtu.

_links object

HAL odkaz na samotný zdroj.

self objectpovinné
hrefstringpovinné

Cesta ke zdroji včetně prefixu verze API, například /1.3/{zdroj}/{id}.

idintegerpovinné

ID účtu.

numberstringpovinné

Celé číslo účtu ve tvaru předčíslí-číslo/kód banky.

např. 19-123457/0100
balancenumber<double>

Aktuální zůstatek účtu v měně účtu. (API 1.3+)

např. 0
balance_czknumber<double>

Aktuální zůstatek účtu v CZK. (API 1.3+)

např. 0
realtime_payment_fetchboolean

Účet podporuje načítání plateb v reálném čase. (API 1.3+)

namestringmax. délka 45

Název účtu.

např. Komerční banka
currencystringpovinnémax. délka 3

Měna účtu, kód podle ISO 4217. Dostupné hodnoty vrací Měny.

např. CZK
isdefaultboolean

Účet je nastavený jako výchozí.

account_prefixstring

Předčíslí účtu. Řetězec, aby se zachovala vedoucí nula.

např. 19
account_numberstringpovinné

Číslo účtu bez předčíslí.

např. 123457
bank_codestringpovinné

Kód banky.

např. 0100
swiftstringmax. délka 11

SWIFT / BIC.

např. KOMBCZPPXXX
ibanstringmax. délka 34

IBAN.

např. CZ5601000000190000123457
initial_statenumber<double>

Počáteční stav účtu.

např. 0
chart_account_idinteger

ID účtu účetní osnovy. Výchozí je 221.

visibleboolean

Účet se nabízí v seznamech.

document_state object

Stav dokladu.

idintegerpovinné

ID stavu.

namestringpovinné

Název stavu.

např. Odesláno
descriptionstringpovinné

Popis stavu.

např. Doklad byl odeslán zákazníkovi
visibilitybooleanpovinné

Stav se nabízí u dokladů.

to_be_paidnumber<double>povinné

Kolik ze zálohové faktury zbývá uhradit, v měně dokladu.

např. 50
to_be_invoicednumber<double>povinné

Kolik ze zálohové faktury zbývá odečíst na koncových fakturách vydaných, v měně dokladu.

např. 50
share_linkstring | nullmůže být null

Veřejný odkaz na doklad. Vzniká až voláním PUT /proforma_invoice_issued/{id}/share.

např. https://online.iucto.cz/link/p?s=ukazka-tajny-odkaz-nema-tenhle-tvar
modifiedstring<date-time>

Datum a čas poslední změny záznamu. Jediné pole, podle kterého jde tenhle seznam řadit (sort=-modified), takže se používá jako vodoznak při inkrementálním stahování.

např. 2026-08-07T19:03:56+02:00
oss_modeboolean

Doklad je v režimu One Stop Shop. Podmínky režimu popisuje průvodce doklady.

idinteger

ID dokladu.

price_inc_vatnumber<double>povinné

Cena celkem včetně DPH v měně dokladu.

např. 50
deletedboolean

Doklad je smazaný.

sequence_codestringmax. délka 45

Číslo dokladu. Když se nevyplní, přidělí ho číselná řada nastavená ve firmě.

např. DOC20190001
variable_symbolstringmax. délka 10

Variabilní symbol.

např. 20190001
datestring<date>povinné

Datum vystavení.

např. 2019-07-12
date_vatstring<date>

Datum zdanitelného plnění. U neplátce DPH se nevyplňuje.

např. 2019-01-10
maturity_datestring<date>povinné

Datum splatnosti.

např. 2019-01-25
currencyCurrencyCodepovinné

Měna dokladu.

např. CZK
pricenumber<double>povinné

Cena bez DPH v měně dokladu.

např. 50
price_czknumber<double>povinné

Cena bez DPH v CZK.

např. 50
price_inc_vat_czknumber<double>povinné

Cena celkem včetně DPH v CZK.

např. 50
items object[]povinné

Položky dokladu.

  • Array [
  • idintegerpovinné

    ID položky.

    textstringpovinnémax. délka 255

    Popis položky.

    např. Položka A
    amountnumberpovinné

    Počet jednotek.

    např. 1
    pricenumber<double>povinné

    Cena za jednotku.

    např. 50
    unit_price_inc_vatboolean

    Cena za jednotku je uvedená včetně DPH.

    unitstringmax. délka 10

    Jednotka.

    např. ks
    vatnumber

    Sazba DPH v procentech. Platné sazby vrací Sazby DPH.

    např. 21
    vat_totalnumber<double>

    DPH celkem za položku.

    např. 0
    department_idinteger
    contract_idinteger
    accountentrytype_idinteger | nullmůže být null

    ID typu účetní položky. Přepisuje chart_account_id.

    vattype_idinteger | nullmůže být null

    ID typu DPH. Přepisuje vat_chart_id.

    chart_account_idinteger | nullmůže být null
    vat_chart_idinteger | nullmůže být null
  • ]
  • payment_typePaymentTypepovinnétransfercashcashondeliveryreciprocitycreditcard

    Způsob úhrady dokladu. Popisy hodnot vrací Metody plateb.

    Pro transfer a creditcard je na dokladu povinný bank_account, pro cash, cashondelivery a reciprocity může být null.

    date_vat_prevstring<date>

    Datum předchozí sazby DPH. Vyplňuje se u dokladů, které spadají do období se změnou sazby.

    např. 2019-01-01
    descriptionstring

    Poznámka na dokladu.

    např. Popis
    rounding_typeRoundingTypenoneroundupdown

    Způsob zaokrouhlení. Když se nevyplní, použije se nastavení firmy.

    ProformaInvoiceIssuedDetail
    {
    "_links": {
    "self": {
    "href": "string"
    }
    },
    "customer": {
    "_links": {
    "self": {
    "href": "string"
    }
    },
    "id": 123,
    "name": "Jan Novák",
    "comid": "12345679",
    "email": "novak.jan@example.org",
    "phone": "+420123123123",
    "cellphone": "+420123123123",
    "customer_group_id": 78,
    "external_code": "CC123",
    "vat_payer": false,
    "vatid": "CZ12345679",
    "name_display": "Jan Novák ml.",
    "www": "https://www.iucto.cz",
    "usual_maturity": 30,
    "preferred_payment_method": "transfer",
    "invoice_language": "cs",
    "address": {
    "street": "Stodolní 123",
    "city": "Ostrava",
    "postalcode": "385 02",
    "country": "CZ"
    },
    "note": "Věrný zákazník",
    "account_number1": "1234567890/0100",
    "account_number2": "1234-1234567890/4400",
    "account_number3": null,
    "account_number4": null,
    "default_department_id": 123,
    "default_contract_id": 321
    },
    "bank_account": {
    "_links": {
    "self": {
    "href": "string"
    }
    },
    "id": 456,
    "number": "19-123457/0100",
    "balance": 0,
    "balance_czk": 0,
    "realtime_payment_fetch": true,
    "name": "Komerční banka",
    "currency": "CZK",
    "isdefault": true,
    "account_prefix": "19",
    "account_number": "123457",
    "bank_code": "0100",
    "swift": "KOMBCZPPXXX",
    "iban": "CZ5601000000190000123457",
    "initial_state": 0,
    "chart_account_id": 424,
    "visible": true
    },
    "document_state": {
    "id": 123,
    "name": "Odesláno",
    "description": "Doklad byl odeslán zákazníkovi",
    "visibility": true
    },
    "to_be_paid": 50,
    "to_be_invoiced": 50,
    "share_link": "https://online.iucto.cz/link/p?s=ukazka-tajny-odkaz-nema-tenhle-tvar",
    "modified": "2026-08-07T19:03:56+02:00",
    "oss_mode": false,
    "id": 123,
    "price_inc_vat": 50,
    "deleted": false,
    "sequence_code": "DOC20190001",
    "variable_symbol": "20190001",
    "date": "2019-07-12",
    "date_vat": "2019-01-10",
    "maturity_date": "2019-01-25",
    "currency": "CZK",
    "price": 50,
    "price_czk": 50,
    "price_inc_vat_czk": 50,
    "items": [
    {
    "id": 123456,
    "text": "Položka A",
    "amount": 1,
    "price": 50,
    "unit_price_inc_vat": false,
    "unit": "ks",
    "vat": 21,
    "vat_total": 0,
    "department_id": 1,
    "contract_id": 1,
    "accountentrytype_id": 532,
    "vattype_id": 1,
    "chart_account_id": 46,
    "vat_chart_id": 52
    }
    ],
    "payment_type": "transfer",
    "date_vat_prev": "2019-01-01",
    "description": "Popis",
    "rounding_type": "round"
    }