Glossary
The words people see in the Clipp supplier app, what they mean, and what they're called inside the code. Use the app's word in docs, support replies and specs. The internal name is for engineers and agents, and for searching the code.
The app's words come from the supplier app's English text. Where the same thing has more than one name in the app, the inconsistent words section lists them.
People and businesses
| App word | Meaning | Internal name |
|---|---|---|
| Supplier | The distributor using the supplier app. Sells to restaurants | BusinessTypeEnum.SUPPLIER, Business |
| Customer / Restaurant | A business that buys from the supplier. "Customer" in lists, "Restaurant" in invites and channels | BusinessTypeEnum.RESTAURANT; the consumer on a BusinessLink |
| Vendor | A business the supplier buys from | BusinessTypeEnum.VENDOR; BusinessLink with the supplier as consumer |
| Connected Customer | The customer has accepted | BusinessLink |
| Invited Customer, Pending Invitation | An invitation is waiting | RestaurantInvitation (PENDING), requiresAcceptance for an existing restaurant |
| Send Connection Request | Ask an existing restaurant to connect | createAndInviteRestaurant with existingRestaurantID |
| Recently Connected | Connected in the last 30 days, no accepted app order yet | BusinessLink.recentlyConnected (computed) |
| Inactive Customers, Mark as Inactive | Customers the supplier has hidden | BusinessLink.isArchived |
| Customer Ref ID, Vendor Ref ID | The supplier's own code for a customer or vendor. "Account #" on the detailed packing slip | customerReferenceID, vendorReferenceID |
| Preset Notes | Notes added automatically to a customer's new orders | customerPresetNotes |
| Outlets | A business's locations | Business.parent / children |
| Primary contact, Mark as Primary (Business) | The main person to contact at a customer, private to the supplier | BusinessLink.primaryContact, markAsPrimary |
| Contact Information (additional contacts) | Up to 5 more contacts, private to the supplier | BusinessLink.additionalContacts |
| Edit Customer Form | Edits a customer's name, EIN, addresses and Customer Ref ID | updateRestaurantInfo |
| Customer info (supplier's view) | The supplier's view of a customer's details. See Customer info | "dual-data" in specs and code comments |
| (customer snapshot) | The customer's details frozen on an order. See Order snapshot | SaleOrder.customerSnapshot |
Orders
| App word | Meaning | Internal name |
|---|---|---|
| Order, Sales Orders | One supplier's order from one customer | SaleOrder ("sale order") |
| (cart sent to several suppliers) | One restaurant checkout covering several suppliers | RestaurantOrder with one SaleOrder per supplier |
| Order ID, Order, Invoice #, Invoice ID | The order number, also the invoice number. See Order & reference numbers | orderNumber |
| Reference Number, Ref. No | A number the supplier types to tie an order to other paperwork | referenceNumber |
| Saved Orders / Submitted Orders | A cart not yet sent / sent | SAVED status; isSubmitted |
| Est. Delivery, Estimated Delivery Date | The supplier's own planned delivery day | estimatedDeliveryDate |
| Invoice Date | The billing day. See Dates & time zones | invoiceDate (LocalDate, YYYY-MM-DD), isInvoiceDateExplicit |
| "Order has items that cannot be fulfilled" | An item is out of stock, paused or gone | isUnfulfillable |
Order statuses
| App label | Meaning | Internal (SaleOrderFulfillmentStatus) |
|---|---|---|
| (cart) | A restaurant's saved cart, not yet sent | SAVED |
| Pending | Placed, not yet confirmed | PLACED |
| Packing | Confirmed and being packed. Stock leaves the shelf | CONFIRMED |
| Ready for Delivery | Packed and invoiced | READY_FOR_DELIVERY |
| Delivered | Delivered | DELIVERED |
| Canceled | Won't be fulfilled | CANCELED + a SaleOrderCancellation |
| Items Returned, Refunded | Display-only labels, not statuses |
How an order came in
| App label (invoice list) | Sales report label | Meaning | Internal (SaleOrderChannel) |
|---|---|---|---|
| Restaurant | Restaurant | The restaurant ordered in the mobile app | RESTAURANT_APP |
| Restaurant | Restaurant Web | The restaurant ordered in a browser, such as the QR page | RESTAURANT_WEB |
| Supplier | Supplier | The supplier entered it | SUPPLIER_WEB |
| AI Voice Agent | AI Voice Agent | Taken by the AI phone agent | AI_VOICE_AGENT |
| Manual Input by Clipp | Manual Input by Clipp | An older or balance-forward invoice Clipp imported | IMPORTED |
| Legacy | Other | No channel recorded | OTHER |
Money, invoices and payments
| App word | Meaning | Internal name |
|---|---|---|
| Invoice | The bill for one order, from Ready for Delivery on | SaleOrder + invoice snapshot (INVOICE_SNAPSHOT effect) |
| Pending Order, Packing Slip | The same PDF before invoicing (Pending / Packing) | PDF title by status |
| Subtotal, Subtotal After Return | Sum of the rounded lines, less returns. See Money & rounding | totals.gross |
| Balance Due, Outstanding Balance | What's still owed on this invoice / across the customer | payment.balanceDue (net − paid, never below 0); pendingBalance across a customer |
| Unit price | Price per unit or per weight unit, up to 4 decimals | unitPrice (UNIT_PRICE_DECIMALS) |
| Statement, Create Statement | A list of a customer's open invoices | InvoiceStatement; statementNumber |
| Return, Start Return, Reshelf, Discard | Goods handed back; back into stock or thrown away | returns, additionalReturns, SaleOrderInventoryAction |
| Cancel Order, Cancelation Reasons | Cancel with reasons and a note | SaleOrderCancellation, cancellationReasons |
| One Time Discount | A manual discount, percent or flat | Adjustment MANUAL / DISCOUNT |
| Fees & Charges, One Time Fee, Delivery fee | An extra charge | Adjustment FEE / CHARGE; defaultDeliveryFee |
| Opening Balance | A balance carried over from before Clipp | Adjustment OPENING_BALANCE |
| Store Credit(s), Issue Store Credit, Credit Issued | Credit a customer can spend on later invoices | StoreCredit; payment mode STORE_CREDIT; type STORE_CREDIT_ISSUED |
| Promotions | Supplier-run discounts | Promotion: percentageOff ("Percentage Off Entire Order"), firstOrderPercentageOff ("First Time Buyer Discount (Percentage)") |
| Loyalty Tier, Loyalty Discount | A per-customer percentage discount | LoyaltyPlan, BusinessLink.loyaltyTier, adjustment LOYALTY |
| Clipp Promotion, Clipp Promo Applied | A Clipp-funded coupon; the supplier is paid in full | Campaign, CampaignCoupon, adjustment CAMPAIGN_COUPON; payment mode PLATFORM_PAYOUT |
| Processing Fee | The card fee (2.9% + 30¢) | PROCESSING_FEE, surchargeAmountPaidByCustomer |
| Card on file, Request card on file | A saved card the supplier can charge | card-on-file module, CardSetupRequest, ChargeAttempt |
| Overdue | Unpaid after the due date. See Dates & time zones | Computed: isOverdue, overdueClauses |
| Set Due Reminder | Automatic payment reminder before/on/after the due date | paymentReminders setting |
| Notify to Pay | Send overdue reminders by hand | notifySaleOrderToPay |
Payment terms
| App label | Internal |
|---|---|
| COD | DueDateTypeEnum.COD |
| Net 7 Days, Net 15 Days, Net 30 Days, Net 45 Days, Net 60 Days, Net 90 Days | DAYS_7, DAYS_15, DAYS_30, DAYS_45, DAYS_60, DAYS_90 |
The customer's default is customerPaymentTerms, a vendor's vendorPaymentTerms. Each order keeps its own dueDateType.
Invoice payment status
| App label | Meaning | Internal (SaleOrderPaymentStatus) |
|---|---|---|
| Unpaid | Nothing paid yet | UNPAID |
| Partially paid | Some paid | PARTIAL |
| Processing | A bank (ACH) payment hasn't cleared | PROCESSING |
| Paid | Paid in full. Overpayment becomes store credit | PAID |
| Void | Nothing owed, nothing paid (e.g. fully returned before payment) | VOID |
| Canceled | The order was canceled (shown from the order status) |
How a payment was made
| App label | Internal (PaymentModeEnum) |
|---|---|
| Cash | CASH |
| Check | CHEQUE (spelled CHECK in the accepted-methods setting) |
| Online (card) | ONLINE |
| ACH | ACH |
| Other ACH | OTHER_ACH |
| Other Credit Card | OTHER_CREDIT_CARD |
| Store Credit(s) | STORE_CREDIT |
| Clipp Promo Applied / Platform Payout | PLATFORM_PAYOUT |
| Other | OTHER |
A single payment record's status shows as Pending, Processing, Complete (PAID), Partial or Failed.
Catalog and products
| App word | Meaning | Internal name |
|---|---|---|
| Product | A sellable item | Product; status PUBLISHED / UNPUBLISHED, isHidden, isArchived |
| Primary Unit, Size/Unit | The unit a product is sold and counted in (CS, EA). Free text | Product.size; suggestions from Business.productSizes |
| Catch Weight Item | Priced by actual weight. See Catch-weight | isCatchWeight |
| Secondary Unit | The weight unit a catch-weight price is per (LB, KG). Free text | secondaryUnit |
| Standard weight | Expected weight per box | standardWeight |
| On hand total weight | Catch-weight stock by weight | weightOnHand |
| (line weight, per-box weights) | The weighed amount on an order line | catchWeight.weight, catchWeight.perBoxWeights, pricingQuantity |
| Default Catalog, custom catalogs | All products at base price / a chosen set and prices for assigned customers | Catalog, BusinessLink.catalog |
| Markup, Discount, Fixed Price | Price changes inside a catalog | CatalogPriceAdjustmentType |
| Base Price, Final Price | Before and after the catalog change | |
| Stock In, Stock Out | Inventory movements | Stock, StockTypeEnum IN / OUT |
Purchasing
| App word | Meaning | Internal name |
|---|---|---|
| Purchase Order (PO) | The supplier buying from a vendor | PurchaseOrder; statuses Pending (PLACED), Delivered, Canceled |
| PO Invoice(s) | A delivered or canceled PO seen as a bill to pay | /poinvoices |
| Revert Order | Move a delivered PO back to Pending | |
| Accounts Payable | What the supplier owes vendors, by age | reports module |
Finance
| App word | Meaning | Internal name |
|---|---|---|
| Bookkeeping | The ledger of income, expenses and transfers | RBAC resource accounting; transactions module |
| Income, Expense, Transfer In, Transfer Out | Ledger row types | TransactionType |
| Categories | Labels for income and expense rows | AccountingCategory |
| Accounts (Cash, Bank, Other) | Where money is held | FinancialAccount |
| Accounts Receivable (Current, 1-30, 31-60, 61-90, 90+) | Unpaid customer invoices, by days past due | AgingBuckets |
| Sales Summary | Sales report | RBAC resource salesReport |
Team roles
| App label | Internal key | Default customer access |
|---|---|---|
| Admin | ADMIN (an isAdmin flag, not a stored role) | Full |
| Clerk | CLERK | Full |
| Sales Person | SALES_PERSON | Read only |
| Warehouse | WAREHOUSE | Read only |
| Driver | DRIVER | Read only |
| Custom roles | any name | as set |
Access levels: Full Access (fullAccess), Read Only (readOnlyAccess), No Access (noAccess).
Messages
| App word | Meaning | Internal name |
|---|---|---|
| Notifications (Profile Settings tab) | Reminder settings | SupplierSettings.paymentReminders |
| Email, SMS (text), push | Delivery channels | NotificationChannel EMAIL / SMS / PUSH |
| Notify customer about this update | Per-action switch to message the restaurant | notifyCustomer |
| (mute) | Clipp can silence a supplier's email, text or push. Not in the app | SupplierSettings.notifications |
Inconsistent words
The same thing under different names in the app today. Prefer the first word in docs.
| Thing | Words used |
|---|---|
| Order channel "browser order" | "Restaurant Web" (sales report) · "Restaurant" (invoice list) |
| No channel | "Other" (sales report) · "Legacy" (invoice list) |
| App / supplier orders in exports | "Restaurant" / "Supplier" on screen · "Restaurant App" / "Supplier Web" in the sales report export |
| Clipp promotion payment | "Clipp Promo Applied" · "Platform Payout" |
| Store credit payment | "Store Credits" · "Store Credit" · "Buyer Credit" · "Credit Issued" · "Store Credit Issued" |
| "Pending" | An unconfirmed order · a PO not yet delivered · an ACH payment record. Unpaid invoices say "Unpaid" |
| "Paid" | "Paid" on invoices · "Complete" on payment records |
| Ready for Delivery | "Ready for Delivery" (button and status) · "marking out for delivery" in the catch-weight error |
| Cancel | "Canceled" · "Cancelled" · "Cancelation" · "Cancellation" |
| Bank payment | "ACH" · "Bank Account (ACH)" · "ACH Bank Transfer" · "Bank Account" |
| Unit | "Size/Unit" · "SIZE/UNIT" · "Primary Unit" · "Size" · "Unit" |
| Salesperson | "Sales Rep" · "Salesperson" · "Sales Person" (role) |
| Team | "Team" (menu) · "Staff" · "Team Member" · "Employee" |
| Bookkeeping | "Bookkeeping" (menu) · "Accounting" |
| Sales report | "Sales Summary" (menu) · "Sales Report" |
| Customer | "Customer" · "Restaurant" · "client" · "Buyer" |
| Hidden | "Inactive" (customers) · "Archived" (products, accounts) |
| Loyalty | "Loyalty Tier" · "loyalty plan" |
| Reference | "Reference Number" · "Ref. No" · "Ref ID" · "Reference #" (restaurant app) |
| Balance | "Balance Due" · "Outstanding Balance" · "Balance Outstanding" · "Amount Due" |