InsuranceSuite Cloud API Consumer Guide
Basic REST operations
Introduction to Cloud API
List of APIs in Cloud API
Viewing API definitions
REST API fundamentals
Cloud API calls
Resources
Endpoints
Requests and responses
Testing requests and responses
GETs
Overview of GETs
Standard payload structures
Sending GETs
Payload structure for a basic response
Payload structure for a response with included resources
Query parameters
Overview of query parameters
The asOfDate query parameter
The fields query parameter
The filter query parameter
The sort query parameter
The pagination query parameters
The includeLocalizations query parameter
Query parameters for included resources
Query parameters for POSTs and PATCHes
POSTs
Overview of POSTs
Standardizing payload structures
Designing a request payload
Sending POSTs
Responses to a POST
Postman behavior with redirects
Business action POSTs
Improving POST performance
PATCHes
Overview of PATCHes
The PATCH payload structure
PATCHes and arrays
Sending PATCHes
Responses to a PATCH
PATCHes and lost updates
Postman behavior with redirects
DELETEs
Overview of DELETEs
DELETEs and lost updates
Request headers
HTTP headers
Language and locale
Preventing duplicate database transactions
Sticky sessions in clustered environments
Warming up an endpoint
Handling a call with unknown elements
Validating response payloads against additional constraints
Optimizing calls
Reducing the number of calls
Features that execute multiple requests at once
Comparing features that execute multiple requests
Determining which feature to use
Composite requests
Constructing composite requests
Composite request limitations
Administering composite requests
Complete composite request syntax
Request and response inclusion
Syntax for simple parent/child relationships
Syntax for named relationships
PATCHes in request inclusion
Additional behaviors with write inclusion
Additional behaviors with read inclusion
Batch requests
Batch request syntax
Batch request examples
Administering batch requests
Lost updates and checksums
Lost updates
Checksums
Checksums for PATCHes and business action POSTs
Checksums for DELETEs
Asynchronous calls
Overview of asynchronous calls
Sending a request asynchronously
Retrieving the response to the original request
Waiting for a response synchronously
Asynchronous request administration
BillingCenter
Plans and administrative data
Plan behavior
Plan order
Testing plans
Plans and multicurrency
Billing plans
Querying for billing plans
Creating billing plans
Modifying billing plans
Delinquency plans
Querying for delinquency plans
Creating delinquency plans
Modifying delinquency plans
Delinquency plan workflows
Payment allocation plans
Querying for payment allocation plans
Creating payment allocation plans
Modifying payment allocation plans
Payment plans
Overview of payment plans
Querying for payment plans
Creating payment plans
Modifying payment plans
Payment plan overrides
Return premium plans
Querying for return premium plans
Creating return premium plans
Modifying and deleting return premium plans
Return premium handling schemes
Commission plans
Working with commission plans
Commission subplans
Working with subplans
Subplan rates
Commission overrides for section types
Commissionable items
Charge pattern rates
Incentives
Changing subplan order
Add a subplan to a commission plan that is in use
Agency bill plans
Querying for agency bill plans
Creating agency bill plans
Modifying agency bill plans
Deleting agency bill plans
Billing entities and processes
Accounts
Querying for accounts
Creating an account
Payment instruments
Account contacts
Account-level charges
Account disbursements
Query for account disbursements
Create account disbursements
Reject and hold future disbursements
Unapplied funds
Delinquency processes
PATCHing accounts
Account general billing instructions
Search for accounts
Policies
Querying for policies and policy periods
Issuing policies
Example: Preview a policy issuance
Canceling policies
Reinstating policies
Rewriting policies
Renewing policies
Executing a policy change
Previewing policy transactions
Example: Preview a policy issuance
Changing a policy’s payment plan
Policy-level charges
Policy period contacts
Policy notes
Policy period general billing instructions
Policy audits
Search for policy periods
Policy period archive summaries
Charges and charge patterns
Overview of charge patterns
Working with charge patterns
Working with charges
Invoices
Overview of invoices
Working with invoices
Working with invoice items
Invoice item events
Working with invoice streams
Querying for an account's invoice streams
Modifying invoice streams
Direct bill
Querying for direct bill payments
Creating and distributing direct bill payments
Querying for distribution information
Payment requests
Reversing payments
Suspense payments
Querying for suspense payments
Creating suspense payments
Modifying suspense payments
Applying suspense payments
Reversing suspense payments
Suspense payment disbursements
Disbursements
Querying for disbursements
Modifying disbursements
Approving disbursements
Rejecting disbursements
Voiding disbursements
Producers
Working with producers
Producer codes
Producer contacts
Producer payment instruments
Policy commissions
Charge commissions
Item commissions
Policy commission archive summaries
Producer statements
Producer statement item events
Producer transactions
Search for producers
Create a producer, producer contact, and producer code in one call
Agency bill
Statement invoices
Agency bill cycles
Agency bill payments
Query for agency bill payments
Create and distribute agency bill payments
Modify agency bill payments and distributions
Execute saved agency bill payments
Delete agency bill payments
Agency bill promises
Query for agency bill promises
Create an agency bill promise with distribution
Agency suspense promise items
Modify agency bill promises and distributions
Execute saved agency bill promises
Delete agency bill promises
Reverse agency bill promises
Create an agency bill payment from a promise
Payment mismatch exceptions
Agency bill suspense items
Agency bill disbursements
Transactions
Policies
Querying for policies and policy periods
Issuing policies
Example: Preview a policy issuance
Canceling policies
Reinstating policies
Rewriting policies
Renewing policies
Executing a policy change
Previewing policy transactions
Example: Preview a policy issuance
Changing a policy’s payment plan
Policy-level charges
Policy period contacts
Policy notes
Policy period general billing instructions
Policy audits
Search for policy periods
Policy period archive summaries
Creating contacts from a contact management system
ClaimCenter
FNOL and adjudication
Executing FNOL
The FNOL process in ClaimCenter
The FNOL process in Cloud API
Creating test policies
POSTing a draft claim
PATCHing a draft claim
POSTing a typical draft claim
Creating claims with unverified policies
Minimum criteria for an unverified policy and claim
Contacts on an unverified policy
Locations on an unverified policy
Risk units on an unverified policy
Coverages on unverified policies
PATCH an unverified policy
Retrieving information about an unverified policy
Submitting a draft claim
Canceling a draft claim
Sample payload addendum
Claims
Querying for claims associated with you
Querying for a claim by claim ID
Searching for active and archived claims
Retrieving policy information
Assigning claims
Validating claims
Retrieving claims from archive
Closing claims
ClaimContacts
Overview of ClaimContacts in Cloud API
ClaimContact roles
Querying for ClaimContacts
Creating new ClaimContacts
Working with contacts from the policy
Copying vendor contacts from ContactManager
Creating ClaimContacts during FNOL
PATCHing ClaimContacts
Assigning roles to existing ClaimContacts
Deleting ClaimContacts
Additional behaviors
Incidents
Overview of incidents in ClaimCenter
Overview of incidents in Cloud API
Fixed property incidents
Managing fixed property incidents
Managing dwelling incidents
Managing other structure incidents
General incidents
Injury incidents
Medical diagnoses
Bodily injury points
Living expenses incidents
Mobile property incidents
Baggage incidents
Property contents incidents
Vehicle incidents
Vehicle damage points
Trip incidents
Overview of trip incidents
Managing trip incidents
Managing trip accommodations
Managing trip segments
Exposures
Overview of exposures in ClaimCenter
Overview of exposures in Cloud API
Creating exposures
Querying for and modifying exposures
Assigning exposures
Deductibles
Additional exposure endpoints
Service requests
Overview of service requests in ClaimCenter
Overview of service requests in the Cloud API
Querying for service requests
Creating service requests
Modifying existing service requests
Advancing a service request in its lifecycle
Service request quotes
Service request invoices
Service request messages
Service request history events
Matters
Query for matters
Creating matters
PATCHing matters
Assigning matters
Closing and reopening matters
Workers' compensation claims
Workers' comp claims in ClaimCenter
Creating basic workers' comp claims
Creating lost wages workers' comp claims
Creating employer liability workers' comp claims
Typical basic workers' comp claim: Example
Managing ICD codes
Medical treatments
Configuring Cloud API behavior with workers' comp claims
Concurrent employers
Catastrophes
Querying for catastrophes
Creating catastrophes
Modifying catastrophes
Deleting catastrophes
Catastrophe zones
Catastrophe perils
Assessment summaries
Querying for assessment summaries
Creating assessment summaries
Financials
Reserves
Overview of reserves in ClaimCenter
Querying for reserves
Creating reserves
Acknowledging reserve transactions
Creating checks
Querying for check sets and checks
POSTing checks
Recurrences
Deductible handling
PATCHing checks
DELETEing checks
Managing the check life cycle
The check life cycle prior to submission
The check life cycle after submission
Acknowledging payment transactions
Denying checks
Recoveries and recovery reserves
Querying for recoveries and recovery reserves
Creating recoveries and recovery reserves
Creating a recovery reserve
Creating a recovery reserve set
Acknowledging a recovery reserve
Creating a recovery
Subrogation summaries and subrogations
Financial calculations
Retrieving the available financial calculations
Retrieving financial calculations
Calculations that include all relevant transactions
Calculations that filter transactions
Filtering transaction examples
Restricting access to financial calculation expressions
Multicurrency
Multicurrency overview
Retrieving multicurrency information
POSTing multicurrency information
Bulk invoices
Querying for bulk invoices
Creating bulk invoices
Modifying bulk invoices
Deleting bulk invoices
Bulk invoice items
Bulk invoice custom actions
PolicyCenter
Accounts
Creating accounts
Creating an account
Name clearance and account status
Child objects for an account
Creating accounts as an anonymous user
Managing accounts
Querying for accounts
Searching for accounts
Modifying accounts
Account contacts
Account contact addresses
Account contact roles
Account locations
Account relationships
Account user role assignment
Account jobs, job groups, and policies
Managing bound policies
Querying for policies
Searching for policies
Moving policies between accounts
Policy producers
Policy jobs
Policy contacts
Policy locations
Policy questions
Prior policies
Loss history
Pre-renewal directions
Additional actions for bound policies
Job types
Overview of policy transaction management
Submissions
Initiating a submission
Modifying the submission
Convert a quick quote submission to a full application submission
Moving submissions between accounts
Quoting the submission
Completing the submission
Binding and issuing a submission at the same time
Binding a submission without issuing
Issuing a previously bound policy
Withdrawing and rejecting submissions
Copying submissions
Additional features for submissions
Composite request submission example for Personal Auto
Renewals
Initiating a renewal
Modifying the renewal
Quoting the renewal
Completing the renewal
Policy changes
Initiating a policy change
Modifying the policy change
Quoting the policy change
Completing the policy change
Reversing a policy change
Issues specific to policy changes
Changing producers
Preemptions
Identifying that a job has been preempted
Viewing preemption information
Preemption payload example
Handling preemptions
Example of handling preemptions
Applying changes to a renewal
Cancellations and reinstatements
Cancellations
Reinstatements
Rewrite and Rewrite New Account
Rewrite transaction
Rewrite new account transaction
Audits
Audit policy endpoints
Audit job endpoints
Job policies
Overview of modifying jobs
Lines of business
Overview of lines of business
Lines
Additional LOB-specific endpoints
Contrasting job, policy, product, and line of business
Coverables and coverages
Overview of coverables
Adding coverables
Overview of coverages
Viewing available coverages on a policy
Adding coverages
Managing seasonal coverages
Coverage terms
Scheduled items
Scheduled item endpoints
Resources for scheduled items
Querying for scheduled items
Creating scheduled items
Coverage validation
Blankets
Blanket coverables
Blankets on jobs
Blankets on policies
Modifiers
Product and product line modifiers
Line-level and object-level modifiers
Modifier validation
Questions
Overview of questions
Answering questions
Question validation
Exposures, exclusions, and conditions
Overview of exposures, exclusions, and conditions
Adding exposures, exclusions, and conditions
Synchronization and deferred validation
Out-of-sync policy data
The /sync endpoints
Deferring validation
Default value creation
Modifiers
Product and product line modifiers
Line-level and object-level modifiers
Modifier validation
Policy contacts
Overview of policy contacts
Working with all policy contacts on a job
Policy contact addresses
Primary and secondary named insured contacts
Additional named insured contacts
LOB-specific additional insured contacts
Location named insureds
Policy locations
Overview of policy locations
Querying for a policy's locations
Creating policy locations
PATCHing policy locations
DELETEing policy locations
Commission overrides
Specify commission overrides
Coinsurance
Policy sections and coinsurance
Towers and layers
Coinsurance agreements
Policy foreign exchange rates
Job user role assignment
Overview of job user role assignment
Retrieving job user roles
Assigning job user roles
PATCHing job user roles
Working with product definitions
Product definitions for audit schedule patterns
Product definitions for lines
Product definitions for products
Product definitions for reference code data
Synchronize products with APD cloud service
PATCHing jobs
Read-only fields
Fields you can modify using PATCH /{jobId}
Fields you can modify using specific endpoints
Job support
Affinity groups
Working with affinity groups
Working with affinity group producer codes
Comparing jobs
Comparing a job to its base policy
Comparing two jobs on the same policy
Contingencies
Querying for contingencies
Creating contingencies
Closing contingencies
Form patterns
Form patterns information
Form patterns lookups
Form patterns with lookups
Policy and job forms
Job search
Out-of-sequence conflicts
Identifying out-of-sequence conflicts
Resolving out-of-sequence conflicts
Example: Identifying and resolving out-of-sequence conflicts
Policy archiving
Determine whether archiving is enabled
List archived policies
Set policies to Do Not Archive
Retrieve an archived policy
Bulk policy archive retrieval
Policy holds
Working with policy holds
Policy hold rules
Policy hold geographic zones
Example: Policy hold setup
Quoting
Costs and transactions
Multi-version quoting
Rating overrides
Manual pricing
Adding manual rates for coverage cost and other cost items
Updating manual rates for coverage cost and other cost items
Querying manual rates for coverage cost and other cost items
Reinsurance risks
Streamlined account and submission creation
Understanding the Graph API
Example: Creating a policy using the graph endpoints
Underwriting issues
Underwriting issues in PolicyCenter
Querying for underwriting issues
Creating underwriting issues
Managing underwriting issue approval
Job locks
Requesting approval
Referral reasons
Framework APIs
Producers
Commission plans
Organizations
Organization contacts
Producer codes
PolicyCenter contacts
Querying for contacts
Creating contacts
Updating contacts
Search for contacts
Destroy contact information
Contact addresses
Foreign exchange rates
Querying for exchange rate sets
Creating a foreign exchange rate set
Updating a foreign exchange set
Agency bill plan summaries
Personal data destruction
API entity destruction overview
System configuration
Obfuscating user data
Destroying a contact
Destroying an account
Destroying a policy
Preventing data destruction
ContactManager
Contacts
Overview of contacts in ContactManager
Overview of contacts in Cloud API
Querying for contacts
Creating contacts
Vendor contacts
Postal addresses
History events
Editing and deleting contacts
Additional behaviors
Contact search
Basic contact search criteria
Proximity searches
Additional search criteria for proximity searches
Authentication
Framework APIs
Activities
Querying for activities
Creating activities
Assigning activities
Closing activities
Additional activity functionality
Documents
Overview of documents
Querying for document information
POSTing documents
PATCHing documents
Sending document metadata only using JSON
DELETEing documents
Notes
Querying for notes
Creating claim notes
Creating account, job, and policy notes
Creating account and policy notes
Additional notes functionality
Users and groups
Users
Groups
Queues
User roles
Authority limit profiles
Authority profiles
Authority profile grants
Authority limits and authority limit profiles
Custom user attributes
Security zones
Querying for security zones
Creating security zones
Modifying and deleting security zones
Associating security zones with other objects
Geographic zones
Holidays
Querying for holidays
Creating holidays
Modifying and deleting holidays
Associating holidays with geographic zones
Date calculator
System time
Regions
Querying for regions
Creating regions
Modifying and deleting regions
Associating regions with region zones
Attributes
Querying for attributes
Creating attributes
Modifying attributes
Deleting attributes
History events
Typelist metadata
The /typelists endpoints
Querying with typekey filters
The /business-line-metadata endpoint
Tutorial: Query for typelist metadata
Batch processes
Overview of batch processes
Querying for batch process information
Getting information about batch process history
Managing batch processes
Database consistency checks
Overview of database consistency checks (DBCCs)
Running DBCCs
Running a previously run DBCC
Querying for DBCC run information
Business entity schemas
Retrieve a business entity schema
Business entity schema query parameters
ETag support
CreateSubmissionAttributes schema
Schema properties
Schema properties overview
Schema properties usage
The Test Util API
Enabling the Test Util API
View the Test Util API in Swagger UI
Test Util API endpoints
PATCHing jobs
This topic discusses changes you can make to a job directly on the
Job
resource.