Specifikace dat

Invoice (faktura)

NázevPouze ke čteníDatový typMaximální délkaHodnota
invoice_idString10ID faktury Twisto
parent_invoice_idString10ID faktury Twisto původní faktury, ze které vznikla rozdělením faktury
eshop_invoice_idString10ID faktury e-shopu. Pokud je vyplněno, použije se jako variabilní symbol platby na účet e-shopu. Povoleny jsou pouze číslice.
external_idString50ID objednávky / faktury e-shopu. Pokud je vyplněno, vrátí se v odpovědích API a zobrazí v přehledu XLSX.
customer_emailString254E-mail zákazníka
billing_addressAddress BillingFakturační adresa
delivery_addressAddressDoručovací adresa
date_createdStringISO 8601Datum a čas vytvoření faktury
date_returnedStringISO 8601Datum a čas vrácení faktury. Vyplněno jen u plně vrácené faktury.
date_cancelledStringISO 8601Datum a čas zrušení faktury
date_activatedStringISO 8601Datum a čas aktivace faktury
date_paidStringISO 8601Datum a čas úhrady faktury
date_dueStringISO 8601Aktuální datum splatnosti faktury
initial_date_dueStringISO 8601Počáteční datum splatnosti faktury
pdf_urlString255URL PDF faktury pro zákazníka. Objeví se po aktivaci faktury (do té doby PDF neexistuje).
total_price_vatNumber8.2Celková cena vč. DPH. 8 číslic, 2 desetinná místa.
itemsItem[]Položky objednávky
has_accountBooleanZákazník má účet Twisto
margin_amountNumber8.2Celková částka marže Twisto bez DPH zaokrouhlená na 2 desetinná místa.
margin_amount_vatNumber8.2Celková částka marže Twisto s DPH zaokrouhlená na 2 desetinná místa.
paid_to_merchant_amountNumberČá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ázevPovinnéDatový typMaximální délkaPříklad hodnoty
emailString254E-mail zákazníka „jan.novak@example.com“
nameString255Jméno „Jan Novák“
facebook_idString50Facebook ID „123456789“
company_idString15IČO „12345678“
vat_idString15DIČ „CZ12345678“

Order (objednávka)

NázevPovinnéDatový typMaximální délkaHodnotaPříklad
date_createdStringISO 8601Datum a čas vytvoření objednávky"2013-07-22T14:57:18+00:00"
billing_addressAddressFakturační adresa
delivery_addressAddressDoručovací adresa
total_price_vatNumber8.2Celková cena včetně DPH1432.23
itemsItem[]Položky objednávky
delivery_methodNumberTyp 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_detailString255Detail 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ázevPovinnéDatový typMaximální délkaHodnotaPříklad
typeNumberTyp položky: 0 – zboží, 1 – doprava, 2 – platba, 4 – sleva, 32 – zaokrouhlení0
nameString255Název položky"Růžový šátek s ornamenty"
product_idString255ID produktu (jedinečné v rámci objednávky)"1001"
quantityNumberMnožství2
price_vatNumberCena vč. DPH406.07
vatNumberSazba DPH v procentech21
ean_codeString13EAN kód
isbn_codeString13ISBN kód
issn_codeString8ISSN kód
heureka_categoryNumberKategorie Heureky – seznam najdete zde1469
is_virtualBooleanNastavte true u virtuálního zboží (např. poukazy).false

Item split

NázevPovinnéDatový typMaximální délkaHodnotaPříklad
product_idString255ID produktu (jedinečné v rámci objednávky)"1001"
quantityNumberPočet kusů k rozdělení (větší než 0)2

Address (adresa)

NázevPovinnéDatový typMaximální délkaHodnotaPříklad
typeNumber1
nameString100Jméno"Jan Novák"
streetString100Ulice"Wilsonova 300/8"
cityString100Město"Praha"
zipcodeString5PSČ"11000"
phone_numberString20Telefonní číslo"+420733123456"
countryString2Kód země ve formátu ISO 3166-1 alpha-2"CZ"