Deprecated API Items

Note

The following entities, parameters, and properties have been marked as deprecated, which means you should avoid using them. They will be removed in future releases.

Endpoints

POST /auth/identity

The endpoint Create Identity Provider is deprecated.

GET /auth/users/{locator}/accessmask

The endpoint Fetch User Masks is deprecated.

PATCH /auth/users/{locator}/accessmask

The endpoint Add Data Security Mask is deprecated.

GET /auth/users/{locator}/accessmask/{tenantLocator}

The endpoint Fetch User Masks for Tenant is deprecated.

DELETE /auth/users/{locator}/accessmask/{tenantLocator}

The endpoint Delete User Masks is deprecated.

GET /auth/users/{locator}/accessmask/{tenantLocator}/{type}

The endpoint Fetch User Mask is deprecated.

GET /billing/{tenantLocator}/delinquencies/quotes/{quoteLocator}/list

The endpoint Get Delinquencies for Quote is deprecated.

PATCH /payment-execution/{tenantLocator}/paymentProviders/{locator}/inactivate

The endpoint Inactivate Payment Provider Configuration is deprecated.

GET /policy/{tenantLocator}/policies/snapshot/list

The endpoint Fetch Multiple Snapshots is deprecated.

GET /policy/{tenantLocator}/transactions/{locator}/affectedTransactions/list

The endpoint Fetch Affected Transactions for List Endpoint is deprecated.

GET /policy/{tenantLocator}/transactions/{locator}/segments/{segmentLocator}

The endpoint Fetch Policy Segment Ex is deprecated.

GET /policy/{tenantLocator}/transactions/{locator}/segments/list

The endpoint Fetch Transaction Segments is deprecated.

Entities

Account Response

In AccountResponse:

Property state is deprecated.

Billing Plan Ref

In BillingPlanRef:

Property billingTrigger is deprecated.

Billing Preferences

The entity BillingPreferences is deprecated.

Charge Ref

In ChargeRef:

Property displayName is deprecated.

Configuration Ref

In ConfigurationRef:

Property billingPlans is deprecated.
Property defaultAnchorMode is deprecated.
Property defaultBillingLevel is deprecated.
Property defaultBillingPlan is deprecated.
Property defaultBillingTrigger is deprecated.
Property defaultDueLeadDays is deprecated.
Property defaultGenerateLeadDays is deprecated.
Property defaultLapseType is deprecated.
Property defaultRegion is deprecated.

Document Job Info

In DocumentJobInfo:

Property state is deprecated.

Document Summary

In DocumentSummary:

Property state is deprecated.

Element Ref

In ElementRef:

Property pluralType is deprecated.

Invoice Details Response

In InvoiceDetailsResponse:

Property policyInvoiceSummaries is deprecated.

Migration Billing Preferences

The entity MigrationBillingPreferences is deprecated.

Migration Preferences

The entity MigrationPreferences is deprecated.

Params Change Instruction Create Request

In ParamsChangeInstructionCreateRequest:

Property billingModeChange is deprecated.
Property inheritSettings is deprecated.

Params Change Instruction Response

In ParamsChangeInstructionResponse:

Property billingModeChange is deprecated.
Property inheritSettings is deprecated.

Policy Response

In PolicyResponse:

Property billingTrigger is deprecated.

Policy Transaction Response

In PolicyTransactionResponse:

Property billingTrigger is deprecated.

Product Ref

In ProductRef:

Property defaultBillingPlan is deprecated.
Property pluralType is deprecated.

Quick Quote Price Response

In QuickQuotePriceResponse:

Property state is deprecated.

Quick Quote Quote Details

In QuickQuoteQuoteDetails:

Property billingTrigger is deprecated.

Quote Response

In QuoteResponse:

Property billingTrigger is deprecated.