Specifikace dat
Invoice (faktura)
| Název | Pouze ke čtení | Datový typ | Maximální délka | Hodnota |
|---|---|---|---|---|
| invoice_id | ✓ | String | 10 | ID faktury Twisto |
| parent_invoice_id | ✓ | String | 10 | ID faktury Twisto původní faktury, ze které vznikla rozdělením faktury |
| eshop_invoice_id | ✓ | String | 10 | ID faktury e-shopu. Pokud je vyplněno, použije se jako variabilní symbol platby na účet e-shopu. Povoleny jsou pouze číslice. |
| external_id | String | 50 | ID objednávky / faktury e-shopu. Pokud je vyplněno, vrátí se v odpovědích API a zobrazí v přehledu XLSX. | |
| customer_email | ✓ | String | 254 | E-mail zákazníka |
| billing_address | ✓ | Address Billing | Fakturační adresa | |
| delivery_address | ✓ | Address | Doručovací adresa | |
| date_created | ✓ | String | ISO 8601 | Datum a čas vytvoření faktury |
| date_returned | ✓ | String | ISO 8601 | Datum a čas vrácení faktury. Vyplněno jen u plně vrácené faktury. |
| date_cancelled | ✓ | String | ISO 8601 | Datum a čas zrušení faktury |
| date_activated | ✓ | String | ISO 8601 | Datum a čas aktivace faktury |
| date_paid | ✓ | String | ISO 8601 | Datum a čas úhrady faktury |
| date_due | ✓ | String | ISO 8601 | Aktuální datum splatnosti faktury |
| initial_date_due | ✓ | String | ISO 8601 | Počáteční datum splatnosti faktury |
| pdf_url | ✓ | String | 255 | URL PDF faktury pro zákazníka. Objeví se po aktivaci faktury (do té doby PDF neexistuje). |
| total_price_vat | ✓ | Number | 8.2 | Celková cena vč. DPH. 8 číslic, 2 desetinná místa. |
| items | Item[] | Položky objednávky | ||
| has_account | ✓ | Boolean | Zákazník má účet Twisto | |
| margin_amount | ✓ | Number | 8.2 | Celková částka marže Twisto bez DPH zaokrouhlená na 2 desetinná místa. |
| margin_amount_vat | ✓ | Number | 8.2 | Celková částka marže Twisto s DPH zaokrouhlená na 2 desetinná místa. |
| paid_to_merchant_amount | ✓ | Number | Částka vyplacená obchodníkovi. Pokud null, ještě nevyplaceno. Pokud 0, zákazník fakturu vrátil. Pokud víc než 0, Twisto obchodníkovi vyplatil. |
Customer (zákazník)
| Název | Povinné | Datový typ | Maximální délka | Příklad hodnoty |
|---|---|---|---|---|
| ✓ | String | 254 | E-mail zákazníka „jan.novak@example.com“ | |
| name | String | 255 | Jméno „Jan Novák“ | |
| facebook_id | String | 50 | Facebook ID „123456789“ | |
| company_id | String | 15 | IČO „12345678“ | |
| vat_id | String | 15 | DIČ „CZ12345678“ |
Order (objednávka)
| Název | Povinné | Datový typ | Maximální délka | Hodnota | Příklad |
|---|---|---|---|---|---|
| date_created | ✓ | String | ISO 8601 | Datum a čas vytvoření objednávky | "2013-07-22T14:57:18+00:00" |
| billing_address | ✓ | Address | Fakturační adresa | ||
| delivery_address | ✓ | Address | Doručovací adresa | ||
| total_price_vat | ✓ | Number | 8.2 | Celková cena včetně DPH | 1432.23 |
| items | ✓ | Item[] | Položky objednávky | ||
| delivery_method | Number | Typ dopravy: 11 – přepravní společnost, 12 – kurýr, 13 – pošta, 14 – osobní odběr, 15 – box, 16 – výdejní místo, 17 – virtuální zboží, 10 – jiné | 11 | ||
| delivery_method_detail | String | 255 | Detail dopravy. Doplňte podle typu: 11 (přepravce): název, 15 (box): název a adresa, 16 (výdejní místo): název a adresa, 10 (jiné): popis | "DPD" |
Item (položka)
| Název | Povinné | Datový typ | Maximální délka | Hodnota | Příklad |
|---|---|---|---|---|---|
| type | ✓ | Number | Typ položky: 0 – zboží, 1 – doprava, 2 – platba, 4 – sleva, 32 – zaokrouhlení | 0 | |
| name | ✓ | String | 255 | Název položky | "Růžový šátek s ornamenty" |
| product_id | ✓ | String | 255 | ID produktu (jedinečné v rámci objednávky) | "1001" |
| quantity | ✓ | Number | Množství | 2 | |
| price_vat | ✓ | Number | Cena vč. DPH | 406.07 | |
| vat | ✓ | Number | Sazba DPH v procentech | 21 | |
| ean_code | String | 13 | EAN kód | ||
| isbn_code | String | 13 | ISBN kód | ||
| issn_code | String | 8 | ISSN kód | ||
| heureka_category | Number | Kategorie Heureky – seznam najdete zde | 1469 | ||
| is_virtual | Boolean | Nastavte true u virtuálního zboží (např. poukazy). | false |
Item split
| Název | Povinné | Datový typ | Maximální délka | Hodnota | Příklad |
|---|---|---|---|---|---|
| product_id | ✓ | String | 255 | ID produktu (jedinečné v rámci objednávky) | "1001" |
| quantity | ✓ | Number | Počet kusů k rozdělení (větší než 0) | 2 |
Address (adresa)
| Název | Povinné | Datový typ | Maximální délka | Hodnota | Příklad |
|---|---|---|---|---|---|
| type | ✓ | Number | 1 | ||
| name | ✓ | String | 100 | Jméno | "Jan Novák" |
| street | ✓ | String | 100 | Ulice | "Wilsonova 300/8" |
| city | ✓ | String | 100 | Město | "Praha" |
| zipcode | ✓ | String | 5 | PSČ | "11000" |
| phone_number | ✓ | String | 20 | Telefonní číslo | "+420733123456" |
| country | ✓ | String | 2 | Kód země ve formátu ISO 3166-1 alpha-2 | "CZ" |