CIZARO API

CIZARO API
More information: https://cizaro.com/
Contact Info: info@cizaro.com
Version: v1
Licensed by CIZARO
https://cizaro.com/

Access

Methods

[ Jump to Models ]

Table of Contents

AdministrationRouter

AuthorizationRouter

BranchRouter

CampaignRouter

CityRouter

CizaroMinimalAPI

CompanyRouter

CountryRouter

CurrencyTypeRouter

CustomQueryRouter

CustomerRouter

CustomerTypeRouter

DashboardLayoutRouter

DeliveryOptionRouter

DocRouter

DriverRouter

EmployeeRouter

EmployeeShiftRouter

EmployeeTimeClockRouter

FleetRouter

HardwareRouter

InitValuesRouter

InventoryCountingRouter

InventoryListRouter

InventoryMovementRouter

InventoryRouter

ItemCategoryRouter

ItemMatrixRouter

ItemRouter

LanguageRouter

LeadRouter

MatrixAttributesRouter

MeasureRouter

ModifierGroupRouter

ModifierRouter

MoneyTypeRouter

OrderNumberHistoryRouter

OrderNumberRouter

OrderRouter

PaymentRouter

PaymentTypeRouter

PositionEntryRouter

PositionRouter

PriceListRouter

PriceRouter

ProductionOrderRouter

PurchaseOrderRouter

ReceivingOrderRouter

ReminderRouter

ReportLayoutRouter

ReturnOrderRouter

RoomEntryRouter

RouteRouter

SignatureRouter

SpreadSheetRouter

StateRouter

StationRouter

SupplierRouter

TaxRouter

ToDoRouter

UserRouter

VehiclePositionRouter

AdministrationRouter

Up
post /administration/create
Summary (administrationCreatePost)
Creates a new Administration Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ParameterRequest (required)
Body Parameter

Responses

200

Success

Up
get /administration/GetAllByBranch/{BranchId}
Summary (administrationGetAllByBranchBranchIdGet)
Get All Global Parameters by Branch

Path parameters

BranchId (required)
Path Parameter

Responses

200

Success

Up
get /administration/GetAll
Summary (administrationGetAllGet)
Get All Global Parameters

Responses

200

Success

Up
get /administration/GetByBranch/{BranchId}/{name}
Summary (administrationGetByBranchBranchIdNameGet)
Get one Global Parameter by Parameter Name and branch Id

Path parameters

BranchId (required)
Path Parameter
name (required)
Path Parameter

Responses

200

Success

Up
get /administration/GetByName/{name_string}
Summary (administrationGetByNameNameStringGet)
Get one Global Parameter by Parameter Name

Path parameters

name_string (required)
Path Parameter

Responses

200

Success

Up
get /administration/Get/{name}
Summary (administrationGetNameGet)
Get All Global Parameters, that aren't linked to a branch

Path parameters

name (required)
Path Parameter

Responses

200

Success

Up
put /administration/UpdateByBranch/{BranchId}/{AdministrationName}
Summary (administrationUpdateByBranchBranchIdAdministrationNamePut)
Sets a Branch Parameter Value, by Parameter Name and Branch Id

Path parameters

AdministrationName (required)
Path Parameter
BranchId (required)
Path Parameter

Query parameters

AdministrationValue (required)
Query Parameter

Responses

200

Success

Up
post /administration/UpdateById/{administrationId}
Summary (administrationUpdateByIdAdministrationIdPost)
Sets a Global Parameter Value, by Parameter Id

Path parameters

administrationId (required)
Path Parameter

Query parameters

AdministrationValue (required)
Query Parameter

Responses

200

Success

Up
put /administration/UpdateGlobal/{AdministrationName}
Summary (administrationUpdateGlobalAdministrationNamePut)
Sets a Global Parameter Value, by Parameter Name

Path parameters

AdministrationName (required)
Path Parameter

Query parameters

AdministrationValue (required)
Query Parameter

Responses

200

Success

AuthorizationRouter

Up
get /security/CreateTokenByKey/{apiKey}
Summary (securityCreateTokenByKeyApiKeyGet)
Returns the Bearer token, passing the Global Key as a Router Parameter, this token will be used in all others api that requires authentication

Path parameters

apiKey (required)
Path Parameter

Responses

200

Success

Up
post /security/CreateToken
Summary (securityCreateTokenPost)
Returns the Bearer token, passing the Username and key as a body parameter, this token will be used in all others api that requires authentication

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body LoginRequest (required)
Body Parameter

Responses

200

Success

BranchRouter

Up
get /branch/GetAllByCompany/{CompanyId}
Summary (branchGetAllByCompanyCompanyIdGet)
Returns all branches linked by a single Company

Path parameters

CompanyId (required)
Path Parameter

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /branch/GetAll
Summary (branchGetAllGet)
Returns all branches

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /branch/GetAll/{OffSet}
Summary (branchGetAllOffSetGet)
Returns all branches, limited by an offset, The ShowExtended parameter allows to include metadata related to the query

Path parameters

OffSet (required)
Path Parameter — format: int32

Query parameters

ShowExtended (optional)
Query Parameter — default: false
ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /branch/Get/{id}
Summary (branchGetIdGet)
Returns a single Branch, according to its Id

Path parameters

id (required)
Path Parameter

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

CampaignRouter

Up
get /campaign/GetByDate
Summary (campaignGetByDateGet)
Returns all campaigns inside a date range

Query parameters

date (required)
Query Parameter

Responses

200

Success

Up
get /campaign/GetById/{id}
Summary (campaignGetByIdIdGet)
Returns a single Campaign, according to its Id

Path parameters

id (required)
Path Parameter

Responses

200

Success

Up
get /campaign/Get/{offset}
Summary (campaignGetOffsetGet)
Returns all campaigns, limited by an offset

Path parameters

offset (required)
Path Parameter — format: int32

Responses

200

Success

CityRouter

Up
post /City/Create
Summary (cityCreatePost)
Add a City and returns the created Entity

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body CityDTO (required)
Body Parameter

Responses

200

Success

Up
delete /City/Delete/{id}
Summary (cityDeleteIdDelete)
Delete the record by its Id

Path parameters

id (required)
Path Parameter

Responses

200

Success

Up
get /City/GetAll
Summary (cityGetAllGet)
Get All Cities delimited by an offset if exists

Query parameters

OffSet (optional)
Query Parameter — format: int32

Responses

200

Success

Up
post /City/GetByDynamicFilter/{Offset}
Summary (cityGetByDynamicFilterOffsetPost)
Get City By Dynamic Filter

Path parameters

Offset (required)
Path Parameter — format: int32

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body FilterModel (required)
Body Parameter

Responses

200

Success

Up
get /City/GetById/{cityId}
Summary (cityGetByIdCityIdGet)
Get City by Id

Path parameters

cityId (required)
Path Parameter

Responses

200

Success

Up
put /City/Update
Summary (cityUpdatePut)
Update a City and returns the created Entity

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body CityDTO (required)
Body Parameter

Responses

200

Success

CizaroMinimalAPI

Up
get /EmployeeTimeClock/GetById/{employeeClockId}
Summary (employeeTimeClockGetByIdEmployeeClockIdGet)
Get employee time clock by Id

Path parameters

employeeClockId (required)
Path Parameter

Responses

200

Success

Up
get /enum/GetAllEnum
Summary (enumGetAllEnumGet)
Returns All Enums in the system

Responses

200

Success

Up
get /enum/GetAllEnumTypes
Summary (enumGetAllEnumTypesGet)
Returns All Enums Types in the system

Responses

200

Success

Up
get /enum/GetEnum/{EnumType}
Summary (enumGetEnumEnumTypeGet)
Returns the Enums filtered by Type

Path parameters

EnumType (required)
Path Parameter

Responses

200

Success

Up
get /Messages/GetAll/{OffSet}
Summary (messagesGetAllOffSetGet)
Returns all system messages, limited by an offset

Path parameters

OffSet (required)
Path Parameter — format: int32

Responses

200

Success

Up
get /Messages/GetByLanguageAndName/{LanguageId}/{MessageName}
Summary (messagesGetByLanguageAndNameLanguageIdMessageNameGet)
Returns a single system message, according to its Id, and a specific language

Path parameters

LanguageId (required)
Path Parameter
MessageName (required)
Path Parameter

Responses

200

Success

Up
get /Messages/GetByLanguage/{LanguageId}
Summary (messagesGetByLanguageLanguageIdGet)
Returns all system messages, filtered by an specific language

Path parameters

LanguageId (required)
Path Parameter

Responses

200

Success

Up
get /orders/Get/{PaymenTypeId}
(ordersGetPaymenTypeIdGet)

Path parameters

PaymenTypeId (required)
Path Parameter

Responses

200

Success

CompanyRouter

Up
get /company/GetAll
Summary (companyGetAllGet)
Returns all Companys in the system

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /company/GetById/{CompanyId}
Summary (companyGetByIdCompanyIdGet)
Returns a single Company accoording to its Id

Path parameters

CompanyId (required)
Path Parameter

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

CountryRouter

Up
post /Country/Create
Summary (countryCreatePost)
Add a Country and returns the created Entity

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body CountryDTO (required)
Body Parameter

Responses

200

Success

Up
delete /Country/Delete/{id}
Summary (countryDeleteIdDelete)
Delete the record by its Id

Path parameters

id (required)
Path Parameter

Responses

200

Success

Up
get /Country/GetAll
Summary (countryGetAllGet)
Get All Countries delimited by an offset if exists

Query parameters

OffSet (optional)
Query Parameter — format: int32

Responses

200

Success

Up
post /Country/GetByDynamicFilter/{Offset}
Summary (countryGetByDynamicFilterOffsetPost)
Get Country By Dynamic Filter

Path parameters

Offset (required)
Path Parameter — format: int32

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body FilterModel (required)
Body Parameter

Responses

200

Success

Up
get /Country/GetById/{countryId}
Summary (countryGetByIdCountryIdGet)
Get Country by Id

Path parameters

countryId (required)
Path Parameter

Responses

200

Success

Up
put /Country/Update
Summary (countryUpdatePut)
Update a Country and returns the updated Entity

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body CountryDTO (required)
Body Parameter

Responses

200

Success

CurrencyTypeRouter

Up
get /currency_type/GetAll/{OffSet}
Summary (currencyTypeGetAllOffSetGet)
Returns all Currency Types, limited by an offset, the optional ShowPicture parameter indicates if the user wants to receive the picture or not, this picture is coded as a base64 string, Currency Type means the set of distinct Bills and Coins used for a specific currency

Path parameters

OffSet (required)
Path Parameter — format: int32

Query parameters

ShowPicture (optional)
Query Parameter — default: false
ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /currency_type/Get/{currencyTypeId}
Summary (currencyTypeGetCurrencyTypeIdGet)
Returns a single Currency Type, according to its Id, the optional ShowPicture parameter indicates if the user wants to receive the picture or not, this picture is coded as a base64 string, Currency Type means the set of distinct Bills and Coins used for a specific currency

Path parameters

currencyTypeId (required)
Path Parameter

Query parameters

ShowPicture (optional)
Query Parameter — default: false
ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

CustomQueryRouter

Up
get /customquery/GetProperties/{TableName}
(customqueryGetPropertiesTableNameGet)

Path parameters

TableName (required)
Path Parameter

Responses

200

Success

Up
get /customquery/GetTables
(customqueryGetTablesGet)

Responses

200

Success

Up
post /customquery/Query2
(customqueryQuery2Post)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body FilterModelTable (required)
Body Parameter

Responses

200

Success

CustomerRouter

Up
post /customer/AddCustomer
Summary (customerAddCustomerPost)
Adds a new customer

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body CustomerRequest (required)
Body Parameter

Responses

200

Success

Up
post /customer/EditCustomer
Summary (customerEditCustomerPost)
Edits a customer

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body CustomerRequest (required)
Body Parameter

Responses

200

Success

Up
get /customer/GetAll
Summary (customerGetAllGet)
Returns all customers

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /customer/GetAll/{OffSet}
Summary (customerGetAllOffSetGet)
Returns all customers, limited by an offset

Path parameters

OffSet (required)
Path Parameter — format: int32

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /customer/GetByName/{name}
Summary (customerGetByNameNameGet)
Returns a single Customer, according to its Name

Path parameters

name (required)
Path Parameter

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /customer/Get/{CustomerId}
Summary (customerGetCustomerIdGet)
Returns a single Customer, according to its Id

Path parameters

CustomerId (required)
Path Parameter

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /customer/GetTypes/{CustomerTypeId}
Summary (customerGetTypesCustomerTypeIdGet)
Returns a single Customer Type, according to its Id

Path parameters

CustomerTypeId (required)
Path Parameter

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

CustomerTypeRouter

Up
get /customer_type/GetAll
Summary (customerTypeGetAllGet)
Returns all Companys in the system

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
post /customer_type/GetbyDynamicFilter/{OffSet}
(customerTypeGetbyDynamicFilterOffSetPost)

Path parameters

OffSet (required)
Path Parameter — format: int32

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body FilterModel (required)
Body Parameter

Responses

200

Success

DashboardLayoutRouter

Up
get /dashboard_layout/GetAll
Summary (dashboardLayoutGetAllGet)
Returns all Companys in the system

Responses

200

Success

Up
get /dashboard_layout/GetById/{DashboardId}
Summary (dashboardLayoutGetByIdDashboardIdGet)
Returns all Companys in the system

Path parameters

DashboardId (required)
Path Parameter

Responses

200

Success

DeliveryOptionRouter

Up
get /delivery_option/GetAll/{OffSet}
Summary (deliveryOptionGetAllOffSetGet)
Returns all delivery options, limited by an offset

Path parameters

OffSet (required)
Path Parameter — format: int32

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /delivery_option/Get/{id}
Summary (deliveryOptionGetIdGet)
Returns a single Delivery Option, according to its Id

Path parameters

id (required)
Path Parameter

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

DocRouter

Up
get /documents/GetAll
Summary (documentsGetAllGet)
Returns all Documents in the system

Responses

200

Success

Up
get /documents/GetById/{DocId}
Summary (documentsGetByIdDocIdGet)
Returns a single Documents in the system

Path parameters

DocId (required)
Path Parameter

Responses

200

Success

DriverRouter

Up
get /driver/GetAllMessages/{driverid}
Summary (driverGetAllMessagesDriveridGet)
Returns all messages, according to the Driver Id

Path parameters

driverid (required)
Path Parameter

Responses

200

Success

Up
get /driver/GetById/{id}
Summary (driverGetByIdIdGet)
Returns a single driver, according to its Id

Path parameters

id (required)
Path Parameter

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /driver/GetByName/{firstname}/{driver_license}
Summary (driverGetByNameFirstnameDriverLicenseGet)
Returns a single driver, filtered by the driver's firstname and the driver license

Path parameters

firstname (required)
Path Parameter
driver_license (required)
Path Parameter

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
post /driver
Summary (driverPost)
Post a new message to a specific driver

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body DriverMessageRequest (required)
Body Parameter

Responses

200

Success

EmployeeRouter

Up
get /employee/GetAll
Summary (employeeGetAllGet)
Returns all Employees

Query parameters

ShowDeleted (optional)
Query Parameter — default: false
ShowPicture (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /employee/GetByBranch/{BranchId}/{OffSet}
Summary (employeeGetByBranchBranchIdOffSetGet)
Returns a list of Employees, filtered branch

Path parameters

BranchId (required)
Path Parameter
OffSet (required)
Path Parameter — format: int32

Query parameters

ShowDeleted (optional)
Query Parameter — default: false
ShowPicture (optional)
Query Parameter — default: false
ShowExtended (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /employee/GetByCredentials/{Email}/{Password}
Summary (employeeGetByCredentialsEmailPasswordGet)
Returns a single Employee, filtered by email and password

Path parameters

Email (required)
Path Parameter
Password (required)
Path Parameter

Query parameters

ShowDeleted (optional)
Query Parameter — default: false
ShowPicture (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /employee/GetByEmail/{Email}
Summary (employeeGetByEmailEmailGet)
Returns a single Employee, filtered by email

Path parameters

Email (required)
Path Parameter

Request headers

Query parameters

ShowDeleted (optional)
Query Parameter — default: false
ShowPicture (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /employee/GetById/{Id}
Summary (employeeGetByIdIdGet)
Returns a single Employee, according to its Id

Path parameters

Id (required)
Path Parameter

Query parameters

ShowDeleted (optional)
Query Parameter — default: false
ShowPicture (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /employee/GetEmployeePhotoById/{EmployeeID}
Summary (employeeGetEmployeePhotoByIdEmployeeIDGet)
Returns the Employee picture, encoded as a base64 string, according to its Id

Path parameters

EmployeeID (required)
Path Parameter

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
post /employee/GetbyDynamicFilter/{OffSet}
(employeeGetbyDynamicFilterOffSetPost)

Path parameters

OffSet (required)
Path Parameter — format: int32

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body FilterModel (required)
Body Parameter

Responses

200

Success

Up
post /employee
(employeePost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body EmployeeResponse (required)
Body Parameter

Responses

200

Success

Up
put /employee
(employeePut)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body EmployeeResponse (required)
Body Parameter

Responses

200

Success

EmployeeShiftRouter

Up
post /EmployeeShift
Summary (employeeShiftPost)
Insert an Time Clock Entry, this endpoint checks the shift entry type of the body parameter.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Responses

200

Success

Up
get /EmployeeShift/Summary
Summary (employeeShiftSummaryGet)
Get the Shifts of determined employee

Query parameters

Employee_id (required)
Query Parameter
dateTime (required)
Query Parameter

Responses

200

Success

EmployeeTimeClockRouter

Up
post /EmployeeTimeClock/AddTimeClock/{EmployeeId}
Summary (employeeTimeClockAddTimeClockEmployeeIdPost)
Add Employee Time Clock and returns the created Entity

Path parameters

EmployeeId (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body EmployeeClockDTO (required)
Body Parameter

Responses

200

Success

Up
put /EmployeeTimeClock/EditTimeClock/{EmployeeId}
Summary (employeeTimeClockEditTimeClockEmployeeIdPut)
Edits Employee Time Clock and returns the edited Entity

Path parameters

EmployeeId (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body EmployeeClockDTO (required)
Body Parameter

Responses

200

Success

Up
get /EmployeeTimeClock/GetAll
Summary (employeeTimeClockGetAllGet)
Get All Time Clock delimited by an offset if exists

Query parameters

OffSet (optional)
Query Parameter — format: int32

Responses

200

Success

Up
post /EmployeeTimeClock/GetByDynamicFilter/{Offset}
Summary (employeeTimeClockGetByDynamicFilterOffsetPost)
Get Employee Time Clock By Dynamic Filter

Path parameters

Offset (required)
Path Parameter — format: int32

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body FilterModel (required)
Body Parameter

Responses

200

Success

Up
get /EmployeeTimeClock/GetByEmployeeId/{EmployeeId}
Summary (employeeTimeClockGetByEmployeeIdEmployeeIdGet)
Get Time Clock By User

Path parameters

EmployeeId (required)
Path Parameter

Responses

200

Success

FleetRouter

Up
get /fleet/GetByDriver/{name}
Summary (fleetGetByDriverNameGet)
Returns the Fleet filtered by Driver Name

Path parameters

name (required)
Path Parameter

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

HardwareRouter

Up
post /hardware/OpenCashTray
(hardwareOpenCashTrayPost)

Responses

200

Success

InitValuesRouter

Up
get /initvalues/GetCurrentBranch
Summary (initvaluesGetCurrentBranchGet)
Get the Branch Id used as global parameter in the API

Responses

200

Success

Up
get /initvalues/GetCurrentCashtray
Summary (initvaluesGetCurrentCashtrayGet)
Get the Cashtray Id used as global parameter in the API

Responses

200

Success

Up
get /initvalues/GetCurrentCompany
Summary (initvaluesGetCurrentCompanyGet)
Get the Company Id used as global parameter in the API

Responses

200

Success

Up
post /initvalues/GetCurrentCustomer/{CustomerId}
Summary (initvaluesGetCurrentCustomerCustomerIdPost)
Set the Customer Id used as global parameter in the API

Path parameters

CustomerId (required)
Path Parameter

Responses

200

Success

Up
get /initvalues/GetCurrentCustomer
Summary (initvaluesGetCurrentCustomerGet)
Get the Customer Id used as global parameter in the API

Responses

200

Success

Up
get /initvalues/GetCurrentEmployee
Summary (initvaluesGetCurrentEmployeeGet)
Get the Employee Id used as global parameter in the API

Responses

200

Success

Up
get /initvalues/GetCurrentInventory
Summary (initvaluesGetCurrentInventoryGet)
Get the Inventory Id used as global parameter in the API

Responses

200

Success

Up
get /initvalues/GetCurrentSalesman
Summary (initvaluesGetCurrentSalesmanGet)
Get the Salesman Id used as global parameter in the API

Responses

200

Success

Up
post /initvalues/GetCurrentSalesman/{SalesmanId}
Summary (initvaluesGetCurrentSalesmanSalesmanIdPost)
Set the Salesman Id used as global parameter in the API

Path parameters

SalesmanId (required)
Path Parameter

Responses

200

Success

Up
get /initvalues/GetCurrentStation
Summary (initvaluesGetCurrentStationGet)
Get the Station Id used as global parameter in the API

Responses

200

Success

Up
post /initvalues/GetCurrentStation/{StationId}
Summary (initvaluesGetCurrentStationStationIdPost)
Set the Station Id used as global parameter in the API

Path parameters

StationId (required)
Path Parameter

Responses

200

Success

Up
get /initvalues/GetCurrentUser
Summary (initvaluesGetCurrentUserGet)
Get the User Id used as global parameter in the API

Responses

200

Success

Up
post /initvalues/SetCurrentBranch/{BranchId}
Summary (initvaluesSetCurrentBranchBranchIdPost)
Set the Branch Id used as global parameter in the API

Path parameters

BranchId (required)
Path Parameter

Responses

200

Success

Up
post /initvalues/SetCurrentCashtray/{CashtrayId}
Summary (initvaluesSetCurrentCashtrayCashtrayIdPost)
Set the Cashtray Id used as global parameter in the API

Path parameters

CashtrayId (required)
Path Parameter

Responses

200

Success

Up
post /initvalues/SetCurrentCompany/{CompanyId}
Summary (initvaluesSetCurrentCompanyCompanyIdPost)
Set the Company Id used as global parameter in the API

Path parameters

CompanyId (required)
Path Parameter

Responses

200

Success

Up
post /initvalues/SetCurrentEmployee/{EmployeeId}
Summary (initvaluesSetCurrentEmployeeEmployeeIdPost)
Set the Employee Id used as global parameter in the API

Path parameters

EmployeeId (required)
Path Parameter

Responses

200

Success

Up
post /initvalues/SetCurrentInventory/{InventoryId}
Summary (initvaluesSetCurrentInventoryInventoryIdPost)
Set the Inventory Id used as global parameter in the API

Path parameters

InventoryId (required)
Path Parameter

Responses

200

Success

Up
post /initvalues/SetCurrentUser/{UserId}
Summary (initvaluesSetCurrentUserUserIdPost)
Set the User Id used as global parameter in the API

Path parameters

UserId (required)
Path Parameter

Responses

200

Success

InventoryCountingRouter

Up
post /inventory_counting/Addline
Summary (inventoryCountingAddlinePost)
Add an specific inventory counting line

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Responses

200

Success

Up
get /inventory_counting/GetLines/{item_id}/{id}
Summary (inventoryCountingGetLinesItemIdIdGet)
Get inventory counting lines, filtered by the parent inventory counting Id, and the line Id

Path parameters

id (required)
Path Parameter
item_id (required)
Path Parameter

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /inventory_counting/Get/{offset}
Summary (inventoryCountingGetOffsetGet)
Get all inventory countings, limited by an offset

Path parameters

offset (required)
Path Parameter — format: int32

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
put /inventory_counting/UpdateInventoryCountingLines/{id}/{qty}/{lot_number}/{reason}
Summary (inventoryCountingUpdateInventoryCountingLinesIdQtyLotNumberReasonPut)
Updates an specific inventory counting line

Path parameters

id (required)
Path Parameter
qty (required)
Path Parameter — format: int32
lot_number (required)
Path Parameter
reason (required)
Path Parameter

Responses

200

Success

InventoryListRouter

Up
get /inventory_list/GetAll/{OffSet}
Summary (inventoryListGetAllOffSetGet)
Get all inventory countings, limited by an offset

Path parameters

OffSet (required)
Path Parameter — format: int32

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
post /inventory_list/GetbyDynamicFilter/{OffSet}
(inventoryListGetbyDynamicFilterOffSetPost)

Path parameters

OffSet (required)
Path Parameter — format: int32

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body FilterModel (required)
Body Parameter

Responses

200

Success

InventoryMovementRouter

Up
post /inventory_movement/Addline
Summary (inventoryMovementAddlinePost)
Add an specific inventory movement line

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body MovementLineRequest (required)
Body Parameter

Responses

200

Success

Up
get /inventory_movement/GetAll/{offset}
Summary (inventoryMovementGetAllOffsetGet)
Add an specific inventory movement

Path parameters

offset (required)
Path Parameter — format: int32

Responses

200

Success

Up
get /inventory_movement/GetById/{id}
(inventoryMovementGetByIdIdGet)

Path parameters

id (required)
Path Parameter

Responses

200

Success

Up
get /inventory_movement/GetLines/{MovementId}
Summary (inventoryMovementGetLinesMovementIdGet)
Get an specific inventory movement, according to its Id

Path parameters

MovementId (required)
Path Parameter

Responses

200

Success

InventoryRouter

Up
put /inventory/Decrease/{id}/{qty}/{lot_no}
Summary (inventoryDecreaseIdQtyLotNoPut)
Decrease a inventory Quantity, filtered by Id

Path parameters

id (required)
Path Parameter
qty (required)
Path Parameter — format: int32
lot_no (required)
Path Parameter

Responses

200

Success

Up
get /inventory/GetAll/{offset}
Summary (inventoryGetAllOffsetGet)
Get All inventory records, limited by an OffSet

Path parameters

offset (required)
Path Parameter — format: int32

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /inventory/GetBalance
(inventoryGetBalanceGet)

Query parameters

item_id (required)
Query Parameter
inventory_list_id (required)
Query Parameter
r_item_matrix_id (required)
Query Parameter
currentBranchID (required)
Query Parameter

Responses

200

Success

Up
get /inventory/GetById/{id}
Summary (inventoryGetByIdIdGet)
Get and specific inventory record, according to its Id

Path parameters

id (required)
Path Parameter

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /inventory/GetbyItem/{value}/{parametertype}
Summary (inventoryGetbyItemValueParametertypeGet)
Get and specific inventory record, according to its Id

Path parameters

value (required)
Path Parameter
parametertype (required)
Path Parameter — format: int32

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
put /inventory/Increase/{id}/{qty}/{lot_no}
Summary (inventoryIncreaseIdQtyLotNoPut)
Increase a inventory Quantity, filtered by Id

Path parameters

id (required)
Path Parameter
qty (required)
Path Parameter — format: int32
lot_no (required)
Path Parameter

Responses

200

Success

ItemCategoryRouter

Up
get /item_categories/GetAllCategories
Summary (itemCategoriesGetAllCategoriesGet)
Get All Item Categories, The optional parameter ShowPicture determines if the associated picture is included or not,The optional parameter ShowOnlyAssigned filters only the categories that has items in it

Query parameters

ShowPicture (optional)
Query Parameter — default: false
ShowOnlyAssigned (optional)
Query Parameter — default: false
ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /item_categories/GetAllCategories/{OffSet}
Summary (itemCategoriesGetAllCategoriesOffSetGet)
Get All Item Categories, limited by an OffSet,The optional parameter ShowPicture determines if the associated picture is included or not,The optional parameter ShowOnlyAssigned filters only the categories that has items in it

Path parameters

OffSet (required)
Path Parameter — format: int32

Query parameters

ShowPicture (optional)
Query Parameter — default: false
ShowOnlyAssigned (optional)
Query Parameter — default: false
ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /item_categories/GetCategoryById/{CategoryId}
Summary (itemCategoriesGetCategoryByIdCategoryIdGet)
Get a Item Category, according to its Id,The optional parameter ShowPicture determines if the associated picture is included or not

Path parameters

CategoryId (required)
Path Parameter

Query parameters

ShowPicture (optional)
Query Parameter — default: false
ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /item_categories/GetCategoryImage/{category_id}
Summary (itemCategoriesGetCategoryImageCategoryIdGet)
Get a Item Category Picture, according to its Id,This response is coded as Base64 string

Path parameters

category_id (required)
Path Parameter

Query parameters

ShowPicture (optional)
Query Parameter — default: false
ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
post /item_categories
(itemCategoriesPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ItemCategoryResponse (required)
Body Parameter

Responses

200

Success

Up
put /item_categories
(itemCategoriesPut)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ItemCategoryResponse (required)
Body Parameter

Responses

200

Success

ItemMatrixRouter

Up
get /item_matrix/GetByItemId/{ItemId}
Summary (itemMatrixGetByItemIdItemIdGet)
Returns all variants according to an Item Id

Path parameters

ItemId (required)
Path Parameter

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /item_matrix/Get/{Value}/{ParameterType}
Summary (itemMatrixGetValueParameterTypeGet)
Returns a variant using a value and a value tipe, where 0 = MATRIX SKU, 1 = MATRIX BARCODE, 2 = MATRUX NAME

Path parameters

Value (required)
Path Parameter
ParameterType (required)
Path Parameter — format: int32

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
post /item_matrix/GetbyDynamicFilter/{OffSet}
(itemMatrixGetbyDynamicFilterOffSetPost)

Path parameters

OffSet (required)
Path Parameter — format: int32

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body FilterModel (required)
Body Parameter

Responses

200

Success

ItemRouter

Up
post /items/AddItem
Summary (itemsAddItemPost)
Adds a new item

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ItemResponse (required)
Body Parameter

Responses

200

Success

Up
post /items/EditItem
Summary (itemsEditItemPost)
Modifies a new item

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ItemResponse (required)
Body Parameter

Responses

200

Success

Up
get /items/GetAllItemDetails
Summary (itemsGetAllItemDetailsGet)
Returns all Items details

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
post /items/GetByDynamicFilter/{OffSet}
(itemsGetByDynamicFilterOffSetPost)

Path parameters

OffSet (required)
Path Parameter — format: int32

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body FilterModel (required)
Body Parameter

Responses

200

Success

Up
get /items/GetByName/{searchValue}
Summary (itemsGetByNameSearchValueGet)
Returns a Item, filtered by its Name, The optional parameter ShowPicture determines if the associated picture is included or not

Path parameters

searchValue (required)
Path Parameter

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /items/Get/{id}
Summary (itemsGetIdGet)
Returns a Item, according to its Id, The optional parameter ShowPicture determines if the associated picture is included or not

Path parameters

id (required)
Path Parameter

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /items/GetImage/{ItemId}
Summary (itemsGetImageItemIdGet)
Returns the Item Picture List, according to its Id

Path parameters

ItemId (required)
Path Parameter

Responses

200

Success

Up
get /items/GetImageStream/{ItemId}
Summary (itemsGetImageStreamItemIdGet)
Returns the Item Picture List, according to its Id

Path parameters

ItemId (required)
Path Parameter

Responses

200

Success

Up
get /items/GetItemCategoryByListID/{ListId}
Summary (itemsGetItemCategoryByListIDListIdGet)
Returns the Item Categories, according to the List Id

Path parameters

ListId (required)
Path Parameter

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /items/GetItemDetail/{value}/{parameterType}
Summary (itemsGetItemDetailValueParameterTypeGet)
Returns a item detail, according to a filter value, the parametertype parameter determines how this filter value will be applied, as follows: 0 applies to the item SKU,1 applies to the item barcode,2 applies to the item PLU,3 applies to the item Name,

Path parameters

value (required)
Path Parameter
parameterType (required)
Path Parameter — format: int32

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /items/GetItemImage/{value}/{parametertype}
Summary (itemsGetItemImageValueParametertypeGet)
Returns a item picture, according to a filter value, the parametertype parameter determines how this filter value will be applied, as follows: 0 applies to the item SKU,1 applies to the item barcode,2 applies to the item PLU,3 applies to the item Name,

Path parameters

value (required)
Path Parameter
parametertype (required)
Path Parameter — format: int32

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /items/GetItemImages/{value}/{parametertype}
Summary (itemsGetItemImagesValueParametertypeGet)
Returns a item picture list, according to a filter value, the parametertype parameter determines how this filter value will be applied, as follows: 0 applies to the item SKU,1 applies to the item barcode,2 applies to the item PLU,3 applies to the item Name,

Path parameters

value (required)
Path Parameter
parametertype (required)
Path Parameter — format: int32

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /items/GetItemInventoryByItemId/{ItemId}
Summary (itemsGetItemInventoryByItemIdItemIdGet)
Returns the Item InventoryRecord, filtered by Item Id

Path parameters

ItemId (required)
Path Parameter

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /items/GetItemsByBarcode/{barcode}
Summary (itemsGetItemsByBarcodeBarcodeGet)
Returns a Item, filtered by its barcode, The optional parameter ShowPicture determines if the associated picture is included or not

Path parameters

barcode (required)
Path Parameter

Query parameters

ShowPicture (optional)
Query Parameter — default: false
ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /items/GetItems
Summary (itemsGetItemsGet)
Returns all Items, The optional parameter ShowPicture determines if the associated picture is included or not,The ShowExtended parameter allows to include metadata related to the query

Query parameters

ShowPicture (optional)
Query Parameter — default: false
ShowDeleted (optional)
Query Parameter — default: false
ShowExtended (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /items/GetItems/{OffSet}
Summary (itemsGetItemsOffSetGet)
Returns all Items, limited by an OffSet, The optional parameter ShowPicture determines if the associated picture is included or not,The ShowExtended parameter allows to include metadata related to the query

Path parameters

OffSet (required)
Path Parameter — format: int32

Query parameters

ShowPicture (optional)
Query Parameter — default: false
ShowExtended (optional)
Query Parameter — default: false
ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /items/SearchItem/{OffSet}/{searchTerm}
Summary (itemsSearchItemOffSetSearchTermGet)
Returns Items, filtered by name as a searchTerm, The optional parameter ShowPicture determines if the associated picture is included or not,The ShowExtended parameter allows to include metadata related to the query

Path parameters

OffSet (required)
Path Parameter — format: int32
searchTerm (required)
Path Parameter

Query parameters

ShowPicture (optional)
Query Parameter — default: false
ShowExtended (optional)
Query Parameter — default: false
ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

LanguageRouter

Up
get /language/GetAll
Summary (languageGetAllGet)
Returns all languages availables

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

LeadRouter

Up
post /lead/Create
Summary (leadCreatePost)
Add a Lead and returns the created Entity

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body LeadDTO (required)
Body Parameter

Responses

200

Success

Up
delete /lead/Delete/{id}
Summary (leadDeleteIdDelete)
Delete the record by its Id

Path parameters

id (required)
Path Parameter

Responses

200

Success

Up
get /lead/GetAll
Summary (leadGetAllGet)
Get All States delimited by an offset if exists

Query parameters

OffSet (optional)
Query Parameter — format: int32

Responses

200

Success

Up
post /lead/GetByDynamicFilter
Summary (leadGetByDynamicFilterPost)
Get Lead By Dynamic Filter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body FilterModel (required)
Body Parameter

Query parameters

Offset (optional)
Query Parameter — format: int32

Responses

200

Success

Up
get /lead/GetByEmployee/{EmployeeId}
Summary (leadGetByEmployeeEmployeeIdGet)
Returns all leads posted by the employee id

Path parameters

EmployeeId (required)
Path Parameter

Responses

200

Success

Up
get /lead/GetById/{leadId}
Summary (leadGetByIdLeadIdGet)
Get Lead by Id

Path parameters

leadId (required)
Path Parameter

Responses

200

Success

Up
post /lead/Update
Summary (leadUpdatePost)
Update a Lead and returns the created Entity

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body LeadDTO (required)
Body Parameter

Responses

200

Success

MatrixAttributesRouter

Up
get /matrix_attributes/GetMatrixAttributes/{OffSet}
(matrixAttributesGetMatrixAttributesOffSetGet)

Path parameters

OffSet (required)
Path Parameter — format: int32

Responses

200

Success

Up
post /matrix_attributes
(matrixAttributesPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body MatrixAttributesResponse (required)
Body Parameter

Responses

200

Success

Up
put /matrix_attributes
(matrixAttributesPut)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body MatrixAttributesResponse (required)
Body Parameter

Responses

200

Success

MeasureRouter

Up
get /measure/GetAll/{OffSet}
Summary (measureGetAllOffSetGet)
Returns all measure units, limited by an offset

Path parameters

OffSet (required)
Path Parameter — format: int32

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /measure/Get/{id}
Summary (measureGetIdGet)
Returns a single measure unit, according to its Id

Path parameters

id (required)
Path Parameter

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

ModifierGroupRouter

Up
get /modifiergroup/GetModifiersGroup/{OffSet}
(modifiergroupGetModifiersGroupOffSetGet)

Path parameters

OffSet (required)
Path Parameter — format: int32

Responses

200

Success

Up
post /modifiergroup
(modifiergroupPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ModifierGroupResponse (required)
Body Parameter

Responses

200

Success

Up
put /modifiergroup
(modifiergroupPut)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ModifierGroupResponse (required)
Body Parameter

Responses

200

Success

ModifierRouter

Up
post /modifiers/AddInfo/{OrderLineId}
(modifiersAddInfoOrderLineIdPost)

Path parameters

OrderLineId (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (required)
Body Parameter

Responses

200

Success

Up
post /modifiers/AddModifier
(modifiersAddModifierPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SaveModifierRequest (required)
Body Parameter

Responses

200

Success

Up
get /modifiers/GetAll
(modifiersGetAllGet)

Responses

200

Success

Up
get /modifiers/GetModifiers/{ItemId}
Summary (modifiersGetModifiersItemIdGet)
Returns all Modifiers groupedm and filtered by a ItemId

Path parameters

ItemId (required)
Path Parameter

Responses

200

Success

Up
get /modifiers/GetModifiers/{OffSet}
(modifiersGetModifiersOffSetGet)

Path parameters

OffSet (required)
Path Parameter — format: int32

Responses

200

Success

Up
post /modifiers
(modifiersPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ModifiersResponse (required)
Body Parameter

Responses

200

Success

Up
put /modifiers
(modifiersPut)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ModifiersResponse (required)
Body Parameter

Responses

200

Success

MoneyTypeRouter

Up
get /money_type/GetAll
Summary (moneyTypeGetAllGet)
Get all currencies in the system

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /money_type/Get/{id}
Summary (moneyTypeGetIdGet)
Get a specific currency, according to its Id

Path parameters

id (required)
Path Parameter

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

OrderNumberHistoryRouter

Up
get /order_number_history/GetAll/{OffSet}
Summary (orderNumberHistoryGetAllOffSetGet)
Get all order number histories, limited by an OffSet

Path parameters

OffSet (required)
Path Parameter — format: int32

Responses

200

Success

Up
get /order_number_history/GetByType/{OrderTypeID}/{OffSet}
Summary (orderNumberHistoryGetByTypeOrderTypeIDOffSetGet)
Get order number history, filtered by document type id, and limited by an OffSet

Path parameters

OrderTypeID (required)
Path Parameter — format: int32
OffSet (required)
Path Parameter — format: int32

Responses

200

Success

OrderNumberRouter

Up
get /order_number/GetAll/{OffSet}
Summary (orderNumberGetAllOffSetGet)
Get all order numbers, limited by an OffSet

Path parameters

OffSet (required)
Path Parameter — format: int32

Responses

200

Success

Up
get /order_number/Get/{BranchId}/{OrderType}
Summary (orderNumberGetBranchIdOrderTypeGet)
Get order number, filtered by branch id and document type Id

Path parameters

BranchId (required)
Path Parameter
OrderType (required)
Path Parameter — format: int32

Responses

200

Success

OrderRouter

Up
post /orders/AddLine
Summary (ordersAddLinePost)
Add a new Order line to an specific order and returns the generated ID for the added Order line

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body OrderLineResponse (required)
Body Parameter

Responses

200

Success

Up
post /orders/AddOrder
Summary (ordersAddOrderPost)
Add a new order to the database, this order object can contain many lines objects as needed

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body OrderResponse (required)
Body Parameter

Responses

200

Success

Up
post /orders/CancelOrder/{OrderId}
Summary (ordersCancelOrderOrderIdPost)
Cancel an specific order

Path parameters

OrderId (required)
Path Parameter

Responses

200

Success

Up
put /orders/EditOrder
Summary (ordersEditOrderPut)
Edits an order in the database, this order object can contain many lines objects as needed

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body OrderResponse (required)
Body Parameter

Responses

200

Success

Up
get /orders/GetAll
Summary (ordersGetAllGet)
Get all orders,The ShowLines optional parameter determines if the order lines are included or not,The ShowPayments optional parameter determines if the payments associated are included or not

Query parameters

ShowLines (optional)
Query Parameter — default: false
ShowPayments (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /orders/GetAll/{OffSet}
Summary (ordersGetAllOffSetGet)
Get all orders, limited by an OffSet,The ShowLines optional parameter determines if the order lines are included or not,The ShowPayments optional parameter determines if the payments associated are included or not

Path parameters

OffSet (required)
Path Parameter — format: int32

Query parameters

ShowLines (optional)
Query Parameter — default: false
ShowPayments (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /orders/GetByBranch/{BranchId}
Summary (ordersGetByBranchBranchIdGet)
Get the orders, filtered by branch,The ShowLines optional parameter determines if the order lines are included or not,The ShowPayments optional parameter determines if the payments associated are included or not

Path parameters

BranchId (required)
Path Parameter

Query parameters

ShowLines (optional)
Query Parameter — default: false
ShowPayments (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /orders/GetByBranch/{BranchId}/{OffSet}
Summary (ordersGetByBranchBranchIdOffSetGet)
Get the orders, filtered by branch and limited by an OffSet,The ShowLines optional parameter determines if the order lines are included or not,The ShowPayments optional parameter determines if the payments associated are included or not

Path parameters

BranchId (required)
Path Parameter
OffSet (required)
Path Parameter — format: int32

Query parameters

ShowLines (optional)
Query Parameter — default: false
ShowPayments (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /orders/GetByDateRange/{OffSet}
Summary (ordersGetByDateRangeOffSetGet)
Get the orders, filtered by date range and limited by an OffSet,The ShowLines optional parameter determines if the order lines are included or not,The ShowPayments optional parameter determines if the payments associated are included or not

Path parameters

OffSet (required)
Path Parameter — format: int32

Query parameters

DateFrom (required)
Query Parameter
DateTo (required)
Query Parameter
ShowLines (optional)
Query Parameter — default: false
ShowPayments (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /orders/GetByEmployee/{SaleEmployeeId}/{OffSet}
Summary (ordersGetByEmployeeSaleEmployeeIdOffSetGet)
Get the orders, filtered by Salesman and limited by an OffSet,The ShowLines optional parameter determines if the order lines are included or not,The ShowPayments optional parameter determines if the payments associated are included or not

Path parameters

SaleEmployeeId (required)
Path Parameter
OffSet (required)
Path Parameter — format: int32

Query parameters

ShowLines (optional)
Query Parameter — default: false
ShowPayments (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /orders/GetById/{Id}
Summary (ordersGetByIdIdGet)
Get a order, according to its Id,The ShowLines optional parameter determines if the order lines are included or not,The ShowPayments optional parameter determines if the payments associated are included or not

Path parameters

Id (required)
Path Parameter

Query parameters

ShowLines (optional)
Query Parameter — default: true
ShowPayments (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /orders/GetByNo/{OrderNo}
Summary (ordersGetByNoOrderNoGet)
Get a order, filtered by Order Number,The ShowLines optional parameter determines if the order lines are included or not,The ShowPayments optional parameter determines if the payments associated are included or not

Path parameters

OrderNo (required)
Path Parameter — format: int32

Query parameters

ShowLines (optional)
Query Parameter — default: false
ShowPayments (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /orders/GetByNumberRange/{OffSet}
Summary (ordersGetByNumberRangeOffSetGet)
Get the orders, filtered by order number range and limited by an OffSet,The ShowLines optional parameter determines if the order lines are included or not,The ShowPayments optional parameter determines if the payments associated are included or not

Path parameters

OffSet (required)
Path Parameter — format: int32

Query parameters

OrderFrom (required)
Query Parameter — format: int32
OrderTo (required)
Query Parameter — format: int32
ShowLines (optional)
Query Parameter — default: false
ShowPayments (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /orders/GetByType/{OrderTypeId}/{OffSet}
Summary (ordersGetByTypeOrderTypeIdOffSetGet)
Get the orders, filtered by order type Id and limited by an OffSet,The ShowLines optional parameter determines if the order lines are included or not,The ShowPayments optional parameter determines if the payments associated are included or not

Path parameters

OrderTypeId (required)
Path Parameter — format: int32
OffSet (required)
Path Parameter — format: int32

Query parameters

ShowLines (optional)
Query Parameter — default: false
ShowPayments (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /orders/GetByUserId/{UserId}/{OffSet}
Summary (ordersGetByUserIdUserIdOffSetGet)
Get the orders, filtered by User Id and limited by an OffSet,The ShowLines optional parameter determines if the order lines are included or not,The ShowPayments optional parameter determines if the payments associated are included or not

Path parameters

UserId (required)
Path Parameter
OffSet (required)
Path Parameter — format: int32

Query parameters

ShowLines (optional)
Query Parameter — default: false
ShowPayments (optional)
Query Parameter — default: false

Responses

200

Success

Up
post /orders/GetLinesbyDynamicFilter/{OffSet}
(ordersGetLinesbyDynamicFilterOffSetPost)

Path parameters

OffSet (required)
Path Parameter — format: int32

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body FilterModel (required)
Body Parameter

Responses

200

Success

Up
post /orders/GetbyDynamicFilter/{OffSet}
(ordersGetbyDynamicFilterOffSetPost)

Path parameters

OffSet (required)
Path Parameter — format: int32

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body FilterModel (required)
Body Parameter

Query parameters

ShowLines (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /orders/RemoveItem
(ordersRemoveItemGet)

Query parameters

OrderLineId (required)
Query Parameter
reason (required)
Query Parameter

Responses

200

Success

Up
put /orders/UpdateOrderStatus
(ordersUpdateOrderStatusPut)

Query parameters

OrderID (required)
Query Parameter
StatusID (required)
Query Parameter — format: int32

Responses

200

Success

PaymentRouter

Up
post /payment/AddOrderToExistingPayment/{paymentId}
(paymentAddOrderToExistingPaymentPaymentIdPost)

Path parameters

paymentId (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body PaymenOrderResponse (required)
Body Parameter

Responses

200

Success

Up
post /payment/AddPayment
(paymentAddPaymentPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body PaymentResponse (required)
Body Parameter

Responses

200

Success

Up
put /payment/EditPayment
(paymentEditPaymentPut)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body PaymentResponse (required)
Body Parameter

Responses

200

Success

Up
get /payment/GetAll
Summary (paymentGetAllGet)
Get All Payments delimited by an offset if exists

Query parameters

OffSet (optional)
Query Parameter — format: int32

Responses

200

Success

Up
get /payment/GetById/{PaymentId}
Summary (paymentGetByIdPaymentIdGet)
Get a specific payment, according to its Id

Path parameters

PaymentId (required)
Path Parameter

Responses

200

Success

Up
get /payment/GetByOrder/{OrderId}
(paymentGetByOrderOrderIdGet)

Path parameters

OrderId (required)
Path Parameter

Responses

200

Success

PaymentTypeRouter

Up
get /paymenttype/GetAll
Summary (paymenttypeGetAllGet)
Get all payment types, the ShowPicture optional parameters determines if the picture is included or not

Query parameters

ShowPicture (optional)
Query Parameter — default: false
ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /paymenttype/GetAll/{OffSet}
Summary (paymenttypeGetAllOffSetGet)
Get all payment types, limited by an OffSet, the ShowPicture optional parameters determines if the picture is included or not

Path parameters

OffSet (required)
Path Parameter — format: int32

Query parameters

ShowPicture (optional)
Query Parameter — default: false
ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /paymenttype/Get/{PaymenTypeId}
Summary (paymenttypeGetPaymenTypeIdGet)
Get a specific payment type, according to its Id, the ShowPicture optional parameters determines if the picture is included or not

Path parameters

PaymenTypeId (required)
Path Parameter

Query parameters

ShowPicture (optional)
Query Parameter — default: false
ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

PositionEntryRouter

Up
get /position_entry/GetAll
Summary (positionEntryGetAllGet)
Get all position entries in the system

Responses

200

Success

Up
get /position_entry/GetByPosition/{PositionId}
Summary (positionEntryGetByPositionPositionIdGet)
Get all position entry, for a single position

Path parameters

PositionId (required)
Path Parameter

Responses

200

Success

Up
get /position_entry/Get/{id}
Summary (positionEntryGetIdGet)
Get a single position entry, according to its Id

Path parameters

id (required)
Path Parameter

Responses

200

Success

Up
get /position_entry/GetLastByPosition/{PositionId}
Summary (positionEntryGetLastByPositionPositionIdGet)
Get the last position entry, for a single position

Path parameters

PositionId (required)
Path Parameter

Responses

200

Success

PositionRouter

Up
post /position/AddPosition
Summary (positionAddPositionPost)
Adds a new position

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body PositionResponse (required)
Body Parameter

Responses

200

Success

Up
post /position/EditPosition
Summary (positionEditPositionPost)
Modifies an existing position

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body PositionResponse (required)
Body Parameter

Responses

200

Success

Up
get /position/GetAllEntries/{OffSet}
Summary (positionGetAllEntriesOffSetGet)
Get all position entries in the system, limited by an offset

Path parameters

OffSet (required)
Path Parameter — format: int32

Responses

200

Success

Up
get /position/GetAll
Summary (positionGetAllGet)
Get all position entries in the system

Query parameters

IncludeType (optional)
Query Parameter — default: false
ShowPicture (optional)
Query Parameter — default: false
ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /position/GetAll/{OffSet}
Summary (positionGetAllOffSetGet)
Get all position entries in the system, limited by an offset

Path parameters

OffSet (required)
Path Parameter — format: int32

Query parameters

IncludeType (optional)
Query Parameter — default: false
ShowPicture (optional)
Query Parameter — default: false
ShowDeleted (optional)
Query Parameter — default: false
ShowExtended (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /position/GetAllTypes/{OffSet}
Summary (positionGetAllTypesOffSetGet)
Get all position types in the system, limited by an offset

Path parameters

OffSet (required)
Path Parameter — format: int32

Query parameters

ShowPicture (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /position/GetAllZones/{OffSet}
Summary (positionGetAllZonesOffSetGet)
Get all position zones in the system, limited by an offset

Path parameters

OffSet (required)
Path Parameter — format: int32

Query parameters

ShowPicture (optional)
Query Parameter — default: false
ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /position/GetByBranch/{BranchId}
Summary (positionGetByBranchBranchIdGet)
Get all position entries in the system

Path parameters

BranchId (required)
Path Parameter

Query parameters

IncludeType (optional)
Query Parameter — default: false
ShowPicture (optional)
Query Parameter — default: false
ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /position/GetById/{PositionId}
Summary (positionGetByIdPositionIdGet)
Get a position, according by its Id

Path parameters

PositionId (required)
Path Parameter

Query parameters

IncludeType (optional)
Query Parameter — default: false
ShowPicture (optional)
Query Parameter — default: false
ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /position/GetByZoneId/{ZoneId}
Summary (positionGetByZoneIdZoneIdGet)
Get a position, according by its Id

Path parameters

ZoneId (required)
Path Parameter

Query parameters

IncludeType (optional)
Query Parameter — default: false
ShowPicture (optional)
Query Parameter — default: false
ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /position/GetDefaultZoneByStationConfigId/{StationConfigId}
Summary (positionGetDefaultZoneByStationConfigIdStationConfigIdGet)
Get the default position zone, according to Station Config Id

Path parameters

StationConfigId (required)
Path Parameter

Query parameters

ShowPicture (optional)
Query Parameter — default: false
ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /position/GetEntriesByPosition/{PositionId}/{OffSet}
Summary (positionGetEntriesByPositionPositionIdOffSetGet)
Get all position entries by a specific position, limited by an offset

Path parameters

PositionId (required)
Path Parameter
OffSet (required)
Path Parameter — format: int32

Responses

200

Success

Up
get /position/GetEntryById/{PositionEntryId}
Summary (positionGetEntryByIdPositionEntryIdGet)
Get all position zones entries in the system, limited by an offset

Path parameters

PositionEntryId (required)
Path Parameter

Responses

200

Success

Up
get /position/GetTypeById/{PositionTypeId}
Summary (positionGetTypeByIdPositionTypeIdGet)
Get a single position type, according to its Id

Path parameters

PositionTypeId (required)
Path Parameter

Query parameters

ShowPicture (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /position/GetZoneByBranchId/{BranchId}
Summary (positionGetZoneByBranchIdBranchIdGet)
Get position zones, filtered by Branch

Path parameters

BranchId (required)
Path Parameter

Query parameters

ShowPicture (optional)
Query Parameter — default: false
ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /position/GetZoneById/{PositionZoneId}
Summary (positionGetZoneByIdPositionZoneIdGet)
Get a position zone, according by its Id

Path parameters

PositionZoneId (required)
Path Parameter

Query parameters

ShowPicture (optional)
Query Parameter — default: false
ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
post /position/SetAvailable/{PositionId}
Summary (positionSetAvailablePositionIdPost)
Set the status in the position as Available, it writes the value of 1 in the database

Path parameters

PositionId (required)
Path Parameter

Responses

200

Success

Up
post /position/SetBusy/{PositionId}/{GuestNo}
Summary (positionSetBusyPositionIdGuestNoPost)
Set the status in the position as Busy, it writes the value of 0 in the database

Path parameters

PositionId (required)
Path Parameter
GuestNo (required)
Path Parameter — format: int32

Responses

200

Success

Up
post /position/SetGuestNo/{PositionId}/{GuestNo}
Summary (positionSetGuestNoPositionIdGuestNoPost)
Set the the Guests Quantity to the position, this requires that the position is busy, it writes the value of 0 in the database

Path parameters

PositionId (required)
Path Parameter
GuestNo (required)
Path Parameter — format: int32

Responses

200

Success

Up
post /position/SetPositionLocation
Summary (positionSetPositionLocationPost)
Update a position location

Query parameters

positionId (required)
Query Parameter
x (required)
Query Parameter
y (required)
Query Parameter

Responses

200

Success

PriceListRouter

Up
get /price/Get
Summary (priceGetGet)
Get all prices list entries in the system

Responses

200

Success

Up
get /price/Get/{id}
Summary (priceGetIdGet)
Get a prices list entry, according to its Id

Path parameters

id (required)
Path Parameter

Responses

200

Success

PriceRouter

Up
get /price/GetAllPriceList
Summary (priceGetAllPriceListGet)
Get all prices list entries in the system

Responses

200

Success

Up
get /price/GetCostPrice/{value}/{parametertype}/{PriceListId}
Summary (priceGetCostPriceValueParametertypePriceListIdGet)
Gets a price entry, filtered by list Id, the parametertype parameter determines how this filter value will be applied, as follows: 0 applies to the item SKU,1 applies to the item barcode,2 applies to the item PLU,3 applies to the item Name,

Path parameters

value (required)
Path Parameter
parametertype (required)
Path Parameter — format: int32
PriceListId (required)
Path Parameter

Responses

200

Success

ProductionOrderRouter

Up
post /production_order/AddProductionOrder
Summary (productionOrderAddProductionOrderPost)
Adds a new Production Order

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ProductionOrderResponse (required)
Body Parameter

Responses

200

Success

Up
put /production_order/EditTax
Summary (productionOrderEditTaxPut)
Modifies a existing Production Order

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ProductionOrderResponse (required)
Body Parameter

Responses

200

Success

Up
get /production_order/GetAll
Summary (productionOrderGetAllGet)
Get all Production Orders in the system

Responses

200

Success

Up
get /production_order/GetAll/{OffSet}
Summary (productionOrderGetAllOffSetGet)
Get all Production Orders in the system, limited by an offset

Path parameters

OffSet (required)
Path Parameter — format: int32

Query parameters

ShowExtended (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /production_order/GetById/{ProductionOrderId}
Summary (productionOrderGetByIdProductionOrderIdGet)
Get a Production Order, according by its Id

Path parameters

ProductionOrderId (required)
Path Parameter

Responses

200

Success

PurchaseOrderRouter

Up
post /purchase_order/AddLine/{PurchaseOrderId}
(purchaseOrderAddLinePurchaseOrderIdPost)

Path parameters

PurchaseOrderId (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Responses

200

Success

Up
post /purchase_order/AddPurchaseOrder
(purchaseOrderAddPurchaseOrderPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body PurchaseOrderResponse (required)
Body Parameter

Responses

200

Success

Up
put /purchase_order/EditPurchaseOrder
(purchaseOrderEditPurchaseOrderPut)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body PurchaseOrderResponse (required)
Body Parameter

Responses

200

Success

Up
get /purchase_order/GetByBranch/{BranchId}/{OffSet}
(purchaseOrderGetByBranchBranchIdOffSetGet)

Path parameters

BranchId (required)
Path Parameter
OffSet (required)
Path Parameter — format: int32

Query parameters

ShowLines (optional)
Query Parameter — default: false

Responses

200

Success

Up
post /purchase_order/GetByDynamicFilter/{OffSet}
(purchaseOrderGetByDynamicFilterOffSetPost)

Path parameters

OffSet (required)
Path Parameter — format: int32

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body FilterModel (required)
Body Parameter

Query parameters

ShowLines (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /purchase_order/GetById/{Id}
(purchaseOrderGetByIdIdGet)

Path parameters

Id (required)
Path Parameter

Query parameters

ShowLines (optional)
Query Parameter — default: false

Responses

200

Success

Up
post /purchase_order/GetLinesByDynamicFilter/{OffSet}
(purchaseOrderGetLinesByDynamicFilterOffSetPost)

Path parameters

OffSet (required)
Path Parameter — format: int32

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body FilterModel (required)
Body Parameter

Responses

200

Success

Up
get /purchase_order/Get/{OffSet}
(purchaseOrderGetOffSetGet)

Path parameters

OffSet (required)
Path Parameter — format: int32

Query parameters

ShowLines (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /purchase_order/RemoveLine
(purchaseOrderRemoveLineGet)

Query parameters

PurchaseOrderLineId (required)
Query Parameter

Responses

200

Success

ReceivingOrderRouter

Up
post /receiving_order/AddLine/{ReceivingOrderId}
(receivingOrderAddLineReceivingOrderIdPost)

Path parameters

ReceivingOrderId (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Responses

200

Success

Up
post /receiving_order/AddReceivingOrder
(receivingOrderAddReceivingOrderPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ReceivingOrderResponse (required)
Body Parameter

Responses

200

Success

Up
post /receiving_order/EditReceivingOrder
(receivingOrderEditReceivingOrderPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ReceivingOrderResponse (required)
Body Parameter

Responses

200

Success

Up
get /receiving_order/GetAll
Summary (receivingOrderGetAllGet)
Get All Receiving Orders

Query parameters

ShowLines (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /receiving_order/GetByBranch/{BranchId}/{OffSet}
(receivingOrderGetByBranchBranchIdOffSetGet)

Path parameters

BranchId (required)
Path Parameter
OffSet (required)
Path Parameter — format: int32

Query parameters

ShowLines (optional)
Query Parameter — default: false

Responses

200

Success

Up
post /receiving_order/GetByDynamicFilter/{OffSet}
(receivingOrderGetByDynamicFilterOffSetPost)

Path parameters

OffSet (required)
Path Parameter — format: int32

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body FilterModel (required)
Body Parameter

Query parameters

ShowLines (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /receiving_order/GetById/{Id}
(receivingOrderGetByIdIdGet)

Path parameters

Id (required)
Path Parameter

Query parameters

ShowLines (optional)
Query Parameter — default: false

Responses

200

Success

Up
post /receiving_order/GetLinesByDynamicFilter/{OffSet}
(receivingOrderGetLinesByDynamicFilterOffSetPost)

Path parameters

OffSet (required)
Path Parameter — format: int32

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body FilterModel (required)
Body Parameter

Responses

200

Success

Up
get /receiving_order/Get/{OffSet}
Summary (receivingOrderGetOffSetGet)
Get All Receiving Orders delimited by an offset if exists

Path parameters

OffSet (required)
Path Parameter — format: int32

Query parameters

ShowLines (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /receiving_order/RemoveLine
(receivingOrderRemoveLineGet)

Query parameters

ReceivingOrderLineId (required)
Query Parameter

Responses

200

Success

ReminderRouter

Up
post /reminder/Add
Summary (reminderAddPost)
Creates a new reminder

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body reminder_tbl (required)
Body Parameter

Responses

200

Success

Up
delete /reminder/DeleteMyReminder/{id}
Summary (reminderDeleteMyReminderIdDelete)
Deletes a specific reminder by Id

Path parameters

id (required)
Path Parameter

Responses

200

Success

Up
get /reminder/GetMyReminders/{EmployeeId}/{OffSet}
Summary (reminderGetMyRemindersEmployeeIdOffSetGet)
Returns all reminders created by a specific employee, limited by an offset

Path parameters

EmployeeId (required)
Path Parameter
OffSet (required)
Path Parameter — format: int32

Responses

200

Success

Up
get /reminder/GetReminderById/{id}
Summary (reminderGetReminderByIdIdGet)
Get a single reminder, according to its Id

Path parameters

id (required)
Path Parameter

Responses

200

Success

Up
get /reminder/GetReminders/{employeeid}/{offset}
Summary (reminderGetRemindersEmployeeidOffsetGet)
Returns all reminders assigned to a specific employee, limited by an offset

Path parameters

employeeid (required)
Path Parameter
offset (required)
Path Parameter — format: int32

Responses

200

Success

Up
put /reminder/MarkReminderAsDone/{id}
Summary (reminderMarkReminderAsDoneIdPut)
Marks a specific reminder as Done

Path parameters

id (required)
Path Parameter

Responses

200

Success

Up
put /reminder/MarkReminderAsRead/{id}
Summary (reminderMarkReminderAsReadIdPut)
Marks a specific reminder as Read

Path parameters

id (required)
Path Parameter

Responses

200

Success

Up
put /reminder
Summary (reminderPut)
Updates a specific reminder by Id

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ReminderUpdateRequest (required)
Body Parameter

Responses

200

Success

ReportLayoutRouter

Up
get /report_layout/GetAll
Summary (reportLayoutGetAllGet)
Returns all Companys in the system

Responses

200

Success

Up
get /report_layout/GetById/{ReportId}
Summary (reportLayoutGetByIdReportIdGet)
Returns all Companys in the system

Path parameters

ReportId (required)
Path Parameter

Responses

200

Success

ReturnOrderRouter

Up
post /return_order/AddLine/{ReturnOrderId}
(returnOrderAddLineReturnOrderIdPost)

Path parameters

ReturnOrderId (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ReturnOrderLineResponse (required)
Body Parameter

Responses

200

Success

Up
post /return_order/AddReturnOrder
(returnOrderAddReturnOrderPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ReturnOrderResponse (required)
Body Parameter

Responses

200

Success

Up
put /return_order/EditReturnOrder
(returnOrderEditReturnOrderPut)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ReturnOrderResponse (required)
Body Parameter

Responses

200

Success

Up
get /return_order/GetAll
Summary (returnOrderGetAllGet)
Get All Return Orders

Query parameters

ShowLines (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /return_order/GetByBranch/{BranchId}/{OffSet}
(returnOrderGetByBranchBranchIdOffSetGet)

Path parameters

BranchId (required)
Path Parameter
OffSet (required)
Path Parameter — format: int32

Query parameters

ShowLines (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /return_order/GetById/{Id}
(returnOrderGetByIdIdGet)

Path parameters

Id (required)
Path Parameter

Query parameters

ShowLines (optional)
Query Parameter — default: false

Responses

200

Success

Up
post /return_order/GetLinesbyDynamicFilter/{OffSet}
(returnOrderGetLinesbyDynamicFilterOffSetPost)

Path parameters

OffSet (required)
Path Parameter — format: int32

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body FilterModel (required)
Body Parameter

Responses

200

Success

Up
get /return_order/Get/{OffSet}
Summary (returnOrderGetOffSetGet)
Get All Return Orders delimited by an offset if exists

Path parameters

OffSet (required)
Path Parameter — format: int32

Query parameters

ShowLines (optional)
Query Parameter — default: false

Responses

200

Success

Up
post /return_order/GetbyDynamicFilter/{OffSet}
(returnOrderGetbyDynamicFilterOffSetPost)

Path parameters

OffSet (required)
Path Parameter — format: int32

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body FilterModel (required)
Body Parameter

Query parameters

ShowLines (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /return_order/RemoveLine
(returnOrderRemoveLineGet)

Query parameters

ReturnOrderLineId (required)
Query Parameter

Responses

200

Success

RoomEntryRouter

Up
get /room_entry/GetAll
Summary (roomEntryGetAllGet)
Gets all Room Entries in the system

Query parameters

id (required)
Query Parameter

Responses

200

Success

Up
get /room_entry/Get/{id}
Summary (roomEntryGetIdGet)
Gets a specific Room Entry, according to its Id

Path parameters

id (required)
Path Parameter

Responses

200

Success

RouteRouter

Up
get /route/GetAll/{OffSet}
Summary (routeGetAllOffSetGet)
Gets all routes in the system, limited by an OffSet

Path parameters

OffSet (required)
Path Parameter — format: int32

Responses

200

Success

SignatureRouter

Up
get /ordersignature/GetByOrderId/{OrderId}
Summary (ordersignatureGetByOrderIdOrderIdGet)
Gets signature picture, filtered by document Id, this value is a encoded base64 string

Path parameters

OrderId (required)
Path Parameter

Responses

200

Success

Up
post /ordersignature
Summary (ordersignaturePost)
Insert a new signature, the value to post must be a encoded as base64 string picture

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body OrderSignatureRequest (required)
Body Parameter

Responses

200

Success

SpreadSheetRouter

Up
get /spreadsheets/GetAll
Summary (spreadsheetsGetAllGet)
Returns all Documents in the system

Responses

200

Success

Up
get /spreadsheets/GetById/{SpreadSheetId}
Summary (spreadsheetsGetByIdSpreadSheetIdGet)
Returns all Documents in the system

Path parameters

SpreadSheetId (required)
Path Parameter

Responses

200

Success

StateRouter

Up
post /State/Create
Summary (stateCreatePost)
Add a State and returns the created Entity

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body StateDTO (required)
Body Parameter

Responses

200

Success

Up
delete /State/Delete/{id}
Summary (stateDeleteIdDelete)
Delete the record by its Id

Path parameters

id (required)
Path Parameter

Responses

200

Success

Up
get /State/GetAll
Summary (stateGetAllGet)
Get All States delimited by an offset if exists

Query parameters

OffSet (optional)
Query Parameter — format: int32

Responses

200

Success

Up
post /State/GetByDynamicFilter/{Offset}
Summary (stateGetByDynamicFilterOffsetPost)
Get State By Dynamic Filter

Path parameters

Offset (required)
Path Parameter — format: int32

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body FilterModel (required)
Body Parameter

Responses

200

Success

Up
get /State/GetById/{stateId}
Summary (stateGetByIdStateIdGet)
Get State by Id

Path parameters

stateId (required)
Path Parameter

Responses

200

Success

Up
put /State/Update
Summary (stateUpdatePut)
Update a State and returns the updated Entity

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body StateDTO (required)
Body Parameter

Responses

200

Success

StationRouter

Up
get /station/GetAll
Summary (stationGetAllGet)
Get all Station Configs

Responses

200

Success

Up
get /station/GetAll/{OffSet}
Summary (stationGetAllOffSetGet)
Get all Station Configs With an OffSet parameter

Path parameters

OffSet (required)
Path Parameter — format: int32

Responses

200

Success

Up
get /station/GetByBranch/{BranchId}/{OffSet}
Summary (stationGetByBranchBranchIdOffSetGet)
Get all Station Configs By BranchId

Path parameters

BranchId (required)
Path Parameter
OffSet (required)
Path Parameter — format: int32

Responses

200

Success

Up
get /station/GetByStationId/{StationId}
Summary (stationGetByStationIdStationIdGet)
Get a Station Config by StationId

Path parameters

StationId (required)
Path Parameter

Responses

200

Success

SupplierRouter

Up
post /supplier
(supplierPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SupplierRequest (required)
Body Parameter

Responses

200

Success

Up
put /supplier
(supplierPut)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SupplierRequest (required)
Body Parameter

Responses

200

Success

TaxRouter

Up
post /tax/Addtax
Summary (taxAddtaxPost)
Adds a new tax

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body TaxResponse (required)
Body Parameter

Responses

200

Success

Up
put /tax/EditTax
Summary (taxEditTaxPut)
Modifies a existing tax

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body TaxResponse (required)
Body Parameter

Responses

200

Success

Up
get /tax/GetAll
Summary (taxGetAllGet)
Get all taxes in the system

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /tax/GetAll/{OffSet}
Summary (taxGetAllOffSetGet)
Get all taxes in the system, limited by an offset

Path parameters

OffSet (required)
Path Parameter — format: int32

Query parameters

ShowDeleted (optional)
Query Parameter — default: false
ShowExtended (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /tax/GetById/{TaxId}
Summary (taxGetByIdTaxIdGet)
Get a tax, according by its Id

Path parameters

TaxId (required)
Path Parameter

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

ToDoRouter

Up
delete /todo/DeleteToDo/{id}
Summary (todoDeleteToDoIdDelete)
Deletes a specific TODO entry

Path parameters

id (required)
Path Parameter

Responses

200

Success

Up
get /todo/GetAll/{offset}
Summary (todoGetAllOffsetGet)
Gets all TODO's entries , limited by an OffSet

Path parameters

offset (required)
Path Parameter — format: int32

Responses

200

Success

Up
get /todo/GetById/{id}
Summary (todoGetByIdIdGet)
Gets the TODO's entries , filtered by employee Id

Path parameters

id (required)
Path Parameter

Responses

200

Success

Up
get /todo/GetReadedById/{id}
Summary (todoGetReadedByIdIdGet)
Gets the readed TODO's entries , filtered by employee Id

Path parameters

id (required)
Path Parameter

Responses

200

Success

Up
put /todo/MarkTodoAsRead/{id}
Summary (todoMarkTodoAsReadIdPut)
Updates a specific TODO entry

Path parameters

id (required)
Path Parameter

Responses

200

Success

UserRouter

Up
get /user/GetAll
Summary (userGetAllGet)
Gets all Users

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /user/GetByEmployeeId/{EmployeeId}
Summary (userGetByEmployeeIdEmployeeIdGet)
Gets a specific User, filtered by Employee Id

Path parameters

EmployeeId (required)
Path Parameter

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /user/GetById/{id}
Summary (userGetByIdIdGet)
Gets a specific User, filtered by User Id

Path parameters

id (required)
Path Parameter

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /user/GetByUserName/{username}
Summary (userGetByUserNameUsernameGet)
Gets a specific User, filtered by UserName

Path parameters

username (required)
Path Parameter

Query parameters

ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
post /user/GetbyDynamicFilter/{OffSet}
(userGetbyDynamicFilterOffSetPost)

Path parameters

OffSet (required)
Path Parameter — format: int32

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body FilterModel (required)
Body Parameter

Responses

200

Success

Up
get /user/LoginBackend
Summary (userLoginBackendGet)
Gets a specific User, filtered by UserName and Password

Query parameters

username (required)
Query Parameter
password (required)
Query Parameter
ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /user/LoginPOS
Summary (userLoginPOSGet)
Gets a specific User, filtered by UserName and Password

Query parameters

username (required)
Query Parameter
password (required)
Query Parameter
ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
get /user/LoginPOSPwd
Summary (userLoginPOSPwdGet)
Gets a specific User, filtered by UserName and Password

Query parameters

password (required)
Query Parameter
ShowDeleted (optional)
Query Parameter — default: false

Responses

200

Success

Up
post /user
(userPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body UserResponse (required)
Body Parameter

Responses

200

Success

Up
put /user
(userPut)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body UserResponse (required)
Body Parameter

Responses

200

Success

VehiclePositionRouter

Up
post /vehicle_position
Summary (vehiclePositionPost)
Inserts a Vehicle Position Entry

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body VehiclePositionRequest (required)
Body Parameter

Responses

200

Success

Up
put /vehicle_position
Summary (vehiclePositionPut)
Updates a Vehicle Position Entry

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body VehiclePositionRequest (required)
Body Parameter

Responses

200

Success

Models

[ Jump to Methods ]

Table of Contents

  1. Assembly
  2. Attribute
  3. AutoCreateOption
  4. CacheBehavior
  5. CallingConventions
  6. CityDTO
  7. ConnectionState
  8. ConstructorInfo
  9. CountryDTO
  10. CustomAttributeData
  11. CustomAttributeNamedArgument
  12. CustomAttributeTypedArgument
  13. CustomerRequest
  14. DBColumn
  15. DBColumnType
  16. DBForeignKey
  17. DBIndex
  18. DBTable
  19. DriverMessageRequest
  20. EmployeeClockDTO
  21. EmployeeResponse
  22. EmployeeShiftUpdateRequest
  23. EventAttributes
  24. EventInfo
  25. FieldAttributes
  26. FieldInfo
  27. FilterCondition
  28. FilterModel
  29. FilterModelTable
  30. GenericParameterAttributes
  31. IComponent
  32. IContainer
  33. ICustomAggregate
  34. ICustomAttributeProvider
  35. ICustomFunctionOperator
  36. IDataLayer
  37. IDbConnection
  38. IObjectLayer
  39. IServiceProvider
  40. ISite
  41. IdentityMapBehavior
  42. IntPtr
  43. IntermediateClassInfo
  44. ItemCategoryResponse
  45. ItemResponse
  46. LayoutKind
  47. LeadDTO
  48. LockingOption
  49. LoginRequest
  50. MapInheritanceType
  51. MatrixAttributesResponse
  52. MemberInfo
  53. MemberTypes
  54. MethodAttributes
  55. MethodBase
  56. MethodImplAttributes
  57. MethodInfo
  58. ModifierGroupResponse
  59. ModifiersResponse
  60. Module
  61. ModuleHandle
  62. MovementLineRequest
  63. NullableBehavior
  64. OptimisticLockingBehavior
  65. OptimisticLockingReadBehavior
  66. OptimisticLockingReadMergeBehavior
  67. OrderLineResponse
  68. OrderResponse
  69. OrderSignatureRequest
  70. ParameterAttributes
  71. ParameterInfo
  72. ParameterRequest
  73. PaymenOrderResponse
  74. PaymentResponse
  75. PositionEntryResponse
  76. PositionResponse
  77. PositionTypeResponse
  78. ProductMenu
  79. ProductionOrderResponse
  80. PropertyAttributes
  81. PropertyInfo
  82. PurchaseOrderLineResponse
  83. PurchaseOrderResponse
  84. ReceivingOrderLineResponse
  85. ReceivingOrderResponse
  86. ReminderUpdateRequest
  87. ReturnOrderLineResponse
  88. ReturnOrderResponse
  89. RuntimeFieldHandle
  90. RuntimeMethodHandle
  91. RuntimeTypeHandle
  92. SaveModifierRequest
  93. SecurityRuleSet
  94. Session
  95. ShiftEntryType
  96. StateDTO
  97. StructLayoutAttribute
  98. SupplierRequest
  99. TaxResponse
  100. TimeSpan
  101. Type
  102. TypeAttributes
  103. TypeInfo
  104. UserResponse
  105. ValueConverter
  106. VehiclePositionRequest
  107. XPClassInfo
  108. XPDictionary
  109. XPMemberInfo
  110. XPObjectType
  111. XPObjectTypesManager
  112. inventory_counting_lines_tbl
  113. reminder_assign_employee_tbl
  114. reminder_tbl

Assembly Up

definedTypes (optional)
exportedTypes (optional)
codeBase (optional)
entryPoint (optional)
fullName (optional)
imageRuntimeVersion (optional)
isDynamic (optional)
location (optional)
reflectionOnly (optional)
isCollectible (optional)
isFullyTrusted (optional)
customAttributes (optional)
escapedCodeBase (optional)
manifestModule (optional)
modules (optional)
globalAssemblyCache (optional)
hostContext (optional)
Long format: int64
securityRuleSet (optional)

Attribute Up

typeId (optional)

AutoCreateOption Up

CacheBehavior Up

CallingConventions Up

CityDTO Up

cityId (optional)
UUID format: uuid
countryId (optional)
UUID format: uuid
name (optional)
zone (optional)
codeZone (optional)
code (optional)
territory (optional)

ConnectionState Up

ConstructorInfo Up

name (optional)
declaringType (optional)
reflectedType (optional)
module (optional)
customAttributes (optional)
isCollectible (optional)
metadataToken (optional)
Integer format: int32
attributes (optional)
methodImplementationFlags (optional)
callingConvention (optional)
isAbstract (optional)
isConstructor (optional)
isFinal (optional)
isHideBySig (optional)
isSpecialName (optional)
isStatic (optional)
isVirtual (optional)
isAssembly (optional)
isFamily (optional)
isFamilyAndAssembly (optional)
isFamilyOrAssembly (optional)
isPrivate (optional)
isPublic (optional)
isConstructedGenericMethod (optional)
isGenericMethod (optional)
isGenericMethodDefinition (optional)
containsGenericParameters (optional)
methodHandle (optional)
isSecurityCritical (optional)
isSecuritySafeCritical (optional)
isSecurityTransparent (optional)
memberType (optional)

CountryDTO Up

countryId (optional)
UUID format: uuid
nationality (optional)
name (optional)
cultureName (optional)
nameIso (optional)
alfaCode (optional)
code (optional)
Integer format: int32

CustomAttributeData Up

attributeType (optional)
constructor (optional)
constructorArguments (optional)
namedArguments (optional)

CustomAttributeNamedArgument Up

memberInfo (optional)
typedValue (optional)
memberName (optional)
isField (optional)

CustomAttributeTypedArgument Up

argumentType (optional)
value (optional)

CustomerRequest Up

customer_id (optional)
UUID format: uuid
title (optional)
bank_name (optional)
bank_account (optional)
firstname (optional)
surname (optional)
address (optional)
state_address (optional)
city_address (optional)
is_company (optional)
postal_code_address (optional)
email (optional)
profession (optional)
contact_homephone (optional)
contact_officephone (optional)
contact_mobilephone (optional)
contact_faxphone (optional)
remark (optional)
home_address (optional)
nationality (optional)
birth_day (optional)
Date format: date-time
gender (optional)
Integer format: int32
customer_type (optional)
UUID format: uuid
is_active (optional)
photo (optional)
username (optional)
password (optional)
custom_fields (optional)

DBColumn Up

DBColumnType Up

DBForeignKey Up

DBIndex Up

DBTable Up

columns (optional)
indexes (optional)
foreignKeys (optional)

DriverMessageRequest Up

driver_id (optional)
UUID format: uuid
entry_type (optional)
Integer format: int32
message (optional)
driver_message_id (optional)
UUID format: uuid

EmployeeClockDTO Up

employee_clock_id (optional)
UUID format: uuid
employee_id (optional)
UUID format: uuid
entry_type (optional)
Integer format: int32
entry_time (optional)
Date format: date-time
shiftDate (optional)
Date format: date-time
employee_message (optional)
totalWorkedHours (optional)
Double format: double
workedHours (optional)
dayHours (optional)
automaticallyEnter (optional)
employee_comments (optional)

EmployeeResponse Up

employeeId (optional)
UUID format: uuid
firstName (optional)
surName (optional)
profession (optional)
address (optional)
contactMobilePhone (optional)
cityAddress (optional)
stateAddress (optional)
email (optional)
password (optional)
photo (optional)
is_active (optional)
custom_fields (optional)

EmployeeShiftUpdateRequest Up

employee_id (optional)
UUID format: uuid
shiftEntryType (optional)
entryTime (optional)
employerMessage (optional)
message (optional)
comments (optional)
automatically_enter (optional)

EventAttributes Up

EventInfo Up

name (optional)
declaringType (optional)
reflectedType (optional)
module (optional)
customAttributes (optional)
isCollectible (optional)
metadataToken (optional)
Integer format: int32
memberType (optional)
attributes (optional)
isSpecialName (optional)
addMethod (optional)
removeMethod (optional)
raiseMethod (optional)
isMulticast (optional)
eventHandlerType (optional)

FieldAttributes Up

FieldInfo Up

name (optional)
declaringType (optional)
reflectedType (optional)
module (optional)
customAttributes (optional)
isCollectible (optional)
metadataToken (optional)
Integer format: int32
memberType (optional)
attributes (optional)
fieldType (optional)
isInitOnly (optional)
isLiteral (optional)
isNotSerialized (optional)
isPinvokeImpl (optional)
isSpecialName (optional)
isStatic (optional)
isAssembly (optional)
isFamily (optional)
isFamilyAndAssembly (optional)
isFamilyOrAssembly (optional)
isPrivate (optional)
isPublic (optional)
isSecurityCritical (optional)
isSecuritySafeCritical (optional)
isSecurityTransparent (optional)
fieldHandle (optional)

FilterCondition Up

fieldName (optional)
operator (optional)
value (optional)
logicalOperator (optional)

FilterModel Up

conditions (optional)

FilterModelTable Up

conditions (optional)
tableName (optional)

GenericParameterAttributes Up

IComponent Up

site (optional)

IContainer Up

components (optional)

ICustomAggregate Up

name (optional)

ICustomAttributeProvider Up

ICustomFunctionOperator Up

name (optional)

IDataLayer Up

connection (optional)
autoCreateOption (optional)
dataLayer (optional)
dictionary (optional)

IDbConnection Up

connectionString (optional)
connectionTimeout (optional)
Integer format: int32
database (optional)
state (optional)

IObjectLayer Up

canLoadCollectionObjects (optional)
objectLayer (optional)
dictionary (optional)

IServiceProvider Up

ISite Up

component (optional)
container (optional)
designMode (optional)
name (optional)

IdentityMapBehavior Up

IntPtr Up

IntermediateClassInfo Up

attributes (optional)
isPersistent (optional)
isVisibleInDesignTime (optional)
members (optional)
trackPropertiesModifications (optional)
optimisticLockingReadBehavior (optional)
optimisticLockFieldName (optional)
optimisticLockFieldInDataLayerName (optional)
optimisticLockingBehavior (optional)
optimisticLockField (optional)
optimisticLockFieldInDataLayer (optional)
nullableBehavior (optional)
tableName (optional)
table (optional)
isAbstract (optional)
keyProperty (optional)
tableMapType (optional)
persistentBaseClass (optional)
idClass (optional)
persistentProperties (optional)
objectProperties (optional)
collectionProperties (optional)
associationListProperties (optional)
dictionary (optional)
hasDescendants (optional)
isObjectLoading (optional)
baseClass (optional)
ownMembers (optional)
fullName (optional)
assemblyName (optional)
classType (optional)
canGetByClassType (optional)

ItemCategoryResponse Up

category_id (optional)
UUID format: uuid
category_name (optional)
parent_category_id (optional)
UUID format: uuid
color (optional)
Integer format: int32
image (optional)
is_active (optional)
custom_fields (optional)

ItemResponse Up

item_id (optional)
UUID format: uuid
name (optional)
price (optional)
Double format: double
description (optional)
pricewithTax (optional)
Double format: double
costwithTax (optional)
Double format: double
cost (optional)
Double format: double
upc_sku (optional)
barcode (optional)
menu_category_id (optional)
UUID format: uuid
item_image (optional)
plu (optional)
tax (optional)
Double format: double
measurement (optional)
Double format: double
quantity_in_a_box (optional)
created_on (optional)
Date format: date-time
created_by (optional)
UUID format: uuid
created_by_name (optional)
updated_on (optional)
Date format: date-time
updated_by (optional)
UUID format: uuid
updated_by_name (optional)
use_matrix (optional)
use_modifiers (optional)
note (optional)
ingredients (optional)
modifiers_number (optional)
Integer format: int32
custom_fields (optional)

LayoutKind Up

LeadDTO Up

leadId (optional)
UUID format: uuid
campaignId (optional)
UUID format: uuid
createdBy (optional)
UUID format: uuid
firstName (optional)
lastName (optional)
address (optional)
phone (optional)
email (optional)
city (optional)
state (optional)
leadStatus (optional)
comment (optional)

LockingOption Up

LoginRequest Up

username (optional)
password (optional)

MapInheritanceType Up

MatrixAttributesResponse Up

matrix_atributes_id (optional)
UUID format: uuid
matrix_atributes_name (optional)
matrix_atributes_type (optional)
price (optional)
Double format: double
code (optional)
percentage (optional)
Double format: double
no (optional)
Integer format: int32
is_active (optional)
no_ecommerce_variant (optional)
photo (optional)

MemberInfo Up

memberType (optional)
declaringType (optional)
reflectedType (optional)
name (optional)
module (optional)
customAttributes (optional)
isCollectible (optional)
metadataToken (optional)
Integer format: int32

MemberTypes Up

MethodAttributes Up

MethodBase Up

memberType (optional)
name (optional)
declaringType (optional)
reflectedType (optional)
module (optional)
customAttributes (optional)
isCollectible (optional)
metadataToken (optional)
Integer format: int32
attributes (optional)
methodImplementationFlags (optional)
callingConvention (optional)
isAbstract (optional)
isConstructor (optional)
isFinal (optional)
isHideBySig (optional)
isSpecialName (optional)
isStatic (optional)
isVirtual (optional)
isAssembly (optional)
isFamily (optional)
isFamilyAndAssembly (optional)
isFamilyOrAssembly (optional)
isPrivate (optional)
isPublic (optional)
isConstructedGenericMethod (optional)
isGenericMethod (optional)
isGenericMethodDefinition (optional)
containsGenericParameters (optional)
methodHandle (optional)
isSecurityCritical (optional)
isSecuritySafeCritical (optional)
isSecurityTransparent (optional)

MethodImplAttributes Up

MethodInfo Up

name (optional)
declaringType (optional)
reflectedType (optional)
module (optional)
customAttributes (optional)
isCollectible (optional)
metadataToken (optional)
Integer format: int32
attributes (optional)
methodImplementationFlags (optional)
callingConvention (optional)
isAbstract (optional)
isConstructor (optional)
isFinal (optional)
isHideBySig (optional)
isSpecialName (optional)
isStatic (optional)
isVirtual (optional)
isAssembly (optional)
isFamily (optional)
isFamilyAndAssembly (optional)
isFamilyOrAssembly (optional)
isPrivate (optional)
isPublic (optional)
isConstructedGenericMethod (optional)
isGenericMethod (optional)
isGenericMethodDefinition (optional)
containsGenericParameters (optional)
methodHandle (optional)
isSecurityCritical (optional)
isSecuritySafeCritical (optional)
isSecurityTransparent (optional)
memberType (optional)
returnParameter (optional)
returnType (optional)
returnTypeCustomAttributes (optional)

ModifierGroupResponse Up

modifier_group_id (optional)
UUID format: uuid
name (optional)
description (optional)
color (optional)
Integer format: int32
unique_option (optional)
is_active (optional)

ModifiersResponse Up

modifier_id (optional)
UUID format: uuid
name (optional)
item_id (optional)
UUID format: uuid
has_price (optional)
amount (optional)
Double format: double
is_percentage (optional)
multiple_option (optional)
multiple_option_unique (optional)
unique_option (optional)
tax_id (optional)
UUID format: uuid
price (optional)
Double format: double
pricewithTax (optional)
Double format: double
vat (optional)
Double format: double
item_quantity (optional)
Double format: double
modifier_group_id (optional)
UUID format: uuid
modifier_group_name (optional)
modifier_group_unique_option (optional)
is_active (optional)
image (optional)
byte[] format: byte
custom_fields (optional)

Module Up

assembly (optional)
fullyQualifiedName (optional)
name (optional)
mdStreamVersion (optional)
Integer format: int32
moduleVersionId (optional)
UUID format: uuid
scopeName (optional)
moduleHandle (optional)
customAttributes (optional)
metadataToken (optional)
Integer format: int32

ModuleHandle Up

mdStreamVersion (optional)
Integer format: int32

MovementLineRequest Up

inventory_movement_lines_id (optional)
UUID format: uuid
inventory_movement_id (optional)
UUID format: uuid
item_name (optional)
item_barcode (optional)
item_id (optional)
UUID format: uuid
sku (optional)
price (optional)
Double format: double
pricewTax (optional)
Double format: double
tax (optional)
Double format: double
matrixCode (optional)
r_item_matrix_id (optional)
UUID format: uuid
matrixCodeName (optional)
lotNO (optional)
comments (optional)
reason_quantity_not_arrived (optional)
actual_quantity (optional)
Integer format: int32
order_status_id (optional)
Integer format: int32

NullableBehavior Up

OptimisticLockingBehavior Up

OptimisticLockingReadBehavior Up

OptimisticLockingReadMergeBehavior Up

OrderLineResponse Up

created_on (optional)
Date format: date-time
order_lines_id (optional)
UUID format: uuid
order_id (optional)
UUID format: uuid
purchase_product_id (optional)
UUID format: uuid
parent_order_line_id (optional)
UUID format: uuid
sort (optional)
Integer format: int32
product_name (optional)
product_description (optional)
quantity (optional)
Double format: double
delivered_quantity (optional)
Double format: double
quantity_received (optional)
Double format: double
refundQty (optional)
Double format: double
refundAmount (optional)
Double format: double
starting_date (optional)
Date format: date-time
end_date (optional)
Date format: date-time
duration (optional)
Integer format: int32
production_status_id (optional)
Integer format: int32
refundUserID (optional)
UUID format: uuid
isCreditnoteRefunded (optional)
cost (optional)
Double format: double
price (optional)
Double format: double
pricewithTax (optional)
Double format: double
minimumPrice (optional)
Double format: double
maximumPrice (optional)
Double format: double
price_id (optional)
UUID format: uuid
has_special_price (optional)
isMixMatch (optional)
mixMatchId (optional)
UUID format: uuid
total (optional)
Double format: double
totalwDisocunt (optional)
Double format: double
vat (optional)
Double format: double
default_price (optional)
Double format: double
tax_id (optional)
UUID format: uuid
sell_inventory_id (optional)
UUID format: uuid
measure_id (optional)
UUID format: uuid
tax (optional)
Double format: double
is_room (optional)
has_vat_discount (optional)
is_info (optional)
inventory_updated (optional)
money_type_id (optional)
UUID format: uuid
is_table (optional)
food_stamp_eligible (optional)
is_cancelled (optional)
is_printed (optional)
is_discount (optional)
is_payment_discount (optional)
customer_split (optional)
void_reason (optional)
serial (optional)
price_change_reason (optional)
delay_minutes (optional)
Integer format: int32
delayed_time (optional)
Date format: date-time
printing_time (optional)
Date format: date-time
is_surcharge (optional)
is_served (optional)
is_modifier (optional)
loyalty_points (optional)
Double format: double
sale_employee_id (optional)
UUID format: uuid
modifier_id (optional)
UUID format: uuid
matrixCode (optional)
r_item_matrix_id (optional)
UUID format: uuid
matrixCodeName (optional)
matrix_sku (optional)
barcode (optional)
position (optional)
sku (optional)
lotNO (optional)
delivery_option_id (optional)
UUID format: uuid
guarantee_days (optional)
Integer format: int32
external_note (optional)
moq (optional)
Double format: double
quantity_in_box (optional)
item_weight (optional)
Double format: double
group_name (optional)
manufacturer (optional)
use_barcode_with_quantity_price (optional)
refundReason (optional)
is_time_based (optional)
mix_match_discount (optional)
mix_match_discount_applied (optional)
UUID format: uuid
mix_match_discount_line_id (optional)
UUID format: uuid
mix_match_applied (optional)
vat1 (optional)
Double format: double
tax_id1 (optional)
UUID format: uuid
tax1 (optional)
Double format: double
vat2 (optional)
Double format: double
tax_id2 (optional)
UUID format: uuid
tax2 (optional)
Double format: double
vat3 (optional)
Double format: double
tax_id3 (optional)
UUID format: uuid
tax3 (optional)
Double format: double
vat4 (optional)
Double format: double
tax_id4 (optional)
UUID format: uuid
tax4 (optional)
Double format: double
tax0 (optional)
Double format: double
custom_fields (optional)

OrderResponse Up

order_id (optional)
UUID format: uuid
order_no (optional)
Integer format: int32
customer_id (optional)
UUID format: uuid
sale_employe_id (optional)
UUID format: uuid
user_id (optional)
UUID format: uuid
order_date (optional)
Date format: date-time
due_date (optional)
Date format: date-time
order_status_id (optional)
Integer format: int32
order_type_id (optional)
Integer format: int32
totalafterallTaxes (optional)
Double format: double
total (optional)
Double format: double
totalwithDiscount (optional)
Double format: double
default_delivery_option_id (optional)
UUID format: uuid
delivery_contact_name (optional)
delivery_phone (optional)
delivery_email (optional)
delivery_address (optional)
delivery_city (optional)
delivery_state (optional)
delivery_branch (optional)
UUID format: uuid
delivery_country (optional)
delivery_temptative_date (optional)
Date format: date-time
online_order_no (optional)
sub_account (optional)
UUID format: uuid
branch_id (optional)
UUID format: uuid
station_id (optional)
UUID format: uuid
is_paid (optional)
additionalInfo (optional)
note (optional)
resolution_no (optional)
invoice_order_no (optional)
Integer format: int32
description (optional)
voidReason (optional)
receipt_no (optional)
Integer format: int32
invoice_date (optional)
Date format: date-time
cancel_order_no (optional)
Double format: double
related_order_Branch_NO (optional)
Double format: double
money_type_id (optional)
UUID format: uuid
is_printed (optional)
inventory_updated (optional)
created_on (optional)
Date format: date-time
lines (optional)
paymentOrders (optional)
orderStatusName (optional)
position_entry_id (optional)
UUID format: uuid
employeeName (optional)
custom_fields (optional)

OrderSignatureRequest Up

orderId (optional)
UUID format: uuid
signature (optional)

ParameterAttributes Up

ParameterInfo Up

attributes (optional)
member (optional)
name (optional)
parameterType (optional)
position (optional)
Integer format: int32
isIn (optional)
isLcid (optional)
isOptional (optional)
isOut (optional)
isRetval (optional)
defaultValue (optional)
rawDefaultValue (optional)
hasDefaultValue (optional)
customAttributes (optional)
metadataToken (optional)
Integer format: int32

ParameterRequest Up

administration_name (optional)
administration_value (optional)
user_id (optional)
UUID format: uuid
branch_id (optional)
UUID format: uuid

PaymenOrderResponse Up

r_payments_orders_id (optional)
UUID format: uuid
payments_id (optional)
UUID format: uuid
order_id (optional)
UUID format: uuid
credit_note_id (optional)
UUID format: uuid
gift_card_id (optional)
UUID format: uuid
cashTray_id (optional)
UUID format: uuid
room_entry_id (optional)
UUID format: uuid
amount (optional)
Double format: double
payed_amount (optional)
Double format: double
is_full_payed (optional)
account_payment (optional)
ecomm_payment_type_id (optional)
UUID format: uuid
status (optional)
Integer format: int32
ecommerce_payment_type_code (optional)
currency_name (optional)
currency_code_name (optional)
credit_balance (optional)
Double format: double
debit_note_id (optional)
UUID format: uuid
payments (optional)

PaymentResponse Up

payments_id (optional)
UUID format: uuid
customer_id (optional)
UUID format: uuid
contract_id (optional)
UUID format: uuid
payments_type_id (optional)
UUID format: uuid
receipt_series (optional)
cashTray (optional)
UUID format: uuid
payment_no (optional)
Integer format: int32
payment_Branch_NO (optional)
Double format: double
refund_NO (optional)
Integer format: int32
order_no (optional)
Integer format: int32
order_Branch_NO (optional)
Double format: double
payment_Value (optional)
Double format: double
date_of_payment (optional)
Date format: date-time
bank_account_id (optional)
UUID format: uuid
couponNO (optional)
couponSecurityNO (optional)
routing_number (optional)
account_number (optional)
checkNumber (optional)
credit_auto_NO (optional)
credit_receipt_NO (optional)
credit_Card_Type (optional)
credit_CardNO (optional)
description (optional)
totalWithTaxes (optional)
Double format: double
totalBeforeTaxes (optional)
Double format: double
receivedAmount (optional)
Double format: double
changes (optional)
Double format: double
inshort (optional)
paid (optional)
installment_NO (optional)
Integer format: int32
payment_status (optional)
Integer format: int32
department_id (optional)
UUID format: uuid
account_id (optional)
UUID format: uuid
money_type_id (optional)
UUID format: uuid
contract_no (optional)
is_confirmed (optional)
confirmation_no (optional)
confirmation_reason (optional)
status (optional)
Integer format: int32
installmentNO (optional)
card_account_type (optional)
deposite_date_payment (optional)
Date format: date-time
paymentOrders (optional)

PositionEntryResponse Up

position_entry_id (optional)
UUID format: uuid
position_parent_entry_id (optional)
UUID format: uuid
registration_no (optional)
voucher_no (optional)
customer_id (optional)
UUID format: uuid
customer_Name (optional)
customer_Phone (optional)
customer_email (optional)
customer_info (optional)
employees (optional)
arrival_time (optional)
Date format: date-time
departure_time (optional)
Date format: date-time
duration (optional)
Integer format: int32
guest_no (optional)
Integer format: int32
child_no (optional)
Integer format: int32
station_id (optional)
UUID format: uuid
total_order (optional)
Double format: double
is_paid (optional)
employee_id (optional)
UUID format: uuid
status (optional)
Integer format: int32
is_arrived (optional)
reservation_status (optional)
Integer format: int32
position_id (optional)
UUID format: uuid
merge_positions_id (optional)
remarks (optional)
cancelation (optional)
room_entry_id (optional)
UUID format: uuid

PositionResponse Up

position_id (optional)
UUID format: uuid
guest_number (optional)
Integer format: int32
position_type_id (optional)
UUID format: uuid
sort_number (optional)
Integer format: int32
position_zone_id (optional)
UUID format: uuid
is_smoking (optional)
remarks (optional)
number (optional)
is_inactive (optional)
inactive_reasons (optional)
allowed_employees (optional)
status_id (optional)
Integer format: int32
status (optional)
color (optional)
Integer format: int32
is_onlayout (optional)
is_active (optional)
x (optional)
Double format: double
locationX (optional)
Double format: double
y (optional)
Double format: double
locationY (optional)
Double format: double
width (optional)
Double format: double
heigth (optional)
Double format: double
positionType (optional)
positionEntry (optional)

PositionTypeResponse Up

position_type_id (optional)
UUID format: uuid
position_type (optional)
color (optional)
Integer format: int32
guest_no (optional)
Integer format: int32
is_active (optional)
image_data (optional)
image_data_busy (optional)

ProductMenu Up

id (optional)
Integer format: int32
item_id (optional)
UUID format: uuid
service_related_item_id (optional)
UUID format: uuid
name (optional)
description (optional)
plu (optional)
upc_sku (optional)
manufacturer (optional)
group_name (optional)
kdsZone (optional)
barcode (optional)
price (optional)
Double format: double
cost (optional)
Double format: double
average_cost (optional)
Double format: double
color (optional)
Integer format: int32
vat (optional)
Double format: double
tax_id (optional)
UUID format: uuid
tax_id_in_cost (optional)
vat1 (optional)
Double format: double
tax_id1 (optional)
UUID format: uuid
tax_id1_in_cost (optional)
vat2 (optional)
Double format: double
tax_id2 (optional)
UUID format: uuid
tax_id2_in_cost (optional)
vat3 (optional)
Double format: double
tax_id3 (optional)
UUID format: uuid
tax_id3_in_cost (optional)
vat4 (optional)
Double format: double
tax_id4 (optional)
UUID format: uuid
tax_id4_in_cost (optional)
pricewithTax (optional)
Double format: double
sellInventory (optional)
UUID format: uuid
item_type (optional)
Integer format: int32
issue_method (optional)
Integer format: int32
product_stage (optional)
Integer format: int32
minimumPricewithTax (optional)
Double format: double
maximumPricewithTax (optional)
Double format: double
costwithTax (optional)
Double format: double
menu_category_id (optional)
UUID format: uuid
default_contact_id (optional)
UUID format: uuid
is_active (optional)
serialNumber (optional)
serial_status (optional)
Integer format: int32
serial_inventory_id (optional)
UUID format: uuid
r_item_serial_id (optional)
UUID format: uuid
category_name (optional)
show_on_POS (optional)
is_service (optional)
time_based_service (optional)
enabledItem (optional)
food_stamp_eligible (optional)
photo (optional)
byte[] format: byte
requires_quantity (optional)
use_serials_inventory (optional)
inventory_measure (optional)
UUID format: uuid
buy_measure (optional)
UUID format: uuid
sell_measure (optional)
UUID format: uuid
inventory_control (optional)
guarantee_days (optional)
Integer format: int32
printerName (optional)
external_note (optional)
note (optional)
loyality_points (optional)
Double format: double
loyality_percent (optional)
Double format: double
use_loyality_percent (optional)
use_lotNoEntry (optional)
use_WMS (optional)
is_loyality_quantity (optional)
stockmax (optional)
Double format: double
stockmin (optional)
Double format: double
inventorySellType (optional)
Integer format: int32
is_compound (optional)
duration_type (optional)
Integer format: int32
duration (optional)
Integer format: int32
maximum_credit (optional)
Double format: double
requiresTransportation (optional)
requiresProduction (optional)
use_matrix (optional)
use_matrix_inventory (optional)
sort (optional)
Double format: double
modifiers_number (optional)
Integer format: int32
userstoSell (optional)
rolestoSell (optional)
fromHour (optional)
toHour (optional)
daystoSell (optional)
subdivision (optional)
Integer format: int32
show_at_order_screen (optional)
updated_on (optional)
Date format: date-time
customer_types (optional)
quantity_in_box (optional)
moq (optional)
Double format: double
item_weight (optional)
Double format: double
use_barcode_with_quantity_price (optional)
reportSelection (optional)
UUID format: uuid
maximum_cost (optional)
Double format: double
minimum_cost (optional)
Double format: double
mix_match_discounts (optional)
mix_match_discountList (optional)
array[UUID] format: uuid

ProductionOrderResponse Up

production_order_id (optional)
UUID format: uuid
bill_material_name (optional)
bill_of_material_id (optional)
UUID format: uuid
finish_item_id (optional)
UUID format: uuid
measure_unit_id (optional)
UUID format: uuid
contract_id (optional)
UUID format: uuid
sale_order_id (optional)
UUID format: uuid
position (optional)
r_inventory_wms_id (optional)
UUID format: uuid
position_scrape (optional)
wms_scrape_position_id (optional)
UUID format: uuid
r_item_matrix_id (optional)
UUID format: uuid
matrix_code_name (optional)
finish_item_name (optional)
destination_inventory_list_id (optional)
UUID format: uuid
scrap_sale_inventory_id (optional)
UUID format: uuid
branch_id (optional)
UUID format: uuid
assembly_id (optional)
UUID format: uuid
description (optional)
comments (optional)
total_cost (optional)
Double format: double
total_cost_with_tax (optional)
Double format: double
total_standard_cost (optional)
Double format: double
modify_by_other_user (optional)
production_start_date (optional)
Date format: date-time
production_finish_date (optional)
Date format: date-time
branch_order_no (optional)
Double format: double
type (optional)
Integer format: int32
order_no (optional)
Integer format: int32
production_no (optional)
Integer format: int32
order_status_id (optional)
Integer format: int32
planned_production_quantity (optional)
Double format: double
bom_quantity (optional)
Double format: double
manufactured_quantity (optional)
Double format: double
manufactured_scraps_quantity (optional)
Double format: double
quality_control_quantity (optional)
Double format: double
quality_control_not_pass_quantity (optional)
Double format: double
finished_production_quantity (optional)
Double format: double
multiplication_quantity (optional)
Double format: double
expiration_date (optional)
Date format: date-time
lot_no (optional)
custom_fields (optional)

PropertyAttributes Up

PropertyInfo Up

name (optional)
declaringType (optional)
reflectedType (optional)
module (optional)
customAttributes (optional)
isCollectible (optional)
metadataToken (optional)
Integer format: int32
memberType (optional)
propertyType (optional)
attributes (optional)
isSpecialName (optional)
canRead (optional)
canWrite (optional)
getMethod (optional)
setMethod (optional)

PurchaseOrderLineResponse Up

purchaseOrderLineId (optional)
UUID format: uuid
purchaseOrderId (optional)
UUID format: uuid
itemId (optional)
UUID format: uuid
itemName (optional)
inventoryListId (optional)
UUID format: uuid
measureUnitId (optional)
UUID format: uuid
measureQuantity (optional)
Double format: double
quantity (optional)
Double format: double
quantityReceived (optional)
Double format: double
isCancelled (optional)
price (optional)
Double format: double
priceWithTax (optional)
Double format: double
defaultPrice (optional)
Double format: double
taxId (optional)
UUID format: uuid
tax (optional)
Double format: double
total (optional)
Double format: double
extendedPrice (optional)
Double format: double
isSupplied (optional)
isDiscount (optional)
orderStatusId (optional)
Integer format: int32
expirationDate (optional)
Date format: date-time
lotNo (optional)
refRoles (optional)
matrixCode (optional)
matrixCodeName (optional)
sellPriceWithTax (optional)
Double format: double
itemBarcode (optional)
vat (optional)
Double format: double
totalReceived (optional)
Double format: double
relatedItemMatrixId (optional)
UUID format: uuid
updateCost (optional)
itemSku (optional)
sort (optional)
Integer format: int32
createdCompanyId (optional)
UUID format: uuid
quantityInABox (optional)
itemWeight (optional)
Double format: double
description (optional)
averageCost (optional)
Double format: double
minimumCost (optional)
Double format: double
maximumCost (optional)
Double format: double
itemCategory (optional)
itemGroup (optional)
price2 (optional)
Double format: double
priceWithTax2 (optional)
Double format: double
total2 (optional)
Double format: double
extendedPrice2 (optional)
Double format: double
itemDescription (optional)
priceAfterAddition (optional)
Double format: double
priceAfterAdditionWithTax (optional)
Double format: double
quantityAccepted (optional)
Double format: double
matrixBarcode (optional)
matrixSku (optional)
tax0 (optional)
Double format: double
vat1 (optional)
Double format: double
taxId1 (optional)
UUID format: uuid
tax1 (optional)
Double format: double
vat2 (optional)
Double format: double
taxId2 (optional)
UUID format: uuid
tax2 (optional)
Double format: double
vat3 (optional)
Double format: double
taxId3 (optional)
UUID format: uuid
tax3 (optional)
Double format: double
vat4 (optional)
Double format: double
taxId4 (optional)
UUID format: uuid
tax4 (optional)
Double format: double
position (optional)
wmsPositionId (optional)
UUID format: uuid

PurchaseOrderResponse Up

purchaseOrderId (optional)
UUID format: uuid
contactId (optional)
UUID format: uuid
date (optional)
Date format: date-time
dueDate (optional)
Date format: date-time
isPaid (optional)
isOpen (optional)
receivingOrderId (optional)
UUID format: uuid
totalOrder (optional)
Double format: double
discounts (optional)
Double format: double
extendedPrice (optional)
Double format: double
totalInWarehouse (optional)
Double format: double
totalOnRoad (optional)
Double format: double
tax (optional)
Double format: double
branchId (optional)
UUID format: uuid
moneyTypeId (optional)
UUID format: uuid
isCancelled (optional)
modifyByOtherUser (optional)
orderSeries (optional)
orderExternalNo (optional)
Integer format: int32
orderNo (optional)
Integer format: int32
poOrderBranchNo (optional)
Double format: double
orderStatusId (optional)
Integer format: int32
accountId (optional)
UUID format: uuid
refRoles (optional)
quoteNo (optional)
Integer format: int32
comments (optional)
additionalTax1 (optional)
Double format: double
additionalTax2 (optional)
Double format: double
additionalTax3 (optional)
Double format: double
paidAmount (optional)
Double format: double
createdCompanyId (optional)
UUID format: uuid
contractId (optional)
UUID format: uuid
exchangeRate (optional)
Double format: double
changeMainPrice (optional)
totalOrder2 (optional)
Double format: double
extendedPrice2 (optional)
Double format: double
tax2 (optional)
Double format: double
additionalTax4 (optional)
Double format: double
additionalTax5 (optional)
Double format: double
additionalTax6 (optional)
Double format: double
itemTax0 (optional)
Double format: double
itemTax1 (optional)
Double format: double
itemTax2 (optional)
Double format: double
itemTax3 (optional)
Double format: double
itemTax4 (optional)
Double format: double
recordNo (optional)
Double format: double
lines (optional)

ReceivingOrderLineResponse Up

receivingOrderLineId (optional)
UUID format: uuid
receivingOrderId (optional)
UUID format: uuid
itemId (optional)
UUID format: uuid
itemName (optional)
inventoryListId (optional)
UUID format: uuid
measureUnitId (optional)
UUID format: uuid
measureQuantity (optional)
Double format: double
quantity (optional)
Double format: double
poQuantity (optional)
Double format: double
price (optional)
Double format: double
priceWithTax (optional)
Double format: double
defaultPrice (optional)
Double format: double
taxId (optional)
UUID format: uuid
tax (optional)
Double format: double
total (optional)
Double format: double
extendedPrice (optional)
Double format: double
isSupplied (optional)
isDiscount (optional)
orderStatusId (optional)
Integer format: int32
purchaseOrderLineId (optional)
UUID format: uuid
expirationDate (optional)
Date format: date-time
lotNo (optional)
refRoles (optional)
transOrderLineId (optional)
UUID format: uuid
matrixCode (optional)
matrixCodeName (optional)
itemBarcode (optional)
sellPriceWithTax (optional)
Double format: double
purchaseOrderNo (optional)
Integer format: int32
vat (optional)
Double format: double
rItemMatrixId (optional)
UUID format: uuid
discountPercentage (optional)
Double format: double
taxExempt (optional)
updateCost (optional)
discountAmount (optional)
Double format: double
totalWithoutDiscount (optional)
Double format: double
sort (optional)
Integer format: int32
itemSku (optional)
priceAfterAddition (optional)
Double format: double
priceAfterAdditionWithTax (optional)
Double format: double
branchId (optional)
UUID format: uuid
createdCompanyId (optional)
UUID format: uuid
quantityInABox (optional)
itemWeight (optional)
Double format: double
averageCost (optional)
Double format: double
minimumCost (optional)
Double format: double
maximumCost (optional)
Double format: double
itemCategory (optional)
itemGroup (optional)
itemDescription (optional)
serial1 (optional)
serial2 (optional)
serial3 (optional)
serial4 (optional)
wmsPosition (optional)
matrixBarcode (optional)
matrixSku (optional)
tax0 (optional)
Double format: double
vat1 (optional)
Double format: double
taxId1 (optional)
UUID format: uuid
tax1 (optional)
Double format: double
vat2 (optional)
Double format: double
taxId2 (optional)
UUID format: uuid
tax2 (optional)
Double format: double
vat3 (optional)
Double format: double
taxId3 (optional)
UUID format: uuid
tax3 (optional)
Double format: double
vat4 (optional)
Double format: double
taxId4 (optional)
UUID format: uuid
tax4 (optional)
Double format: double
rInventoryWmsId (optional)
UUID format: uuid

ReceivingOrderResponse Up

receivingOrderId (optional)
UUID format: uuid
contactId (optional)
UUID format: uuid
date (optional)
Date format: date-time
totalOrder (optional)
Double format: double
discounts (optional)
Double format: double
extendedPrice (optional)
Double format: double
tax (optional)
Double format: double
moneyTypeId (optional)
UUID format: uuid
isCancelled (optional)
modifyByOtherUser (optional)
orderSeries (optional)
orderExternalNo (optional)
orderNo (optional)
Integer format: int32
poOrderNo (optional)
grvorderBranchNo (optional)
Double format: double
orderStatusId (optional)
Integer format: int32
billId (optional)
UUID format: uuid
branchId (optional)
UUID format: uuid
accountId (optional)
UUID format: uuid
driverName (optional)
driverId (optional)
carNo (optional)
managerEmployee (optional)
UUID format: uuid
processEmployee (optional)
UUID format: uuid
refRoles (optional)
dueDate (optional)
Date format: date-time
comments (optional)
poOrderNoString (optional)
additionalTax1 (optional)
Double format: double
additionalTax2 (optional)
Double format: double
additionalTax3 (optional)
Double format: double
paidAmount (optional)
Double format: double
isPaid (optional)
createdCompanyId (optional)
UUID format: uuid
extendedPriceWithDiscount (optional)
Double format: double
additionalTax4 (optional)
Double format: double
additionalTax5 (optional)
Double format: double
additionalTax6 (optional)
Double format: double
itemTax0 (optional)
Double format: double
itemTax1 (optional)
Double format: double
itemTax2 (optional)
Double format: double
itemTax3 (optional)
Double format: double
itemTax4 (optional)
Double format: double
recordNo (optional)
Double format: double
lines (optional)

ReminderUpdateRequest Up

subject (optional)
description (optional)
start (optional)
Date format: date-time
end (optional)
Date format: date-time
priority (optional)
Integer format: int32
reminderid (optional)
UUID format: uuid

ReturnOrderLineResponse Up

returnOrderLineId (optional)
UUID format: uuid
returnOrderId (optional)
UUID format: uuid
receivingOrderId (optional)
UUID format: uuid
itemId (optional)
UUID format: uuid
itemName (optional)
inventoryListId (optional)
UUID format: uuid
measureUnitId (optional)
UUID format: uuid
returnReason (optional)
itemBarcode (optional)
itemSku (optional)
measureQuantity (optional)
Double format: double
matrixCode (optional)
rItemMatrixId (optional)
UUID format: uuid
matrixCodeName (optional)
quantity (optional)
Double format: double
poQuantity (optional)
Double format: double
price (optional)
Double format: double
priceWithTax (optional)
Double format: double
defaultPrice (optional)
Double format: double
taxId (optional)
UUID format: uuid
tax (optional)
Double format: double
total (optional)
Double format: double
extendedPrice (optional)
Double format: double
isSupplied (optional)
orderStatusId (optional)
Integer format: int32
expirationDate (optional)
Date format: date-time
serial (optional)
lotNo (optional)
quantityInABox (optional)
itemWeight (optional)
Double format: double
itemCategory (optional)
itemGroup (optional)
matrixBarcode (optional)
matrixSku (optional)
vat (optional)
Double format: double
tax0 (optional)
Double format: double
vat1 (optional)
Double format: double
taxId1 (optional)
UUID format: uuid
tax1 (optional)
Double format: double
vat2 (optional)
Double format: double
taxId2 (optional)
UUID format: uuid
tax2 (optional)
Double format: double
vat3 (optional)
Double format: double
taxId3 (optional)
UUID format: uuid
tax3 (optional)
Double format: double
vat4 (optional)
Double format: double
taxId4 (optional)
UUID format: uuid
tax4 (optional)
Double format: double

ReturnOrderResponse Up

returnOrderId (optional)
UUID format: uuid
contactId (optional)
UUID format: uuid
date (optional)
Date format: date-time
totalOrder (optional)
Double format: double
discounts (optional)
Double format: double
extendedPrice (optional)
Double format: double
tax (optional)
Double format: double
moneyTypeId (optional)
UUID format: uuid
isCancelled (optional)
modifyByOtherUser (optional)
orderSeries (optional)
orderExternalNo (optional)
debitNoteNo (optional)
Double format: double
debitNoteBranchNo (optional)
Double format: double
poOrderNo (optional)
Integer format: int32
orderNo (optional)
Integer format: int32
returnOrderBranchNo (optional)
Double format: double
orderStatusId (optional)
Integer format: int32
billId (optional)
UUID format: uuid
branchId (optional)
UUID format: uuid
managerEmployee (optional)
UUID format: uuid
processEmployee (optional)
UUID format: uuid
accountId (optional)
UUID format: uuid
driverName (optional)
driverId (optional)
carNo (optional)
comments (optional)
reasonToReturn (optional)
additionalTax1 (optional)
Double format: double
additionalTax2 (optional)
Double format: double
additionalTax3 (optional)
Double format: double
additionalTax4 (optional)
Double format: double
additionalTax5 (optional)
Double format: double
additionalTax6 (optional)
Double format: double
itemTax0 (optional)
Double format: double
itemTax1 (optional)
Double format: double
itemTax2 (optional)
Double format: double
itemTax3 (optional)
Double format: double
itemTax4 (optional)
Double format: double
lines (optional)

RuntimeFieldHandle Up

value (optional)

RuntimeMethodHandle Up

value (optional)

RuntimeTypeHandle Up

value (optional)

SaveModifierRequest Up

modifierId (optional)
UUID format: uuid
orderId (optional)
UUID format: uuid
orderLineId (optional)
UUID format: uuid

SecurityRuleSet Up

Session Up

site (optional)
container (optional)
caseSensitive (optional)
trackPropertiesModifications (optional)
isObjectsLoading (optional)
isObjectsSaving (optional)
isObjectModifiedOnNonPersistentPropertyChange (optional)
objectsSavedInCurrentTransaction (optional)
autoCreateOption (optional)
connection (optional)
connectionString (optional)
lockingOption (optional)
optimisticLockingReadBehavior (optional)
cacheBehavior (optional)
identityMapBehavior (optional)
objectLayer (optional)
dictionary (optional)
isConnected (optional)
typesManager (optional)
inTransaction (optional)
trackingChanges (optional)
dataLayer (optional)
serviceProvider (optional)

ShiftEntryType Up

StateDTO Up

stateId (optional)
UUID format: uuid
countryId (optional)
UUID format: uuid
name (optional)
code (optional)

StructLayoutAttribute Up

typeId (optional)
value (optional)

SupplierRequest Up

contact_id (optional)
UUID format: uuid
contact_no (optional)
Integer format: int32
contact_Branch_NO (optional)
Double format: double
title (optional)
name (optional)
contact_person (optional)
contact_homephone (optional)
contact_officephone (optional)
contact_mobilephone (optional)
contact_faxphone (optional)
address (optional)
remark (optional)
contact_hours (optional)
description (optional)
profession (optional)
website (optional)
email (optional)
groups (optional)
tax_id_number (optional)
tax_exempt_number (optional)
is_active (optional)
is_preferred (optional)
is_supplier (optional)
department_id (optional)
UUID format: uuid
fiscalID (optional)
account_id (optional)
UUID format: uuid
rate (optional)
Integer format: int32
state_address (optional)
city_address (optional)
country_id_address (optional)
UUID format: uuid
postal_code_address (optional)
taxExtempt (optional)
photo (optional)
company_legal_name (optional)
custom_fields (optional)

TaxResponse Up

tax_id (optional)
UUID format: uuid
name (optional)
percent (optional)
Double format: double
vat_id (optional)
Integer format: int32
vat_code (optional)
group (optional)
is_fixed (optional)
is_active (optional)
type (optional)
Integer format: int32
apply_to (optional)
Integer format: int32
tax_bracket (optional)
Double format: double
custom_fields (optional)

TimeSpan Up

ticks (optional)
Long format: int64
days (optional)
Integer format: int32
hours (optional)
Integer format: int32
milliseconds (optional)
Integer format: int32
minutes (optional)
Integer format: int32
seconds (optional)
Integer format: int32
totalDays (optional)
Double format: double
totalHours (optional)
Double format: double
totalMilliseconds (optional)
Double format: double
totalMinutes (optional)
Double format: double
totalSeconds (optional)
Double format: double

Type Up

name (optional)
customAttributes (optional)
isCollectible (optional)
metadataToken (optional)
Integer format: int32
isInterface (optional)
memberType (optional)
namespace (optional)
assemblyQualifiedName (optional)
fullName (optional)
assembly (optional)
module (optional)
isNested (optional)
declaringType (optional)
declaringMethod (optional)
reflectedType (optional)
underlyingSystemType (optional)
isTypeDefinition (optional)
isArray (optional)
isByRef (optional)
isPointer (optional)
isConstructedGenericType (optional)
isGenericParameter (optional)
isGenericTypeParameter (optional)
isGenericMethodParameter (optional)
isGenericType (optional)
isGenericTypeDefinition (optional)
isSZArray (optional)
isVariableBoundArray (optional)
isByRefLike (optional)
hasElementType (optional)
genericTypeArguments (optional)
genericParameterPosition (optional)
Integer format: int32
genericParameterAttributes (optional)
attributes (optional)
isAbstract (optional)
isImport (optional)
isSealed (optional)
isSpecialName (optional)
isClass (optional)
isNestedAssembly (optional)
isNestedFamANDAssem (optional)
isNestedFamily (optional)
isNestedFamORAssem (optional)
isNestedPrivate (optional)
isNestedPublic (optional)
isNotPublic (optional)
isPublic (optional)
isAutoLayout (optional)
isExplicitLayout (optional)
isLayoutSequential (optional)
isAnsiClass (optional)
isAutoClass (optional)
isUnicodeClass (optional)
isCOMObject (optional)
isContextful (optional)
isEnum (optional)
isMarshalByRef (optional)
isPrimitive (optional)
isValueType (optional)
isSignatureType (optional)
isSecurityCritical (optional)
isSecuritySafeCritical (optional)
isSecurityTransparent (optional)
structLayoutAttribute (optional)
typeInitializer (optional)
typeHandle (optional)
guid (optional)
UUID format: uuid
baseType (optional)
isSerializable (optional)
containsGenericParameters (optional)
isVisible (optional)

TypeAttributes Up

TypeInfo Up

name (optional)
customAttributes (optional)
isCollectible (optional)
metadataToken (optional)
Integer format: int32
isInterface (optional)
memberType (optional)
namespace (optional)
assemblyQualifiedName (optional)
fullName (optional)
assembly (optional)
module (optional)
isNested (optional)
declaringType (optional)
declaringMethod (optional)
reflectedType (optional)
underlyingSystemType (optional)
isTypeDefinition (optional)
isArray (optional)
isByRef (optional)
isPointer (optional)
isConstructedGenericType (optional)
isGenericParameter (optional)
isGenericTypeParameter (optional)
isGenericMethodParameter (optional)
isGenericType (optional)
isGenericTypeDefinition (optional)
isSZArray (optional)
isVariableBoundArray (optional)
isByRefLike (optional)
hasElementType (optional)
genericTypeArguments (optional)
genericParameterPosition (optional)
Integer format: int32
genericParameterAttributes (optional)
attributes (optional)
isAbstract (optional)
isImport (optional)
isSealed (optional)
isSpecialName (optional)
isClass (optional)
isNestedAssembly (optional)
isNestedFamANDAssem (optional)
isNestedFamily (optional)
isNestedFamORAssem (optional)
isNestedPrivate (optional)
isNestedPublic (optional)
isNotPublic (optional)
isPublic (optional)
isAutoLayout (optional)
isExplicitLayout (optional)
isLayoutSequential (optional)
isAnsiClass (optional)
isAutoClass (optional)
isUnicodeClass (optional)
isCOMObject (optional)
isContextful (optional)
isEnum (optional)
isMarshalByRef (optional)
isPrimitive (optional)
isValueType (optional)
isSignatureType (optional)
isSecurityCritical (optional)
isSecuritySafeCritical (optional)
isSecurityTransparent (optional)
structLayoutAttribute (optional)
typeInitializer (optional)
typeHandle (optional)
guid (optional)
UUID format: uuid
baseType (optional)
isSerializable (optional)
containsGenericParameters (optional)
isVisible (optional)
genericTypeParameters (optional)
declaredConstructors (optional)
declaredEvents (optional)
declaredFields (optional)
declaredMembers (optional)
declaredMethods (optional)
declaredNestedTypes (optional)
declaredProperties (optional)
implementedInterfaces (optional)

UserResponse Up

user_id (optional)
UUID format: uuid
employee_id (optional)
UUID format: uuid
driver_id (optional)
UUID format: uuid
username (optional)
password (optional)
posPassword (optional)
internal_no (optional)
is_order (optional)
showGridMenu (optional)
cashTrayUser (optional)
showPOSGridMenu (optional)
is_active (optional)
role_id (optional)
UUID format: uuid
language_id (optional)
UUID format: uuid
pos_administrator (optional)
inventory_manager (optional)
backoffice_web_user (optional)
pos_starting_Form (optional)
Integer format: int32
closedForms (optional)
favoritesForms (optional)
branches (optional)
emailAccounts (optional)
dashboardUsername (optional)
dashboardPassword (optional)
useOnlineDashboards (optional)
unique_backoffice (optional)
unique_pos (optional)
unique_order (optional)
implement_privilege (optional)
fingerprint (optional)
fingerprint_length (optional)
Integer format: int32
user_type (optional)
Integer format: int32
date_last_login (optional)
Date format: date-time
date_changed_password (optional)
Date format: date-time
custom_fields (optional)

ValueConverter Up

storageType (optional)

VehiclePositionRequest Up

phone_timestamp (optional)
latitude (optional)
Double format: double
longitude (optional)
Double format: double
direction (optional)
Double format: double
altitude (optional)
Double format: double
speed (optional)
Double format: double
quantity_satellites (optional)
Integer format: int32
battery_percentage (optional)
Double format: double
signal (optional)
Double format: double
is_sos (optional)
internet_timestamp (optional)
fleet_id (optional)
UUID format: uuid
driver_id (optional)
UUID format: uuid
route_id (optional)
UUID format: uuid
status (optional)
vehicle_position_id (optional)
UUID format: uuid

XPClassInfo Up

attributes (optional)
isPersistent (optional)
isVisibleInDesignTime (optional)
members (optional)
trackPropertiesModifications (optional)
optimisticLockingReadBehavior (optional)
optimisticLockFieldName (optional)
optimisticLockFieldInDataLayerName (optional)
optimisticLockingBehavior (optional)
optimisticLockField (optional)
optimisticLockFieldInDataLayer (optional)
nullableBehavior (optional)
fullName (optional)
tableName (optional)
table (optional)
isAbstract (optional)
classType (optional)
canGetByClassType (optional)
keyProperty (optional)
tableMapType (optional)
baseClass (optional)
persistentBaseClass (optional)
idClass (optional)
persistentProperties (optional)
objectProperties (optional)
collectionProperties (optional)
associationListProperties (optional)
dictionary (optional)
ownMembers (optional)
hasDescendants (optional)
assemblyName (optional)
isObjectLoading (optional)

XPDictionary Up

nullableBehavior (optional)
classes (optional)
customFunctionOperators (optional)
customAggregates (optional)

XPMemberInfo Up

attributes (optional)
isPersistent (optional)
isVisibleInDesignTime (optional)
isReadOnly (optional)
isKey (optional)
isAutoGenerate (optional)
isIdentity (optional)
isNullable (optional)
defaultValue (optional)
dbDefaultValue (optional)
isFetchOnly (optional)
subMembers (optional)
isDelayed (optional)
isAliased (optional)
isPublic (optional)
memberType (optional)
converter (optional)
storageType (optional)
mappingField (optional)
mappingFieldSize (optional)
Integer format: int32
mappingFieldDBType (optional)
mappingFieldDBTypeName (optional)
owner (optional)
name (optional)
displayName (optional)
isCollection (optional)
isAssociationList (optional)
isNonAssociationList (optional)
isManyToManyAlias (optional)
collectionElementType (optional)
isAssociation (optional)
isManyToMany (optional)
intermediateClass (optional)
manyToManyRelatedProperty (optional)
referenceType (optional)
isStruct (optional)
isAggregated (optional)
mergeCollisionBehavior (optional)
isOptimisticLockingIgnored (optional)
isExpandableToPersistent (optional)

XPObjectType Up

typeName (optional)
assemblyName (optional)
isValidType (optional)
systemType (optional)
typeClassInfo (optional)

XPObjectTypesManager Up

allTypes (optional)

inventory_counting_lines_tbl Up

classInfo (optional)
session (optional)
isLoading (optional)
isDeleted (optional)
this (optional)
loading (optional)
productItem (optional)
stockmax (optional)
Double format: double
stockmin (optional)
Double format: double
counted_percent (optional)
Double format: double
difference_costwithtax (optional)
Double format: double
difference_cost (optional)
Double format: double
difference_pricewithtax (optional)
Double format: double
difference_price (optional)
Double format: double
updated_branch_id (optional)
UUID format: uuid
created_branch_id (optional)
UUID format: uuid
created_company_id (optional)
UUID format: uuid
updated_by (optional)
UUID format: uuid
updated_on (optional)
Date format: date-time
sync_on (optional)
Date format: date-time
created_by (optional)
UUID format: uuid
ref_branches (optional)
ref_roles (optional)
created_on (optional)
Date format: date-time
inventory_counting_lines_id (optional)
UUID format: uuid
inventory_counting_id (optional)
UUID format: uuid
item_id (optional)
UUID format: uuid
item_name (optional)
barcode (optional)
upc_sku (optional)
buyingMeasure (optional)
inventoryMeasureName (optional)
cost (optional)
Double format: double
costwithtax (optional)
Double format: double
price (optional)
Double format: double
pricewithTax (optional)
Double format: double
description (optional)
reason (optional)
theoretical_quantity (optional)
Double format: double
physical_quantity (optional)
Double format: double
difference_quantity (optional)
Double format: double
matrixCode (optional)
r_item_matrix_id (optional)
UUID format: uuid
matrixCodeName (optional)
position (optional)
lotNO (optional)
serial (optional)
required (optional)
Double format: double
totalQuantity (optional)
Double format: double
inventory_updated (optional)
is_active (optional)
wms_position_id (optional)
UUID format: uuid

reminder_assign_employee_tbl Up

classInfo (optional)
session (optional)
isLoading (optional)
isDeleted (optional)
this (optional)
loading (optional)
updated_branch_id (optional)
UUID format: uuid
created_branch_id (optional)
UUID format: uuid
created_company_id (optional)
UUID format: uuid
updated_by (optional)
UUID format: uuid
updated_on (optional)
Date format: date-time
sync_on (optional)
Date format: date-time
created_by (optional)
UUID format: uuid
ref_branches (optional)
ref_roles (optional)
created_on (optional)
Date format: date-time
reminder_assign_employee_id (optional)
UUID format: uuid
employee_id (optional)
UUID format: uuid
reminder_id (optional)

reminder_tbl Up

classInfo (optional)
session (optional)
isLoading (optional)
isDeleted (optional)
this (optional)
loading (optional)
updated_branch_id (optional)
UUID format: uuid
created_branch_id (optional)
UUID format: uuid
created_company_id (optional)
UUID format: uuid
updated_by (optional)
UUID format: uuid
updated_on (optional)
Date format: date-time
sync_on (optional)
Date format: date-time
created_by (optional)
UUID format: uuid
ref_branches (optional)
ref_roles (optional)
created_on (optional)
Date format: date-time
reminderid (optional)
UUID format: uuid
related_to (optional)
reminder_subject (optional)
reminder_description (optional)
remider_starting_time (optional)
Date format: date-time
remider_ending_time (optional)
Date format: date-time
status (optional)
Integer format: int32
priority (optional)
Integer format: int32
is_each_day (optional)
ref_ids (optional)
reminder_type (optional)
Integer format: int32
is_done (optional)
isReaded (optional)
assigned_email (optional)
sender_email (optional)
department_id (optional)
UUID format: uuid
object_id (optional)
UUID format: uuid
object_name (optional)
reminder_assign_employee_tbls (optional)