Pro vývojáře

Účtujte rezervace z jiné pokladny

Nechte externí pokladnu přečíst, kolik rezervace stojí, a poslat prodej zpátky, aby se rezervace dokončila.

Co to je

Předání účtování je jedna adresa se dvěma voláními: GET a POST /api/v1/{slug}/appointments/{id}/checkout. GET vrátí, kolik rezervace stojí: každou službu a doplněk s jeho lineId a tím, kdo ho dělal, cenu, slevy, daňové řádky, už zaplacenou zálohu a dueCents, což je přesně částka, kterou máte vybrat. POST zaznamená prodej, který vaše pokladna přijala, dokončí rezervaci a propojí s ní prodej, a používá přitom stejný kód účtování jako vlastní pokladna Bookatu.

Proč se to hodí

Nikdo nemarkuje návštěvu dvakrát a rezervace, prodej, připsání personálu i peníze v Bookatu sedí, jako by prodej přijala jeho vlastní pokladna. Odeslání je idempotentní podle vašeho externalSaleId, takže opakovaný pokus po přerušeném spojení vrátí replayed: true a nic nezapíše.

Jak to používat

  1. 1Klíč vytvoří majitelé a administrátoři v Settings, pak API & monitoring, v části API keys. Ve What this key may do zaškrtněte na řádku Checkout at another point of sale obě políčka: See what a booking comes to at checkout (checkout:read) a Check bookings out from another point of sale (checkout:write). Zapínají se jen výslovně a klíč vytvořený před zavedením oprávnění je nikdy nemá. Kdo klíč vytváří, musí vidět kalendáře všech (kvůli checkout:read) a upravovat kalendář (kvůli checkout:write). Přidejte See bookings (bookings:read), chcete-li vypsat rezervace dne přes GET /appointments, a See clients (customers:read), pokud vaše pokladna potřebuje jméno, e-mail a telefon klienta. Bez něj přijde klient jen jako id.
  2. 2Posílejte klíč jako Authorization: Bearer v každém volání. Zavolejte GET /api/v1/{slug}/appointments/{id}/checkout a namarkujte jeho řádky. checkout.allowed říká, jestli jde rezervaci teď naúčtovat, a checkout.blocked uvádí důvod: not_live, deposit_pending, already_checked_out nebo invoiced. invoiced znamená, že rezervace je na faktuře a platí se tam, takže za ni na své pokladně peníze nepřijímejte.
  3. 3Přijměte peníze a pak pošlete POST na stejnou adresu s { externalSaleId, source, amountCents, currency, tender, tipCents, tipSplit, lines }. externalSaleId je vlastní id prodeje vaší pokladny. source pojmenovává vaši pokladnu, například front_desk_pos (výchozí je external a nikdy nesmí být bookatu). amountCents se musí rovnat dueCents. currency je nepovinné, ale musí to být měna podniku. tender je card, cash nebo other. lines ve tvaru [{ lineId, staffId }] připíše řádek někomu jinému.
  4. 4Odeslání stejného externalSaleId ze stejné pokladny znovu vrátí původní prodej s replayed: true. Odmítnutí nic nezapíšou a uvedou důvod: 400 card_number (externalSaleId nebo source vypadá jako číslo karty, a to se nikdy nepřijme); 409 amount_mismatch (s expectedCents), already_checked_out, external_sale_used, lines_changed (přečtěte účtování znovu), not_live, deposit_pending nebo invoiced (rezervace se platí na faktuře); 422 currency nebo tip_split; 503, dokud se předání pro podnik ještě zapíná.
  5. 5Chcete-li vědět o každém účtování, přidejte webhook v kartě Webhooks na stejné stránce a zaškrtněte booking.checked_out v Only if you tick it. Nikdy se neposílá na endpoint, který přijímá všechny události. Spouští se i při účtování na vlastní pokladně Bookatu (sale.source bookatu), se stejnými daty jako GET a s klientem jen jako id.
  6. 6Kompletní reference se všemi poli a příklady je v dokumentaci pro vývojáře na /developers#checkout-handoff a jako markdown na /developers.md.

Was this helpful?

Nenašli jste, co potřebujete?

Kontaktovat podporu nebo si projděte časté otázky.