Reading your records
96 operations.
Looking up and listing the records of your organization.
Operations
| Operation | Kind | What it does |
|---|---|---|
| abcClasses | query | ABC inventory classification — ranks what you sell into A/B/C classes by value and how fast it moves. “A” items are your most valuable, fastest movers; “C” items the slowest. |
| affiliateEntryList | query | The ledger of what an affiliate has earned, entry by entry. |
| affiliatePayoutReport | query | The payout report for affiliates — what you owe each partner for the period. |
| agentChannelCatalogLookup | query | Resolve product, variant, SKU or barcode identifiers to the listed products an agent would see. |
| agentChannelCatalogProduct | query | One listed product as an agent sees it in full — its variants narrowed by chosen options, each option value marked available or not. |
| agentChannelCatalogSearch | query | What AI shopping agents can see and buy from this channel right now — the listed products searched by words and filters, priced at the selling location, with in-stock words. |
| agentChannelCheckout | query | Read one agent checkout as the platform sees it — the lines, the quote, the delivery options, the status and its messages. |
| agentChannelOrder | query | Read a completed agent checkout’s order as the platform sees it — what was bought, how it ships, what has happened since. |
| allocationSuggestions | query | Suggestions for pushing genuine excess stock from a hub out to your stores, shared fairly by each store’s weight. |
| arAging | query | The aging report — who owes what, and for how long (30/60/90 buckets). |
| arLedger | query | A customer’s house-account ledger — every charge and payment, in order. |
| assistantAsk | query | Ask the page assistant a question about using Almond Till — it knows which page you are on and answers with the same words the Guide shows. |
| binStock | query | What is sitting in one bin. |
| cancelExportJob | mutation | Stop one of your own background exports — it ends as cancelled and no file is produced. |
| cancelSearchJob | mutation | Stop one of your own background searches — it ends as cancelled and keeps the matches found so far. |
| cannedCharacteristics | query | The canned characteristic list — each entry is a platform-preset product characteristic you can copy into your group. |
| cannedConsentPurposes | query | The canned consent purpose list — each entry is a platform-preset consent purpose you can copy into your group. |
| cannedFiscalRegimes | query | The fiscal regimes we support, per market — each key names a country scheme (sign-and-journal, or authority-cleared before issuing); receipts only accept listed keys. Markets with no scheme (like the US) simply never issue one. |
| cannedPeripheralModels | query | The platform’s supported-hardware presets — the printers, scanners, and card readers Almond Till knows how to drive. A device peripheral names one of these. |
| cannedRoles | query | The canned role list — each entry is a platform-preset role template you can copy into your group. |
| cannedStorefrontThemes | query | The canned storefront themes to pick from — each key names a ready-made look; storefronts only accept listed keys. |
| cannedUoms | query | The platform’s preset units of measure (each, pair, kilogram…) — copy or reference them instead of redefining the basics. |
| caseMessages | query | One case’s message thread — staff replies, internal notes, and the customer’s messages. |
| casesByConsumer | query | All the service cases one customer has had — their support history. |
| categoryChildren | query | One category’s direct children — browse your merchandise tree level by level. |
| collectionProducts | query | What a collection actually contains right now — the evaluated product list (pins plus rule matches). |
| commissionEntryList | query | The commission ledger — what staff earned, entry by entry. |
| commissionPayoutReport | query | The commission payout report — what you owe each seller for the period. |
| consultationTurns | query | One page of a consultation's transcript, oldest first. |
| couponBatchCodes | query | One batch’s unique codes with their redemption status — the list you export for a campaign. |
| dashboardMetrics | query | One dashboard’s widgets answered with live figures — counts and per-currency totals computed at read time, each stamped with when it was read. |
| draftReport | query | Describe the report you want in plain words and get a report definition back — which records, and what to say about them (the columns to list, or the groups and totals) — shown in words before anything runs. |
| draftSearchPlan | query | Describe what you are looking for in plain words and get a search plan back — the start, the relationships to follow, the conditions on each step — shown in words before anything runs. |
| drawerLedger | query | The drawer’s cash movements for one till session — every entry, in order. |
| effectivePermissions | query | This page — the full picture of what a user may and may not do at an organization. |
| expectedReceipts | query | What is expected to arrive — open purchase-order lines by item and date. |
| explainWizardStep | query | Ask AI to explain where you are on this wizard page — what is happening, what you have provided, and what is still needed and why. |
| exportJobDownload | query | Get a short-lived link to download the file a finished export wrote — its name, size, row count and format come with it. |
| fillDraft | query | Look up one of your own wizard drafts — its status, the sheet page by page once it is ready, the questions the assistant asked, and why it stopped if it failed. |
| fillDraftTurns | query | The conversation on one of your own wizard drafts, oldest first — what you said and what the assistant answered — one page at a time. |
| fillDrafts | query | Your own wizard drafts, newest first — being made, ready, or failed — one page at a time. |
| fiscalReceipt | query | Look up one fiscal receipt — the legal tax artifact of a sale: its sequential fiscal number, signature or authorization code, and the QR the printed receipt shows. |
| fiscalReceipts | query | List your fiscal receipts, newest first — the gap-free compliance journal; receipts are permanent and never edited or removed. |
| interpretFilter | query | Turn a written request — “issued orders from Acme since June” — into filter conditions you can review and apply. |
| inventoryOnOrderAudit | query | Check the on-order figures — each stock item’s stored on order against what your open purchase orders actually add up to, one page of items at a time. |
| loyaltyLedger | query | A loyalty member’s points history — every earn, redemption, and adjustment. |
| myOrganizationGroup | query | Your own organization group — the tenant root: its name, code, classification, status, and owners. |
| notes | query | The notes attached to one record. |
| orderTenders | query | The payments applied to one order — the tender-by-tender money story. |
| orgBus | query | What’s happening across your whole organization — every create, edit, and status change on every record, newest first, over roughly the last three months. |
| orgLayout | query | Your organization’s operational map in one call — every physical facility (with its location site), the logical facilities inside each, and the registers inside those. |
| organization | query | Look up one record — an organization — one store or business unit in your group. |
| organizations | query | The organization list — each entry is an organization — one store or business unit in your group. |
| purchaseOrderLines | query | The lines on one purchase order — what you ordered, where each lot is going, and how much of it has landed. |
| rebalanceSuggestions | query | Stock-balancing suggestions between your locations — pull stock to where it sells. |
| receiptLines | query | The lines on one goods receipt — which purchase-order lines arrived, how many of each, and where they landed. |
| registriesByConsumer | query | All of one customer’s registries. |
| registryFulfillments | query | Who bought what against one registry — the fulfilment audit. |
| registryItems | query | The items on one gift registry. |
| relationshipCounts | query | How many records point at this one, per family — the folder counts on a record’s Explore page. |
| replenishmentParameters | query | The reorder maths per item — min/max, lead times, safety stock — that replenishment suggestions use. |
| replenishmentSuggestions | query | What to reorder — suggested purchase quantities from your sales pace and stock levels. |
| reportRun | query | Run a report — group and total the last step’s records (count, sums, smallest, largest, average per currency) or list chosen columns of them, newest first. |
| resolveFxRate | query | What exchange rate applies right now for a foreign currency at your organization. |
| resolveIdentifier | query | Scan lookup — which variant does this barcode belong to? |
| resolveStoredValueInstrument | query | Look up a gift card or store credit by its number — balance and state, the till’s check before redeeming. |
| resolveTaxJurisdictionByPostal | query | Find the tax jurisdiction that applies at a postal code — type a ZIP, get the place. |
| reviewRecord | query | Ask AI to review this record for issues — incomplete, inconsistent, or suspicious-looking values. |
| revisions | query | A record’s full change history — every saved version, what changed, when, and why, with the stated reason kept word for word. |
| rolePermissions | query | The full picture of what ONE role may and may not do at an organization — before anyone holds it (the guide’s “show this guide for a different role”). |
| schedulableResourceAvailability | query | One resource’s availability facts over a window (at most 31 days) — its advisory hours, capacity and the reserved bookings; compose free slots from them. |
| search | query | Name search across your records — type-ahead by caption within your own group. |
| searchAll | query | One search over every kind of record you may read — a word, a code or an id finds products, vendors, contacts and more, grouped by kind. |
| searchJobMatches | query | Read the matches a background search found — the last step’s records newest first, the whole match count, how many records were examined, and whether the set is partial or has expired. |
| searchPlanRun | query | Run a search plan — start at one kind of record, follow its links to related records step by step, and read the last step’s matches newest first. |
| segmentMembers | query | One segment’s member list, in shopper-id order. |
| sizeRunFill | query | Spread a total over a size run’s ratio — whole units, the remainder to the largest shares, ties to the earlier size. |
| startExportJob | mutation | Export records to a file in the background — start at one kind of record, follow its links step by step, and let the platform write every matching record as CSV or JSON Lines while you carry on; download the file when it is done. |
| startSearchJob | mutation | Start a search plan in the background — start at one kind of record, follow its links step by step, and let the platform dig while you carry on; read the matches when it is done. |
| stockCard | query | One item’s full stock story at a location — every movement, in order. |
| stockRecords | query | The stock balances — what you own, where, in which bucket. |
| storedValueLedger | query | A gift card / store credit’s full money story — every load and redemption. |
| styleStockMatrix | query | The cells of one style at one location — on hand, reserved, available and on order per variant, the axes in scheme and size order. |
| suggestCaption | query | Suggest a cleaned-up version of a record name you are typing — casing, spacing, and obvious typos fixed. |
| suggestCode | query | Suggest a code for a record, built from its name — and free to take where codes must be unique. |
| suggestFormFill | query | Ask AI to draft values for the empty inputs on this wizard page, predicted from what you already answered. |
| suggestNote | query | Ask AI to draft one internal note — from the thread so far, or by cleaning up words you already wrote. |
| suggestReason | query | Draft a short reason for the change you are about to save — composed from what actually changed. |
| summarizeThread | query | Ask AI for a short synopsis of this record’s note thread — what it is about, what was decided, what still hangs. |
| tasksByConstruct | query | The tasks attached to one record — “what’s to do about this?”. |
| taxJurisdictionChildren | query | One tax jurisdiction’s direct children — drill a country into its states, a state into its counties. |
| taxJurisdictionCountries | query | The countries with a live tax-jurisdiction tree — what the tax page’s country picker offers. |
| teamTasks | query | One team’s task inbox — the to-dos assigned to that team. |
| transferLaneRanking | query | Which transfer lanes (location pairs) serve a move best, ranked. |
| variantIdentifiers | query | The identifiers (barcodes/SKUs) assigned to one variant. |
| verifyInventoryItem | query | Reconcile one item’s ledger against its cached balances — “do the books add up?”. |