Sales | Pos Device
Service to manage entities of type 'PosDevice'.
Overview
| URL | api/{tenantKey}/{orgKey}/salesCore/posDevices | 
| Methods Supported | GET, POST, PUT, DELETE | 
All Operations
This service includes the following operations:
- GET:
 - POST:
 - 
                        PUT:
                        
- PUT Set IsActive PosDevice
 - PUT Set DeviceKey PosDevice
 - PUT Set Description PosDevice
 - PUT Set DeviceToken PosDevice
 - PUT Set Store PosDevice
 - PUT Set DefaultFinancialAccount PosDevice
 - PUT Set LastSynchronization PosDevice
 - PUT Set FinancialAccount PosDevicePMethodsFAccount
 - PUT Set Active PosDeviceInvoiceType
 - PUT Set FiscalDocumentType PosDeviceInvoiceType
 - PUT Set Serie PosDeviceInvoiceType
 - PUT Set Active PosDeviceMemoType
 - PUT Set FiscalDocumentType PosDeviceMemoType
 - PUT Set Serie PosDeviceMemoType
 - PUT Set Active PosDeviceQuotationType
 - PUT Set FiscalDocumentType PosDeviceQuotationType
 - PUT Set Serie PosDeviceQuotationType
 
 - DELETE:
 
All Resources
This service uses the following resources:
- ApiPosDevicePosDeviceInvoiceTypesResource
 - ApiPosDevicePosDeviceMemoTypesResource
 - ApiPosDevicePosDevicePMethodsFAccountsResource
 - ApiPosDevicePosDeviceQuotationTypesResource
 - ApiPosDeviceResource
 - PosDeviceInvoiceTypeResource
 - PosDeviceMemoTypeResource
 - PosDevicePMethodsFAccountResource
 - PosDeviceQuotationTypeResource
 - PosDeviceResource
 
GET PosDevices (odata)
Returns a page of the list of all the entity records available.
The following elements are optional:
| opts | (ODataQueryOptions) OData query option. | 
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:
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:
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:
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:
POST PosDevicePMethodsFAccount
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:
POST Pos Device Invoice Type
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:
POST Pos Device Memo Type
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:
POST Pos Device Quotation Type
Inserts a new 'Pos Device Quotation Type' in the 'Pos Device'.
The following elements are required:
| deviceKey | (string) The POS device's key. | 
| companyKey | (string) The company key. | 
| value | (ApiPosDevicePosDeviceQuotationTypesResource) The ApiPosDevicePosDeviceQuotationTypesResource instance. See ApiPosDevicePosDeviceQuotationTypesResource.  | 
                            
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:
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:
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:
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:
PUT Set Active PosDeviceQuotationType
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:
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:
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:
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:
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:
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:
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:
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:
PUT Set FiscalDocumentType PosDeviceQuotationType
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:
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:
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:
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:
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:
PUT Set Serie PosDeviceQuotationType
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:
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:
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:
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:
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:
DELETE Pos Device Quotation 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:
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:
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:
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. | 
ApiPosDevicePosDeviceQuotationTypesResource
The following elements are required:
| quotationType | (string) Quotation Type. | 
| serie | (string) Serie. | 
The following elements are optional:
| active | (bool) Active. | 
| fiscalDocumentType | (string) Fiscal Document Type. | 
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. | 
| posDeviceQuotationTypes | (List of ApiPosDevicePosDeviceQuotationTypesResource) Pos Device Quotation Types.
									 See ApiPosDevicePosDeviceQuotationTypesResource.  | 
                            
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. | 
PosDeviceQuotationTypeResource
The following elements are required:
| quotationType | (string) Quotation Type. | 
| serie | (string) Serie. | 
The following elements are optional:
| active | (bool) Active. | 
| fiscalDocumentType | (string) Fiscal Document Type. | 
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. | 
| posDeviceQuotationTypes | (List of PosDeviceQuotationTypeResource) Pos Device Quotation Types.
									 See PosDeviceQuotationTypeResource.  |