Restaurant365

https://docs.restaurant365.com/docs/
Admin
Restaurant365 is a comprehensive restaurant management platform that provides accounting, inventory,...
Tokens:634,989
Snippets:12,416
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### GET /api/v2/views/Item

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector

Retrieve inventory item details.

```APIDOC
## GET /api/v2/views/Item

### Description
Retrieve item records filtered by category, item number, or unique ID.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/Item

### Query Parameters
- **$filter** (string) - Optional - OData filter expression (e.g., category1 eq 'Food %26 Beverage', itemId eq xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
```

--------------------------------

### GET /api/v2/views/Company

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector

Retrieve company information.

```APIDOC
## GET /api/v2/views/Company

### Description
Retrieve a list of companies with filtering capabilities based on name patterns or creation date.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/Company

### Query Parameters
- **$filter** (string) - Optional - OData filter expression (e.g., startswith(name,'C'), contains(name,'food'))
- **$orderby** (string) - Optional - Field(s) to sort by
- **$top** (integer) - Optional - Number of records to return
```

--------------------------------

### Retrieve Transactions

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector

Examples for filtering and selecting transaction data using date ranges, IDs, and sorting.

```plaintext
https://odata.restaurant365.net/api/v2/views/Transaction?$filter=date ge 2019-09-01T00:00:00Z
```

```plaintext
https://odata.restaurant365.net/api/v2/views/Transaction?$filter=date lt 2019-12-15T00:00:00Z
```

```plaintext
https://odata.restaurant365.net/api/v2/views/Transaction?$filter=date eq 2019-08-28T00:00:00Z
```

```plaintext
https://odata.restaurant365.net/api/v2/views/Transaction?$filter=date ge 2019-03-26T00:00:00Z and date lt 2019-04-01T00:00:00Z
```

```plaintext
https://odata.restaurant365.net/api/v2/views/Transaction?$select=locationId,locationName,name&$filter=transactionId eq xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
```

```plaintext
https://odata.restaurant365.net/api/v2/views/TransactionDetail?$filter=transactionId eq xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
```

```plaintext
https://odata.restaurant365.net/api/v2/views/TransactionDetail?$filter=amount eq 0
```

```plaintext
https://odata.restaurant365.net/api/v2/views/TransactionDetail?$filter=adjustment ne 0&$orderby=adjustment desc
```

```plaintext
https://odata.restaurant365.net/api/v2/views/Transaction?$filter=locationId eq xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&$orderby=type, date
```

```plaintext
https://odata.restaurant365.net/api/v2/views/Transaction?$filter=date eq 2019-03-26T00:00:00Z&$orderby=createdOn desc&$top=5
```

--------------------------------

### GET /api/v2/views/Transaction

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector-1

Retrieves transaction records from the system.

```APIDOC
## GET /api/v2/views/Transaction

### Description
Retrieves a list of transaction records. When querying by the 'date' property, the query returns all tickets for the business date.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/Transaction
```

--------------------------------

### GET /api/v2/views/Location

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector

Retrieve location information.

```APIDOC
## GET /api/v2/views/Location

### Description
Retrieve location records filtered by ID, number, or legal entity.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/Location

### Query Parameters
- **$filter** (string) - Optional - OData filter expression (e.g., locationId eq xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, contains(name, 'Food'))
```

--------------------------------

### GET /api/v2/views/GLAccount

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector

Retrieve General Ledger account information.

```APIDOC
## GET /api/v2/views/GLAccount

### Description
Retrieve GL account records filtered by account number, location, or type.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/GLAccount

### Query Parameters
- **$filter** (string) - Optional - OData filter expression (e.g., glAccountNumber eq '1234', glType eq 'Current Asset')
- **$select** (string) - Optional - Comma-separated list of fields to return
```

--------------------------------

### Retrieve GL Accounts

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector

Examples for filtering GL accounts by number, location, type, or selecting specific fields.

```plaintext
https://odata.restaurant365.net/api/v2/views/GLAccount?$filter=glAccountNumber eq '1234'
```

```plaintext
https://odata.restaurant365.net/api/v2/views/GLAccount?$filter=locationId eq xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
```

```plaintext
https://odata.restaurant365.net/api/v2/views/GLAccount?$filter=glType eq 'Current Asset' and locationName eq 'My Cafe'
```

```plaintext
https://odata.restaurant365.net/api/v2/views/GLAccount?$filter=glAccountAutoId eq 134&$select=legalentityname,legalentitynumber,legalentityid
```

--------------------------------

### GET /api/v2/views/POSEmployee

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector-1

Retrieves POS Employee mapping records. This view can be joined with Employee data.

```APIDOC
## GET https://odata.restaurant365.net/api/v2/views/POSEmployee

### Description
Retrieves POS Employee mapping records. This view can be joined with Employee data using the employee_id field.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/POSEmployee
```

--------------------------------

### GET /api/v2/views/SalesDetail

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector

Retrieves sales detail records. Note that requests are limited to a 31-day date range.

```APIDOC
## GET /api/v2/views/SalesDetail

### Description
Retrieves a list of sales detail records. This endpoint is subject to a 31-day date range limitation per request.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/SalesDetail

### Response
#### Success Response (200)
- **salesdetailID** (guid) - Unique identifier for the sales ticket record.
- **menuitem** (string) - Name of the menu item ordered.
- **amount** (decimal) - Extended amount charged for the menu item.
- **customerPOSText** (string) - Comment text from the POS.
- **date** (string) - ISO 8601 date and time.
- **quantity** (decimal) - Quantity of the item ordered.
- **void** (boolean) - Indicates if the item was voided.
- **company** (guid) - Company identifier.
- **location** (guid) - Unique identifier for the Location.
- **salesID** (guid) - Unique identifier for the sales ticket record.
- **salesAccount** (string) - GL Account Name.
- **category** (string) - Name of sales category.
- **houseAccountTransaction** (string) - Placeholder for future implementation.
- **dailysalessummaryid** (guid) - Reference to the Daily Sales Summary.
- **transactionDetailID** (string) - Placeholder for future implementation.
- **cateringEvent** (string) - Placeholder for future implementation.
- **createdBy** (guid) - User identifier who created the record.
- **createdOn** (string) - ISO 8601 creation timestamp.
- **modifiedBy** (guid) - User identifier who last modified the record.
- **modifiedOn** (string) - ISO 8601 modification timestamp.
```

--------------------------------

### GET /views/SalesDetail

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector-1

Retrieves sales details for records from a specified location or sales ticket.

```APIDOC
## GET https://odata.restaurant365.net/api/v2/views/SalesDetail

### Description
Retrieves sales details for records from a specified location or sales ticket, optionally including a record count.

### Method
GET

### Query Parameters
- **$filter** (string) - Required - OData filter expression
- **$count** (boolean) - Optional - Include record count
```

--------------------------------

### GET /api/v2/views/SalesPayment

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector

Retrieves payment data associated with sales tickets.

```APIDOC
## GET /api/v2/views/SalesPayment

### Description
Retrieves payment information for sales tickets.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/SalesPayment

### Query Parameters
- **$filter** (string) - Required - OData filter expression (e.g., modifiedon, salesID).
- **$count** (boolean) - Optional - Set to true to include record count.
```

--------------------------------

### GET /api/v2/views/Item

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector-1

Retrieve item records by category, item number, or item ID.

```APIDOC
## GET /api/v2/views/Item

### Description
Retrieve item records. Supports filtering by category, item number, or unique item ID.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/Item

### Query Parameters
- **$filter** (string) - Optional - OData filter expression (e.g., category1 eq 'Food %26 Beverage', itemNumber eq 'ABC123')
```

--------------------------------

### GET /api/v2/views/Company

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector-1

Retrieve company information using string-based filters or sorting.

```APIDOC
## GET /api/v2/views/Company

### Description
Retrieve a list of companies. Supports string matching functions like startswith, endswith, and contains.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/Company

### Query Parameters
- **$filter** (string) - Optional - OData filter expression (e.g., startswith(name,'C'))
- **$orderby** (string) - Optional - Field to sort by
- **$top** (integer) - Optional - Number of records to return
```

--------------------------------

### GET /api/v2/views/SalesDetail

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector

Retrieves detailed sales records for specific locations or sales tickets.

```APIDOC
## GET /api/v2/views/SalesDetail

### Description
Retrieves detailed sales information with optional record counts.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/SalesDetail

### Query Parameters
- **$filter** (string) - Required - OData filter expression (e.g., location, date, salesID).
- **$count** (boolean) - Optional - Set to true to include record count.
```

--------------------------------

### GET /api/v2/views/GLAccount

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector-1

Retrieve GL Account records by account number, location, or type.

```APIDOC
## GET /api/v2/views/GLAccount

### Description
Retrieve GL Account records. Supports filtering by account number, location ID, or GL type.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/GLAccount

### Query Parameters
- **$filter** (string) - Optional - OData filter expression (e.g., glAccountNumber eq '1234', glType eq 'Current Asset')
```

--------------------------------

### GET /api/v2/views/$metadata

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector-1

Retrieves the XML-based service metadata document containing the schema of the entity models.

```APIDOC
## GET /api/v2/views/$metadata

### Description
Retrieves the XML-based service metadata document containing the schema of the entity models associated with each available endpoint.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/$metadata
```

--------------------------------

### GET /api/v2/views/SalesEmployee

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector

Retrieves sales employee (sales ticket) records. Note that requests are limited to a 31-day date range.

```APIDOC
## GET /api/v2/views/SalesEmployee

### Description
Retrieves a list of sales ticket records. This endpoint is subject to a 31-day date range limit per request. It does not support the $select or $count OData parameters.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/SalesEmployee

### Response
#### Success Response (200)
- **salesId** (guid) - Unique identifier for the sales record.
- **receiptNumber** (string) - Receipt number from the POS.
- **checkNumber** (string) - Ticket identifying value from the POS.
- **comment** (string) - Comment text on the ticket.
- **date** (ISO 8601) - Date and time the order was taken.
- **dayOfWeek** (string) - Day of the week.
- **dayPart** (string) - Part of the day the order was taken.
- **netSales** (decimal) - Total sales less discounts.
- **numberOfGuests** (integer) - Number of guests on the ticket.
- **orderHour** (integer) - Hour of the day.
- **salesAmount** (decimal) - Total sales amount excluding tax or tip.
- **taxAmount** (decimal) - Amount of tax.
- **tipAmount** (decimal) - Amount tipped.
- **totalAmount** (decimal) - Total of all items sold.
- **totalPayment** (decimal) - Total payment applied.
- **void** (boolean) - Indicates if the ticket was voided.
- **server** (string) - Name of the employee/server.
- **location** (guid) - Unique identifier for the location.
- **grossSales** (decimal) - Total sales excluding gift cards.
- **dailysalessummaryid** (guid) - Reference to the Daily Sales Summary.
- **createdBy** (guid) - User who created the record.
- **createdOn** (ISO 8601) - Creation timestamp.
- **modifiedBy** (guid) - User who last modified the record.
- **modifiedOn** (ISO 8601) - Last modification timestamp.
- **serviceType** (string) - Service type (e.g., Dine In, Take Out).
```

--------------------------------

### GET /api/v2/views/SalesDetail

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector-1

Retrieves sales detail records. Note that this endpoint enforces a 31-day limit on date ranges and does not support $select or $count parameters.

```APIDOC
## GET https://odata.restaurant365.net/api/v2/views/SalesDetail

### Description
Retrieves detailed sales item information. Requests are limited to a maximum of 31 days of data.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/SalesDetail

### Response
#### Success Response (200)
- **salesdetailID** (guid) - Unique identifier for the sales ticket record.
- **menuitem** (string) - Name of the menu item ordered.
- **amount** (decimal) - Extended amount charged for the item.
- **customerPOSText** (string) - Comment text from the POS.
- **date** (ISO 8601) - Date and time item was added.
- **quantity** (decimal) - Quantity of the item ordered.
- **void** (boolean) - Indicates if the item was voided.
- **company** (guid) - Company identifier.
- **location** (guid) - Unique identifier for the Location.
- **salesID** (guid) - Unique identifier for the salesEmployee record.
- **salesAccount** (string) - GL Account Name.
- **category** (string) - Name of sales category.
- **houseAccountTransaction** (string) - House account transaction details.
- **dailysalessummaryid** (guid) - Reference to the Daily Sales Summary.
- **transactionDetailID** (string) - Transaction detail identifier.
- **cateringEvent** (string) - Catering event details.
- **createdBy** (guid) - User identifier who created the record.
- **createdOn** (ISO 8601) - Creation timestamp.
- **modifiedBy** (guid) - User identifier who last modified the record.
- **modifiedOn** (ISO 8601) - Last modification timestamp.
```

--------------------------------

### GET https://odata.restaurant365.net/api/v2/views/Item

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector

Retrieves item data which can be joined to the Transaction Detail report on the itemId column.

```APIDOC
## GET https://odata.restaurant365.net/api/v2/views/Item

### Description
Retrieves a list of items. This data can be joined to the Transaction Detail report on the itemId column to view more information regarding the item on the transaction detail.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/Item

### Response
- **itemId** (guid) - A unique guid identifier for the item.
- **itemNumber** (string) - The name or number of the business for optional identification purposes.
- **category1** (string) - Item category name 1.
- **category2** (string) - Item category name 2.
- **category3** (string) - Item category name 3.
- **createdBy** (guid) - A unique guid identifier for the User who created the item.
- **createdOn** (string) - The date and time when the item was created in ISO 8601 format.
- **modifiedBy** (guid) - A unique guid identifier for the User who modified the item last.
- **modifiedOn** (string) - The date and time when the item was last modified in ISO 8601 format.
```

--------------------------------

### GET https://odata.restaurant365.net/api/v2/views/GlAccount

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector-1

Retrieves GL Account data. This view can be joined with the Transaction Detail report on glAccountAutoId.

```APIDOC
## GET https://odata.restaurant365.net/api/v2/views/GlAccount

### Description
Retrieves GL Account data. GL Account data can be joined with the Transaction Detail report on glAccountAutoId to see the GL Account associated with a transaction detail record.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/GlAccount

### Response
- **glAccountAutoId** (numeric) - A unique numeric identifier for a GL account.
- **glAccountId** (guid) - A unique guid identifier for a GL account.
- **locationId** (guid) - A reference identifier to a Location associated with the GL account.
- **locationNumber** (string) - The Location number associated with the GL account.
- **locationName** (string) - The Location name associated with the GL account.
- **legalEntityId** (guid) - A guid identifier of the legal entity associated with this GL account.
- **legalEntityNumber** (string) - The number of the legal entity.
- **legalEntityName** (string) - The name of the legal entity.
- **name** (string) - The name of the GL account.
- **glAccountNumber** (string) - The GL account number.
- **glTypeClass** (numeric) - A number class type for this GL account.
- **glType** (string) - The GL account type.
- **operationalCategory** (string) - The Operational category for this GL account.
- **createdBy** (guid) - A unique guid identifier for the User who created the GL account.
- **createdOn** (string) - The date and time when the GL account was created in ISO 8601 format.
- **modifiedBy** (guid) - A unique guid identifier for the User who modified the GL account last.
- **modifiedOn** (string) - The date and time when the GL account was last modified in ISO 8601 format.
```

--------------------------------

### GET /views/GLAccount

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector-1

Retrieves Legal Entity names and numbers for a specified GL Account numeric ID.

```APIDOC
## GET https://odata.restaurant365.net/api/v2/views/GLAccount

### Description
Retrieves Legal Entity names and numbers for a specified GL Account numeric ID.

### Method
GET

### Query Parameters
- **$filter** (string) - Required - Filter by glAccountAutoId
- **$select** (string) - Required - Fields to return (legalentityname, legalentitynumber, legalentityid)
```

--------------------------------

### GET /views/SalesPayment

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector-1

Retrieves sales payment data based on modification date or specific sales ticket ID.

```APIDOC
## GET https://odata.restaurant365.net/api/v2/views/SalesPayment

### Description
Retrieves sales payment data based on modification date or specific sales ticket ID.

### Method
GET

### Query Parameters
- **$filter** (string) - Required - OData filter expression
- **$count** (boolean) - Optional - Include record count
```

--------------------------------

### GET /views/LaborDetail

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector-1

Retrieves labor details, hours, or punch information for employees within specified date and time ranges.

```APIDOC
## GET https://odata.restaurant365.net/api/v2/views/LaborDetail

### Description
Retrieves labor details, hours, or punch information for employees within specified date and time ranges.

### Method
GET

### Query Parameters
- **$filter** (string) - Required - OData filter expression
- **$select** (string) - Optional - Fields to return
```

--------------------------------

### GET /api/v2/views/Employee

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector

Retrieves a list of employee records. This endpoint provides detailed information about employees, including contact details, hire dates, and status.

```APIDOC
## GET https://odata.restaurant365.net/api/v2/views/Employee

### Description
Retrieves employee records. Employees can be joined to Labor Detail or POS Employee data using the employeeId field.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/Employee

### Response
#### Success Response (200)
- **employeeId** (guid) - Unique identifier for an Employee.
- **fullName** (string) - Full name of the Employee.
- **address1** (string) - Address line 1.
- **address2** (string) - Address line 2.
- **allowTextMessaging** (boolean) - Indicates if text messaging is allowed.
- **birthdayDay** (integer) - Day of birthday.
- **birthdayMonth** (integer) - Month of birthday.
- **city** (string) - City of residence.
- **firstName** (string) - First name.
- **hireDate** (string) - Hire date.
- **lastName** (string) - Last name.
- **middleName** (string) - Middle name.
- **mobilePhone** (string) - Mobile phone number.
- **multipleLocations** (boolean) - Indicates if employee works at multiple locations.
- **payrollID** (string) - Payroll ID.
- **phoneNumber** (string) - Phone number.
- **posid** (string) - POS ID.
- **state** (string) - State of residence.
- **zipCode** (string) - Zip code.
- **primaryLocation_id** (guid) - Primary work location.
- **inactive** (boolean) - Employee status.
- **email** (string) - Email address.
- **birthday** (string) - Birthday.
- **createdBy** (guid) - User who created the record.
- **createdOn** (string) - Creation date (ISO 8601).
- **modifiedBy** (guid) - User who last modified the record.
- **modifiedOn** (string) - Last modification date (ISO 8601).
```

--------------------------------

### GET /api/v2/views/SalesPayment

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector-1

Retrieves sales payment records. Note that requests are limited to a maximum date range of 31 days.

```APIDOC
## GET /api/v2/views/SalesPayment

### Description
Retrieves a list of sales payment records. This endpoint does not support the $select or $count OData parameters. Requests are limited to a maximum of 31 days of data.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/SalesPayment

### Parameters
#### Query Parameters
- **$filter** (string) - Optional - Filters the results based on a Boolean condition.
- **$orderby** (string) - Optional - Sorts the results.
- **$skip** (integer) - Optional - Skips the first n results.
- **$top** (integer) - Optional - Returns only the first n results.

### Response
#### Success Response (200)
- **salespaymentId** (guid) - Unique identifier for the record.
- **name** (string) - Name of payment.
- **amount** (decimal) - Payment amount.
- **date** (ISO 8601) - Date and time payment was recorded.
- **location** (guid) - Unique identifier for the location.
```

--------------------------------

### GET https://odata.restaurant365.net/api/v2/views/SalesEmployee

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector-1

Retrieves sales employee (sales ticket) records. Note that this endpoint does not support $select or $count OData parameters and requires a date range filter of no more than 31 days.

```APIDOC
## GET https://odata.restaurant365.net/api/v2/views/SalesEmployee

### Description
Retrieves a list of sales employee records. Data is limited to a 31-day range per request.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/SalesEmployee

### Response
#### Success Response (200)
- **salesId** (guid) - Unique identifier for the record.
- **receiptNumber** (string) - Receipt number from POS.
- **checkNumber** (string) - Ticket identifying value from POS.
- **comment** (string) - Comment text.
- **date** (string) - ISO 8601 date and time.
- **dayOfWeek** (string) - Day of the week.
- **dayPart** (string) - Part of the day.
- **netSales** (decimal) - Total sales less discounts.
- **numberOfGuests** (integer) - Number of guests.
- **orderHour** (integer) - Hour of the day.
- **salesAmount** (decimal) - Total sales excluding tax/tip.
- **taxAmount** (decimal) - Tax amount.
- **tipAmount** (decimal) - Tip amount.
- **totalAmount** (decimal) - Total of all items sold.
- **totalPayment** (decimal) - Total payment applied.
- **void** (boolean) - Indicates if the ticket was voided.
- **server** (string) - Name of the employee/server.
- **location** (guid) - Unique identifier for the location.
- **grossSales** (decimal) - Total sales excluding gift cards.
- **dailysalessummaryid** (guid) - Reference to the Daily Sales Summary.
- **createdBy** (guid) - User who created the record.
- **createdOn** (string) - ISO 8601 creation date.
- **modifiedBy** (guid) - User who last modified the record.
- **modifiedOn** (string) - ISO 8601 modification date.
- **serviceType** (string) - Service type/order mode.
```

--------------------------------

### Create Journal Entries via API

Source: https://docs.restaurant365.com/docs/r365-api-connector

Submit journal entries to the system. Debits and credits must be balanced for the request to succeed.

```bash
curl --request POST \
 --url 'https://[YOUR-UNIQUE-CUSTOMER-URL].restaurant365.com/APIv1/JournalEntries \
 --header 'Authorization: InsertYourBearerTokenKeyHere' \
 --header 'Content-Type: application/json' \
 --data
{
 "BatchId": "String",
 "userId": "String",
 "journalEntries":
 [
 {
 "JENumber": "String", //Optional (R365 will assign an autogenerated number if not included)
 "Date": "String", //Required
 "JEComment": "Testing API", //Optional
 "JELocation": "100", //Required
 "Account": "1000", //Required
 "Debit": 0, //Required Debits and Credits must be balanced
 "Credit": 100, //Required Debits and Credits must be balanced
 "DetailLocation": "100", //Required
 "PayrollJournalEntry": true, //Required only for Payroll JE's. DO NOT include if JE is not for payroll
 "PayrollStartDate": "9/16/2020", //Required only for Payroll JE's. DO NOT include if JE is not for payroll
 "PayrollEndDate": "9/29/2020" //Required only for Payroll JE's. DO NOT include if JE is not for payroll
 }
 ]
}
```

```json
{
 "errors": [
 {
 "reason": "String",
 "solution": "String"
 }
 ],
 "success": [ { "Count": 0 } ],
 "failures": [
 {
 "record": "String",
 "reason": "String",
 "solution": "String"
 }
 ]
}
```

--------------------------------

### Create AP Invoices by GL Account via API

Source: https://docs.restaurant365.com/docs/r365-api-connector

Submit AP invoices mapped to specific GL accounts. Requires valid authentication and correct GL account/location identifiers.

```bash
curl --request POST \
 --url 'https://[YOUR-UNIQUE-CUSTOMER-URL].restaurant365.com/APIv1/APInvoicesGL \
 --header 'Authorization: InsertYourBearerTokenKeyHere' \
 --header 'Content-Type: application/json' \
 --data
{
 "BatchId": "1",
 "userId": "QA_TESTING",
 "apInvoices":
 [
 {
 "Type": "AP Invoice", //OR AP Credit Memo, Required
 "Comment": "", //Optional
 "Vendor": "Abbey", //Required
 "Date": "06/30/2023", //Required
 "GL_Date": "06/30/2023", //Required
 "Due_Date": "06/30/2023", //If blank, will default to Date value,Optional
 "Location": "20", //Required
 "Number": "TESTAPIG523", //Required
 "Amount": 15.12, //Required
 "Payment_Terms": "", //Optional
 "Detail_Account": "100", //GL Account Name or Number, Required
 "Detail_Amount": 15.12, //Required
 "Detail_Comment": "AAAAAAAAAA", //Line item comment, Optional
 "Detail_Location": "20", //Required
 "Image_URL": "https://www.example.com/images/img.jpg", //Optional
 "IsPaid": "false", //Optional
 "Paid_Account": "500" //GL Account number associated with the invoice, Optional
 }
 ]
}
```

```json
{
 "errors": [
 {
 "reason": "String",
 "solution": "String"
 }
 ],
 "success": [ { "Count": 0 } ],
 "failures": [
 {
 "record": "String",
 "reason": "String",
 "solution": "String"
 }
 ]
}
```

--------------------------------

### Create AP Invoices via API

Source: https://docs.restaurant365.com/docs/r365-api-connector

Submit a batch of AP invoices using a POST request. Ensure the Authorization header is set with a valid Bearer token.

```bash
curl --request POST \
 --url 'https://[YOUR-UNIQUE-CUSTOMER-URL].restaurant365.com/APIv1/APInvoices \
 --header 'Authorization: InsertYourBearerTokenKeyHere' \
 --header 'Content-Type: application/json' \
 --data
{
 "BatchId": "String",
 "userId": "String",
 "apInvoices":
 [
 {
 "Vendor_Name": "OBTAIN VENDOR NUMBER FROM CUSTOMER", //Required
 "Retailer_Store_Number": "String", //Required
 "Invoice_Date": "MM/DD/YYYY", //Required
 "Invoice_Due_Date": "MM/DD/YYYY", //Optional
 "Invoice_Number": "#######", //Optional
 "Invoice_Amount": #.##, //Optional
 "Image_URL": "String", //Optional
 "Product_Number": "OBTAIN VENDOR ITEM NUMBER FROM CUSTOMER", //Optional
 "Quantity": #, //Optional
 "Invoice_Line_Item_Cost": #.##, //Optional
 "Extended_Price": #.##, //Optional
 "Product_Description": "AAAAAAAAAA", //Optional
 "Unit_Of_Measure": "AAAAAAA (MUST MATCH UOFM IN R365)", //Optional
 "Split_Case": true/false (SPLIT UOFM SET ON VENDOR ITEM IN R365) //Optional
 }
]
}
```

```json
{
 "errors": [
 {
 "reason": "String",
 "solution": "String"
 }
 ],
 "success": [ { "Count": 0 } ],
 "failures": [
 {
 "record": "String",
 "reason": "String",
 "solution": "String"
 }
 ]
}
```

--------------------------------

### POST /APIv1/APInvoices

Source: https://docs.restaurant365.com/docs/r365-api-connector

Creates new AP Invoices in the Restaurant365 system.

```APIDOC
## POST /APIv1/APInvoices

### Description
Submits a batch of AP Invoices to the Restaurant365 system.

### Method
POST

### Endpoint
https://[YOUR-UNIQUE-CUSTOMER-URL].restaurant365.com/APIv1/APInvoices

### Request Body
- **BatchId** (String) - Required
- **userId** (String) - Required
- **apInvoices** (Array) - Required

### Response
#### Success Response (200)
- **success** (Array) - Contains count of successful records
- **errors** (Array) - List of error reasons and solutions
- **failures** (Array) - List of failed records with reasons and solutions
```

--------------------------------

### GET /api/v2/views/EntityDeleted

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector-1

Retrieves records of entities that have been deleted from the system.

```APIDOC
## GET /api/v2/views/EntityDeleted

### Description
Retrieves a list of entities that have been deleted, useful for synchronizing data deletions.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/EntityDeleted

### Parameters
#### Query Parameters
- **$filter** (string) - Optional - Filters the results.
- **$orderby** (string) - Optional - Sorts the results.
- **$select** (string) - Optional - Selects properties to include.
- **$skip** (integer) - Optional - Skips the first n results.
- **$top** (integer) - Optional - Returns only the first n results.

### Response
#### Success Response (200)
- **entityId** (guid) - Unique identifier for the record.
- **entityName** (string) - Name of the entity type.
- **deletedOn** (ISO 8601) - Date and time the record was deleted.
```

--------------------------------

### GET /views/EntityDeleted

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector-1

Retrieves IDs for entities deleted on a specific date.

```APIDOC
## GET https://odata.restaurant365.net/api/v2/views/EntityDeleted

### Description
Retrieves IDs for entities deleted on a specific date.

### Method
GET

### Query Parameters
- **$filter** (string) - Required - OData filter expression
```

--------------------------------

### Retrieve Snowflake Cloud Platform and Region

Source: https://docs.restaurant365.com/docs/snowflake-data-share-setup

Use this query to identify the cloud platform and region hosting the Snowflake account.

```sql
SELECT CURRENT_REGION() AS ACCOUNT_REGION;
```

--------------------------------

### POST /APIv1/APInvoicesGL

Source: https://docs.restaurant365.com/docs/r365-api-connector

Creates new AP Invoices categorized by GL account.

```APIDOC
## POST /APIv1/APInvoicesGL

### Description
Submits AP Invoices with specific GL account details.

### Method
POST

### Endpoint
https://[YOUR-UNIQUE-CUSTOMER-URL].restaurant365.com/APIv1/APInvoicesGL

### Request Body
- **BatchId** (String) - Required
- **userId** (String) - Required
- **apInvoices** (Array) - Required

### Response
#### Success Response (200)
- **success** (Array) - Contains count of successful records
- **errors** (Array) - List of error reasons and solutions
- **failures** (Array) - List of failed records with reasons and solutions
```

--------------------------------

### GET /api/v2/views/Location

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector-1

Retrieve location records by ID, number, or legal entity.

```APIDOC
## GET /api/v2/views/Location

### Description
Retrieve location records. Supports filtering by location ID, location number, legal entity number, or name.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/Location

### Query Parameters
- **$filter** (string) - Optional - OData filter expression (e.g., locationId eq xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, locationNumber eq '1234')
```

--------------------------------

### Authenticate with R365 API

Source: https://docs.restaurant365.com/docs/r365-api-connector

Use this CURL command to generate a bearer token for subsequent API requests. Replace [YOUR-UNIQUE-CUSTOMER-URL] with your specific R365 subdomain.

```bash
curl --request POST \
 --url 'https://[YOUR-UNIQUE-CUSTOMER-URL].restaurant365.com/APIv1/Authenticate/JWT format=json' \
 --header 'Content-Type: application/json' \
 --data '
{
 "UserName":"yourUserName",
 "Password":"YourPassword"
}'
```

--------------------------------

### Retrieve Company Information

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector-1

Queries for filtering companies by name patterns or creation date.

```HTTP
https://odata.restaurant365.net/api/v2/views/Company?$filter=startswith(name,'C')
```

```HTTP
https://odata.restaurant365.net/api/v2/views/Company?$filter=endswith(name,'Inc')
```

```HTTP
https://odata.restaurant365.net/api/v2/views/Company?$filter=contains(name,'food')
```

```HTTP
https://odata.restaurant365.net/api/v2/views/Company?$orderby=createdOn desc&$top=1
```

--------------------------------

### GET /api/v2/views/Company

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector-1

Retrieves company records, which can be joined to the Transaction report using companyId.

```APIDOC
## GET /api/v2/views/Company

### Description
Retrieves company records. These can be joined to the Transaction report using the companyId property.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/Company
```

--------------------------------

### POST /APIv1/JournalEntries

Source: https://docs.restaurant365.com/docs/r365-api-connector

Creates new Journal Entries in the general ledger.

```APIDOC
## POST /APIv1/JournalEntries

### Description
Submits journal entries to the general ledger. Debits and credits must be balanced.

### Method
POST

### Endpoint
https://[YOUR-UNIQUE-CUSTOMER-URL].restaurant365.com/APIv1/JournalEntries

### Request Body
- **BatchId** (String) - Required
- **userId** (String) - Required
- **journalEntries** (Array) - Required

### Response
#### Success Response (200)
- **success** (Array) - Contains count of successful records
- **errors** (Array) - List of error reasons and solutions
- **failures** (Array) - List of failed records with reasons and solutions
```

--------------------------------

### User Operations

Source: https://docs.restaurant365.com/docs/api-managed-users-1

Operations for creating, viewing, and updating user records in the system.

```APIDOC
## GET /users

### Description
Returns existing users, including general information, user roles, report roles, and location access.

### Method
GET

## POST /users

### Description
Creates new user records and sets values for general information, user roles, report roles, and location access.

### Method
POST

## PATCH /users/{userId}

### Description
Updates existing users, including general information, user roles, report roles, and location access.

### Method
PATCH
```

--------------------------------

### Retrieve Item Information

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector-1

Queries for filtering items by category, item number, or unique ID.

```HTTP
https://odata.restaurant365.net/api/v2/views/Item?$filter=category1 eq 'Food %26 Beverage'
```

```HTTP
https://odata.restaurant365.net/api/v2/views/Item?$filter=itemNumber eq 'ABC123'
```

```HTTP
https://odata.restaurant365.net/api/v2/views/Item?$filter=itemId eq xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
```

--------------------------------

### OData Entity Endpoints

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector-1

A list of available OData endpoints for retrieving system data from Restaurant365.

```APIDOC
## Available OData Endpoints

### Description
The following entities are available for retrieval via the R365 OData Connector:

- **Company**: List all vendors.
- **Employee**: List all employees with basic information.
- **EntityDeleted**: Retrieve a list of records deleted from the system.
- **GLAccount**: List all GL accounts with details.
- **Item**: List all Items with categorization.
- **JobTitle**: List all Job titles with details.
- **LaborDetail**: Retrieve employee punch times details (clock in/out).
- **Location**: List all locations.
- **PayrollSummary**: Retrieve a list of labor records.
- **POSEmployee**: Retrieve data mapping between R365 Employee records and POS Employee records.
- **Transaction**: Retrieve a list of financial transactions.
- **TransactionDetail**: Retrieve a list of financial transaction details at item level.
- **SalesEmployee**: Retrieve a list of Sales Ticket (header) data, including the employee associated with the ticket. (Note: Does not support $select or $count).
- **SalesDetail**: Retrieve sales ticket details (items on ticket). (Note: Does not support $select or $count).
- **SalesPayment**: Retrieve sales payment associated with sales ticket data. (Note: Does not support $select or $count).
```

--------------------------------

### Retrieve Transaction Details

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector-1

Queries for fetching specific transaction data, including details by ID, zero balances, and adjustments.

```HTTP
https://odata.restaurant365.net/api/v2/views/Transaction?$select=locationId,locationName,name&$filter=transactionId eq xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
```

```HTTP
https://odata.restaurant365.net/api/v2/views/TransactionDetail?$filter=transactionId eq xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
```

```HTTP
https://odata.restaurant365.net/api/v2/views/TransactionDetail?$filter=amount eq 0
```

```HTTP
https://odata.restaurant365.net/api/v2/views/TransactionDetail?$filter=adjustment ne 0&$orderby=adjustment desc
```

--------------------------------

### GET /api/v2/views/TransactionDetail

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector-1

Retrieves transaction detail records, which can be joined to the Transaction report using transactionId.

```APIDOC
## GET /api/v2/views/TransactionDetail

### Description
Retrieves transaction detail records. These can be joined to the Transaction report using the transactionId property.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/TransactionDetail
```

--------------------------------

### Retrieve Transactions by Date

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector-1

Use these queries to filter transactions based on specific dates or ranges.

```HTTP
https://odata.restaurant365.net/api/v2/views/Transaction?$filter=date ge 2019-09-01T00:00:00Z
```

```HTTP
https://odata.restaurant365.net/api/v2/views/Transaction?$filter=date lt 2019-12-15T00:00:00Z
```

```HTTP
https://odata.restaurant365.net/api/v2/views/Transaction?$filter=date eq 2019-08-28T00:00:00Z
```

```HTTP
https://odata.restaurant365.net/api/v2/views/Transaction?$filter=date ge 2019-03-26T00:00:00Z and date lt 2019-04-01T00:00:00Z 
```

--------------------------------

### GET /api/v2/views/LaborDetail

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector

Retrieves labor and punch details for employees based on date, ID, or time ranges.

```APIDOC
## GET /api/v2/views/LaborDetail

### Description
Retrieves labor details including hours worked and punch times.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/LaborDetail

### Query Parameters
- **$filter** (string) - Required - OData filter expression (e.g., dateWorked, employee_Id, startTime, total).
- **$select** (string) - Optional - Fields to return (e.g., hours).
```

--------------------------------

### POST /APIv1/Authenticate/JWT

Source: https://docs.restaurant365.com/docs/r365-api-connector

Authenticates a user and returns a session ID and bearer token for use in subsequent API calls.

```APIDOC
## POST /APIv1/Authenticate/JWT

### Description
Authenticates a user against the Restaurant365 database and returns a bearer token required for subsequent API requests.

### Method
POST

### Endpoint
https://[YOUR-UNIQUE-CUSTOMER-URL].restaurant365.com/APIv1/Authenticate/JWT

### Request Body
- **UserName** (string) - Required - The username for the R365 account.
- **Password** (string) - Required - The password for the R365 account.

### Request Example
{
 "UserName":"yourUserName",
 "Password":"YourPassword"
}

### Response
#### Success Response (200)
- **SessionId** (string) - The unique session identifier.
- **UserName** (string) - The authenticated username.
- **BearerToken** (string) - The token to be used in the header of subsequent requests.
- **ResponseStatus** (object) - Status information regarding the request.

#### Response Example
{
 "SessionId": "YourSessionId",
 "UserName": "YourUserName",
 "BearerToken": "YourBearerTokenReturned",
 "ResponseStatus": {}
}
```

--------------------------------

### GET /api/v2/views/Item

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector-1

Retrieves item records, which can be joined to the Transaction Detail report using the itemId column.

```APIDOC
## GET /api/v2/views/Item

### Description
Retrieves item records. These can be joined to the Transaction Detail report using the itemId column to view more information regarding the item.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/Item
```

--------------------------------

### GET /api/v2/views/JobTitle

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector-1

Retrieves a list of Job Titles. This view can be joined with Labor Detail and GL Accounts.

```APIDOC
## GET https://odata.restaurant365.net/api/v2/views/JobTitle

### Description
Retrieves a list of Job Titles. This view can be joined with Labor Detail using the JobTitleID field and with GL Accounts using the glAccount_ID field.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/JobTitle
```

--------------------------------

### GET /api/v2/views/Employee

Source: https://docs.restaurant365.com/docs/restaurant365-odata-connector

Retrieves employee records based on various filters such as name, messaging preferences, location, or status.

```APIDOC
## GET /api/v2/views/Employee

### Description
Retrieves employee records based on specific criteria.

### Method
GET

### Endpoint
https://odata.restaurant365.net/api/v2/views/Employee

### Query Parameters
- **$filter** (string) - Required - OData filter expression to narrow down results (e.g., fullName, allowTextMessaging, primaryLocation_id, city, inactive).
```
Tokens:
Raw