Square Payments (Independent Publisher) (Preview)

Square pomáhá milionům prodejců provozovat svou firmu – od zabezpečeného zpracování platebních karet až po prodejní řešení. Tento konektor obsahuje akce pro následující koncové body: platby, terminál, objednávky, předplatná, faktury, katalog, inventář a zákazníci.

Tento konektor je dostupný v následujících produktech a oblastech:

Service	Class	Regions
Copilot Studio	Premium	Všechny oblasti Power Automate s výjimkou následujících:      – státní správa USA (GCC)      – státní správa USA (GCC High)      - China Cloud provozovaný společností 21Vianet      - Ministerstvo obrany USA (DoD)
Logic Apps	Standard	Všechny oblasti Logic Apps s výjimkou následujících:      – Oblasti Azure Government      – Oblasti Azure China      - Ministerstvo obrany USA (DoD)
Power Apps	Premium	Všechny oblasti Power Apps s výjimkou následujících:      – státní správa USA (GCC)      – státní správa USA (GCC High)      - China Cloud provozovaný společností 21Vianet      - Ministerstvo obrany USA (DoD)
Power Automate	Premium	Všechny oblasti Power Automate s výjimkou následujících:      – státní správa USA (GCC)      – státní správa USA (GCC High)      - China Cloud provozovaný společností 21Vianet      - Ministerstvo obrany USA (DoD)

Kontakt
Název	Troy Taylor
URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

Metadata konektoru
Vydavatel	Troy Taylor
Internetová stránka	https://squareup.com/
Zásady ochrany osobních údajů	https://squareup.com/us/en/legal/general/privacy
Kategorie	Obchod; Sales and CRM

Limity omezování

Name	Volání	Období obnovení
Volání rozhraní API na připojení	100	60 sekund

Akce

Aktualizace daní položek	Aktualizuje objekty CatalogTax, které se vztahují na cílový CatalogItem, aniž by bylo nutné provést upsert pro celou položku.
Aktualizace faktury	Aktualizuje fakturu úpravou polí, vymazáním polí nebo obojího.
Aktualizace platby	Aktualizuje platbu se stavem APPROVED. Pomocí tohoto koncového bodu můžete aktualizovat amount_money a tip_money.
Aktualizace předplatného	Aktualizuje předplatné. Hodnoty polí předplatného můžete nastavit, upravit a vymazat.
Aktualizace seznamů modifikátoru položek	Aktualizuje catalogModifierList objekty, které platí pro cílový CatalogItem, aniž by bylo nutné provést upsert pro celou položku.
Aktualizace skupiny zákazníků	Aktualizuje skupinu zákazníků.
Aktualizace zákazníka	Aktualizuje profil zákazníka. Pokud chcete změnit atribut, zadejte novou hodnotu. Pokud chcete atribut odebrat, zadejte hodnotu jako prázdný řetězec nebo prázdný objekt.
Batch načítá počty inventáře	Vrátí aktuální počty zadaných objektů CatalogObjects v požadovaných umístěních.
Dokončit platbu	Dokončí (zachytí) platbu. Ve výchozím nastavení se platby nastaví tak, aby se dokončily okamžitě po jejich vytvoření.
Dávkové načtení objednávek	Načte sadu objednávek podle jejich ID. Pokud dané ID objednávky neexistuje, id se místo generování chyby ignoruje.
Dávkové načtení objektů katalogu	Vrátí sadu objektů na základě zadaného ID. Každý CatalogItem vrácený v sadě obsahuje všechny jeho podřízené informace, včetně: všechny jeho CatalogItemVariation objekty, odkazy na jeho CatalogModifierList objekty a ID všech CatalogTax objektů, které se na něj vztahují.
Dávkové načtení změn inventáře	Vrátí historické fyzické počty a úpravy na základě zadaných kritérií filtru.
Dávkové odstranění objektů katalogu	Odstraní sadu CatalogItems na základě zadaného seznamu cílových ID a vrátí sadu úspěšně odstraněných ID v odpovědi.
Hledat faktury	Vyhledá faktury z umístění zadaného ve filtru.
Hledat zákazníky	Vyhledá profily zákazníků přidružené k účtu Square pomocí podporovaného filtru dotazů. Volání SearchCustomers bez explicitního filtru dotazu vrátí všechny profily zákazníků seřazené abecedně podle given_name a family_name.
Hledání předplatných	Vyhledá předplatná. Výsledky jsou seřazeny chronologicky podle data vytvoření předplatného. Pokud požadavek určuje více než jedno ID umístění, koncový bod si výsledek vyžádá podle ID umístění a potom podle data vytvoření v rámci každého umístění. Pokud dotaz neobsahuje žádná umístění, vyhledá se všechna umístění.
Informace o katalogu	Načte informace o rozhraní API pro čtvercové katalogy, jako jsou limity velikosti dávky, které lze použít koncovým bodem BatchUpsertCatalogObjects.
Inventář změn služby Batch	Použije úpravy a počty na poskytnuté množství položek. Při úspěchu: vrátí aktuální počítané počty pro všechny objekty odkazované v požadavku.
Karty seznamu	Načte seznam karet vlastněných účtem, který žádost provádí.
Katalog seznamů	Vrátí seznam CatalogObjects, který obsahuje všechny objekty sady požadovaných typů (například všechny objekty CatalogItem a CatalogTax) v katalogu. ListCatalog nevrací odstraněné položky katalogu.
Načtení důkazů o sporu	Vrátí metadata důkazů zadaná ID důkazu v cestě URL požadavku. Pokud na něj budete chtít později odkazovat, musíte zachovat kopii důkazů, které nahrajete. Po nahrání nemůžete stáhnout důkazy.
Načtení fyzického počtu inventáře	Vrátí objekt InventoryPhysicalCount se zadaným physical_count_id.
Načtení karty	Načte podrobnosti o konkrétní kartě.
Načtení objektu katalogu	Vrátí jeden CatalogItem jako CatalogObject na základě zadaného ID. Vrácený objekt obsahuje všechny relevantní informace CatalogItem včetně: CatalogItemVariation podřízených objektů, odkazy na jeho CatalogModifierList objekty a ID všech CatalogTax objektů, které se na něj vztahují.
Načtení počtu inventáře	Načte aktuální počítaný počet akcií pro daný objekt CatalogObject v dané sadě umístění.
Načtení předplatného	Načte předplatné.
Načtení přenosu inventáře (beta verze)	Vrátí objekt InventoryTransfer se zadaným transfer_id.
Načtení segmentu zákazníka	Načte konkrétní segment zákazníka.
Načtení skupiny zákazníků	Načte konkrétní skupinu zákazníků.
Načtení sporu	Vrátí podrobnosti o konkrétním sporu.
Načtení zákazníka	Vrátí podrobnosti pro jednoho zákazníka.
Načtení úpravy inventáře	Vrátí objekt InventoryAdjustment se zadaným adjustment_id.
Načíst pořadí	Načte objednávku podle ID.
Objekt katalogu Upsert	Vytvoří nebo aktualizuje cílový objekt CatalogObject.
Objekty katalogu Upsert služby Batch	Vytvoří nebo aktualizuje až 10 000 cílových objektů na základě zadaného seznamu objektů. Cílové objekty jsou seskupeny do dávek a každá dávka se vloží nebo aktualizuje úplně nebo jinak. Pokud je objekt v dávce nějakým způsobem poškozený nebo porušuje omezení databáze, bude celá dávka obsahující tuto položku ignorována. Jiné dávky ve stejném požadavku však mohou být i nadále úspěšné. Každá dávka může obsahovat až 1 000 objektů a dávky budou zpracovány v pořadí, pokud celkový počet objektů pro požadavek (položky, varianty, modifikační seznamy, slevy a daně) není větší než 10 000.
Obnovení předplatného	Obnoví deaktivované předplatné.
Odebrání skupiny od zákazníka	Odebere členství ve skupině od zákazníka. Zákazník je identifikován hodnotou customer_id a skupina zákazníků je identifikována hodnotou group_id.
Odeslat důkaz	Odešle důkaz do banky držitele karty. Před odesláním důkazů Square zkompiluje všechny dostupné důkazy. To zahrnuje důkazy nahrané pomocí koncových bodů CreateDisputeEvidenceFile a CreateDisputeEvidenceText a důkazů automaticky poskytovaných square, pokud je k dispozici.
Odstranění důkazů o sporu	Odebere zadané důkazy z sporu.
Odstranění faktury	Odstraní zadanou fakturu. Po odstranění faktury se přidružený stav objednávky změní na CANCELED. Můžete odstranit jenom koncept faktury (publikovanou fakturu nemůžete odstranit, včetně faktury, která je naplánovaná ke zpracování).
Odstranění objektu katalogu	Odstraní jeden catalogObject na základě zadaného ID a vrátí sadu úspěšně odstraněných ID v odpovědi. Odstranění je kaskádová událost, která zajistí odstranění všech podřízených objektů cílového objektu. Odstraněním položky CatalogItem například odstraníte také všechny podřízené položky CatalogItemVariation.
Odstranění skupiny zákazníků	Odstraní skupinu zákazníků podle hodnoty group_id.
Odstranění zákazníka	Odstraní profil zákazníka z firmy. Tato operace také zruší propojení všech přidružených karet v souboru.
Platba objednávky (beta verze)	Platíte za objednávku pomocí jedné nebo více schválených plateb nebo vypořádejte objednávku s celkem 0. Celkový součet payment_ids uvedených v požadavku musí být roven celkovému součtu objednávky. Objednávky s celkovou částkou 0 je možné označit jako zaplacené zadáním prázdného pole payment_ids v požadavku.
Pořadí aktualizací (beta verze)	Aktualizuje otevřené pořadí přidáním, nahrazením nebo odstraněním polí. Objednávky se stavem COMPLETED nebo CANCELED nelze aktualizovat.
Pořadí klonování (beta verze)	Vytvoří nové pořadí ve stavu KONCEPT duplikováním existující objednávky. Nově vytvořená objednávka obsahuje pouze základní pole (například řádkové položky, daně a slevy) zkopírovaná z původní objednávky.
Prohledat objednávky	Vyhledejte všechna pořadí pro jedno nebo více míst. Objednávky zahrnují všechny prodeje, výnosy a výměny bez ohledu na to, jak nebo kdy vstoupily do ekosystému Square (například prodejní bod, faktury a rozhraní API pro připojení).
Publikování faktury	Publikuje zadanou koncept fakturu. Po publikování faktury bude square následovat na základě konfigurace faktury. Například Square odešle fakturu na e-mailovou adresu zákazníka, účtuje kartu zákazníka v souboru nebo nic nedělá. Square také zpřístupňuje fakturu na stránce faktury hostované na náměstí.
Přidání skupiny k zákazníkovi	Přidá do zákazníka členství ve skupině. Zákazník je identifikován hodnotou customer_id a skupina zákazníků je identifikována hodnotou group_id.
Přijmout spor	Přijme ztrátu sporu. Square vrátí spornou částku držiteli karet a aktualizuje stav sporu na AKCEPTOVANÝ. Square inkasuje spornou částku z účtu náměstí prodejce. Pokud čtvereční účet nemá dostatek finančních prostředků, square inkasuje přidružený bankovní účet.
Refundace platby	Vrátí platbu. Můžete vrátit celou částku platby nebo jeho část. Tento koncový bod můžete použít k refundaci platby kartou nebo zaznamenání refundace hotovosti nebo externí platby.
Refundace v terminálech vyhledávání	Načte filtrovaný seznam žádostí o refundaci terminálu Interac vytvořených prodejcem, který žádost vytvořila.
Registrace domény pro Apple Pay	Aktivuje doménu pro použití s Apple Pay na webu a náměstí. V této doméně provádí Apple ověření, aby se zajistilo, že je správně nastavená jako doména s podporou Apple Pay.
Rezervace terminálů vyhledávání	Načte filtrovaný seznam žádostí o rezervaci terminálu vytvořených účtem, který žádost provádí.
Vyhledávání objektů katalogu	Vyhledá objekt CatalogObject libovolného typu podle odpovídajících podporovaných hodnot atributů vyhledávání, s výjimkou hodnot vlastních atributů u položek nebo variant položek, na jednom nebo několika zadaných filtrech dotazu.
Vytvoření faktury	Vytvoří koncept faktury pro objednávku vytvořenou pomocí rozhraní API Objednávky. Koncept faktury zůstane na vašem účtu a neprovedou se žádné akce. Fakturu musíte publikovat, než ji bude moct square zpracovat (poslat ji na e-mailovou adresu zákazníka nebo účtovat kartu zákazníka v souboru).
Vytvoření karty	Přidá kartu do souboru existujícímu obchodníku.
Vytvoření platby	Vytvoří platbu pomocí poskytnutého zdroje. Pomocí tohoto koncového bodu můžete účtovat kartu (kreditní/debetní nebo čtvercovou dárkovou kartu) nebo zaznamenávat platbu, kterou prodejce obdržel mimo square (platbu hotovostí od kupujícího nebo platby, kterou externí entita zpracovala jménem prodejce).
Vytvoření předplatného	Vytvoří předplatné pro zákazníka k plánu předplatného. Pokud v žádosti zadáte kartu v souboru, za předplatné se naúčtuje karta Square. V opačném případě společnost Square fakturuje fakturu na e-mailovou adresu zákazníka. Předplatné se spustí okamžitě, pokud požadavek neobsahuje volitelnou start_date. Každé individuální předplatné je přidružené k určitému umístění.
Vytvoření refundace terminálů	Vytvoří žádost o refundaci platby Interac dokončené na náměstí terminálu.
Vytvoření rezervace terminálu	Vytvoří žádost o rezervaci terminálu a odešle ji do zadaného zařízení, aby převzala platbu za požadovanou částku.
Vytvoření skupiny zákazníků	Vytvoří novou skupinu zákazníků pro firmu.
Vytvoření textu důkazu sporu	Nahraje text, který se použije jako důkaz pro sporový problém.
Vytvoření zákazníka	Vytvoří nového zákazníka pro firmu.
Vytvořit objednávku	Vytvoří novou objednávku, která může obsahovat informace o produktech pro nákup a nastavení, která se mají na nákup použít.
Výpis důkazů o sporu	Vrátí seznam důkazů spojených se sporem.
Výpis faktur	Vrátí seznam faktur pro dané umístění.
Výpis plateb	Načte seznam plateb přijatých účtem, který žádost provádí. Výsledky jsou nakonec konzistentní a nové platby nebo změny plateb můžou trvat několik sekund.
Výpis refundací plateb	Načte seznam refundací pro účet, který žádost provádí. Výsledky jsou nakonec konzistentní a zobrazení nových refundací nebo změn refundací může trvat několik sekund.
Výpis segmentů zákazníků	Načte seznam segmentů zákazníků firmy.
Výpis skupin zákazníků	Načte seznam skupin zákazníků firmy.
Výpis sporů	Vrátí seznam sporů spojených s konkrétním účtem.
Výpis událostí odběru	Zobrazí seznam všech událostí pro konkrétní předplatné.
Výpis zákazníků	Zobrazí seznam profilů zákazníků přidružených k účtu Square. Za normálních provozních podmínek se nově vytvořené nebo aktualizované profily zákazníků zpřístupní pro operaci výpisu do 30 sekund. Někdy může šíření nových nebo aktualizovaných profilů trvat déle než jednu minutu, zejména při incidentech a výpadkech sítě.
Výpočet pořadí (beta verze)	Umožňuje aplikacím zobrazit náhled cen objednávek bez vytvoření objednávky.
Zakázání karty	Zakáže kartu a zabrání dalším aktualizacím nebo poplatkům. Zakázání již zakázané karty je povolené, ale nemá žádný vliv.
Zrušení faktury	Zruší fakturu. Prodejce nemůže shromažďovat platby za zrušenou fakturu.
Zrušení platby	Zruší platbu (voids). Tento koncový bod můžete použít ke zrušení platby se stavem APPROVED.
Zrušení platby pomocí idempotentního klíče	Zruší (voids) platbu identifikovanou klíčem idempotence, který je zadaný v požadavku. Tuto metodu použijte, pokud je stav požadavku CreatePayment neznámý (například po odeslání požadavku CreatePayment dojde k chybě sítě a nedostanete odpověď). V takovém případě můžete nasměrovat square k zrušení platby pomocí tohoto koncového bodu. V žádosti zadáte stejný klíč idempotence, který jste zadali v požadavku CreatePayment, který chcete zrušit. Po zrušení platby můžete žádost o vytvoření zálohy odeslat znovu. Upozorňujeme, že pokud se nenajde žádná platba se zadaným klíčem idempotence, neprovedou se žádné akce a koncový bod se úspěšně vrátí.
Zrušení předplatného	Nastaví pole canceled_date na konec aktivního fakturačního období. Po tomto datu se stav změní z AKTIVNÍ na ZRUŠENO.
Zrušení refundace terminálů	Zruší žádost o refundaci v rámci terminálu interac podle ID žádosti o refundaci, pokud to stav žádosti umožňuje.
Zrušení rezervace terminálu	Zruší žádost o rezervaci terminálu, pokud ji stav žádosti povolí.
Získání faktury	Načte fakturu podle ID faktury.
Získání platby	Načte podrobnosti pro konkrétní platbu.
Získání pokladny terminálu	Načte žádost o rezervaci terminálu checkout_id.
Získání refundace plateb	Načte konkrétní refundaci pomocí refund_id.
Získání refundace terminálů	Načte objekt refundace terminálu Interac podle ID.

Aktualizace daní položek

ID operace:

CatalogUpdateTaxes

Aktualizuje objekty CatalogTax, které se vztahují na cílový CatalogItem, aniž by bylo nutné provést upsert pro celou položku.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID položek	item_ids		array of string
Daně k povolení	taxes_to_enable		array of string
Daně k zákazu	taxes_to_disable		array of string

Návraty

Name	Cesta	Typ	Description
Aktualizováno na adrese	updated_at	string	Časové razítko databáze této aktualizace ve formátu RFC 3339.

Aktualizace faktury

ID operace:

InvoiceUpdate

Aktualizuje fakturu úpravou polí, vymazáním polí nebo obojího.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID faktury	invoice_id	True	string	Identifikátor faktury.
Idempotency Key	idempotency_key		string	Zadaná hodnota, která jednoznačně identifikuje tento požadavek mezi všemi vašimi požadavky. Běžným způsobem vytvoření platného klíče idempotence je použití univerzálního jedinečného identifikátoru (UUID).
UID	uid		string	ID vygenerované čtvercem.
Povolené provazování	tipping_enabled		boolean	Pokud je nastavená hodnota true, poskytne zákazníkovi místo, kde může zaplatit tip.
Pole k vymazání	fields_to_clear		array of string

Návraty

Name	Cesta	Typ	Description
ID	invoice.id	string	Jedinečný identifikátor vystavený čtvercem.
Version	invoice.version	integer	Aktuální verze tohoto objektu.
ID místa	invoice.location_id	string	Identifikátor umístění.
ID objednávky	invoice.order_id	string	ID objednávky.
Žádosti o platbu	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	ID vygenerované čtvercem.
Typ požadavku	invoice.payment_requests.request_type	string	Určuje typ žádosti o platbu. Tento typ definuje způsob určení částky žádosti o platbu.
Termín splnění	invoice.payment_requests.due_date	string	Termín splatnosti pro žádost o platbu ve formátu RRRR-MM-DD.
Povolené provazování	invoice.payment_requests.tipping_enabled	boolean	Pokud je nastavená hodnota true, poskytne zákazníkovi místo, kde může zaplatit tip.
Množství	invoice.payment_requests.computed_amount_money.amount	integer	Částka.
Měna	invoice.payment_requests.computed_amount_money.currency	string	Měna.
Množství	invoice.payment_requests.total_completed_amount_money.amount	integer	Částka.
Měna	invoice.payment_requests.total_completed_amount_money.currency	string	Měna.
Automatický zdroj plateb	invoice.payment_requests.automatic_payment_source	string	Způsob platby pro automatickou platbu.
Číslo faktury	invoice.invoice_number	string	Uživatelsky přívětivé číslo faktury. Hodnota je jedinečná v rámci umístění. Pokud není k dispozici při vytváření faktury, square přiřadí hodnotu.
Title	invoice.title	string	Název.
Description	invoice.description	string	Popis.
Naplánováno na	invoice.scheduled_at	string	Časové razítko při naplánování zpracování ve formátu RFC 3339.
Stav	invoice.status	string	Aktuální stav ověření tohoto objektu.
Timezone	invoice.timezone	string	Časové pásmo sloužící k interpretaci kalendářních dat. Při vytvoření faktury je toto pole nastaveno na časové pásmo určené pro umístění prodejce. Hodnotu nelze změnit.
Vytvořeno na adrese	invoice.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	invoice.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
ID zákazníka	invoice.primary_recipient.customer_id	string	ID zákazníka přidruženého k objednávce.
křestní jméno	invoice.primary_recipient.given_name	string	Jméno příjemce (tj. jméno).
Příjmení	invoice.primary_recipient.family_name	string	Rodina příjemce (tj. příjmení).
E-mailová adresa	invoice.primary_recipient.email_address	string	E-mailová adresa příjemce.
Telefonní číslo	invoice.primary_recipient.phone_number	string	Telefonní číslo příjemce.
Množství	invoice.next_payment_amount_money.amount	integer	Částka.
Měna	invoice.next_payment_amount_money.currency	string	Měna.
Card	invoice.accepted_payment_methods.card	boolean	Určuje, zda jsou přijímány platby kreditní kartou nebo debetní kartou.
Čtvercová dárková karta	invoice.accepted_payment_methods.square_gift_card	boolean	Určuje, jestli jsou přijímány platby za dárkové karty square.
Bankovní účet	invoice.accepted_payment_methods.bank_account	boolean	Určuje, zda jsou přijímány platby bankovním převodem.
Vlastní pole	invoice.custom_fields	array of object
Označení	invoice.custom_fields.label	string	Popisek nebo název vlastního pole
Hodnota	invoice.custom_fields.value	string	Text vlastního pole
Umístění	invoice.custom_fields.placement	string	Umístění vlastního pole na faktuře
Metoda doručení	invoice.delivery_method	string	Metoda doručení, kterou Square používá k odeslání faktury, připomenutí a účtenek zákazníkovi. Po publikování faktury square zpracuje fakturu na základě způsobu doručení a nastavení žádosti o platbu, a to buď okamžitě, nebo v scheduled_at datu, pokud je zadáno.
Datum prodeje nebo služby	invoice.sale_or_service_date	string	Datum prodeje nebo datum vykreslení služby ve formátu RRRR-MM-DD. Toto pole lze použít k zadání data v minulosti nebo budoucnosti, které se zobrazí na faktuře.

Aktualizace platby

ID operace:

PaymentUpdate

Aktualizuje platbu se stavem APPROVED. Pomocí tohoto koncového bodu můžete aktualizovat amount_money a tip_money.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID platby	payment_id	True	string	Identifikátor platby.
Idempotency Key	idempotency_key		string	Zadaná hodnota, která jednoznačně identifikuje tento požadavek mezi všemi vašimi požadavky. Běžným způsobem vytvoření platného klíče idempotence je použití univerzálního jedinečného identifikátoru (UUID).
Množství	amount		integer	Částka.
Měna	currency		string	Měna.
Množství	amount		integer	Částka.
Měna	currency		string	Měna.
Token verze	version_token		string	Tento neprůhlený token identifikuje konkrétní verzi objektu.

Návraty

Name	Cesta	Typ	Description
ID	payment.id	string	Jedinečný identifikátor vystavený čtvercem.
Vytvořeno na adrese	payment.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	payment.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
Množství	payment.amount_money.amount	integer	Částka.
Měna	payment.amount_money.currency	string	Měna.
Množství	payment.tip_money.amount	integer	Částka.
Měna	payment.tip_money.currency	string	Měna.
Stav	payment.status	string	Aktuální stav ověření tohoto objektu.
Doba trvání zpoždění	payment.delay_duration	string	Doba trvání po vytvoření platby, kdy square automaticky použije delay_action na platbu. Tato automatická delay_action se vztahuje pouze na platby, které nedosahují stavu terminálu (COMPLETED, CANCELED nebo FAILED) před delay_duration časovým obdobím. Toto pole je určeno jako časová doba trvání ve formátu RFC 3339.
Typ zdroje	payment.source_type	string	Typ zdroje pro tuto platbu. Mezi aktuální hodnoty patří KARTA, BANK_ACCOUNT, PENĚŽENKA, HOTOVOST nebo EXTERNÍ.
Stav	payment.card_details.status	string	Aktuální stav.
Značka karty	payment.card_details.card.card_brand	string	Značka karty.
Posledních 4	payment.card_details.card.last_4	string	Posledních 4 číslic čísla karty.
Exp Month	payment.card_details.card.exp_month	integer	Měsíc vypršení platnosti přidružené karty jako celé číslo mezi 1 a 12.
Exp Year	payment.card_details.card.exp_year	integer	Čtyřciferný rok data vypršení platnosti karty.
Otisk prstu	payment.card_details.card.fingerprint	string	Zamýšlený jako identifikátor přiřazený k čtverci na základě čísla karty k identifikaci karty na více místech v rámci jedné aplikace.
Typ karty	payment.card_details.card.card_type	string	Typ karty.
Předplacený typ	payment.card_details.card.prepaid_type	string	Určuje, jestli je karta předplacená nebo ne.
POPELNICE	payment.card_details.card.bin	string	Prvních šest číslic čísla karty, označované jako identifikační číslo banky (BIN).
Entry – metoda	payment.card_details.entry_method	string	Metoda použitá k zadání údajů o platbě na kartě. Metoda může být KEYED, POTÁHNUTÍ PRSTEM, EMV, ON_FILE nebo BEZ KONTAKTU.
Stav CVV	payment.card_details.cvv_status	string	Stavový kód vrácený z kontroly ověřovací hodnoty karty (CVV). Kód může být CVV_ACCEPTED, CVV_REJECTED nebo CVV_NOT_CHECKED.
Stav AVS	payment.card_details.avs_status	string	Stavový kód vrácený z kontroly systému ověřování adres (AVS). Kód může být AVS_ACCEPTED, AVS_REJECTED nebo AVS_NOT_CHECKED.
Ověřovací kód výsledku	payment.card_details.auth_result_code	string	Stavový kód vrácený vystavitelem karty, který popisuje stav autorizace platby.
Popis příkazu	payment.card_details.statement_description	string	Popis příkazu odeslaný do sítí karet.
Autorizované na adrese	payment.card_details.card_payment_timeline.authorized_at	string	Časové razítko, kdy byla platba autorizována, ve formátu RFC 3339.
ID místa	payment.location_id	string	Identifikátor umístění.
ID objednávky	payment.order_id	string	ID objednávky.
Vytvořeno na adrese	payment.risk_evaluation.created_at	string	Časové razítko při vytváření ve formátu RFC 3339.
Úroveň rizika	payment.risk_evaluation.risk_level	string	Úroveň rizika spojená s platbou.
Poznámka:	payment.note	string	Vlastní poznámka přidružená k profilu zákazníka.
ID zákazníka	payment.customer_id	string	ID tohoto objektu představujícího zákazníka.
Množství	payment.total_money.amount	integer	Částka.
Měna	payment.total_money.currency	string	Měna.
Množství	payment.approved_money.amount	integer	Částka.
Měna	payment.approved_money.currency	string	Měna.
Capabilities	payment.capabilities	array of string
Číslo potvrzení	payment.receipt_number	string	Číslo potvrzení platby. Pole chybí, pokud je platba zrušena.
Zpožďovací akce	payment.delay_action	string	Akce, která se má použít na platbu, když delay_duration uplynula.
Zpožděno do	payment.delayed_until	string	Časové razítko jen pro čtení, kdy se delay_action automaticky použije ve formátu RFC 3339.
Čtvercový součin	payment.application_details.square_product	string	Produkt čtverce, například nákupní bod prodeje (POS), čtvercové faktury nebo terminál čtvercového virtuálního terminálu.
Identifikátor aplikace	payment.application_details.application_id	string	ID čtverce jen pro čtení přiřazené aplikaci
Token verze	payment.version_token	string	Tento neprůhlený token identifikuje konkrétní verzi objektu.

Aktualizace předplatného

ID operace:

SubscriptionUpdate

Aktualizuje předplatné. Hodnoty polí předplatného můžete nastavit, upravit a vymazat.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Identifikátor předplatného	subscription_id	True	string	Identifikátor předplatného.
Version	version		integer	Aktuální verze tohoto objektu.
Procento daně	tax_percentage		string	Částka daně uplatněná při fakturaci předplatného.
Množství	amount		integer	Částka.
Měna	currency		string	Měna.

Návraty

Name	Cesta	Typ	Description
ID	subscription.id	string	Jedinečný identifikátor vystavený čtvercem.
ID místa	subscription.location_id	string	Identifikátor umístění.
ID plánu	subscription.plan_id	string	ID přidruženého plánu předplatného.
ID zákazníka	subscription.customer_id	string	ID tohoto objektu představujícího zákazníka.
Stav	subscription.status	string	Aktuální stav ověření tohoto objektu.
Množství	subscription.price_override_money.amount	integer	Částka.
Měna	subscription.price_override_money.currency	string	Měna.
Version	subscription.version	integer	Aktuální verze tohoto objektu.
Vytvořeno na adrese	subscription.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Timezone	subscription.timezone	string	Časové pásmo sloužící k interpretaci kalendářních dat. Při vytvoření faktury je toto pole nastaveno na časové pásmo určené pro umístění prodejce. Hodnotu nelze změnit.
Název	subscription.source.name	string	Název.

Aktualizace seznamů modifikátoru položek

ID operace:

CatalogUpdateModifier

Aktualizuje catalogModifierList objekty, které platí pro cílový CatalogItem, aniž by bylo nutné provést upsert pro celou položku.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID položek	item_ids		array of string
Modifikační seznamy pro povolení	modifier_lists_to_enable		array of string
Modifikační seznamy pro zakázání	modifier_lists_to_disable		array of string

Návraty

Name	Cesta	Typ	Description
Aktualizováno na adrese	updated_at	string	Časové razítko databáze této aktualizace ve formátu RFC 3339.

Aktualizace skupiny zákazníků

ID operace:

CustomerGroupUpdate

Aktualizuje skupinu zákazníků.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID skupiny	group_id	True	string	Identifikátor skupiny.
Název	name		string	Název objektu.

Návraty

Name	Cesta	Typ	Description
ID	group.id	string	Jedinečný identifikátor vystavený čtvercem.
Název	group.name	string	Název objektu.
Vytvořeno na adrese	group.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	group.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.

Aktualizace zákazníka

ID operace:

CustomerUpdate

Aktualizuje profil zákazníka. Pokud chcete změnit atribut, zadejte novou hodnotu. Pokud chcete atribut odebrat, zadejte hodnotu jako prázdný řetězec nebo prázdný objekt.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID zákazníka	customer_id	True	string	Identifikátor zákazníka.

Návraty

Name	Cesta	Typ	Description
ID	customer.id	string	Jedinečný identifikátor vystavený čtvercem.
Vytvořeno na adrese	customer.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	customer.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
křestní jméno	customer.given_name	string	Zadaný (tj. první) název přidružený k profilu zákazníka.
Příjmení	customer.family_name	string	Rodinné jméno (tj. příjmení) přidružené k profilu zákazníka.
E-mailová adresa	customer.email_address	string	E-mailová adresa přidružená k profilu zákazníka.
Řádek adresy 1	customer.address.address_line_1	string	První řádek adresy. Pole začínající address_line poskytují nejvýraznější podrobnosti adresy, například číslo ulice, název ulice a název budovy.
Řádek adresy 2	customer.address.address_line_2	string	Druhý řádek adresy, pokud existuje.
Lokalita	customer.address.locality	string	Město nebo město adresy.
Správní oblast – úroveň 1	customer.address.administrative_district_level_1	string	Civilní subjekt v rámci země adresy. V USA je to stát.
PSČ	customer.address.postal_code	string	PSČ adresy.
Country	customer.address.country	string	Země adresy ve formátu ISO 3166-1-alpha-2.
ID odkazu	customer.reference_id	string	Volitelné uživatelem definované REFERENČNÍ ID.
Poznámka:	customer.note	string	Vlastní poznámka přidružená k profilu zákazníka.
Odhlášení odběru e-mailu	customer.preferences.email_unsubscribed	boolean	Určuje, jestli se zákazník odhlásil od odběru e-mailů marketingové kampaně. Hodnota true znamená, že se zákazník rozhodl odhlásit se z e-mailového marketingu od aktuálního prodejce square nebo od všech prodejců square.
Zdroj vytvoření	customer.creation_source	string	Zdroj vytvoření představuje metodu použitou k vytvoření profilu zákazníka.
Version	customer.version	integer	Aktuální verze tohoto objektu.

Batch načítá počty inventáře

ID operace:

InventoryBatchRetrieveCounts

Vrátí aktuální počty zadaných objektů CatalogObjects v požadovaných umístěních.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID objektů katalogu	catalog_object_ids		array of string
ID umístění	location_ids		array of string
Aktualizováno po	updated_after		string	Filtr, který vrátí výsledky s jejich calculated_at hodnotou po daném čase, jak je uvedeno v časovém razítku RFC 3339.

Návraty

Name	Cesta	Typ	Description
Počítá	counts	array of object
ID objektu katalogu	counts.catalog_object_id	string	ID objektu CatalogObject generovaného čtvercem, které se sleduje.
Typ objektu katalogu	counts.catalog_object_type	string	Typ objektu CatalogObject, který se sleduje.
Stát	counts.state	string	Aktuální stav.
ID místa	counts.location_id	string	Identifikátor umístění.
Množství	counts.quantity	string	Počet položek ovlivněných odhadovaným počtem jako desetinný řetězec. Může podporovat až 5 číslic za desetinnou čárkou.
Vypočteno na	counts.calculated_at	string	Časové razítko ve formátu RFC 3339, které označuje, kdy byl přijat nejnovější fyzický počet nebo úprava ovlivňující odhadovaný počet.

Dokončit platbu

ID operace:

PaymentComplete

Dokončí (zachytí) platbu. Ve výchozím nastavení se platby nastaví tak, aby se dokončily okamžitě po jejich vytvoření.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID platby	payment_id	True	string	Identifikátor platby.

Návraty

Name	Cesta	Typ	Description
ID	payment.id	string	Jedinečný identifikátor vystavený čtvercem.
Vytvořeno na adrese	payment.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	payment.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
Množství	payment.amount_money.amount	integer	Částka.
Měna	payment.amount_money.currency	string	Měna.
Stav	payment.status	string	Aktuální stav ověření tohoto objektu.
Doba trvání zpoždění	payment.delay_duration	string	Doba trvání po vytvoření platby, kdy square automaticky použije delay_action na platbu. Tato automatická delay_action se vztahuje pouze na platby, které nedosahují stavu terminálu (COMPLETED, CANCELED nebo FAILED) před delay_duration časovým obdobím. Toto pole je určeno jako časová doba trvání ve formátu RFC 3339.
Typ zdroje	payment.source_type	string	Typ zdroje pro tuto platbu. Mezi aktuální hodnoty patří KARTA, BANK_ACCOUNT, PENĚŽENKA, HOTOVOST nebo EXTERNÍ.
Stav	payment.card_details.status	string	Aktuální stav.
Značka karty	payment.card_details.card.card_brand	string	Značka karty.
Posledních 4	payment.card_details.card.last_4	string	Posledních 4 číslic čísla karty.
Exp Month	payment.card_details.card.exp_month	integer	Měsíc vypršení platnosti přidružené karty jako celé číslo mezi 1 a 12.
Exp Year	payment.card_details.card.exp_year	integer	Čtyřciferný rok data vypršení platnosti karty.
Otisk prstu	payment.card_details.card.fingerprint	string	Zamýšlený jako identifikátor přiřazený k čtverci na základě čísla karty k identifikaci karty na více místech v rámci jedné aplikace.
Typ karty	payment.card_details.card.card_type	string	Typ karty.
Předplacený typ	payment.card_details.card.prepaid_type	string	Určuje, jestli je karta předplacená nebo ne.
POPELNICE	payment.card_details.card.bin	string	Prvních šest číslic čísla karty, označované jako identifikační číslo banky (BIN).
Entry – metoda	payment.card_details.entry_method	string	Metoda použitá k zadání údajů o platbě na kartě. Metoda může být KEYED, POTÁHNUTÍ PRSTEM, EMV, ON_FILE nebo BEZ KONTAKTU.
Stav CVV	payment.card_details.cvv_status	string	Stavový kód vrácený z kontroly ověřovací hodnoty karty (CVV). Kód může být CVV_ACCEPTED, CVV_REJECTED nebo CVV_NOT_CHECKED.
Stav AVS	payment.card_details.avs_status	string	Stavový kód vrácený z kontroly systému ověřování adres (AVS). Kód může být AVS_ACCEPTED, AVS_REJECTED nebo AVS_NOT_CHECKED.
Ověřovací kód výsledku	payment.card_details.auth_result_code	string	Stavový kód vrácený vystavitelem karty, který popisuje stav autorizace platby.
Popis příkazu	payment.card_details.statement_description	string	Popis příkazu odeslaný do sítí karet.
Autorizované na adrese	payment.card_details.card_payment_timeline.authorized_at	string	Časové razítko, kdy byla platba autorizována, ve formátu RFC 3339.
Zachyceno na	payment.card_details.card_payment_timeline.captured_at	string	Časové razítko, kdy byla platba zaznamenána, ve formátu RFC 3339.
ID místa	payment.location_id	string	Identifikátor umístění.
ID objednávky	payment.order_id	string	ID objednávky.
Poplatek za zpracování	payment.processing_fee	array of object
Efektivní na adrese	payment.processing_fee.effective_at	string	Časové razítko, kdy se poplatek projeví, ve formátu RFC 3339.
Typ	payment.processing_fee.type	string	Určuje typ.
Množství	payment.processing_fee.amount_money.amount	integer	Částka.
Měna	payment.processing_fee.amount_money.currency	string	Měna.
Poznámka:	payment.note	string	Vlastní poznámka přidružená k profilu zákazníka.
Množství	payment.total_money.amount	integer	Částka.
Měna	payment.total_money.currency	string	Měna.
Množství	payment.approved_money.amount	integer	Částka.
Měna	payment.approved_money.currency	string	Měna.
ID zaměstnance	payment.employee_id	string	ID zaměstnance vygenerované čtvercem.
Číslo potvrzení	payment.receipt_number	string	Číslo potvrzení platby. Pole chybí, pokud je platba zrušena.
Adresa URL potvrzení	payment.receipt_url	string	Adresa URL potvrzení platby. Pole se vyplní jenom pro dokončené platby.
Zpožďovací akce	payment.delay_action	string	Akce, která se má použít na platbu, když delay_duration uplynula.
Zpožděno do	payment.delayed_until	string	Časové razítko jen pro čtení, kdy se delay_action automaticky použije ve formátu RFC 3339.
ID člena týmu	payment.team_member_id	string	ID člena týmu.
Čtvercový součin	payment.application_details.square_product	string	Produkt čtverce, například nákupní bod prodeje (POS), čtvercové faktury nebo terminál čtvercového virtuálního terminálu.
Identifikátor aplikace	payment.application_details.application_id	string	ID čtverce jen pro čtení přiřazené aplikaci
Token verze	payment.version_token	string	Tento neprůhlený token identifikuje konkrétní verzi objektu.

Dávkové načtení objednávek

ID operace:

OrderBatchRetrieve

Načte sadu objednávek podle jejich ID. Pokud dané ID objednávky neexistuje, id se místo generování chyby ignoruje.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID místa	location_id		string	Identifikátor umístění.
ID objednávek	order_ids		array of string

Návraty

Name	Cesta	Typ	Description
Objednávky	orders	array of object
ID	orders.id	string	Jedinečný identifikátor vystavený čtvercem.
ID místa	orders.location_id	string	Identifikátor umístění.
ID odkazu	orders.reference_id	string	Volitelné druhé ID použité k přidružení profilu zákazníka k entitě v jiném systému.
Řádkové položky	orders.line_items	array of object
UID	orders.line_items.uid	string	ID žádosti o platbu na faktuře vygenerované čtvercem.
Název	orders.line_items.name	string	Čitelný název člověka.
Množství	orders.line_items.quantity	string	Zakoupené množství naformátované jako desetinné číslo.
Množství	orders.line_items.base_price_money.amount	integer	Částka.
Měna	orders.line_items.base_price_money.currency	string	Měna.
Množství	orders.line_items.total_money.amount	integer	Částka.
Měna	orders.line_items.total_money.currency	string	Měna.
Množství	orders.total_money.amount	integer	Částka.
Měna	orders.total_money.currency	string	Měna.

Dávkové načtení objektů katalogu

ID operace:

CatalogBatchRetrieve

Vrátí sadu objektů na základě zadaného ID. Každý CatalogItem vrácený v sadě obsahuje všechny jeho podřízené informace, včetně: všechny jeho CatalogItemVariation objekty, odkazy na jeho CatalogModifierList objekty a ID všech CatalogTax objektů, které se na něj vztahují.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID objektů	object_ids		array of string
Verze katalogu	catalog_version		integer	Konkrétní verze objektů katalogu, které se mají zahrnout do odpovědi. To vám umožní načíst historické verze objektů. Zadaná hodnota verze se shoduje s atributem verze CatalogObjects.
Zahrnout související objekty	include_related_objects		boolean	Pokud je pravda, odpověď bude obsahovat další objekty, které souvisejí s požadovanými objekty, následujícím způsobem: Pokud pole objektů odpovědi obsahuje CatalogItem, jeho přidružené Objekty CatalogCategory, CatalogTax objekty, CatalogImage objekty a CatalogModifierLists budou vráceny v poli related_objects odpovědi. Pokud pole objects odpovědi obsahuje CatalogItemVariation, jeho nadřazený CatalogItem bude vrácen v related_objects pole odpovědi.

Návraty

Name	Cesta	Typ	Description
Objects	objects	array of object
Typ	objects.type	string	Typ tohoto objektu.
ID	objects.id	string	Jedinečný identifikátor vystavený čtvercem.
Aktualizováno na adrese	objects.updated_at	string	Časové razítko poslední změny ve formátu RFC 3339
Version	objects.version	integer	Aktuální verze objektu.
Je odstraněno.	objects.is_deleted	boolean	Pokud je hodnota true, objekt byl odstraněn z databáze. Pro vložené nové objekty musí být false. Po odstranění se pole updated_at rovná času odstranění.
Prezentovat na všech místech	objects.present_at_all_locations	boolean	Pokud je hodnota true, tento objekt se nachází ve všech umístěních (včetně budoucích umístění), s výjimkou případů, kdy je zadaný v poli absent_at_location_ids. Pokud je false, tento objekt není k dispozici v žádném umístění (včetně budoucích umístění), s výjimkou místa, kde je uvedeno v poli present_at_location_ids. Pokud není zadáno, výchozí hodnota je true.
Název	objects.item_data.name	string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Description	objects.item_data.title	string	Popis položky Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazů a jeho délka hodnoty je kódových bodů Unicode.
ID kategorie	objects.item_data.category_id	string	ID kategorie položky, pokud existuje.
DIČ	objects.item_data.tax_ids	array of string
Variace	objects.item_data.variations	array of object
Typ	objects.item_data.variations.type	string	Typ tohoto objektu. Každý typ objektu má očekávané vlastnosti vyjádřené ve strukturovaném formátu v příslušném poli *_data níže.
ID	objects.item_data.variations.id	string	Identifikátor odkaz na tento objekt.
Aktualizováno na adrese	objects.item_data.variations.updated_at	string	Časové razítko poslední změny ve formátu RFC 3339
Version	objects.item_data.variations.version	integer	Verze objektu. Při aktualizaci objektu musí zadaná verze odpovídat verzi v databázi, jinak se zápis zamítne jako konfliktní.
Je odstraněno.	objects.item_data.variations.is_deleted	boolean	Pokud je hodnota true, objekt byl odstraněn z databáze. Pro vložené nové objekty musí být false. Po odstranění se pole updated_at rovná času odstranění.
Prezentovat na všech místech	objects.item_data.variations.present_at_all_locations	boolean	Seznam umístění, kde je objekt přítomný, i když present_at_all_locations je nepravda. Může se jednat o deaktivovaná umístění.
ID položky	objects.item_data.variations.item_variation_data.item_id	string	ID objektu s touto variantou položky.
Název	objects.item_data.variations.item_variation_data.name	string	Název této položky Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazů a jeho délka hodnoty je kódových bodů Unicode.
Řadová číslovka	objects.item_data.variations.item_variation_data.ordinal	integer	Pořadí, ve kterém má být tato varianta položky zobrazena. Tato hodnota je jen pro čtení.
Cenový typ	objects.item_data.variations.item_variation_data.pricing_type	string	Určuje, zda je cena varianty položky pevná nebo určená v době prodeje.
Množství	objects.item_data.variations.item_variation_data.price_money.amount	integer	Částka peněz, v nejmenší nominální hodnotě měny označené měnou. Pokud je například měna USD, částka je v centech. Peněžní částky můžou být kladné nebo záporné. Podívejte se na popis konkrétního pole a určete význam znaménka v konkrétním případě.
Měna	objects.item_data.variations.item_variation_data.price_money.currency	string	Typ měny ve formátu ISO 4217. Například kód měny pro americké dolary je USD.
Související objekty	related_objects	array of object
Typ	related_objects.type	string	Typ tohoto objektu.
ID	related_objects.id	string	Jedinečný identifikátor vystavený čtvercem.
Aktualizováno na adrese	related_objects.updated_at	string	Časové razítko poslední změny ve formátu RFC 3339
Version	related_objects.version	integer	Aktuální verze objektu.
Je odstraněno.	related_objects.is_deleted	boolean	Pokud je hodnota true, objekt byl odstraněn z databáze. Pro vložené nové objekty musí být false. Po odstranění se pole updated_at rovná času odstranění.
Prezentovat na všech místech	related_objects.present_at_all_locations	boolean	Pokud je hodnota true, tento objekt se nachází ve všech umístěních (včetně budoucích umístění), s výjimkou případů, kdy je zadaný v poli absent_at_location_ids. Pokud je false, tento objekt není k dispozici v žádném umístění (včetně budoucích umístění), s výjimkou místa, kde je uvedeno v poli present_at_location_ids. Pokud není zadáno, výchozí hodnota je true.
Název	related_objects.category_data.name	string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Název	related_objects.tax_data.name	string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Fáze výpočtu	related_objects.tax_data.calculation_phase	string	Zda se daň počítá na základě mezisoučtu nebo součtu platby.
Typ zahrnutí	related_objects.tax_data.inclusion_type	string	Bez ohledu na to, zda je daň DOPLŇKOVÁ NEBO INKLUZIVNÍ.
Procento	related_objects.tax_data.percentage	string	Procento v desítkové podobě pomocí oddělovače desetinných míst a bez znaku "%". Hodnota 7,5 odpovídá hodnotě 7,5%.
Enabled	related_objects.tax_data.enabled	boolean	Určuje, zda lze objekt použít nebo ne.

Dávkové načtení změn inventáře

ID operace:

InventoryBatchRetrieveChanges

Vrátí historické fyzické počty a úpravy na základě zadaných kritérií filtru.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID objektů katalogu	catalog_object_ids		array of string
ID umístění	location_ids		array of string
Types	types		array of string
States	states		array of string
Aktualizováno po	updated_after		string	Filtr, který vrátí výsledky s jejich calculated_at hodnotou po daném čase, jak je uvedeno v časovém razítku RFC 3339.
Aktualizováno před	updated_before		string	Filtr vrátí výsledky s jejich created_at nebo calculated_at hodnotu přísně před daným časem, jak je uvedeno v časovém razítku RFC 3339.

Návraty

Name	Cesta	Typ	Description
Changes	changes	array of object
Typ	changes.type	string	Typ tohoto objektu.
ID	changes.physical_count.id	string	Identifikátor objektu
ID odkazu	changes.physical_count.reference_id	string	Volitelné id odkazu definované uživatelem, které tuto kartu přidruží k jiné entitě v externím systému.
ID objektu katalogu	changes.physical_count.catalog_object_id	string	ID objektu CatalogObject generovaného čtvercem, které se sleduje.
Typ objektu katalogu	changes.physical_count.catalog_object_type	string	Typ objektu CatalogObject, který se sleduje.
Stát	changes.physical_count.state	string	Aktuální stav inventáře pro související množství položek.
ID místa	changes.physical_count.location_id	string	ID místa příjemce (jiného než obchodníka) obdrží část tohoto nabídkového řízení.
Množství	changes.physical_count.quantity	string	Počet položek ovlivněných fyzickým počtem jako desetinný řetězec. Číslo může podporovat až 5 číslic za desetinnou čárkou.
Product	changes.physical_count.source.product	string	Typ produktu pro aplikaci.
Identifikátor aplikace	changes.physical_count.source.application_id	string	Čtvercové ID přiřazené aplikaci.
Název	changes.physical_count.source.name	string	Název položky.
ID zaměstnance	changes.physical_count.employee_id	string	ID vygenerované čtvercem zaměstnance zodpovědného za fyzický počet.
Došlo k	changes.physical_count.occurred_at	string	Časové razítko ve formátu RFC 3339 generované klientem, které označuje, kdy byl zkoumán fyzický počet. U aktualizací fyzického počtu nemůže být časové razítko occurred_at starší než 24 hodin nebo v budoucnu vzhledem k času požadavku.
Vytvořeno na adrese	changes.physical_count.created_at	string	Časové razítko vygenerované klientem ve formátu RFC 3339, které označuje, kdy byl vytvořen fyzický počet.

Dávkové odstranění objektů katalogu

ID operace:

CatalogBatchDelete

Odstraní sadu CatalogItems na základě zadaného seznamu cílových ID a vrátí sadu úspěšně odstraněných ID v odpovědi.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID objektů	object_ids		array of string

Návraty

Name	Cesta	Typ	Description
ID odstraněných objektů	deleted_object_ids	array of string
Odstraněno na adrese	deleted_at	string	Časové razítko databáze tohoto odstranění ve formátu RFC 3339

Hledat faktury

ID operace:

InvoiceSearch

Vyhledá faktury z umístění zadaného ve filtru.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID umístění	location_ids		array of string
ID zákazníků	customer_ids		array of string
Obor	field		string	K seřazení hledaných profilů zákazníků použijte jeden nebo více atributů zákazníka.
Objednávka	order		string	Určuje pořadí, ve kterém se mají výsledky řadit na základě hodnoty pole řazení. Řetězce používají standardní abecední porovnání k určení pořadí.
Omezení	limit		integer	Maximální počet faktur, které se mají vrátit (200 je maximální limit). Pokud není zadaný, server použije výchozí limit 100 faktur.

Návraty

Name	Cesta	Typ	Description
Invoices	invoices	array of object
ID	invoices.id	string	Jedinečný identifikátor vystavený čtvercem.
Version	invoices.version	integer	Aktuální verze objektu.
ID místa	invoices.location_id	string	Identifikátor umístění.
ID objednávky	invoices.order_id	string	ID objednávky.
Žádosti o platbu	invoices.payment_requests	array of object
UID	invoices.payment_requests.uid	string	ID žádosti o platbu na faktuře vygenerované čtvercem.
Typ požadavku	invoices.payment_requests.request_type	string	Určuje typ žádosti o platbu. Tento typ definuje způsob určení částky žádosti o platbu.
Termín splnění	invoices.payment_requests.due_date	string	Termín splatnosti (v časovém pásmu faktury) pro žádost o platbu ve formátu RRRR-MM-DD.
Povolené provazování	invoices.payment_requests.tipping_enabled	boolean	Pokud je nastavená hodnota true, stránka faktury hostovaná na náměstí (pole public_url faktury) poskytuje zákazníkovi místo, kde může zaplatit tip.
upomínky	invoices.payment_requests.reminders	array of object	Upomínky
UID	invoices.payment_requests.reminders.uid	string	ID přiřazené čtvercem, které jednoznačně identifikuje připomenutí v rámci InvoicePaymentRequest.
Relativní naplánované dny	invoices.payment_requests.reminders.relative_scheduled_days	integer	Počet dní před odesláním připomenutí (záporné číslo) nebo po (kladném čísle) žádosti o platbu due_date.
Message	invoices.payment_requests.reminders.message	string	Zpráva s připomenutím
Stav	invoices.payment_requests.reminders.status	string	Stav připomenutí.
Množství	invoices.payment_requests.computed_amount_money.amount	integer	Částka.
Měna	invoices.payment_requests.computed_amount_money.currency	string	Měna.
Množství	invoices.payment_requests.total_completed_amount_money.amount	integer	Částka.
Měna	invoices.payment_requests.total_completed_amount_money.currency	string	Měna.
Automatický zdroj plateb	invoices.payment_requests.automatic_payment_source	string	Způsob platby pro automatickou platbu.
Požadováno procento	invoices.payment_requests.percentage_requested	string	Určuje částku žádosti o platbu v procentech.
ID karty	invoices.payment_requests.card_id	string	ID kreditní nebo debetní karty v souboru, které se mají účtovat za žádost o platbu.
Číslo faktury	invoices.invoice_number	string	Uživatelsky přívětivé číslo faktury.
Title	invoices.title	string	Název faktury.
Description	invoices.description	string	Popis.
Naplánováno na	invoices.scheduled_at	string	Časové razítko, kdy je naplánováno zpracování faktury ve formátu RFC 3339. Po publikování faktury square zpracuje fakturu k zadanému datu podle způsobu doručení a nastavení žádosti o platbu.
Stav	invoices.status	string	Aktuální stav ověření tohoto objektu.
Timezone	invoices.timezone	string	Časové pásmo používané k interpretaci kalendářních dat na faktuře, například due_date. Při vytvoření faktury je toto pole nastaveno na časové pásmo určené pro umístění prodejce. Hodnotu nelze změnit.
Vytvořeno na adrese	invoices.created_at	string	Čas události ve formátu ISO 8601.
Aktualizováno na adrese	invoices.updated_at	string	Časové razítko poslední změny ve formátu RFC 3339
ID zákazníka	invoices.primary_recipient.customer_id	string	ID zákazníka, který se má k této kartě přidružit.
křestní jméno	invoices.primary_recipient.given_name	string	Jméno příjemce (tj. jméno).
Příjmení	invoices.primary_recipient.family_name	string	Rodina příjemce (tj. příjmení).
E-mailová adresa	invoices.primary_recipient.email_address	string	E-mailová adresa příjemce.
Telefonní číslo	invoices.primary_recipient.phone_number	string	Telefonní číslo příjemce.
Card	invoices.accepted_payment_methods.card	boolean	Určuje, zda jsou přijímány platby kreditní kartou nebo debetní kartou.
Čtvercová dárková karta	invoices.accepted_payment_methods.square_gift_card	boolean	Určuje, jestli jsou přijímány platby za dárkové karty square.
Bankovní účet	invoices.accepted_payment_methods.bank_account	boolean	Určuje, zda jsou přijímány platby bankovním převodem.
Vlastní pole	invoices.custom_fields	array of object
Označení	invoices.custom_fields.label	string	Popisek nebo název vlastního pole
Hodnota	invoices.custom_fields.value	string	Text vlastního pole
Umístění	invoices.custom_fields.placement	string	Umístění vlastního pole na faktuře
Metoda doručení	invoices.delivery_method	string	Metoda doručení, kterou Square používá k odeslání faktury, připomenutí a účtenek zákazníkovi.
Datum prodeje nebo služby	invoices.sale_or_service_date	string	Datum prodeje nebo datum vykreslení služby ve formátu RRRR-MM-DD. Toto pole lze použít k zadání data v minulosti nebo budoucnosti, které se zobrazí na faktuře.
Veřejná adresa URL	invoices.public_url	string	Adresa URL stránky faktury hostované na náměstí. Po publikování faktury pomocí koncového bodu PublishInvoice je square hostitelem stránky faktury a vrátí adresu URL stránky v odpovědi.
Množství	invoices.next_payment_amount_money.amount	integer	Částka.
Měna	invoices.next_payment_amount_money.currency	string	Měna.
Cursor	cursor	string	Do následných volání tohoto koncového bodu zahrňte kurzor stránkování, který načte další sadu výsledků přidružených k původnímu dotazu.

Hledat zákazníky

ID operace:

CustomerSearch

Vyhledá profily zákazníků přidružené k účtu Square pomocí podporovaného filtru dotazů. Volání SearchCustomers bez explicitního filtru dotazu vrátí všechny profily zákazníků seřazené abecedně podle given_name a family_name.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Neostrý	fuzzy		string	Pomocí filtru přibližných shod vyberte zákazníky, jejichž atributy odpovídají zadanému dotazu přibližným způsobem. Pokud se použije možnost přibližné shody, vyhledávací dotazy se tokenizují a každý token dotazu se musí shodovat někde v prohledávaném atributu. U dotazů s jedním tokenem je to v podstatě stejné chování jako operace částečné shody.
Hodnoty	values		array of string
Pravidlo	rule		string	Určuje, jestli by měl být ve výsledku zahrnut profil zákazníka odpovídající kritériím filtru nebo vyloučen z výsledku.
Začít od	start_at		string	Hodnota data a času ve formátu RFC 3339 označující, kdy se časový rozsah spustí.
Ukončit na	end_at		string	Hodnota data a času ve formátu RFC 3339 označující, kdy časový rozsah končí.
Všechno	all		array of string
Obor	field		string	K seřazení hledaných profilů zákazníků použijte jeden nebo více atributů zákazníka.
Objednávka	order		string	Určuje pořadí, ve kterém se mají výsledky řadit na základě hodnoty pole řazení. Řetězce používají standardní abecední porovnání k určení pořadí.
Omezení	limit		integer	Omezení počtu výsledků, které se mají vrátit na jedné stránce. Limit je doporučení – implementace může vrátit více nebo méně výsledků. Pokud je zadaný limit záporný, nulový nebo vyšší než maximální limit 1 000, bude ignorován.

Návraty

Name	Cesta	Typ	Description
Zákazníci	customers	array of object
ID	customers.id	string	Jedinečný identifikátor vystavený čtvercem.
Vytvořeno na adrese	customers.created_at	string	Čas události ve formátu ISO 8601.
Aktualizováno na adrese	customers.updated_at	string	Časové razítko poslední změny ve formátu RFC 3339
křestní jméno	customers.given_name	string	Zadaný (tj. první) název přidružený k profilu zákazníka.
Příjmení	customers.family_name	string	Rodinné jméno (tj. příjmení) přidružené k profilu zákazníka.
E-mailová adresa	customers.email_address	string	E-mailová adresa přidružená k profilu zákazníka.
Řádek adresy 1	customers.address.address_line_1	string	První řádek adresy.
Řádek adresy 2	customers.address.address_line_2	string	Druhý řádek adresy, pokud existuje.
Lokalita	customers.address.locality	string	Město nebo město adresy.
Správní oblast – úroveň 1	customers.address.administrative_district_level_1	string	Civilní subjekt v rámci země adresy. V USA je to stát.
PSČ	customers.address.postal_code	string	PSČ adresy.
Country	customers.address.country	string	Země adresy ve formátu ISO 3166-1-alpha-2.
Telefonní číslo	customers.phone_number	string	11místné telefonní číslo přidružené k profilu zákazníka.
ID odkazu	customers.reference_id	string	Volitelné druhé ID použité k přidružení profilu zákazníka k entitě v jiném systému.
Odhlášení odběru e-mailu	customers.preferences.email_unsubscribed	boolean	Určuje, jestli se zákazník odhlásil od odběru e-mailů marketingové kampaně. Hodnota true znamená, že se zákazník rozhodl odhlásit se z e-mailového marketingu od aktuálního prodejce square nebo od všech prodejců square. Tato hodnota je jen pro čtení z rozhraní API customers.
Zdroj vytvoření	customers.creation_source	string	Zdroj vytvoření představuje metodu použitou k vytvoření profilu zákazníka.
ID skupin	customers.group_ids	array of string
ID segmentů	customers.segment_ids	array of string
Version	customers.version	integer	Aktuální verze objektu.
Poznámka:	customers.note	string	Vlastní poznámka přidružená k profilu zákazníka.
Cursor	cursor	string	Do následných volání tohoto koncového bodu zahrňte kurzor stránkování, který načte další sadu výsledků přidružených k původnímu dotazu.

Hledání předplatných

ID operace:

SubscriptionSearch

Vyhledá předplatná. Výsledky jsou seřazeny chronologicky podle data vytvoření předplatného. Pokud požadavek určuje více než jedno ID umístění, koncový bod si výsledek vyžádá podle ID umístění a potom podle data vytvoření v rámci každého umístění. Pokud dotaz neobsahuje žádná umístění, vyhledá se všechna umístění.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID umístění	location_ids		array of string
ID zákazníků	customer_ids		array of string
Názvy zdrojů	source_names		array of string

Návraty

Name	Cesta	Typ	Description
Předplatná	subscriptions	array of object
ID	subscriptions.id	string	Jedinečný identifikátor vystavený čtvercem.
ID místa	subscriptions.location_id	string	Identifikátor umístění.
ID plánu	subscriptions.plan_id	string	ID přidruženého plánu předplatného
ID zákazníka	subscriptions.customer_id	string	ID přiřazené čtvercem zákazníka, který je přidružený k účtu.
Datum zahájení	subscriptions.start_date	string	Počáteční datum předplatného ve formátu RRRR-MM-DD.
Datum zrušení	subscriptions.canceled_date	string	Datum zrušení předplatného ve formátu RRRR-MM-DD.
Účtované prostřednictvím data	subscriptions.charged_through_date	string	Datum, kdy je zákazník fakturován za předplatné, ve formátu RRRR-MM-DD.
Stav	subscriptions.status	string	Aktuální stav ověření tohoto objektu.
Vytvořeno na adrese	subscriptions.created_at	string	Čas události ve formátu ISO 8601.
ID karty	subscriptions.card_id	string	ID karty zákazníka, která se účtuje za předplatné.
Zaplaceno do data	subscriptions.paid_until_date	string	Datum zaplaceno do.
Timezone	subscriptions.timezone	string	Časové pásmo používané k interpretaci kalendářních dat na faktuře, například due_date. Při vytvoření faktury je toto pole nastaveno na časové pásmo určené pro umístění prodejce. Hodnotu nelze změnit.
Název	subscriptions.source.name	string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Procento daně	subscriptions.tax_percentage	string	Částka daně uplatněná při fakturaci předplatného.
Množství	subscriptions.price_override_money.amount	integer	Částka.
Měna	subscriptions.price_override_money.currency	string	Měna.
Version	subscriptions.version	integer	Aktuální verze objektu.
ID faktury	subscriptions.invoice_ids	array of string

Informace o katalogu

ID operace:

CatalogInfo

Načte informace o rozhraní API pro čtvercové katalogy, jako jsou limity velikosti dávky, které lze použít koncovým bodem BatchUpsertCatalogObjects.

Návraty

Name	Cesta	Typ	Description
Dávkové upsertování maximálních objektů na dávku	limits.batch_upsert_max_objects_per_batch	integer	Maximální počet objektů, které se mohou objevit v jedné dávce v požadavku /v2/catalog/batch-upsert.
Batch Upsert Max Total Objects	limits.batch_upsert_max_total_objects	integer	Maximální počet objektů, které se můžou objevit ve všech dávkách v požadavku /v2/catalog/batch-upsert.
Batch Retrieve Max Object ID	limits.batch_retrieve_max_object_ids	integer	Maximální počet ID objektů, které se mohou objevit v požadavku /v2/catalog/batch-retrieve.
Maximální limit stránky vyhledávání	limits.search_max_page_limit	integer	Maximální počet výsledků, které se můžou vrátit na stránce odpovědi /v2/catalog/search.
Batch Delete Max Object ID	limits.batch_delete_max_object_ids	integer	Maximální počet ID objektů, které mohou být zahrnuty do jednoho požadavku /v2/catalog/batch-delete.
Aktualizovat daně z daně položky – Maximální ID položek	limits.update_item_taxes_max_item_ids	integer	Maximální počet ID položek, které mohou být zahrnuty do jedné žádosti /v2/catalog/update-item-tax.
Aktualizace daně položky – Maximální daň pro povolení	limits.update_item_taxes_max_taxes_to_enable	integer	Maximální počet DAŇOVÝch ID, která se mají povolit, která může být zahrnuta do jediné žádosti /v2/catalog/update-item-tax.
Aktualizace daně položky – Maximální daň za účelem zakázání	limits.update_item_taxes_max_taxes_to_disable	integer	Maximální počet DAŇOVÝch ID, která se mají zakázat, která může být zahrnuta do jediné žádosti /v2/catalog/update-item-tax.
Aktualizace modifikátoru položek obsahuje maximální ID položek	limits.update_item_modifier_lists_max_item_ids	integer	Maximální počet DAŇOVÝch ID, která se mají zakázat, která může být zahrnuta do jediné žádosti /v2/catalog/update-item-tax.
Aktualizovat seznam modifikátoru položek, aby bylo možné povolit maximální počet modifikátorů	limits.update_item_modifier_lists_max_modifier_lists_to_enable	integer	Maximální počet ID modifikačního seznamu, které mají být povoleny, které mohou být zahrnuty do jednoho požadavku /v2/catalog/update-item-modifier-lists.
Aktualizace seznamů modifikátoru položek– maximální počet modifikátorů, aby se zakázaly	limits.update_item_modifier_lists_max_modifier_lists_to_disable	integer	Maximální počet ID modifikačního seznamu, které mají být zakázány, které mohou být zahrnuty v jednom požadavku /v2/catalog/update-item-modifier-lists.

Inventář změn služby Batch

ID operace:

InventoryBatchChange

Použije úpravy a počty na poskytnuté množství položek. Při úspěchu: vrátí aktuální počítané počty pro všechny objekty odkazované v požadavku.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Idempotency Key	idempotency_key		string	Zadaná hodnota, která jednoznačně identifikuje tento požadavek mezi všemi vašimi požadavky. Běžným způsobem vytvoření platného klíče idempotence je použití univerzálního jedinečného identifikátoru (UUID).
Typ	type		string	Typ tohoto objektu.
ID odkazu	reference_id		string	Volitelné id odkazu definované uživatelem, které tuto kartu přidruží k jiné entitě v externím systému.
ID objektu katalogu	catalog_object_id		string	ID objektu CatalogObject generovaného čtvercem, které se sleduje.
Stát	state		string	Aktuální stav inventáře pro související množství položek.
ID místa	location_id		string	ID místa příjemce (jiného než obchodníka) obdrží část tohoto nabídkového řízení.
Množství	quantity		string	Počet položek ovlivněných fyzickým počtem jako desetinný řetězec. Číslo může podporovat až 5 číslic za desetinnou čárkou.
ID zaměstnance	employee_id		string	ID vygenerované čtvercem zaměstnance zodpovědného za fyzický počet.
Došlo k	occurred_at		string	Časové razítko ve formátu RFC 3339 generované klientem, které označuje, kdy byl zkoumán fyzický počet. U aktualizací fyzického počtu nemůže být časové razítko occurred_at starší než 24 hodin nebo v budoucnu vzhledem k času požadavku.
Ignorovat nezměněné počty	ignore_unchanged_counts		boolean	Určuje, jestli se má aktuální fyzický počet ignorovat, pokud se množství od posledního fyzického počtu nezmění.

Návraty

Name	Cesta	Typ	Description
Počítá	counts	array of object
ID objektu katalogu	counts.catalog_object_id	string	ID objektu CatalogObject generovaného čtvercem, které se sleduje.
Typ objektu katalogu	counts.catalog_object_type	string	Typ objektu CatalogObject, který se sleduje.
Stát	counts.state	string	Aktuální stav.
ID místa	counts.location_id	string	Identifikátor umístění.
Množství	counts.quantity	string	Počet položek ovlivněných odhadovaným počtem jako desetinný řetězec. Může podporovat až 5 číslic za desetinnou čárkou.
Vypočteno na	counts.calculated_at	string	Časové razítko ve formátu RFC 3339, které označuje, kdy byl přijat nejnovější fyzický počet nebo úprava ovlivňující odhadovaný počet.

Karty seznamu

ID operace:

CardList

Načte seznam karet vlastněných účtem, který žádost provádí.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Cursor	cursor		string	Kurzor stránkování vrácený předchozím voláním tohoto koncového bodu.
ID zákazníka	customer_id		string	Omezte výsledky na karty přidružené k zadanému zákazníkovi. Ve výchozím nastavení se vrátí všechny karty vlastněné obchodníkem.
Zahrnout zakázáno	include_disabled		boolean	Zahrnuje zakázané karty. Ve výchozím nastavení se vrátí všechny povolené karty vlastněné obchodníkem.
ID odkazu	reference_id		string	Omezte výsledky na karty přidružené k zadanému reference_id.
Pořadí řazení	sort_order		string	Seřadí vrácený seznam podle toho, kdy byla karta vytvořena se zadaným pořadím.

Návraty

Name	Cesta	Typ	Description
Cards	cards	array of object
ID	cards.card.id	string	Identifikátor objektu
Řádek adresy 1	cards.card.billing_address.address_line_1	string	Pole začínající address_line poskytují nejvýraznější podrobnosti adresy, například číslo ulice, název ulice a název budovy.
Řádek adresy 2	cards.card.billing_address.address_line_2	string	Druhý řádek adresy, pokud existuje.
Lokalita	cards.card.billing_address.locality	string	Město nebo město adresy.
Správní oblast – úroveň 1	cards.card.billing_address.administrative_district_level_1	string	Civilní subjekt v rámci země adresy. V USA je to stát.
PSČ	cards.card.billing_address.postal_code	string	PSČ adresy.
Country	cards.card.billing_address.country	string	Země adresy ve formátu ISO 3166-1-alpha-2.
Otisk prstu	cards.card.fingerprint	string	Zamýšlený jako identifikátor přiřazený k čtverci na základě čísla karty k identifikaci karty na více místech v rámci jedné aplikace.
POPELNICE	cards.card.bin	string	Prvních šest číslic čísla karty, označované jako identifikační číslo banky (BIN).
Značka karty	cards.card.card_brand	string	Značka karty.
Typ karty	cards.card.card_type	string	Typ karty.
Název držitelů karet	cards.card.cardholder_name	string	Jméno držitele karty.
ID zákazníka	cards.card.customer_id	string	ID zákazníka, který se má k této kartě přidružit.
Enabled	cards.card.enabled	boolean	Určuje, zda lze objekt použít nebo ne.
Měsíc vypršení platnosti	cards.card.exp_month	integer	Měsíc vypršení platnosti přidružené karty jako celé číslo mezi 1 a 12.
Rok vypršení platnosti	cards.card.exp_year	integer	Čtyřciferný rok data vypršení platnosti karty.
Posledních 4	cards.card.last_4	string	Posledních 4 číslic čísla karty.
Předplacený typ	cards.card.prepaid_type	string	Určuje, jestli je karta předplacená nebo ne.
ID odkazu	cards.card.reference_id	string	Volitelné id odkazu definované uživatelem, které tuto kartu přidruží k jiné entitě v externím systému.
Version	cards.card.version	integer	Aktuální číslo verze karty Zvýší se při každé aktualizaci karty. Žádosti o aktualizaci existujícího objektu Karta budou odmítnuty, pokud verze v požadavku neodpovídá aktuální verzi karty.

Katalog seznamů

ID operace:

CatalogList

Vrátí seznam CatalogObjects, který obsahuje všechny objekty sady požadovaných typů (například všechny objekty CatalogItem a CatalogTax) v katalogu. ListCatalog nevrací odstraněné položky katalogu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Cursor	cursor		integer	Kurzor stránkování vrácený předchozím voláním tohoto koncového bodu.
Types	types		string	Volitelný seznam typů objektů oddělených čárkami bez rozlišování velkých a malých písmen. Platné hodnoty jsou definovány v katalogu CatalogObjectType výčtu, včetně ITEM, ITEM_VARIATION, CATEGORY, DISCOUNT, TAX, MODIFIER, MODIFIER_LIST nebo IMAGE. Pokud není zadáno, operace vrátí objekty všech typů ve verzi rozhraní Square API použité k provedení požadavku.

Návraty

Name	Cesta	Typ	Description
Objects	objects	array of object
Typ	objects.type	string	Typ tohoto objektu.
ID	objects.id	string	Jedinečný identifikátor vystavený čtvercem.
Aktualizováno na adrese	objects.updated_at	string	Časové razítko poslední změny ve formátu RFC 3339
Version	objects.version	integer	Aktuální verze objektu.
Je odstraněno.	objects.is_deleted	boolean	Pokud je hodnota true, objekt byl odstraněn z databáze. Pro vložené nové objekty musí být false. Po odstranění se pole updated_at rovná času odstranění.
Prezentovat na všech místech	objects.present_at_all_locations	boolean	Pokud je hodnota true, tento objekt se nachází ve všech umístěních (včetně budoucích umístění), s výjimkou případů, kdy je zadaný v poli absent_at_location_ids. Pokud je false, tento objekt není k dispozici v žádném umístění (včetně budoucích umístění), s výjimkou místa, kde je uvedeno v poli present_at_location_ids. Pokud není zadáno, výchozí hodnota je true.
Název	objects.category_data.name	string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Název	objects.tax_data.name	string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Fáze výpočtu	objects.tax_data.calculation_phase	string	Zda se daň počítá na základě mezisoučtu nebo součtu platby.
Typ zahrnutí	objects.tax_data.inclusion_type	string	Bez ohledu na to, zda je daň DOPLŇKOVÁ NEBO INKLUZIVNÍ.
Procento	objects.tax_data.percentage	string	Procento v desítkové podobě pomocí oddělovače desetinných míst a bez znaku "%". Hodnota 7,5 odpovídá hodnotě 7,5%.
Enabled	objects.tax_data.enabled	boolean	Určuje, zda lze objekt použít nebo ne.

Načtení důkazů o sporu

ID operace:

DisputeRetrieveEvidence

Vrátí metadata důkazů zadaná ID důkazu v cestě URL požadavku. Pokud na něj budete chtít později odkazovat, musíte zachovat kopii důkazů, které nahrajete. Po nahrání nemůžete stáhnout důkazy.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID sporu	dispute_id	True	string	Identifikátor sporu.
ID důkazu	evidence_id	True	string	Identifikátor důkazů.

Návraty

Name	Cesta	Typ	Description
ID	evidence.id	string	Jedinečný identifikátor vystavený čtvercem.
ID sporu	evidence.dispute_id	string	ID sporu, ke kterým je důkaz přidružený.
Jméno souboru	evidence.evidence_file.filename	string	Soubory důkazy o sporu musí být soubory application/pdf, image/heic, image/heif, image/jpeg, image/png nebo formáty image/tiff.
Typ souboru	evidence.evidence_file.filetype	string	Název souboru včetně přípony souboru.
Typ důkazů	evidence.evidence_type	string	Typ pf důkaz.
Odesláno na	evidence.uploaded_at	string	Čas splnění další akce ve formátu RFC 3339.

Načtení fyzického počtu inventáře

ID operace:

InventoryRetrievePhysicalCount

Vrátí objekt InventoryPhysicalCount se zadaným physical_count_id.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID fyzického počtu	physical_count_id	True	string	Identifikátor fyzického počtu.

Návraty

Name	Cesta	Typ	Description
ID	count.id	string	Jedinečný identifikátor vystavený čtvercem.
ID odkazu	count.reference_id	string	Volitelné uživatelem definované REFERENČNÍ ID.
ID objektu katalogu	count.catalog_object_id	string	ID objektu CatalogObject generovaného čtvercem, které se sleduje.
Typ objektu katalogu	count.catalog_object_type	string	Typ objektu CatalogObject, který se sleduje.
Stát	count.state	string	Aktuální stav.
ID místa	count.location_id	string	Identifikátor umístění.
Množství	count.quantity	string	Počet položek ovlivněných úpravou jako desetinný řetězec. Může podporovat až 5 číslic za desetinnou čárkou.
Product	count.source.product	string	Typ produktu pro aplikaci.
Identifikátor aplikace	count.source.application_id	string	ID čtverce jen pro čtení přiřazené aplikaci
Název	count.source.name	string	Název.
ID zaměstnance	count.employee_id	string	ID zaměstnance vygenerované čtvercem.
Došlo k	count.occurred_at	string	Časové razítko ve formátu RFC 3339 generované klientem, které označuje, kdy došlo k úpravě inventáře. U aktualizací úprav inventáře nesmí být časové razítko occurred_at starší než 24 hodin nebo v budoucnu vzhledem k času požadavku.
Vytvořeno na adrese	count.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.

Načtení karty

ID operace:

CardRetrieve

Načte podrobnosti o konkrétní kartě.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID karty	card_id	True	string	Identifikátor karty.

Návraty

Name	Cesta	Typ	Description
ID	card.id	string	Jedinečný identifikátor vystavený čtvercem.
Řádek adresy 1	card.billing_address.address_line_1	string	První řádek adresy. Pole začínající address_line poskytují nejvýraznější podrobnosti adresy, například číslo ulice, název ulice a název budovy.
Řádek adresy 2	card.billing_address.address_line_2	string	Druhý řádek adresy, pokud existuje.
Lokalita	card.billing_address.locality	string	Město nebo město adresy.
Správní oblast – úroveň 1	card.billing_address.administrative_district_level_1	string	Civilní subjekt v rámci země adresy. V USA je to stát.
PSČ	card.billing_address.postal_code	string	PSČ adresy.
Country	card.billing_address.country	string	Země adresy ve formátu ISO 3166-1-alpha-2.
Otisk prstu	card.fingerprint	string	Zamýšlený jako identifikátor přiřazený k čtverci na základě čísla karty k identifikaci karty na více místech v rámci jedné aplikace.
POPELNICE	card.bin	string	Prvních šest číslic čísla karty, označované jako identifikační číslo banky (BIN).
Značka karty	card.card_brand	string	Značka karty.
Typ karty	card.card_type	string	Typ karty.
Název držitelů karet	card.cardholder_name	string	Jméno držitele karty.
ID zákazníka	card.customer_id	string	ID tohoto objektu představujícího zákazníka.
Enabled	card.enabled	boolean	Zda je povoleno.
Exp Month	card.exp_month	integer	Měsíc vypršení platnosti přidružené karty jako celé číslo mezi 1 a 12.
Exp Year	card.exp_year	integer	Čtyřciferný rok data vypršení platnosti karty.
Posledních 4	card.last_4	string	Posledních 4 číslic čísla karty.
Předplacený typ	card.prepaid_type	string	Určuje, jestli je karta předplacená nebo ne.
ID odkazu	card.reference_id	string	Volitelné uživatelem definované REFERENČNÍ ID.
Version	card.version	integer	Aktuální verze tohoto objektu.

Načtení objektu katalogu

ID operace:

CatalogRetrieve

Vrátí jeden CatalogItem jako CatalogObject na základě zadaného ID. Vrácený objekt obsahuje všechny relevantní informace CatalogItem včetně: CatalogItemVariation podřízených objektů, odkazy na jeho CatalogModifierList objekty a ID všech CatalogTax objektů, které se na něj vztahují.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID objektu	object_id	True	string	Identifikátor objektu.
Zahrnout související objekty	include_related_objects		boolean	Pokud je pravda, odpověď bude obsahovat další objekty, které souvisejí s požadovaným objektem, následujícím způsobem: Pokud pole objektu odpovědi obsahuje CatalogItem, jeho přidružené CatalogCategory, CatalogTax, CatalogImage a CatalogModifierList objekty budou vráceny v related_objects pole odpovědi. Pokud pole objektu odpovědi obsahuje CatalogItemVariation, jeho nadřazený CatalogItem bude vrácen v related_objects pole odpovědi.

Návraty

Name	Cesta	Typ	Description
Typ	object.type	string	Typ tohoto objektu.
ID	object.id	string	Jedinečný identifikátor vystavený čtvercem.
Aktualizováno na adrese	object.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
Version	object.version	integer	Aktuální verze tohoto objektu.
Je odstraněno.	object.is_deleted	boolean	Pokud je hodnota true, objekt byl odstraněn z databáze. Pro vložené nové objekty musí být false. Po odstranění se pole updated_at rovná času odstranění.
present_at_all_locations	object.present_at_all_locations	boolean	Pokud je hodnota true, tento objekt se nachází ve všech umístěních (včetně budoucích umístění), s výjimkou případů, kdy je zadaný v poli absent_at_location_ids. Pokud je false, tento objekt není k dispozici v žádném umístění (včetně budoucích umístění), s výjimkou místa, kde je uvedeno v poli present_at_location_ids. Pokud není zadáno, výchozí hodnota je true.
Název	object.item_data.name	string	Název.
Description	object.item_data.title	string	Popis položky Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazů a jeho délka hodnoty je kódových bodů Unicode.
ID kategorie	object.item_data.category_id	string	ID kategorie položky, pokud existuje.
DIČ	object.item_data.tax_ids	array of string
Variace	object.item_data.variations	array of object
Typ	object.item_data.variations.type	string	Typ tohoto objektu.
ID	object.item_data.variations.id	string	Identifikátor odkaz na tento objekt v katalogu.
Aktualizováno na adrese	object.item_data.variations.updated_at	string	Časové razítko poslední změny ve formátu RFC 3339
Version	object.item_data.variations.version	integer	Verze objektu. Při aktualizaci objektu musí zadaná verze odpovídat verzi v databázi, jinak se zápis zamítne jako konfliktní.
Je odstraněno.	object.item_data.variations.is_deleted	boolean	Pokud je hodnota true, objekt byl odstraněn z databáze. Pro vložené nové objekty musí být false. Po odstranění se pole updated_at rovná času odstranění.
Prezentovat na všech místech	object.item_data.variations.present_at_all_locations	boolean	Pokud je hodnota true, tento objekt se nachází ve všech umístěních (včetně budoucích umístění), s výjimkou případů, kdy je zadaný v poli absent_at_location_ids. Pokud je false, tento objekt není k dispozici v žádném umístění (včetně budoucích umístění), s výjimkou místa, kde je uvedeno v poli present_at_location_ids. Pokud není zadáno, výchozí hodnota je true.
ID položky	object.item_data.variations.item_variation_data.item_id	string	ID položky CatalogItem přidružené k této variantě položky.
Název	object.item_data.variations.item_variation_data.name	string	Název varianty položky Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazů a jeho délka hodnoty je kódových bodů Unicode.
Řadová číslovka	object.item_data.variations.item_variation_data.ordinal	integer	Pořadí, ve kterém má být tato varianta položky zobrazena. Tato hodnota je jen pro čtení. Při zápisech je pořadové číslo pro každou variantu položky v nadřazené vlastnosti CatalogItem nastaveno podle pozice variant položek. Při čtení není zaručeno, že hodnota bude sekvenční nebo jedinečná.
Cenový typ	object.item_data.variations.item_variation_data.pricing_type	string	Určuje, zda je cena varianty položky pevná nebo určená v době prodeje.
Množství	object.item_data.variations.item_variation_data.price_money.amount	integer	Částka.
Měna	object.item_data.variations.item_variation_data.price_money.currency	string	Měna.

Načtení počtu inventáře

ID operace:

InventoryRetrieveCount

Načte aktuální počítaný počet akcií pro daný objekt CatalogObject v dané sadě umístění.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID objektu katalogu	catalog_object_id	True	string	Identifikátor objektu katalogu.
ID umístění	location_ids		string	ID umístění, která se mají vyhledat jako seznam oddělený čárkami. Prázdný seznam se dotazuje na všechna umístění.
Cursor	cursor		string	Kurzor stránkování vrácený předchozím voláním tohoto koncového bodu.

Návraty

Name	Cesta	Typ	Description
Počítá	counts	array of object
ID objektu katalogu	counts.catalog_object_id	string	ID objektu CatalogObject generovaného čtvercem, které se sleduje.
Typ objektu katalogu	counts.catalog_object_type	string	Typ objektu CatalogObject, který se sleduje.
Stát	counts.state	string	Aktuální stav.
ID místa	counts.location_id	string	Identifikátor umístění.
Množství	counts.quantity	string	Počet položek ovlivněných odhadovaným počtem jako desetinný řetězec. Může podporovat až 5 číslic za desetinnou čárkou.
Vypočteno na	counts.calculated_at	string	Časové razítko ve formátu RFC 3339, které označuje, kdy byl přijat nejnovější fyzický počet nebo úprava ovlivňující odhadovaný počet.

Načtení předplatného

ID operace:

SubscriptionRetrieve

Načte předplatné.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Identifikátor předplatného	subscription_id	True	string	Identifikátor předplatného.

Návraty

Name	Cesta	Typ	Description
ID	subscription.id	string	Jedinečný identifikátor vystavený čtvercem.
ID místa	subscription.location_id	string	Identifikátor umístění.
ID plánu	subscription.plan_id	string	ID přidruženého plánu předplatného.
ID zákazníka	subscription.customer_id	string	ID tohoto objektu představujícího zákazníka.
Datum zahájení	subscription.start_date	string	Počáteční datum předplatného ve formátu RRRR-MM-DD.
Účtované prostřednictvím data	subscription.charged_through_date	string	Datum, kdy je zákazník fakturován za předplatné, ve formátu RRRR-MM-DD.
Stav	subscription.status	string	Aktuální stav ověření tohoto objektu.
ID faktury	subscription.invoice_ids	array of string
Množství	subscription.price_override_money.amount	integer	Částka.
Měna	subscription.price_override_money.currency	string	Měna.
Vytvořeno na adrese	subscription.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Zaplaceno do data	subscription.paid_until_date	string	Datum zaplaceno do.
Timezone	subscription.timezone	string	Časové pásmo sloužící k interpretaci kalendářních dat. Při vytvoření faktury je toto pole nastaveno na časové pásmo určené pro umístění prodejce. Hodnotu nelze změnit.
Název	subscription.source.name	string	Název.

Načtení přenosu inventáře (beta verze)

ID operace:

InventoryRetrieveTransfer

Vrátí objekt InventoryTransfer se zadaným transfer_id.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Identifikátor přenosu	transfer_id	True	string	Identifikátor přenosu.

Návraty

Name	Cesta	Typ	Description
ID	transfer.id	string	Jedinečný identifikátor vystavený čtvercem.
ID objektu katalogu	transfer.catalog_object_id	string	ID objektu CatalogObject generovaného čtvercem, které se sleduje.
Typ objektu katalogu	transfer.catalog_object_type	string	Typ objektu CatalogObject, který se sleduje.
Vytvořeno na adrese	transfer.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
ID zaměstnance	transfer.employee_id	string	ID zaměstnance vygenerované čtvercem.
Z ID umístění	transfer.from_location_id	string	ID vygenerované čtvercem umístění, kde bylo před převodem sledováno související množství položek.
DO ID umístění	transfer.to_location_id	string	ID vygenerované čtvercem umístění, kde bylo po převodu sledováno související množství položek.
Došlo k	transfer.occurred_at	string	Časové razítko ve formátu RFC 3339 generované klientem, které označuje, kdy došlo k úpravě inventáře. U aktualizací úprav inventáře nesmí být časové razítko occurred_at starší než 24 hodin nebo v budoucnu vzhledem k času požadavku.
Množství	transfer.quantity	string	Počet položek ovlivněných úpravou jako desetinný řetězec. Může podporovat až 5 číslic za desetinnou čárkou.
ID odkazu	transfer.reference_id	string	Volitelné uživatelem definované REFERENČNÍ ID.
Product	transfer.source.product	string	Typ produktu pro aplikaci.
Identifikátor aplikace	transfer.source.application_id	string	ID čtverce jen pro čtení přiřazené aplikaci
Název	transfer.source.name	string	Název.
Stát	transfer.state	string	Aktuální stav.

Načtení segmentu zákazníka

ID operace:

CustomerSegmentRetrieve

Načte konkrétní segment zákazníka.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID segmentu	segment_id	True	string	Identifikátor segmentu.

Návraty

Name	Cesta	Typ	Description
ID	segment.id	string	Jedinečný identifikátor vystavený čtvercem.
Název	segment.name	string	Název objektu.
Vytvořeno na adrese	segment.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	segment.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.

Načtení skupiny zákazníků

ID operace:

CustomerGroupRetrieve

Načte konkrétní skupinu zákazníků.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID skupiny	group_id	True	string	Identifikátor skupiny.

Návraty

Name	Cesta	Typ	Description
ID	group.id	string	Jedinečný identifikátor vystavený čtvercem.
Název	group.name	string	Název objektu.
Vytvořeno na adrese	group.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	group.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.

Načtení sporu

ID operace:

DisputeRetrieve

Vrátí podrobnosti o konkrétním sporu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID sporu	dispute_id	True	string	Identifikátor sporu.

Návraty

Name	Cesta	Typ	Description
ID	dispute.id	string	Jedinečný identifikátor vystavený čtvercem.
Množství	dispute.amount_money.amount	integer	Částka.
Měna	dispute.amount_money.currency	string	Měna.
Důvod	dispute.reason	string	Důvod tohoto objektu.
Stát	dispute.state	string	Aktuální stav.
Termín splnění na adrese	dispute.due_at	string	Čas splnění další akce ve formátu RFC 3339.
Sporné platby	dispute.disputed_payments	array of object
ID platby	dispute.disputed_payments.payment_id	string	Jedinečné ID platby vygenerované čtvercem
Značka karty	dispute.card_brand	string	Značka karty.
Vytvořeno na adrese	dispute.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	dispute.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
ID sporu značky	dispute.brand_dispute_id	string	ID sporu v systému značky karty vygenerované značkou karty.

Načtení zákazníka

ID operace:

CustomerRetrieve

Vrátí podrobnosti pro jednoho zákazníka.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID zákazníka	customer_id	True	string	Identifikátor zákazníka.

Návraty

Name	Cesta	Typ	Description
ID	customer.id	string	Jedinečný identifikátor vystavený čtvercem.
Vytvořeno na adrese	customer.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	customer.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
křestní jméno	customer.given_name	string	Zadaný (tj. první) název přidružený k profilu zákazníka.
Příjmení	customer.family_name	string	Rodinné jméno (tj. příjmení) přidružené k profilu zákazníka.
E-mailová adresa	customer.email_address	string	E-mailová adresa přidružená k profilu zákazníka.
Řádek adresy 1	customer.address.address_line_1	string	První řádek adresy. Pole začínající address_line poskytují nejvýraznější podrobnosti adresy, například číslo ulice, název ulice a název budovy.
Řádek adresy 2	customer.address.address_line_2	string	Druhý řádek adresy, pokud existuje.
Lokalita	customer.address.locality	string	Město nebo město adresy.
Správní oblast – úroveň 1	customer.address.administrative_district_level_1	string	Civilní subjekt v rámci země adresy. V USA je to stát.
PSČ	customer.address.postal_code	string	PSČ adresy.
Country	customer.address.country	string	Země adresy ve formátu ISO 3166-1-alpha-2.
Telefonní číslo	customer.phone_number	string	11místné telefonní číslo přidružené k profilu zákazníka.
ID odkazu	customer.reference_id	string	Volitelné uživatelem definované REFERENČNÍ ID.
Poznámka:	customer.note	string	Vlastní poznámka přidružená k profilu zákazníka.
Odhlášení odběru e-mailu	customer.preferences.email_unsubscribed	boolean	Určuje, jestli se zákazník odhlásil od odběru e-mailů marketingové kampaně. Hodnota true znamená, že se zákazník rozhodl odhlásit se z e-mailového marketingu od aktuálního prodejce square nebo od všech prodejců square.
Zdroj vytvoření	customer.creation_source	string	Zdroj vytvoření představuje metodu použitou k vytvoření profilu zákazníka.
ID skupin	customer.group_ids	array of string
ID segmentů	customer.segment_ids	array of string
Version	customer.version	integer	Aktuální verze tohoto objektu.

Načtení úpravy inventáře

ID operace:

InventoryRetrieveAdjustment

Vrátí objekt InventoryAdjustment se zadaným adjustment_id.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID úpravy	adjustment_id	True	string	Identifikátor úpravy.

Návraty

Name	Cesta	Typ	Description
ID	adjustment.id	string	Jedinečný identifikátor vystavený čtvercem.
ID odkazu	adjustment.reference_id	string	Volitelné uživatelem definované REFERENČNÍ ID.
Ze stavu	adjustment.from_state	string	Stav inventáře souvisejícího množství položek před úpravou.
Do stavu	adjustment.to_state	string	Stav inventáře souvisejícího množství položek po úpravě.
ID místa	adjustment.location_id	string	Identifikátor umístění.
ID objektu katalogu	adjustment.catalog_object_id	string	ID objektu CatalogObject generovaného čtvercem, které se sleduje.
Typ objektu katalogu	adjustment.catalog_object_type	string	Typ objektu CatalogObject, který se sleduje.
Množství	adjustment.quantity	string	Počet položek ovlivněných úpravou jako desetinný řetězec. Může podporovat až 5 číslic za desetinnou čárkou.
Množství	adjustment.total_price_money.amount	integer	Částka.
Měna	adjustment.total_price_money.currency	string	Měna.
Došlo k	adjustment.occurred_at	string	Časové razítko ve formátu RFC 3339 generované klientem, které označuje, kdy došlo k úpravě inventáře. U aktualizací úprav inventáře nesmí být časové razítko occurred_at starší než 24 hodin nebo v budoucnu vzhledem k času požadavku.
Vytvořeno na adrese	adjustment.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Product	adjustment.source.product	string	Typ produktu pro aplikaci.
Identifikátor aplikace	adjustment.source.application_id	string	ID čtverce jen pro čtení přiřazené aplikaci
Název	adjustment.source.name	string	Název.
ID zaměstnance	adjustment.employee_id	string	ID zaměstnance vygenerované čtvercem.

Načíst pořadí

ID operace:

OrderRetrieve

Načte objednávku podle ID.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID objednávky	order_id	True	string	Identifikátor objednávky.

Návraty

Name	Cesta	Typ	Description
ID	order.id	string	Jedinečný identifikátor vystavený čtvercem.
ID místa	order.location_id	string	Identifikátor umístění.
Řádkové položky	order.line_items	array of object
UID	order.line_items.uid	string	ID vygenerované čtvercem.
Množství	order.line_items.quantity	string	Počet položek ovlivněných fyzickým počtem jako desetinný řetězec. Číslo může podporovat až 5 číslic za desetinnou čárkou.
Název	order.line_items.name	string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Množství	order.line_items.base_price_money.amount	integer	Částka.
Měna	order.line_items.base_price_money.currency	string	Měna.
Množství	order.line_items.gross_sales_money.amount	integer	Částka.
Měna	order.line_items.gross_sales_money.currency	string	Měna.
Množství	order.line_items.total_tax_money.amount	integer	Částka.
Měna	order.line_items.total_tax_money.currency	string	Měna.
Množství	order.line_items.total_discount_money.amount	integer	Částka.
Měna	order.line_items.total_discount_money.currency	string	Měna.
Množství	order.line_items.total_money.amount	integer	Částka.
Měna	order.line_items.total_money.currency	string	Měna.
Množství	order.line_items.variation_total_price_money.amount	integer	Částka.
Měna	order.line_items.variation_total_price_money.currency	string	Měna.
Použité slevy	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	ID přiřazené čtvercem.
UID slevy	order.line_items.applied_discounts.discount_uid	string	UID slevy, kterou uplatněná sleva představuje.
Množství	order.line_items.applied_discounts.applied_money.amount	integer	Částka.
Měna	order.line_items.applied_discounts.applied_money.currency	string	Měna.
Slevy	order.discounts	array of object
UID	order.discounts.uid	string	ID vygenerované čtvercem.
Název	order.discounts.name	string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Procento	order.discounts.percentage	string	Procento v desítkové podobě pomocí oddělovače desetinných míst a bez znaku "%". Hodnota 7,5 odpovídá hodnotě 7,5%.
Množství	order.discounts.applied_money.amount	integer	Částka.
Měna	order.discounts.applied_money.currency	string	Měna.
Typ	order.discounts.type	string	Určuje typ.
Scope	order.discounts.scope	string	Označuje aktuální úroveň.
Vytvořeno na adrese	order.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	order.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
Stát	order.state	string	Aktuální stav.
Version	order.version	integer	Aktuální verze tohoto objektu.
Množství	order.total_tax_money.amount	integer	Částka.
Měna	order.total_tax_money.currency	string	Měna.
Množství	order.total_discount_money.amount	integer	Částka.
Měna	order.total_discount_money.currency	string	Měna.
Množství	order.total_tip_money.amount	integer	Částka.
Měna	order.total_tip_money.currency	string	Měna.
Množství	order.total_money.amount	integer	Částka.
Měna	order.total_money.currency	string	Měna.
Množství	order.total_service_charge_money.amount	integer	Částka.
Měna	order.total_service_charge_money.currency	string	Měna.
Množství	order.net_amounts.total_money.amount	integer	Částka.
Měna	order.net_amounts.total_money.currency	string	Měna.
Množství	order.net_amounts.tax_money.amount	integer	Částka.
Měna	order.net_amounts.tax_money.currency	string	Měna.
Množství	order.net_amounts.discount_money.amount	integer	Částka.
Měna	order.net_amounts.discount_money.currency	string	Měna.
Množství	order.net_amounts.tip_money.amount	integer	Částka.
Měna	order.net_amounts.tip_money.currency	string	Měna.
Množství	order.net_amounts.service_charge_money.amount	integer	Částka.
Měna	order.net_amounts.service_charge_money.currency	string	Měna.

Objekt katalogu Upsert

ID operace:

CatalogUpsert

Vytvoří nebo aktualizuje cílový objekt CatalogObject.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Idempotency Key	idempotency_key		string	Zadaná hodnota, která jednoznačně identifikuje tento požadavek mezi všemi vašimi požadavky. Běžným způsobem vytvoření platného klíče idempotence je použití univerzálního jedinečného identifikátoru (UUID).
ID	id		string	Jedinečný identifikátor vystavený čtvercem.
Typ	type		string	Typ tohoto objektu.
Zkratka	abbreviation		string	Text zobrazeného popisku položky v aplikaci Square Point of Sale Použije se pouze prvních pět znaků řetězce. Tento atribut je prohledávatelný a jeho délka hodnoty je kódových bodů Unicode.
Description	title		string	Popis položky Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazů a jeho délka hodnoty je kódových bodů Unicode.
Název	name		string	Název.
ID	id		string	Identifikátor odkaz na tento objekt v katalogu.
Typ	type		string	Typ tohoto objektu.
ID položky	item_id		string	ID položky CatalogItem přidružené k této variantě položky.
Název	name		string	Název varianty položky Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazů a jeho délka hodnoty je kódových bodů Unicode.
Cenový typ	pricing_type		string	Určuje, zda je cena varianty položky pevná nebo určená v době prodeje.
Množství	amount		integer	Částka.
Měna	currency		string	Měna.

Návraty

Name	Cesta	Typ	Description
Typ	catalog_object.type	string	Typ tohoto objektu.
ID	catalog_object.id	string	Jedinečný identifikátor vystavený čtvercem.
Aktualizováno na adrese	catalog_object.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
Version	catalog_object.version	integer	Aktuální verze tohoto objektu.
Je odstraněno.	catalog_object.is_deleted	boolean	Pokud je hodnota true, objekt byl odstraněn z databáze. Pro vložené nové objekty musí být false. Po odstranění se pole updated_at rovná času odstranění.
present_at_all_locations	catalog_object.present_at_all_locations	boolean	Pokud je hodnota true, tento objekt se nachází ve všech umístěních (včetně budoucích umístění), s výjimkou případů, kdy je zadaný v poli absent_at_location_ids. Pokud je false, tento objekt není k dispozici v žádném umístění (včetně budoucích umístění), s výjimkou místa, kde je uvedeno v poli present_at_location_ids. Pokud není zadáno, výchozí hodnota je true.
Název	catalog_object.item_data.name	string	Název.
Description	catalog_object.item_data.title	string	Popis položky Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazů a jeho délka hodnoty je kódových bodů Unicode.
Zkratka	catalog_object.item_data.abbreviation	string	Text zobrazeného popisku položky v aplikaci Square Point of Sale Použije se pouze prvních pět znaků řetězce. Tento atribut je prohledávatelný a jeho délka hodnoty je kódových bodů Unicode.
Variace	catalog_object.item_data.variations	array of object
Typ	catalog_object.item_data.variations.type	string	Typ tohoto objektu.
ID	catalog_object.item_data.variations.id	string	Identifikátor odkaz na tento objekt v katalogu.
Aktualizováno na adrese	catalog_object.item_data.variations.updated_at	string	Časové razítko poslední změny ve formátu RFC 3339
Version	catalog_object.item_data.variations.version	integer	Verze objektu. Při aktualizaci objektu musí zadaná verze odpovídat verzi v databázi, jinak se zápis zamítne jako konfliktní.
Je odstraněno.	catalog_object.item_data.variations.is_deleted	boolean	Pokud je hodnota true, objekt byl odstraněn z databáze. Pro vložené nové objekty musí být false. Po odstranění se pole updated_at rovná času odstranění.
Prezentovat na všech místech	catalog_object.item_data.variations.present_at_all_locations	boolean	Pokud je hodnota true, tento objekt se nachází ve všech umístěních (včetně budoucích umístění), s výjimkou případů, kdy je zadaný v poli absent_at_location_ids. Pokud je false, tento objekt není k dispozici v žádném umístění (včetně budoucích umístění), s výjimkou místa, kde je uvedeno v poli present_at_location_ids. Pokud není zadáno, výchozí hodnota je true.
ID položky	catalog_object.item_data.variations.item_variation_data.item_id	string	ID položky CatalogItem přidružené k této variantě položky.
Název	catalog_object.item_data.variations.item_variation_data.name	string	Název varianty položky Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazů a jeho délka hodnoty je kódových bodů Unicode.
Řadová číslovka	catalog_object.item_data.variations.item_variation_data.ordinal	integer	Pořadí, ve kterém má být tato varianta položky zobrazena. Tato hodnota je jen pro čtení. Při zápisech je pořadové číslo pro každou variantu položky v nadřazené vlastnosti CatalogItem nastaveno podle pozice variant položek. Při čtení není zaručeno, že hodnota bude sekvenční nebo jedinečná.
Cenový typ	catalog_object.item_data.variations.item_variation_data.pricing_type	string	Určuje, zda je cena varianty položky pevná nebo určená v době prodeje.
Skladové zásoby	catalog_object.item_data.variations.item_variation_data.stockable	boolean	Určuje, jestli se akcie počítají přímo na této variantě (TRUE), nebo pouze na jejích součástech (FALSE). Chybějící hodnoty zpětné kompatibility budou interpretovány jako PRAVDA.
Množství	catalog_object.item_data.variations.item_variation_data.price_money.amount	integer	Částka.
Měna	catalog_object.item_data.variations.item_variation_data.price_money.currency	string	Měna.
Typ produktu	catalog_object.item_data.product_type	string	Typ produktu položky. Po vytvoření položky nelze změnit.
Mapování ID	id_mappings	array of object
ID klientského objektu	id_mappings.client_object_id	string	Dočasné ID předpony #-předpony klienta pro nový catalogObject.
ID objektu	id_mappings.object_id	string	Trvalé ID vytvořené serverem.

Objekty katalogu Upsert služby Batch

ID operace:

CatalogBatchUpsert

Vytvoří nebo aktualizuje až 10 000 cílových objektů na základě zadaného seznamu objektů. Cílové objekty jsou seskupeny do dávek a každá dávka se vloží nebo aktualizuje úplně nebo jinak. Pokud je objekt v dávce nějakým způsobem poškozený nebo porušuje omezení databáze, bude celá dávka obsahující tuto položku ignorována. Jiné dávky ve stejném požadavku však mohou být i nadále úspěšné. Každá dávka může obsahovat až 1 000 objektů a dávky budou zpracovány v pořadí, pokud celkový počet objektů pro požadavek (položky, varianty, modifikační seznamy, slevy a daně) není větší než 10 000.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Idempotency Key	idempotency_key		string	Zadaná hodnota, která jednoznačně identifikuje tento požadavek mezi všemi vašimi požadavky. Běžným způsobem vytvoření platného klíče idempotence je použití univerzálního jedinečného identifikátoru (UUID).
Typ	type		string	Typ tohoto objektu.
ID	id		string	Identifikátor odkaz na tento objekt.
Prezentovat na všech místech	present_at_all_locations		boolean	Pokud je hodnota true, tento objekt se nachází ve všech umístěních (včetně budoucích umístění), s výjimkou případů, kdy je zadaný v poli absent_at_location_ids. Pokud je false, tento objekt není k dispozici v žádném umístění (včetně budoucích umístění), s výjimkou místa, kde je uvedeno v poli present_at_location_ids. Pokud není zadáno, výchozí hodnota je true.
Název	name		string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Description	title		string	Popis položky Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazů a jeho délka hodnoty je kódových bodů Unicode.
ID kategorie	category_id		string	ID kategorie položky, pokud existuje.
DIČ	tax_ids		array of string
Typ	type		string	Typ tohoto objektu. Každý typ objektu má očekávané vlastnosti vyjádřené ve strukturovaném formátu v příslušném poli *_data níže.
ID	id		string	Identifikátor odkaz na tento objekt.
Prezentovat na všech místech	present_at_all_locations		boolean	Určuje, jestli se nachází na všech místech.
ID položky	item_id		string	Identifikátor položky.
Název	name		string	Název položky.
Cenový typ	pricing_type		string	Typ cen.
Množství	amount		integer	Částka.
Měna	currency		string	Měna.
Název	name		string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Název	name		string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Fáze výpočtu	calculation_phase		string	Zda se daň počítá na základě mezisoučtu nebo součtu platby.
Typ zahrnutí	inclusion_type		string	Bez ohledu na to, zda je daň DOPLŇKOVÁ NEBO INKLUZIVNÍ.
Procento	percentage		string	Procento daně v desítkové podobě s použitím oddělovače desetinných míst a bez znaku "%". Hodnota 7,5 odpovídá hodnotě 7,5%.
Platí pro vlastní částky.	applies_to_custom_amounts		boolean	Pokud je to pravda, poplatek se vztahuje na vlastní částky zadané do aplikace Square Point of Sale, které nejsou přidruženy k určitému catalogItem.
Enabled	enabled		boolean	Logický příznak označující, jestli je daň zobrazena jako povolená (true) v aplikaci Square Point of Sale nebo ne (nepravda).

Návraty

Name	Cesta	Typ	Description
Objects	objects	array of object
Typ	objects.type	string	Typ tohoto objektu.
ID	objects.id	string	Jedinečný identifikátor vystavený čtvercem.
Aktualizováno na adrese	objects.updated_at	string	Časové razítko poslední změny ve formátu RFC 3339
Version	objects.version	integer	Aktuální verze objektu.
Je odstraněno.	objects.is_deleted	boolean	Pokud je hodnota true, objekt byl odstraněn z databáze. Pro vložené nové objekty musí být false. Po odstranění se pole updated_at rovná času odstranění.
Prezentovat na všech místech	objects.present_at_all_locations	boolean	Pokud je hodnota true, tento objekt se nachází ve všech umístěních (včetně budoucích umístění), s výjimkou případů, kdy je zadaný v poli absent_at_location_ids. Pokud je false, tento objekt není k dispozici v žádném umístění (včetně budoucích umístění), s výjimkou místa, kde je uvedeno v poli present_at_location_ids. Pokud není zadáno, výchozí hodnota je true.
Název	objects.item_data.name	string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Description	objects.item_data.title	string	Popis položky Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazů a jeho délka hodnoty je kódových bodů Unicode.
ID kategorie	objects.item_data.category_id	string	ID kategorie položky, pokud existuje.
DIČ	objects.item_data.tax_ids	array of string
Variace	objects.item_data.variations	array of object
Typ	objects.item_data.variations.type	string	Typ tohoto objektu. Každý typ objektu má očekávané vlastnosti vyjádřené ve strukturovaném formátu v příslušném poli *_data níže.
ID	objects.item_data.variations.id	string	Identifikátor odkaz na tento objekt.
Aktualizováno na adrese	objects.item_data.variations.updated_at	string	Časové razítko poslední změny ve formátu RFC 3339
Version	objects.item_data.variations.version	integer	Verze objektu. Při aktualizaci objektu musí zadaná verze odpovídat verzi v databázi, jinak se zápis zamítne jako konfliktní.
Je odstraněno.	objects.item_data.variations.is_deleted	boolean	Pokud je hodnota true, objekt byl odstraněn z databáze. Pro vložené nové objekty musí být false. Po odstranění se pole updated_at rovná času odstranění.
Prezentovat na všech místech	objects.item_data.variations.present_at_all_locations	boolean	Seznam umístění, kde je objekt přítomný, i když present_at_all_locations je nepravda. Může se jednat o deaktivovaná umístění.
ID položky	objects.item_data.variations.item_variation_data.item_id	string	ID objektu s touto variantou položky.
Název	objects.item_data.variations.item_variation_data.name	string	Název této položky Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazů a jeho délka hodnoty je kódových bodů Unicode.
Řadová číslovka	objects.item_data.variations.item_variation_data.ordinal	integer	Pořadí, ve kterém má být tato varianta položky zobrazena. Tato hodnota je jen pro čtení.
Cenový typ	objects.item_data.variations.item_variation_data.pricing_type	string	Určuje, zda je cena varianty položky pevná nebo určená v době prodeje.
Množství	objects.item_data.variations.item_variation_data.price_money.amount	integer	Částka peněz, v nejmenší nominální hodnotě měny označené měnou. Pokud je například měna USD, částka je v centech. Peněžní částky můžou být kladné nebo záporné. Podívejte se na popis konkrétního pole a určete význam znaménka v konkrétním případě.
Měna	objects.item_data.variations.item_variation_data.price_money.currency	string	Typ měny ve formátu ISO 4217. Například kód měny pro americké dolary je USD.
Název	objects.category_data.name	string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Název	objects.tax_data.name	string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Fáze výpočtu	objects.tax_data.calculation_phase	string	Zda se daň počítá na základě mezisoučtu nebo součtu platby.
Typ zahrnutí	objects.tax_data.inclusion_type	string	Bez ohledu na to, zda je daň DOPLŇKOVÁ NEBO INKLUZIVNÍ.
Procento	objects.tax_data.percentage	string	Procento v desítkové podobě pomocí oddělovače desetinných míst a bez znaku "%". Hodnota 7,5 odpovídá hodnotě 7,5%.
Platí pro vlastní částky.	objects.tax_data.applies_to_custom_amounts	boolean	Pokud je to pravda, poplatek se vztahuje na vlastní částky zadané do aplikace Square Point of Sale, které nejsou přidruženy k určitému catalogItem.
Enabled	objects.tax_data.enabled	boolean	Určuje, zda lze objekt použít nebo ne.
Mapování ID	id_mappings	array of object
ID klientského objektu	id_mappings.client_object_id	string	Dočasné ID předpony #-předpony klienta pro nový catalogObject.
ID objektu	id_mappings.object_id	string	Trvalé ID vytvořené serverem.

Obnovení předplatného

ID operace:

SubscriptionResume

Obnoví deaktivované předplatné.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Identifikátor předplatného	subscription_id	True	string	Identifikátor předplatného.

Návraty

Name	Cesta	Typ	Description
ID	subscription.id	string	Jedinečný identifikátor vystavený čtvercem.
ID místa	subscription.location_id	string	Identifikátor umístění.
ID plánu	subscription.plan_id	string	ID přidruženého plánu předplatného.
ID zákazníka	subscription.customer_id	string	ID tohoto objektu představujícího zákazníka.
Stav	subscription.status	string	Aktuální stav ověření tohoto objektu.
Množství	subscription.price_override_money.amount	integer	Částka.
Měna	subscription.price_override_money.currency	string	Měna.
Version	subscription.version	integer	Aktuální verze tohoto objektu.
Vytvořeno na adrese	subscription.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Timezone	subscription.timezone	string	Časové pásmo sloužící k interpretaci kalendářních dat. Při vytvoření faktury je toto pole nastaveno na časové pásmo určené pro umístění prodejce. Hodnotu nelze změnit.
Název	subscription.source.name	string	Název.

Odebrání skupiny od zákazníka

ID operace:

CustomerRemoveGroup

Odebere členství ve skupině od zákazníka. Zákazník je identifikován hodnotou customer_id a skupina zákazníků je identifikována hodnotou group_id.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID zákazníka	customer_id	True	string	Identifikátor zákazníka.
ID skupiny	group_id	True	string	Identifikátor skupiny.

Návraty

response

object

Odeslat důkaz

ID operace:

EvidenceSubmit

Odešle důkaz do banky držitele karty. Před odesláním důkazů Square zkompiluje všechny dostupné důkazy. To zahrnuje důkazy nahrané pomocí koncových bodů CreateDisputeEvidenceFile a CreateDisputeEvidenceText a důkazů automaticky poskytovaných square, pokud je k dispozici.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID sporu	dispute_id	True	string	Identifikátor sporu.

Návraty

Name	Cesta	Typ	Description
ID	dispute.id	string	Jedinečný identifikátor vystavený čtvercem.
Množství	dispute.amount_money.amount	integer	Částka.
Měna	dispute.amount_money.currency	string	Měna.
Důvod	dispute.reason	string	Důvod tohoto objektu.
Stát	dispute.state	string	Aktuální stav.
Termín splnění na adrese	dispute.due_at	string	Čas splnění další akce ve formátu RFC 3339.
Sporné platby	dispute.disputed_payments	array of object
ID platby	dispute.disputed_payments.payment_id	string	Jedinečné ID platby vygenerované čtvercem
Značka karty	dispute.card_brand	string	Značka karty.
Vytvořeno na adrese	dispute.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	dispute.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
ID sporu značky	dispute.brand_dispute_id	string	ID sporu v systému značky karty vygenerované značkou karty.

Odstranění důkazů o sporu

ID operace:

DisputeDeleteEvidence

Odebere zadané důkazy z sporu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID sporu	dispute_id	True	string	Identifikátor sporu.
ID důkazu	evidence_id	True	string	Identifikátor důkazů.

Návraty

response

object

Odstranění faktury

ID operace:

InvoiceDelete

Odstraní zadanou fakturu. Po odstranění faktury se přidružený stav objednávky změní na CANCELED. Můžete odstranit jenom koncept faktury (publikovanou fakturu nemůžete odstranit, včetně faktury, která je naplánovaná ke zpracování).

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID faktury	invoice_id	True	string	Identifikátor faktury.
Version	version		integer	Verze faktury, která se má odstranit.

Návraty

response

object

Odstranění objektu katalogu

ID operace:

CatalogDelete

Odstraní jeden catalogObject na základě zadaného ID a vrátí sadu úspěšně odstraněných ID v odpovědi. Odstranění je kaskádová událost, která zajistí odstranění všech podřízených objektů cílového objektu. Odstraněním položky CatalogItem například odstraníte také všechny podřízené položky CatalogItemVariation.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID objektu	object_id	True	string	Identifikátor objektu.

Návraty

Name	Cesta	Typ	Description
ID odstraněných objektů	deleted_object_ids	array of string
Odstraněno na adrese	deleted_at	string	Časové razítko databáze tohoto odstranění ve formátu RFC 3339

Odstranění skupiny zákazníků

ID operace:

CustomerGroupDelete

Odstraní skupinu zákazníků podle hodnoty group_id.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID skupiny	group_id	True	string	Identifikátor skupiny.

Návraty

response

object

Odstranění zákazníka

ID operace:

CustomerDelete

Odstraní profil zákazníka z firmy. Tato operace také zruší propojení všech přidružených karet v souboru.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID zákazníka	customer_id	True	string	Identifikátor zákazníka.

Návraty

response

object

Platba objednávky (beta verze)

ID operace:

OrderPay

Platíte za objednávku pomocí jedné nebo více schválených plateb nebo vypořádejte objednávku s celkem 0. Celkový součet payment_ids uvedených v požadavku musí být roven celkovému součtu objednávky. Objednávky s celkovou částkou 0 je možné označit jako zaplacené zadáním prázdného pole payment_ids v požadavku.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID objednávky	order_id	True	string	Identifikátor objednávky.
Idempotency Key	idempotency_key		string	Zadaná hodnota, která jednoznačně identifikuje tento požadavek mezi všemi vašimi požadavky. Běžným způsobem vytvoření platného klíče idempotence je použití univerzálního jedinečného identifikátoru (UUID).
ID plateb	payment_ids		array of string

Návraty

Name	Cesta	Typ	Description
ID	order.id	string	Jedinečný identifikátor vystavený čtvercem.
ID místa	order.location_id	string	Identifikátor umístění.
Řádkové položky	order.line_items	array of object
UID	order.line_items.uid	string	ID vygenerované čtvercem.
Množství	order.line_items.quantity	string	Počet položek ovlivněných fyzickým počtem jako desetinný řetězec. Číslo může podporovat až 5 číslic za desetinnou čárkou.
Název	order.line_items.name	string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Množství	order.line_items.base_price_money.amount	integer	Částka.
Měna	order.line_items.base_price_money.currency	string	Měna.
Množství	order.line_items.gross_sales_money.amount	integer	Částka.
Měna	order.line_items.gross_sales_money.currency	string	Měna.
Množství	order.line_items.total_tax_money.amount	integer	Částka.
Měna	order.line_items.total_tax_money.currency	string	Měna.
Množství	order.line_items.total_discount_money.amount	integer	Částka.
Měna	order.line_items.total_discount_money.currency	string	Měna.
Množství	order.line_items.total_money.amount	integer	Částka.
Měna	order.line_items.total_money.currency	string	Měna.
Vytvořeno na adrese	order.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	order.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
Version	order.version	integer	Aktuální verze tohoto objektu.
Množství	order.total_tax_money.amount	integer	Částka.
Měna	order.total_tax_money.currency	string	Měna.
Množství	order.total_discount_money.amount	integer	Částka.
Měna	order.total_discount_money.currency	string	Měna.
Množství	order.total_money.amount	integer	Částka.
Měna	order.total_money.currency	string	Měna.
Uzavřeno na	order.closed_at	string	Čas ukončení ve formátu ISO 8601.
Nabídky	order.tenders	array of object
ID	order.tenders.id	string	Identifikátor objektu
ID místa	order.tenders.location_id	string	ID místa příjemce (jiného než obchodníka) obdrží část tohoto nabídkového řízení.
ID transakce	order.tenders.transaction_id	string	ID přidružené transakce nabídky.
Vytvořeno na adrese	order.tenders.created_at	string	Časové razítko při vytváření ve formátu RFC 3339.
Množství	order.tenders.amount_money.amount	integer	Částka.
Měna	order.tenders.amount_money.currency	string	Měna.
Typ	order.tenders.type	string	Určuje typ.
Stav	order.tenders.card_details.status	string	Aktuální stav platby platební kartou (například AUTHORIZED nebo CAPTURED)
Značka karty	order.tenders.card_details.card.card_brand	string	Značka karty.
last_4	order.tenders.card_details.card.last_4	string	Posledních 4 číslic čísla karty.
Exp Month	order.tenders.card_details.card.exp_month	integer	Měsíc vypršení platnosti přidružené karty jako celé číslo mezi 1 a 12.
Exp Year	order.tenders.card_details.card.exp_year	integer	Čtyřciferný rok data vypršení platnosti karty.
Otisk prstu	order.tenders.card_details.card.fingerprint	string	Zamýšlený jako identifikátor přiřazený k čtverci na základě čísla karty k identifikaci karty na více místech v rámci jedné aplikace.
Entry – metoda	order.tenders.card_details.entry_method	string	Metoda použitá k zadání podrobností karty pro transakci.
ID platby	order.tenders.payment_id	string	Jedinečné ID platby vygenerované čtvercem
Množství	order.total_service_charge_money.amount	integer	Částka.
Měna	order.total_service_charge_money.currency	string	Měna.
Množství	order.net_amounts.total_money.amount	integer	Částka.
Měna	order.net_amounts.total_money.currency	string	Měna.
Množství	order.net_amounts.tax_money.amount	integer	Částka.
Měna	order.net_amounts.tax_money.currency	string	Měna.
Množství	order.net_amounts.discount_money.amount	integer	Částka.
Měna	order.net_amounts.discount_money.currency	string	Měna.
Množství	order.net_amounts.tip_money.amount	integer	Částka.
Měna	order.net_amounts.tip_money.currency	string	Měna.
Množství	order.net_amounts.service_charge_money.amount	integer	Částka.
Měna	order.net_amounts.service_charge_money.currency	string	Měna.
Název	order.source.name	string	Název.
Stát	order.state	string	Aktuální stav.

Pořadí aktualizací (beta verze)

ID operace:

OrderUpdate

Aktualizuje otevřené pořadí přidáním, nahrazením nebo odstraněním polí. Objednávky se stavem COMPLETED nebo CANCELED nelze aktualizovat.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID objednávky	order_id	True	string	Identifikátor objednávky.
Idempotency Key	idempotency_key		string	Zadaná hodnota, která jednoznačně identifikuje tento požadavek mezi všemi vašimi požadavky. Běžným způsobem vytvoření platného klíče idempotence je použití univerzálního jedinečného identifikátoru (UUID).
Version	version		integer	Aktuální verze tohoto objektu.
UID	uid		string	ID vygenerované čtvercem.
Množství	quantity		string	Počet položek ovlivněných fyzickým počtem jako desetinný řetězec. Číslo může podporovat až 5 číslic za desetinnou čárkou.
Název	name		string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Množství	amount		integer	Částka.
Měna	currency		string	Měna.
Pole k vymazání	fields_to_clear		array of string

Návraty

Name	Cesta	Typ	Description
Version	order.version	integer	Aktuální verze tohoto objektu.
Měna	order.total_money.currency	string	Měna.
Množství	order.total_money.amount	integer	Částka.
Název	order.source.name	string	Název.
Řádkové položky	order.line_items	array of object
Měna	order.line_items.total_tax_money.currency	string	Měna.
Množství	order.line_items.total_tax_money.amount	integer	Částka.
Množství	order.line_items.total_money.amount	integer	Částka.
Měna	order.line_items.total_money.currency	string	Měna.
Množství	order.line_items.gross_sales_money.amount	integer	Částka.
Měna	order.line_items.gross_sales_money.currency	string	Měna.
Množství	order.line_items.base_price_money.amount	integer	Částka.
Měna	order.line_items.base_price_money.currency	string	Měna.
Množství	order.line_items.quantity	string	Počet položek ovlivněných fyzickým počtem jako desetinný řetězec. Číslo může podporovat až 5 číslic za desetinnou čárkou.
Měna	order.line_items.total_discount_money.currency	string	Měna.
Množství	order.line_items.total_discount_money.amount	integer	Částka.
Název	order.line_items.name	string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
UID	order.line_items.uid	string	ID vygenerované čtvercem.
Množství	order.line_items.variation_total_price_money.amount	integer	Částka.
Měna	order.line_items.variation_total_price_money.currency	string	Měna.
Stát	order.state	string	Aktuální stav.
Množství	order.total_service_charge_money.amount	integer	Částka.
Měna	order.total_service_charge_money.currency	string	Měna.
ID	order.id	string	Jedinečný identifikátor vystavený čtvercem.
ID místa	order.location_id	string	Identifikátor umístění.
Množství	order.total_tax_money.amount	integer	Částka.
Měna	order.total_tax_money.currency	string	Měna.
Vytvořeno na adrese	order.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Množství	order.total_discount_money.amount	integer	Částka.
Měna	order.total_discount_money.currency	string	Měna.
Měna	order.net_amounts.service_charge_money.currency	string	Měna.
Množství	order.net_amounts.service_charge_money.amount	integer	Částka.
Množství	order.net_amounts.total_money.amount	integer	Částka.
Měna	order.net_amounts.total_money.currency	string	Měna.
Měna	order.net_amounts.discount_money.currency	string	Měna.
Množství	order.net_amounts.discount_money.amount	integer	Částka.
Měna	order.net_amounts.tax_money.currency	string	Měna.
Množství	order.net_amounts.tax_money.amount	integer	Částka.
Aktualizováno na adrese	order.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.

Pořadí klonování (beta verze)

ID operace:

OrderClone

Vytvoří nové pořadí ve stavu KONCEPT duplikováním existující objednávky. Nově vytvořená objednávka obsahuje pouze základní pole (například řádkové položky, daně a slevy) zkopírovaná z původní objednávky.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID objednávky	order_id		string	Identifikátor objednávky.
Version	version		integer	Verze.
Idempotency Key	idempotency_key		string	Zadaná hodnota, která jednoznačně identifikuje tento požadavek mezi všemi vašimi požadavky. Běžným způsobem vytvoření platného klíče idempotence je použití univerzálního jedinečného identifikátoru (UUID).

Návraty

Name	Cesta	Typ	Description
ID	order.id	string	Jedinečný identifikátor vystavený čtvercem.
ID místa	order.location_id	string	Identifikátor umístění.
Řádkové položky	order.line_items	array of object
UID	order.line_items.uid	string	ID vygenerované čtvercem.
Název	order.line_items.name	string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Množství	order.line_items.quantity	string	Počet položek ovlivněných fyzickým počtem jako desetinný řetězec. Číslo může podporovat až 5 číslic za desetinnou čárkou.
Použité daně	order.line_items.applied_taxes	array of object
UID	order.line_items.applied_taxes.uid	string	ID přiřazené čtvercem.
UID daně	order.line_items.applied_taxes.tax_uid	string	UID daně, pro kterou tato uplatněná daň představuje.
Množství	order.line_items.applied_taxes.applied_money.amount	integer	Částka.
Měna	order.line_items.applied_taxes.applied_money.currency	string	Měna.
Použité slevy	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	ID přiřazené čtvercem.
UID slevy	order.line_items.applied_discounts.discount_uid	string	UID slevy, kterou uplatněná sleva představuje.
Množství	order.line_items.applied_discounts.applied_money.amount	integer	Částka.
Měna	order.line_items.applied_discounts.applied_money.currency	string	Měna.
Množství	order.line_items.base_price_money.amount	integer	Částka.
Měna	order.line_items.base_price_money.currency	string	Měna.
Množství	order.line_items.gross_sales_money.amount	integer	Částka.
Měna	order.line_items.gross_sales_money.currency	string	Měna.
Množství	order.line_items.total_tax_money.amount	integer	Částka.
Měna	order.line_items.total_tax_money.currency	string	Měna.
Množství	order.line_items.total_discount_money.amount	integer	Částka.
Měna	order.line_items.total_discount_money.currency	string	Měna.
Množství	order.line_items.total_money.amount	integer	Částka.
Měna	order.line_items.total_money.currency	string	Měna.
Množství	order.line_items.variation_total_price_money.amount	integer	Částka.
Měna	order.line_items.variation_total_price_money.currency	string	Měna.
ID objektu katalogu	order.line_items.catalog_object_id	string	ID objektu CatalogObject generovaného čtvercem, které se sleduje.
Název varianty	order.line_items.variation_name	string	Název varianty použité u této řádkové položky
Modifikátory	order.line_items.modifiers	array of object
UID	order.line_items.modifiers.uid	string	ID přiřazené čtvercem.
ID objektu katalogu	order.line_items.modifiers.catalog_object_id	string	ID objektu katalogu.
Název	order.line_items.modifiers.name	string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Množství	order.line_items.modifiers.base_price_money.amount	integer	Částka.
Měna	order.line_items.modifiers.base_price_money.currency	string	Měna.
Množství	order.line_items.modifiers.total_price_money.amount	integer	Částka.
Měna	order.line_items.modifiers.total_price_money.currency	string	Měna.
Daně	order.taxes	array of object
UID	order.taxes.uid	string	ID vygenerované čtvercem.
Název	order.taxes.name	string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Typ	order.taxes.type	string	Určuje typ.
Procento	order.taxes.percentage	string	Procento v desítkové podobě pomocí oddělovače desetinných míst a bez znaku "%". Hodnota 7,5 odpovídá hodnotě 7,5%.
Množství	order.taxes.applied_money.amount	integer	Částka.
Měna	order.taxes.applied_money.currency	string	Měna.
Scope	order.taxes.scope	string	Označuje aktuální úroveň.
Slevy	order.discounts	array of object
UID	order.discounts.uid	string	ID vygenerované čtvercem.
ID objektu katalogu	order.discounts.catalog_object_id	string	ID objektu CatalogObject generovaného čtvercem, které se sleduje.
Název	order.discounts.name	string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Typ	order.discounts.type	string	Určuje typ.
Procento	order.discounts.percentage	string	Procento v desítkové podobě pomocí oddělovače desetinných míst a bez znaku "%". Hodnota 7,5 odpovídá hodnotě 7,5%.
Množství	order.discounts.applied_money.amount	integer	Částka.
Měna	order.discounts.applied_money.currency	string	Měna.
Scope	order.discounts.scope	string	Označuje aktuální úroveň.
Množství	order.discounts.amount_money.amount	integer	Částka.
Měna	order.discounts.amount_money.currency	string	Měna.
Vytvořeno na adrese	order.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	order.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
Stát	order.state	string	Aktuální stav.
Version	order.version	integer	Aktuální verze tohoto objektu.
ID odkazu	order.reference_id	string	Volitelné uživatelem definované REFERENČNÍ ID.
Množství	order.total_money.amount	integer	Částka.
Měna	order.total_money.currency	string	Měna.
Množství	order.total_tax_money.amount	integer	Částka.
Měna	order.total_tax_money.currency	string	Měna.
Množství	order.total_discount_money.amount	integer	Částka.
Měna	order.total_discount_money.currency	string	Měna.
Množství	order.total_tip_money.amount	integer	Částka.
Měna	order.total_tip_money.currency	string	Měna.
Množství	order.total_service_charge_money.amount	integer	Částka.
Měna	order.total_service_charge_money.currency	string	Měna.
Množství	order.net_amounts.total_money.amount	integer	Částka.
Měna	order.net_amounts.total_money.currency	string	Měna.
Množství	order.net_amounts.tax_money.amount	integer	Částka.
Měna	order.net_amounts.tax_money.currency	string	Měna.
Množství	order.net_amounts.discount_money.amount	integer	Částka.
Měna	order.net_amounts.discount_money.currency	string	Měna.
Množství	order.net_amounts.tip_money.amount	integer	Částka.
Měna	order.net_amounts.tip_money.currency	string	Měna.
Množství	order.net_amounts.service_charge_money.amount	integer	Částka.
Měna	order.net_amounts.service_charge_money.currency	string	Měna.
Název	order.source.name	string	Název.

Prohledat objednávky

ID operace:

OrderSearch

Vyhledejte všechna pořadí pro jedno nebo více míst. Objednávky zahrnují všechny prodeje, výnosy a výměny bez ohledu na to, jak nebo kdy vstoupily do ekosystému Square (například prodejní bod, faktury a rozhraní API pro připojení).

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Návratové položky	return_entries		boolean	Logická hodnota, která řídí formát výsledků hledání. Pokud je true, SearchOrders vrátí OrderEntry objekty. Pokud je hodnota false, vrátí Funkce SearchOrders dokončené objekty pořadí.
Omezení	limit		integer	Omezení počtu výsledků, které se mají vrátit na jedné stránce. Limit je doporučení – implementace může vrátit více nebo méně výsledků. Pokud je zadaný limit záporný, nulový nebo vyšší než maximální limit 1 000, bude ignorován.
ID umístění	location_ids		array of string
Začít od	start_at		string	Hodnota data a času ve formátu RFC 3339 označující, kdy se časový rozsah spustí.
Ukončit na	end_at		string	Hodnota data a času ve formátu RFC 3339 označující, kdy časový rozsah končí.
States	states		array of string
Pole řazení	sort_field		string	Pole, podle které chcete řadit.
Pořadí řazení	sort_order		string	Chronologické pořadí, ve kterém se vrátí výsledky.

Návraty

Name	Cesta	Typ	Description
Položky objednávek	order_entries	array of object
ID objednávky	order_entries.order_id	string	ID objednávky.
ID místa	order_entries.location_id	string	Identifikátor umístění.
Version	order_entries.version	integer	Aktuální verze objektu.
Cursor	cursor	string	Do následných volání tohoto koncového bodu zahrňte kurzor stránkování, který načte další sadu výsledků přidružených k původnímu dotazu.

Publikování faktury

ID operace:

InvoicePublish

Publikuje zadanou koncept fakturu. Po publikování faktury bude square následovat na základě konfigurace faktury. Například Square odešle fakturu na e-mailovou adresu zákazníka, účtuje kartu zákazníka v souboru nebo nic nedělá. Square také zpřístupňuje fakturu na stránce faktury hostované na náměstí.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID faktury	invoice_id	True	string	Identifikátor faktury.
Version	version		integer	Verze.
Idempotency Key	idempotency_key		string	Zadaná hodnota, která jednoznačně identifikuje tento požadavek mezi všemi vašimi požadavky. Běžným způsobem vytvoření platného klíče idempotence je použití univerzálního jedinečného identifikátoru (UUID).

Návraty

Name	Cesta	Typ	Description
ID	invoice.id	string	Jedinečný identifikátor vystavený čtvercem.
Version	invoice.version	integer	Aktuální verze tohoto objektu.
ID místa	invoice.location_id	string	Identifikátor umístění.
ID objednávky	invoice.order_id	string	ID objednávky.
Žádosti o platbu	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	ID vygenerované čtvercem.
Typ požadavku	invoice.payment_requests.request_type	string	Určuje typ žádosti o platbu. Tento typ definuje způsob určení částky žádosti o platbu.
Termín splnění	invoice.payment_requests.due_date	string	Termín splatnosti pro žádost o platbu ve formátu RRRR-MM-DD.
Povolené provazování	invoice.payment_requests.tipping_enabled	boolean	Pokud je nastavená hodnota true, poskytne zákazníkovi místo, kde může zaplatit tip.
Upomínky	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	ID přiřazené čtvercem.
Relativní naplánované dny	invoice.payment_requests.reminders.relative_scheduled_days	integer	Počet dní před odesláním připomenutí (záporné číslo) nebo po (kladném čísle) žádosti o platbu due_date.
Message	invoice.payment_requests.reminders.message	string	Zpráva.
Stav	invoice.payment_requests.reminders.status	string	Aktuální stav.
Množství	invoice.payment_requests.computed_amount_money.amount	integer	Částka.
Měna	invoice.payment_requests.computed_amount_money.currency	string	Měna.
Množství	invoice.payment_requests.total_completed_amount_money.amount	integer	Částka.
Měna	invoice.payment_requests.total_completed_amount_money.currency	string	Měna.
Automatický zdroj plateb	invoice.payment_requests.automatic_payment_source	string	Způsob platby pro automatickou platbu.
Číslo faktury	invoice.invoice_number	string	Uživatelsky přívětivé číslo faktury. Hodnota je jedinečná v rámci umístění. Pokud není k dispozici při vytváření faktury, square přiřadí hodnotu.
Title	invoice.title	string	Název.
Description	invoice.description	string	Popis.
Naplánováno na	invoice.scheduled_at	string	Časové razítko při naplánování zpracování ve formátu RFC 3339.
Stav	invoice.status	string	Aktuální stav ověření tohoto objektu.
Timezone	invoice.timezone	string	Časové pásmo sloužící k interpretaci kalendářních dat. Při vytvoření faktury je toto pole nastaveno na časové pásmo určené pro umístění prodejce. Hodnotu nelze změnit.
Vytvořeno na adrese	invoice.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	invoice.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
ID zákazníka	invoice.primary_recipient.customer_id	string	ID zákazníka přidruženého k objednávce.
křestní jméno	invoice.primary_recipient.given_name	string	Jméno příjemce (tj. jméno).
Příjmení	invoice.primary_recipient.family_name	string	Rodina příjemce (tj. příjmení).
E-mailová adresa	invoice.primary_recipient.email_address	string	E-mailová adresa příjemce.
Telefonní číslo	invoice.primary_recipient.phone_number	string	Telefonní číslo příjemce.
Veřejná adresa URL	invoice.public_url	string	Adresa URL stránky faktury hostované na náměstí. Po publikování faktury pomocí koncového bodu PublishInvoice je square hostitelem stránky faktury a vrátí adresu URL stránky v odpovědi.
Card	invoice.accepted_payment_methods.card	boolean	Určuje, zda jsou přijímány platby kreditní kartou nebo debetní kartou.
Čtvercová dárková karta	invoice.accepted_payment_methods.square_gift_card	boolean	Určuje, jestli jsou přijímány platby za dárkové karty square.
Bankovní účet	invoice.accepted_payment_methods.bank_account	boolean	Určuje, zda jsou přijímány platby bankovním převodem.
Vlastní pole	invoice.custom_fields	array of object
Označení	invoice.custom_fields.label	string	Popisek nebo název vlastního pole
Hodnota	invoice.custom_fields.value	string	Text vlastního pole
Umístění	invoice.custom_fields.placement	string	Umístění vlastního pole na faktuře
Metoda doručení	invoice.delivery_method	string	Metoda doručení, kterou Square používá k odeslání faktury, připomenutí a účtenek zákazníkovi. Po publikování faktury square zpracuje fakturu na základě způsobu doručení a nastavení žádosti o platbu, a to buď okamžitě, nebo v scheduled_at datu, pokud je zadáno.
Datum prodeje nebo služby	invoice.sale_or_service_date	string	Datum prodeje nebo datum vykreslení služby ve formátu RRRR-MM-DD. Toto pole lze použít k zadání data v minulosti nebo budoucnosti, které se zobrazí na faktuře.

Přidání skupiny k zákazníkovi

ID operace:

CustomerAddGroup

Přidá do zákazníka členství ve skupině. Zákazník je identifikován hodnotou customer_id a skupina zákazníků je identifikována hodnotou group_id.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID zákazníka	customer_id	True	string	Identifikátor zákazníka.
ID skupiny	group_id	True	string	Identifikátor skupiny.

Návraty

response

object

Přijmout spor

ID operace:

DisputeAccept

Přijme ztrátu sporu. Square vrátí spornou částku držiteli karet a aktualizuje stav sporu na AKCEPTOVANÝ. Square inkasuje spornou částku z účtu náměstí prodejce. Pokud čtvereční účet nemá dostatek finančních prostředků, square inkasuje přidružený bankovní účet.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID sporu	dispute_id	True	string	Identifikátor sporu.

Návraty

Name	Cesta	Typ	Description
ID	dispute.id	string	Jedinečný identifikátor vystavený čtvercem.
Množství	dispute.amount_money.amount	integer	Částka.
Měna	dispute.amount_money.currency	string	Měna.
Důvod	dispute.reason	string	Důvod tohoto objektu.
Stát	dispute.state	string	Aktuální stav.
Termín splnění na adrese	dispute.due_at	string	Čas splnění další akce ve formátu RFC 3339.
Sporné platby	dispute.disputed_payments	array of object
ID platby	dispute.disputed_payments.payment_id	string	Jedinečné ID platby vygenerované čtvercem
Značka karty	dispute.card_brand	string	Značka karty.
Vytvořeno na adrese	dispute.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	dispute.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
ID sporu značky	dispute.brand_dispute_id	string	ID sporu v systému značky karty vygenerované značkou karty.

Refundace platby

ID operace:

RefundPayment

Vrátí platbu. Můžete vrátit celou částku platby nebo jeho část. Tento koncový bod můžete použít k refundaci platby kartou nebo zaznamenání refundace hotovosti nebo externí platby.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Idempotency Key	idempotency_key		string	Zadaná hodnota, která jednoznačně identifikuje tento požadavek mezi všemi vašimi požadavky. Běžným způsobem vytvoření platného klíče idempotence je použití univerzálního jedinečného identifikátoru (UUID).
ID platby	payment_id		string	Jedinečné ID refundované platby.
Množství	amount		integer	Částka, kterou chcete přijmout za tuto platbu, a to včetně tip_money.
Měna	currency		string	3znakový kód měny ISO 4217.
Množství	amount		integer	Částka, kterou chcete přijmout za tuto platbu, a to včetně tip_money.
Měna	currency		string	3znakový kód měny ISO 4217.
Důvod	reason		string	Popis důvodu vrácení peněz.

Návraty

Name	Cesta	Typ	Description
ID	refund.id	string	Jedinečný identifikátor vystavený čtvercem.
Stav	refund.status	string	Aktuální stav ověření tohoto objektu.
Množství	refund.amount_money.amount	integer	Částka.
Měna	refund.amount_money.currency	string	Měna.
ID platby	refund.payment_id	string	Jedinečné ID platby.
ID objednávky	refund.order_id	string	ID objednávky.
Vytvořeno na adrese	refund.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	refund.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
Množství	refund.app_fee_money.amount	integer	Částka.
Měna	refund.app_fee_money.currency	string	Měna.
ID místa	refund.location_id	string	Identifikátor umístění.
Důvod	refund.reason	string	Důvod tohoto objektu.

Refundace v terminálech vyhledávání

ID operace:

TerminalSearchRefunds

Načte filtrovaný seznam žádostí o refundaci terminálu Interac vytvořených prodejcem, který žádost vytvořila.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Omezení	limit		integer	Omezení počtu výsledků, které se mají vrátit na jedné stránce. Limit je doporučení – implementace může vrátit více nebo méně výsledků. Pokud je zadaný limit záporný, nulový nebo vyšší než maximální limit 1 000, bude ignorován.
Stav	status		string	Aktuální stav.

Návraty

Name	Cesta	Typ	Description
Náhrady	refunds	array of object
ID	refunds.id	string	Jedinečný identifikátor vystavený čtvercem.
ID refundace	refunds.refund_id	string	Jedinečné ID pro tuto refundaci vygenerované čtvercem.
ID platby	refunds.payment_id	string	ID platby.
Množství	refunds.amount_money.amount	integer	Částka.
Měna	refunds.amount_money.currency	string	Měna.
Důvod	refunds.reason	string	Důvod sporu, proč držitel karty zahájil spor se svou bankou.
ID zařízení	refunds.device_id	string	Jedinečné ID zařízení, které tento kód použilo. Naplní se při spárování zařízení.
Doba trvání konečného termínu	refunds.deadline_duration	string	Doba trvání RFC 3339, po které se rezervace automaticky zruší. TerminalCheckout, který je čeká na vyřízení je automaticky zrušen a má důvod zrušení TIMED_OUT. Výchozí hodnota: 5 minut od vytvoření
Stav	refunds.status	string	Aktuální stav ověření tohoto objektu.
Vytvořeno na adrese	refunds.created_at	string	Čas události ve formátu ISO 8601.
Aktualizováno na adrese	refunds.updated_at	string	Časové razítko poslední změny ve formátu RFC 3339
ID aplikace	refunds.app_id	string	ID aplikace, která vytvořila rezervaci.
Značka karty	refunds.card.card_brand	string	Značka karty.
Posledních 4	refunds.card.last_4	string	Posledních 4 číslic čísla karty.
Měsíc vypršení platnosti	refunds.card.exp_month	integer	Měsíc vypršení platnosti přidružené karty jako celé číslo mezi 1 a 12.
Rok vypršení platnosti	refunds.card.exp_year	integer	Čtyřciferný rok data vypršení platnosti karty.
Otisk prstu	refunds.card.fingerprint	string	Zamýšlený jako identifikátor přiřazený k čtverci na základě čísla karty k identifikaci karty na více místech v rámci jedné aplikace.
Typ karty	refunds.card.card_type	string	Typ karty.
POPELNICE	refunds.card.bin	string	Prvních šest číslic čísla karty, označované jako identifikační číslo banky (BIN).
ID objednávky	refunds.order_id	string	ID objednávky.
ID místa	refunds.location_id	string	Identifikátor umístění.

Registrace domény pro Apple Pay

ID operace:

ApplePayRegister

Aktivuje doménu pro použití s Apple Pay na webu a náměstí. V této doméně provádí Apple ověření, aby se zajistilo, že je správně nastavená jako doména s podporou Apple Pay.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Název domény	domain_name	True	string	Název domény, jak je popsáno v dokumentu RFC-1034, který se zaregistruje ve službě Apple Pay.

Návraty

Name	Cesta	Typ	Description
Stav	status	string	Stav registrace domény.

Rezervace terminálů vyhledávání

ID operace:

TerminalSearchCheckouts

Načte filtrovaný seznam žádostí o rezervaci terminálu vytvořených účtem, který žádost provádí.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Omezení	limit		integer	Omezení počtu výsledků, které se mají vrátit na jedné stránce. Limit je doporučení – implementace může vrátit více nebo méně výsledků. Pokud je zadaný limit záporný, nulový nebo vyšší než maximální limit 1 000, bude ignorován.
Stav	status		string	Aktuální stav.

Návraty

Name	Cesta	Typ	Description
Rezervace	checkouts	array of object
ID	checkouts.id	string	Jedinečný identifikátor vystavený čtvercem.
Množství	checkouts.amount_money.amount	integer	Částka.
Měna	checkouts.amount_money.currency	string	Měna.
ID odkazu	checkouts.reference_id	string	Volitelné druhé ID použité k přidružení profilu zákazníka k entitě v jiném systému.
Poznámka:	checkouts.note	string	Vlastní poznámka přidružená k profilu zákazníka.
ID zařízení	checkouts.device_options.device_id	string	Jedinečné ID zařízení určeného pro tuto terminálovou kontrolu.
Povolit tipping	checkouts.device_options.tip_settings.allow_tipping	boolean	Určuje, jestli je pro tuto rezervaci povolené provazování. Výchozí nastavení je „false“.
Přeskočit obrazovku potvrzení	checkouts.device_options.skip_receipt_screen	boolean	Dá zařízení pokyn, aby přeskočí obrazovku potvrzení. Výchozí nastavení je „false“.
Stav	checkouts.status	string	Aktuální stav ověření tohoto objektu.
ID plateb	checkouts.payment_ids	array of string
Vytvořeno na adrese	checkouts.created_at	string	Čas události ve formátu ISO 8601.
Aktualizováno na adrese	checkouts.updated_at	string	Časové razítko poslední změny ve formátu RFC 3339
ID aplikace	checkouts.app_id	string	ID aplikace, která vytvořila rezervaci.
Doba trvání konečného termínu	checkouts.deadline_duration	string	Doba trvání RFC 3339, po které se rezervace automaticky zruší. TerminalCheckout, který je čeká na vyřízení je automaticky zrušen a má důvod zrušení TIMED_OUT. Výchozí hodnota: 5 minut od vytvoření
Cursor	cursor	string	Do následných volání tohoto koncového bodu zahrňte kurzor stránkování, který načte další sadu výsledků přidružených k původnímu dotazu.

Vyhledávání objektů katalogu

ID operace:

CatalogSearch

Vyhledá objekt CatalogObject libovolného typu podle odpovídajících podporovaných hodnot atributů vyhledávání, s výjimkou hodnot vlastních atributů u položek nebo variant položek, na jednom nebo několika zadaných filtrech dotazu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Typy objektů	object_types		array of string
Název atributu	attribute_name		string	Název atributu, který se má prohledávat.
Předpona atributu	attribute_prefix		string	Požadovaná předpona hodnoty atributu vyhledávání.
Omezení	limit		integer	Omezení počtu výsledků, které se mají vrátit na jedné stránce. Limit je doporučení – implementace může vrátit více nebo méně výsledků. Pokud je zadaný limit záporný, nulový nebo vyšší než maximální limit 1 000, bude ignorován.

Návraty

Name	Cesta	Typ	Description
Objects	objects	array of object
Typ	objects.type	string	Typ tohoto objektu.
ID	objects.id	string	Jedinečný identifikátor vystavený čtvercem.
Aktualizováno na adrese	objects.updated_at	string	Časové razítko poslední změny ve formátu RFC 3339
Version	objects.version	integer	Aktuální verze objektu.
Je odstraněno.	objects.is_deleted	boolean	Pokud je hodnota true, objekt byl odstraněn z databáze. Pro vložené nové objekty musí být false. Po odstranění se pole updated_at rovná času odstranění.
Prezentovat na všech místech	objects.present_at_all_locations	boolean	Pokud je hodnota true, tento objekt se nachází ve všech umístěních (včetně budoucích umístění), s výjimkou případů, kdy je zadaný v poli absent_at_location_ids. Pokud je false, tento objekt není k dispozici v žádném umístění (včetně budoucích umístění), s výjimkou místa, kde je uvedeno v poli present_at_location_ids. Pokud není zadáno, výchozí hodnota je true.
Název	objects.item_data.name	string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Description	objects.item_data.title	string	Popis položky Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazů a jeho délka hodnoty je kódových bodů Unicode.
ID kategorie	objects.item_data.category_id	string	ID kategorie položky, pokud existuje.
Typ produktu	objects.item_data.product_type	string	Výraz dotazu typu produkt vrací položky nebo varianty položek se zadanými typy produktů.
DIČ	objects.item_data.tax_ids	array of string
Variace	objects.item_data.variations	array of object
Typ	objects.item_data.variations.type	string	Typ tohoto objektu. Každý typ objektu má očekávané vlastnosti vyjádřené ve strukturovaném formátu v příslušném poli *_data níže.
ID	objects.item_data.variations.id	string	Identifikátor odkaz na tento objekt.
Aktualizováno na adrese	objects.item_data.variations.updated_at	string	Časové razítko poslední změny ve formátu RFC 3339
Version	objects.item_data.variations.version	integer	Verze objektu. Při aktualizaci objektu musí zadaná verze odpovídat verzi v databázi, jinak se zápis zamítne jako konfliktní.
Je odstraněno.	objects.item_data.variations.is_deleted	boolean	Pokud je hodnota true, objekt byl odstraněn z databáze. Pro vložené nové objekty musí být false. Po odstranění se pole updated_at rovná času odstranění.
Prezentovat na všech místech	objects.item_data.variations.present_at_all_locations	boolean	Seznam umístění, kde je objekt přítomný, i když present_at_all_locations je nepravda. Může se jednat o deaktivovaná umístění.
ID položky	objects.item_data.variations.item_variation_data.item_id	string	ID objektu s touto variantou položky.
Název	objects.item_data.variations.item_variation_data.name	string	Název této položky Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazů a jeho délka hodnoty je kódových bodů Unicode.
Řadová číslovka	objects.item_data.variations.item_variation_data.ordinal	integer	Pořadí, ve kterém má být tato varianta položky zobrazena. Tato hodnota je jen pro čtení.
Množství	objects.item_data.variations.item_variation_data.price_money.amount	integer	Částka peněz, v nejmenší nominální hodnotě měny označené měnou. Pokud je například měna USD, částka je v centech. Peněžní částky můžou být kladné nebo záporné. Podívejte se na popis konkrétního pole a určete význam znaménka v konkrétním případě.
Měna	objects.item_data.variations.item_variation_data.price_money.currency	string	Typ měny ve formátu ISO 4217. Například kód měny pro americké dolary je USD.
Cenový typ	objects.item_data.variations.item_variation_data.pricing_type	string	Určuje, zda je cena varianty položky pevná nebo určená v době prodeje.
Viditelnost	objects.item_data.visibility	string	Viditelnost.

Vytvoření faktury

ID operace:

InvoiceCreate

Vytvoří koncept faktury pro objednávku vytvořenou pomocí rozhraní API Objednávky. Koncept faktury zůstane na vašem účtu a neprovedou se žádné akce. Fakturu musíte publikovat, než ji bude moct square zpracovat (poslat ji na e-mailovou adresu zákazníka nebo účtovat kartu zákazníka v souboru).

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Idempotency Key	idempotency_key		string	Zadaná hodnota, která jednoznačně identifikuje tento požadavek mezi všemi vašimi požadavky. Běžným způsobem vytvoření platného klíče idempotence je použití univerzálního jedinečného identifikátoru (UUID).
ID místa	location_id		string	Identifikátor umístění.
ID objednávky	order_id		string	ID objednávky.
Naplánováno na	scheduled_at		string	Časové razítko při naplánování zpracování ve formátu RFC 3339.
ID zákazníka	customer_id		string	ID zákazníka přidruženého k objednávce.
Metoda doručení	delivery_method		string	Metoda doručení, kterou Square používá k odeslání faktury, připomenutí a účtenek zákazníkovi. Po publikování faktury square zpracuje fakturu na základě způsobu doručení a nastavení žádosti o platbu, a to buď okamžitě, nebo v scheduled_at datu, pokud je zadáno.
Typ požadavku	request_type		string	Určuje typ žádosti o platbu. Tento typ definuje způsob určení částky žádosti o platbu.
Termín splnění	due_date		string	Termín splatnosti pro žádost o platbu ve formátu RRRR-MM-DD.
Povolené provazování	tipping_enabled		boolean	Pokud je nastavená hodnota true, poskytne zákazníkovi místo, kde může zaplatit tip.
Automatický zdroj plateb	automatic_payment_source		string	Způsob platby pro automatickou platbu.
Message	message		string	Zpráva.
Relativní naplánované dny	relative_scheduled_days		integer	Počet dní před odesláním připomenutí (záporné číslo) nebo po (kladném čísle) žádosti o platbu due_date.
Číslo faktury	invoice_number		string	Uživatelsky přívětivé číslo faktury. Hodnota je jedinečná v rámci umístění. Pokud není k dispozici při vytváření faktury, square přiřadí hodnotu.
Title	title		string	Název.
Description	description		string	Popis.
Card	card		boolean	Určuje, zda jsou přijímány platby kreditní kartou nebo debetní kartou.
Čtvercová dárková karta	square_gift_card		boolean	Určuje, jestli jsou přijímány platby za dárkové karty square.
Bankovní účet	bank_account		boolean	Určuje, zda jsou přijímány platby bankovním převodem.
Označení	label		string	Popisek nebo název vlastního pole
Hodnota	value		string	Text vlastního pole
Umístění	placement		string	Umístění vlastního pole na faktuře
Datum prodeje nebo služby	sale_or_service_date		string	Datum prodeje nebo datum vykreslení služby ve formátu RRRR-MM-DD. Toto pole lze použít k zadání data v minulosti nebo budoucnosti, které se zobrazí na faktuře.

Návraty

Name	Cesta	Typ	Description
ID	invoice.id	string	Jedinečný identifikátor vystavený čtvercem.
Version	invoice.version	integer	Aktuální verze tohoto objektu.
ID místa	invoice.location_id	string	Identifikátor umístění.
ID objednávky	invoice.order_id	string	ID objednávky.
Žádosti o platbu	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	ID vygenerované čtvercem.
Typ požadavku	invoice.payment_requests.request_type	string	Určuje typ žádosti o platbu. Tento typ definuje způsob určení částky žádosti o platbu.
Termín splnění	invoice.payment_requests.due_date	string	Termín splatnosti pro žádost o platbu ve formátu RRRR-MM-DD.
Povolené provazování	invoice.payment_requests.tipping_enabled	boolean	Pokud je nastavená hodnota true, poskytne zákazníkovi místo, kde může zaplatit tip.
Upomínky	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	ID přiřazené čtvercem.
Relativní naplánované dny	invoice.payment_requests.reminders.relative_scheduled_days	integer	Počet dní před odesláním připomenutí (záporné číslo) nebo po (kladném čísle) žádosti o platbu due_date.
Message	invoice.payment_requests.reminders.message	string	Zpráva.
Stav	invoice.payment_requests.reminders.status	string	Aktuální stav.
Množství	invoice.payment_requests.computed_amount_money.amount	integer	Částka.
Měna	invoice.payment_requests.computed_amount_money.currency	string	Měna.
Množství	invoice.payment_requests.total_completed_amount_money.amount	integer	Částka.
Měna	invoice.payment_requests.total_completed_amount_money.currency	string	Měna.
Automatický zdroj plateb	invoice.payment_requests.automatic_payment_source	string	Způsob platby pro automatickou platbu.
Číslo faktury	invoice.invoice_number	string	Uživatelsky přívětivé číslo faktury. Hodnota je jedinečná v rámci umístění. Pokud není k dispozici při vytváření faktury, square přiřadí hodnotu.
Title	invoice.title	string	Název.
Description	invoice.description	string	Popis.
Naplánováno na	invoice.scheduled_at	string	Časové razítko při naplánování zpracování ve formátu RFC 3339.
Stav	invoice.status	string	Aktuální stav ověření tohoto objektu.
Timezone	invoice.timezone	string	Časové pásmo sloužící k interpretaci kalendářních dat. Při vytvoření faktury je toto pole nastaveno na časové pásmo určené pro umístění prodejce. Hodnotu nelze změnit.
Vytvořeno na adrese	invoice.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	invoice.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
ID zákazníka	invoice.primary_recipient.customer_id	string	ID zákazníka přidruženého k objednávce.
křestní jméno	invoice.primary_recipient.given_name	string	Jméno příjemce (tj. jméno).
Příjmení	invoice.primary_recipient.family_name	string	Rodina příjemce (tj. příjmení).
E-mailová adresa	invoice.primary_recipient.email_address	string	E-mailová adresa příjemce.
Telefonní číslo	invoice.primary_recipient.phone_number	string	Telefonní číslo příjemce.
Card	invoice.accepted_payment_methods.card	boolean	Určuje, zda jsou přijímány platby kreditní kartou nebo debetní kartou.
Čtvercová dárková karta	invoice.accepted_payment_methods.square_gift_card	boolean	Určuje, jestli jsou přijímány platby za dárkové karty square.
Bankovní účet	invoice.accepted_payment_methods.bank_account	boolean	Určuje, zda jsou přijímány platby bankovním převodem.
Vlastní pole	invoice.custom_fields	array of object
Označení	invoice.custom_fields.label	string	Popisek nebo název vlastního pole
Hodnota	invoice.custom_fields.value	string	Text vlastního pole
Umístění	invoice.custom_fields.placement	string	Umístění vlastního pole na faktuře
Metoda doručení	invoice.delivery_method	string	Metoda doručení, kterou Square používá k odeslání faktury, připomenutí a účtenek zákazníkovi. Po publikování faktury square zpracuje fakturu na základě způsobu doručení a nastavení žádosti o platbu, a to buď okamžitě, nebo v scheduled_at datu, pokud je zadáno.
Datum prodeje nebo služby	invoice.sale_or_service_date	string	Datum prodeje nebo datum vykreslení služby ve formátu RRRR-MM-DD. Toto pole lze použít k zadání data v minulosti nebo budoucnosti, které se zobrazí na faktuře.

Vytvoření karty

ID operace:

CardCreate

Přidá kartu do souboru existujícímu obchodníku.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Idempotency Key	idempotency_key		string	Klíč idempotence.
ID zdroje	source_id		string	Identifikátor zdroje.
Řádek adresy 1	address_line_1		string	První řádek adresy. Pole začínající address_line poskytují nejvýraznější podrobnosti adresy, například číslo ulice, název ulice a název budovy.
Řádek adresy 2	address_line_2		string	Druhý řádek adresy, pokud existuje.
Lokalita	locality		string	Město nebo město adresy.
Správní oblast – úroveň 1	administrative_district_level_1		string	Civilní subjekt v rámci země adresy. V USA je to stát.
PSČ	postal_code		string	PSČ adresy.
Country	country		string	Země adresy ve formátu ISO 3166-1-alpha-2.
Název držitelů karet	cardholder_name		string	Jméno držitele karty.
ID zákazníka	customer_id		string	ID tohoto objektu představujícího zákazníka.
ID odkazu	reference_id		string	Volitelné uživatelem definované REFERENČNÍ ID.

Návraty

Name	Cesta	Typ	Description
ID	card.id	string	Jedinečný identifikátor vystavený čtvercem.
Řádek adresy 1	card.billing_address.address_line_1	string	První řádek adresy. Pole začínající address_line poskytují nejvýraznější podrobnosti adresy, například číslo ulice, název ulice a název budovy.
Řádek adresy 2	card.billing_address.address_line_2	string	Druhý řádek adresy, pokud existuje.
Lokalita	card.billing_address.locality	string	Město nebo město adresy.
Správní oblast – úroveň 1	card.billing_address.administrative_district_level_1	string	Civilní subjekt v rámci země adresy. V USA je to stát.
PSČ	card.billing_address.postal_code	string	PSČ adresy.
Country	card.billing_address.country	string	Země adresy ve formátu ISO 3166-1-alpha-2.
Otisk prstu	card.fingerprint	string	Zamýšlený jako identifikátor přiřazený k čtverci na základě čísla karty k identifikaci karty na více místech v rámci jedné aplikace.
POPELNICE	card.bin	string	Prvních šest číslic čísla karty, označované jako identifikační číslo banky (BIN).
Značka karty	card.card_brand	string	Značka karty.
Typ karty	card.card_type	string	Typ karty.
Název držitelů karet	card.cardholder_name	string	Jméno držitele karty.
ID zákazníka	card.customer_id	string	ID tohoto objektu představujícího zákazníka.
Enabled	card.enabled	boolean	Zda je povoleno.
Exp Month	card.exp_month	integer	Měsíc vypršení platnosti přidružené karty jako celé číslo mezi 1 a 12.
Exp Year	card.exp_year	integer	Čtyřciferný rok data vypršení platnosti karty.
Posledních 4	card.last_4	string	Posledních 4 číslic čísla karty.
Předplacený typ	card.prepaid_type	string	Určuje, jestli je karta předplacená nebo ne.
ID odkazu	card.reference_id	string	Volitelné uživatelem definované REFERENČNÍ ID.
Version	card.version	integer	Aktuální verze tohoto objektu.

Vytvoření platby

ID operace:

PaymentCreate

Vytvoří platbu pomocí poskytnutého zdroje. Pomocí tohoto koncového bodu můžete účtovat kartu (kreditní/debetní nebo čtvercovou dárkovou kartu) nebo zaznamenávat platbu, kterou prodejce obdržel mimo square (platbu hotovostí od kupujícího nebo platby, kterou externí entita zpracovala jménem prodejce).

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Idempotency Key	idempotency_key		string	Zadaná hodnota, která jednoznačně identifikuje tento požadavek mezi všemi vašimi požadavky. Běžným způsobem vytvoření platného klíče idempotence je použití univerzálního jedinečného identifikátoru (UUID).
Množství	amount		integer	Částka, kterou chcete přijmout za tuto platbu, a to včetně tip_money.
Měna	currency		string	3znakový kód měny ISO 4217.
ID zdroje	source_id		string	ID zdroje finančních prostředků pro tuto platbu. Může to být platební token (karta nonce) vygenerovaný platebním formulářem Čtverec nebo kartou v souboru vytvořeném pomocí rozhraní API pro zákazníky. Pokud zaznamenáte platbu, kterou prodejce obdržel mimo čtverec, zadejte cash nebo EXTERNAL.
Automatické dokončování	autocomplete		boolean	Pokud je tato platba nastavená na hodnotu true, bude tato platba dokončena, pokud je to možné. Pokud je tato platba nastavená na false, bude tato platba uložena ve schváleném stavu, dokud se explicitně nedokončí (zachyceno) nebo zruší (voided).
ID zákazníka	customer_id		string	ID zákazníka, který se má propojit.
ID místa	location_id		string	Identifikátor umístění.
ID odkazu	reference_id		string	Volitelné druhé ID použité k přidružení profilu zákazníka k entitě v jiném systému.
Poznámka:	note		string	Vlastní poznámka přidružená k profilu zákazníka.
Množství	amount		integer	Částka, kterou chcete přijmout za tuto platbu, a to včetně tip_money.
Měna	currency		string	3znakový kód měny ISO 4217.

Návraty

Name	Cesta	Typ	Description
ID	payment.id	string	Jedinečný identifikátor vystavený čtvercem.
Vytvořeno na adrese	payment.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	payment.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
Množství	payment.amount_money.amount	integer	Částka.
Měna	payment.amount_money.currency	string	Měna.
Množství	payment.app_fee_money.amount	integer	Částka.
Měna	payment.app_fee_money.currency	string	Měna.
Stav	payment.status	string	Aktuální stav ověření tohoto objektu.
Doba trvání zpoždění	payment.delay_duration	string	Doba trvání po vytvoření platby, kdy square automaticky použije delay_action na platbu. Tato automatická delay_action se vztahuje pouze na platby, které nedosahují stavu terminálu (COMPLETED, CANCELED nebo FAILED) před delay_duration časovým obdobím. Toto pole je určeno jako časová doba trvání ve formátu RFC 3339.
Typ zdroje	payment.source_type	string	Typ zdroje pro tuto platbu. Mezi aktuální hodnoty patří KARTA, BANK_ACCOUNT, PENĚŽENKA, HOTOVOST nebo EXTERNÍ.
Stav	payment.card_details.status	string	Aktuální stav.
Značka karty	payment.card_details.card.card_brand	string	Značka karty.
Posledních 4	payment.card_details.card.last_4	string	Posledních 4 číslic čísla karty.
Exp Month	payment.card_details.card.exp_month	integer	Měsíc vypršení platnosti přidružené karty jako celé číslo mezi 1 a 12.
Exp Year	payment.card_details.card.exp_year	integer	Čtyřciferný rok data vypršení platnosti karty.
Otisk prstu	payment.card_details.card.fingerprint	string	Zamýšlený jako identifikátor přiřazený k čtverci na základě čísla karty k identifikaci karty na více místech v rámci jedné aplikace.
Typ karty	payment.card_details.card.card_type	string	Typ karty.
Předplacený typ	payment.card_details.card.prepaid_type	string	Určuje, jestli je karta předplacená nebo ne.
POPELNICE	payment.card_details.card.bin	string	Prvních šest číslic čísla karty, označované jako identifikační číslo banky (BIN).
Entry – metoda	payment.card_details.entry_method	string	Metoda použitá k zadání údajů o platbě na kartě. Metoda může být KEYED, POTÁHNUTÍ PRSTEM, EMV, ON_FILE nebo BEZ KONTAKTU.
Stav CVV	payment.card_details.cvv_status	string	Stavový kód vrácený z kontroly ověřovací hodnoty karty (CVV). Kód může být CVV_ACCEPTED, CVV_REJECTED nebo CVV_NOT_CHECKED.
Stav AVS	payment.card_details.avs_status	string	Stavový kód vrácený z kontroly systému ověřování adres (AVS). Kód může být AVS_ACCEPTED, AVS_REJECTED nebo AVS_NOT_CHECKED.
Ověřovací kód výsledku	payment.card_details.auth_result_code	string	Stavový kód vrácený vystavitelem karty, který popisuje stav autorizace platby.
Popis příkazu	payment.card_details.statement_description	string	Popis příkazu odeslaný do sítí karet.
Autorizované na adrese	payment.card_details.card_payment_timeline.authorized_at	string	Časové razítko, kdy byla platba autorizována, ve formátu RFC 3339.
Zachyceno na	payment.card_details.card_payment_timeline.captured_at	string	Časové razítko, kdy byla platba zaznamenána, ve formátu RFC 3339.
ID místa	payment.location_id	string	Identifikátor umístění.
ID objednávky	payment.order_id	string	ID objednávky.
ID odkazu	payment.reference_id	string	Volitelné uživatelem definované REFERENČNÍ ID.
Vytvořeno na adrese	payment.risk_evaluation.created_at	string	Časové razítko při vytváření ve formátu RFC 3339.
Úroveň rizika	payment.risk_evaluation.risk_level	string	Úroveň rizika spojená s platbou.
Poznámka:	payment.note	string	Vlastní poznámka přidružená k profilu zákazníka.
ID zákazníka	payment.customer_id	string	ID tohoto objektu představujícího zákazníka.
Množství	payment.total_money.amount	integer	Částka.
Měna	payment.total_money.currency	string	Měna.
Množství	payment.approved_money.amount	integer	Částka.
Měna	payment.approved_money.currency	string	Měna.
Číslo potvrzení	payment.receipt_number	string	Číslo potvrzení platby. Pole chybí, pokud je platba zrušena.
Adresa URL potvrzení	payment.receipt_url	string	Adresa URL potvrzení platby. Pole se vyplní jenom pro dokončené platby.
Zpožďovací akce	payment.delay_action	string	Akce, která se má použít na platbu, když delay_duration uplynula.
Zpožděno do	payment.delayed_until	string	Časové razítko jen pro čtení, kdy se delay_action automaticky použije ve formátu RFC 3339.
Čtvercový součin	payment.application_details.square_product	string	Produkt čtverce, například nákupní bod prodeje (POS), čtvercové faktury nebo terminál čtvercového virtuálního terminálu.
Identifikátor aplikace	payment.application_details.application_id	string	ID čtverce jen pro čtení přiřazené aplikaci
Token verze	payment.version_token	string	Tento neprůhlený token identifikuje konkrétní verzi objektu.

Vytvoření předplatného

ID operace:

SubscriptionCreate

Vytvoří předplatné pro zákazníka k plánu předplatného. Pokud v žádosti zadáte kartu v souboru, za předplatné se naúčtuje karta Square. V opačném případě společnost Square fakturuje fakturu na e-mailovou adresu zákazníka. Předplatné se spustí okamžitě, pokud požadavek neobsahuje volitelnou start_date. Každé individuální předplatné je přidružené k určitému umístění.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Idempotency Key	idempotency_key		string	Zadaná hodnota, která jednoznačně identifikuje tento požadavek mezi všemi vašimi požadavky. Běžným způsobem vytvoření platného klíče idempotence je použití univerzálního jedinečného identifikátoru (UUID).
ID místa	location_id		string	Identifikátor umístění.
ID plánu	plan_id		string	ID plánu předplatného vytvořeného pomocí rozhraní API katalogu.
ID zákazníka	customer_id		string	ID zákazníka, který se má propojit.
ID karty	card_id		string	ID karty zákazníka, které se má účtovat.
Datum zahájení	start_date		string	Počáteční datum předplatného ve formátu RRRR-MM-DD.
Procento daně	tax_percentage		string	Daň, která se má přidat při fakturaci předplatného.
Množství	amount		integer	Částka, kterou chcete přijmout za tuto platbu, a to včetně tip_money.
Měna	currency		string	3znakový kód měny ISO 4217.
Timezone	timezone		string	Časové pásmo, které se používá ve výpočtech kalendářních dat předplatného.
Název	name		string	Název objektu.

Návraty

Name	Cesta	Typ	Description
ID	subscription.id	string	Jedinečný identifikátor vystavený čtvercem.
ID místa	subscription.location_id	string	Identifikátor umístění.
ID plánu	subscription.plan_id	string	ID přidruženého plánu předplatného.
ID zákazníka	subscription.customer_id	string	ID tohoto objektu představujícího zákazníka.
Datum zahájení	subscription.start_date	string	Počáteční datum předplatného ve formátu RRRR-MM-DD.
Stav	subscription.status	string	Aktuální stav ověření tohoto objektu.
Procento daně	subscription.tax_percentage	string	Částka daně uplatněná při fakturaci předplatného.
Množství	subscription.price_override_money.amount	integer	Částka.
Měna	subscription.price_override_money.currency	string	Měna.
Version	subscription.version	integer	Aktuální verze tohoto objektu.
Vytvořeno na adrese	subscription.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
ID karty	subscription.card_id	string	ID karty zákazníka, která se účtuje za předplatné.
Timezone	subscription.timezone	string	Časové pásmo sloužící k interpretaci kalendářních dat. Při vytvoření faktury je toto pole nastaveno na časové pásmo určené pro umístění prodejce. Hodnotu nelze změnit.
Název	subscription.source.name	string	Název.

Vytvoření refundace terminálů

ID operace:

TerminalCreateRefund

Vytvoří žádost o refundaci platby Interac dokončené na náměstí terminálu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Idempotency Key	idempotency_key		string	Zadaná hodnota, která jednoznačně identifikuje tento požadavek mezi všemi vašimi požadavky. Běžným způsobem vytvoření platného klíče idempotence je použití univerzálního jedinečného identifikátoru (UUID).
Množství	amount		integer	Částka.
Měna	currency		string	Měna.
ID zařízení	device_id		string	Jedinečné ID zařízení určeného pro tento TerminálRefund.
Důvod	reason		string	Důvod tohoto objektu.
ID platby	payment_id		string	Jedinečné ID platby.

Návraty

Name	Cesta	Typ	Description
ID	refund.id	string	Jedinečný identifikátor vystavený čtvercem.
ID platby	refund.payment_id	string	Jedinečné ID platby.
Množství	refund.amount_money.amount	integer	Částka.
Měna	refund.amount_money.currency	string	Měna.
Důvod	refund.reason	string	Důvod tohoto objektu.
ID zařízení	refund.device_id	string	Jedinečné ID zařízení určeného pro tento TerminálRefund.
Doba trvání konečného termínu	refund.deadline_duration	string	Doba trvání RFC 3339, po které se rezervace automaticky zruší. TerminalCheckout, který je čeká na vyřízení je automaticky zrušen a má důvod zrušení TIMED_OUT. Výchozí hodnota: 5 minut od vytvoření
Stav	refund.status	string	Aktuální stav ověření tohoto objektu.
Vytvořeno na adrese	refund.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	refund.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
ID aplikace	refund.app_id	string	ID aplikace, která vytvořila rezervaci.
Značka karty	refund.card.card_brand	string	Značka karty.
last_4	refund.card.last_4	string	Posledních 4 číslic čísla karty.
Exp Month	refund.card.exp_month	integer	Měsíc vypršení platnosti přidružené karty jako celé číslo mezi 1 a 12.
Exp Year	refund.card.exp_year	integer	Čtyřciferný rok data vypršení platnosti karty.
Otisk prstu	refund.card.fingerprint	string	Zamýšlený jako identifikátor přiřazený k čtverci na základě čísla karty k identifikaci karty na více místech v rámci jedné aplikace.
Typ karty	refund.card.card_type	string	Typ karty.
POPELNICE	refund.card.bin	string	Prvních šest číslic čísla karty, označované jako identifikační číslo banky (BIN).
ID objednávky	refund.order_id	string	ID objednávky.
ID místa	refund.location_id	string	Identifikátor umístění.

Vytvoření rezervace terminálu

ID operace:

TerminalCreateCheckout

Vytvoří žádost o rezervaci terminálu a odešle ji do zadaného zařízení, aby převzala platbu za požadovanou částku.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Idempotency Key	idempotency_key		string	Zadaná hodnota, která jednoznačně identifikuje tento požadavek mezi všemi vašimi požadavky. Běžným způsobem vytvoření platného klíče idempotence je použití univerzálního jedinečného identifikátoru (UUID).
Množství	amount		integer	Částka.
Měna	currency		string	Měna.
ID odkazu	reference_id		string	Volitelné uživatelem definované REFERENČNÍ ID.
ID zařízení	device_id		string	Jedinečné ID zařízení určeného pro tuto terminálovou kontrolu.
Poznámka:	note		string	Vlastní poznámka přidružená k profilu zákazníka.

Návraty

Name	Cesta	Typ	Description
ID	checkout.id	string	Jedinečný identifikátor vystavený čtvercem.
Množství	checkout.amount_money.amount	integer	Částka.
Měna	checkout.amount_money.currency	string	Měna.
ID odkazu	checkout.reference_id	string	Volitelné uživatelem definované REFERENČNÍ ID.
Poznámka:	checkout.note	string	Vlastní poznámka přidružená k profilu zákazníka.
ID zařízení	checkout.device_options.device_id	string	Jedinečné ID zařízení určeného pro tuto terminálovou kontrolu.
Povolit tipping	checkout.device_options.tip_settings.allow_tipping	boolean	Určuje, jestli je pro tuto rezervaci povolené provazování. Výchozí nastavení je „false“.
Přeskočit obrazovku potvrzení	checkout.device_options.skip_receipt_screen	boolean	Dá zařízení pokyn, aby přeskočí obrazovku potvrzení. Výchozí nastavení je „false“.
Stav	checkout.status	string	Aktuální stav ověření tohoto objektu.
Vytvořeno na adrese	checkout.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	checkout.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
ID aplikace	checkout.app_id	string	ID aplikace, která vytvořila rezervaci.
Doba trvání konečného termínu	checkout.deadline_duration	string	Doba trvání RFC 3339, po které se rezervace automaticky zruší. TerminalCheckout, který je čeká na vyřízení je automaticky zrušen a má důvod zrušení TIMED_OUT. Výchozí hodnota: 5 minut od vytvoření
Typ platby	checkout.payment_type	string	Typ platby, ze které by se terminál měl pokusit zachytit. Výchozí hodnota je CARD_PRESENT.

Vytvoření skupiny zákazníků

ID operace:

CustomGroupCreate

Vytvoří novou skupinu zákazníků pro firmu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Název	name		string	Název objektu.

Návraty

Name	Cesta	Typ	Description
ID	group.id	string	Jedinečný identifikátor vystavený čtvercem.
Název	group.name	string	Název objektu.
Vytvořeno na adrese	group.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	group.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.

Vytvoření textu důkazu sporu

ID operace:

DisputeCreateEvidenceText

Nahraje text, který se použije jako důkaz pro sporový problém.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID sporu	dispute_id	True	string	Identifikátor sporu.
Typ důkazů	evidence_type		string	Typ důkazů, které nahráváte.
Text důkazů	evidence_text		string	Řetězec důkazů.
Idempotency Key	idempotency_key		string	Zadaná hodnota, která jednoznačně identifikuje tento požadavek mezi všemi vašimi požadavky. Běžným způsobem vytvoření platného klíče idempotence je použití univerzálního jedinečného identifikátoru (UUID).

Návraty

Name	Cesta	Typ	Description
ID	evidence.id	string	Jedinečný identifikátor vystavený čtvercem.
ID sporu	evidence.dispute_id	string	ID sporu, ke kterým je důkaz přidružený.
Text důkazů	evidence.evidence_text	string	Nezpracovaný text.
Typ důkazů	evidence.evidence_type	string	Typ pf důkaz.
Odesláno na	evidence.uploaded_at	string	Čas splnění další akce ve formátu RFC 3339.

Vytvoření zákazníka

ID operace:

CustomerCreate

Vytvoří nového zákazníka pro firmu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
křestní jméno	given_name		string	Křestní jméno (tj. jméno) přidružené k profilu zákazníka.
Příjmení	family_name		string	Jméno rodiny (tj. příjmení) přidružené k profilu zákazníka.
E-mailová adresa	email_address		string	E-mailová adresa přidružená k profilu zákazníka.
Název společnosti	company_name		string	Obchodní název přidružený k profilu zákazníka.
Přezdívka	nickname		string	Přezdívka pro profil zákazníka.
Řádek adresy 1	address_line_1		string	První řádek adresy.
Řádek adresy 2	address_line_2		string	Druhý řádek adresy, pokud existuje.
Lokalita	locality		string	Město nebo město adresy.
Správní oblast – úroveň 1	administrative_district_level_1		string	Civilní subjekt v rámci země adresy. V USA je to stát.
PSČ	postal_code		string	PSČ adresy.
Country	country		string	Kód země ISO 3166 Alpha-2.
Telefonní číslo	phone_number		string	11místné telefonní číslo přidružené k profilu zákazníka.
ID odkazu	reference_id		string	Volitelné druhé ID použité k přidružení profilu zákazníka k entitě v jiném systému.
Poznámka:	note		string	Vlastní poznámka přidružená k profilu zákazníka.
Narozeniny	birthday		string	Narozeniny přidružené k profilu zákazníka ve formátu RFC 3339. Rok je volitelný. Časové pásmo a čas nejsou povoleny. Například 0000-09-21T00:00:00-00:00 představuje narozeniny 21. září a 1998-09-21T00:00:00-00:00:00 narozeniny 21. září 1998. Tuto hodnotu můžete zadat také ve formátu RRRR-MM-DD.

Návraty

Name	Cesta	Typ	Description
ID	customer.id	string	Jedinečný identifikátor vystavený čtvercem.
Vytvořeno na adrese	customer.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	customer.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
křestní jméno	customer.given_name	string	Zadaný (tj. první) název přidružený k profilu zákazníka.
Příjmení	customer.family_name	string	Rodinné jméno (tj. příjmení) přidružené k profilu zákazníka.
E-mailová adresa	customer.email_address	string	E-mailová adresa přidružená k profilu zákazníka.
Název společnosti	customer.company_name	string	Obchodní název přidružený k profilu zákazníka.
Přezdívka	customer.nickname	string	Přezdívka pro profil zákazníka.
Řádek adresy 1	customer.address.address_line_1	string	První řádek adresy. Pole začínající address_line poskytují nejvýraznější podrobnosti adresy, například číslo ulice, název ulice a název budovy.
Řádek adresy 2	customer.address.address_line_2	string	Druhý řádek adresy, pokud existuje.
Lokalita	customer.address.locality	string	Město nebo město adresy.
Správní oblast – úroveň 1	customer.address.administrative_district_level_1	string	Civilní subjekt v rámci země adresy. V USA je to stát.
PSČ	customer.address.postal_code	string	PSČ adresy.
Country	customer.address.country	string	Země adresy ve formátu ISO 3166-1-alpha-2.
Telefonní číslo	customer.phone_number	string	11místné telefonní číslo přidružené k profilu zákazníka.
ID odkazu	customer.reference_id	string	Volitelné uživatelem definované REFERENČNÍ ID.
Poznámka:	customer.note	string	Vlastní poznámka přidružená k profilu zákazníka.
Narozeniny	customer.birthday	string	Narozeniny přidružené k profilu zákazníka ve formátu RFC 3339. Rok je volitelný. Časové pásmo a čas nejsou povoleny. Například 0000-09-21T00:00:00-00:00 představuje narozeniny 21. září a 1998-09-21T00:00:00-00:00:00 narozeniny 21. září 1998.
Odhlášení odběru e-mailu	customer.preferences.email_unsubscribed	boolean	Určuje, jestli se zákazník odhlásil od odběru e-mailů marketingové kampaně. Hodnota true znamená, že se zákazník rozhodl odhlásit se z e-mailového marketingu od aktuálního prodejce square nebo od všech prodejců square.
Zdroj vytvoření	customer.creation_source	string	Zdroj vytvoření představuje metodu použitou k vytvoření profilu zákazníka.
Version	customer.version	integer	Aktuální verze tohoto objektu.

Vytvořit objednávku

ID operace:

OrderCreate

Vytvoří novou objednávku, která může obsahovat informace o produktech pro nákup a nastavení, která se mají na nákup použít.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Idempotency Key	idempotency_key		string	Zadaná hodnota, která jednoznačně identifikuje tento požadavek mezi všemi vašimi požadavky. Běžným způsobem vytvoření platného klíče idempotence je použití univerzálního jedinečného identifikátoru (UUID).
ID odkazu	reference_id		string	Volitelné uživatelem definované REFERENČNÍ ID.
ID místa	location_id		string	Identifikátor umístění.
Název	name		string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Množství	quantity		string	Počet položek ovlivněných fyzickým počtem jako desetinný řetězec. Číslo může podporovat až 5 číslic za desetinnou čárkou.
Množství	amount		integer	Částka.
Měna	currency		string	Měna.
ID objektu katalogu	catalog_object_id		string	ID objektu CatalogObject generovaného čtvercem, které se sleduje.
ID objektu katalogu	catalog_object_id		string	ID objektu katalogu.
UID slevy	discount_uid		string	UID slevy, kterou uplatněná sleva představuje.
UID	uid		string	ID vygenerované čtvercem.
Název	name		string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Procento	percentage		string	Procento v desítkové podobě pomocí oddělovače desetinných míst a bez znaku "%". Hodnota 7,5 odpovídá hodnotě 7,5%.
Scope	scope		string	Označuje aktuální úroveň.
UID	uid		string	ID vygenerované čtvercem.
Název	name		string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Procento	percentage		string	Procento v desítkové podobě pomocí oddělovače desetinných míst a bez znaku "%". Hodnota 7,5 odpovídá hodnotě 7,5%.
Scope	scope		string	Označuje aktuální úroveň.
ID objektu katalogu	catalog_object_id		string	ID objektu CatalogObject generovaného čtvercem, které se sleduje.
Množství	amount		integer	Částka.
Měna	currency		string	Měna.

Návraty

Name	Cesta	Typ	Description
ID	order.id	string	Jedinečný identifikátor vystavený čtvercem.
ID místa	order.location_id	string	Identifikátor umístění.
Řádkové položky	order.line_items	array of object
UID	order.line_items.uid	string	ID vygenerované čtvercem.
Název	order.line_items.name	string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Množství	order.line_items.quantity	string	Počet položek ovlivněných fyzickým počtem jako desetinný řetězec. Číslo může podporovat až 5 číslic za desetinnou čárkou.
Použité daně	order.line_items.applied_taxes	array of object
UID	order.line_items.applied_taxes.uid	string	ID přiřazené čtvercem.
UID daně	order.line_items.applied_taxes.tax_uid	string	UID daně, pro kterou tato uplatněná daň představuje.
Množství	order.line_items.applied_taxes.applied_money.amount	integer	Částka.
Měna	order.line_items.applied_taxes.applied_money.currency	string	Měna.
Použité slevy	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	ID přiřazené čtvercem.
UID slevy	order.line_items.applied_discounts.discount_uid	string	UID slevy, kterou uplatněná sleva představuje.
Množství	order.line_items.applied_discounts.applied_money.amount	integer	Částka.
Měna	order.line_items.applied_discounts.applied_money.currency	string	Měna.
Množství	order.line_items.base_price_money.amount	integer	Částka.
Měna	order.line_items.base_price_money.currency	string	Měna.
Množství	order.line_items.gross_sales_money.amount	integer	Částka.
Měna	order.line_items.gross_sales_money.currency	string	Měna.
Množství	order.line_items.total_tax_money.amount	integer	Částka.
Měna	order.line_items.total_tax_money.currency	string	Měna.
Množství	order.line_items.total_discount_money.amount	integer	Částka.
Měna	order.line_items.total_discount_money.currency	string	Měna.
Množství	order.line_items.total_money.amount	integer	Částka.
Měna	order.line_items.total_money.currency	string	Měna.
Množství	order.line_items.variation_total_price_money.amount	integer	Částka.
Měna	order.line_items.variation_total_price_money.currency	string	Měna.
ID objektu katalogu	order.line_items.catalog_object_id	string	ID objektu CatalogObject generovaného čtvercem, které se sleduje.
Název varianty	order.line_items.variation_name	string	Název varianty použité u této řádkové položky
Modifikátory	order.line_items.modifiers	array of object
UID	order.line_items.modifiers.uid	string	ID přiřazené čtvercem.
ID objektu katalogu	order.line_items.modifiers.catalog_object_id	string	ID objektu katalogu.
Název	order.line_items.modifiers.name	string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Množství	order.line_items.modifiers.base_price_money.amount	integer	Částka.
Měna	order.line_items.modifiers.base_price_money.currency	string	Měna.
Množství	order.line_items.modifiers.total_price_money.amount	integer	Částka.
Měna	order.line_items.modifiers.total_price_money.currency	string	Měna.
Daně	order.taxes	array of object
UID	order.taxes.uid	string	ID vygenerované čtvercem.
Název	order.taxes.name	string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Typ	order.taxes.type	string	Určuje typ.
Procento	order.taxes.percentage	string	Procento v desítkové podobě pomocí oddělovače desetinných míst a bez znaku "%". Hodnota 7,5 odpovídá hodnotě 7,5%.
Množství	order.taxes.applied_money.amount	integer	Částka.
Měna	order.taxes.applied_money.currency	string	Měna.
Scope	order.taxes.scope	string	Označuje aktuální úroveň.
Slevy	order.discounts	array of object
UID	order.discounts.uid	string	ID vygenerované čtvercem.
ID objektu katalogu	order.discounts.catalog_object_id	string	ID objektu CatalogObject generovaného čtvercem, které se sleduje.
Název	order.discounts.name	string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Typ	order.discounts.type	string	Určuje typ.
Procento	order.discounts.percentage	string	Procento v desítkové podobě pomocí oddělovače desetinných míst a bez znaku "%". Hodnota 7,5 odpovídá hodnotě 7,5%.
Množství	order.discounts.applied_money.amount	integer	Částka.
Měna	order.discounts.applied_money.currency	string	Měna.
Scope	order.discounts.scope	string	Označuje aktuální úroveň.
Množství	order.discounts.amount_money.amount	integer	Částka.
Měna	order.discounts.amount_money.currency	string	Měna.
Vytvořeno na adrese	order.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	order.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
Stát	order.state	string	Aktuální stav.
Version	order.version	integer	Aktuální verze tohoto objektu.
ID odkazu	order.reference_id	string	Volitelné uživatelem definované REFERENČNÍ ID.
Množství	order.total_money.amount	integer	Částka.
Měna	order.total_money.currency	string	Měna.
Množství	order.total_tax_money.amount	integer	Částka.
Měna	order.total_tax_money.currency	string	Měna.
Množství	order.total_discount_money.amount	integer	Částka.
Měna	order.total_discount_money.currency	string	Měna.
Množství	order.total_tip_money.amount	integer	Částka.
Měna	order.total_tip_money.currency	string	Měna.
Množství	order.total_service_charge_money.amount	integer	Částka.
Měna	order.total_service_charge_money.currency	string	Měna.
Množství	order.net_amounts.total_money.amount	integer	Částka.
Měna	order.net_amounts.total_money.currency	string	Měna.
Množství	order.net_amounts.tax_money.amount	integer	Částka.
Měna	order.net_amounts.tax_money.currency	string	Měna.
Množství	order.net_amounts.discount_money.amount	integer	Částka.
Měna	order.net_amounts.discount_money.currency	string	Měna.
Množství	order.net_amounts.tip_money.amount	integer	Částka.
Měna	order.net_amounts.tip_money.currency	string	Měna.
Množství	order.net_amounts.service_charge_money.amount	integer	Částka.
Měna	order.net_amounts.service_charge_money.currency	string	Měna.
Název	order.source.name	string	Název.

Výpis důkazů o sporu

ID operace:

DisputeListEvidence

Vrátí seznam důkazů spojených se sporem.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID sporu	dispute_id	True	string	Identifikátor sporu.

Návraty

Name	Cesta	Typ	Description
Evidence	evidence	array of object
ID	evidence.id	string	Jedinečný identifikátor vystavený čtvercem.
ID sporu	evidence.dispute_id	string	ID sporu, ke kterým je důkaz přidružený.
Text důkazů	evidence.evidence_text	string	Nezpracovaný text.
Typ důkazů	evidence.evidence_type	string	Typ důkazů.
Odesláno na	evidence.uploaded_at	string	Čas splnění další akce ve formátu RFC 3339.
ID důkazu	evidence.evidence_id	string	Čtverec vygenerovaný ID důkazů.
Jméno souboru	evidence.evidence_file.filename	string	Název souboru včetně přípony souboru
Typ souboru	evidence.evidence_file.filetype	string	Soubory důkazy o sporu musí být soubory application/pdf, image/heic, image/heif, image/jpeg, image/png nebo formáty image/tiff.
Cursor	cursor	string	Do následných volání tohoto koncového bodu zahrňte kurzor stránkování, který načte další sadu výsledků přidružených k původnímu dotazu.

Výpis faktur

ID operace:

InvoiceList

Vrátí seznam faktur pro dané umístění.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID místa	location_id		string	Tento volitelný filtr můžete zadat, aby se načetly jenom záznamy patřící do konkrétního umístění.
Cursor	cursor		string	Kurzor stránkování vrácený předchozím voláním tohoto koncového bodu.
Omezení	limit		integer	Horní limit čísla, které se má vrátit v odpovědi.

Návraty

Name	Cesta	Typ	Description
Invoices	invoices	array of object
ID	invoices.id	string	Jedinečný identifikátor vystavený čtvercem.
Version	invoices.version	integer	Aktuální verze objektu.
ID místa	invoices.location_id	string	Identifikátor umístění.
ID objednávky	invoices.order_id	string	ID objednávky.
Žádosti o platbu	invoices.payment_requests	array of object
UID	invoices.payment_requests.uid	string	ID žádosti o platbu na faktuře vygenerované čtvercem.
Typ požadavku	invoices.payment_requests.request_type	string	Určuje typ žádosti o platbu. Tento typ definuje způsob určení částky žádosti o platbu.
Termín splnění	invoices.payment_requests.due_date	string	Termín splatnosti (v časovém pásmu faktury) pro žádost o platbu ve formátu RRRR-MM-DD.
Povolené provazování	invoices.payment_requests.tipping_enabled	boolean	Pokud je nastavená hodnota true, stránka faktury hostovaná na náměstí (pole public_url faktury) poskytuje zákazníkovi místo, kde může zaplatit tip.
upomínky	invoices.payment_requests.reminders	array of object	Upomínky
UID	invoices.payment_requests.reminders.uid	string	ID přiřazené čtvercem, které jednoznačně identifikuje připomenutí v rámci InvoicePaymentRequest.
Relativní naplánované dny	invoices.payment_requests.reminders.relative_scheduled_days	integer	Počet dní před odesláním připomenutí (záporné číslo) nebo po (kladném čísle) žádosti o platbu due_date.
Message	invoices.payment_requests.reminders.message	string	Zpráva s připomenutím
Stav	invoices.payment_requests.reminders.status	string	Stav připomenutí.
Množství	invoices.payment_requests.computed_amount_money.amount	integer	Částka.
Měna	invoices.payment_requests.computed_amount_money.currency	string	Měna.
Množství	invoices.payment_requests.total_completed_amount_money.amount	integer	Částka.
Měna	invoices.payment_requests.total_completed_amount_money.currency	string	Měna.
Automatický zdroj plateb	invoices.payment_requests.automatic_payment_source	string	Způsob platby pro automatickou platbu.
Požadováno procento	invoices.payment_requests.percentage_requested	string	Určuje částku žádosti o platbu v procentech.
ID karty	invoices.payment_requests.card_id	string	ID kreditní nebo debetní karty v souboru, které se mají účtovat za žádost o platbu.
Číslo faktury	invoices.invoice_number	string	Uživatelsky přívětivé číslo faktury.
Title	invoices.title	string	Název faktury.
Description	invoices.description	string	Popis.
Naplánováno na	invoices.scheduled_at	string	Časové razítko, kdy je naplánováno zpracování faktury ve formátu RFC 3339. Po publikování faktury square zpracuje fakturu k zadanému datu podle způsobu doručení a nastavení žádosti o platbu.
Stav	invoices.status	string	Aktuální stav ověření tohoto objektu.
Timezone	invoices.timezone	string	Časové pásmo používané k interpretaci kalendářních dat na faktuře, například due_date. Při vytvoření faktury je toto pole nastaveno na časové pásmo určené pro umístění prodejce. Hodnotu nelze změnit.
Vytvořeno na adrese	invoices.created_at	string	Čas události ve formátu ISO 8601.
Aktualizováno na adrese	invoices.updated_at	string	Časové razítko poslední změny ve formátu RFC 3339
ID zákazníka	invoices.primary_recipient.customer_id	string	ID zákazníka, který se má k této kartě přidružit.
křestní jméno	invoices.primary_recipient.given_name	string	Jméno příjemce (tj. jméno).
Příjmení	invoices.primary_recipient.family_name	string	Rodina příjemce (tj. příjmení).
E-mailová adresa	invoices.primary_recipient.email_address	string	E-mailová adresa příjemce.
Telefonní číslo	invoices.primary_recipient.phone_number	string	Telefonní číslo příjemce.
Card	invoices.accepted_payment_methods.card	boolean	Určuje, zda jsou přijímány platby kreditní kartou nebo debetní kartou.
Čtvercová dárková karta	invoices.accepted_payment_methods.square_gift_card	boolean	Určuje, jestli jsou přijímány platby za dárkové karty square.
Bankovní účet	invoices.accepted_payment_methods.bank_account	boolean	Určuje, zda jsou přijímány platby bankovním převodem.
Vlastní pole	invoices.custom_fields	array of object
Označení	invoices.custom_fields.label	string	Popisek nebo název vlastního pole
Hodnota	invoices.custom_fields.value	string	Text vlastního pole
Umístění	invoices.custom_fields.placement	string	Umístění vlastního pole na faktuře
Metoda doručení	invoices.delivery_method	string	Metoda doručení, kterou Square používá k odeslání faktury, připomenutí a účtenek zákazníkovi.
Datum prodeje nebo služby	invoices.sale_or_service_date	string	Datum prodeje nebo datum vykreslení služby ve formátu RRRR-MM-DD. Toto pole lze použít k zadání data v minulosti nebo budoucnosti, které se zobrazí na faktuře.
Veřejná adresa URL	invoices.public_url	string	Adresa URL stránky faktury hostované na náměstí. Po publikování faktury pomocí koncového bodu PublishInvoice je square hostitelem stránky faktury a vrátí adresu URL stránky v odpovědi.
Množství	invoices.next_payment_amount_money.amount	integer	Částka.
Měna	invoices.next_payment_amount_money.currency	string	Měna.
Cursor	cursor	string	Do následných volání tohoto koncového bodu zahrňte kurzor stránkování, který načte další sadu výsledků přidružených k původnímu dotazu.

Výpis plateb

ID operace:

PaymentList

Načte seznam plateb přijatých účtem, který žádost provádí. Výsledky jsou nakonec konzistentní a nové platby nebo změny plateb můžou trvat několik sekund.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Čas zahájení	begin_time		string	Inkluzivní počáteční čas dotazu na opened_at ve formátu ISO 8601.
Koncový čas	end_time		string	Výhradní koncové datum dotazu na opened_at ve formátu ISO 8601.
Pořadí řazení	sort_order		string	Seřadí vrácený seznam podle toho, kdy byla karta vytvořena se zadaným pořadím.
Cursor	cursor		string	Kurzor stránkování vrácený předchozím voláním tohoto koncového bodu.
ID místa	location_id		string	Tento volitelný filtr můžete zadat, aby se načetly jenom záznamy patřící do konkrétního umístění.
Total	total		integer	Přesná částka v total_money pro platbu.
Posledních 4	last_4		string	Poslední čtyři číslice platební karty.
Značka karty	card_brand		string	Značka platební karty (například VISA).
Omezení	limit		integer	Horní limit čísla, které se má vrátit v odpovědi.

Návraty

Name	Cesta	Typ	Description
Payments	payments	array of object
ID	payments.id	string	Jedinečný identifikátor vystavený čtvercem.
Vytvořeno na adrese	payments.created_at	string	Čas události ve formátu ISO 8601.
Aktualizováno na adrese	payments.updated_at	string	Časové razítko poslední změny ve formátu RFC 3339
Množství	payments.amount_money.amount	integer	Částka.
Měna	payments.amount_money.currency	string	Měna.
Stav	payments.status	string	Aktuální stav ověření tohoto objektu.
Doba trvání zpoždění	payments.delay_duration	string	Doba trvání po vytvoření platby, kdy square automaticky použije delay_action na platbu.
Typ zdroje	payments.source_type	string	Typ zdroje pro tuto platbu.
Stav	payments.card_details.status	string	Aktuální stav platby kartou. Stav může být AUTORIZOVANÝ, ZACHYCENÝ, VOIDED nebo SELHÁNÍ.
Značka karty	payments.card_details.card.card_brand	string	Značka karty.
last_4	payments.card_details.card.last_4	string	Posledních 4 číslic čísla karty.
Exp Month	payments.card_details.card.exp_month	integer	Měsíc vypršení platnosti přidružené karty jako celé číslo mezi 1 a 12.
Exp Year	payments.card_details.card.exp_year	integer	Čtyřciferný rok data vypršení platnosti karty.
Otisk prstu	payments.card_details.card.fingerprint	string	Zamýšlený jako identifikátor přiřazený k čtverci na základě čísla karty k identifikaci karty na více místech v rámci jedné aplikace.
Typ karty	payments.card_details.card.card_type	string	Typ karty.
Předplacený typ	payments.card_details.card.prepaid_type	string	Určuje, jestli je karta předplacená nebo ne.
POPELNICE	payments.card_details.card.bin	string	Prvních šest číslic čísla karty, označované jako bankovní identifikační číslo (BIN)
Entry – metoda	payments.card_details.entry_method	string	Metoda použitá k zadání údajů o platbě na kartě. Metoda může být KEYED, POTÁHNUTÍ PRSTEM, EMV, ON_FILE nebo BEZ KONTAKTU.
Stav Cvv	payments.card_details.cvv_status	string	Stavový kód vrácený z kontroly ověřovací hodnoty karty (CVV). Kód může být CVV_ACCEPTED, CVV_REJECTED nebo CVV_NOT_CHECKED.
Stav Avs	payments.card_details.avs_status	string	Stavový kód vrácený z kontroly systému ověřování adres (AVS). Kód může být AVS_ACCEPTED, AVS_REJECTED nebo AVS_NOT_CHECKED.
Ověřovací kód výsledku	payments.card_details.auth_result_code	string	Stavový kód vrácený vystavitelem karty, který popisuje stav autorizace platby.
Popis příkazu	payments.card_details.statement_description	string	Popis příkazu odeslaný do sítí karet.
Autorizované na adrese	payments.card_details.card_payment_timeline.authorized_at	string	Časové razítko, kdy byla platba autorizována, ve formátu RFC 3339.
Zachyceno na	payments.card_details.card_payment_timeline.captured_at	string	Časové razítko, kdy byla platba zaznamenána, ve formátu RFC 3339.
ID místa	payments.location_id	string	Identifikátor umístění.
ID objednávky	payments.order_id	string	ID objednávky.
Poplatek za zpracování	payments.processing_fee	array of object
Efektivní na adrese	payments.processing_fee.effective_at	string	Časové razítko, kdy se poplatek projeví, ve formátu RFC 3339.
Typ	payments.processing_fee.type	string	Typ tohoto objektu.
Množství	payments.processing_fee.amount_money.amount	integer	Částka.
Měna	payments.processing_fee.amount_money.currency	string	Měna.
Poznámka:	payments.note	string	Vlastní poznámka přidružená k profilu zákazníka.
Množství	payments.total_money.amount	integer	Částka.
Měna	payments.total_money.currency	string	Měna.
Množství	payments.approved_money.amount	integer	Částka.
Měna	payments.approved_money.currency	string	Měna.
Číslo potvrzení	payments.receipt_number	string	Číslo potvrzení platby. Pole chybí, pokud je platba zrušena.
Adresa URL potvrzení	payments.receipt_url	string	Adresa URL potvrzení platby. Pole se vyplní jenom pro dokončené platby.
Zpožďovací akce	payments.delay_action	string	Akce, která se má použít na platbu, když delay_duration uplynula.
Zpožděno do	payments.delayed_until	string	Časové razítko jen pro čtení, kdy se delay_action automaticky použije ve formátu RFC 3339.
ID člena týmu	payments.team_member_id	string	ID objektu TeamMember pro člena týmu přidruženého k objektu.
Čtvercový součin	payments.application_details.square_product	string	Produkt čtverce, například nákupní bod prodeje (POS), čtvercové faktury nebo terminál čtvercového virtuálního terminálu.
Identifikátor aplikace	payments.application_details.application_id	string	ID čtverce přiřazené aplikaci použité k provedení platby. Vývojáři aplikací můžou tyto informace použít k identifikaci plateb, které aplikace zpracovala. Pokud například vývojář ke zpracování plateb používá vlastní aplikaci, obsahuje toto pole ID aplikace z řídicího panelu pro vývojáře. Pokud prodejce ke zpracování plateb používá aplikaci Square App Marketplace, pole obsahuje odpovídající ID aplikace.
Token verze	payments.version_token	string	Používá se pro optimistickou souběžnost. Tento neprůhlený token identifikuje konkrétní verzi objektu Platby.

Výpis refundací plateb

ID operace:

RefundList

Načte seznam refundací pro účet, který žádost provádí. Výsledky jsou nakonec konzistentní a zobrazení nových refundací nebo změn refundací může trvat několik sekund.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Čas zahájení	begin_time		string	Inkluzivní počáteční čas dotazu na opened_at ve formátu ISO 8601.
Koncový čas	end_time		string	Výhradní koncové datum dotazu na opened_at ve formátu ISO 8601.
Pořadí řazení	sort_order		string	Seřadí vrácený seznam podle toho, kdy byla karta vytvořena se zadaným pořadím.
Cursor	cursor		string	Kurzor stránkování vrácený předchozím voláním tohoto koncového bodu.
ID místa	location_id		string	Tento volitelný filtr můžete zadat, aby se načetly jenom záznamy patřící do konkrétního umístění.
Stav	status		string	Pokud je zadáno, vrátí pouze objekty, které odpovídají zadaným stavům.
Typ zdroje	source_type		string	V případě potřeby se vrátí pouze refundace s daným typem zdroje.
Omezení	limit		integer	Horní limit čísla, které se má vrátit v odpovědi.

Návraty

Name	Cesta	Typ	Description
Náhrady	refunds	array of object
ID	refunds.id	string	Jedinečný identifikátor vystavený čtvercem.
Stav	refunds.status	string	Aktuální stav ověření tohoto objektu.
Množství	refunds.amount_money.amount	integer	Částka.
Měna	refunds.amount_money.currency	string	Měna.
ID platby	refunds.payment_id	string	ID platby.
ID objednávky	refunds.order_id	string	ID objednávky.
Vytvořeno na adrese	refunds.created_at	string	Čas události ve formátu ISO 8601.
Aktualizováno na adrese	refunds.updated_at	string	Časové razítko poslední změny ve formátu RFC 3339
Poplatek za zpracování	refunds.processing_fee	array of object
Efektivní na adrese	refunds.processing_fee.effective_at	string	Časové razítko, kdy se poplatek projeví, ve formátu RFC 3339.
Typ	refunds.processing_fee.type	string	Typ tohoto objektu.
Množství	refunds.processing_fee.amount_money.amount	integer	Částka.
Měna	refunds.processing_fee.amount_money.currency	string	Měna.
ID místa	refunds.location_id	string	Identifikátor umístění.
Důvod	refunds.reason	string	Důvod sporu, proč držitel karty zahájil spor se svou bankou.
Cursor	cursor	string	Do následných volání tohoto koncového bodu zahrňte kurzor stránkování, který načte další sadu výsledků přidružených k původnímu dotazu.

Výpis segmentů zákazníků

ID operace:

CustomerSegmentList

Načte seznam segmentů zákazníků firmy.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Cursor	cursor		string	Kurzor stránkování vrácený předchozím voláním tohoto koncového bodu.
Omezení	limit		integer	Horní limit čísla, které se má vrátit v odpovědi.

Návraty

Name	Cesta	Typ	Description
Segments	segments	array of object
ID	segments.id	string	Jedinečný identifikátor vystavený čtvercem.
Název	segments.name	string	Název objektu.
Vytvořeno na adrese	segments.created_at	string	Čas události ve formátu ISO 8601.
Aktualizováno na adrese	segments.updated_at	string	Časové razítko poslední změny ve formátu RFC 3339

Výpis skupin zákazníků

ID operace:

CustomerGroupList

Načte seznam skupin zákazníků firmy.

Návraty

Name	Cesta	Typ	Description
Groups	groups	array of object
ID	groups.id	string	Jedinečný identifikátor vystavený čtvercem.
Název	groups.name	string	Název objektu.
Vytvořeno na adrese	groups.created_at	string	Čas události ve formátu ISO 8601.
Aktualizováno na adrese	groups.updated_at	string	Časové razítko poslední změny ve formátu RFC 3339

Výpis sporů

ID operace:

DisputeList

Vrátí seznam sporů spojených s konkrétním účtem.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Cursor	cursor		string	Kurzor stránkování vrácený předchozím voláním tohoto koncového bodu.
States	states		string	Spor uvádí, že se má výsledek filtrovat. Pokud není zadaný, koncový bod vrátí všechny otevřené spory (stav sporu není INQUIRY_CLOSED, WON nebo LOST).
ID místa	location_id		string	Tento volitelný filtr můžete zadat, aby se načetly jenom záznamy patřící do konkrétního umístění.

Návraty

Name	Cesta	Typ	Description
Spory	disputes	array of object
ID	disputes.id	string	Jedinečný identifikátor vystavený čtvercem.
Množství	disputes.amount_money.amount	integer	Částka.
Měna	disputes.amount_money.currency	string	Měna.
Důvod	disputes.reason	string	Důvod sporu, proč držitel karty zahájil spor se svou bankou.
Stát	disputes.state	string	Aktuální stav.
Termín splnění na adrese	disputes.due_at	string	Čas splnění další akce ve formátu RFC 3339.
Sporné platby	disputes.disputed_payments	array of object
ID platby	disputes.disputed_payments.payment_id	string	Square-generated unique ID of the payment being disputed.
Značka karty	disputes.card_brand	string	Značka karty použitá ve sporné platbě.
Vytvořeno na adrese	disputes.created_at	string	Čas události ve formátu ISO 8601.
Aktualizováno na adrese	disputes.updated_at	string	Časové razítko poslední změny ve formátu RFC 3339
ID sporu značky	disputes.brand_dispute_id	string	ID sporu v systému značky karty vygenerované značkou karty.
Cursor	cursor	string	Do následných volání tohoto koncového bodu zahrňte kurzor stránkování, který načte další sadu výsledků přidružených k původnímu dotazu.

Výpis událostí odběru

ID operace:

SubscriptionListEvents

Zobrazí seznam všech událostí pro konkrétní předplatné.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Identifikátor předplatného	subscription_id	True	string	Identifikátor předplatného.

Návraty

Name	Cesta	Typ	Description
Události odběru	subscription_events	array of object
ID	subscription_events.id	string	Jedinečný identifikátor vystavený čtvercem.
Typ události odběru	subscription_events.subscription_event_type	string	Typ události odběru
Den nabytí účinnosti	subscription_events.effective_date	string	Datum ve formátu RRRR-MM-DD, kdy se událost odběru projevila.
ID plánu	subscription_events.plan_id	string	ID přidruženého plánu předplatného

Výpis zákazníků

ID operace:

CustomerList

Zobrazí seznam profilů zákazníků přidružených k účtu Square. Za normálních provozních podmínek se nově vytvořené nebo aktualizované profily zákazníků zpřístupní pro operaci výpisu do 30 sekund. Někdy může šíření nových nebo aktualizovaných profilů trvat déle než jednu minutu, zejména při incidentech a výpadkech sítě.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Cursor	cursor		string	Kurzor stránkování vrácený předchozím voláním tohoto koncového bodu.
Omezení	limit		integer	Horní limit čísla, které se má vrátit v odpovědi.
Pole řazení	sort_field		string	Určuje, jak mají být zákazníci seřazeni. Výchozí hodnota je DEFAULT.
Pořadí řazení	sort_order		string	Seřadí vrácený seznam podle toho, kdy byla karta vytvořena se zadaným pořadím.

Návraty

Name	Cesta	Typ	Description
Zákazníci	customers	array of object
ID	customers.id	string	Jedinečný identifikátor vystavený čtvercem.
Vytvořeno na adrese	customers.created_at	string	Čas události ve formátu ISO 8601.
Aktualizováno na adrese	customers.updated_at	string	Časové razítko poslední změny ve formátu RFC 3339
křestní jméno	customers.given_name	string	Zadaný (tj. první) název přidružený k profilu zákazníka.
Příjmení	customers.family_name	string	Rodinné jméno (tj. příjmení) přidružené k profilu zákazníka.
E-mailová adresa	customers.email_address	string	E-mailová adresa přidružená k profilu zákazníka.
Řádek adresy 1	customers.address.address_line_1	string	První řádek adresy.
Řádek adresy 2	customers.address.address_line_2	string	Druhý řádek adresy, pokud existuje.
Lokalita	customers.address.locality	string	Město nebo město adresy.
Správní oblast – úroveň 1	customers.address.administrative_district_level_1	string	Civilní subjekt v rámci země adresy. V USA je to stát.
PSČ	customers.address.postal_code	string	PSČ adresy.
Country	customers.address.country	string	Země adresy ve formátu ISO 3166-1-alpha-2.
Telefonní číslo	customers.phone_number	string	11místné telefonní číslo přidružené k profilu zákazníka.
ID odkazu	customers.reference_id	string	Volitelné druhé ID použité k přidružení profilu zákazníka k entitě v jiném systému.
Poznámka:	customers.note	string	Vlastní poznámka přidružená k profilu zákazníka.
Odhlášení odběru e-mailu	customers.preferences.email_unsubscribed	boolean	Určuje, jestli se zákazník odhlásil od odběru e-mailů marketingové kampaně. Hodnota true znamená, že se zákazník rozhodl odhlásit se z e-mailového marketingu od aktuálního prodejce square nebo od všech prodejců square. Tato hodnota je jen pro čtení z rozhraní API customers.
Zdroj vytvoření	customers.creation_source	string	Zdroj vytvoření představuje metodu použitou k vytvoření profilu zákazníka.
ID skupin	customers.group_ids	array of string
ID segmentů	customers.segment_ids	array of string
Version	customers.version	integer	Aktuální verze objektu.

Výpočet pořadí (beta verze)

ID operace:

OrderCalculate

Umožňuje aplikacím zobrazit náhled cen objednávek bez vytvoření objednávky.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Idempotency Key	idempotency_key		string	Zadaná hodnota, která jednoznačně identifikuje tento požadavek mezi všemi vašimi požadavky. Běžným způsobem vytvoření platného klíče idempotence je použití univerzálního jedinečného identifikátoru (UUID).
ID místa	location_id		string	Identifikátor umístění.
Název	name		string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Procento	percentage		string	Procento v desítkové podobě pomocí oddělovače desetinných míst a bez znaku "%". Hodnota 7,5 odpovídá hodnotě 7,5%.
Scope	scope		string	Označuje aktuální úroveň.
Název	name		string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Množství	quantity		string	Počet položek ovlivněných fyzickým počtem jako desetinný řetězec. Číslo může podporovat až 5 číslic za desetinnou čárkou.
Množství	amount		integer	Částka.
Měna	currency		string	Měna.

Návraty

Name	Cesta	Typ	Description
ID místa	order.location_id	string	Identifikátor umístění.
Řádkové položky	order.line_items	array of object
UID	order.line_items.uid	string	ID vygenerované čtvercem.
Množství	order.line_items.quantity	string	Počet položek ovlivněných fyzickým počtem jako desetinný řetězec. Číslo může podporovat až 5 číslic za desetinnou čárkou.
Název	order.line_items.name	string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Množství	order.line_items.base_price_money.amount	integer	Částka.
Měna	order.line_items.base_price_money.currency	string	Měna.
Množství	order.line_items.gross_sales_money.amount	integer	Částka.
Měna	order.line_items.gross_sales_money.currency	string	Měna.
Množství	order.line_items.total_tax_money.amount	integer	Částka.
Měna	order.line_items.total_tax_money.currency	string	Měna.
Množství	order.line_items.total_discount_money.amount	integer	Částka.
Měna	order.line_items.total_discount_money.currency	string	Měna.
Množství	order.line_items.total_money.amount	integer	Částka.
Měna	order.line_items.total_money.currency	string	Měna.
Množství	order.line_items.variation_total_price_money.amount	integer	Částka.
Měna	order.line_items.variation_total_price_money.currency	string	Měna.
Použité slevy	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	ID přiřazené čtvercem.
UID slevy	order.line_items.applied_discounts.discount_uid	string	UID slevy, kterou uplatněná sleva představuje.
Množství	order.line_items.applied_discounts.applied_money.amount	integer	Částka.
Měna	order.line_items.applied_discounts.applied_money.currency	string	Měna.
Slevy	order.discounts	array of object
UID	order.discounts.uid	string	ID vygenerované čtvercem.
Název	order.discounts.name	string	Název položky. Toto je prohledávatelný atribut pro použití v příslušných filtrech dotazu, jeho hodnota nesmí být prázdná a délka je kódových bodů Unicode.
Procento	order.discounts.percentage	string	Procento v desítkové podobě pomocí oddělovače desetinných míst a bez znaku "%". Hodnota 7,5 odpovídá hodnotě 7,5%.
Množství	order.discounts.applied_money.amount	integer	Částka.
Měna	order.discounts.applied_money.currency	string	Měna.
Typ	order.discounts.type	string	Určuje typ.
Scope	order.discounts.scope	string	Označuje aktuální úroveň.
Vytvořeno na adrese	order.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	order.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
Stát	order.state	string	Aktuální stav.
Version	order.version	integer	Aktuální verze tohoto objektu.
Množství	order.total_tax_money.amount	integer	Částka.
Měna	order.total_tax_money.currency	string	Měna.
Množství	order.total_discount_money.amount	integer	Částka.
Měna	order.total_discount_money.currency	string	Měna.
Množství	order.total_tip_money.amount	integer	Částka.
Měna	order.total_tip_money.currency	string	Měna.
Množství	order.total_money.amount	integer	Částka.
Měna	order.total_money.currency	string	Měna.
Množství	order.total_service_charge_money.amount	integer	Částka.
Měna	order.total_service_charge_money.currency	string	Měna.
Množství	order.net_amounts.total_money.amount	integer	Částka.
Měna	order.net_amounts.total_money.currency	string	Měna.
Množství	order.net_amounts.tax_money.amount	integer	Částka.
Měna	order.net_amounts.tax_money.currency	string	Měna.
Množství	order.net_amounts.discount_money.amount	integer	Částka.
Měna	order.net_amounts.discount_money.currency	string	Měna.
Množství	order.net_amounts.tip_money.amount	integer	Částka.
Měna	order.net_amounts.tip_money.currency	string	Měna.
Množství	order.net_amounts.service_charge_money.amount	integer	Částka.
Měna	order.net_amounts.service_charge_money.currency	string	Měna.

Zakázání karty

ID operace:

CardDisable

Zakáže kartu a zabrání dalším aktualizacím nebo poplatkům. Zakázání již zakázané karty je povolené, ale nemá žádný vliv.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID karty	card_id	True	string	Identifikátor karty.

Návraty

Name	Cesta	Typ	Description
ID	card.id	string	Jedinečný identifikátor vystavený čtvercem.
Řádek adresy 1	card.billing_address.address_line_1	string	První řádek adresy. Pole začínající address_line poskytují nejvýraznější podrobnosti adresy, například číslo ulice, název ulice a název budovy.
Řádek adresy 2	card.billing_address.address_line_2	string	Druhý řádek adresy, pokud existuje.
Lokalita	card.billing_address.locality	string	Město nebo město adresy.
Správní oblast – úroveň 1	card.billing_address.administrative_district_level_1	string	Civilní subjekt v rámci země adresy. V USA je to stát.
PSČ	card.billing_address.postal_code	string	PSČ adresy.
Country	card.billing_address.country	string	Země adresy ve formátu ISO 3166-1-alpha-2.
Otisk prstu	card.fingerprint	string	Zamýšlený jako identifikátor přiřazený k čtverci na základě čísla karty k identifikaci karty na více místech v rámci jedné aplikace.
POPELNICE	card.bin	string	Prvních šest číslic čísla karty, označované jako identifikační číslo banky (BIN).
Značka karty	card.card_brand	string	Značka karty.
Typ karty	card.card_type	string	Typ karty.
Název držitelů karet	card.cardholder_name	string	Jméno držitele karty.
ID zákazníka	card.customer_id	string	ID tohoto objektu představujícího zákazníka.
Enabled	card.enabled	boolean	Zda je povoleno.
Exp Month	card.exp_month	integer	Měsíc vypršení platnosti přidružené karty jako celé číslo mezi 1 a 12.
Exp Year	card.exp_year	integer	Čtyřciferný rok data vypršení platnosti karty.
Posledních 4	card.last_4	string	Posledních 4 číslic čísla karty.
Předplacený typ	card.prepaid_type	string	Určuje, jestli je karta předplacená nebo ne.
ID odkazu	card.reference_id	string	Volitelné uživatelem definované REFERENČNÍ ID.
Version	card.version	integer	Aktuální verze tohoto objektu.

Zrušení faktury

ID operace:

InvoiceCancel

Zruší fakturu. Prodejce nemůže shromažďovat platby za zrušenou fakturu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID faktury	invoice_id	True	string	Identifikátor faktury.
Version	version		integer	Verze.

Návraty

Name	Cesta	Typ	Description
ID	invoice.id	string	Jedinečný identifikátor vystavený čtvercem.
Version	invoice.version	integer	Aktuální verze tohoto objektu.
ID místa	invoice.location_id	string	Identifikátor umístění.
ID objednávky	invoice.order_id	string	ID objednávky.
Žádosti o platbu	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	ID vygenerované čtvercem.
Typ požadavku	invoice.payment_requests.request_type	string	Určuje typ žádosti o platbu. Tento typ definuje způsob určení částky žádosti o platbu.
Termín splnění	invoice.payment_requests.due_date	string	Termín splatnosti pro žádost o platbu ve formátu RRRR-MM-DD.
Povolené provazování	invoice.payment_requests.tipping_enabled	boolean	Pokud je nastavená hodnota true, poskytne zákazníkovi místo, kde může zaplatit tip.
Upomínky	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	ID přiřazené čtvercem.
Relativní naplánované dny	invoice.payment_requests.reminders.relative_scheduled_days	integer	Počet dní před odesláním připomenutí (záporné číslo) nebo po (kladném čísle) žádosti o platbu due_date.
Message	invoice.payment_requests.reminders.message	string	Zpráva.
Stav	invoice.payment_requests.reminders.status	string	Aktuální stav.
Množství	invoice.payment_requests.computed_amount_money.amount	integer	Částka.
Měna	invoice.payment_requests.computed_amount_money.currency	string	Měna.
Množství	invoice.payment_requests.total_completed_amount_money.amount	integer	Částka.
Měna	invoice.payment_requests.total_completed_amount_money.currency	string	Měna.
Automatický zdroj plateb	invoice.payment_requests.automatic_payment_source	string	Způsob platby pro automatickou platbu.
Číslo faktury	invoice.invoice_number	string	Uživatelsky přívětivé číslo faktury. Hodnota je jedinečná v rámci umístění. Pokud není k dispozici při vytváření faktury, square přiřadí hodnotu.
Title	invoice.title	string	Název.
Description	invoice.description	string	Popis.
Naplánováno na	invoice.scheduled_at	string	Časové razítko při naplánování zpracování ve formátu RFC 3339.
Stav	invoice.status	string	Aktuální stav ověření tohoto objektu.
Timezone	invoice.timezone	string	Časové pásmo sloužící k interpretaci kalendářních dat. Při vytvoření faktury je toto pole nastaveno na časové pásmo určené pro umístění prodejce. Hodnotu nelze změnit.
Vytvořeno na adrese	invoice.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	invoice.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
ID zákazníka	invoice.primary_recipient.customer_id	string	ID zákazníka přidruženého k objednávce.
křestní jméno	invoice.primary_recipient.given_name	string	Jméno příjemce (tj. jméno).
Příjmení	invoice.primary_recipient.family_name	string	Rodina příjemce (tj. příjmení).
E-mailová adresa	invoice.primary_recipient.email_address	string	E-mailová adresa příjemce.
Telefonní číslo	invoice.primary_recipient.phone_number	string	Telefonní číslo příjemce.
Card	invoice.accepted_payment_methods.card	boolean	Určuje, zda jsou přijímány platby kreditní kartou nebo debetní kartou.
Čtvercová dárková karta	invoice.accepted_payment_methods.square_gift_card	boolean	Určuje, jestli jsou přijímány platby za dárkové karty square.
Bankovní účet	invoice.accepted_payment_methods.bank_account	boolean	Určuje, zda jsou přijímány platby bankovním převodem.
Vlastní pole	invoice.custom_fields	array of object
Označení	invoice.custom_fields.label	string	Popisek nebo název vlastního pole
Hodnota	invoice.custom_fields.value	string	Text vlastního pole
Umístění	invoice.custom_fields.placement	string	Umístění vlastního pole na faktuře
Metoda doručení	invoice.delivery_method	string	Metoda doručení, kterou Square používá k odeslání faktury, připomenutí a účtenek zákazníkovi. Po publikování faktury square zpracuje fakturu na základě způsobu doručení a nastavení žádosti o platbu, a to buď okamžitě, nebo v scheduled_at datu, pokud je zadáno.
Datum prodeje nebo služby	invoice.sale_or_service_date	string	Datum prodeje nebo datum vykreslení služby ve formátu RRRR-MM-DD. Toto pole lze použít k zadání data v minulosti nebo budoucnosti, které se zobrazí na faktuře.

Zrušení platby

ID operace:

PaymentCancel

Zruší platbu (voids). Tento koncový bod můžete použít ke zrušení platby se stavem APPROVED.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID platby	payment_id	True	string	Identifikátor platby.

Návraty

Name	Cesta	Typ	Description
ID	payment.id	string	Jedinečný identifikátor vystavený čtvercem.
Vytvořeno na adrese	payment.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	payment.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
Množství	payment.amount_money.amount	integer	Částka.
Měna	payment.amount_money.currency	string	Měna.
Množství	payment.tip_money.amount	integer	Částka.
Měna	payment.tip_money.currency	string	Měna.
Stav	payment.status	string	Aktuální stav ověření tohoto objektu.
Doba trvání zpoždění	payment.delay_duration	string	Doba trvání po vytvoření platby, kdy square automaticky použije delay_action na platbu. Tato automatická delay_action se vztahuje pouze na platby, které nedosahují stavu terminálu (COMPLETED, CANCELED nebo FAILED) před delay_duration časovým obdobím. Toto pole je určeno jako časová doba trvání ve formátu RFC 3339.
Typ zdroje	payment.source_type	string	Typ zdroje pro tuto platbu. Mezi aktuální hodnoty patří KARTA, BANK_ACCOUNT, PENĚŽENKA, HOTOVOST nebo EXTERNÍ.
Stav	payment.card_details.status	string	Aktuální stav.
Značka karty	payment.card_details.card.card_brand	string	Značka karty.
Posledních 4	payment.card_details.card.last_4	string	Posledních 4 číslic čísla karty.
Exp Month	payment.card_details.card.exp_month	integer	Měsíc vypršení platnosti přidružené karty jako celé číslo mezi 1 a 12.
Exp Year	payment.card_details.card.exp_year	integer	Čtyřciferný rok data vypršení platnosti karty.
Otisk prstu	payment.card_details.card.fingerprint	string	Zamýšlený jako identifikátor přiřazený k čtverci na základě čísla karty k identifikaci karty na více místech v rámci jedné aplikace.
Typ karty	payment.card_details.card.card_type	string	Typ karty.
Předplacený typ	payment.card_details.card.prepaid_type	string	Určuje, jestli je karta předplacená nebo ne.
POPELNICE	payment.card_details.card.bin	string	Prvních šest číslic čísla karty, označované jako identifikační číslo banky (BIN).
Entry – metoda	payment.card_details.entry_method	string	Metoda použitá k zadání údajů o platbě na kartě. Metoda může být KEYED, POTÁHNUTÍ PRSTEM, EMV, ON_FILE nebo BEZ KONTAKTU.
Stav CVV	payment.card_details.cvv_status	string	Stavový kód vrácený z kontroly ověřovací hodnoty karty (CVV). Kód může být CVV_ACCEPTED, CVV_REJECTED nebo CVV_NOT_CHECKED.
Stav AVS	payment.card_details.avs_status	string	Stavový kód vrácený z kontroly systému ověřování adres (AVS). Kód může být AVS_ACCEPTED, AVS_REJECTED nebo AVS_NOT_CHECKED.
Ověřovací kód výsledku	payment.card_details.auth_result_code	string	Stavový kód vrácený vystavitelem karty, který popisuje stav autorizace platby.
Popis příkazu	payment.card_details.statement_description	string	Popis příkazu odeslaný do sítí karet.
Autorizované na adrese	payment.card_details.card_payment_timeline.authorized_at	string	Časové razítko, kdy byla platba autorizována, ve formátu RFC 3339.
Voided At	payment.card_details.card_payment_timeline.voided_at	string	Časové razítko, kdy byla platba zrušena, ve formátu RFC 3339.
ID místa	payment.location_id	string	Identifikátor umístění.
ID objednávky	payment.order_id	string	ID objednávky.
Vytvořeno na adrese	payment.risk_evaluation.created_at	string	Časové razítko při vytváření ve formátu RFC 3339.
Úroveň rizika	payment.risk_evaluation.risk_level	string	Úroveň rizika spojená s platbou.
Poznámka:	payment.note	string	Vlastní poznámka přidružená k profilu zákazníka.
ID zákazníka	payment.customer_id	string	ID tohoto objektu představujícího zákazníka.
Množství	payment.total_money.amount	integer	Částka.
Měna	payment.total_money.currency	string	Měna.
Množství	payment.approved_money.amount	integer	Částka.
Měna	payment.approved_money.currency	string	Měna.
Zpožďovací akce	payment.delay_action	string	Akce, která se má použít na platbu, když delay_duration uplynula.
Zpožděno do	payment.delayed_until	string	Časové razítko jen pro čtení, kdy se delay_action automaticky použije ve formátu RFC 3339.
Čtvercový součin	payment.application_details.square_product	string	Produkt čtverce, například nákupní bod prodeje (POS), čtvercové faktury nebo terminál čtvercového virtuálního terminálu.
Identifikátor aplikace	payment.application_details.application_id	string	ID čtverce jen pro čtení přiřazené aplikaci
Token verze	payment.version_token	string	Tento neprůhlený token identifikuje konkrétní verzi objektu.

Zrušení platby pomocí idempotentního klíče

ID operace:

PaymentCancelIdempotency

Zruší (voids) platbu identifikovanou klíčem idempotence, který je zadaný v požadavku. Tuto metodu použijte, pokud je stav požadavku CreatePayment neznámý (například po odeslání požadavku CreatePayment dojde k chybě sítě a nedostanete odpověď). V takovém případě můžete nasměrovat square k zrušení platby pomocí tohoto koncového bodu. V žádosti zadáte stejný klíč idempotence, který jste zadali v požadavku CreatePayment, který chcete zrušit. Po zrušení platby můžete žádost o vytvoření zálohy odeslat znovu. Upozorňujeme, že pokud se nenajde žádná platba se zadaným klíčem idempotence, neprovedou se žádné akce a koncový bod se úspěšně vrátí.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Idempotency Key	idempotency_key		string	Zadaná hodnota, která jednoznačně identifikuje tento požadavek mezi všemi vašimi požadavky. Běžným způsobem vytvoření platného klíče idempotence je použití univerzálního jedinečného identifikátoru (UUID).

Návraty

response

object

Zrušení předplatného

ID operace:

SubscriptionCancel

Nastaví pole canceled_date na konec aktivního fakturačního období. Po tomto datu se stav změní z AKTIVNÍ na ZRUŠENO.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Identifikátor předplatného	subscription_id	True	string	Identifikátor předplatného.

Návraty

Name	Cesta	Typ	Description
ID	subscription.id	string	Jedinečný identifikátor vystavený čtvercem.
ID místa	subscription.location_id	string	Identifikátor umístění.
ID plánu	subscription.plan_id	string	ID přidruženého plánu předplatného.
ID zákazníka	subscription.customer_id	string	ID tohoto objektu představujícího zákazníka.
ID karty	subscription.card_id	string	ID karty zákazníka, která se účtuje za předplatné.
Datum zahájení	subscription.start_date	string	Počáteční datum předplatného ve formátu RRRR-MM-DD.
Datum zrušení	subscription.canceled_date	string	Datum zrušení předplatného ve formátu RRRR-MM-DD.
Zaplaceno do data	subscription.paid_until_date	string	Datum zaplaceno do.
Stav	subscription.status	string	Aktuální stav ověření tohoto objektu.
Vytvořeno na adrese	subscription.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Version	subscription.version	integer	Aktuální verze tohoto objektu.
Timezone	subscription.timezone	string	Časové pásmo sloužící k interpretaci kalendářních dat. Při vytvoření faktury je toto pole nastaveno na časové pásmo určené pro umístění prodejce. Hodnotu nelze změnit.
Název	subscription.source.name	string	Název.

Zrušení refundace terminálů

ID operace:

TerminalCancelRefund

Zruší žádost o refundaci v rámci terminálu interac podle ID žádosti o refundaci, pokud to stav žádosti umožňuje.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID refundace terminálu	terminal_refund_id	True	string	Identifikátor refundace terminálu.

Návraty

Name	Cesta	Typ	Description
ID	refund.id	string	Jedinečný identifikátor vystavený čtvercem.
ID platby	refund.payment_id	string	Jedinečné ID platby.
Množství	refund.amount_money.amount	integer	Částka.
Měna	refund.amount_money.currency	string	Měna.
Důvod	refund.reason	string	Důvod tohoto objektu.
ID zařízení	refund.device_id	string	Jedinečné ID zařízení určeného pro tento TerminálRefund.
Doba trvání konečného termínu	refund.deadline_duration	string	Doba trvání RFC 3339, po které se rezervace automaticky zruší. TerminalCheckout, který je čeká na vyřízení je automaticky zrušen a má důvod zrušení TIMED_OUT. Výchozí hodnota: 5 minut od vytvoření
Stav	refund.status	string	Aktuální stav ověření tohoto objektu.
Důvod zrušení	refund.cancel_reason	string	Důvod zrušené transakce.
Vytvořeno na adrese	refund.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	refund.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
ID aplikace	refund.app_id	string	ID aplikace, která vytvořila rezervaci.
Značka karty	refund.card.card_brand	string	Značka karty.
last_4	refund.card.last_4	string	Posledních 4 číslic čísla karty.
Exp Month	refund.card.exp_month	integer	Měsíc vypršení platnosti přidružené karty jako celé číslo mezi 1 a 12.
Exp Year	refund.card.exp_year	integer	Čtyřciferný rok data vypršení platnosti karty.
Otisk prstu	refund.card.fingerprint	string	Zamýšlený jako identifikátor přiřazený k čtverci na základě čísla karty k identifikaci karty na více místech v rámci jedné aplikace.
Typ karty	refund.card.card_type	string	Typ karty.
POPELNICE	refund.card.bin	string	Prvních šest číslic čísla karty, označované jako identifikační číslo banky (BIN).
ID objednávky	refund.order_id	string	ID objednávky.
ID místa	refund.location_id	string	Identifikátor umístění.

Zrušení rezervace terminálu

ID operace:

TerminalCancelCheckout

Zruší žádost o rezervaci terminálu, pokud ji stav žádosti povolí.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID rezervace	checkout_id	True	string	Identifikátor rezervace.

Návraty

Name	Cesta	Typ	Description
ID	checkout.id	string	Jedinečný identifikátor vystavený čtvercem.
Množství	checkout.amount_money.amount	integer	Částka.
Měna	checkout.amount_money.currency	string	Měna.
ID odkazu	checkout.reference_id	string	Volitelné uživatelem definované REFERENČNÍ ID.
ID zařízení	checkout.device_options.device_id	string	Jedinečné ID zařízení určeného pro tuto terminálovou kontrolu.
Povolit tipping	checkout.device_options.tip_settings.allow_tipping	boolean	Určuje, jestli je pro tuto rezervaci povolené provazování. Výchozí nastavení je „false“.
Přeskočit obrazovku potvrzení	checkout.device_options.skip_receipt_screen	boolean	Dá zařízení pokyn, aby přeskočí obrazovku potvrzení. Výchozí nastavení je „false“.
Stav	checkout.status	string	Aktuální stav ověření tohoto objektu.
Důvod zrušení	checkout.cancel_reason	string	Důvod zrušené transakce.
Vytvořeno na adrese	checkout.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	checkout.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
ID aplikace	checkout.app_id	string	ID aplikace, která vytvořila rezervaci.
Doba trvání konečného termínu	checkout.deadline_duration	string	Doba trvání RFC 3339, po které se rezervace automaticky zruší. TerminalCheckout, který je čeká na vyřízení je automaticky zrušen a má důvod zrušení TIMED_OUT. Výchozí hodnota: 5 minut od vytvoření

Získání faktury

ID operace:

InvoiceGet

Načte fakturu podle ID faktury.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID faktury	invoice_id	True	string	Identifikátor faktury.

Návraty

Name	Cesta	Typ	Description
ID	invoice.id	string	Jedinečný identifikátor vystavený čtvercem.
Version	invoice.version	integer	Aktuální verze tohoto objektu.
ID místa	invoice.location_id	string	Identifikátor umístění.
ID objednávky	invoice.order_id	string	ID objednávky.
Žádosti o platbu	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	ID vygenerované čtvercem.
Typ požadavku	invoice.payment_requests.request_type	string	Určuje typ žádosti o platbu. Tento typ definuje způsob určení částky žádosti o platbu.
Termín splnění	invoice.payment_requests.due_date	string	Termín splatnosti pro žádost o platbu ve formátu RRRR-MM-DD.
Povolené provazování	invoice.payment_requests.tipping_enabled	boolean	Pokud je nastavená hodnota true, poskytne zákazníkovi místo, kde může zaplatit tip.
Upomínky	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	ID přiřazené čtvercem.
Relativní naplánované dny	invoice.payment_requests.reminders.relative_scheduled_days	integer	Počet dní před odesláním připomenutí (záporné číslo) nebo po (kladném čísle) žádosti o platbu due_date.
Message	invoice.payment_requests.reminders.message	string	Zpráva.
Stav	invoice.payment_requests.reminders.status	string	Aktuální stav.
Množství	invoice.payment_requests.computed_amount_money.amount	integer	Částka.
Měna	invoice.payment_requests.computed_amount_money.currency	string	Měna.
Množství	invoice.payment_requests.total_completed_amount_money.amount	integer	Částka.
Měna	invoice.payment_requests.total_completed_amount_money.currency	string	Měna.
Automatický zdroj plateb	invoice.payment_requests.automatic_payment_source	string	Způsob platby pro automatickou platbu.
Číslo faktury	invoice.invoice_number	string	Uživatelsky přívětivé číslo faktury. Hodnota je jedinečná v rámci umístění. Pokud není k dispozici při vytváření faktury, square přiřadí hodnotu.
Title	invoice.title	string	Název.
Description	invoice.description	string	Popis.
Naplánováno na	invoice.scheduled_at	string	Časové razítko při naplánování zpracování ve formátu RFC 3339.
Stav	invoice.status	string	Aktuální stav ověření tohoto objektu.
Timezone	invoice.timezone	string	Časové pásmo sloužící k interpretaci kalendářních dat. Při vytvoření faktury je toto pole nastaveno na časové pásmo určené pro umístění prodejce. Hodnotu nelze změnit.
Vytvořeno na adrese	invoice.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	invoice.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
ID zákazníka	invoice.primary_recipient.customer_id	string	ID zákazníka přidruženého k objednávce.
křestní jméno	invoice.primary_recipient.given_name	string	Jméno příjemce (tj. jméno).
Příjmení	invoice.primary_recipient.family_name	string	Rodina příjemce (tj. příjmení).
E-mailová adresa	invoice.primary_recipient.email_address	string	E-mailová adresa příjemce.
Telefonní číslo	invoice.primary_recipient.phone_number	string	Telefonní číslo příjemce.
Card	invoice.accepted_payment_methods.card	boolean	Určuje, zda jsou přijímány platby kreditní kartou nebo debetní kartou.
Čtvercová dárková karta	invoice.accepted_payment_methods.square_gift_card	boolean	Určuje, jestli jsou přijímány platby za dárkové karty square.
Bankovní účet	invoice.accepted_payment_methods.bank_account	boolean	Určuje, zda jsou přijímány platby bankovním převodem.
Vlastní pole	invoice.custom_fields	array of object
Označení	invoice.custom_fields.label	string	Popisek nebo název vlastního pole
Hodnota	invoice.custom_fields.value	string	Text vlastního pole
Umístění	invoice.custom_fields.placement	string	Umístění vlastního pole na faktuře
Metoda doručení	invoice.delivery_method	string	Metoda doručení, kterou Square používá k odeslání faktury, připomenutí a účtenek zákazníkovi. Po publikování faktury square zpracuje fakturu na základě způsobu doručení a nastavení žádosti o platbu, a to buď okamžitě, nebo v scheduled_at datu, pokud je zadáno.
Datum prodeje nebo služby	invoice.sale_or_service_date	string	Datum prodeje nebo datum vykreslení služby ve formátu RRRR-MM-DD. Toto pole lze použít k zadání data v minulosti nebo budoucnosti, které se zobrazí na faktuře.

Získání platby

ID operace:

PaymentGet

Načte podrobnosti pro konkrétní platbu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID platby	payment_id	True	string	Identifikátor platby.

Návraty

Name	Cesta	Typ	Description
ID	payment.id	string	Jedinečný identifikátor vystavený čtvercem.
Vytvořeno na adrese	payment.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	payment.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
Množství	payment.amount_money.amount	integer	Částka.
Měna	payment.amount_money.currency	string	Měna.
Stav	payment.status	string	Aktuální stav ověření tohoto objektu.
Doba trvání zpoždění	payment.delay_duration	string	Doba trvání po vytvoření platby, kdy square automaticky použije delay_action na platbu. Tato automatická delay_action se vztahuje pouze na platby, které nedosahují stavu terminálu (COMPLETED, CANCELED nebo FAILED) před delay_duration časovým obdobím. Toto pole je určeno jako časová doba trvání ve formátu RFC 3339.
Typ zdroje	payment.source_type	string	Typ zdroje pro tuto platbu. Mezi aktuální hodnoty patří KARTA, BANK_ACCOUNT, PENĚŽENKA, HOTOVOST nebo EXTERNÍ.
Stav	payment.card_details.status	string	Aktuální stav.
Značka karty	payment.card_details.card.card_brand	string	Značka karty.
Posledních 4	payment.card_details.card.last_4	string	Posledních 4 číslic čísla karty.
Exp Month	payment.card_details.card.exp_month	integer	Měsíc vypršení platnosti přidružené karty jako celé číslo mezi 1 a 12.
Exp Year	payment.card_details.card.exp_year	integer	Čtyřciferný rok data vypršení platnosti karty.
Otisk prstu	payment.card_details.card.fingerprint	string	Zamýšlený jako identifikátor přiřazený k čtverci na základě čísla karty k identifikaci karty na více místech v rámci jedné aplikace.
Typ karty	payment.card_details.card.card_type	string	Typ karty.
Předplacený typ	payment.card_details.card.prepaid_type	string	Určuje, jestli je karta předplacená nebo ne.
POPELNICE	payment.card_details.card.bin	string	Prvních šest číslic čísla karty, označované jako identifikační číslo banky (BIN).
Entry – metoda	payment.card_details.entry_method	string	Metoda použitá k zadání údajů o platbě na kartě. Metoda může být KEYED, POTÁHNUTÍ PRSTEM, EMV, ON_FILE nebo BEZ KONTAKTU.
Stav CVV	payment.card_details.cvv_status	string	Stavový kód vrácený z kontroly ověřovací hodnoty karty (CVV). Kód může být CVV_ACCEPTED, CVV_REJECTED nebo CVV_NOT_CHECKED.
Stav AVS	payment.card_details.avs_status	string	Stavový kód vrácený z kontroly systému ověřování adres (AVS). Kód může být AVS_ACCEPTED, AVS_REJECTED nebo AVS_NOT_CHECKED.
Ověřovací kód výsledku	payment.card_details.auth_result_code	string	Stavový kód vrácený vystavitelem karty, který popisuje stav autorizace platby.
Popis příkazu	payment.card_details.statement_description	string	Popis příkazu odeslaný do sítí karet.
Autorizované na adrese	payment.card_details.card_payment_timeline.authorized_at	string	Časové razítko, kdy byla platba autorizována, ve formátu RFC 3339.
Zachyceno na	payment.card_details.card_payment_timeline.captured_at	string	Časové razítko, kdy byla platba zaznamenána, ve formátu RFC 3339.
ID místa	payment.location_id	string	Identifikátor umístění.
ID objednávky	payment.order_id	string	ID objednávky.
Poplatek za zpracování	payment.processing_fee	array of object
Efektivní na adrese	payment.processing_fee.effective_at	string	Časové razítko, kdy se poplatek projeví, ve formátu RFC 3339.
Typ	payment.processing_fee.type	string	Určuje typ.
Množství	payment.processing_fee.amount_money.amount	integer	Částka.
Měna	payment.processing_fee.amount_money.currency	string	Měna.
Poznámka:	payment.note	string	Vlastní poznámka přidružená k profilu zákazníka.
Množství	payment.total_money.amount	integer	Částka.
Měna	payment.total_money.currency	string	Měna.
Množství	payment.approved_money.amount	integer	Částka.
Měna	payment.approved_money.currency	string	Měna.
ID zaměstnance	payment.employee_id	string	ID zaměstnance vygenerované čtvercem.
Číslo potvrzení	payment.receipt_number	string	Číslo potvrzení platby. Pole chybí, pokud je platba zrušena.
Adresa URL potvrzení	payment.receipt_url	string	Adresa URL potvrzení platby. Pole se vyplní jenom pro dokončené platby.
Zpožďovací akce	payment.delay_action	string	Akce, která se má použít na platbu, když delay_duration uplynula.
Zpožděno do	payment.delayed_until	string	Časové razítko jen pro čtení, kdy se delay_action automaticky použije ve formátu RFC 3339.
ID člena týmu	payment.team_member_id	string	ID člena týmu.
Čtvercový součin	payment.application_details.square_product	string	Produkt čtverce, například nákupní bod prodeje (POS), čtvercové faktury nebo terminál čtvercového virtuálního terminálu.
Identifikátor aplikace	payment.application_details.application_id	string	ID čtverce jen pro čtení přiřazené aplikaci
Token verze	payment.version_token	string	Tento neprůhlený token identifikuje konkrétní verzi objektu.

Získání pokladny terminálu

ID operace:

TerminalGetCheckout

Načte žádost o rezervaci terminálu checkout_id.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID rezervace	checkout_id	True	string	Identifikátor rezervace.

Návraty

Name	Cesta	Typ	Description
ID	checkout.id	string	Jedinečný identifikátor vystavený čtvercem.
Množství	checkout.amount_money.amount	integer	Částka.
Měna	checkout.amount_money.currency	string	Měna.
ID odkazu	checkout.reference_id	string	Volitelné uživatelem definované REFERENČNÍ ID.
Poznámka:	checkout.note	string	Vlastní poznámka přidružená k profilu zákazníka.
ID zařízení	checkout.device_options.device_id	string	Jedinečné ID zařízení určeného pro tuto terminálovou kontrolu.
Povolit tipping	checkout.device_options.tip_settings.allow_tipping	boolean	Určuje, jestli je pro tuto rezervaci povolené provazování. Výchozí nastavení je „false“.
Přeskočit obrazovku potvrzení	checkout.device_options.skip_receipt_screen	boolean	Dá zařízení pokyn, aby přeskočí obrazovku potvrzení. Výchozí nastavení je „false“.
Stav	checkout.status	string	Aktuální stav ověření tohoto objektu.
Vytvořeno na adrese	checkout.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	checkout.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
ID aplikace	checkout.app_id	string	ID aplikace, která vytvořila rezervaci.
Doba trvání konečného termínu	checkout.deadline_duration	string	Doba trvání RFC 3339, po které se rezervace automaticky zruší. TerminalCheckout, který je čeká na vyřízení je automaticky zrušen a má důvod zrušení TIMED_OUT. Výchozí hodnota: 5 minut od vytvoření

Získání refundace plateb

ID operace:

RefundGet

Načte konkrétní refundaci pomocí refund_id.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID refundace	refund_id	True	string	Identifikátor refundace.

Návraty

Name	Cesta	Typ	Description
ID	refund.id	string	Jedinečný identifikátor vystavený čtvercem.
Stav	refund.status	string	Aktuální stav ověření tohoto objektu.
Množství	refund.amount_money.amount	integer	Částka.
Měna	refund.amount_money.currency	string	Měna.
ID platby	refund.payment_id	string	Jedinečné ID platby.
ID objednávky	refund.order_id	string	ID objednávky.
Vytvořeno na adrese	refund.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	refund.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
Poplatek za zpracování	refund.processing_fee	array of object
Efektivní na adrese	refund.processing_fee.effective_at	string	Časové razítko, kdy se poplatek projeví, ve formátu RFC 3339.
Typ	refund.processing_fee.type	string	Určuje typ.
Množství	refund.processing_fee.amount_money.amount	integer	Částka.
Měna	refund.processing_fee.amount_money.currency	string	Měna.
ID místa	refund.location_id	string	Identifikátor umístění.
Důvod	refund.reason	string	Důvod tohoto objektu.

Získání refundace terminálů

ID operace:

TerminalGetRefund

Načte objekt refundace terminálu Interac podle ID.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID refundace terminálu	terminal_refund_id	True	string	Identifikátor refundace terminálu.

Návraty

Name	Cesta	Typ	Description
ID	refund.id	string	Jedinečný identifikátor vystavený čtvercem.
ID refundace	refund.refund_id	string	Jedinečné ID pro tuto refundaci vygenerované čtvercem.
ID platby	refund.payment_id	string	Jedinečné ID platby.
Množství	refund.amount_money.amount	integer	Částka.
Měna	refund.amount_money.currency	string	Měna.
Důvod	refund.reason	string	Důvod tohoto objektu.
ID zařízení	refund.device_id	string	Jedinečné ID zařízení určeného pro tento TerminálRefund.
Doba trvání konečného termínu	refund.deadline_duration	string	Doba trvání RFC 3339, po které se rezervace automaticky zruší. TerminalCheckout, který je čeká na vyřízení je automaticky zrušen a má důvod zrušení TIMED_OUT. Výchozí hodnota: 5 minut od vytvoření
Stav	refund.status	string	Aktuální stav ověření tohoto objektu.
Vytvořeno na adrese	refund.created_at	string	Časové razítko určující čas vytvoření tohoto objektu ve formátu RFC 3339.
Aktualizováno na adrese	refund.updated_at	string	Časové razítko určující poslední čas aktualizace tohoto objektu ve formátu RFC 3339.
ID aplikace	refund.app_id	string	ID aplikace, která vytvořila rezervaci.
Značka karty	refund.card.card_brand	string	Značka karty.
last_4	refund.card.last_4	string	Posledních 4 číslic čísla karty.
Exp Month	refund.card.exp_month	integer	Měsíc vypršení platnosti přidružené karty jako celé číslo mezi 1 a 12.
Exp Year	refund.card.exp_year	integer	Čtyřciferný rok data vypršení platnosti karty.
Otisk prstu	refund.card.fingerprint	string	Zamýšlený jako identifikátor přiřazený k čtverci na základě čísla karty k identifikaci karty na více místech v rámci jedné aplikace.
Typ karty	refund.card.card_type	string	Typ karty.
POPELNICE	refund.card.bin	string	Prvních šest číslic čísla karty, označované jako identifikační číslo banky (BIN).
ID objednávky	refund.order_id	string	ID objednávky.
ID místa	refund.location_id	string	Identifikátor umístění.

Definice

objekt

Toto je typ "object".