Ledger and billing-related data (scope of coverage)
Explains the scope of the ledger and billing-related data ReceiptRoller handles, tax reports, qualified-invoice support, and guidance for integrating with accounting software.
Setting the redirect URL
Explains the role of the redirect URI (callback URL) you set in the ReceiptRoller developer portal, the registration rules, using development vs. production environments, and common errors and how to handle them.
CrmCustomerDto reference
A complete field reference for CrmCustomerDto, ReceiptRoller's customer master. Customer information imported from a POS (Smaregi / Square) is normalized into this model.
Rotating and safely storing secrets
Explains the rotation plan for safely operating ReceiptRoller client secrets and Webhook secrets, how to use the old/new parallel period, and best practices for storage.
Product master (PIM) and category data
Explains the data structure of ReceiptRoller's product master (PIM), categories, and variations, CRUD operations, SKU management, and synchronization patterns with e-commerce.
Using the Staff API
A guide to CRUD operations on the staff (employees) under a business account using ReceiptRoller's Staff API (/api/v1/staff). Supports fields compatible with Square Team Member (name kana, multiple job assignments, and the pay structure).
Monitoring and handling failures
Explains how to read the ReceiptRoller Webhook delivery history, the metrics to monitor and how to design alerts, redelivering dead letters, and common failure patterns and recovery procedures.
Cannot obtain a token (authentication error)
How to isolate the cause when you cannot obtain an access token. Explains the representative errors — invalid_client, invalid_grant, redirect_uri_mismatch — and what to do about them.
Webhook overview
Explains the main event types delivered by ReceiptRoller Webhooks, why to use Webhooks instead of polling, the delivery format (HTTPS POST + JSON), and how to think about delivery guarantees.
SLA, uptime, and the checking procedure during an incident
Explains ReceiptRoller's API uptime targets, how to check the status page, the isolation procedure when an incident occurs, and the flow for escalating to support.
The developer portal is not shown while on the Free plan
What to check when the ReceiptRoller developer portal is not shown. Explains what to do when your plan is Free, switching business accounts, and the timing of when the display updates.
Signature verification and security
Explains how ReceiptRoller Webhook HMAC-SHA256 signature verification works, sample verification code (Node.js / Python / C#), replay-attack countermeasures, and how to manage secrets safely.
How to read the API reference and docs
Explains the structure of ReceiptRoller's developer documentation and when to use each part. Covers the four entry points — the developer help, the API top page, the Swagger-based API reference, and the developer community — and how to obtain the OpenAPI spec (openapi/v1.json) for use with AI assistants and code generators.
The basics of requests and responses (JSON)
Explains the request format, required headers, response structure, pagination, filtering, and date/time format rules of the ReceiptRoller API.
Representative API examples
Introduces, as curl commands, examples of calling the representative ReceiptRoller API endpoints (retrieving receipts, listing stores, creating products, registering Webhooks).
PosTransactionDto specification — field reference for transaction data
A complete field reference for PosTransactionDto, the canonical model for the transaction data ReceiptRoller handles. For each category — identifiers, dates, amounts, line items, payments, staff, status, and CRM linkage — it summarizes the field names, types, meanings, and how each POS vendor populates them. A reference for developers and external-system integrators. Also referenced from the Smaregi and Square mapping articles.