Class CrmApi

Generate a list summary query

Example

const currencyPayload: ListSummaryPayload = {
  fields: ["crcyName", "crcyCode", "crcySymbol", "crcyCode", "crcyKey"],
  tableName: "Currency",
  query: [["crcyIsDisabled = 0"]]
};
const result = await crm.listSummary<Crcy>(currencyPayload);
const euro = result?.list.find(item => item.crcyCode === "EUR")

const companyPayload: ListSummaryPayload = {
  fields: ["compKey", "compName"],
  tableName: "Company",
  query: [["compArchived = 1", "compName like 'Efficy%'"]]
};
Copy

Some operations cannot create their own session (e.g. systemClearCaches), hence this explicit logon

Global elastic search in Efficy, with various filtering options

Example

const payload: GetSearchResultPayload = {
  identifier: "",
  search: {
    entities: ["cont"],
    value: searchedContact.toLocaleLowerCase(),
    offset: 0,
    quantity: 5,
    refinedOptions: {
      onlyItemsLinkedToMe: false
    }
  }
}
const searchResult: EntitySearch[] = await crm.searchGlobal(payload);
Copy

Refresh the Crm server cache. Useful after modifying security or reference values. Requires an active session.

Example

const crmApi = new CrmApi(crmEnv);
await crmApi.logon(); // Makes sure there is an active session
const result = await crmApi.clearServerCaches();
Copy

Get an optionally refresh the Crm reference cache. Requires an active session.

Example

const crmApi = new CrmApi(crmEnv);
await crmApi.logon(); // Makes sure there is an active session
const references = await crmApi.systemReference(false);
Copy