Catalogs

The catalog API is used to retrieve codes and ids for static data.

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.