### GET /products Source: https://pts-api.procountor.com/api/openapi.json Returns a paginated list of products in the current environment, starting from "previousId" limited by "size". with a metadata about the pagination. ```markdown ### Parameters - **name** (string, query, optional): Name of product matched by substring. - **previousId** (integer (int32), query, optional): Previous Id for pagination - **size** (integer (int32), query, optional): Page size for the results. Maximum value: 200. - **orderById** (string (ASC|DESC), query, optional): Order the results by product ID - **orderByVersion** (string (ASC|DESC), query, optional): Order the results by product version - **group** (array (integer), query, optional): Id of product group. - **type** (string (SALES|PURCHASE|TRAVEL), query, optional): Register type of product. If not given, then SALES and PURCHASE returned as default - **code** (string, query, optional): Custom code assigned by the owner of the product. Matched by substring. - **startDate** (string (date), query, optional): Start date of activity period. Used by TRAVEL type only. Used to search all travel product which are in active state after that date (expiration date is after that date). - **endDate** (string (date), query, optional): End date of activity period. Used by TRAVEL type only. Used to search all travel product which were activated before that date (start date is before that date). - **includeLocalizations** (boolean, query, optional): Include localized product names - **active** (boolean, query, optional): Status of product - **versionStartDate** (string (date-time), query, optional): Start date of the search (product updated date) - **versionEndDate** (string (date-time), query, optional): End date of the search (product updated date) ### Responses #### 200 - The products were successfully returned **ProductSearchResult** - **results** (array (Product)): Search results. Array items: - **id** (integer (int64)): Unique identifier of the product. Generated by Procountor. - **type** (string (PURCHASE|SALES|TRAVEL)) (required): Product type: to which kind of invoices the product can be assigned. (example: "TRAVEL") ("PURCHASE"|"SALES"|"TRAVEL") - **name** (string) (required): Product name. - **code** (string): Custom code assigned by the owner of the product. - **unit** (string (AMPERE|AMPERE_HOUR|AMPERE_MINUTE|BAG|BAR|BOTTLE|BOX|CAN|CENTILITRE|CM|CUBIC_METER|CUP|DAY|DECILITRE|DOZEN|DOZEN_PACK|EIGHT_PACK|EXAJOULE|FIVE_PACK|FOOT|FOUR_PACK|FULL_DAY|GALLON_UK|GALLON_US|GIGABIT|GIGABYTE|GIGAJOULE|GIGAWATT|GIGAWATT_HOUR|GRAM|GRAM_PER_CUBIC_METRE|GRAM_PER_SQUARE_METRE|HECTARE|HOUR|HUNDRED|INCH|JAR|JOULE|JOULE_PER_SECOND|KILOAMPERE_HOUR|KILOBIT|KILOBYTE|KILOGRAM|KILOGRAM_PER_CUBIC_METRE|KILOGRAM_PER_SQUARE_METRE|KILOJOULE|KILOMETER|KILOPASCAL|KILOVOLT|KILOWATT|KILOWATT_HOUR|LINEAR_METER|LITER|LOT|MEGABIT|MEGABYTE|MEGAWATT_HOUR|METER|MILE|MILLIAMPERE_HOUR|MILLIGRAM|MILLIGRAM_PER_CUBIC_METRE|MILLIJOULE|MILLILITRE|MILLIMETER|MILLIVOLT|MILLIWATT|MINUTE|MONTH|NINE_PACK|NO_UNIT|NUMBER_OF_WORDS|OUNCE|PAGE|PAIR|PALLET|PARCEL|PASCAL|PERSON|PETAJOULE|PIECE|PINT_UK|PINT_US|PLATE|POUND|ROLL|SACK|SALE_UNIT|SECOND|SERIES|SET|SEVEN_PACK|SIX_PACK|SQUARE_CENTIMETRE|SQUARE_METER|STONE_UK|TEN_PACK|TERABIT|TERAJOULE|TERAWATT|TERAWATT_HOUR|THREE_PACK|TON|TUBE|TWO_PACK|WATT|WATT_HOUR|WEEK|WRAP|YARD|YEAR)): Product unit. ("AMPERE"|"AMPERE_HOUR"|"AMPERE_MINUTE"|"BAG"|"BAR"|"BOTTLE"|"BOX"|"CAN"|"CENTILITRE"|"CM"|"CUBIC_METER"|"CUP"|"DAY"|"DECILITRE"|"DOZEN"|"DOZEN_PACK"|"EIGHT_PACK"|"EXAJOULE"|"FIVE_PACK"|"FOOT"|"FOUR_PACK"|"FULL_DAY"|"GALLON_UK"|"GALLON_US"|"GIGABIT"|"GIGABYTE"|"GIGAJOULE"|"GIGAWATT"|"GIGAWATT_HOUR"|"GRAM"|"GRAM_PER_CUBIC_METRE"|"GRAM_PER_SQUARE_METRE"|"HECTARE"|"HOUR"|"HUNDRED"|"INCH"|"JAR"|"JOULE"|"JOULE_PER_SECOND"|"KILOAMPERE_HOUR"|"KILOBIT"|"KILOBYTE"|"KILOGRAM"|"KILOGRAM_PER_CUBIC_METRE"|"KILOGRAM_PER_SQUARE_METRE"|"KILOJOULE"|"KILOMETER"|"KILOPASCAL"|"KILOVOLT"|"KILOWATT"|"KILOWATT_HOUR"|"LINEAR_METER"|"LITER"|"LOT"|"MEGABIT"|"MEGABYTE"|"MEGAWATT_HOUR"|"METER"|"MILE"|"MILLIAMPERE_HOUR"|"MILLIGRAM"|"MILLIGRAM_PER_CUBIC_METRE"|"MILLIJOULE"|"MILLILITRE"|"MILLIMETER"|"MILLIVOLT"|"MILLIWATT"|"MINUTE"|"MONTH"|"NINE_PACK"|"NO_UNIT"|"NUMBER_OF_WORDS"|"OUNCE"|"PAGE"|"PAIR"|"PALLET"|"PARCEL"|"PASCAL"|"PERSON"|"PETAJOULE"|"PIECE"|"PINT_UK"|"PINT_US"|"PLATE"|"POUND"|"ROLL"|"SACK"|"SALE_UNIT"|"SECOND"|"SERIES"|"SET"|"SEVEN_PACK"|"SIX_PACK"|"SQUARE_CENTIMETRE"|"SQUARE_METER"|"STONE_UK"|"TEN_PACK"|"TERABIT"|"TERAJOULE"|"TERAWATT"|"TERAWATT_HOUR"|"THREE_PACK"|"TON"|"TUBE"|"TWO_PACK"|"WATT"|"WATT_HOUR"|"WEEK"|"WRAP"|"YARD"|"YEAR") - **discount** (number) (required): Product discount percentage. - **price** (number) (required): Product price. - **vat** (number): Product VAT percentage. - **active** (boolean) (required): Product status. - **defaultAccount** (string): Default ledger account for the product. - **vatStatus** (integer (int32)): Product VAT status. Allowed VAT statuses are available under GET /vats/default - **currency** (string (AED|AFN|ALL|AMD|ANG|AOA|ARS|ATS|AUD|AWG|AZN|BAM|BBD|BDT|BEF|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYN|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNH|CNT|CNY|COP|COU|CRC|CUC|CUP|CVE|CYP|CZK|DEM|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ESP|ETB|EUR|FIM|FJD|FKP|FRF|GBP|GEL|GGP|GHS|GIP|GMD|GNF|GRD|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|IEP|ILS|IMP|INR|IQD|IRR|ISK|ITL|JEP|JMD|JOD|JPY|KES|KGS|KHR|KID|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LUF|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NIS|NLG|NOK|NPR|NTD|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PRB|PTE|PYG|QAR|RMB|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SIT|SKK|SLL|SLS|SOS|SRD|SSP|STN|SVC|SYP|SZL|THB|TJS|TMT|TND|TOP|TRY|TTD|TVD|TWD|TZS|UAH|UGX|USD|USN|UYI|UYU|UYW|UZS|VES|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XOF|XPD|XPF|XPT|XSU|XTS|XUA|XXX|YER|ZAR|ZMW|ZWB|ZWL)) (required): Currency for the product in ISO 4217 format. (example: "EUR") ("AED"|"AFN"|"ALL"|"AMD"|"ANG"|"AOA"|"ARS"|"ATS"|"AUD"|"AWG"|"AZN"|"BAM"|"BBD"|"BDT"|"BEF"|"BGN"|"BHD"|"BIF"|"BMD"|"BND"|"BOB"|"BOV"|"BRL"|"BSD"|"BTN"|"BWP"|"BYN"|"BZD"|"CAD"|"CDF"|"CHE"|"CHF"|"CHW"|"CLF"|"CLP"|"CNH"|"CNT"|"CNY"|"COP"|"COU"|"CRC"|"CUC"|"CUP"|"CVE"|"CYP"|"CZK"|"DEM"|"DJF"|"DKK"|"DOP"|"DZD"|"EEK"|"EGP"|"ERN"|"ESP"|"ETB"|"EUR"|"FIM"|"FJD"|"FKP"|"FRF"|"GBP"|"GEL"|"GGP"|"GHS"|"GIP"|"GMD"|"GNF"|"GRD"|"GTQ"|"GYD"|"HKD"|"HNL"|"HRK"|"HTG"|"HUF"|"IDR"|"IEP"|"ILS"|"IMP"|"INR"|"IQD"|"IRR"|"ISK"|"ITL"|"JEP"|"JMD"|"JOD"|"JPY"|"KES"|"KGS"|"KHR"|"KID"|"KMF"|"KPW"|"KRW"|"KWD"|"KYD"|"KZT"|"LAK"|"LBP"|"LKR"|"LRD"|"LSL"|"LTL"|"LUF"|"LVL"|"LYD"|"MAD"|"MDL"|"MGA"|"MKD"|"MMK"|"MNT"|"MOP"|"MRO"|"MTL"|"MUR"|"MVR"|"MWK"|"MXN"|"MXV"|"MYR"|"MZN"|"NAD"|"NGN"|"NIO"|"NIS"|"NLG"|"NOK"|"NPR"|"NTD"|"NZD"|"OMR"|"PAB"|"PEN"|"PGK"|"PHP"|"PKR"|"PLN"|"PRB"|"PTE"|"PYG"|"QAR"|"RMB"|"RON"|"RSD"|"RUB"|"RWF"|"SAR"|"SBD"|"SCR"|"SDG"|"SEK"|"SGD"|"SHP"|"SIT"|"SKK"|"SLL"|"SLS"|"SOS"|"SRD"|"SSP"|"STN"|"SVC"|"SYP"|"SZL"|"THB"|"TJS"|"TMT"|"TND"|"TOP"|"TRY"|"TTD"|"TVD"|"TWD"|"TZS"|"UAH"|"UGX"|"USD"|"USN"|"UYI"|"UYU"|"UYW"|"UZS"|"VES"|"VND"|"VUV"|"WST"|"XAF"|"XAG"|"XAU"|"XBA"|"XBB"|"XBC"|"XBD"|"XCD"|"XDR"|"XOF"|"XPD"|"XPF"|"XPT"|"XSU"|"XTS"|"XUA"|"XXX"|"YER"|"ZAR"|"ZMW"|"ZWB"|"ZWL") - **productLocalizations** (array (ProductLocalization)): Product name localizations. Array items: - **language** (string (DANISH|ENGLISH|ESTONIAN|FINNISH|NORWEGIAN|SWEDISH)): Product language ("DANISH"|"ENGLISH"|"ESTONIAN"|"FINNISH"|"NORWEGIAN"|"SWEDISH") - **productName** (string): Product name - **productGroupId** (integer (int32)): Product group ID. - **startDate** (string (date)): Get start date for the product. Used by TRAVEL type only. - **endDate** (string (date)): Get end date for the product. Used by TRAVEL type only. - **bookkeepingAccount** (string): Get bookkeeping account code for the product. Used by TRAVEL type only. - **version** (string (date-time)): Product version timestamp. Automatically generated by Procountor and updated every time the product is updated. - **meta** (object): Search result metadata. - **pageNumber** (integer (int32)): Number of the page. - **pageSize** (integer (int32)): Size of the page. - **resultCount** (integer (int32)): The number of results per page. - **totalCount** (integer (int64)): Total number of rows. #### 400 - Request contains invalid data **ErrorMessages** - **errors** (array (ErrorMessage)): List of error messages. Array items: - **status** (integer (int32)): HTTP response status. - **field** (string): Field path of violation. - **message** (string): Validation error code or description. - **model** (object): Data model for which constraint violations occurred. #### 403 - Insufficient user rights. **ErrorMessages** - **errors** (array (ErrorMessage)): List of error messages. Array items: - **status** (integer (int32)): HTTP response status. - **field** (string): Field path of violation. - **message** (string): Validation error code or description. - **model** (object): Data model for which constraint violations occurred. ### Example Usage ```bash curl -X GET "https://pts-api.procountor.com/api/products?name=string&previousId=0&size=50&orderById=ASC&orderByVersion=ASC&group=item1,item2&type=SALES&code=string&startDate=2023-01-01&endDate=2023-01-01&includeLocalizations=false&active=true&versionStartDate=2023-01-01T00:00:00Z&versionEndDate=2023-01-01T00:00:00Z" ``` ``` -------------------------------- ### GET /sie/file Source: https://pts-api.procountor.com/api/openapi.json Returns a SIE file for given accounting period start date and export end date. ```markdown ### Parameters - **accountingPeriodStart** (string (date), query, required): Start date of accounting period - **exportEndDate** (string (date), query, required): End date of the export ### Responses #### 200 - SIE file successfully returned. #### 400 - Request contains invalid data. **ErrorMessages** - **errors** (array (ErrorMessage)): List of error messages. Array items: - **status** (integer (int32)): HTTP response status. - **field** (string): Field path of violation. - **message** (string): Validation error code or description. - **model** (object): Data model for which constraint violations occurred. #### 403 - Insufficient user rights. **ErrorMessages** - **errors** (array (ErrorMessage)): List of error messages. Array items: - **status** (integer (int32)): HTTP response status. - **field** (string): Field path of violation. - **message** (string): Validation error code or description. - **model** (object): Data model for which constraint violations occurred. ### Example Usage ```bash curl -X GET "https://pts-api.procountor.com/api/sie/file?accountingPeriodStart=2023-01-01&exportEndDate=2023-01-01" ``` ```