Skip to content

File format

Describes the file format for orders to be imported into Payway.

General requirements

  • Data should be UTF-8 encoded
  • Data should be provided as CSV data separated with semicolon ";".
  • Filename suffix should be .csv
  • First row are column-headers
  • One row equals one new order
  • Customers are matched/identified first on Email, then by CustomerNumber. If no account is found, a new account is created and the new CustomerNumber is available in the result files.
  • Default invoicing method is email invoice, unless PreferredInvoiceMethod indicates paper invoice.

E-invoice

E-invoice can be used when invoicing the actual telemarketing company and not individuals.

If e-invoice is desired for a telemarketing company, please provide necessary e-invoice details in a support request to Tulo - Support:

  • Organisation number
  • Global location number (Gln)
  • Intermediator of invoices (ex. Peppol)

Addresses

  • Delivery-address is only required for orders containing a paper-product that should be delivered to customer.
  • If order is prepaid, only invoice address is needed unless paper-product needs to be delivered.
  • If order is NOT prepaid, a full invoice address is always required.

Order file format

FieldName IsMandatory Type Description
CustomerNumber - Number The customers Tulo customer number in Tulo Payway, if known. Also secondary customer lookup field.
CustomerExternalId X string Your own reference ID for this customer in your system if any.
SubscriptionExternalId X string Your own reference ID for this subscription in your system if any.
PackageCode X string Package code identifying the purchased package in Tulo Payway, package codes will be provided to you for use.
PeriodType X string A period identifier, accepted values: "month", "year"
PeriodLength X number Length of period purchased
SubscriptionType X string Recurring or time-limited subscription? Accepted values: "recurring", "limited"
StartDate X date Date for start of subscription (YYYY-MM-DD)
Email X email-address Customer's validated email address, used for the account created. Also primary customer lookup field.
FirstName X string
LastName X string
CompanyName - string
CompanyReference - string
CompanyDepartment - string
DeliveryAddress - string Streetname including number/building, floor and apartment if any. "Streetname 23 2 tr lgh 1234"
DeliveryZip - string
DeliveryCity - string
DeliveryCountry - string
DeliveryCOAddress - string
InvoiceFirstName X string
InvoiceLastName X string
InvoiceCompanyName - string
InvoiceCompanyReference - string If a reference is needed on the invoice
InvoiceCompanyDepartment - string If department is needed on the invoice
InvoiceAddress X string Streetname including number/building, floor and apartment if any. "Streetname 23 2 tr lgh 1234"
InvoiceZip X string
InvoiceCity X string
InvoiceCountry X string
InvoiceCOAddress - string
InvoiceEmail X string Validated email for invoice. Should always be specified unless PreferredInvoiceMethod equals paper. If left blank will use the "Email" field above.
InvoiceVatNo - string Vat number if customer is company within EU
PreferredInvoiceMethod - string Preferred invoice method. Accepted values "email", "paper". If no invoicing email-address can be collected, select "paper" to send invoice by normal mail instead. Defaults to "email".

Result files format

Uploaded files are processed automatically and the result of the import is uploaded to the "outbox" folder as file "$reseller_YYYYMMDD.csv.result", format of resultfile is described below.

FieldName Type Description
Processed timestamp Date/time of processing for this order
CustomerNumber number The customer number for the customer in Tulo Payway
OrderID string OrderID for this order in Tulo Payway
CustomerExternalID string Your own reference ID for this customer in your system
SubscriptionExternalID string Your own reference ID for this subscription in your system
Email email-address Customer email address
StartDate date StartDate of subscription
NewCustomer boolean Indicates if a new customer has been created for this order, meaning that customer will need to set a password to login
Status string OK if imported successfully
Error string Error information in case import was not successful