PHPOrangeData

PHP integration for OrangeData service

Актуальная версия библиотеки: 4.0.0

Версия PHP: 5.6.6+

Версия протокола взаимодействия с интернет кассой: 2.29.1 от 15.11.2023

Содержание

• Начало работы
  • Подключение библиотеки
  • Создание клиента
• Заказ
  • Создание заказа
    • Добавление позиции в заказ
    • Добавление оплаты в заказ
    • Добавление агента в заказ
    • Добавление дополнительного реквизита пользователя
    • Добавление дополнительных полей
    • Добавление вендинга в заказ
    • Добавление курьера в заказ
  • Отправка заказа
  • Проверка статуса заказа
• Чек коррекции
  • Создание чека коррекции ФФД1.05
  • Отправка чека коррекции ФФД1.05
  • Создание чека коррекции ФФД1.2
  • Отправка чека коррекции ФФД1.2
  • Добавление вендинга в чек коррекции
  • Добавление курьера в чек коррекции
  • Добавление дополнительных аттрибутов, позиции и оплаты в чек коррекции (только для ФФД1.2)
  • Проверка статуса чека коррекции

Начало работы

Подключение библиотеки

Для начала работы необходимо подключить файл класса:

<?php
include_once 'orangedata_client.php';

Создание клиента

<?php
$client = [
  'inn' => '0123456789',
  'api_url' => '2443',
  // 'api_url' => 'https://apip.orangedata.ru:2443', // link access
  'sign_pkey' => dirname(__DIR__) . '/secure_path/private_key.pem',
  'ssl_client_key' => dirname(__DIR__) . '/secure_path/client.key',
  'ssl_client_crt' => dirname(__DIR__) . '/secure_path/client.crt',
  'ssl_ca_cert' => dirname(__DIR__) . '/secure_path/cacert.pem',
  'ssl_client_crt_pass' => 1234,
];

$buyer = new orangedata\orangedata_client($client); // create new client

Cвойства клиента

Для включения записи логов в файл ‘curl.log’, прописываем:

<?php
$buyer->is_debug();

Заказ

Создание заказа

После того, как создали клиента, можно приступить к созданию заказа.

<?php
$order = [
  'id' => '23423423434',
  'type' => 1,
  'customerContact' => 'example@example.com',
  'taxationSystem' => 1,
  'key' => '1234567',
  'ffdVersion' => 4
];

$buyer->create_order($order);

Cвойства заказа

Добавление позиции в заказ

<?php
$position = [
  'quantity' => '10',
  'price' => 100,
  'tax' => 1,
  'text' => 'some text',
  'paymentMethodType' => 3,
  'paymentSubjectType' => 1,
  'nomenclatureCode' => 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/',
  'supplierInfo' => [
    'phoneNumbers' => ['+79266660011', '+79293456723'],
    'name' => 'PAO Example',
  ],
  'supplierINN' => 1234567890,
  'agentType' => 127,
  'agentInfo' => [
    'paymentTransferOperatorPhoneNumbers' => ['+79266660011', '+79293456723'],
    'paymentAgentOperation' => 'some operartion',
    'paymentAgentPhoneNumbers' => ['+79266660011', '+79293456723'],
    'paymentOperatorPhoneNumbers' => ['+79266660011'],
    'paymentOperatorName' => 'OAO ATLANT',
    'paymentOperatorAddress' => 'Address',
    'paymentOperatorInn' => 1234567890,
  ],
  'unitOfMeasurement' => 'kg',
  'additionalAttribute' => 'attribute',
  'manufacturerCountryCode' => '534',
  'customsDeclarationNumber' => 'AD 11/77 from 01.08.2018',
  'excise' => '12.43',
];

$buyer->add_position_to_order($position);

Cвойства позиции

Параметры nomenclatureCode, unitOfMeasurement используются для ФФД 1.05
Параметры itemCode, quantityMeasurementUnit, industryAttribute, plannedStatus, fractionalQuantity, barcodes используются для ФФД 1.2

Cвойства supplierInfo

Cвойства agentInfo

Cвойства industryAttribute

Cвойства fractionalQuantity

Cвойства barcodes

Добавление оплаты в заказ

<?php
$payment = [
  'type' => 16,
  'amount' => 131.23,
];

$buyer->add_payment_to_order($payment);

Cвойства оплаты

Добавление агента в заказ

Не поддерживается для ФФД1.2

<?php
$agent = [
  'agentType' => 127,
  'paymentTransferOperatorPhoneNumbers' => ['+79998887766', '+76667778899'],
  'paymentAgentOperation' => 'Operation',
  'paymentAgentPhoneNumbers' => ['+79998887766'],
  'paymentOperatorPhoneNumbers' => ['+79998887766'],
  'paymentOperatorName' => 'Name',
  'paymentOperatorAddress' => 'ulitsa Adress, dom 7',
  'paymentOperatorINN' => '3123011520',
  'supplierPhoneNumbers' => ['+79998887766', '+76667778899'],
];

$buyer->add_agent_to_order($agent);

Cвойства агента

Добавление дополнительного реквизита пользователя

<?php
$userAttribute = [
  'name' => 'Like',
  'value' => 'Example',
];

$buyer->add_user_attribute($userAttribute);

Cвойства дополнительного реквизита пользователя

Добавление дополнительных полей

<?php
$additional = [
  'additionalAttribute' => 'Attribute',
  'customer' => 'Ivanov Ivan',
  'customerINN' => '0987654321',
];

$buyer->add_additional_attributes($additional);

Cвойства дополнительных полей

Cвойства customerInfo

Cвойства operationalAttribute

Cвойства industryAttribute

Для ФФД1.2 Параметры Customer и customerINN изменяется на один параметр customerInfo.

Добавление вендинга в заказ

<?php
$vending = [
  'automatNumber' => '21321321123',
  'settlementAddress' => 'Address',
  'settlementPlace' => 'Place',
];

$buyer->add_vending_to_order($vending);

Cвойства вендинга

Добавление курьера в заказ

<?php
$courier = [
  'settlementAddress' => 'Address',
  'settlementPlace' => 'Place',
  'cashier' => 'Test'
  'cashierINN' => '123456789012'
];

$buyer->add_courier_to_order($courier);

Cвойства курьера

Отправка заказа

После того, как заполнены все поля заказа и добавлены все параметры, можно отправлять заказ на обработку:

<?php
$result = $buyer->send_order();
var_dump($result);

Проверка статуса заказа

<?php
$order_status = $buyer->get_order_status(23423423434);
var_dump($order_status);

Чек коррекции

Создание чека коррекции ФФД1.05

<?php
$correction = [
  'id' => '23423423',
  'key' => '1234567',
  'correctionType' => 0,
  'type' => 1,
  'description' => 'cashier error',
  'causeDocumentDate' => new \DateTime(),
  'causeDocumentNumber' => '56ce',
  'totalSum' => 567.9,
  'cashSum' => 567,
  'eCashSum' => 0.9,
  'prepaymentSum' => 0,
  'postpaymentSum' => 0,
  'otherPaymentTypeSum' => 0,
  'tax1Sum' => 0,
  'tax2Sum' => 0,
  'tax3Sum' => 0,
  'tax4Sum' => 0,
  'tax5Sum' => 0,
  'tax6Sum' => 0,
  'taxationSystem' => 2,
];

$buyer->create_correction($correction);

Cвойства чека коррекции

Отправка чека коррекции ФФД1.05

<?php
$result = $buyer->post_correction();
var_dump($result);

Создание чека коррекции ФФД1.2

<?php
  $correction = [
      'ffdVersion' => 4,
      'id' => '23423423',
      'inn' => '7725327863',
      'key' => '1234567',
      'correctionType' => 0,
      'type' => 1,
      'group' => 'main_2',
      'causeDocumentDate' => new \DateTime(),
      'causeDocumentNumber' => '56ce',
      'totalSum' => 0,
      'customerContact' => 'liza@ya.ru',
      'vat1Sum' => 0,
      'vat2Sum' => 0,
      'vat3Sum' => 0,
      'vat4Sum' => 0,
      'vat5Sum' => 0,
      'vat6Sum' => 0,
  ];

$buyer->create_correction12($correction);

Cвойства чека коррекции

Отправка чека коррекции ФФД1.2

<?php
$result = $buyer->post_correction12();
var_dump($result);

Добавление вендинга в чек коррекции

<?php
$correctionVending = [
  'automatNumber' => '21321321123',
  'settlementAddress' => 'Address',
  'settlementPlace' => 'Place',
];

$buyer->add_vending_to_correction($correctionVending);

Cвойства вендинга

Добавление курьера в чек коррекции

<?php
$correctionСourier = [
  'settlementAddress' => 'Address',
  'settlementPlace' => 'Place',
  'cashier' => 'Test'
  'cashierINN' => '123456789012'
];

$buyer->add_courier_to_correction($correctionСourier);

Cвойства курьера

Добавление дополнительных аттрибутов, позиции и оплаты в чек коррекции (только для ФФД1.2)

<?php
 $correctionPos = [
      "quantity" => 1.000,
      "price" => 1,
      "tax" => 6,
      "text" => "Булка",
      "excise" => 23.45,
      "paymentMethodType" => 4, "paymentSubjectType" => 1,
      "agentType" => 127,
      "agentInfo" => 
      [
        "paymentTransferOperatorPhoneNumbers" => ["+79200000001", "+74997870001"], 
        "paymentAgentOperation" => "Какая-то операция 1",
        "paymentAgentPhoneNumbers" => ["+79200000003"], 
        "paymentOperatorPhoneNumbers" => ["+79200000002", "+74997870002"], 
        "paymentOperatorName" => "ООО \"Атлант\"", 
        "paymentOperatorAddress" => "Воронеж, ул. Недогонная, д. 84", 
        "paymentOperatorINN" => "7727257386"
      ]
  ];

  $correctionPayment =
      [
          'type' => 1,
          'amount' => 1,
      ];

  $userAttribute = [
    "value" => "2132",
    "name" => "21212"
  ];

  $additional = [
      'additionalAttribute' => 'Attribute',
       "customerInfo" =>[
            "name"=> "Кузнецов Иван Петрович",
            "inn"=> "7725327863",
            "birthDate"=> "15.09.1988",
            "citizenship"=> "643",
            "identityDocumentCode"=> "01",
            "identityDocumentData"=> "multipassport",
            "address"=> "Басеенная 36"
        ],
  ];

$buyer->add_position_to_correction12($correctionPos)
      ->add_payment_to_correction12($correctionPayment)
      ->add_user_attribute_to_correction12($userAttribute)
      ->add_additional_attributes_to_correction12($additional);

Cвойства функций см. в аналогичных блоках для заказа

Проверка статуса чека коррекции

<?php
$cor_status = $buyer->get_correction_status('23423423');
var_dump($cor_status);