Skip to content

REST API v1 · Resource

Your invoices and bookings

Your own invoices, quotations and bookings: make, issue, send, record payments, reschedule and cancel.

API reference · Your invoices and bookings

Endpoints

Paths are relative to https://fliok.com/api/v1. Each endpoint names the scope and the lowest key role it needs; a key without them gets 403 (see Authentication).

Your invoices and bookings

32
  • GET/sales-invoicesFind an invoice or proforma your business issued, by its printed number (?number=). Admin keys. Returns the same object the invoice.* events carryScope biz:read · admin role or higher
  • GET/bookings/{id}One booking as it stands now, by the id the booking.* events carryScope biz:read · viewer role or higher
  • POST/sales-invoicesSave a draft invoice, proforma or quotation, or issue (and send) it in one step. The monthly document limit answers 402 as in the dashboard. Idempotency-Key supportedScope biz:write · admin role or higher
  • GET/sales-invoices/{id}One document by id, drafts included: its status, totals, received and balance, the payments recorded on it, plus the invoice.* event object once issuedScope biz:read · admin role or higher
  • POST/sales-invoices/{id}/issueGive a draft its number and, with send, send it to the customer (optionally marked paid)Scope biz:write · admin role or higher
  • POST/sales-invoices/{id}/sendSend an issued document to the customer again on WhatsApp and/or by emailScope biz:write · admin role or higher
  • POST/sales-invoices/{id}/paymentsRecord money received: the receipt, the balance and the lead’s timeline, and with send the receipt to the customer. Idempotency-Key supportedScope biz:write · admin role or higher
  • POST/sales-invoices/{id}/cancelCancel an issued document with a reason. Its number stays in your records; nothing is sentScope biz:write · admin role or higher
  • GET/bookingsOne page of bookings: upcoming, past, cancelled or all, by day range, service, status, person or searchScope biz:read · viewer role or higher
  • POST/bookingsMake a booking for a contact or a typed-in customer, with the same availability, advance and monthly-limit rules as the dashboard. Idempotency-Key supportedScope biz:write · agent role or higher
  • POST/bookings/{id}/rescheduleMove a booking to a new time (or service, or person); the customer is toldScope biz:write · agent role or higher
  • POST/bookings/{id}/cancelCancel a booking, with an optional reason; the customer is told while it is still aheadScope biz:write · agent role or higher
  • PATCH/sales-invoices/{id}Replace a draft’s content with the whole document, as POST /sales-invoices takes it. Drafts only: an issued document answers 409 not_a_draftScope biz:write · admin role or higher
  • DELETE/sales-invoices/{id}Delete a draft (audit-logged). An issued document answers 409 not_a_draft: cancel it instead, its number staysScope biz:write · admin role or higher
  • POST/sales-invoices/{id}/convertMake an issued proforma into an invoice ({ send }), money received carried over. Same plan and module checks as the dashboard. Idempotency-Key supportedScope biz:write · admin role or higher
  • POST/sales-invoices/{id}/billRaise the invoice or proforma for one part of an accepted quotation ({ position, as, send }), once per part. Recording the acceptance stays a person’s, in Fliok or on the quotation’s page. Idempotency-Key supportedScope biz:write · admin role or higher
  • POST/sales-invoices/{id}/payments/{paymentId}/voidVoid a recorded payment with a reason: it stops counting, the receipt keeps its number and is marked Void. Nothing is sent; audit-loggedScope biz:write · admin role or higher
  • GET/sales-invoices/settingsInvoices’ settings as its panel shows them: sending number, channels, prefixes and next numbers, defaults, auto-send, reminders, email wording, quotation rules, template states. No bank detail or keyScope biz:read · admin role or higher
  • PATCH/sales-invoices/settingsChange Invoices’ settings ({ phoneNumberId, whatsappEnabled, emailEnabled, module }), strictly checked; switching a channel off works on any plan. Switching the module on or off stays in FliokScope biz:write · admin role or higher
  • POST/bookings/{id}/completeMark a booking completed (a review request follows when switched on). Never plan-gatedScope biz:write · agent role or higher
  • POST/bookings/{id}/no-showMark a booking a no-show once its time has come; an advance is kept or refunded by the module’s rules. Never plan-gatedScope biz:write · agent role or higher
  • POST/bookings/{id}/restoreBring a cancelled booking back, or put a completed or no-show one back to confirmed — if its time is still free; the customer is told. Idempotency-Key supportedScope biz:write · agent role or higher
  • GET/bookings/servicesThe booking page’s services in order: length, price, place, on or off, and the advance one booking would askScope biz:read · viewer role or higher
  • POST/bookings/servicesAdd a service, with the dashboard’s checks and plan. Idempotency-Key supportedScope biz:write · admin role or higher
  • PATCH/bookings/services/{id}Change a service — only what is sent. Bookings already made keep what they were booked forScope biz:write · admin role or higher
  • DELETE/bookings/services/{id}Stop offering a service (any plan). Bookings keep what they were booked forScope biz:write · admin role or higher
  • GET/bookings/staffThe people (and rooms, chairs, courts) who take bookings: hours, leave, services, on or off, and bookings that need movingScope biz:read · viewer role or higher
  • POST/bookings/staffAdd a person who takes bookings — name, kind, linked member, hours, services. Idempotency-Key supportedScope biz:write · admin role or higher
  • PATCH/bookings/staff/{id}Change a person — only what is sent. Switched off with bookings to come, those are listed to move; nothing is cancelledScope biz:write · admin role or higher
  • DELETE/bookings/staff/{id}Remove a person (any plan); refused with the list (409 has_bookings) while they still have bookings to comeScope biz:write · admin role or higher
  • GET/bookings/settingsBookings’ settings as its panel shows them: page address, time zone, hours, notice, reminders, email wording, the advance, services, template states, the month against the planScope biz:read · viewer role or higher
  • PATCH/bookings/settingsChange Bookings’ settings ({ phoneNumberId, whatsappEnabled, emailEnabled, module }), strictly checked; switching a channel off works on any plan. Switching the module on or off stays in FliokScope biz:write · admin role or higher

Rate limits

These endpoints have no row of their own in the rate-limit table.

Every limit, the RateLimit-* headers and what to do on a 429: Rate limits.