POS Revenue Classes
Access revenue class definitions from your POS system. Revenue classes categorize sales for financial reporting and analysis.
Overview
The POS Revenue Class API provides access to revenue categorization in your POS system. Revenue classes (also called sales categories or revenue centers) group menu items and sales for accounting and reporting purposes.
Revenue classes are used for:
- Financial Reporting - Categorize sales by revenue type
- Accounting Integration - Map POS sales to accounting categories
- Performance Analysis - Analyze sales by category
- Tax Reporting - Different tax treatment for different revenue classes
API Endpoints
Retrieve Revenue Classes
Returns all revenue class definitions for a specific location.
Method: GET
Endpoint: /pos/v2/{locationId}/revenue-classes
Authentication: Bearer token required
Retrieve all revenue class configurations from the POS system.
Path Parameters
| Name | Type | Description |
|---|---|---|
locationId * | integer | The unique identifier for the location |
Query Parameters
| Name | Type | Description |
|---|---|---|
page | integer | Page number for pagination (default: 1) |
pageSize | integer | Number of results per page (default: 50, max: 100) |
active | boolean | Filter by active/inactive status |
Request
curl -X GET https://conecto-api.shift4payments.com/pos/v2/12345/revenue-classes \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Response
{
"results": [
{
"posRef": "RC-FOOD",
"name": "Food",
"description": "Food sales",
"isActive": true,
"accountingCode": "4010",
"isTaxable": true,
"isNonSalesRevenue": false,
"locationId": 12345
},
{
"posRef": "RC-BEVERAGE",
"name": "Beverage",
"description": "Non-alcoholic beverages",
"isActive": true,
"accountingCode": "4020",
"isTaxable": true,
"isNonSalesRevenue": false,
"locationId": 12345
},
{
"posRef": "RC-ALCOHOL",
"name": "Alcohol",
"description": "Alcoholic beverages",
"isActive": true,
"accountingCode": "4030",
"isTaxable": true,
"isNonSalesRevenue": false,
"locationId": 12345
},
{
"posRef": "RC-TIPS",
"name": "Tips",
"description": "Employee tips",
"isActive": true,
"accountingCode": "2110",
"isTaxable": false,
"isNonSalesRevenue": true,
"locationId": 12345
}
],
"meta": {
"page": 1,
"pageSize": 50,
"totalCount": 12
}
}
Models
RevenueClass
Represents a revenue classification in the POS system.
- Name
posRef- Type
- string
- Description
Unique POS system reference ID for the revenue class
- Name
name- Type
- string
- Description
Display name of the revenue class
- Name
description- Type
- string
- Description
Description of what this revenue class represents
- Name
isActive- Type
- boolean
- Description
Whether the revenue class is currently active
- Name
accountingCode- Type
- string
- Description
General ledger or accounting system code for this revenue class
- Name
isTaxable- Type
- boolean
- Description
Whether sales in this revenue class are taxable
- Name
isNonSalesRevenue- Type
- boolean
- Description
Whether this represents non-sales revenue (tips, fees, etc.)
- Name
parentRevenueClassRef- Type
- string
- Description
Reference to parent revenue class if hierarchical
- Name
locationId- Type
- integer
- Description
Location ID where the revenue class is defined
- Name
createdAt- Type
- datetime
- Description
When the revenue class was created
- Name
updatedAt- Type
- datetime
- Description
When the revenue class was last updated
Common Revenue Classes
Food
Typical items: Entrees, appetizers, sides, desserts
Characteristics:
- Generally taxable
- Sales revenue
- May have sub-classes (appetizers, entrees, desserts)
Beverage (Non-Alcoholic)
Typical items: Soft drinks, coffee, tea, juice
Characteristics:
- Generally taxable
- Sales revenue
- Often separate from food for reporting
Alcohol
Typical items: Beer, wine, spirits, cocktails
Characteristics:
- Usually taxable (sometimes at different rate)
- Sales revenue
- May require separate tracking for compliance
Tips/Gratuities
Typical items: Service charges, automatic gratuities, tips
Characteristics:
- Not taxable (in most jurisdictions)
- Non-sales revenue
- Pass-through to employees
Merchandise
Typical items: Retail items, gift cards, merchandise
Characteristics:
- Generally taxable
- Sales revenue
- May have different tax treatment
Discounts
Typical items: Promotional discounts, comp meals
Characteristics:
- Negative revenue
- May or may not be taxable
- Reduces net sales
Use Cases
Financial Reporting
Generate detailed financial reports:
- Sales by Category - Break down sales by revenue class
- Tax Reports - Calculate taxable vs. non-taxable sales
- Trend Analysis - Track category performance over time
- Mix Analysis - Understand sales mix by category
Accounting Integration
Integrate with accounting systems:
- Map revenue classes to GL accounts
- Post daily sales by category
- Reconcile POS to accounting system
- Generate journal entries automatically
Performance Analysis
Analyze business performance:
- Category Performance - Identify best and worst performing categories
- Pricing Strategy - Analyze pricing by category
- Menu Engineering - Optimize menu based on revenue class performance
- Promotional Analysis - Track impact of promotions by category
Best Practices
- Name
Consistent Mapping- Description
Maintain consistent mapping between revenue classes and accounting codes. Changes should be coordinated with accounting team.
- Name
Non-Sales Revenue- Description
Properly identify non-sales revenue items (tips, fees, etc.) to avoid inflating gross sales figures.
- Name
Tax Treatment- Description
Respect the
isTaxableflag when calculating taxes. Different revenue classes may have different tax treatment.
- Name
Hierarchical Structure- Description
If revenue classes are hierarchical, respect the parent-child relationships in reporting.
- Name
Active Classes Only- Description
Filter for active revenue classes in most contexts, but retain inactive classes for historical data.