Outbound - Data Collect¶

Data Collect is the default export feed of all POS transactions. This feed is version dependent and documentation is automatically generated. Documentation will be provided with software release.

Three different file options are available: Text, Json or Xml.

Text Format¶

Example:

H|2049|3481|8523|85232||348112|20100522140344217|20100522140518560|1|0|0|91858
S|2050|2049|4|0|0|0||06013|5413149029866|0913301|||1|1000|4.89|3.66|0.5844
X|2051|2050||19.00
L|2052|2050|2|0|False|99||-1.23
X|2053|2052|||||1.23|17|SWIFFER DUSTER 2e HALVE PRIJS
S|2054|2049|4|0|0|0||06012|5413149238213|0913400|||1|1000|12.99|7.99|1.2757
X|2055|2054||19.00
S|2056|2049|4|0|0|0||06013|5413149829008|0913262|||1|1000|4.89|3.67|0.5860
X|2057|2056||19.00
L|2058|2056|2|0|False|99||-1.22
X|2059|2058|||||1.22|17|SWIFFER DUSTER 2e HALVE PRIJS
F|2060|2049|7|999|0|1||0|0|0.02|0.02
F|2061|2049|1|999|0|1||1|0|-4.70|-4.70
F|2062|2049|1|999|0|1||1|0|20.00|20.00
Q|2063|2049

Json Format¶

Example document:

{
    "Header": {
        "ShopId": "0701",
        "PosId": "01",
        "DrawerNr": "",
        "ShopManagerId": null,
        "EmployeeId": "",
        "StartDateTime": "2024-09-17T14:25:13.727",
        "EndDateTime": "2024-09-17T14:25:13.99",
        "Type": "ApplicationStartUpShutDown",
        "SubType": "ApplicationStartup",
        "TransactionStatus": "Normal",
        "ReceiptNr": 6600,
        "SalesInvoiceNumber": "",
        "SnippetValues": {
            "Header": {
                "ChainId": "my-chain-id",
                "ExtShopId": "my-external-shop-id",
                "HomeCurrencyCode": "EUR",
                "AuthorizeByAuthenticationMethod": "Unspecified"
            }
        },
        "Details": [
            {
                "Type": "ApplicationStart",
                "SubType": "NormalStartup",
                "Status": "Normal",
                "Count": 0,
                "Amount": 0.0,
                "VatAmount": 0.0,
                "Code": "",
                "CreatedAt": "2024-09-17T14:25:13.727",
                "MutatedAt": "2024-09-17T14:25:13.727",
                "SnippetValues": {
                    "ApplicationStart": {
                        "ClientVersionNumber": "1.999.100.152",
                        "ClientVersionDate": "2024-09-17T14:19:27.577",
                        "Order": "1"
                    }
                },
                "LinkedDetails": []
            }
        ],
        "Sales": [],
        "Financials": []
    }
}

Xml Format¶

Example Xml document:

<Headers>
    <Header>
        <ShopId>0701</ShopId>
        <PosId>01</PosId>
        <DrawerNr/>
        <ShopManagerId/>
        <EmployeeId/>
        <StartDateTime>2024-09-17T14:25:13.727</StartDateTime>
        <EndDateTime>2024-09-17T14:25:13.99</EndDateTime>
        <Type>10</Type>
        <SubType>10001</SubType>
        <TransactionStatus>0</TransactionStatus>
        <ReceiptNr>6600</ReceiptNr>
        <SalesInvoiceNumber/>
        <SnippetValues>
            <Header>
                <ChainId>my-chain-id</ChainId>
                <ExtShopId>my-external-shop-id</ExtShopId>
                <HomeCurrencyCode>EUR</HomeCurrencyCode>
                <AuthorizeByAuthenticationMethod>0</AuthorizeByAuthenticationMethod>
            </Header>
        </SnippetValues>
        <Details>
            <Type>97</Type>
            <SubType>97001</SubType>
            <Status>0</Status>
            <Count>0</Count>
            <Amount>0</Amount>
            <VatAmount>0</VatAmount>
            <Code/>
            <CreatedAt>2024-09-17T14:25:13.727</CreatedAt>
            <MutatedAt>2024-09-17T14:25:13.727</MutatedAt>
            <SnippetValues>
                <ApplicationStart>
                    <ClientVersionNumber>1.222.100.152</ClientVersionNumber>
                    <ClientVersionDate>2024-09-17T14:19:27.577</ClientVersionDate>
                    <Order>1</Order>
                </ApplicationStart>
            </SnippetValues>
        </Details>
    </Header>
</Headers>

File name convention¶

Per transaction (Text) {shopid}-{posid}-{receiptnr:0000000}-{datetime:yyyyMMddHHmmss}.dcr
Per transaction (Json) {shopid}-{posid}-{receiptnr:0000000}-{datetime:yyyyMMddHHmmss}.dcr.json
Per transaction (Xml) {shopid}-{posid}-{receiptnr:0000000}-{datetime:yyyyMMddHHmmss}.dcr.xml
Consolidated (End of Day) DC-{yyyyMMdd}-{shopid}{posid}-{sequenceNumber}
Consolidated (Scheduled) DC-{yyyyMMddHHmm}-{sequenceNumber}