Fiscal register

create

request
POST /api/v2/fiscal-register HTTP/1.1

{
  "adminConfigJson" : "{\"login\":\"0004455205\",\"password\":\"11111\"}",
  "configJson" : "{\"login\":\"0004455205\",\"password\":\"11111\"}",
  "externalId" : "3705",
  "name" : "Касса 2",
  "type" : "LIGHT_KASSA"
}
Table 183. request description
Path Type Description Constraints

adminConfigJson

String

adminConfigJson

configJson

String

Configuration for the fiscal register (e.g. login and password) as JSON

externalId

String

Id of the fiscal register as received from here

Must not be blank

name

String

The fiscal register’s visible name

type

String

The fiscal register’s type. For possible values see here. Field 'isNative' for the type must be false

Must not be null.
Ненативный тип кассы
response
HTTP/1.1 201 Created
Location: /api/v2/fiscal-register/1

{
  "id" : 1,
  "configJson" : "{\"departmentId\":1000000003,\"credential\":{\"login\":\"0004455205\",\"password\":\"11111\"}}",
  "externalId" : "3705",
  "name" : "Касса 2",
  "type" : "LIGHT_KASSA"
}
Table 184. response description
Path Type Description

id

Number

The fiscal register’s id

configJson

String

Configuration for the fiscal register (e.g. login and password) as JSON

externalId

String

External id of the fiscal register as received from here

name

String

The fiscal register’s visible name

type

String

The fiscal register’s type. For possible values see here. Field 'isNative' for the type must be false

list

request
GET /api/v2/fiscal-register?type=LIGHT_KASSA HTTP/1.1
Table 185. request description
Parameter Description

type

Fiscal register type
response
HTTP/1.1 200 OK

[ {
  "id" : 1,
  "configJson" : "{\"departmentId\":1000000003,\"credential\":{\"login\":\"0004455205\",\"password\":\"11111\"}}",
  "externalId" : "3705",
  "name" : "Касса 2",
  "type" : "LIGHT_KASSA"
} ]
Table 186. response description
Path Type Description

[]

Array

List of fiscal registers

[].id

Number

The fiscal register’s id

[].configJson

String

Configuration for the fiscal register (e.g. login and password) as JSON

[].externalId

String

External id of the fiscal register as received from here

[].name

String

The fiscal register’s visible name

[].type

String

The fiscal register’s type. For possible values see here. Field 'isNative' for the type must be false

update

request
PUT /api/v2/fiscal-register/1 HTTP/1.1

{
  "adminConfigJson" : "{\"login\":\"0004455205\",\"password\":\"11111\"}",
  "configJson" : "{\"login\":\"0004455205\",\"password\":\"11111\"}",
  "externalId" : "3705",
  "name" : "Касса 1",
  "type" : "LIGHT_KASSA"
}
Table 187. /api/v2/fiscal-register/{id}
Parameter Description

id

The fiscal register’s id
Path Type Description Constraints

adminConfigJson

String

adminConfigJson

configJson

String

Configuration for the fiscal register (e.g. login and password) as JSON

externalId

String

Id of the fiscal register as received from here

Must not be blank

name

String

The fiscal register’s visible name

type

String

The fiscal register’s type. For possible values see here. Field 'isNative' for the type must be false

Must not be null.
Ненативный тип кассы
response
HTTP/1.1 200 OK

list external

request
GET /api/v2/fiscal-register/external?type=LIGHT_KASSA&adminConfigJson=%7B%22login%22:%220004455205%22,%22password%22:%2211111%22%7D HTTP/1.1
Table 188. request description
Parameter Description

adminConfigJson

Configuration to make an external API request (e.g. admin API login and password)

type

Fiscal register type
response
HTTP/1.1 200 OK

[ {
  "type" : "LIGHT_KASSA",
  "id" : "3705",
  "name" : "Касса 1"
} ]
Table 189. response description
Path Type Description

[]

Array

List of external info

[].type

String

The fiscal register’s type

[].id

String

The fiscal register’s external id

[].name

String

The fiscal register’s visible name

list types

request
GET /api/v2/fiscal-register/types HTTP/1.1
response
HTTP/1.1 200 OK

[ {
  "type" : "ATOL",
  "regions" : null,
  "native" : true
}, {
  "type" : "SHTRIH_M",
  "regions" : null,
  "native" : true
}, {
  "type" : "TEST",
  "regions" : null,
  "native" : true
} ]
Table 190. response description
Path Type Description

[]

Array

List of info about fiscal register types

[].type

String

The type’s id

[].isNative

Boolean

Are fiscal registers of this type handled by Optima Native?

[].regions

Array

List of regions where the type is supported. Empty list means the type is supported everywhere

← Previous: Export 1C | ↑ Up: Optima2 API v.2 REST | Next: Gift certificates →