List, search, and retrieve products in full or summary form.
List Products
Returns products for the specified tenant.
Use availableDownpayment to return products available for down payment.
Use forProductType to return products for a specific ERP mapping type.
If ERP is configured as the product master, products are retrieved from ERP. Otherwise, products are retrieved from UtilityCloud.
Products are sorted by sort order and name.
query Parameters
availableDownpaymentOptional filter for returning products available for down payment.
forProductTypeOptional filter for returning products for a specific ERP mapping type.
0 (Unknown), 1 (DefaultAccount), 2 (DefaultBankAccount), 30 (PtiProduct), 31 (PrintfeeProduct), 32 (CreditProduct), 33 (FeeProduct), 34 (DownpaymentsProduct), 35 (ReminderFeeProduct), 36 (PowerProduct), 37 (OpenPostProduct), 38 (AdministrationfeeProduct), 39 (AllProductFilter), 40 (RoundingProduct), 41 (FixedDueDateProduct), 42 (PrintfeePrivateProduct), 43 (ServiceProduct), 44 (InterestProduct), 45 (PurchaseProduct), 46 (LossProduct), 63 (DownpaymentsVatCode), 70 (CostPrintFee), 80 (CustomerNumberSerieId), 81 (CustomerTemplate), 83 (PrivateCustomerDimensionId), 84 (CorporateCustomerDimensionId), 90 (DimensionForCustomer), 91 (AccountDownpayment).
List Products › Responses
Success
productIdproductElementIdproductNamenameproductMappingIdproductElementNamedescriptionaccountavailableFrontisProductionlineTypevatCodeIdvatCodeOverridemainSortOrdersortOrderquantityUnitamountUnitaccountNumberVatExcemptpricenumbermappingType0 (Unknown), 1 (DefaultAccount), 2 (DefaultBankAccount), 30 (PtiProduct), 31 (PrintfeeProduct), 32 (CreditProduct), 33 (FeeProduct), 34 (DownpaymentsProduct), 35 (ReminderFeeProduct), 36 (PowerProduct), 37 (OpenPostProduct), 38 (AdministrationfeeProduct), 39 (AllProductFilter), 40 (RoundingProduct), 41 (FixedDueDateProduct), 42 (PrintfeePrivateProduct), 43 (ServiceProduct), 44 (InterestProduct), 45 (PurchaseProduct), 46 (LossProduct), 63 (DownpaymentsVatCode), 70 (CostPrintFee), 80 (CustomerNumberSerieId), 81 (CustomerTemplate), 83 (PrivateCustomerDimensionId), 84 (CorporateCustomerDimensionId), 90 (DimensionForCustomer), 91 (AccountDownpayment).
isPreliminaryproductNameEdit