Sales | Pos Device

Service to manage entities of type 'PosDevice'.

Overview

api/{tenantKey}/{orgKey}/salesCore/posDevices

URL	api/{tenantKey}/{orgKey}/salesCore/posDevices
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiPosDevicePosDeviceInvoiceTypesResource
ApiPosDevicePosDeviceMemoTypesResource
ApiPosDevicePosDevicePMethodsFAccountsResource
ApiPosDeviceResource
PosDeviceInvoiceTypeResource
PosDeviceMemoTypeResource
PosDevicePMethodsFAccountResource
PosDeviceResource

GET Operations

GET PosDevices

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See PosDeviceResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices

GET /salesCore/posDevices

GET PosDevices (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See PosDeviceResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices?page={page}&pageSize={pageSize}

GET /salesCore/posDevices?page={page}&pageSize={pageSize}

GET PosDevice by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See PosDeviceResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{id}

GET /salesCore/posDevices/{id}

GET PosDevice by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
deviceKey	(string) The POS device's key.

Response:

When successful, the response body contains the entity record. See PosDeviceResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{companyKey}/{deviceKey}

GET /salesCore/posDevices/{companyKey}/{deviceKey}

GET Print PosDevice by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{id}/print?template={template}

GET /salesCore/posDevices/{id}/print?template={template}

GET Print PosDevice by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
deviceKey	(string) The POS device's key.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{companyKey}/{deviceKey}/print

GET /salesCore/posDevices/{companyKey}/{deviceKey}/print

GET Original Print PosDeviceOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{id}/printOriginal?template={template}

GET /salesCore/posDevices/{id}/printOriginal?template={template}

GET Original Print PosDevice by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
deviceKey	(string) The POS device's key.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{companyKey}/{deviceKey}/printOriginal

GET /salesCore/posDevices/{companyKey}/{deviceKey}/printOriginal

POST Operations

POST PosDevices

Creates a new entity record.

The following elements are required:

posDeviceResource

(ApiPosDeviceResource) The request body should contain the entity record that should be created.
See ApiPosDeviceResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiPosDeviceResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices

POST /salesCore/posDevices

POST Pos Device

Inserts a new 'PosDevicePMethodsFAccount' in the 'Pos Device'.

The following elements are required:

deviceKey	(string) The POS device's key.
companyKey	(string) The company key.
value	(ApiPosDevicePosDevicePMethodsFAccountsResource) The ApiPosDevicePosDevicePMethodsFAccountsResource instance. See ApiPosDevicePosDevicePMethodsFAccountsResource.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{companyKey}/{deviceKey}/posDevicePMethodsFAccounts

POST /salesCore/posDevices/{companyKey}/{deviceKey}/posDevicePMethodsFAccounts

POST Pos Device

Inserts a new 'Pos Device Invoice Type' in the 'Pos Device'.

The following elements are required:

deviceKey	(string) The POS device's key.
companyKey	(string) The company key.
value	(ApiPosDevicePosDeviceInvoiceTypesResource) The ApiPosDevicePosDeviceInvoiceTypesResource instance. See ApiPosDevicePosDeviceInvoiceTypesResource.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{companyKey}/{deviceKey}/posDeviceInvoiceTypes

POST /salesCore/posDevices/{companyKey}/{deviceKey}/posDeviceInvoiceTypes

POST Pos Device

Inserts a new 'Pos Device Memo Type' in the 'Pos Device'.

The following elements are required:

deviceKey	(string) The POS device's key.
companyKey	(string) The company key.
value	(ApiPosDevicePosDeviceMemoTypesResource) The ApiPosDevicePosDeviceMemoTypesResource instance. See ApiPosDevicePosDeviceMemoTypesResource.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{companyKey}/{deviceKey}/posDeviceMemoTypes

POST /salesCore/posDevices/{companyKey}/{deviceKey}/posDeviceMemoTypes

POST Synchronized

Updates POS Device 'LastSynchronization' date by setting the current system datetime.

The following elements are required:

companyKey	(string) The company where the device is defined.
deviceKey	(string) The device to be updated.

Response:

When successful, the response body is empty.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/synchronized/{companyKey}/{deviceKey}

POST /salesCore/posDevices/synchronized/{companyKey}/{deviceKey}

PUT Operations

PUT Set Active PosDeviceInvoiceType

Updates the value of attribute 'Active' in the specified entity record.

The following elements are required:

deviceKey	(string) The POS device's key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{companyKey}/{deviceKey}/posDeviceInvoiceTypes/{lineId}/active

PUT /salesCore/posDevices/{companyKey}/{deviceKey}/posDeviceInvoiceTypes/{lineId}/active

PUT Set Active PosDeviceMemoType

Updates the value of attribute 'Active' in the specified entity record.

The following elements are required:

deviceKey	(string) The POS device's key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{companyKey}/{deviceKey}/posDeviceMemoTypes/{lineId}/active

PUT /salesCore/posDevices/{companyKey}/{deviceKey}/posDeviceMemoTypes/{lineId}/active

PUT Set DefaultFinancialAccount PosDevice

Updates the value of attribute 'DefaultFinancialAccount' in the specified entity record.

The following elements are required:

deviceKey	(string) The POS device's key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{companyKey}/{deviceKey}/defaultFinancialAccount

PUT /salesCore/posDevices/{companyKey}/{deviceKey}/defaultFinancialAccount

PUT Set Description PosDevice

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

deviceKey	(string) The POS device's key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{companyKey}/{deviceKey}/description

PUT /salesCore/posDevices/{companyKey}/{deviceKey}/description

PUT Set DeviceKey PosDevice

Updates the value of attribute 'DeviceKey' in the specified entity record.

The following elements are required:

deviceKey	(string) The POS device's key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{companyKey}/{deviceKey}/deviceKey

PUT /salesCore/posDevices/{companyKey}/{deviceKey}/deviceKey

PUT Set DeviceToken PosDevice

Updates the value of attribute 'DeviceToken' in the specified entity record.

The following elements are required:

deviceKey	(string) The POS device's key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{companyKey}/{deviceKey}/deviceToken

PUT /salesCore/posDevices/{companyKey}/{deviceKey}/deviceToken

PUT Set FinancialAccount PosDevicePMethodsFAccount

Updates the value of attribute 'FinancialAccount' in the specified entity record.

The following elements are required:

deviceKey	(string) The POS device's key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{companyKey}/{deviceKey}/posDevicePMethodsFAccounts/{lineId}/financialAccount

PUT /salesCore/posDevices/{companyKey}/{deviceKey}/posDevicePMethodsFAccounts/{lineId}/financialAccount

PUT Set FiscalDocumentType PosDeviceInvoiceType

Updates the value of attribute 'FiscalDocumentType' in the specified entity record.

The following elements are required:

deviceKey	(string) The POS device's key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{companyKey}/{deviceKey}/posDeviceInvoiceTypes/{lineId}/fiscalDocumentType

PUT /salesCore/posDevices/{companyKey}/{deviceKey}/posDeviceInvoiceTypes/{lineId}/fiscalDocumentType

PUT Set FiscalDocumentType PosDeviceMemoType

Updates the value of attribute 'FiscalDocumentType' in the specified entity record.

The following elements are required:

deviceKey	(string) The POS device's key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{companyKey}/{deviceKey}/posDeviceMemoTypes/{lineId}/fiscalDocumentType

PUT /salesCore/posDevices/{companyKey}/{deviceKey}/posDeviceMemoTypes/{lineId}/fiscalDocumentType

PUT Set IsActive PosDevice

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

deviceKey	(string) The POS device's key.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{companyKey}/{deviceKey}/isActive

PUT /salesCore/posDevices/{companyKey}/{deviceKey}/isActive

PUT Set LastSynchronization PosDevice

Updates the value of attribute 'LastSynchronization' in the specified entity record.

The following elements are required:

deviceKey	(string) The POS device's key.
companyKey	(string) The company key.
value	(DateTimeOffset) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{companyKey}/{deviceKey}/lastSynchronization

PUT /salesCore/posDevices/{companyKey}/{deviceKey}/lastSynchronization

PUT Set Serie PosDeviceInvoiceType

Updates the value of attribute 'Serie' in the specified entity record.

The following elements are required:

deviceKey	(string) The POS device's key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{companyKey}/{deviceKey}/posDeviceInvoiceTypes/{lineId}/serie

PUT /salesCore/posDevices/{companyKey}/{deviceKey}/posDeviceInvoiceTypes/{lineId}/serie

PUT Set Serie PosDeviceMemoType

Updates the value of attribute 'Serie' in the specified entity record.

The following elements are required:

deviceKey	(string) The POS device's key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{companyKey}/{deviceKey}/posDeviceMemoTypes/{lineId}/serie

PUT /salesCore/posDevices/{companyKey}/{deviceKey}/posDeviceMemoTypes/{lineId}/serie

PUT Set Store PosDevice

Updates the value of attribute 'Store' in the specified entity record.

The following elements are required:

deviceKey	(string) The POS device's key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{companyKey}/{deviceKey}/store

PUT /salesCore/posDevices/{companyKey}/{deviceKey}/store

DELETE Operations

DELETE PosDevicePMethodsFAccount by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

deviceKey	(string) The POS device's key.
companyKey	(string) The company key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{companyKey}/{deviceKey}/posDevicePMethodsFAccounts/{lineId}

DELETE /salesCore/posDevices/{companyKey}/{deviceKey}/posDevicePMethodsFAccounts/{lineId}

DELETE Pos Device Invoice Type by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

deviceKey	(string) The POS device's key.
companyKey	(string) The company key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{companyKey}/{deviceKey}/posDeviceInvoiceTypes/{lineId}

DELETE /salesCore/posDevices/{companyKey}/{deviceKey}/posDeviceInvoiceTypes/{lineId}

DELETE Pos Device Memo Type by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

deviceKey	(string) The POS device's key.
companyKey	(string) The company key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{companyKey}/{deviceKey}/posDeviceMemoTypes/{lineId}

DELETE /salesCore/posDevices/{companyKey}/{deviceKey}/posDeviceMemoTypes/{lineId}

DELETE PosDevice by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{id}

DELETE /salesCore/posDevices/{id}

DELETE PosDevice by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
deviceKey	(string) The POS device's key.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/posDevices/{companyKey}/{deviceKey}

DELETE /salesCore/posDevices/{companyKey}/{deviceKey}

Resources

ApiPosDevicePosDeviceInvoiceTypesResource

The following elements are required:

invoiceType	(string) Invoice Type.
serie	(string) Serie.

The following elements are optional:

active	(bool) Active.
fiscalDocumentType	(string) Fiscal Document Type.

ApiPosDevicePosDeviceMemoTypesResource

The following elements are required:

memoType	(string) Memo Type.
serie	(string) Serie.

The following elements are optional:

active	(bool) Active.
fiscalDocumentType	(string) Fiscal Document Type.

ApiPosDevicePosDevicePMethodsFAccountsResource

The following elements are required:

paymentMethod	(string) Payment Method.
financialAccount	(string) Financial Account.

ApiPosDeviceResource

The following elements are required:

company	(string) The POS device's type company. The company's code is the central organizational unit within the system.
deviceKey	(string) The POS device's key.
description	(string) The POS device's description.
deviceToken	(string) The POS device's token.
store	(string) The POS device's store.
defaultFinancialAccount	(string) The POS device's default financial account.

The following elements are optional:

posDevicePMethodsFAccounts	(List of ApiPosDevicePosDevicePMethodsFAccountsResource) Pos Device P Methods F Accounts. See ApiPosDevicePosDevicePMethodsFAccountsResource.
posDeviceInvoiceTypes	(List of ApiPosDevicePosDeviceInvoiceTypesResource) Pos Device Invoice Types. See ApiPosDevicePosDeviceInvoiceTypesResource.
posDeviceMemoTypes	(List of ApiPosDevicePosDeviceMemoTypesResource) Pos Device Memo Types. See ApiPosDevicePosDeviceMemoTypesResource.
lastSynchronization	(DateTimeOffset) The last Sincronization datetime. Managed by the integrator application.

PosDeviceInvoiceTypeResource

The following elements are required:

invoiceType	(string) Invoice Type.
serie	(string) Serie.

The following elements are optional:

active	(bool) Active.
fiscalDocumentType	(string) Fiscal Document Type.

PosDeviceMemoTypeResource

The following elements are required:

memoType	(string) Memo Type.
serie	(string) Serie.

The following elements are optional:

active	(bool) Active.
fiscalDocumentType	(string) Fiscal Document Type.

PosDevicePMethodsFAccountResource

The following elements are required:

paymentMethod	(string) Payment Method.
financialAccount	(string) Financial Account.

PosDeviceResource

The following elements are required:

company	(string) The POS device's type company. The company's code is the central organizational unit within the system.
deviceKey	(string) The POS device's key.
description	(string) The POS device's description.
deviceToken	(string) The POS device's token.
store	(string) The POS device's store.
defaultFinancialAccount	(string) The POS device's default financial account.

The following elements are optional:

posDevicePMethodsFAccounts	(List of PosDevicePMethodsFAccountResource) Pos Device P Methods F Accounts. See PosDevicePMethodsFAccountResource.
posDeviceInvoiceTypes	(List of PosDeviceInvoiceTypeResource) Pos Device Invoice Types. See PosDeviceInvoiceTypeResource.
posDeviceMemoTypes	(List of PosDeviceMemoTypeResource) Pos Device Memo Types. See PosDeviceMemoTypeResource.
lastSynchronization	(DateTimeOffset) The last Sincronization datetime. Managed by the integrator application.