payments
Use the payments data format creator to export payments and save this data in the cloud. The raw data file is stored in the cloud for a maximum of 6 months. Therefore, the data must be processed before this date. The following tables contain further information about the format.
1. Technical specifications
See Table 1 for further information on the available properties and their corresponding values.
Property | Meaning | Value | Explanation |
---|---|---|---|
dataName |
Name |
payments |
Name of the creator process and prefix of the created file. |
fileFormat |
File format |
CSV, GZIP |
The data is provided as a GZIP-compressed CSV file (RFC 1952). |
limitPage |
Lines per request |
up to 8,000 |
The maximum number of data rows that is written into a single file. |
limitDay |
Lines per day |
up to 280,000 |
The maximum number of data rows that is written on one day in total. |
earliestPossibleDataDate |
Earliest point in time |
2020-01-01 |
Point in time as of which the raw data can be collected. The data is filtered by the date saved in the dataUpdatedAtColumnName column. |
filterType |
Filter type |
lastUpdate |
Data are filtered based on the last update. |
dataUpdatedAtColumnName |
Column header |
pay_imported_at |
Name of the column that contains the time stamp of the last data update. |
defaultActive |
Activated by default |
no |
The data is only exported automatically in the background after you have activated the creator in the Setup » plentyBI » Raw data menu. |
interval |
Interval |
daily |
With this setting, all data that has been changed since the last run is exported once a day, usually during the night. |
storableFromPlan |
Storage starting from tariff |
plentyBI S |
Minimum fee plan required for saving the data in cloud storage and making it available via REST. |
processableFromPlan |
Usage starting from tariff |
plentyBI L |
Minimum fee plan required for making the data available in plentyBI Data Warehouse, i.e. for using, filtering and processing key figures. |
2. Data columns
See Table 2 for further information on the payments data columns included in the CSV file during raw data export.
Column name | Data type | Full name | Explanation |
---|---|---|---|
plenty_id |
INTEGER NOT NULL |
plenty id |
ID of the plentymarkets system |
pay_id (Primary key) |
VARCHAR NOT NULL |
payment id |
ID of the payment |
pay_amount |
NUMERIC(17,4) NOT NULL |
payment amount |
Amount of the payment |
pay_exchange_ratio |
NUMERIC(12,6) NOT NULL |
payment exchange ratio |
Exchange rate of the payment |
pay_parent_id |
VARCHAR |
payment parent id |
ID of the parent payment, if available |
pay_deleted |
SMALLINT |
payment deleted |
1 = deleted |
pay_unaccountable |
SMALLINT |
payment unaccountable |
1 = accountable |
pay_currency |
VARCHAR NOT NULL |
payment currency |
Currency of the payment |
pay_is_system_currency |
SMALLINT NOT NULL |
payment is system currency |
1 = Currency is the same as system currency |
pay_type |
VARCHAR NOT NULL |
payment type |
Type of the payment |
mop_id |
INTEGER |
method of payment id |
Payment method ID |
pay_imported_at |
TIMESTAMPTZ NOT NULL |
payment imported at |
Time stamp of the last update |