Products

Get a product.

Returns the requested product by its id. Also accepts multiple comma-separated ids. Max 200 ids per request.

get/products/{productId}

Request

  • Base URL: https://pts-api.procountor.com/api
  • URL: https://pts-api.procountor.com/api/products/{productId}
  • Auth: HTTP bearer

Path parameters

productIdstring multi required

Id of the product

Query parameters

includeLocalizationsboolean

Include localized product names.

Response

The product was successfully returned.

idinteger

Unique identifier of the product. Generated by Procountor.

type'PURCHASE' | 'SALES' | 'TRAVEL' required

Product type: to which kind of invoices the product can be assigned.

namestring required

Product name.

codestring

Custom code assigned by the owner of the 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'

Product unit.

discountnumber required

Product discount percentage.

pricenumber required

Product price.

vatnumber

Product VAT percentage.

activeboolean required

Product status.

defaultAccountstring

Default ledger account for the product.

vatStatusinteger

Product VAT status. Allowed VAT statuses are available under GET /vats/default

currency'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.

productGroupIdinteger

Product group ID.

startDatestring date

Get start date for the product. Used by TRAVEL type only.

endDatestring date

Get end date for the product. Used by TRAVEL type only.

bookkeepingAccountstring

Get bookkeeping account code for the product. Used by TRAVEL type only.

versionstring date-time

Product version timestamp. Automatically generated by Procountor and updated every time the product is updated.

Example response

{
  "type": "TRAVEL",
  "currency": "EUR",
  "version": "2019-09-25T13:15:58"
}

Changes

No recorded changes to this operation across all 1 revision of this API.