Documentation

Welcome to the The Neat Profit documentation hub. Here you’ll find comprehensive API guides, integration documentation, and technical resources for developers using our bar inventory management software.

Getting Started

New to The Neat Profit API? Start here to set up your integration and begin using our powerful tools.

Getting Started Guide - Learn how to authenticate, make your first API call, and set up webhooks. Perfect for developers who want to integrate quickly.

API Reference

Complete reference documentation for all API endpoints.

API Overview - Introduction to the API architecture, authentication, rate limits, and best practices.
Authentication - Learn about API keys, OAuth tokens, and securing your integration.
Inventory API - Endpoints for managing inventory, products, and stock levels.
POS Integration API - Sync sales data, map products, and manage POS connections.
Ordering API - Automate distributor orders, manage suppliers, and track shipments.
Analytics API - Access variance reports, demand forecasts, and performance metrics.
Webhooks - Set up real-time notifications for inventory changes, variance alerts, and order updates.

Integration Guides

Step-by-step guides for common integrations.

POS Integration Guide - Connect Toast, Square, Micros, and other major POS systems.
Distributor Integration - Integrate with major beverage distributors for automated ordering.
Mobile App Integration - Build custom mobile apps using our mobile SDK.
Webhook Handling - Best practices for handling webhook events securely.

Feature Documentation

Deep dive into specific features and capabilities.

AI Demand Forecasting - How to use predictive analytics for inventory planning.
Variance Analysis - Detect and analyze inventory variance patterns.
Recipe Costing - Calculate drink costs and optimize menu pricing.
Smart Ordering - Automate purchase orders with AI-powered recommendations.

Guides

Comprehensive guides on bar inventory management, operations, AI tools, and more.

All Guides - Browse our full collection of guides covering bar inventory, variance tracking, recipe costing, POS integration, demand forecasting, voice inventory, AI operations, and industry-specific best practices.

Quick Links

The Neat Profit Website - Visit our main website for product information and to sign up
GitHub Repository - View source code and report issues
Support - Get help with any questions or issues

Need Help?

Can’t find what you’re looking for? Our support team is here to help:

Email - Reach out to our developer support team at api@theneatprofit.com
GitHub Issues - Report bugs and request features on our GitHub repository
Documentation - Browse our extensive guides and API reference

Stay Updated

Keep up with the latest API changes and improvements:

Follow our developer blog for API updates and best practices
Check our changelog for new features and breaking changes
Join our developer community to connect with other integrators

Ready to start building? Get your API key at theneatprofit.com and begin integrating today.