| Table of Contents |
|---|
1 Introduction
1.1 Document purpose
This document describes the interface between the SecuTix 360º ticketing system and their customers' accounting systems. These systems are applications that are independent from the ticketing system.
This document provides examples of exported accounting files and explains the customers how to select the data to import into their accounting system.
This document describes the status of the interfaces with the "JungfrauNordend" version 3 (Version 2 3 of the accounting interface, June July 20132014)
1.2 Document structure
Chapter 1 contains this introduction.
...
Chapter 5 describes in detail the exported files contents.
2 Interface description
2.1 Solution perimeter
The accounting interface is a generation system of text files containing accounting data which are exported from SecuTix source data.
The following scheme illustrates the accounting interface principle:
The process stages are:
1. SecuTix generates exported files from ticketing system (orders, payments, etc...). The exports are scheduled for automatic exportation once a day. This is the solution perimeter.
...
· Individuals file: This file contains a list of indi
2.2 Export principles
2.2.1 Submission of detailed data
The interface provides detailed information for each sales operation. The data provided in the interface is not the result of any aggregation. On the other hand, the interface provides the complete set of data valid for a given file, with no other selection criteria. For example, the interface does not offer to select data for a subset of products.
Under this principle, the client's accounting system has a maximum flexibility for generating the reports or making the desired analysis.
2.2.2 Only a single submission for a given information
A given record for a given file is only submitted once. In this way, the risk of accounting a sales or payment operation twice is lowerminimized.
...
Data exported in the files is data not yet sent by a previous successful export until the start time of current export.
2.2.3 Data Identification
All identifiers, code, etc. mentioned in the interface are SecuTix identifiers. In order to make it easy for an operator to query the data in the interface, the corresponding SecuTix names are attached to the codes.
If needed, a separate adapter will make any necessary conversions using tables of correspondence.
2.2.4 Date processing
The dates mentioned in the files always represent the calendar dates. For example, an operation dated on July, 25th at 1:30 am will be recorded under July, 25th, even if it is related to the "evening" of July, 24th.
2.2.5 Multiple organisations
If the institution has multiple organisations, there will be a separate file of each type for every organisation.
2.2.6 Currency
SecuTix supports multiple currencies. Therefore, the ISO code for the currency will be attached to every amount shown.
2.2.7 File format
The generated files are encoded in UTF-8 without BOM (byte-order mark) format.
...
No column names ar
2.2.8 File structure
The order of the records in the file is important, especially for files containing different types of records. In such case, the “daughter” line always refers to the previous “mother” line.
Example: If a composite product is sold, the records of the sales file describing the content of the sold product will appear directly after the record describing the composite product itself.
2.2.9 Accounting codes
With a view to allowing the accounting system to record a sale operation (or other) under the adequate account, accounting codes can be configured in the interface for the following entities:
...
Note: certain analytic compatibilities use several accounting lines, so to satisfy this need, we recommend taking several numbers, always from the same order (accounting line 1, accounting line 2...) separated by commas, in the field of the correspondence interface. Then, the accounting system importing the file will be able to easily parse this field and manage the lines as desired.
3 Configuration
The accounting interface is configured in the screen called "Contexte Organisme > Module Outils > Ecran interface comptableListe des interfaces" (Organisation context > Tools module > List of Accounting interface screeninterfaces).: This screen allows access to the control panel of the accounting interfaceThe list of interfaces may be filtered by selecting the type “Interface comptable” (accounting interface).
When you double click on the accounting interface, the "General" screen below opens: It is necessary to report a transfer of the "Envoi" (Submission) type started by SecuTixThe type (of the generated files) is CSV. The URL address, the user name (connection) and the password are irrelevant and are not used. You have now the possibility to enter the email of one or several people who will be informed if the accounting export ends with some warnings or an error.
You have to specify whether accounting codes are necessary or not. If accounting codes are defined as necessary, the absence of an accounting code will cause an error and the concerned record won’t be exported.
If you do not want to export the accounting codes, you have to specify that no mapping table is required and that the accounting codes are not necessary.
The accounting codes are defined in a mapping table. If you want to export the accounting codes, you have to decide if the absence of those codes will cause errors. On the other hand, it is necessary to specify that a mapping table is necessary. This table indeed allows you to retrieve the accounting codes that correspond to products or structures, for example.
The "MappingCorrespondance" (Mapping) screen allows you to create these mappings. After choosing "Nouveau" (New), the entity data type must be selected (e.g. "Produit" (Product)) then its occurrence in the list and enter the corresponding accounting code.
The new field “Produit” (Product) is irrelevant for accounting interfaces.
The “Programmations” (Schedules) screen displays the current scheduling of the export of the different file types.
You can modify the scheduling already configured or create a new scheduling. In both cases (in case of a new scheduling, you first have to select the file you want to export), the following screen is displayed:
The "Configuration" (Configuration) screen displays the file types that can be created.
The screen above gives an example of an export of the invoice file that is scheduled daily at 3am, the first export being scheduled on the 1st of December. Don’t use the options “Jours avant produit daté” (Days before first product date) and “Jours après produit daté” (Days after first product date) for the accounting interface.
By double-clicking on each line, you configure an "Automatique" (Automatic) export every "24 heures" (24 hours).
Then, you can start the regular export by selecting the line on the "ConfigurationProgrammations" (ConfigurationSchedules) screen and clicking on "ACTIVER" (ENABLE).
The regular export is disabled by selecting the line on the "ProgrammationsConfiguration" (ConfigurationSchedules) screen and clicking on "DESACTIVER" (DISABLE).
You can start a single immediate export by selecting the line on the "ProgrammationsConfiguration" (ConfigurationSchedules) screen and clicking on "MODIFIER/DEMARRER" (STARTMODIFY/START) and then on “EXÉCUTION IMMÉDIATE” (IMMEDIATE EXECUTION).
Each generated file is then displayed on the “Exécutions” screen. This screen may be accessed through "Contexte Organisme > Module Outils > Liste des interfaces > (select an interface) > Exécutions” (Organisation context > Tools module > List of interfaces (select an interface) > Executions) or "Contexte Organisme > Module Outils > Ecran Exécutions" (Organisation context > Tools module > Runs Executions screen) (with a filter on the "accounting" interface) via a hyperlink:
Completed exports will have the "OK" status.
Planned exports for the next day have the "PLANIFIE" (Planned) status.
You can download the file manually by clicking on the hyperlink in the "Dernière ligne du journal" (Last line of the log) column. Chapter 4 explains how an import tool can access the generated files automatically.
3.1.1 Multiple interfaces
For a given organization, only one accounting interface can export a given set of data. It is not possible to have 2 interfaces exporting sales, for example. Pagination of results would not work correctly.
4 File access
4.1 Access from the application
The generated files can be downloaded manually from the result screen of a run (by using a filter criterion to quickly access it; for example: interface type = accounting) by clicking on the link provided in one of the first INFO lines.
4.2 Direct access from a URL address
In order to access the accou
...
The user name to be entered is the concatenation of the institution code and the operator user name: INSTIT#USER_LOGIN.
4.3 Direct access to the files
Files may be delivered through FTP to a location defined together with the customer. However, this type of delivery is not very secure.
5 Exported file contents
5.1 Sales file
This file contains the set of information about completed sales.
...
This file contains a record per order line (operation).
In the case of composite products (packages and season tickets), there is a record for the composite product itself and a record for each item that it comprises.
Each record concerning an item in a composite product will mention the composite product it refers to.
5.1.1 Record selection
The exported order lines satisfy the following conditions:
...
§ They refer to orders associated with the current organisation[1].
§ They refer to a product within a sale or refund (requested by the client or by the organisation)[2]
§ The order line does not represent a commission. The sales file mentions the commission amounts for each operation it benefits from. Therefore, the accounting system may recalculate the commission for a given contract and order.
For the composite products, the sales file provides the lines matching the composite product itself as well as the lines matching the content of the composite product.
5.1.2 Product validity period
The following table mentions the information about the validity period available for the different product families.
...
Field | Product Family | Storage in SecuTix |
Validity start date | Single entry (event, visit, competition) | Start date of the performance associated with the operation-related item |
| Dated or undated pass | Validity start date stored in any operation movement For undated passes where the validity duration corresponds to the season, the season start date is used. |
| Membership | Idem (including validity for a season) |
| Transport | Idem |
| Timeslot pass | Date of the timeslot associated with the operation |
| Other product families | No information |
Validity start time | Single entry (event, visit, competition) | Start time of the performance associated with the operation-related item |
| Timeslot pass | Time of the timeslot associated with the operation |
| Other product families | No information |
Validity end date | Dated or undated pass | Validity end date stored in any operation movement For undated passes where the validity duration corresponds to the season, the season end date is used. |
| Membership | Idem (including validity for a season) |
| Transport | Idem. Only available for return tickets. |
| Other product families | No information |
5.1.3 File structure
The generated file name is:
· YYYY/MM/DD/Ventes_YYYYMMDD_S.txt
...
No. | Description | Field (DB) | |||||||||||||
1 | Record type, a flag indicating if they are: | Operations: | |||||||||||||
2 | Operation number (technical identifier). This number is used as the link to the cash flow file. | OPERATION.OPERATION_ID | |||||||||||||
3 | Operation type: In case of a refund, all amounts are negative | OPERATION.TYPE AS OPERATION_TYPE | |||||||||||||
4 | Order number | ORDER_TABLE.ORDER_ID | |||||||||||||
5 | Date and time of the associated order | ORDER_TABLE.CREATION_DATE AS ORDER_CREATION_DATE | |||||||||||||
6 | Technical number of the point of sales | POINT_OF_SALES.POS _NUM | |||||||||||||
7 | Technical number of the sales channel | SALES_CHANNEL.SALCHAN_ID | |||||||||||||
8 | Reserved for accounting code of the sales channel. This field is currently set to NULL. Data Type: VARCHAR2(100 CHAR) | INTERFACE_MAPPING.value[ | |||||||||||||
9 | Operator last name[3] Note: link through ORDER_TABLE.RESPONSIBLE_USER <-> USER_TABLE.LOGIN | USER_TABLE.LASTNAME AS OPERATOR_LASTNAME | |||||||||||||
10 | Operator first name | USER_TABLE.FIRSTNAME AS OPERATOR_FIRSTNAME | |||||||||||||
11 | Operator login name | USER_TABLE.LOGIN AS OPERATOR_LOGIN | |||||||||||||
12 | Cash desk number (if available)[4] | CASH_DESK.CASHDESK_ID | |||||||||||||
13 | Order line kind: · PRODUCT_COMPOSITION: order line within a package or a season ticket · SINGLE_ENTRY: order line for a product (event, competition, visit, etc.), not included in the package or season ticket · ORDER_OVERHEADS: order line for general charges (related to the order) · PAYMENT_OVERHEADS: order line for payment charges · DELIVERY_OVERHEADS: order line for delivery charges · CHARGES: order line for simple charges (related to the tickets) · COMPOSED_PRODUCT: order line for the package or the season ticket themselves · SIMPLE_PRODUCT: order line for a service or pass not included in a package or season ticket | OPERATION.KIND AS OPERATION_KIND | |||||||||||||
14 | Purchase contact number | CONTACT.CONTACT_NUMBER | |||||||||||||
15 | Reserved for the purchase contact accounting code. Contains currently the role of the contact. Possible values are: RELAY, PUBLIC | Foreseen: Current: CONTACT.ROLE | |||||||||||||
16 | Purchase contact last name (if an individual) | INDIVIDUAL.LASTNAME AS IND_LASTNAME | |||||||||||||
17 | Purchase contact first name (if an individual) | INDIVIDUAL.FIRSTNAME AS IND_FIRSTNAME | |||||||||||||
18 | Purchase contact official name (if it is a structure) | STRUCTURE.OFFICIAL_NAME AS STRUCT_NAME | |||||||||||||
19 | Technical number of the season. The season is only indicated if the record is related to a product or a simple charge. | Product or simple charge: SEASON.SEASON_ID | |||||||||||||
20 | Season name. The season is only indicated if the record is related to a product or a simple charge. | Product or simple charge: SEASON.INTERNAL_NAME_L1 AS SEASON_NAME | |||||||||||||
21 | Code of the organisation responsible for the bought product
| OR Note: link per ITEM <-> PRODUCT <-> CATALOG <-> SEASON <-> ORGANIZATION | |||||||||||||
22 | Internal name of the organisation responsible for the bought product | ORGANIZATION.INTERNAL_NAME_L1 AS RESP_ORGANIZ_NAME | |||||||||||||
23 | Record type, a flag indicating if they are: | Product:
| |||||||||||||
| 4 types of charges: a: delivery charges (shipment fee): "DELIVERY_OVERHEADS" b: order charges (general charges): "ORDER_OVERHEADS" c: payment charges (general charges): "PAYMENT_OVERHEADS" d: simple charges: "CHARGES" | Charges: b, c order or payment charges (Link per ORDER <-> OPERATION <-> OVERHEADS) d: simple charges (Link per ORDER <-> OPERATION <-> CHARGES) | |||||||||||||
24 | Product or charge code
| Product: Charges: b, c: OVERHEADS.CODE AS PRODUCT_CODE d: CHARGES.CODE AS PRODUCT_CODE | |||||||||||||
25 | Product or charge internal name | Product: b, c: OVERHEADS.INTERNAL_NAME_L1 AS PRODUCT_NAME d: | |||||||||||||
26 | Accounting code for the product, the performance or the charge (if available) | Product: Charges: | |||||||||||||
27 | Product family code Possible values:
| Product: | |||||||||||||
28 | The data contained in this field depends on the context: For a product, it is the internal name of the product family For simple charges, operation number that the charges are attached to The field is blank for other charge types. | Product: Charges: | |||||||||||||
29 | Audience category code | Product: | |||||||||||||
30 | Internal name of the audience category | Product: | |||||||||||||
31 | Audience subcategory code | Product: | |||||||||||||
32 | Internal name of the audience subcategory | Product: | |||||||||||||
33 | Product validity start: · Date and time of the performance (if a performance is associated with the operation) · Date and time of the timeslot (in case of a timeslot pass) · Date of the dated pass · Validity start date of an undated pass, a transport or a membership · This is null for any other products Data Type: TIMESTAMP(3) | Performance: PERFORMANCE.START_TIME AS VALIDITY_START Note: link per OPERATION <-> ITEM <->PERFORMANCE
Pass, membership, transport: MOVEMENT.BEGIN_DATE AS VALIDITY_START
Timeslot pass: TIMESLOT.START_DATE + TIMESLOT.START_TIME AS VALIDITY_START
Note: link per OPERATION > TIMESLOT | |||||||||||||
34 | Validity end of the product for the passes, memberships and transports. This field may be null for certain transportation types (e.g. one-way). It is null for any other products. Ex.: 15.07.09 00:00:00.000000000 | Pass, membership, transport: MOVEMENT.END_DATE Other product or charge:
| |||||||||||||
35 | Single entry: Performance identifier | Single entry:
| |||||||||||||
| Goods product: Reference of the goods item | Goods product: GOODS_ITEM.REFERENCE | |||||||||||||
| Service/voucher: Code of the item | SERVICE_ITEM.code | |||||||||||||
36 | Contingent code (if a contingent associated with the operation) | Product: | |||||||||||||
37 | Internal name of the contingent (if a contingent associated with the operation) | Product:
| |||||||||||||
38 | Seat category number (if seat categories are associated with the operation) | Product: | |||||||||||||
39 | Activity code (if an event is associated with the operation) | Product:
| |||||||||||||
40 | Internal name of the activity (if there is an event associated with the operation) | Product: | |||||||||||||
41 | Code of the composite product if the current operation corresponds to a package or season ticket line.
| Product: Note: | |||||||||||||
42 | Internal name of the composite product if the current operation corresponds to a package or season ticket line. | Product:
| |||||||||||||
43 | Type of the composite product if the current operation corresponds to a package or season ticket line. | Product: | |||||||||||||
44 | Accounting code of the composite product if the current operation corresponds to a package or season ticket line. | Product: | |||||||||||||
45 | Number of articles in the order line | OPERATION.QUANTITY | |||||||||||||
46 | ISO code of the currency used for all amounts mentioned in the current record Data Type : CHAR(3) Ex : EUR, CHF, USD | CURRENCY.ISO_NUMBER of the organisation’s main currency. The organisation concerned is the one containing the point of sale of the order to which belongs the current operation. | |||||||||||||
47 | Base unit price (taxes included) of the product or charge. This price is expressed in tenths of cents. The base price is the catalogue price and doesn’t take into account special discounts | OPERATION.BASE_UNIT_AMOUNT AS TTC_BASE_UNIT_AMOUNT | |||||||||||||
48 | Unit price (taxes included) of the product or charge. This price is expressed in tenths of cents. The unit price is the price effectively paid by the customer taking into account applied discounts.
Data Type: NUMBER(38,0) | OPERATION.UNIT_AMOUNT AS TTC_UNIT_AMOUNT | |||||||||||||
49 | Net amount of the product or charge. This amount is expressed in tenths of cents. It is always based on the unit amount to be paid. Data Type: NUMBER(38,6) | (OPERATION.WITHOUT_VAT_UNIT_AMOUNT * OPERATION.QUANTITY) AS HT_TOTAL_AMOUNT | |||||||||||||
50 | VAT rate of the product or charge, in thousandths of a percent. It is the effectively applied rate during this sale (even if the rate has been modified in the meantime in the configuration) | Product: | |||||||||||||
51 | VAT amount of the product or charge. This amount is expressed in tenths of cents.
Data Type: NUMBER(38,6) | Product: | |||||||||||||
52 | Unit amount (taxes included) of the commission, expressed in tenths of cents. This field is null if no commission has been granted.
| Operation associated with an operation of the "commission" kind. OPERATION.UNIT_AMOUNT – OPERATION.COMMISSIONNED_UNIT_AMOUNT Operation not associated with an operation of the "commission" kind. NULL | |||||||||||||
53 | Commission rate effectively granted, in thousandths of a percent. It may be different from the rate defined in the contract It may be null even if a commission is granted (commission defined by a fixed amount).
| Operation associated with an operation of the "commission" kind. COMMISSION.USED_RATE AS USED_COMMISSION_RATE Operat NULL | |||||||||||||
54 | Internal name of the contract applied to this operation. This field is null if no commission has been granted. | Operation associated with an operation of the "commission" kind. CONTRACT.INTERNAL_NAME AS CONTRACT_INTERNAL_NAME Operation not associated with an operation of the "commission" kind. NULL | |||||||||||||
55 | Reference of the contract applied to this operation. This field is null if no commission has been granted. | Operation associated with an operation of the "commission" kind. CONTRACT.REFERENCE AS CONTRACT_REFERENCE | |||||||||||||
|
| Operation not associated with an operation of the "commission" kind. NULL | |||||||||||||
56 | Number of lines of the sales price breakdown. This number should be ignored for the moment. The export of the price breakdown hasn’t been implemented yet. Data Type: INTEGER | COUNT(AMOUNT_BREAKDOWN.AMOUNTBD_ID) AS PRICE_COMP_NBR | |||||||||||||
57 | Comment in the order, without line breaks or tabs Data Type: VARCHAR2(2000 CHAR) | ORDER_TABLE.REMARK | |||||||||||||
58 | Designation of the product related to the Data Type: VARCHAR2(1000 CHAR) | OPERATION.PRODUCT_DESIGNATION AS PRODUCT_DESIGNATION | |||||||||||||
59 | Number of the file the order line belongs to. Generally, an order belongs to a unique file but an order my relate to several files in some cases (e.g. refunding a large number of order lines belonging to different files). | OPERATION.FILE_ID |
5.1.4 Example
Below you can find a line of the "sales" file, related to the purchase of a single entry for a competition. In th
...
OP | 420399201 | SALE | 2417 | 201205181005 | 28 | 113432393 | Siegfried | Stéphane | STX_SSI | 226659560 | SINGLE_ENTRY | | | | | 191268952 | 2012-13 | HAC | SAS Océane Stadium - TEST | P | FFF | Coupe de France | Compét | INT_PRODFAM/SPORTING | OccCont | AUDCAT_TYPE/OccCont | Adulte | Adulte | 201210092000 | | 419462708 | | | C1 | Champion | Compétitions | | | | 1 | 30000 | 30000 | 30000 | 0 | 0 | | | | 0 | |
5.2 Cash flow file
This file contains the set of data related to payments made and the projected debits. It contains one record per each payment.
Certain payments are not related to orders (e.g. a refund of the credit note). Therefore, they are included in the cash flow file but they do not have an equivalent in the sales file. The same applies to the deposits related to files that are still open.
5.2.1 Record selection
The payments to be taken into account must meet the following conditions:
...
§ They are associated with cash desks that have been closed and verified by the accountant ("accounting closed" status) or with cash desks for virtual operators[6]
§ They are associated with the current organisation points of sale
...
No. | Description | Field (DB) |
1 | Technical identifier for the payment | PAYMENT.PAYMENT_ID |
2 | Date of the payment | TRUNC(PAYMENT.REFERENCE_DATE) AS REFERENCE_DATE |
3 | Due date (in case of deferred payment, if the payment is associated with exactly one due date)
| TRUNC(DUE_DATE.DUE_DATE) AS DUE_DATE |
4 | Cash desk technical identifier number | CASH_DESK.CASHDESK_ID |
5 | Operator's last name (à responsible for the order) | USER_TABLE.LASTNAME AS OPERATOR_LASTNAME Note: link through CASH_DESK |
6 | Operator first name | USER_TABLE.FIRSTNAME AS OPERATOR_FIRSTNAME |
7 | Operator login name | USER_TABLE.LOGIN AS OPERATOR_LOGIN |
8 | Technical identifier number of the point of sales | POINT_OF_SALES.POS_NUM |
9 | ISO code of the organisation’s currency Data Type : CHAR(3) Ex : EUR, CHF, USD | CURRENCY.ISO_NUMBER of the main currency of the organization containing th |
10 | Payment amount (negative in case of a refund), expressed in the organisation’s main currency; this amount corresponds to tenths of cents. This is the amount that must be used to make comparisons with the other files in the accounting interface. | PAYMENT.INSTITUTION_AMOUNT |
11 | Amount expressed in the buyer’s currency Data Type : NUMBER(38,0) | PAYMENT.CURRENCY_AMOUNT |
12 | ISO code of the currency selected by the buyer Data Type : CHAR(3) Ex : EUR, CHF, USD | PAYMENT.CURRENCY_CODE |
13 | Payment method code | PAYMENT_METHOD.CODE AS PAYMENT_METHOD_CODE |
14 | Payment method internal name | PAYMENT_METHOD.INTERNAL_NAME_L1 AS PAYMENT_METHOD_NAME |
15 | Payment method accounting code | INTERFACE_MAPPING.value[ |
16 | Bank code (optional for cheques, always indicated for bank debits) | BANK.BANK_CODE |
17 | Bank name (optional for cheques, | BANK.NAME AS BANK_NAME |
18 | Cheque number (as appropriate) | PAYMENT.IDENTIFICATION AS CHEQ_NUMBER |
19 | IBAN number (for bank debits) | PAYMENT.IBAN |
20 | Authorisation technical number returned by the external payment system (for bank cards and cheques, if available) | PAYMENT.IDENTIFICATION AS CLEARING |
21 | Payment kind: · Direct payment: DIRECT_PAYMENT · Deposit credit (negative amount): CREDIT_DEPOSIT · Deferred payment: POSTPONED_PAYMENT · Credit note credited (negative amount): CREDIT_CREDIT_NOTE · Payment by debiting the credit note: DEBIT_CREDIT_NOTE · Payment through the use of a deposit: DEBIT_DEPOSIT · Credit transferred to the waiting account (negative amount): CREDIT_WAIT_ACCOUNT · Payment by debiting the waiting account: DEBIT_WAIT_ACCOUNT · Refunds (negative amount): REFUND · Refund of the credit note (negative amount): REFUND_CREDIT_NOTE · Refund of a deposit: DEPOSIT_CREDIT_NOTE · Payment cancellation (after an error has been discovered): CANCELLATION Data Type: VARCHAR2(20 BYTE) | PAYMENT.PAYMENT_KIND |
22 | Payment state | PAYMENT.STATE AS PAYMENT_STATE |
23 | Order number (if existing) | ORDER_TABLE.ORDER_ID |
24 | Contact number of the payer (if it exists; anonymous payments do not have a contact) | CONTACT.CONTACT_NUMBER |
25 | Reserved for the accounting code of the payer (if it exists). Contains currently the role of the contact. Possible values are: RELAY, PUBLIC | Foreseen: Currently: |
26 | Payer's last name (in case it is an individual) | INDIVIDUAL.LASTNAME AS IND_LASTNAME |
27 | Payer's first name (in case it is an individual) | INDIVIDUAL.FIRSTNAME AS IND_FIRSTNAME |
28 | Contact official name (if it is a structure) | STRUCTURE.OFFICIAL_NAME AS STRUCT_NAME |
29 | Number of operations associated with this payment | COUNT (OPERATION.OPERATION_ID) AS COUNT_OPERATIONS |
30 | Number of the file directly related to the payment. This information is provided in case of payment of a deposit. | PAYMENT.FILE_ID |
• List of operations associated with the payment (substructure)
After each payment, the file contains a list of technical identifiers of order lines that are covered (at least partially) by the previous payment. The technical identifiers of command lines correspond to those in column 2 of the sales file. A record type has been added to the record so that the different lists may be distinguished easily. The format of these data is as follows:
No. | Description | Field (DB) |
1 | Record type | “OPE” |
2 | Operation identifier | OPERATION.OPERATION_ID |
3 | File number. Number of the file the operation belongs to Data Type: NUMBER(38,0) | OPERATION.FILE_ID |
• List of instalments associated with the payment (substructure)
After each payment, the file contains a list of technical identifiers of instalments that are covered (at least partially) by the previous payment. The technical identifiers of instalments correspond to those in column 1 of the instalments file. A record type allows distinguishing easily the different lists. The format of these data is as follows:
No. | Description | Field (DB) |
1 | Record type | “INS” |
2 | Instalment identifier | INSTALLMENT.INSTALLMENT_ID |
3 | Part of the instalment amount paid by the current payment. This is an amount expressed in the same currency as the instalment. This amount corresponds to tenths of cents. | AT_INSTALLMENT_PAYMENT.CURRENCY_AMOUNT |
5.2.3 Example
This is an example of a line in the "cash flow" file, for a payment in cash that covers three command lines. In this example, tabs between the fields have been replaced with the pipe symbol " | ": Firstly, it is the payment information and later three supplementary lines that indicate which order lines and which instalments (if any) are covered:
...
This file doesn’t mention the payment state of each instalment. Instead, the cash flow file contains also the payments destined to pay the instalments.
5.3.1 Record selection
The instalments to be taken into account must meet the following conditions:
...
§ Due date
§ Payment method
5.3.2 File structure
The generated file name is:
...
No. | Description | Field (DB) |
1 | Technical identifier for the instalment | INSTALLMENT.INSTALLMENT_ID |
2 | Sequence number of instalment Data Type: INTEGER | INSTALLMENT.RANK |
3 | Amount of instalment (without taking possible payments into account). This amount corresponds to tenths of cents. | INSTALLMENT.CURRENCY_AMOUNT |
4 | ISO code of the currency in which the previous amount is expressed Data Type : CHAR(3) Ex : EUR, CHF, USD | INSTALLMENT.CURRENCY_CODE |
5 | Due date Data Type: TIMESTAMP(3) | INSTALLMENT.DUE_DATE |
6 | Number of order related to this instalment Data Type: NUMBER(38,0) | INSTALLMENT.ORDER_ID |
7 | Number of invoice related to the instalment. This information is only available if the order related to the instalment has been invoiced. Data Type: VARCHAR2(100 CHAR) | INVOICE.INVOICE_NUMBER AS INVOICE_NUMBER |
8 | Payment method code. Payment method foreseen in order to pay the current instalment. SecuTix doesn’t forbid the buyer to use another payment method at the time of effective payment. | PAYMENT_METHOD.CODE AS PAYMENT_METHOD_CODE |
9 | Payment method internal name. Payment method foreseen in order to pay the current instalment. SecuTix doesn’t forbid the buyer to use another payment method at the time of effective payment | PAYMENT_METHOD.INTERNAL_NAME_L1 AS PAYMENT_METHOD_NAME |
5.3.3 Example
The example below gives the list of the instalments of a given The order number and the invoice number allow to link the information to other files.
...
467006629|2|22400|USD|20160211|785913|A-A+1-000370|BankTran|Virement bancaire
5.4 Invoices file
This file contains the set of invoices issued since the last file submission. It contains one record per each invoice. Each invoice has a record per every operation associated with it.
5.4.1 Record selection
The invoices to be taken into account must meet the following conditions:
...
N° | Description | Field (DB) |
1 | All attributes of sales file. In case a record describes a commission operation, following rules apply: Field 23 (record type) gets the value ‘F’ Field 24 represents a commission code (instead of a product or a charge code) Field 25 represents the commission internal name Field 27 (product family code) is set to ‘COMMISSION’ Field 28 stores the number of an operation that gets the current commission. | See sales file |
5.4.3 Example
The following is an example of a line of the "invoice" file, for an invoice containing three operations. In this example, tabs between the fields have been replaced with the pipe symbol " | ": First, we find the invoice data and later tree supplementary lines indicating the details of the operation:
...
OP | 229473540 | SALE | 251 | 201204021822 | 27 | 225008507 | Dauzout | Virginie | VIRGINIE | 228895598 | PRODUCT_COMPOSITION | 26560 | RENAUD | Maxime | | 191268952 | 2012-13 | HAC | SAS Océane Stadium - TEST | P | GalaHAC | Match de Gala, 140 ans du HAC | Evén | INT_PRODFAM/SIMPLE | OccCont | AUDCAT_TYPE/OccCont | AboAdul | Abonné HAC adulte | 201209091800 | | 199607918 | | | | | SUPPOR | Evénem | Evénements | PackInau | Pack Spectacle Inaugural + Match 140 ans | | 1 | 10000 | 10000 | 10000 | 0 | 0 | | | | | 0 |
5.5 Structures file
This file describes the set of structures that are known of a certain organisation. Each record describes one structure.
...
A contact acting as a simple spectator has the “public” role. A contact person of a company is a “relay” of that company.
5.5.1 Record selection
The structures to be taken into account must meet the following conditions:
...
§ They are visible from the current organisation[7]
§ Each of them is associated with a public role contact
5.5.2 File structure
The generated file name is:
...
No. | Description | Field (DB) |
1 | Record type, a flag indicating if they are: | Operations: |
2 | Structure identifier | STRUCTURE.STRUCTUR_ID AS STRUCTURE_ID |
3 | Administrative number code | ADMINISTRATIVE_NUMBER.CODE AS ADM_NUMBER_CODE |
4 | Administrative number internal number | ADMINISTRATIVE_NUMBER.ADMINNUM_ID AS ADM_NUMBER_ID |
5 | Administrative number value | ADMINISTRATIVE_NUMBER_VALUE.VALUE AS ADM_NUMBER_VALUE |
5.5.3 Example
STR|PEUGEOT|AmComité|Comité d'entreprise|34500|2820||||AVENUE DE LA CITADELLE||25000|BESANCON|F|2999-12-31 00:00:00.0|false|
...
NAD|SIRET|22720196|20597799|
5.6 Individuals file
This file describes the set of individuals that are known of a certain organisation. Each record describes an individual who can be attached to a structure.
SecuTix manages structures, individuals and contacts. A structure is a company or a community. An individual is a physical person. An individual may have several roles. He may act as a simple spectator, as a journalist, as a contact person of a company. Each role corresponds to a contact. A specific contact represents the company itself (in opposition to an individual working in that company).
5.6.1 Record selection
The individuals to be taken into account must meet the following conditions:
...
§ They are visible from the current organisation[8]
§ This individual is associated with at least one public role contact or relay
5.6.2 File structure
The generated file name is:
...
No. | Description | Field (DB) |
1 | Record type, possible values: | Record type |
2 | Title of the contact
| INDIVIDUAL.TITLE |
3 | Contact's last name
| INDIVIDUAL.LASTNAME |
4 | Contact's first name
| INDIVIDUAL.FIRSTNAME |
5 | If existing, number of the public role contact associated with the individual (ROLE = "PUBLIC") | CONTACT.CONTACT_NUMBER |
6 | Reserved for the accounting code of the contact associated to the individual (if available). Contains currently the role of the contact. Possible values are: RELAY, PUBLIC Data Type: VARCHAR2(100 CHAR) | Foreseen: Currently: |
7 | Way number of the contact main address | CONTACT_ADDRESS.WAY_NUMBER |
8 | Way type of the contact main address | CONTACT_ADDRESS.WAY_TYPE |
9 | Way name of the contact main address | CONTACT_ADDRESS.WAY |
10 | Way complement of the contact main address | CONTACT_ADDRESS.WAY_COMPLEMENT |
11 | Zip code of the contact main address | CONTACT_ADDRESS.ZIPCODE |
12 | Town of the contact main address | CONTACT_ADDRESS.TOWN |
13 | Country of the contact main address | CONTACT_ADDRESS.COUNTRY_CODE |
14 | Fixed telephone number of the contact[9] | COMMUNICATION_MEAN.NAT_PHONE_NUMBER AS FIXED_PHONE Note: DTYPE = "FIXED_PHONE" |
15 | Fixed fax number of the contact[10] | COMMUNICATION_MEAN.NAT_PHONE_NUMBER AS FAX_PHONE Note: DTYPE = "FAX_PHONE" |
16 | Cellular telephone number of the contact[11] | COMMUNICATION_MEAN.NAT_PHONE_NUMBER AS MOBILE_PHONE Note: DTYPE = "CELLULAR_PHONE" |
17 | Contact's email address[12] | COMMUNICATION_MEAN.VALUE AS EMAIL Note: DTYPE = "EMAIL" |
18 | Contact validity end date (may be null) | CONTACT.END_VALIDITY_DATE AS END_VALIDITY_DATE |
19 |
| AT_STRUCTURE_CONTACT à AT_STRUCTURE_CONTACT à CONTACT.CONTACT_NUMBER |
20 | Additional information (e.g. floor, apartment number) of the contact main addresss | CONTACT_ADDRESS.APARTMENT |
Remarks:
§ Identifying a contact:
...
No. | Description | Field (DB) |
1 | AUT: Authorisations to communicate | Record type |
2 | Authorisation code | CONTACT_AUTHORIZATION.CODE AS AUTHORIZATION_CODE |
3 | Authorisation internal name
| CONTACT_AUTHORIZATION.INTERNAL_NAME_IC AS AUTHORIZATION_NAME |
4 | Authorisation value
| CONTACT_AUTHORIZATION_VALUE.ALLOWED AS AUTHORIZATION_VALUE |
5.6.3 Example
Main record:
IND|Monsieur|TAKATA|Miso|2327|PUBLIC|||16 RUE DU KARATÉ||1234|KYOTO|JP||||miso.takata@ne-pas-envoyer.com|2999-12-31 00:00:00.0||Appartement 58
...
AUT|EMAIL|AUTHOR_INFO/EMAIL|true
[1] This condition applies in case of multi-organisations, the current organisation being the one for which the file is generated.
[2] The operation type is "Remboursement organisme" (REFUND_ORGANIZATION), "Remboursement public" (REFUND_CLIENT) or "Vente" (SALE).
[3] Last name and first name of the unique user associated with this operator
[4] This number is not required (this is not available in case of a free article), but it allows the accounting service to work, through combinations and auto-review. The cash desk in question is not necessarily closed.
[5] The charges are the subject of independent operations in SecuTix and independent records in the sales file.
[6] For example, these cash desks that are used for the "internet" sales channel, are rarely closed. Therefore, it is necessary to provide the payments even if the cash desk is not closed. This is not a problem because the payments of this kind of cash desks are not modified after the sale.
[7] Currently, this condition is always ver
[8] Currently, this condition is always verified, since an individual belongs to a contact file visible for the whole institution.
[9] Main communication means of type "fixed telephone" associated with the main address.
[10] Main communication means of type "fax" associated with the main address.
[11] Main communication means of type "cellular phone"
[12] Main communication means of type "cellular phone"