Skip to main content

Voyado Engage

Receipt & Items - export fields

Below is a description of two different exports. One is the export of the receipt header and the other export contains the line-items of each receipt.

The receiptId is the main key-reference here in order to connect the two tables.

Receipt

Field

Description

Data type

Example value

receiptId

Receipt id (Generated by Voyado)

GUID

BA270CBB-EAEA-4237-AA4A-A53100909FA2

contactId

Unique contact id

GUID

5307c938-55fc-4fd8-9512-aab500977e67

storeId

Internal unique store id where purchase was made. (Generated by Voyado)

GUID

HJ270CBB-EAEA-4237-AA4A-743100909FA2

storeExternalId

The store id generated by the clients.

string

1001

receiptNumber

The invoice number

string

3247265354287

totalGrossPrice

The total purchase amount

decimal

500.00

totalQuantity

The total quantity of all items

int

4

totalReturned

The number of returned items in one receipt

int

2

totalLocalPrice

The total purchase amount in local currency

decimal

50.00

exchangeRate

The currency exchange rate

decimal

10.00

localCurrency

The currency code

string

EUR

numberOfItems

The number of items in receipt

int

4

numberOfPurchases

The number of items that are of type PURCHASE

int

2

numberOfReturns

The number of items that are of type RETURN

int

2

changeType

Not applicable

string

CREATE/UPDATE/DELETE

ReceiptItem

Field

Description

Data type

Example value

receiptItemId

Item id (Generated by Voyado)

GUID

JU270CBB-K9EA-4237-A6TA-B90300909FA2

receiptId

Receipt id (Generated by Voyado)

GUID

BA270CBB-EAEA-4237-AA4A-A53100909FA2

contactId

Unique contact id

GUID

5307c938-55fc-4fd8-9512-aab500977e67

storeId

Unique store id (Generated by Voyado)

GUID

HJ270CBB-EAEA-4237-AA4A-743100909FA2

transactionDateTime

When the purchase was made

datetime

2020-06-30T10:34:00+01:00

type

PURCHASE or RETURN

string

PURCHASE

sku

Store keeping unit

string

12314-5

articleNumber

The article number

string

12314

quantity

Quantity

int

2

grossPaidPrice

Summed price of all units

decimal

100.00

grossPaidPricePerUnit

Price per unit

decimal

50.00

localPrice

Price in local currency

decimal

10.00

localCurrency

Currency code

string

EUR

discounts

Total amount of discount on line item

decimal

10.00

discountPercent

Discount percentage

decimal

10.00

marginPercent

The margin percentage of sold item.

decimal

50.00

taxPercent

VAT percentage for item

decimal

25.00

articleName

Name of the article

string

Voyado cap

articleGroup

Highest level of categorizing

string

Hats

articleSpare1-10

Up to 10 extra fields

string

Size medium

articleDateSpare1-5

Up to 5 extra datetime fields

datetime

2020-01-02T03:04:05+01:00

awardsBonus

If item is valid for bonus

boolean

true

changeType

Not applicable

string

CREATE/UPDATE/DELETE