Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

File format for memberships

The generic file format is described in Generic file format (Extended). This documents describes all available import fields. 

Examples

Attachments
sortByname

Fields

Field codeField typeMandatoryDescription
INSTITUTION
Text 15
CodeYesInstitution code owning the data to be imported.
ORGANIZATION
Text 15
CodeNoOrganization code owning the data to be imported.

By default, the organization code is the same as the institution code.

CONTACT_NRText 15YesThe contact number of contact that owner the membership card.MEMBER_NRNumberYesThe membership number of contact. This number allows another member to buy ticket on behalf of this member.SEASONCodeYesSeason code.MEMBERSHIPCodeYesThe product code of the MEMBERSHIP that is to be imported.TARIFCodeYes

The tariff code linked to the season that match one of these conditions :

  1. Main category = 'OCCASIONAL' and secondary category = 'INDIVIDUAL'
  2. Main category = 'INVITED'.
SALE_DATETimestampYesDate of the sale.VALIDITY_BEGINDateYesBeginning of the membership.VALIDITY_ENDDateYesEnd of the membership
If leave it empty, the institution code will be used.
ORDER_NRNumberNoIf leave it empty, order number will be set while importing by default.
One line is one ticket. So each line is a unique order number if leave it empty.
Many tickets can be in an order if leave them the same order number. This number can be started from 1 in a new data file. Then it will be given new one while importing.
This will be file number also.
ORDER_DATEDateNoBuying date.
If leave it empty, it will be imported date by default.
OPERATION_TYPEEnumYesAllowed values: SALE or RESERVATION.
CONFIRMATION_DATEDateNoExpiration date to confirm reservation.
REMARKText 2000NoInternal remark of order.
BUYING_CONTACT_NRNumberYesContact number who buys the order. Mandatory because a membership needs a contact.
SEASONCodeYesSeason code of membership.
MEMBERSHIPCodeYesProduct code of membership.
VALIDITY_BEGINTimestampYesThe date starts to validate.
VALIDITY_ENDTimestampYesThe date stops to validate.
TARIFFCodeYesTariff code.
PRICEAmountYes
The gross amount of order of the inserted membership.CHARGES
Price of ticket * 100 (so that 25$ = 2500).
CHARGEAmountNo
Not used yet
Charge of ticket * 100 (so that 1$ = 100).
VATPercentage
Yes
NoIf leave it empty, it will be 0 while importing by default.
Vat rate in percent * 100 (so that 1% = 100).
Choose the rate that active and valid following this:
Valid from date of vat rate <=
VALIDITY
ORDER_
BEGIN
DATE <= Valid to date of vat rate.
PAYMENT_DATEDateNoIf leave it empty, the operation type is SALE and the price is not 0, the order date will be used by default. Means it can be imported date if the order date is not given.
MEMBERSHIP_NRNumberNoEach membership has a unique number to know how many memberships have been published.
In importation, it helps to define ticket to check between data excel file and database system after importing.
This number can be started from 1 in a new data file. Then it will be given new one while importing.
CULTURAL_CONTACT_NRNumberNoContact number who is ticket holder.
If leave it empty and first/last name are empty, the buying contact number will be used by default.
BENEFICIARY_FIRSTNAMEText 50NoBeneficiary first name (only if cultural contact is not specified).
BENEFICIARY_LASTNAMEText 50NoBeneficiary last name (only if cultural contact is not specified).
TICKET_STATEEnumYes
The state of ticket must be in ('PRINTED', 'NOT_PRINTED')
if SALEMandatory when the operation type is SALE.
Allowed values: NOT_PRINTED, PRINTED, CONTROLLED.
GENERATION_DATE
Timestamp
Date
Yes if PRINTED
NoIf
the ticket state equal to 'PRINTED' the generation date must not null
leave it empty and the ticket has been printed or controlled, the order date will be used by default. Means it can be imported date if the order date is not given.
BARCODEText 50NoIf leave it empty and the ticket has been printed or controlled, it will be generated following import rules by default.
TAX_
NR
NUMBERText
30BARCODEText 100Yes if PRINTEDThe bar code of ticket. Ex: Input = 345678920
50
Yes if PRINTEDThe tax number of the ticket. If not inserted, the tax number will be generated with prefix equal to "IMP-".
NoIf leave it empty and the ticket has been printed or controlled, it will be generated following import rules by default.
SHIPMENT_DATEDateNoIf leave it empty, the order date will be used by default. Means it can be imported date if the order date is not given.
SHIPMENT_MODECodeNoIf leave it empty and the ticket has been printed or controlled, it will be imported following import rules by default.