Server for POS

Errors ¶

500 - InternalServerErrorJsonException

When server can not understand what is happening. See "details" field for more info. It contains field "message" with text description.

410 - OutdatedVersionJsonException

Informs user that api doesn't work anymore. The app should be updated to newest version asap! No additional details provided.

501 - NotImplementedJsonException

Thrown by any method but make sense to catch for. Happens usually for local servers: when android device is up to date, but server is not. No additional details provided.

404 - NotFoundJsonException

When requested resource wasn't found.

409 - VersionConflictJsonException

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

400 - InvalidETagFormatJsonException

Occurs when provided ETag format is not a quoted string with version inside.

401 - UnauthorizedJsonException

Dropped by server when user tries access resource without any authentications.

400 - MessageNotReadableJsonException

When sent JSON is failed to parse. Message is not human-readable and intended solely to give all required information to developer.

400 - HttpHeaderMissingJsonException

If request param doesn't contain required http header.

400 - RequestParameterMissingJsonException

If request parameter was missed.

400 - TypeMismatchJsonException

When some entity fails during type conversion. For example, passed String as query param is not convertible to Date.

405 - RequestMethodNotSupportedJsonException

Occurs on wrong API usage. For instance, when method GET is not supported by specified URL.

403 - ForbiddenJsonException

When service returns 403 HTTP status name.
For instance if one seller is trying to access data of another seller. Or seller is trying to reach data available for admins only. Or trying to reach public data for non-public seller.
When trying to get user info, while the authentication is by seller role.
No additional details provided.

All possible error codes are listed below.

INSUFFICIENT_ACCESS_RIGHTS - It is most used code, which covers cases when credentials is not sufficient to perform request or, for example, on attempt to get non-public data.
ACTIVATION_CLOSED_ALREADY - If activation in credentials is closed already. I.e. it is in the CLOSED state.
ACTIVATION_STILL_ISSUED - If activation in credentials is not activated. I.e. it is in the ISSUED state.
ACTIVATION_NO_FEATURE - If activation doesn't have required feature. I.e. it is in the {@link com.srv4pos.server.api.activation.Feature} state.
SELLER_NOT_FOUND - If there is credentials and seller with given country and corporate id is not registered. If caught, you should register yourself on the server.
WRONG_ACTIVATION_PERIOD - If either activation's period haven't started yet or has expired already.
WRONG_USERNAME_OR_PASSWORD - If either username or password failed to pass authorization. User should get "Please contact sales@srv4pos.com if this error appears longer than 24h".
AUTHORIZATION_DATA_IS_NOT_VALID - When auth data doesn't pass verification. For example, if username is empty.
INCOMPATIBILITY_OF_SESSION_ID - When passed session id hasn't passed verification.
CU_ARE_NOT_MANAGEABLE_BY_SVA - When software vendor isn't able to manage CU.
REGISTRATION_IS_NOT_THINKASSAN - When used registration is not thinkassan but needs to be.
EMAIL_IS_NOT_FREE - When attempt to send a free email on non-free address.
SELLER_IS_NOT_PUBLIC - When requested seller is not public.
OLD_PASSWORD_IS_INCORRECT - When verification on old password failed during password change operation.

503 - ServiceUnavailableJsonException

Dropped by the server if server is off (for instance server is restarting or in a service mode) or not ready.

All possible error codes are listed below.

SERVER_IS_DOWN - When server is down or under maintenance.
REQUIRES_SETUP - When local server is not ready yet.

413 - RequestEntityTooLargeJsonException

When size of passed entity is too large.

400 - NonUniqueJsonException

When passed data violates some unique constraint. Details can have more then one violated field, it means that constraint is composite.

404 - ReferenceNotFoundJsonException

This exception occurs when SomethingInfo dto class contains a field which references to another entity and the algorithm assumes it has to be on the server but it doesn't. See details field: it contains field "entityName" to know the id of entity which is not found and optional field "identifier" of entity which is not found.

409 - InconsistentDataJsonException

When data sent to the server is in inconsistent state. See "details" field for more info. It contains field "message" with text description.

All possible error codes are listed below.

SV_MISMATCH_IN_APP_DESC_AND_CU - Occurs when references to software vendor in application description and control unit don't match.
VALID_FROM_AND_VALID_TO_INCONSISTENCY - Occurs when some inconsistency was detected during 'ValidFrom' or 'ValidTo' validation.
ACTIVATION_CODE_WRONG_LENGTH - Occurs during activation process when activation code is tested.
ACTIVATION_CODE_ALREADY_EXISTS - Occurs during activation process when passed activation has its signature already.
ACTIVATION_STATUS_IS_NOT_MODIFIABLE_BY_PUT - Occurs in case of attempting to modify activation status by 'PUT' http method.
QUERY_PARAM_CANT_BE_NEGATIVE - Occurs if passed query parameter is negative, but positive of zero value is expected.
SELLER_HAS_NOT_REGISTRATION - Occurs when passed by query param cash register name doesn't belong to the passed seller.
SELLER_SHOULD_BE_PROVIDED_FOR_CR - Occurs when cash register name passed as query param without specified seller.
SERVER_IS_OVERLOADED - Occurs when retrieving data bulk is too large. It signals to specify maxResults param to not greater that some limit.
IDENTIFIER_LENGTH_VIOLATION - Occurs when passed identifier (for instance, seller identifier) doesn't fit into length requirements.
SERVER_CANT_BE_REMOVED - Occurs in case of attempting to remove current working server.
URL_AND_BODY_IDENTIFIERS_MISMATCH - Occurs when identifier in URL and body is not the same. Commonly, it is used to forbid changing identifier by PUT.
LOCAL_AND_SERVER_VERSIONS_INCONSISTENCY - Occurs when passed version is more then server's one.
WORKING_WITH_CU_IS_NOT_SUPPORTED_BY_APP - Occurs when application without ability to work with control units attempts to send a kd.
PRODUCTION_NUMBER_AND_CONNECTION_MISMATCH - Occurs during connection to activation process when connection production number is not equal with installation.
PRODUCTION_NUMBER_AND_DEVICE_ID_MISMATCH - Occurs during ordering an activation. Indicates that passed production number doesn't belong to device.
REGISTRATION_EXISTS_FOR_SELLER_AND_INSTALLATION - Occurs during ordering an activation. Indicates that registration already exists for the same seller and installation.
ACTIVATION_APPLICATION_PACKAGE_MUST_BE_NULL_OR_EQUAL - Occurs during ordering an activation. ApplicationPackage must be null or equal to applicationPackage for installation from database.
ACTIVATION_PRODUCTION_NUMBER_SHOULD_BE_NULL - Occurs during ordering an activation. Production number should be null.
ACTIVATION_PRODUCTION_NUMBER_SHOULD_BE_NULL_OR_EQUAL - Occurs during ordering an activation. Production number should be null or equal to production number from database.
ACTIVATION_MUST_HAVE_INSTALLATION_OR_ACTIVATION_CODE - Occurs during creating installation, when we cannot find a installation by a seller and a registration (registration can be found by CashRegisterName or ProductionNumber) and ConnectionCode is empty
VALID_FROM_AND_VALID_TO_INCONSISTENCY - Occurs when some inconsistency was detected during 'ValidFrom' or 'ValidTo' validation.
REGISTRATION_EXISTS_FOR_SELLER_AND_INSTALLATION - Occurs during ordering an activation. Indicates that registration already exists for the same seller and installation.
SV_MISMATCH_IN_APP_DESC_AND_CU - Occurs when references to software vendor in application description and control unit don't match.
REGISTRATION_EXISTS_FOR_SELLER_AND_INSTALLATION - Occurs during ordering an activation. Indicates that registration already exists for the same seller and installation.
ACTIVATION_APPLICATION_PACKAGE_MUST_BE_NULL_OR_EQUAL - Occurs during ordering an activation. ApplicationPackage must be null or equal to applicationPackage for installation from database.
ACTIVATION_PRODUCTION_NUMBER_SHOULD_BE_NULL - Occurs during ordering an activation. Production number should be null.
ACTIVATION_PRODUCTION_NUMBER_SHOULD_BE_NULL_OR_EQUAL - Occurs during ordering an activation. Production number should be null or equal to production number from database.
ACTIVATION_MUST_HAVE_INSTALLATION_OR_ACTIVATION_CODE - Occurs during creating installation, when we cannot find a installation by a seller and a registration (registration can be found by CashRegisterName or ProductionNumber) and ConnectionCode is empty

422 - UnprocessableEntityJsonException

This exception occurs when every entity field passes validation but there is a logical (semantical) violation.

All possible error codes are listed below.

TREASURER_IS_JOINED_TO_USER_ALREADY - Occurs on attempt to join treasurer which is joined already. Need to disjoin treasurer from user at first.
USER_HAS_TREASURER_WITH_SAME_SELLER_ID_ALREADY - Occurs on attempt to join treasurer, but user has treasurer with same seller id already.
TREASURER_IS_NOT_JOINED_TO_USER - Occurs on disjoin treasurer. Indicates that treasurer is not joined to any user and disjoin doesn't make any sense.
COMPANY_NAME_MUST_BE_SET_IF_NO_SELLER - Occurs if both passed seller wasn't found and company name wasn't set.
CU_LOCATION_MUST_BE_SET - Occurs on attempt to set control unit without geolocation info specified.
INSTALLATION_IS_OUT_OF_DATE - Indicates that passed production number is out of date with device since another instance of application was installed already. Reinstall of application is suggested.
CU_IS_MISSING_FOR_ACTIVATION - Indicates that control unit should be set if application is working with control unit
AUTO_ACTIVATE_IS_NOT_POSSIBLE_ON_NEW_CU - Occurs during ordering an activation. Indicates the attempt to enable auto-activation upon not yet registered control unit.
PRODUCTION_NUMBER_AND_DEVICE_ID_MISMATCH - Occurs during ordering an activation. Indicates that passed production number doesn't belong to device. Reinstall of application is suggested.
APPLICATION_PACKAGES_MISMATCH - Occurs during ordering an activation. Indicates that passed application package in the request body and another one identified by production number are not the same.
APP_DESC_HAS_REFERENCED_DATA - Occurs on attempt to remove application description which is referenced in another entities.
SOFTWARE_VENDOR_HAS_REFERENCED_DATA - Occurs on attempt to remove software vendor which is referenced in another entities.
SOFTWARE_VENDOR_IS_MISSING - Occurs on attempt to create/edit user with ROLE_SOFTWARE_VENDOR_ADMIN.
PROHIBITED_ORDER_STATUS_CHANGE - Occurs on attempt to change status of order which breaks conceived logic.
CU_HAS_REFERENCED_DATA - Occurs on attempt to delete the control unit which has referenced data.
DAY_IS_CLOSED - Occurs when current day is closed.
DAY_IS_NOT_CLOSED - Occurs when current day isn't closed.
RECEIPT_IS_PRINTED_ALREADY - Occurs when current receipt is printed already.
RECEIPT_IS_NOT_PRINTED - Occurs when current receipt is not printed yet.
REPORT_IS_PRINTED_ALREADY - Occurs when report is printed already.
REPORT_IS_NOT_PRINTED - Occurs when report is not printed yet.
ACTIVATION_IS_CLOSED_ALREADY - Occurs when activation is closed already.
ACTIVATION_IS_ACTIVE_ALREADY - Occurs when activation is active already.
ACTIVATION_IS_WORKING_ALREADY - Occurs when activation is working already.
ORDER_ALREADY_HAS_PRECEPT - Occurs when new precept is creating with order that already has precept.
SELLER_MUST_HAVE_CURRENCY - Occurs when currency is necessary for make payment and seller doesn't have it.
CONTROL_UNIT_IS_CONNECTED_ALREADY - Control unit is connected to SV already.
CONTROL_UNIT_IS_DISCONNECTED_ALREADY - Control unit is disconnected from SV already.
LATEST_SELLER_CAN_NOT_BE_DELETED - Can not delete the latest seller.
DEVICE_IS_ATTACHED_TO_NON_MULTI_TERMINAL - Device is attached to not multi user terminal.
DEVICE_IS_ATTACHED - Device is attached to terminal.
DEVICE_CANNOT_BE_DELETED - Device cannot be deleted until force deleting terminals which have attaching and detaching of this device.
CONFLICT_DATES - Specified date has conflict with current data.
DEVICE_SHOULD_BE_DETACHED - Device should be detached from terminal.
DEVICE_IS_NOT_AVAILABLE - Device is not available.
NEW_DEVICE_SHOULD_BE_SPECIFIED - New device should be specified.
CU_LOCATION_MUST_BE_SET - Occurs on attempt to set control unit without geolocation info specified.
CU_IS_MISSING_FOR_ACTIVATION - Indicates that control unit should be set if application is working with control unit
INSTALLATION_IS_OUT_OF_DATE - Indicates that passed production number is out of date with device since another instance of application was installed already. Reinstall of application is suggested.

400 - ValueNotValidJsonException

Thrown when some value of field fails validation. One field can have one or more violations.

All possible error codes are listed below.

SHOULD_NOT_BE_NULL - Occurs if non-null constraint violated.
SHOULD_MATCH_PATTERN - Occurs if regex violated. See params in details by keys 'actualValue' and 'pattern'.
SIZE_SHOULD_BE_EQUAL_EXACTLY - Says that size of the field in characters should be equal to limiting number. See params in details 'actualValue', 'sizeMin' and 'sizeMax'.
SIZE_SHOULD_BE_LESS_THEN - Says that size of the field in characters should be less then limiting number. See params in details by keys 'actualValue', 'sizeMin' and 'sizeMax'.
SIZE_SHOULD_BE_MORE_THEN - Says that size of the field in characters should be more or equal then limiting number. See params in details by keys 'actualValue', 'sizeMin' and 'sizeMax'.
SIZE_SHOULD_BE_IN_RANGE - Says that size of the field in characters should be in some range. See params in details by keys actualValue' and 'pattern'.
VALUE_SHOULD_BE_GREATER_THEN - Says that numerical value should be greater or equal then some limiting value. See params in details by keys 'actualValue' and 'valueMin'.
VALUE_SHOULD_BE_LESS_THEN - Says that numerical value should be less or equal then some limiting value. See params in details by keys 'actualValue' and 'valueMax'.
VALUE_SHOULD_NOT_BE_NEGATIVE - Says that value should be positive. See params in details by keys 'actualValue' and 'valueMin'.
SHOULD_MATCH_CORPORATE_ID_VALIDATION_SWEDISH - Says that seller's corporate id failed to pass swedish validation.
SHOULD_MATCH_CORPORATE_ID_VALIDATION_LUHN - Says that seller's corporate id failed to pass Luhn-algorithm validation.
SHOULD_BE_BASE64_ENCODED - Says that value can't be decoded from base64 format.
MAX_UPLOAD_SIZE_EXCEEDED - Says that max uploading file size is exceeded.
SHOULD_BE_CONSISTENT_WITH_ANOTHER_FIELD - Says that value of field related to value of another field.
SHOULD_MATCH_CORPORATE_ID_VALIDATION_SWEDISH - Says that seller's corporate id failed to pass swedish validation.

500 - ControlUnitReceiptJsonException

Thrown when Control Unit decides something is wrong according to it's internal business logic. Thrown by the control unit itself. The details contains three fields:

1. command
2. response
3. name

• InternLoggFull24(24)
• InternaRaknareSaturerade23(23)
• FaltForekommerEfterSistaCRC22(22)
• FelaktigtForhallandeForsaljRetur21(21)
• PowerFailAbort20(20)
• InterntSkrivfel19(19)
• InterntSkrivfel18(18)
• InterntSkrivfel17(17)
• InterntSkrivfel16(16)
• InterntSkrivfel15(15)
• AntalAnvandareHarOverskridits14(14)
• FelaktigMoms4_13(13)
• FelaktigMoms3_12(12)
• FelaktigMoms2_11(11)
• FelaktigMoms1_10(10)
• FelaktigtForsaljningsbelopp9(9)
• FelaktigtReturbelopp8(8)
• KvittotypSaknas7(7)
• FelaktigKvittotyp6(6)
• FelaktigtLopnummer5(5)
• FelaktigtKassaID4(4)
• FelaktigtOrganisationsnummer3(3)
• FelaktigtDatumTid2(2)
• FelAntalArgument1(1)
• OK0(0)
• FelaktigLangd_1(-1)
• CRCError_2(-2)
• OkantKommando_3(-3)

500 - ControlUnitUnavailableJsonException

When server is unable to reach the control unit device (for instance it's ejected from the server). No additional details provided.

500 - ControlUnitCommunicationJsonException

When error has happened during transmission data to the control unit (for instance it was ejected from the server during sending the data). No additional details provided.

Types ¶

identifierType

Each entity has to be identified. Server generates identifiers for every entity. String. Minimum 1 characters. Maximum 50 characters. Regular expression ^(?!^(PRN|AUX|CLOCK\$|NUL|CON|COM\d|LPT\d|\.\.?)$)[^\x00-\x1f\\?*:\";|/<>]+$ .

corporateIdType

Identifies Seller within a country. Seller is a company who sells goods or provides services. Described at Data domain page. Seller is a company who sells goods or provides services. Format of corporateId is country specific. String. Maximum 95 characters. Regular expression ^(?!^(PRN|AUX|CLOCK\$|NUL|CON|COM\d|LPT\d|\.\.?)$)[^\x00-\x1f\\?*:\";|/<>]+$ .

sellerIdType

Unique identifier of every Seller. Seller is a company who sells goods or provides services. Described at Data domain page. Format is {countryType}{corporateIdType}. String.

productionNumberType

Serial number uniquely identifies instance of every installation. It represents production number of cash register according to Swedish regulations. It has format "{softwareId}{number}" where {softwareId} is some constant which identifies vendor of POS software (the company) and the name of POS software. It must be globally unique number. For instance productionNumber PT12300000517264, {softwareId} is PT123, where PT is “PosTerm” – the name of POS software, 123 – first three letters of corporate Id of vendor of PosTerm and 00000517264 is the serial number of the Installation of PosTerm. Each cash register must have a production number. String. Maximum 25 characters.

deviceIdType

Unique number of every device that can be used as cash register or related application. It can be android, iOS, server (for thin clients), desktop PC etc. String. Minimum 1 characters. Maximum 17 characters.

applicationPackageType

A unique identifier of the software, but not it's version. For instance for Android it can be getPackageName() Normally identifier is an url composed of a software name and company website. For instance if your website is http://mycompany.com and your ECR is named "GreatPOS" then identifier will be greatpos.mycompany.com. And then you turn it back to com.mycompany.greatpos. A valid real examples are se.mobilkassan (http://mobilkassan.se) and com.pos4mobile (http://pos4mobile.com). String. Minimum 1 characters. Maximum 64 characters.

printType

The type of receipt print. One of the following values: 'Normal' (Normal receipt), 'Copy' (Receipt copy), 'Proforma'.

controlUnitLocationType

Where control unit is connected and how. One of the following values: 'DEVICE' (Control unit located at Device), 'REMOTE'.

countryType

Country where Seller with given corporateId is registered. Usually used insellerIdType. All possible values are at https://www.iso.org/... website. Preferably lowercase. String. Minimum 2 characters. Maximum 2 characters.

cashRegisterNameType

Described in swedish regulations as "cash register designation". It is defined by Seller, something simple, easy to read and understand, like “Cash1”, “Lobby22”. It is sent to Control Unit together with CorporateId to uniquely identify Cash Register. It's case insensitive. According to swedish regulations it must contain only alphanumeric characters. It must be unique withing the Seller: a single company must not have two different Cash Registers with the same Cash Register Name. It means you may buy a new Cash Register and place it at the same physical position as the old one (you still call it desk 3 or window 5), but since the log is different, you have to inform the authorities that you have installed a new Cash Register instead of the old one, you have to generate a new Cash Register Name. The field that must be printed on receipts and X- and X-reports. It can not be changed within the same Installation. If Installation wipes and there are a new Installation (or replace the Device entirely), it is a new Cash Register Name because we retain no settings and no transaction history: it is very strict with not permitting the same Installation on the same Device (with the same Control Unit) twice - it would defeat the government purpose of keeping the transaction history intact. ProductionNumber can’t be used for this purpose according to the Swedish regulations. There is a method to check the existance of that name for a Seller. String. Minimum 2 characters. Maximum 16 characters.

roleType

User role. One of the following values: 'ROLE_HYPER_ADMIN' (Can do anything), 'ROLE_SOFTWARE_VENDOR_ADMIN' ( Edit seller and seller data, who have at least one activation for his software vendor. Manage activations requested trough it's software and activate them. Activation has field activationPackages which identifies the software ), 'SELLER_ADMIN' (Role for manage by seller admin), 'ACTIVATION'.

activationStatusType

One of the following values: 'ISSUED' (The order was issued by the customer but not yet paid which means Activation can not provide), 'ACTIVE' (The order has been paid by the customer, so we can provide an Activation code to him), 'WORKING' ( Activation has been downloaded, so it can be treated as it was used We can't delete it because we assume it's out of the server ), 'CLOSED'.

imageVersionType

One of the following values: 'current', 'version'.

sellerFieldsType

One of the following values: 'COUNTRY', 'NAME'.

ticketCategoryType

One of the following values: 'CONTROL_UNIT_BROKEN', 'ACTIVATION_ISSUED', 'CONTROL_UNIT_ADDRESS_CHANGED'.

ticketStatusType

One of the following values: 'OPEN', 'CLOSED'.

salesUnitType

One of the following values: 'Piece', 'Price', 'Kilogram', 'Hektogram', 'Meters', 'Centimeters', 'Hours', 'Minutes'.

changeBalanceActionType

One of the following values: 'DEPOSIT', 'WITHDRAWAL'.

deviceFormFactorType

One of the following values: 'PHONE', 'TABLET_SMALL', 'TABLET_BIG'.

saleStateType

One of the following values: 'Open', 'Paid', 'Cancelled', 'Complete'.

deliveryType

One of the following values: 'Display', 'Print', 'SMS', 'Email', 'Discard', 'Journal'.

paymentType

One of the following values: 'Cash', 'EmvStandalone', 'WyWallet', 'PayEx', 'SEQR', 'EmvIntegrated', 'ClosePayment'.

paymentStateType

One of the following values: 'SENDING', 'SENDING_FAILED', 'PENDING', 'APPROVED', 'REJECTED', 'PAUSED', 'CANCELLED', 'CHARGE_FAILED', 'CHARGE_UNKNOWN'.

keyActionType

One of the following values: 'Product', 'SaleItemsView', 'POSSaleItemsView', 'Camera', 'InitiateReturn', 'InitSaleCash', 'InitSaleCard', 'InitSaleAirpay', 'InitSaleSEQR', 'InitSaleIZettle', 'InitSaleWyWallet', 'InitSalePayex', 'SubKeyboard', 'Numeric1', 'Numeric2', 'Numeric3', 'Numeric4', 'Numeric5', 'Numeric6', 'Numeric7', 'Numeric8', 'Numeric9', 'Numeric0', 'Numeric00', 'CurrencyUnit', 'ProductUnit', 'NumericReset', 'NumericDot', 'NumericBackspace', 'NumericIndicator', 'PercentDiscount', 'CurrencyDiscount', 'SendOrder', 'GetOrders', 'SubtotalIndicator', 'ProductsSearchView', 'GroupsProductsView', 'GroupsProductsTextView', 'TablesProductsView', 'TablesProductsTextView', 'NetworkIndicator', 'PrintProforma', 'SalesInOperation'.

activationFeatureType

One of the following values: 'VOUCHERS', 'SEQR', 'WYWALLET', 'PAYEX', 'CLOSEPAYMENT', 'AIRPAY', 'SUPPORT', 'SYNCHRONIZATION', 'IZETTLE', 'CONTROL_UNIT', 'COUPONS', 'SKATTERVERKET'.

autoActivationConditionType

This condition defines use or not use the auto activation. One of the following values: 'NEVER', 'ALWAYS', 'NO_FEATURES'.

currencyType

One of the following values: 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BRL', 'BSD', 'BTN', 'BWP', 'BYR', 'BZD', 'CAD', 'CDF', 'CHF', 'CLP', 'CNY', 'COP', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GGP', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'IMP', 'INR', 'IQD', 'IRR', 'ISK', 'JEP', 'JMD', 'JOD', 'JPY', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KRW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LTL', 'LVL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRO', 'MUR', 'MVR', 'MWK', 'MXN', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PRB', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLL', 'SOS', 'SRD', 'SSP', 'STD', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USD', 'UYU', 'UZS', 'VEF', 'VND', 'VUV', 'WST', 'XAF', 'XCD', 'XOF', 'XPF', 'YER', 'ZAR', 'ZMK', 'ZWL'.

corporateIdValidationMethodType

One of the following values: 'NONE', 'VALIDATE_SWEDISH'.

userRoleType

One of the following values: 'ROLE_HYPER_ADMIN', 'ROLE_SOFTWARE_VENDOR', 'ROLE_REGULAR_USER'.

mailEncryptionType

One of the following values: 'TLS' (Transport Layer Security), 'SSL_TLS' (Transport Layer Security (TLS) and its predecessor, Secure Sockets Layer (SSL)), 'NONE'.

InconsistentDataErrorType

Enum describes error codes corresponding to InconsistentDataJsonException. One of the following values: 'SV_MISMATCH_IN_APP_DESC_AND_CU' (Occurs when references to software vendor in application description and control unit don't match.), 'VALID_FROM_AND_VALID_TO_INCONSISTENCY' (Occurs when some inconsistency was detected during 'ValidFrom' or 'ValidTo' validation.), 'ACTIVATION_CODE_WRONG_LENGTH' (Occurs during activation process when activation code is tested.), 'ACTIVATION_CODE_ALREADY_EXISTS' (Occurs during activation process when passed activation has its signature already.), 'ACTIVATION_STATUS_IS_NOT_MODIFIABLE_BY_PUT' (Occurs in case of attempting to modify activation status by 'PUT' http method.), 'QUERY_PARAM_CANT_BE_NEGATIVE' (Occurs if passed query parameter is negative, but positive of zero value is expected.), 'SELLER_HAS_NOT_REGISTRATION' (Occurs when passed by query param cash register name doesn't belong to the passed seller.), 'SELLER_SHOULD_BE_PROVIDED_FOR_CR' (Occurs when cash register name passed as query param without specified seller.), 'SERVER_IS_OVERLOADED' ( Occurs when retrieving data bulk is too large. It signals to specify maxResults param to not greater that some limit. ), 'IDENTIFIER_LENGTH_VIOLATION' (Occurs when passed identifier (for instance, seller identifier) doesn't fit into length requirements.), 'SERVER_CANT_BE_REMOVED' (Occurs in case of attempting to remove current working server.), 'URL_AND_BODY_IDENTIFIERS_MISMATCH' ( Occurs when identifier in URL and body is not the same. Commonly, it is used to forbid changing identifier by PUT. ), 'LOCAL_AND_SERVER_VERSIONS_INCONSISTENCY' (Occurs when passed version is more then server's one.), 'WORKING_WITH_CU_IS_NOT_SUPPORTED_BY_APP' (Occurs when application without ability to work with control units attempts to send a kd.), 'PRODUCTION_NUMBER_AND_CONNECTION_MISMATCH' (Occurs during connection to activation process when connection production number is not equal with installation.), 'PRODUCTION_NUMBER_AND_DEVICE_ID_MISMATCH' (Occurs during ordering an activation. Indicates that passed production number doesn't belong to device.), 'REGISTRATION_EXISTS_FOR_SELLER_AND_INSTALLATION' (Occurs during ordering an activation. Indicates that registration already exists for the same seller and installation. ), 'ACTIVATION_APPLICATION_PACKAGE_MUST_BE_NULL_OR_EQUAL' (Occurs during ordering an activation. ApplicationPackage must be null or equal to applicationPackage for installation from database. ), 'ACTIVATION_PRODUCTION_NUMBER_SHOULD_BE_NULL' (Occurs during ordering an activation. Production number should be null.), 'ACTIVATION_PRODUCTION_NUMBER_SHOULD_BE_NULL_OR_EQUAL' (Occurs during ordering an activation. Production number should be null or equal to production number from database. ), 'ACTIVATION_MUST_HAVE_INSTALLATION_OR_ACTIVATION_CODE'.

UnprocessableEntityErrorType

Enum describes error codes corresponding to UnprocessableEntityJsonException. One of the following values: 'TREASURER_IS_JOINED_TO_USER_ALREADY' ( Occurs on attempt to join treasurer which is joined already. Need to disjoin treasurer from user at first. ), 'USER_HAS_TREASURER_WITH_SAME_SELLER_ID_ALREADY' (Occurs on attempt to join treasurer, but user has treasurer with same seller id already.), 'TREASURER_IS_NOT_JOINED_TO_USER' ( Occurs on disjoin treasurer. Indicates that treasurer is not joined to any user and disjoin doesn't make any sense. ), 'COMPANY_NAME_MUST_BE_SET_IF_NO_SELLER' (Occurs if both passed seller wasn't found and company name wasn't set.), 'CU_LOCATION_MUST_BE_SET' (Occurs on attempt to set control unit without geolocation info specified.), 'INSTALLATION_IS_OUT_OF_DATE' ( Indicates that passed production number is out of date with device since another instance of application was installed already. Reinstall of application is suggested. ), 'CU_IS_MISSING_FOR_ACTIVATION' (Indicates that control unit should be set if application is working with control unit), 'AUTO_ACTIVATE_IS_NOT_POSSIBLE_ON_NEW_CU' ( Occurs during ordering an activation. Indicates the attempt to enable auto-activation upon not yet registered control unit. ), 'PRODUCTION_NUMBER_AND_DEVICE_ID_MISMATCH' ( Occurs during ordering an activation. Indicates that passed production number doesn't belong to device. Reinstall of application is suggested. ), 'APPLICATION_PACKAGES_MISMATCH' ( Occurs during ordering an activation. Indicates that passed application package in the request body and another one identified by production number are not the same. ), 'APP_DESC_HAS_REFERENCED_DATA' (Occurs on attempt to remove application description which is referenced in another entities.), 'SOFTWARE_VENDOR_HAS_REFERENCED_DATA' ( Occurs on attempt to remove software vendor which is referenced in another entities. ), 'SOFTWARE_VENDOR_IS_MISSING' (Occurs on attempt to create/edit user with ROLE_SOFTWARE_VENDOR_ADMIN.), 'PROHIBITED_ORDER_STATUS_CHANGE' (Occurs on attempt to change status of order which breaks conceived logic.), 'CU_HAS_REFERENCED_DATA' ( Occurs on attempt to delete the control unit which has referenced data. ), 'DAY_IS_CLOSED' ( Occurs when current day is closed. ), 'DAY_IS_NOT_CLOSED' ( Occurs when current day isn't closed. ), 'RECEIPT_IS_PRINTED_ALREADY' ( Occurs when current receipt is printed already. ), 'RECEIPT_IS_NOT_PRINTED' ( Occurs when current receipt is not printed yet. ), 'REPORT_IS_PRINTED_ALREADY' ( Occurs when report is printed already. ), 'REPORT_IS_NOT_PRINTED' ( Occurs when report is not printed yet. ), 'ACTIVATION_IS_CLOSED_ALREADY' ( Occurs when activation is closed already. ), 'ACTIVATION_IS_ACTIVE_ALREADY' ( Occurs when activation is active already. ), 'ACTIVATION_IS_WORKING_ALREADY' ( Occurs when activation is working already. ), 'ORDER_ALREADY_HAS_PRECEPT' ( Occurs when new precept is creating with order that already has precept. ), 'SELLER_MUST_HAVE_CURRENCY' ( Occurs when currency is necessary for make payment and seller doesn't have it. ), 'CONTROL_UNIT_IS_CONNECTED_ALREADY' ( Control unit is connected to SV already. ), 'CONTROL_UNIT_IS_DISCONNECTED_ALREADY' ( Control unit is disconnected from SV already. ), 'LATEST_SELLER_CAN_NOT_BE_DELETED' ( Can not delete the latest seller. ), 'DEVICE_IS_ATTACHED_TO_NON_MULTI_TERMINAL' ( Device is attached to not multi user terminal. ), 'DEVICE_IS_ATTACHED' ( Device is attached to terminal. ), 'DEVICE_CANNOT_BE_DELETED' ( Device cannot be deleted until force deleting terminals which have attaching and detaching of this device. ), 'CONFLICT_DATES' ( Specified date has conflict with current data. ), 'DEVICE_SHOULD_BE_DETACHED' ( Device should be detached from terminal. ), 'DEVICE_IS_NOT_AVAILABLE' ( Device is not available. ), 'NEW_DEVICE_SHOULD_BE_SPECIFIED'.

ValueNotValidErrorType

Enum describes error codes corresponding to ValueNotValidJsonException. One of the following values: 'SHOULD_NOT_BE_NULL' (Occurs if non-null constraint violated.), 'SHOULD_MATCH_PATTERN' ( Occurs if regex violated. See params in details by keys 'actualValue' and 'pattern'. ), 'SIZE_SHOULD_BE_EQUAL_EXACTLY' ( Says that size of the field in characters should be equal to limiting number. See params in details 'actualValue', 'sizeMin' and 'sizeMax'. ), 'SIZE_SHOULD_BE_LESS_THEN' ( Says that size of the field in characters should be less then limiting number. See params in details by keys 'actualValue', 'sizeMin' and 'sizeMax'. ), 'SIZE_SHOULD_BE_MORE_THEN' ( Says that size of the field in characters should be more or equal then limiting number. See params in details by keys 'actualValue', 'sizeMin' and 'sizeMax'. ), 'SIZE_SHOULD_BE_IN_RANGE' ( Says that size of the field in characters should be in some range. See params in details by keys actualValue' and 'pattern'. ), 'VALUE_SHOULD_BE_GREATER_THEN' ( Says that numerical value should be greater or equal then some limiting value. See params in details by keys 'actualValue' and 'valueMin'. ), 'VALUE_SHOULD_BE_LESS_THEN' ( Says that numerical value should be less or equal then some limiting value. See params in details by keys 'actualValue' and 'valueMax'. ), 'VALUE_SHOULD_NOT_BE_NEGATIVE' ( Says that value should be positive. See params in details by keys 'actualValue' and 'valueMin'. ), 'SHOULD_MATCH_CORPORATE_ID_VALIDATION_SWEDISH' (Says that seller's corporate id failed to pass swedish validation.), 'SHOULD_MATCH_CORPORATE_ID_VALIDATION_LUHN' (Says that seller's corporate id failed to pass Luhn-algorithm validation.), 'SHOULD_BE_BASE64_ENCODED' (Says that value can't be decoded from base64 format.), 'MAX_UPLOAD_SIZE_EXCEEDED' (Says that max uploading file size is exceeded.), 'SHOULD_BE_CONSISTENT_WITH_ANOTHER_FIELD'.

ForbiddenErrorType

Enum describes error codes corresponding to ForbiddenJsonException. One of the following values: 'INSUFFICIENT_ACCESS_RIGHTS' ( It is most used code, which covers cases when credentials is not sufficient to perform request or, for example, on attempt to get non-public data. ), 'ACTIVATION_CLOSED_ALREADY' ( If activation in credentials is closed already. I.e. it is in the CLOSED state. ), 'ACTIVATION_STILL_ISSUED' ( If activation in credentials is not activated. I.e. it is in the ISSUED state. ), 'ACTIVATION_NO_FEATURE' ( If activation doesn't have required feature. I.e. it is in the {@link com.srv4pos.server.api.activation.Feature} state. ), 'SELLER_NOT_FOUND' ( If there is credentials and seller with given country and corporate id is not registered. If caught, you should register yourself on the server. ), 'WRONG_ACTIVATION_PERIOD' ( If either activation's period haven't started yet or has expired already. ), 'WRONG_USERNAME_OR_PASSWORD' ( If either username or password failed to pass authorization. User should get "Please contact sales@srv4pos.com if this error appears longer than 24h". ), 'AUTHORIZATION_DATA_IS_NOT_VALID' ( When auth data doesn't pass verification. For example, if username is empty. ), 'INCOMPATIBILITY_OF_SESSION_ID' ( When passed session id hasn't passed verification. ), 'CU_ARE_NOT_MANAGEABLE_BY_SVA' ( When software vendor isn't able to manage CU. ), 'REGISTRATION_IS_NOT_THINKASSAN' ( When used registration is not thinkassan but needs to be. ), 'EMAIL_IS_NOT_FREE' ( When attempt to send a free email on non-free address. ), 'SELLER_IS_NOT_PUBLIC' ( When requested seller is not public. ), 'OLD_PASSWORD_IS_INCORRECT'.

ServiceUnavailableErrorType

Represents types or error for 503 HTTP code. One of the following values: 'SERVER_IS_DOWN' ( When server is down or under maintenance. ), 'REQUIRES_SETUP'.

PictureReportErrorType

Represents error codes for pictures inconsistency for both filesystem to database and vice verse. One of the following values: 'SELLER_MISSING_IN_DB', 'ENTITY_MISSING_IN_DB', 'PIC_MISSING_IN_DB', 'PIC_VERSION_MISSING_IN_DB', 'SELLER_MISSING_IN_FS', 'ENTITY_MISSING_IN_FS', 'PIC_MISSING_IN_FS', 'PIC_VERSION_MISSING_IN_FS', 'LAST_VERSIONS_MISMATCH', 'DELETED_STATUS_MISMATCH'.

orderPaymentStatus

One of the following values: 'NEW' (The order has been created.), 'PAID' (The order has been paid.), 'REJECTED'.

dateGroupingUnit

One of the following values: 'HOUR' ( If duration of period is from 0 to 2 days. 48 grouped parts is maximum (48 hours). ), 'DAY' ( If duration of period is from 3 to 30 days. 30 grouped parts is maximum (30 days). ), 'WEEK' ( If duration of period is from 31 to 84 days. 12 grouped parts is maximum (12 weeks). ), 'MONTH' ( If duration of period is from 85 to 550 days. 18 grouped parts is maximum (18 months). ), 'QUARTER' ( If duration of period is from 551 to 1461 days. 8 grouped parts is maximum (8 quarters). ), 'YEAR'.

preceptStatusType

One of the following values: 'NEW' (Precept has been created.), 'PRINTED' (Precept has been printed.), 'READY'.

dayOfWeek

One of the following values: 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY'.

InconsistentDataErrorType

Enum describes error codes corresponding to InconsistentDataJsonException. One of the following values: 'VALID_FROM_AND_VALID_TO_INCONSISTENCY' (Occurs when some inconsistency was detected during 'ValidFrom' or 'ValidTo' validation.), 'REGISTRATION_EXISTS_FOR_SELLER_AND_INSTALLATION' (Occurs during ordering an activation. Indicates that registration already exists for the same seller and installation. ), 'SV_MISMATCH_IN_APP_DESC_AND_CU' (Occurs when references to software vendor in application description and control unit don't match.), 'REGISTRATION_EXISTS_FOR_SELLER_AND_INSTALLATION' (Occurs during ordering an activation. Indicates that registration already exists for the same seller and installation. ), 'ACTIVATION_APPLICATION_PACKAGE_MUST_BE_NULL_OR_EQUAL' (Occurs during ordering an activation. ApplicationPackage must be null or equal to applicationPackage for installation from database. ), 'ACTIVATION_PRODUCTION_NUMBER_SHOULD_BE_NULL' (Occurs during ordering an activation. Production number should be null.), 'ACTIVATION_PRODUCTION_NUMBER_SHOULD_BE_NULL_OR_EQUAL' (Occurs during ordering an activation. Production number should be null or equal to production number from database. ), 'ACTIVATION_MUST_HAVE_INSTALLATION_OR_ACTIVATION_CODE'.

registrationStatusType

Enum describes registration status One of the following values: 'REMOVED' (When deactivate request was sent or new registration was created for same device id), 'ACTIVE'.

applicationNameAndVersionType

Application name and version. Should contains SE and version String. Minimum 1 characters. Maximum 60 characters.

UnprocessableEntityErrorType

Enum describes error codes corresponding to UnprocessableEntityJsonException. One of the following values: 'CU_LOCATION_MUST_BE_SET' (Occurs on attempt to set control unit without geolocation info specified.), 'CU_IS_MISSING_FOR_ACTIVATION' (Indicates that control unit should be set if application is working with control unit), 'INSTALLATION_IS_OUT_OF_DATE'.

ValueNotValidErrorType

Enum describes error codes corresponding to ValueNotValidJsonException. One of the following values: 'SHOULD_MATCH_CORPORATE_ID_VALIDATION_SWEDISH'.

GET /v45/auth/handshake ¶

Request

Response

Errors

See there: SELLER_NOT_FOUND .

GET /v45/auth/user ¶

Request

Response

Errors

See there: INSUFFICIENT_ACCESS_RIGHTS, WRONG_USERNAME_OR_PASSWORD .

POST /v45/activations-advanced ¶

Request

Response

Errors

If installation by seller (by country andcorporateId) andcashRegisterName, applicationPackage or controlUnitSerial in request body weren't found.

If cash register name is not unique within a seller.

See there: VALID_FROM_AND_VALID_TO_INCONSISTENCY, REGISTRATION_EXISTS_FOR_SELLER_AND_INSTALLATION, SV_MISMATCH_IN_APP_DESC_AND_CU, REGISTRATION_EXISTS_FOR_SELLER_AND_INSTALLATION, ACTIVATION_APPLICATION_PACKAGE_MUST_BE_NULL_OR_EQUAL, ACTIVATION_PRODUCTION_NUMBER_SHOULD_BE_NULL, ACTIVATION_PRODUCTION_NUMBER_SHOULD_BE_NULL_OR_EQUAL, ACTIVATION_MUST_HAVE_INSTALLATION_OR_ACTIVATION_CODE .

See there: CU_LOCATION_MUST_BE_SET, CU_IS_MISSING_FOR_ACTIVATION, INSTALLATION_IS_OUT_OF_DATE .

See there: SHOULD_MATCH_CORPORATE_ID_VALIDATION_SWEDISH .

POST /v45/activations-advanced ¶

Request

Response

Errors

If applicationPackage or controlUnitSerial in request body weren't found.

If cash register name is not unique within a seller.

See there: VALID_FROM_AND_VALID_TO_INCONSISTENCY, REGISTRATION_EXISTS_FOR_SELLER_AND_INSTALLATION, SV_MISMATCH_IN_APP_DESC_AND_CU .

See there: CU_LOCATION_MUST_BE_SET, CU_IS_MISSING_FOR_ACTIVATION .

POST /v45/activations-advanced ¶

Request

Response

Errors

If applicationPackage in request body wasn't found.

If cash register name is not unique within a seller.

See there: VALID_FROM_AND_VALID_TO_INCONSISTENCY, REGISTRATION_EXISTS_FOR_SELLER_AND_INSTALLATION .

POST /v45/activations-advanced ¶

Request

Response

Errors

If installation by seller (by country andcorporateId) and cashRegisterName or controlUnitSerial in request body weren't found.

If cash register name is not unique within a seller.

See there: VALID_FROM_AND_VALID_TO_INCONSISTENCY, SV_MISMATCH_IN_APP_DESC_AND_CU .

See there: CU_LOCATION_MUST_BE_SET, CU_IS_MISSING_FOR_ACTIVATION, INSTALLATION_IS_OUT_OF_DATE .

POST /v45/activations-advanced ¶

Request

Response

Errors

If installation by seller (by country andcorporateId) and cashRegisterName or controlUnitSerial in request body weren't found.

If cash register name is not unique within a seller.

See there: VALID_FROM_AND_VALID_TO_INCONSISTENCY .

See there: INSTALLATION_IS_OUT_OF_DATE .

POST /v45/noauth/activations/cash-register-name/existance ¶

Request

Response

Errors

When passed data violates some unique constraint. Details can have more then one violated field, it means that constraint is composite.

POST /v45/activations/activation-code ¶

Request

Response

Errors

See there: ACTIVATION_STILL_ISSUED, WRONG_USERNAME_OR_PASSWORD .

POST /v45/activations/connection ¶

Request

Response

Errors

Activation not found by code.

See there: ACTIVATION_CODE_WRONG_LENGTH, PRODUCTION_NUMBER_AND_CONNECTION_MISMATCH, PRODUCTION_NUMBER_AND_DEVICE_ID_MISMATCH .

See there: APPLICATION_PACKAGES_MISMATCH .

GET /v45/sellers/{sellerId} ¶

Request

Response

PUT /v45/sellers/{sellerId} ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

DELETE /v45/sellers/{sellerId} ¶

Request

Response

GET /v45/sellers ¶

Request

Response

GET /v45/{sellerId}/version ¶

Request

Response

GET /v45/{sellerId}/stats ¶

Request

Response

GET /v45/{sellerId}/modifications ¶

Request

Response

Errors

If "from" or "to" parameters were missed.

Errors

If requested api is outdated.

POST /v45/{sellerId}/images ¶

Request

Response

GET /v45/{sellerId}/images ¶

Request

Response

GET /v45/{sellerId}/images/current/{pictureFilename} ¶

Request

Response

HTTP/1.1 200 OK

GET /v45/{sellerId}/images/{pictureVersion}/{pictureFilename} ¶

Request

Response

HTTP/1.1 200 OK

PUT /v45/{sellerId}/images/current/{pictureFilename} ¶

Request

PUT /v45/se9876543217/images/current/MAIN.PNG HTTP/1.1 Content-Type: image/png

Authorization: RestApiTester@se9876543217:9999

Host: s.srv4pos.com

Response

Errors

If seller wasn't found.

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

DELETE /v45/{sellerId}/images/current/{pictureFilename} ¶

Request

Response

GET /v45/{sellerId}/seller-images-diff/{versionFrom}/{versionTo} ¶

Request

Response

POST /v45/{sellerId}/taxes ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

PUT /v45/{sellerId}/taxes/{identifier} ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

GET /v45/{sellerId}/taxes/{identifier} ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

If entity is not found.

See there: INSUFFICIENT_ACCESS_RIGHTS .

DELETE /v45/{sellerId}/taxes/{identifier} ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

GET /v45/{sellerId}/taxes-diff/{versionFrom}/{versionTo} ¶

Request

Response

GET /v45/{sellerId}/taxes ¶

Request

Response

GET /v45/{sellerId}/taxes/stats ¶

Request

Response

Errors

If passed date period has incorrect format.

If passed cash register name don't belong to seller.

POST /v45/{sellerId}/categories ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

PUT /v45/{sellerId}/categories/{identifier} ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

GET /v45/{sellerId}/categories/{identifier} ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

If entity is not found.

DELETE /v45/{sellerId}/categories/{identifier} ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

GET /v45/{sellerId}/categories-diff/{versionFrom}/{versionTo} ¶

Request

Response

GET /v45/{sellerId}/categories ¶

Request

Response

GET /v45/{sellerId}/categories/stats ¶

Request

Response

Errors

If passed date period has incorrect format.

If passed cash register name don't belong to seller.

POST /v45/{sellerId}/categories/{categoryIdentifier}/images ¶

Request

Response

GET /v45/{sellerId}/categories/{categoryIdentifier}/images ¶

Request

Response

GET /v45/{sellerId}/categories/{categoryIdentifier}/images/current/{pictureFilename} ¶

Request

Response

HTTP/1.1 200 OK

GET /v45/{sellerId}/categories/{categoryIdentifier}/images/{pictureVersion}/{pictureFilename} ¶

Request

Response

HTTP/1.1 200 OK

PUT /v45/{sellerId}/categories/{categoryIdentifier}/images/current/{pictureFilename} ¶

Request

PUT /v45/se9876543217/categories/0-2U10/images/current/MAIN.PNG HTTP/1.1 Content-Type: application/json Host: s.srv4pos.com

Response

Errors

If seller wasn't found.

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

DELETE /v45/{sellerId}/categories/{categoryIdentifier}/images/current/{pictureFilename} ¶

Request

Response

GET /v45/{sellerId}/category-images-diff/{versionFrom}/{versionTo} ¶

Request

Response

POST /v45/{sellerId}/products ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

If tax is not found.

See there: SIZE_SHOULD_BE_IN_RANGE, SHOULD_MATCH_PATTERN .

PUT /v45/{sellerId}/products/{identifier} ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

If tax wasn't found.

GET /v45/{sellerId}/products/{identifier} ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

If entity is not found.

GET /v45/{sellerId}/products-diff/{versionFrom}/{versionTo} ¶

Request

Response

GET /v45/{sellerId}/products ¶

Request

Response

DELETE /v45/{sellerId}/products/{identifier} ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

GET /v45/{sellerId}/products/stats ¶

Request

Response

Errors

If passed date period has incorrect format.

If passed cash register name don't belong to seller.

PUT /v45/{sellerId}/products/{productIdentifier}/images/current/{pictureFilename} ¶

Request

PUT /v45/se9876543217/products/0-2U12/images/current/MAIN.PNG HTTP/1.1 Content-Type: image/png

Authorization: RestApiTester@se9876543217:9999

Host: s.srv4pos.com

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

If product wasn't found.

GET /v45/{sellerId}/products/{productIdentifier}/images ¶

Request

Response

GET /v45/{sellerId}/products/{productIdentifier}/images/current/{pictureFilename} ¶

Request

Response

HTTP/1.1 200 OK

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

If product wasn't found.

GET /v45/{sellerId}/products/{productIdentifier}/images/{pictureVersion}/{pictureFilename} ¶

Request

Response

HTTP/1.1 200 OK

Errors

If image is not found.

If product wasn't found.

DELETE /v45/{sellerId}/products/{productIdentifier}/images/current/{pictureFilename} ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

If product wasn't found.

GET /v45/{sellerId}/product-images-diff/{versionFrom}/{versionTo} ¶

Request

Response

POST /v45/{sellerId}/commodities ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

If product wasn't found.

PUT /v45/{sellerId}/commodities/{identifier} ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

If product wasn't found.

GET /v45/{sellerId}/commodities/{identifier} ¶

Request

Response

Errors

If entity is not found.

GET /v45/{sellerId}/commodities ¶

Request

Response

GET /v45/{sellerId}/commodities-advanced ¶

Request

Response

DELETE /v45/{sellerId}/commodities/{identifier} ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

GET /v45/{sellerId}/commodities-diff/{versionFrom}/{versionTo} ¶

Request

Response

POST /v45/{sellerId}/keyboards ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

PUT /v45/{sellerId}/keyboards/{identifier} ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

GET /v45/{sellerId}/keyboards/{identifier} ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

If entity is not found.

GET /v45/{sellerId}/keyboards ¶

Request

Response

DELETE /v45/{sellerId}/keyboards/{identifier} ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

GET /v45/{sellerId}/keyboards-diff/{versionFrom}/{versionTo} ¶

Request

Response

POST /v45/{sellerId}/keyboard-entries ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

If product wasn't found.

PUT /v45/{sellerId}/keyboard-entries/{identifier} ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

If product wasn't found.

GET /v45/{sellerId}/keyboard-entries/{identifier} ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

If entity is not found.

DELETE /v45/{sellerId}/keyboard-entries/{identifier} ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

GET /v45/{sellerId}/keyboard-entries-diff/{versionFrom}/{versionTo} ¶

Request

Response

GET /v45/{sellerId}/keyboard-entries ¶

Request

Response

POST /v45/{sellerId}/orders ¶

Request

Response

Errors

If product with passed productIdentifier or booking with passed identifier were not found.

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

GET /v45/{sellerId}/orders ¶

Request

Response

GET /v45/{sellerId}/orders/{orderId} ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

GET /v45/{sellerId}/orders-advanced ¶

Request

Response

GET /v45/{sellerId}/orders-advanced/{orderId} ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

GET /v45/{sellerId}/orders-diff/{versionFrom}/{versionTo} ¶

Request

Response

PUT /v45/{sellerId}/orders/{orderId} ¶

Request

Response

Errors

If product with passed productIdentifier or booking with passed identifier were not found.

See there: INSUFFICIENT_ACCESS_RIGHTS .

See there: PROHIBITED_ORDER_STATUS_CHANGE .

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

DELETE /v45/{sellerId}/orders/{orderId} ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

GET /v45/{sellerId}/treasurers/{identifier} ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

When requested resource wasn't found.

PUT /v45/{sellerId}/treasurers/{identifier} ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

POST /v45/{sellerId}/treasurers ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

DELETE /v45/{sellerId}/treasurers/{identifier} ¶

Request

Response

Errors

When requested resource wasn't found.

GET /v45/{sellerId}/treasurers-diff/{versionFrom}/{versionTo} ¶

Request

Response

GET /v45/{sellerId}/treasurers ¶

Request

Response

GET /v45/{sellerId}/bookings/{identifier} ¶

Request

Response

Errors

If booking or seller wasn't found.

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

See there: INSUFFICIENT_ACCESS_RIGHTS .

PUT /v45/{sellerId}/bookings/{identifier} ¶

Request

Response

Errors

If booking or seller wasn't found.

See there: INSUFFICIENT_ACCESS_RIGHTS .

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

POST /v45/{sellerId}/bookings ¶

Request

Response

Errors

If seller wasn't found.

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

DELETE /v45/{sellerId}/bookings/{identifier} ¶

Request

Response

Errors

If booking or seller wasn't found.

See there: INSUFFICIENT_ACCESS_RIGHTS .

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

GET /v45/{sellerId}/bookings ¶

Request

Response

GET /v45/{sellerId}/bookings-diff/{versionFrom}/{versionTo} ¶

Request

Response

GET /v45/{sellerId}/registrations ¶

Request

Response

GET /v45/{sellerId}/registrations-advanced ¶

Request

Response

GET /v45/{sellerId}/registrations/stats ¶

Request

Response

Errors

If passed date period has incorrect format.

POST /v45/{sellerId}/registration/{cashRegisterName}/kd ¶

Request

Response

Errors

This exception occurs when SomethingInfo dto class contains a field which references to another entity and the algorithm assumes it has to be on the server but it doesn't. See details field: it contains field "entityName" to know the id of entity which is not found and optional field "identifier" of entity which is not found.

Thrown when Control Unit decides something is wrong according to it's internal business logic. Thrown by the control unit itself. The details contains three fields:

1. command
2. response
3. name

• InternLoggFull24(24)
• InternaRaknareSaturerade23(23)
• FaltForekommerEfterSistaCRC22(22)
• FelaktigtForhallandeForsaljRetur21(21)
• PowerFailAbort20(20)
• InterntSkrivfel19(19)
• InterntSkrivfel18(18)
• InterntSkrivfel17(17)
• InterntSkrivfel16(16)
• InterntSkrivfel15(15)
• AntalAnvandareHarOverskridits14(14)
• FelaktigMoms4_13(13)
• FelaktigMoms3_12(12)
• FelaktigMoms2_11(11)
• FelaktigMoms1_10(10)
• FelaktigtForsaljningsbelopp9(9)
• FelaktigtReturbelopp8(8)
• KvittotypSaknas7(7)
• FelaktigKvittotyp6(6)
• FelaktigtLopnummer5(5)
• FelaktigtKassaID4(4)
• FelaktigtOrganisationsnummer3(3)
• FelaktigtDatumTid2(2)
• FelAntalArgument1(1)
• OK0(0)
• FelaktigLangd_1(-1)
• CRCError_2(-2)
• OkantKommando_3(-3)

When server is unable to reach the control unit device (for instance it's ejected from the server). No additional details provided.

When error has happened during transmission data to the control unit (for instance it was ejected from the server during sending the data). No additional details provided.

POST /v45/{sellerId}/registration/{cashRegisterName}/kd ¶

Request

Response

Errors

This exception occurs when SomethingInfo dto class contains a field which references to another entity and the algorithm assumes it has to be on the server but it doesn't. See details field: it contains field "entityName" to know the id of entity which is not found and optional field "identifier" of entity which is not found.

Thrown when Control Unit decides something is wrong according to it's internal business logic. Thrown by the control unit itself. The details contains three fields:

1. command
2. response
3. name

• InternLoggFull24(24)
• InternaRaknareSaturerade23(23)
• FaltForekommerEfterSistaCRC22(22)
• FelaktigtForhallandeForsaljRetur21(21)
• PowerFailAbort20(20)
• InterntSkrivfel19(19)
• InterntSkrivfel18(18)
• InterntSkrivfel17(17)
• InterntSkrivfel16(16)
• InterntSkrivfel15(15)
• AntalAnvandareHarOverskridits14(14)
• FelaktigMoms4_13(13)
• FelaktigMoms3_12(12)
• FelaktigMoms2_11(11)
• FelaktigMoms1_10(10)
• FelaktigtForsaljningsbelopp9(9)
• FelaktigtReturbelopp8(8)
• KvittotypSaknas7(7)
• FelaktigKvittotyp6(6)
• FelaktigtLopnummer5(5)
• FelaktigtKassaID4(4)
• FelaktigtOrganisationsnummer3(3)
• FelaktigtDatumTid2(2)
• FelAntalArgument1(1)
• OK0(0)
• FelaktigLangd_1(-1)
• CRCError_2(-2)
• OkantKommando_3(-3)

When server is unable to reach the control unit device (for instance it's ejected from the server). No additional details provided.

When error has happened during transmission data to the control unit (for instance it was ejected from the server during sending the data). No additional details provided.

GET /v45/{sellerId}/registrations/{cashRegisterName}/balance ¶

Request

Response

Errors

If cashRegisterName wasn't found.

See there: DAY_IS_CLOSED, DAY_IS_NOT_CLOSED, REPORT_IS_NOT_PRINTED .

POST /v45/{sellerId}/registrations/{cashRegisterName}/balance ¶

Request

Response

Errors

See there: DAY_IS_CLOSED, DAY_IS_NOT_CLOSED, REPORT_IS_NOT_PRINTED .

GET /v45/{sellerId}/registrations/{cashRegisterName} ¶

Request

Response

Errors

Occurs when we upload data to the server but server contains more fresh data than we send. No additional details provided. You should set actual "If-Match" header.

GET /v45/{sellerId}/registrations/{cashRegisterName}/version ¶

Request

Response

Errors

If cash register wasn't found.

POST /v45/{sellerId}/registrations/{cashRegisterName}/sales ¶

Request