Part of stoqdrivers.interfaces View In Hierarchy
Workflow:
--<-- --<--
| | | |
[identify_customer] -> open -> add_item -> totalize -> add_payment -> close
| Method | coupon_identify_customer | Identify the customer. This method doesn't have mandatory |
| Method | coupon_is_customer_identified | Returns True, if the customer have already been identified, |
| Method | coupon_open | This needs to be called before anything else (except |
| Method | coupon_add_item | Adds an item to the coupon. |
| Method | coupon_cancel_item | Cancels an item, item_id must be a value returned by |
| Method | coupon_cancel | Cancels the currently open coupon or the last closed open. |
| Method | cancel_last_coupon | Cancel the last closed non-fiscal coupon or the last sale. |
| Method | coupon_totalize | Closes the coupon applies addition a discount or surcharge and tax. |
| Method | coupon_add_payment | Add payment method to coupon. |
| Method | coupon_close | It needs to be possible to open new coupons after this is called. |
| Method | summarize | Prints a summary of all sales of the day. In Brazil this is |
| Method | close_till | Close the till for the day, no other actions can be done after |
| Method | till_add_cash | Add an till complement. This is called 'suprimento de caixa' on |
| Method | till_remove_cash | Retire payments from the till. This is called 'sangria' on Brazil |
| Method | till_read_memory | Reads the fiscal memory, from the date start to the date end |
| Method | till_read_memory_by_reductions | Reads the fiscal memory, from the start reductions to the end |
| Method | get_payment_receipt_identifier | If the printer requires an identifier to open a payment receipt, |
| Method | payment_receipt_open | Opens a non-fiscal bound receipt for a payment |
| Method | payment_receipt_print | Prints the payment receipt text |
| Method | payment_receipt_close | Closes previouly opened payment receipt |
| Method | get_capabilities | Returns a capabilities dictionary, where the keys are the strings |
| Method | get_constants | Returns the object that implements IDriverConstants where the printer |
| Method | get_payment_constants | Undocumented |
| Method | get_serial | Returns the serial number for the printer |
| Method | get_sintegra | Gets an object that implements ISintegraData or None. |
| Method | get_firmware_version | Firmware version of the printer |
| Method | get_ccf | Fiscal Coupon Counter |
| Method | get_coo | Operation Order Counter |
| Method | get_gnf | Nonfiscal Operation General Counter |
| Method | get_crz | Z Reduction Counter |
| Method | get_user_registration_info | Returns current ecf user registration date and time, |
| Parameters | customer | (type: str ) |
| address | (type: str ) | |
| document | (type: str ) |
| Parameters | code | item code identifier (type: str ) |
| description | description of product | |
| desription | (type: str ) | |
| price | price (type: Decimal ) | |
| taxcode | constant to descrive the tax (type: str ) | |
| quantity | quantity (type: Decimal ) | |
| unit | constant to describe the unit (type: integer constant one of: UnitType.LITERS, UnitType.EMPTY, UnitType.METERS, UnitType.WEIGHT, UnitType.CUSTOM. ) | |
| discount | discount in % (type: Decimal between 0-100 ) | |
| surcharge | surcharge in % (type: Decimal between 0-100 ) | |
| unit_desc | A 2-byte string representing the unit that applies to the product. (type: str ) | |
| Returns | identifier of added item (type: Decimal ) | |
| Parameters | item_id | the item id |
| Parameters | discount | discount in % (type: Decimal between 0-100 ) |
| surcharge | surcharge in % (type: Decimal between 0-100 ) | |
| taxcode | constant to descrive the tax (type: integer constant one of: TaxType.NONE, TaxType.SUBSTITUTION, TaxType.EXEMPTION ) | |
| Returns | (type: Decimal @returns the coupon total value ) | |
| Parameters | payment_method | The payment method. (type: a device specific value representing the payment value ) |
| value | The payment value (type: Decimal ) | |
| description | A simple description of the payment method to be appended to the coupon. | |
| value | (type: unicode ) | |
| Returns | the total remaining amount (type: Decimal ) | |
| Parameters | message | promotional message (type: str ) |
| Returns | identifier of the coupon. (type: int ) | |
| Parameters | previous_day | if this is to close a till opened previously |
| Parameters | value | The value added (type: Decimal ) |
| Parameters | value | The value to remove (type: Decimal ) |
| Parameters | start | start date (type: datetime.date ) |
| end | end date (type: datetime.date ) |
| Parameters | start | start reductions (type: int ) |
| end | end reductions (type: int ) |
| Parameters | method_name | get receipt for specific method name. |
| Parameters | identifier | a char (A-P) representing the receipt to use. The receipt must already be configured at the printer. |
| method | another char (A-P) for the payment method. Also, this must be configured at the printer. The payment method must be bindable | |
| coo | coo for the coupon containing the payment | |
| value | the value of the payment |
* item_code (str) * item_id (int) * items_quantity (float) * item_price (float) * item_description (str) * payment_value (float) * payment_description (str) * promotional_message (str) * customer_name (str) * customer_id (str) * customer_address (str) * add_cash_value (float) * remove_cash_value (float)