Wiki source code of Импорт денежных сертификатов
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | (% class="lead" %) | ||
| 2 | Since version 2022.1 it is now possible to import ready-made [[gift certificates>>doc:Main.Using.Gift_certificates.WebHome]] created outside of the Loymax system. | ||
| 3 | |||
| 4 | Importing money certificates involves the following steps: | ||
| 5 | |||
| 6 | {{toc start="3"/}} | ||
| 7 | |||
| 8 | === Certificate type creation === | ||
| 9 | |||
| 10 | You need to create [[certificate type>>doc:Main.Using.Gift_certificates.Gift_certificates_MMP.Certificate_types.WebHome]] to further issue and order certificates. The type of denomination and its value can be any. | ||
| 11 | |||
| 12 | === Template Creation === | ||
| 13 | |||
| 14 | You need to create [[Template>>doc:Main.Using.Gift_certificates.Gift_certificates_MMP.Certificate_patterns.WebHome]] to further issue and order certificates. | ||
| 15 | |||
| 16 | === Creation of certificate issue and ordering === | ||
| 17 | |||
| 18 | You need to create [[Issue and Order>>doc:Main.Using.Gift_certificates.Gift_certificates_MMP.Certificate_orders.WebHome]] certificates (without pressing **Execute**). | ||
| 19 | |||
| 20 | === Creation of a ruble account for a legal entity === | ||
| 21 | |||
| 22 | Make sure that the legal entity has a ruble account. If a partner does not have a ruble account, it is necessary to add it [[via MMP>>doc:Main.Using.MMP.Admin_panel.Partners.Legal_entity_editing.WebHome]] or [[via API>>doc:Main.Integration.Ways_to_use_API.System_Api_Methods.Methods_of_system_api.PartnerLegal.WebHome||anchor="001"]] | ||
| 23 | |||
| 24 | === Import certificates === | ||
| 25 | |||
| 26 | Cash certificates are imported using [[API>>doc:Main.Integration.Ways_to_use_API.Gift_certificates_API.API_use_cases.WebHome||anchor="H41843C43F43E44044442434343543D43543D435433D644444B44514443544044443844443843A43044243E432"]] for cash certificates. To do this, you need to prepare a CSV file with information about money certificates. It is possible to get data about the number of import errors using a special [[API>>doc:Main.Integration.Ways_to_use_API.Gift_certificates_API.API_use_cases.WebHome||anchor="https://docs.loymax.net/xwiki/bin/view/Main/Integration/Ways_to_use_API/Gift_certificates_API/API_use_cases/#H41E43144043043143044244B43243043544243843C43F43E44044244143544044243844443843A43044243E432"]] method. | ||
| 27 | |||
| 28 | (% class="box infomessage" %) | ||
| 29 | ((( | ||
| 30 | **Notes:** | ||
| 31 | |||
| 32 | 1. It is recommended to import no more than 100 certificates in one batch. | ||
| 33 | 1. If errors occur during the import, you can make corrections to the source file and repeat the import procedure. Certificates that were loaded without errors will be skipped when the import is restarted. | ||
| 34 | ))) | ||
| 35 | |||
| 36 | ==== Import file requirements ==== | ||
| 37 | |||
| 38 | * Certificates must be uploaded to the System in CSV##;## file format | ||
| 39 | * [[Certificate identifiers>>doc:Main.Using.Gift_certificates.WebHome||anchor="ids"]] which can be used during import: | ||
| 40 | ** The unique number printed on the certificate (Number); | ||
| 41 | ** A unique barcode printed on the certificate (Barcode); | ||
| 42 | ** Information embedded in the magnetic strip (Strip1, Strip2, Strip3); | ||
| 43 | ** QR code printed on the certificate (QRcode). | ||
| 44 | * Possible [[states>>doc:Main.Using.Gift_certificates.WebHome||anchor="lifetime"]] of imported money certificates: | ||
| 45 | ** **Prepared**; | ||
| 46 | ** **Activated**; | ||
| 47 | ** **Redeemed**; | ||
| 48 | ** **Canceled**; | ||
| 49 | ** **Redunded**; | ||
| 50 | ** **Expired.** | ||
| 51 | * The certificate balance (Amount), i.e. the amount in the certificate account, can be anything in the range of 0...100000000, including fractional (rubles and kopecks). | ||
| 52 | * The dates of activation (ActivationDate) and expiration (ExpirationDate) must be transmitted in the format **YYYYY-MM-DD**. | ||
| 53 | |||
| 54 | (% class="box warningmessage" %) | ||
| 55 | ((( | ||
| 56 | You cannot import money certificates that are in a state that indicates an incomplete process: **Activating** or **Returning **(Refunding). | ||
| 57 | ))) | ||
| 58 | |||
| 59 | Example of an imported CSV file with money certificates: | ||
| 60 | |||
| 61 | {{code language="xml"}} | ||
| 62 | Number;BarCode;Strip2;Status;Amount;ActivationDate;ExpirationDate | ||
| 63 | 7770002105606220001;7770002105606220001;7770002105606227847=26067229740000001;Activated;555;2022-11-25;2023-11-25 | ||
| 64 | 7770002105606220002;7770002105606220002;7770002105606227848=26067229740000002;Activated;345;2022-11-25;2023-11-25 | ||
| 65 | 7770002105606220003;7770002105606220003;7770002105606227849=26067229740000003;Activated;100;2022-10-25;2024-10-25 | ||
| 66 | 7770002105606220004;7770002105606220004;7770002105606227850=26067229740000004;Prepared;1000;2022-10-25;2024-10-25 | ||
| 67 | |||
| 68 | {{/code}} | ||
| 69 | |||
| 70 | ((( | ||
| 71 | (% class="box infomessage" %) | ||
| 72 | ((( | ||
| 73 | **Note:** you can only import data about a redeemed certificate (in Redeemed state) if the certificate is a one-time certificate or if the certificate amount (Amount) is zero. | ||
| 74 | ))) | ||
| 75 | |||
| 76 | === Updating information about certificates === | ||
| 77 | |||
| 78 | If changes have been made after importing money certificates, e.g. certificates have been sold, redeemed, cancelled, etc., it is necessary to upload a CSV file with updated data on the certificates whose status has been changed. | ||
| 79 | |||
| 80 | (% class="box successmessage" %) | ||
| 81 | ((( | ||
| 82 | You can also perform **batch activation of money certificates** by transferring a file with money certificates in the state **Activated**. Thus, it is possible to issue a large number of certificates at one time. | ||
| 83 | ))) | ||
| 84 | |||
| 85 | For example, the certificate with number 7770002105606220002 has been redeemed, so you must transmit the updated status (Redeemed) and the redemption date - RedemptionDate in the format **YYYY-MM-DD**. The certificate with the number 7770002105606220004 has been activated, its status has changed from **Activated** to **Activated**, the data about the change should also be transmitted in the import file. An example CSV file for these certificates is shown below: | ||
| 86 | |||
| 87 | {{code language="xml"}} | ||
| 88 | Number;BarCode;Strip2;Status;Amount;ActivationDate;ExpirationDate;RedemptionDate | ||
| 89 | 7770002105606220002;7770002105606220002;7770002105606227848=26067229740000002;Redeemed;0;2022-11-25;2023-11-25;2022-12-12 | ||
| 90 | 7770002105606220004;7770002105606220004;7770002105606227850=26067229740000004;Activated;1000;2022-10-25;2024-10-25 | ||
| 91 | {{/code}} | ||
| 92 | |||
| 93 | (% class="box infomessage" %) | ||
| 94 | ((( | ||
| 95 | **Note: **when updating certificate data, you can transmit any one certificate identifier. | ||
| 96 | ))) | ||
| 97 | |||
| 98 | |||
| 99 | ))) |