Receiving receipt information

Parameters

HTTP method

Access rights

URL

Parameters

Note

GET offline_receipts https://api.admitad.com/offline_receipts/ List of request parameters

Returns information about a receipt

  • * Returns the result in the JSON format.

List of request parameters

Name

Type

Allowed values

website_id integer The list of publisher’s ad spaces
id string Список идентификаторов чеков
datetime_created_from datetime Дата и время оплаты чека (%d.%m.%Y %H:%M)
datetime_created_to datetime Дата и время оплаты чека (%d.%m.%Y %H:%M)
datetime_updated_from datetime Дата и время последнего обновления чека (%d.%m.%Y %H:%M)
datetime_updated_to datetime Дата и время последнего обновления чека (%d.%m.%Y %H:%M)
limit integer limit, offset parameters
offset integer limit, offset parameters

Example of use

Example of a request with utility ``curl``:

curl -L -H 'Authorization: Bearer access_token' -X GET 'https://api.admitad.com/offline_receipts/?website_id=1&id=5b509f0c47b41317d0829ade&id=4a509f0c47b48362d0829ada''

Example of the response from the API server in the JSON format:

{
    "results": [
        {
            "id": "5b509f0c47b41317d0829ade",
            "website_id": 1,
            "purchaser_id": 2341,
            "status": "receipt_info_found",
            "payment_ids": [
                125342,
                2345254
            ],
            "retail_place_address": "",
            "user": "",
            "total_sum": "2915.00",
            "datetime_created": "2018-12-12T00:00:00",
            "datetime_updated": "2018-12-12T13:12:00",
            "offline_sales_ids": [
                31233,
                21233
            ],
            "not_activated_offline_sales_ids": [42],
            "items": [
                {
                    "sum": "1915.00",
                    "quantity": "1.00",
                    "offline_sales_ids": [
                        31233
                    ],
                    "price": "1915.00",
                    "name": "",
                },
                {
                    "sum": "1915.00",
                    "quantity": "1.00",
                    "offline_sales_ids": [
                        21233
                    ],
                    "price": "1915.00",
                    "name": "",
                }
            ]
            "FNS_data": "{\"items\":[{\"paymentType\":4,\"name\":\"qqqq\",\"productType\":1,\"sum\":100,\"price\":100,\"ndsSum\":0,\"nds\":6,\"quantity\":1}],\"userInn\":\"507303885648\",\"operationType\":1,\"dateTime\":\"2018-07-02T21:39:00\"}",
        },
        {
            "id": "4a509f0c47b48362d0829ada",
            "website_id": 1,
            "purchaser_id": 2342,
            "status": "receipt_info_found",
            "payment_ids": [
                4345254,
            ]
            "retail_place_address": ""
            "user": "",
            "total_sum": "351918.00",
            "datetime_created": "2018-11-12T00:00:00",
            "datetime_updated": "2018-12-12T12:15:00",
            "offline_sales_ids": [
                11233,
            ],
            "not_activated_offline_sales_ids": [],
            "items": [
                {
                    "sum": "1915.00",
                    "quantity": "1.00",
                    "offline_sales_ids": [
                        11233
                    ],
                    "price": "1915.00",
                    "name": "",
                }
            ]
            "FNS_data": "{\"items\":[{\"paymentType\":4,\"name\":\"qqqq\",\"productType\":1,\"sum\":100,\"price\":100,\"ndsSum\":0,\"nds\":6,\"quantity\":1}],\"userInn\":\"507303885648\",\"operationType\":1,\"dateTime\":\"2018-07-02T21:29:00\"}",
        },
    ],
    "_meta": {
        "count": 2,
        "limit": 20,
        "offset": 0
    }
}

Description of API server response fields

Описание полей чека

Name

Description

id

Receipt identifier

website_id

Ad space ID

purchaser_id

Customer unique identifier in the publisher’s system

status
Статус offline чека.
  • new - Новый чек
  • invalid_qr - Невалидный QR-код
  • receipt_info_found - Информация по чеку найдена
  • receipt_info_not_found - Информация по чеку не найдена
  • receipt_info_is_not_yet_ready - Информация по чеку еще не готова
  • fail - Не удалось получить данные от ФНС
  • payments_created - Чек проверен, найдены акционные товары
  • payments_not_found - Чек проверен, акционные товары не найдены
payment_ids Идентификаторы действий (платёжек) сгенерированных при матчинге акций с чека (Reports by actions)
retail_place_address Адрес магазина
user Наименование организации, выдавшей чек
total_sum Итоговая сумма расчета
datetime_created Дата и время выдачи чека
datetime_updated Дата и время последнего изменения данных о чеке
offline_sales_ids Список идентификаторов акций которые сработали на чек
items Список товаров в чеке
FNS_data

FTS data (unstable scheme)

not_activated_offline_sales_ids Список идентификаторов акций, которые не сработали, так как не были активированы

Описание полей товаров чека

Name

Description

sum Стоимость
quantity Количество
offline_sales_ids Идентификаторы акций которые сработали на товар
price Цена за единицу
name

Name of goods

Описание полей FNS_data (схема нестабильна)

Name

Description

dateTime Дата и время выдачи чека
fiscalDocumentNumber

Fiscal document No.

fiscalDriveNumber Номер фискального накопителя
fiscalSign Номер фискального признака
operationType Признак расчета 1 - приход, 2 - возврат прихода, 3 - расход, 4 - возврат расхода
totalSum Итоговая сумма расчета
cashTotalSum Сумма расчета наличными
ecashTotalSum Сумма расчета безналичным
nds18 Сумма НДС по ставке 18%
nds10 Сумма НДС по ставке 10%
ndsNo Стоимость по ставке 0% НДС
operator Кассир
shiftNumber Номер смены
requestNumber Номер чека
retailPlaceAddress Адрес магазина
user Наименование организации, выдавшей чек
userInn ИНН организации, выдавшей чек
ofdId ID Оператора Фискальных Данных
items Список товаров