GET /config/{tenantLocator}/deployments/datamodel/{version}

Request

Base URL
https://docs.socotra.com
Auth
none declared
TypeScript
https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/docs/config/:tenantLocator/deployments/datamodel/:version/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

tenantLocatorstring uuid required

versionstring ulid required

Query parameters

resolveboolean

byStaticLocatorboolean

Response

defaultTimeZonestring

defaultCurrencystring

defaultTermDurationnumber

defaultInstallmentPlanstring

defaultInvoicingPlanstring

defaultPaymentNumberingPlanNamestring

defaultDisbursementNumberingPlanNamestring

defaultBillingPlanstring

defaultDurationBasis'years' | 'months' | 'weeks' | 'days' | 'hours'

defaultBillingLevel'account' | 'inherit' | 'policy'

defaultBackdatedInstallmentsBilling'immediate' | 'deferDueDate'

defaultDelinquencyPlanstring

defaultAutoRenewalPlanstring

defaultExcessCreditPlanstring

defaultRetryPlanstring

defaultLapseTypestring

defaultAnchorMode'generateDay' | 'termStartDay' | 'dueDay'

defaultGenerateLeadDaysinteger

defaultDueLeadDaysinteger

defaultAuxDataSettingsstring

defaultShortfallTolerancePlanstring

jurisdictionsobject

regionsobject

defaultRegionstring

defaultSearchableboolean

Default is true

enableSerialInvoiceNumberingboolean

enableEntityAnonymizationboolean

defaultScheduleUploadErrorsLimitinteger

dataTypesobject

accountsobject required

policyLinesobject

exposureGroupsobject

exposuresobject

coveragesobject

productsobject required

coverageTermsobject

chargesobject required

transactionTypesobject

installmentPlansobject

invoicingPlansobject

billingPlansobject

paymentsobject

disbursementsobject

tablesobject

rangeTablesobject

constraintTablesobject

secretsobject

documentsobject

consolidatedDocumentsobject

templateSnippetsobject

customFontsstring[]

auxDataSettingsobject

moratoriumsobject

customEventsobject

delinquencyPlansobject

shortfallTolerancePlansobject

autoRenewalPlansobject

excessCreditPlansobject

reversalTypesobject

numberingPlansobject

fnolobject

lossesobject

lossCategoriesstring[]

contactsobject

contactRolesstring[]

schedulesobject

defaultInvoiceDocumentstring

retryPlansobject

automationsobject

tenantCustomEventsobject

externalNumberingPlansobject

Changes

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