- Created by Laurent KLOETZER, last modified by MMI (Unlicensed) on Aug 29, 2018
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 12 Next »
0 Read me !
This page was initially referenced as accounting interface. The content of the data exported did not change but we prefer to promote /wiki/spaces/DOCEN/pages/41621187, which provides more flexibility.
1 Quick reference
Latest version | Examples |
---|---|
3.2 | exemples de fichier à télécharger |
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.
2 Interface description
2.1 Solution perimeter
The following scheme illustrates the accounting interface principle:
SecuTix exports five different file types:
· Individuals file: This file contains a list of individuals known to the ticketing system.
2.2 Export principles
2.2.1 Submission of detailed data
2.2.2 Only a single submission for a given information
2.2.3 Data Identification
If needed, a separate adapter will make any necessary conversions using tables of correspondence.
2.2.4 Date processing
2.2.5 Multiple organisations
2.2.6 Currency
2.2.7 File format
The generated files are encoded in UTF-8 without BOM (byte-order mark) format.
The line break character is \n.
The file contains a header line that only specifies the version number.
2.2.8 File structure
2.2.9 Accounting codes
§ Structure and type of structure
4 File access
4.1 Access from the application
Generated files are kept on SecuTix servers for at least 90 days.
4.2 Direct access from a URL address
From the PRODUCTION environment, the access addresses are as follows:
o https://instit.pos.secutix.com/tnai/FileReader?file_name=Ventes(_VER)_YYYYMMDD(_S).txt
o https://instit.pos.secutix.com/tnai/FileReader?file_name= Encaissements(_VER)_YYYYMMDD-(_S).txt
o https://instit.pos.secutix.com/tnai/FileReader?file_name=Factures(_VER)_YYYYMMDD(_S).txt
o https://instit.pos.secutix.com/tnai/FileReader?file_name=Individuels(_VER)_YYYYMMDD(_S).txt
o https://instit.pos.secutix.com/tnai/FileReader?file_name=Structures(_VER)_YYYYMMDD(_S).txt
· instit is the institution code
· MM is the month with 2 digits
· DD is the day of month with 2 digits
Examples (exports from 16/08/2013)
https://nihon.pos.secutix.com:80/tnai/FileReader?file_name=Individuels_20130816.txt
https://nihon.pos.secutix.com:80/tnai/FileReader?file_name=Structures_20130816.txt
https://nihon.pos.secutix.com:80/tnai/FileReader?file_name=Factures_20130816.txt
https://nihon.pos.secutix.com:80/tnai/FileReader?file_name=Ventes_20130816.txt
https://nihon.pos.secutix.com:80/tnai/FileReader?file_name=Encaissements_20130816.txt
These access URL addresses need a SecuTix operator (either real or virtual) user name / password; the operator must have READ access to the "Contexte organisme > Module Outils > Ecran Exécutions" (Organisation context > Tools module > Runs screen).
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 to a system not managed by SecuTix :
- plain FTP: this is not recommended because transfer is not secured!
- SFTP with login and password: configure url= sftp://hostname:22?proxyPort=NO&ftpDir=XX&otherParam=value, then Connection = yourLogin and password = yourPassword.
- SFTP with certificate: configure url= sftp://hostname:22?proxyPort=NO&ftpDir=XX&otherParam=value, then Connection = PUBLIC_KEY_AUTH/yourLogin and password = the certificate in openSSH format (=starts by -----BEGIN DSA PRIVATE KEY----- ....)
- AWS S3: configure url = s3://bucketName/region?ftpDir=XXX then Connection = AWSaccessKeyId and password = AWSsecretAccessKey
- HTTP POST with basic auth: configure url = https://hostname/path?param1=value then Connection = yourLogin and password= yourPassword
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).
5.1.1 Record selection
The exported order lines satisfy the following conditions:
§ They have not yet been sent after a previous submission of the sales file.
§ They refer to closed orders.
§ 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]
5.1.2 Product validity period
SecuTix handles 3 types of passes:
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 file structure is as defined in the following tables:
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
| ORGANIZATION.CODE AS RESP_ORGANIZ_CODE 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: CHARGES.INTERNAL_NAME_L1 AS PRODUCT_NAME | |||||||||||||
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 Operation not associated with an operation of the "commission" kind. 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
5.2 Cash flow file
5.2.1 Record selection
The payments to be taken into account must meet the following conditions:
§ They have not yet been sent after a previous submission of the cash flow file.
§ 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
§ The amount of the payments cannot be null
§ They must have the "Paid" status
5.2.2 File structure
· YYYY/MM/DD/Encaissements_YYYYMMDD_S.txt
The file structure is as defined in the following table:
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 the point of sales or the sales channel of the cash desk associated with the payment |
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, always indicated for bank debits) | 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)
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)
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
5.3 Instalments file
5.3.1 Record selection
The instalments to be taken into account must meet the following conditions:
§ They concern orders issued by the current organisation
5.3.2 File structure
· YYYY/MM/DD/Echeances_YYYYMMDD_S.txt
The file structure is as defined in the following table:
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
467006628|1|9600|USD|20141210|785913|A-A+1-000370|BankTran|Virement bancaire
467006629|2|22400|USD|20160211|785913|A-A+1-000370|BankTran|Virement bancaire
5.4 Invoices file
5.4.1 Record selection
The invoices to be taken into account must meet the following conditions:
§ They have not yet been submitted after a previous submission of the invoices file.
§ They have been issued by the current organisation.
Cancelled invoices and cancellation invoices are also submitted.
5.4.2 File structure
· YYYY/MM/DD/Factures_YYYYMMDD_S.txt
The file structure is as defined in the following table:
No. | Description | Field (DB) |
1 | Invoice number | INVOICE.INVOICE_NUMBER |
2 | Invoice creation timestamp | INVOICE.INVOICING_DATE |
3 | ISO code of the currency in which all the amounts of the current record are expressed Data Type : CHAR(3) Ex : EUR, CHF, USD | CURRENCY.ISO_NUMBER of the main currency of the organisation containing the point of sale of the invoiced order
|
4 | Total amount of the invoice. Invoice amount (negative in case of credit note), expressed in tenths of cents of the main currency of the organisation.Therefore, 600 € is provided as 600000. Ex.: 600'000 = 60'000 cents = 600,00 € | INVOICEABLE_OBJECT.AMOUNT |
5 | Invoice remark | INVOICE.REMARK |
6 | Invoice number cancelled by the current invoice | INVOICE. FK_INVOICE_CANCELLEDINVOICE |
7 | Producer name (if available), i.e. official name of the producer of the show associated with the invoice, for example | STRUCTURE.OFFICIAL_NAME as PRODUCER Note: link per INVOICE → INVOICEABLE_OBJECT → CONTACT |
8 | Producer accounting code (if available) | INTERFACE_MAPPING.value[ |
9 | Generation date | TRUNC(DOCUMENT.GENERATION_DATE) AS PRINT_DATE |
10 | Number of the point of sales generating the invoice
| POINT_OF_SALES.POS _NUM Note: link per DOCUMENT.FK_DOC_PRINTINGPOS |
11 | Cash desk number. This field is only filled in if the invoice corresponds to a single order. In this case, it contains the identifier of the cash desk associated to the payments of the order or, if the order has no payment (because its amount is null), the cash desk identifier of the order. | CASH_DESK.CASHDESK_ID |
12 | Last name of the operator who created the invoice document (the oldest if there are several of them) Note: link through DOCUMENT.FK_DOCUMENT_CREATIONUSER | USER_TABLE.LASTNAME AS OPERATOR_LASTNAME |
13 | First name of the operator who created the invoice document (the oldest if there are several of them) | USER_TABLE.FIRSTNAME AS OPERATOR_FIRSTNAME |
14 | Login name of the operator who created the invoice document (the oldest if there are several of them) | USER_TABLE.LOGIN AS OPERATOR_LOGIN |
15 | Invoiced contact number Note: link per INVOICE → CONTACT | CONTACT.CONTACT_NUMBER |
16 | Reserved for the accounting code of the invoiced contact (if available). Contains currently the role of the contact. Possible values are: RELAY, PUBLIC Invoiced contact accounting code (if available) | Foreseen: Currently: |
17 | Contact's last name (in case it is an individual) | INDIVIDUAL.LASTNAME AS IND_LASTNAME |
18 | Contact's first name (in case it is an individual) | INDIVIDUAL.FIRSTNAME AS IND_FIRSTNAME |
19 | Official name of the contact (in case it is a structure) | STRUCTURE.OFFICIAL_NAME AS STRUCT_NAME |
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
000004 | 201204021825 | 30000 | | | | | 27 | 228895598 | | | | 26560 | RENAUD, Maxime |
5.5 Structures file
5.5.1 Record selection
The structures to be taken into account must meet the following conditions:
§ They have been modified after the last submission of the file
§ They are visible from the current organisation[7]
§ Each of them is associated with a public role contact
5.5.2 File structure
· YYYY/MM/DD/Structures_YYYYMMDD_S.txt
The file structure is as defined in the following tables:
· 1 line per structure contact
No. | Description | Field (DB) |
1 | Record type, a flag indicating if they are: | Operations: |
2 | Official name
| STRUCTURE.OFFICIAL_NAME AS STRUCT_NAME |
3 | Structure type code | STRUCTURE_TYPE.CODE AS STRUCT_TYPE_CODE |
4 | Structure type internal name (Path) | STRUCTURE_TYPE.INTERNAL_NAME_L1 AS STRUCT_TYPE_NAME |
5 | Structure staff | STRUCTURE.NUMBER_OF_EMPLOYEES AS STAFF |
6 | Number of contact of structure type (contact with a public role). If there are several of them, choose a valid contact associated with an address. If there are none, choose a valid contact. Otherwise, choose any contact that is associated with the structure | CONTACT.CONTACT_NUMBER |
7 | Reserved for structure accounting code (if available). This field is currently set to NULL | INTERFACE_MAPPING.value[ |
8 | Way number of the contact main address | CONTACT_ADDRESS.WAY_NUMBER |
9 | Way type of the contact main address | (CONTACT_ADDRESS.WAY_TYPE_IC) |
10 | Way name of the contact main address | CONTACT_ADDRESS.WAY |
11 | Way complement of the contact main address | CONTACT_ADDRESS.WAY_COMPLEMENT |
12 | Zip code of the contact main address | CONTACT_ADDRESS.ZIPCODE |
13 | Town of the contact main address | CONTACT_ADDRESS.TOWN |
14 | Country of the contact main address | CONTACT_ADDRESS.COUNTRY_CODE |
15 | Contact validity end date (may be null) | CONTACT.END_VALIDITY_DATE AS END_VALIDITY_DATE |
16 | Indication whether it is a community | STRUCTURE.COMMUNITY AS COMMUNITY |
17 | Additional information (e.g. floor, apartment number) of the contact main address | CONTACT_ADDRESS.APARTMENT |
· 1 line per administrative number valid on the file extraction date
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
NAD|467095818|APE|2720204|147258369
NAD|467095818|SIRET|2720205|863524
NAD|467095818|TVAEU|2720206|518462
5.6 Individuals file
5.6.1 Record selection
The individuals to be taken into account must meet the following conditions:
§ They have been modified after the last submission of the file
§ 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
· YYYY/MM/DD/Individuels_YYYYMMDD_S.txt
The file structure is as defined in the following table:
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 |
Contact criteria ("CRI" record type):
No. | Description | Field (DB) |
1 | CRI: Contact criterion | Record type |
2 | Contact criterion code | CONTACT_CRITERION.ID_CODE AS CRITERION_CODE |
3 | Contact criterion internal name
| CONTACT_CRITERION.INTERNAL_NAME_L1 AS CRITERION_NAME |
4 | Contact criterion value The BLOB is a string of characters. The accounting interface doesn’t define a maximum string length. | CONTACT_CRITERION_VALUE.VALUE AS CRITERION_VALUE |
Contact authorisations ("AUT" record type):
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
IND|111504|Mademoiselle|Joset|Céline|3738322|CT456321|26|Avenue|Champs-Elysées|Bureaux de la colline| 75000 | PARIS | FR | 0123456789 | 0123456788 | celine.joset@wanadoo.fr | 2013-02-28 | 2341745
Contact criteria:
CRI|NewsLett|Newsletter|true
CRI|CRITERION_CODE| CRITERION_NAME| CRITERION_VALUE
CRI|CT_INTER|Centre d’intérêt|Sport mécanique
Authorisation contact:
AUT|PARTNER|AUTHOR_INFO/PARTNER|true
AUT|PHONE|AUTHOR_INFO/PHONE|true
AUT|CNIL_O|AUTHOR_INFO/INSTITUTION|true
AUT|SMS_MMS|AUTHOR_INFO/SMS_MMS|true
AUT|CNIL_T|AUTHOR_INFO/THIRDPARTY|true
AUT|LETTER|AUTHOR_INFO/LETTER|true
AUT|EMAIL|AUTHOR_INFO/EMAIL|true
- No labels