logo
API docs by Redocly

Rosnet API (1.0.0)

Download OpenAPI specification:Download

Obtain Credentials

Welcome to Rosnet API. You will need to obtain API credentials in order to connect. To do so please email api@rosnet.com with your name, company name, and email address.

Authentication

This API uses Basic authentication, a simple authentication scheme built into the HTTP protocol. The client sends HTTP requests with the Authorization header that contains the word Basic followed by a space and a base64-encoded string username:password.

See Get Checks for a working example that demonstrates basic authentication.

Paging

On the initial request only the first 500 results will be returned. If there are more results available the response will include a "cursor" header. To fetch the next set of results, send a followup request to the same endpoint and provide the "cursor" value returned from the previous response.

See Get Checks for a working example that demonstrates paging.

Rate Limits

We rate limit the number of API calls you can make to help prevent abuse and protect system stability. If a rate limit is exceeded you will receive a 429 - "Too Many Requests" response along with a Retry-After header containing the number of seconds to wait before making another call.

Outages

From time to time we'll need to take the system down for scheduled maintenance. During these outages you'll receive a 503 - "Service Unavailable" response along with a Retry-After header containing the number of seconds to wait before making another call.

Try It Out!

Visit our hosted Swagger UI or download the OpenAPI specification and import into Postman to make requests and explore the API.

General

List employees

query Parameters
id
integer <int32>

Optional employee id if retrieving a specific employee.

locationId
integer <int32>

Optional location id to filter by. See general/locations for a list of location ids.

deleted
boolean

Optional deleted status to filter by.

borrowed
boolean

Optional borrowed status to filter by.

homeLocationId
integer <int32>

Optional home location id to filter by. See general/locations for a list of location ids.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

alternateemployeeId
string

Optional alternate employee id if retrieving a specific employee.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
Id
required
integer <int32>

Unique database sequence number assigned by Rosnet.

Name
string

Employee's name as entered in Rosnet.

LocationId
required
integer <int32>

The location where the employee was entered. This maps to general/locations Id.

LocationEmployeeId
string

Id assigned by the location's pos system.

PayrollEmployeeId
string

The numerical Payroll Id that is used by the payroll provider.

Deleted
required
boolean

Indicates an employee has been deleted from the pos.

Borrowed
required
boolean

Indicates if an employee has been borrowed.

HomeLocationId
required
integer <int32>

The Home Location as assigned in the Home Location Assignment screen.

AlternateEmployeeId
string

The alphanumeric Payroll Id that is used by the payroll provider. PayrollEmployeeId will be blank if this is used.

PrimaryJobID
required
integer <int32>

The Primary JobId as assigned by the POS or in Modify Employee.
This maps to labor/definitions/jobs Id.

DateOfBirth
string <date-time>

The Employee's PAF or POS Date of Birth in YYYY-MM-DD format.

HireDate
string <date-time>

The Employee's PAF or POS Hire Date in YYYY-MM-DD format.

Response samples

Content type
application/json
[
  • {
    }
]

List locations

query Parameters
id
integer <int32>

Optional location id if retrieving a specific location.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
Id
required
integer <int32>

A unique id. Also known as "Location Number" or simply "Location" on Rosnet reports.

Name
string

The plain name for the number, this is usually a City or Street name.

OpenDate
required
string <date-time>

The business date the location opened in YYYY-MM-DD format.

ClosedDate
string <date-time>

The business date the location closed in YYYY-MM-DD format.
This will be Null for open locations.

TimeZoneName
string

The name of the time zone in the IANA database. See list of time zones

Response samples

Content type
application/json
[
  • {
    }
]

List dayparts

query Parameters
id
integer <int32>

Optional location id if retrieving a specific location.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
Id
required
integer <int32>

Unique database sequence number assigned by Rosnet.

Name
string

The name of the daypart as configured in Rosnet.
For example, "Breakfast", "Lunch", "Dinner", "Late Night".

Level
required
integer <int32>

Indicates the order of the daypart Id and Name in the business day.

ConceptNo
required
integer <int32>

If multiple concepts are configured on one site, this will detail the concept used for the daypart configuration.

StartTime
string

The time the Daypart begins.

EndTime
string

The time the Daypart ends.

ActiveDate
string

The date the Daypart was last configured.

RetireDate
string

The date the Daypart was retired.
This will be Null for active or current configured Dayparts.

Response samples

Content type
application/json
[
  • {
    }
]

Shifts

List shifts

Returns the list of shifts for a given location and business date.

query Parameters
locationId
required
integer <int32>

The location where the shifts occurred. See general/locations.

businessDate
required
string <date-time>

The business date when the shifts occurred. yyyy-MM-dd.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
LocationId
required
integer <int32>

The Rosnet LocationId where the shift occurred. This maps to general/locations Id.

BusinessDate
required
string <date-time>

The Business Date when the shift occurred in YYYY-MM-DD format.

EmployeeId
required
integer <int32>

The employee who worked the shift. This maps to general/employees Id.

Begin
required
string <date-time>

The time the shift began in the location's local time.

End
string <date-time>

The time the shift ended in the location's local time. May be null if employee hasn't clocked out.

JobId
required
integer <int32>

The job the employee worked during the shift. This maps to labor/definitions/jobs Id.

BaseRate
required
number <decimal>

The employee's base pay rate for this shift.

PayRate
required
number <decimal>

The actual rate the employee was paid for this shift.

PayTypeId
required
integer <int32>

Details the type of pay that was used for the shift. This maps to labor/definitions/payTypes Id.

Response samples

Content type
application/json
[
  • {
    }
]

List shifts by pay period

Returns all shifts for a pay period and location.

query Parameters
locationId
required
integer <int32>

The location where the shifts occurred. See general/locations.

businessDate
required
string <date-time>

Any business date in the pay period. yyyy-MM-dd.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
LocationId
required
integer <int32>

The Rosnet LocationId where the shift occurred. This maps to general/locations Id.

BusinessDate
required
string <date-time>

The Business Date when the shift occurred in YYYY-MM-DD format.

EmployeeId
required
integer <int32>

The employee who worked the shift. This maps to general/employees Id.

Begin
required
string <date-time>

The time the shift began in the location's local time.

End
string <date-time>

The time the shift ended in the location's local time. May be null if employee hasn't clocked out.

JobId
required
integer <int32>

The job the employee worked during the shift. This maps to labor/definitions/jobs Id.

BaseRate
required
number <decimal>

The employee's base pay rate for this shift.

PayRate
required
number <decimal>

The actual rate the employee was paid for this shift.

PayTypeId
required
integer <int32>

Details the type of pay that was used for the shift. This maps to labor/definitions/payTypes Id.

Response samples

Content type
application/json
[
  • {
    }
]

List schedules

query Parameters
locationId
required
integer <int32>

The location where the shift was scheduled. See general/locations.

businessDate
required
string <date-time>

The business date the shift is scheduled for. yyyy-MM-dd.

employeeId
integer <int32>

Optional employee id if retrieving a specific employee.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
LocationId
required
integer <int32>

The location where the shift was scheduled. This maps to general/locations Id.

EmployeeId
required
integer <int32>

The employee who was assigned to work the shift. This maps to general/employees Id.

ScheduleBusinessDate
required
string <date-time>

The business date the shift was scheduled for.

ShiftStartTime
required
string <date-time>

The time the shift was scheduled to begin.

ShiftEndTime
required
string <date-time>

The time the shift was scheduled to end.

JobId
required
integer <int32>

The job the employee was assigned for the shift. This maps to labor/definitions/jobs Id.

Station
string

The Station the employee was assigned for the shift.

ShiftHours
required
number <decimal>

The total number of hours for the scheduled shift in decimal format.

Response samples

Content type
application/json
[
  • {
    }
]

List published and validated schedules by pay period

query Parameters
locationId
required
integer <int32>

The location where the shift was scheduled. See general/locations.

businessDate
required
string <date-time>

Any business date in the pay period. yyyy-MM-dd.

employeeId
integer <int32>

Optional employee id if retrieving a specific employee.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
LocationId
required
integer <int32>

The location where the shift was scheduled. This maps to general/locations Id.

EmployeeId
required
integer <int32>

The employee who was assigned to work the shift. This maps to general/employees Id.

ScheduleBusinessDate
required
string <date-time>

The business date the shift was scheduled for.

ShiftStartTime
required
string <date-time>

The time the shift was scheduled to begin.

ShiftEndTime
required
string <date-time>

The time the shift was scheduled to end.

JobId
required
integer <int32>

The job the employee was assigned for the shift. This maps to labor/definitions/jobs Id.

Station
string

The Station the employee was assigned for the shift.

ShiftHours
required
number <decimal>

The total number of hours for the scheduled shift in decimal format.

Response samples

Content type
application/json
[
  • {
    }
]

Tips

List tips

Returns the list of tips for a given location and business date.

query Parameters
locationId
required
integer <int32>

The location where the tip occurred. See general/locations.

businessDate
required
string <date-time>

The business date when the tip occurred. yyyy-MM-dd.

Responses

Response Schema: application/json
Array
BusinessDate
required
string <date-time>

The BusinessDate for the shift where the tips were given in YYYY-MM-DD format.

EmployeeId
required
integer <int32>

The employee who received the tip type. This maps to general/employees Id.

JobId
required
integer <int32>

The job the employee worked when they received the tip type. This maps to labor/definitions/jobs Id.

TipTypeId
required
integer <int32>

The type of tips the employee received for the BusinessDate. This maps to labor/definitions/tipTypes Id.

Amount
required
number <decimal>

The total amount the employee received or declared for the BusinessDate and TipTypeId.

CheckId
required
integer <int32>

Unique id of the check within a location and business date. If the check came from a pos system with unique numeric check ids that number will be used.

Response samples

Content type
application/json
[
  • {
    }
]

Deductions

List deductions

Returns the list of deductions for an employee, location, and business date.

query Parameters
businessDate
required
string <date-time>

The business date when the deduction occurred. yyyy-MM-dd.

locationId
integer <int32>

Optional location where the deduction occurred. See general/locations.

employeeId
integer <int32>

Optional employee Id for a specific employee who received the deduction.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 500

The maximum number of items to return.

Responses

Response Schema: application/json
Array
BusinessDate
required
string <date-time>

The BusinessDate the deduction occurred.

EmployeeId
required
integer <int32>

The employee who received the deduction.

LocationId
required
integer <int32>

The location where the deduction occurred. See general/locations.

CCTipFeeAmount
required
number <decimal>

The total amount of CC Tip Fee(s) taken from the employee for the BusinessDate and Location.

Response samples

Content type
application/json
[
  • {
    }
]

Definitions

List jobs

query Parameters
id
integer <int32>

Optional id if retrieving a specific item.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
Id
required
integer <int32>

Unique database sequence number assigned by Rosnet.

Name
string

The name of the job as entered in Rosnet.

Response samples

Content type
application/json
[
  • {
    }
]

List pay types

query Parameters
id
integer <int32>

Optional id if retrieving a specific item.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
Id
required
integer <int32>

Unique database sequence number assigned by Rosnet.

Name
string

The name of the type of pay as defined in Rosnet. Examples include: "Regular Pay", "OT - Long Workday" ,"OT - Holiday", "Violation Pay".

Response samples

Content type
application/json
[
  • {
    }
]

List tip types

query Parameters
id
integer <int32>

Optional id if retrieving a specific item.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
Id
required
integer <int32>

Unique database sequence number assigned by Rosnet.

Name
string

The name of the tip type as defined in Rosnet. Common examples include: "Declared", "Allocated", "Misc Allocated".

Response samples

Content type
application/json
[
  • {
    }
]

Checks

List checks

Returns the list of checks for a given location and business date.

query Parameters
locationId
required
integer <int32>

The location where the check was created. See general/locations

businessDate
required
string <date-time>

The business date when the check was created. yyyy-MM-dd

id
integer <int32>

Optional id if retrieving a specific item.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
Id
required
integer <int32>

Unique id of the check within a location and business date. If the check came from a pos system with unique numeric check ids that number will be used.

LocationId
required
integer <int32>

The location where the check was created. See general/locations

BusinessDate
required
string <date-time>

The business date when the check was created. Call results will be in yyyy-MM-dd format.

TableName
string

Identifies the table where the check was opened.

OpenTime
required
string <date-time>

The time the check was opened in the location's local time. Call results will show to the minute.

CloseTime
required
string <date-time>

The time the check was closed in the location's local time. Call results will show to the minute.

TrafficCount
required
number <decimal>

The number of customers associated with this check.

ServiceCharge
required
number <decimal>

An additional charge tacked on to the check. For example auto gratuity for large parties.

LoyaltyId
string

Identifies the customer loyalty program associated with this check. If supported by the pos that created the check.

RevenueCenterId
required
integer <int32>

Identifies the revenue center associated with the check. See /sales/definitions/revenueCenters

Array of objects (Tax)
Array of objects (CheckDiscount)
Array of objects (Payment)
Array of objects (ItemSold)
Array of objects (ItemVoid)

Request samples 

// Requests must use https / tls 1.2
ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12;
var url = "https://api.rosnetdev.com"; // must be https
url = Environment.GetEnvironmentVariable("TestApiUrl") ?? url;
const string endpoint = "sales/checks";

var results = new List<Check>();
using (var client = new WebClient())
{
    // Basic auth requires user:pass to be base64 encoded.
    var user = Environment.GetEnvironmentVariable("TestApiUser");
    var pass = Environment.GetEnvironmentVariable("TestApiPass");
    var credentials = Convert.ToBase64String(
        Encoding.Default.GetBytes($"{user}:{pass}"));
    client.Headers["Authorization"] = $"Basic {credentials}";

    // Paging is handled by making a request and then making
    // follow up requests as long as a "cursor" is returned.
    string cursor = null;
    do
    {
        var query = HttpUtility.ParseQueryString("");
        query["locationId"] = "1";
        query["businessDate"] = "2019-04-30";
        if (cursor != null) query["cursor"] = cursor;

        var fullUrl = $"{url}/{endpoint}?{query}";
        _testOutputHelper.WriteLine(fullUrl);
        var json = client.DownloadString(fullUrl);
        results.AddRange(
            JsonConvert.DeserializeObject<List<Check>>(json));

        cursor = client.ResponseHeaders["cursor"];
    } while (cursor != null);
}

// Pick an arbitrary check and verify it's "in balance".
var check = results.FirstOrDefault(x => x.Id == 226943);
Assert.NotNull(check);

var totalItemsSold = check.ItemsSold.Sum(x => x.SoldPrice);
var totalTax = check.Tax.Sum(x => x.Amount);
var totalCheckDiscounts = check.Discounts.Sum(x => x.Amount);
var totalPayments = check.Payments.Sum(x => x.Amount);

Assert.Equal(
    totalPayments,
    totalItemsSold + totalTax - totalCheckDiscounts);

Response samples

Content type
application/json
[
  • {
    }
]

List check changes

Returns the list of GET /sales/checks api calls needed to pull all end of day checks that have been updated since the specified time.

query Parameters
lastUpdatedOn
required
string <date-time>

Links to datasets updated after this time will be returned. The timesamp must be UCT and end with Z to indicate it's zero offset. yyyy-MM-ddTHH:mm:ssZ Example: 2024-02-12T07:14:08Z

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 9999

The maximum number of items to return.

Responses

Response Schema: application/json
Array
LocationId
required
integer <int32>

The location where checks were updated See general/locations

BusinessDate
required
string <date-time>

The business date. yyyy-MM-dd

UpdatedOn
required
string <date-time>

The time the check data was loaded to Rosnet.

Link
string

The url for of the api call to get updated checks.

Response samples

Content type
application/json
[
  • {
    }
]

Definitions

List pos departments

query Parameters
id
integer <int32>

Optional id if retrieving a specific item.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
Id
required
integer <int32>
ConceptNo
required
integer <int32>

Internal identification field for concept.

PosDeptNo
required
integer <int32>

Department number from POS, if loaded.

PosDeptName
string

Department name from POS, if loaded.

RosnetDeptName
string

Department name within Rosnet for POS department.

ActiveDate
string

Date the POS department was active.

RetireDate
string

Date the POS department was retired.

PosDesc
string

The name of the POS

Response samples

Content type
application/json
[
  • {
    }
]

List discount categories

query Parameters
id
integer <int32>

Optional id if retrieving a specific item.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
Id
required
integer <int32>
Name
string

Common examples include: Employee, Promotion, Mistake

Response samples

Content type
application/json
[
  • {
    }
]

List discount types

query Parameters
id
integer <int32>

Optional id if retrieving a specific item.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
Id
required
integer <int32>
Name
string

The name of the discount as entered in Rosnet. Usually describes why the discount was given. Common examples include: "Employee Meal", "Birthday", "Long Wait"

DiscountCategoryId
required
integer <int32>

The category the discount falls under. See sales/definitions/discountCategories

Response samples

Content type
application/json
[
  • {
    }
]

List drive thru stations

query Parameters
id
integer <int32>

Optional id if retrieving a specific item.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
Id
required
integer <int32>

Optional id if retrieving a specific drive-thru station.

Name
string

The name of the drive-thru station.

SortOrder
required
integer <int32>

The order of how the drive-thru stations will appear.

IncludeInSum
required
boolean

Determines whether the specific station is included in total drive-thru time.

ConceptNo
required
integer <int32>

Internal identification field for concept.

ActiveDate
string

Date drive thru station was active.

RetireDate
string

Date drive thru station was retired.

LastUpdated
string

Date drive thru station was changed or updated.

UpdatedBy
required
integer <int32>

POS Number to distinguish who updated the drive thru station

Response samples

Content type
application/json
[
  • {
    }
]

List items

query Parameters
minSoldDate
string <date-time>

Optional. If specified, only items sold on or after this date will be returned. If not specified all items will be returned. yyyy-MM-dd

id
integer <int32>

Optional id if retrieving a specific item.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
Id
required
integer <int32>

Rosnet's internal unique id for the item.

Name
string

Rosnet item name

Plu
required
integer <int32>

Rosnet item PLU number

SalesCategoryId
required
integer <int32>

Optional id if retrieving a specific item. See sales/definitions/salesCategories

ExternalId
string

Optional id for an external system.

Response samples

Content type
application/json
[
  • {
    }
]

List "major" categories

All sales categories belong to a "major" category.

query Parameters
id
integer <int32>

Optional id if retrieving a specific item.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
Id
required
integer <int32>
Name
string

The name of the category as entered in Rosnet. Common examples include: Food, Bar, Retail.

IsFood
required
boolean
IsBeerWineLiquor
required
boolean
IsExcluded
required
boolean

Response samples

Content type
application/json
[
  • {
    }
]

List payment categories

query Parameters
id
integer <int32>

Optional id if retrieving a specific item.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
Id
required
integer <int32>
Name
string

The name of the payment category as entered in Rosnet. Common examples include: "Cash", "Visa", "Gift Card".

Type
string (CategoryType)
Enum: "Cash" "CreditCard" "GiftCardRedeemed" "GiftCardSold" "GiftCertRedeemed" "GiftCertSold" "PaidIn" "PaidOut" "OutOfBalance"

Response samples

Content type
application/json
[
  • {
    }
]

List pos sources

query Parameters
id
integer <int32>

Optional id if retrieving a specific item.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
Id
required
integer <int32>
Name
string

The name of the source. Examples include: "POS", "Table Top", "Rails"

Response samples

Content type
application/json
[
  • {
    }
]

List revenue centers

query Parameters
id
integer <int32>

Optional id if retrieving a specific item.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
Id
required
integer <int32>
Name
string

The name of the revenue center as entered in Rosnet. Common examples include: "Dine In", "To Go", "Catering".

Response samples

Content type
application/json
[
  • {
    }
]

List sales categories

query Parameters
id
integer <int32>

Optional id if retrieving a specific item.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
Id
required
integer <int32>
Name
string

The name of the category as entered in Rosnet. Common examples include: Apps, Burgers, Salads.

MajorCategoryId
required
integer <int32>

Optional ID if retrieving a specific item. The major category the sales category falls under. See sales/definitions/majorCategories

Response samples

Content type
application/json
[
  • {
    }
]

List tax categories

query Parameters
id
integer <int32>

Optional id if retrieving a specific item.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
Id
required
integer <int32>
Name
string

The name of the tax category as entered in Rosnet. These vary based on pos and client preference. Common examples include: State, City, Food, Liquor, Tax Code 1, Tax Code 2.

Response samples

Content type
application/json
[
  • {
    }
]

List void categories

query Parameters
id
integer <int32>

Optional id if retrieving a specific item.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
Id
required
integer <int32>
Name
string

The name of the void category as entered in Rosnet. Usually describes why the item was voided. Common examples include: "Changed Mind", "Rang Wrong Item", "Over Ring"

Response samples

Content type
application/json
[
  • {
    }
]

DriveThru

List DriveThru

Returns DriveThru data.

query Parameters
locationId
required
integer <int32>

Location. See general/locations

businessDate
required
string <date-time>

Business Date. yyyy-MM-dd

id
integer <int32>

Optional id if retrieving a specific item.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
Id
required
integer <int32>

Optional id if retrieving a specific drive-thru station.

Location
required
integer <int32>

Required location number for drive-thru information.

LocationName
string

Location Name for the drive thru information.

BusDate
required
string <date-time>

Business Date. Call results will be in yyyy-MM-dd format.

PullIns
required
integer <int32>

Number of cars who have skipped the greet station.

PullOuts
required
integer <int32>

Number of cars who have triggered drive-thru time without ordering.

DaypartId
required
integer <int32>

POS ID for the daypart for the drive-thru record.

CarsTotal
required
integer <int32>

Number of Cars.

StationId
required
integer <int32>

Number indicating the station.

SecondsAtStation
required
integer <int32>

Length of time is seconds for ordering at specified station.

OrderRef
required
integer <int32>

Sort order number for daypart

SortOrder
required
integer <int32>

Sort order number for drive thru station

Response samples

Content type
application/json
[
  • {
    }
]

Definitions

List account categories

query Parameters
id
integer <int32>
cursor
string
limit
integer <int32>
Default: 100

Responses

Response Schema: application/json
Array
Id
required
integer <int32>

Account category Id

Name
string

Account category name

Excluded
required
boolean

Account exclusion flag

Response samples

Content type
application/json
[
  • {
    }
]

List accounts

query Parameters
id
integer <int32>
cursor
string
limit
integer <int32>
Default: 100

Responses

Response Schema: application/json
Array
Id
required
integer <int32>

unique Account id

AccountNumber
required
integer <int32>

Account number

SubAccountNumber
required
integer <int32>

Sub account number

Name
string

account name

AccountCategoryId
required
integer <int32>

Account category Id

IsInventoried
required
boolean

Inventory account flag

Response samples

Content type
application/json
[
  • {
    }
]

List vendors

query Parameters
id
integer <int32>
cursor
string
limit
integer <int32>
Default: 100

Responses

Response Schema: application/json
Array
Id
required
integer <int32>

unique vendor id

Name
string

Vendor name

Response samples

Content type
application/json
[
  • {
    }
]

List transaction types

query Parameters
id
integer <int32>

Responses

Response Schema: application/json
Array
Id
required
integer <int32>

Unique Transaction type id

Description
string

Transaction name for purchases

Response samples

Content type
application/json
[
  • {
    }
]

List inventory status types

query Parameters
id
integer <int32>

Responses

Response Schema: application/json
Array
Id
required
integer <int32>

unique Inventory status Id

Description
string

inventory status description

Response samples

Content type
application/json
[
  • {
    }
]

List Product UOMs

query Parameters
id
integer <int32>
cursor
string
limit
integer <int32>
Default: 100

Responses

Response Schema: application/json
Array
Id
required
integer <int32>

Product Uom id, unique id

Name
string

Product unit of measure description

Response samples

Content type
application/json
[
  • {
    }
]

Inventory

List Inventory Status

Returns list of inventory periods beginning from the start date.

query Parameters
startDate
required
string <date-time>

Inventory periods ending on or after this date will be returned. yyyy-MM-dd.

locationId
integer <int32>

Optional location to filter by. Returns inventory periods for all locations if not provided. See general/locations for a list of location ids.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
LocationId
required
integer <int32>

The location where inventory will take place. See general/locations.

BeginDate
required
string <date-time>

Beginning Inventory date

EndDate
required
string <date-time>

Ending Inventory date

InventoryStatusId
string

Inventory Status Id

CountSheet
string

Count sheet type description

Response samples

Content type
application/json
[
  • {
    }
]

List inventory products

query Parameters
invPeriodDate
required
string <date-time>

The end date of the inventory period to query. yyyy-MM-dd. See food/inventoryStatus to get a list of inventory periods and their end dates.

locationId
required
integer <int32>
consolidated
boolean
Default: true
cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
ProductId
required
integer <int32>

Product Id

AccountId
required
integer <int32>

Account Id

PrimaryProductDetailId
required
integer <int32>

Unique ID to identify the Product by primary unit of measure Primary Product is determined by unit of measure which the majority of the locations use.

InventoryPeriodEndDate
required
string <date-time>

Ending inventory date

BeginCount
required
number <decimal>

Beginning period's Inventory Count for the product.

BeginAmount
required
number <decimal>

Beginning period's Inventory Amount for the product.

EndCount
required
number <decimal>

Ending period's Inventory Count for the product.

EndAmount
required
number <decimal>

Ending period's Inventory Amount for the product.

TheoUsageCount
required
number <decimal>

Theoretical Usage Count

TheoUsageAmount
required
number <decimal>

Theoretical Usage Amount

WasteCount
required
number <decimal>

Wastage count

WasteAmount
required
number <decimal>

Wastage Amount

Response samples

Content type
application/json
[
  • {
    }
]

List Period Qfactor summary

Returns list of Qfactors by sales category.

query Parameters
invPeriodDate
required
string <date-time>
locationId
required
integer <int32>

Responses

Response Schema: application/json
Array
AccountCatId
required
integer <int32>

Account category id

Amount
required
number <decimal>

Q Factor Amount

Response samples

Content type
application/json
[
  • {
    }
]

List product purchases

query Parameters
locationId
required
integer <int32>
minPostDate
required
string <date-time>

Purchases in inventory periods that end on or after this date will be returned. yyyy-MM-dd. See food/inventoryStatus to get a list of inventory periods and their end dates.

maxPostDate
required
string <date-time>

Purchases in inventory periods that begin on or after this date will be returned. yyyy-MM-dd.

cursor
string
limit
integer <int32>
Default: 100

Responses

Response Schema: application/json
Array
ProductId
required
integer <int32>

Unique Product Id

AccountId
required
integer <int32>
ProductDetailId
required
integer <int32>

Primary Product Detail id

TransactionNumber
string

Transaction number (aka Invoice number)

TransactionTypeId
required
integer <int32>

Transaction id

VendorId
required
integer <int32>

Vendor Id

PostDate
required
string <date-time>

Purchase date (post date).

TransactionDate
required
string <date-time>

Invoice/Transaction date

DeliveryDate
required
string <date-time>

Delivery date and time

Quantity
required
number <decimal>

Total Quantity of the product

TotalPurchasePrice
required
number <decimal>

Total purchase cost for the product

OnInventory
required
boolean

False if not on inventory for the period date else true

Response samples

Content type
application/json
[
  • {
    }
]

List non product purchases

Includes account level purchases

query Parameters
locationId
required
integer <int32>
minPostDate
required
string <date-time>

Purchases that posted in inventory periods that end on or after this date will be returned. yyyy-MM-dd. See food/inventoryStatus to get a list of inventory periods and their end dates.

maxPostDate
required
string <date-time>

Purchases that posted in inventory periods that begin on or after this date will be returned. yyyy-MM-dd.

cursor
string
includeNonInventoryAccounts
boolean
Default: false

Include non product purchases from non inventory accounts (accounts designated as IsInventoried: false in List Accounts). Default is false. false/true.

limit
integer <int32>
Default: 100

Responses

Response Schema: application/json
Array
TransactionNumber
string

Transaction number (aka Invoice number)

TransactionTypeId
required
integer <int32>

Transaction id

AccountId
required
integer <int32>

Account Id having inventory inclusion flag

VendorId
string

Vendor Id

TotalPurchasePrice
required
number <decimal>

Total purchase cost for the product

PostDate
required
string <date-time>

Purchase date (post date).

TransactionDate
required
string <date-time>

Transaction/Invoice date

Response samples

Content type
application/json
[
  • {
    }
]

List on hand amount and quantity

query Parameters
businessDate
required
string <date-time>

The Business date for which the on hand counts are needed. Business date should be greater than end date of last inventory period.(yyyy-MM-dd.) See food/inventoryStatus to get a list of inventory periods and their end dates.

locationId
required
integer <int32>

Returns on hand counts for provided location. See general/locations for a list of location ids.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
ProductId
required
integer <int32>

Product Id

ProductDetailId
required
integer <int32>

Unique ID to identify the product by primary unit of measure. Primary product is determined by unit of measure which the majority of the locations use.

OnHandCount
required
number <decimal>

On hand count for the product.

OnHandAmount
required
number <decimal>

On hand amount for the product.

ProductUomId
required
integer <int32>

Product unit of measure

Response samples

Content type
application/json
[
  • {
    }
]

List plate costs

Returns plate costs for a given location and inventory period.

query Parameters
invPeriodDate
required
string <date-time>

The end date of the inventory period to query. yyyy-MM-dd. See food/inventoryStatus to get a list of inventory periods and their end dates.

locationId
required
integer <int32>

The location associated with the plate. See general/locations

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 500

The maximum number of items to return.

Responses

Response Schema: application/json
Array
ItemId
required
integer <int32>
ItemPlu
required
integer <int32>
ItemName
string
PlateName
string
TotalCost
required
number <decimal>

Response samples

Content type
application/json
[
  • {
    }
]

SoftInventory

List soft inventory products

query Parameters
busDate
required
string <date-time>

Business date within an inventory period. yyyy-MM-dd All data for the period will be returned.

locationId
required
integer <int32>
consolidated
boolean
Default: true

True or false

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
ProductId
required
integer <int32>

Product Id

InventoryDate
required
string <date-time>

Inventory Date

AccountId
required
integer <int32>

Account id

PrimaryProductDetailId
required
integer <int32>

Primary product detail Id

Array of objects (SoftInventoryDetail)

List of Inventory details include Counts and Amounts

Response samples

Content type
application/json
[
  • {
    }
]

List product theoretical usage

query Parameters
busDate
required
string <date-time>

Business date within an inventory period. yyyy-MM-dd All data for the period will be returned.

locationId
required
integer <int32>
productId
integer <int32>

Product id (optional)

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array
ProductId
required
integer <int32>

Product Id

PrimaryProductDetailId
required
integer <int32>

Primary product detail id

BusDate
required
string <date-time>

business Date

ReadingTime
string

Reading time

TheoUsageCount
string

Theoretical Usage count

TheoUsageAmount
string

Theoretical Usage amount

Response samples

Content type
application/json
[
  • {
    }
]

Products

List products

query Parameters
productId
integer <int32>
cursor
string
limit
integer <int32>
Default: 100

Responses

Response Schema: application/json
Array
ProductId
required
integer <int32>

Product Id

ProductDetailId
required
integer <int32>

Product detail Id

Name
string

Product Name

ProductUomId
required
integer <int32>

Product Unit of Measure

IsPrimary
required
boolean

Primary Flag

IsQFactor
required
boolean

Q Factor flag 'Y' represents Yes/true and 'N' represents No/false.

PrimaryProductConversionFactor
required
number <decimal>

Conversion factor to convert to/from primary unit of measure

Response samples

Content type
application/json
[
  • {
    }
]