Catalogs

Catalogs are lists of grouped items in iplicit. Every item in a catalog has an id, a code and a description. Most API endpoints require catalog codes to be supplied when creating and amending records.

Name	Type	Path
GetAllCatalogs	GET	`/api/Catalog`
		Get a list of all catalogs
GetCatalog	GET	`/api/Catalog/{catalogName}`
		Get all items in a catalog
ReplaceCatalogItems	POST	`/api/Catalog/{catalogName}`
		Replace all items in a catalog
AddCatalogItem	PUT	`/api/Catalog/{catalogName}`
		Add an item to a catalog
UpdateCatalogItem	PATCH	`/api/Catalog/{catalogName}/{idOrCode}`
		Update an item in a catalog
DeleteCatalogItem	DELETE	`/api/Catalog/{catalogName}/{idOrCode}`
		Delete an item in a catalog
LockCatalogItem	POST	`/api/Catalog/{catalogName}/{idOrCode}/lock`
		Lock a catalog item
UnlockCatalogItem	POST	`/api/Catalog/{catalogName}/{idOrCode}/unlock`
		Unlock a catalog item

Common catalogs

Catalog
`AbsenceGroup`
`Account`
`BankAccount`
`Currency`
`ContactAccount`
`ContactAddress`
`ContactClassification`
`ContactGroupCustomer`
`ContactGroupSupplier`
`ContactPayRecipient`
`CostCentre`
`Department`
`DocType`
`EmploymentType`
`LegalEntity`
`Location`
`PaymentMethod`
`PayTerm`
`Product`
`ProductPriceBand`
`ProductPurchase`
`ProductPurchasePrice`
`ProductSale`
`ProductSalePrice`
`Project`
`ReminderGroup`
`Resource`
`StockLocation`
`TaxAuthority`
`TaxBand`
`TaxCode`

All available catalogs are available using GET /api/catalog.

Example

GET /api/catalog/Country

[
  {
    "id": "6871f805-cc5b-4008-9076-6a8bb919bc94",
    "description": "Andorra",
    "code": "AD",
    "isActive": true
  },
  {
    "id": "1967471f-fa30-4dd3-bf0a-8e9a70d43c1c",
    "description": "United Arab Emirates",
    "code": "AE",
    "isActive": true
  },
  {
    "id": "c455ef6a-45b8-4748-8dd0-8549abf14a41",
    "description": "Afghanistan",
    "code": "AF",
    "isActive": true
  }
  /*...*/

Note: IsActive is not supported by all catalogs and may be omitted.

Updated September 2025