Cloud API Consumer Guide
Cloud API Consumer Guide
Basic REST operations
Introduction to Cloud API
List of APIs in Cloud API
Version numbers for major and minor releases
Viewing API definitions
Swagger UI
View definitions using Swagger UI
Information in Swagger UI
The API definition endpoints and Postman
View definitions using Postman
Information in the output of API definition endpoints
The Guidewire API References site
View definitions using the API References site
Information on the API References site
REST API fundamentals
Cloud API calls
Resources
Endpoints
Root resources
Child resources
Methods
Paths
Requests and responses
Testing requests and responses
Tutorial: Set up your Postman environment
Cloud API GET requests
Overview of GETs
Standard payload structures
Viewing schemas
View a response schema in Swagger UI
Sending GETs
Send a GET using Postman
Tutorial: Send a basic Postman request
Payload structure for a basic response
Structure of a basic response
The count property
The data section
The attributes section
The checksum field
The links subsection (for an element)
The collection-level links section
Payload structure for a response with included resources
Tutorial: Send a Postman request with included resources
Structure of a response with included resources
The related section (for a resource)
The included section (for a response)
Including either a collection or a specific resource
Determining which resources can be included
Including nested resources
Cloud API query parameters
Overview of query parameters
Viewing query parameter definitions
The asOfDate query parameter
The fields query parameter
Tutorial: Send a GET with the fields parameter
The filter query parameter
Endpoints with default filters
The assignedUser filters
Tutorial: Send a GET with the filter parameters
The sort query parameter
Tutorial: Send a GET with the sort query parameter
The pagination query parameters
pageSize limits the number of resources per page
The self link returns a single resource in a page
pageOffset pages through resources
includeTotal retrieves the total number of resources
Tutorial: Send a GET with the pageSize and totalCount parameters
The includeLocalizations query parameter
Query parameters for included resources
Syntax for query parameters for included resources
Summary of query parameters for included resources
Specifying query parameters at different levels
Tutorial: Send a GET with query parameters for included resources
Query parameters for POSTs and PATCHes
Cloud API POST requests
Overview of POSTs
Standardizing payload structures
Viewing request schemas
View a request schema in Swagger UI
Designing a request payload
Request payload structure
Determining the minimum creation criteria
Specifying scalar values
Specifying compound values
Setting values and objects to null
Sending POSTs
Send a POST using Postman
Tutorial: Create a new note that specifies required fields only
Tutorial: Create a new note that specifies optional fields
Responses to a POST
Postman behavior with redirects
Business action POSTs
Improving POST performance
Cloud API PATCH requests
Overview of PATCHes
The PATCH payload structure
Designing a request payload
PATCHes and arrays
Sending PATCHes
Send a PATCH using Postman
Tutorial: PATCH an activity
Tutorial: PATCH an account
Responses to a PATCH
PATCHes and lost updates
Postman behavior with redirects
Cloud API DELETE requests
Overview of DELETEs
Tutorial: DELETE a note
Tutorial: DELETE an account contact
DELETEs and lost updates
Cloud API request headers
HTTP headers
Overview of Cloud API headers
Send a request with a Cloud API header using Postman
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 Cloud API calls
Reducing Cloud API calls
Features that execute multiple requests at once
Comparing features that execute multiple requests
Determining which feature to use
Cloud API composite requests
Constructing composite requests
The requests section
Using variables to share information across subrequests
Responses to the subrequests
The selections section
Composite request examples
Composite request limitations
Administering composite requests
Error handling
Logging
Configuring the maximum number of subrequests
Complete composite request syntax
Request/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
Cloud API batch requests
Batch request syntax
Optional subrequest attributes
Batch request examples
Simple batch requests
Batch requests with query parameters
Batch requests with request payloads
Batch requests with distinct operations
Administering batch requests
Specifying subrequest headers
Specifying onFail behavior
Configuring the maximum number of subrequests
Lost updates and checksums
Lost updates
Checksums
Checksums for PATCHes and business action POSTs
Tutorial: PATCH an activity using checksums
Tutorial: PATCH an account using checksums
Tutorial: Assign an activity using checksums
Checksums for DELETEs
Send a checksum in a request header using Postman
Tutorial: DELETE a note using checksums
Asynchronous calls
Overview of asynchronous calls
Determining when the call has been processed
Retrieving the response using /requests/{asyncRequestId}
Retrieving the response from /requests/{asyncRequestId}/response
Sending a request asynchronously
Tutorial: Send a request asynchronously
Retrieving the response to the original request
Response information in the /requests response
Response information using the /response endpoint
Tutorial: Retrieve information about an asynchronous request
Waiting for a response synchronously
Tutorial: Send a request asynchronously with a wait time
Asynchronous request administration
BillingCenter Cloud API
BillingCenter plans and data
BillingCenter plan behavior
Plan order
Testing plans
Endpoints for testing plans
Plans and multicurrency
Currencies at the plan level
Currencies at the fee/threshold level
BillingCenter 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
Querying for reasons and events
Creating reasons and events
Modifying reasons and events
Payment allocation plans
Querying for payment allocation plans
Creating payment allocation plans
Modifying payment allocation plans
BillingCenter payment plans
Overview of payment plans
Querying for payment plans
Creating payment plans
Modifying payment plans
Payment plan overrides
Querying for payment plan overrides
Creating payment plan overrides
PATCHing payment plan overrides
DELETEing 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
Changing the priority of return premium handling schemes
BillingCenter commission plans
Working with commission plans
Querying for commission plans
Creating commission plans
Modifying commission plans
Commission subplans
Working with subplans
Query for subplans
Create a conditional subplan
Modifying subplan
Deleting 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 actions
BillingCenter accounts
Querying for accounts
Creating an account
Creating an account example payload
Child objects for an account
Payment instruments
Querying for universal payment instruments
Querying for account payment instruments
Creating account-level payment instruments
Patching account-level payment instruments
Account contacts
Querying for account contacts
Creating account contacts
Additional behaviors
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
BillingCenter policies
Querying for policies and policy periods
Issuing policies
Example: Preview a policy issuance
Canceling policies
Reinstating policies
Reinstate a policy
Rewriting policies
Renewing policies
Executing a policy change
Previewing policy transactions
Example: Preview a policy issuance
Changing a policy's payment plan
Preview a payment plan change
Policy-level charges
Policy period contacts
Policy notes
Policy period general billing instructions
Policy audits
Schedule a final audit
Issue an audit billing instruction
Waive a final audit
Search for policy periods
Policy period archive summaries
Charges and charge patterns
Overview of charge patterns
Working with charge patterns
Working with charges
BillingCenter invoices
Overview of invoices
Working with invoices
Retrieving invoices on an invoice stream
Working with invoice items
Invoice item events
Working with invoice streams
Querying for an account's invoice streams
Modifying invoice streams
Direct bill payments
Querying for direct bill payments
Creating and distributing direct bill payments
Minimum creation criteria
Payments with a specific target
Distributing direct bill payments when they are created
Distributing direct bill payments after creation
Querying for distribution information
Payment requests
Querying for payment requests
Creating 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
Querying for suspense payment disbursements
The disbursement approval workflow
Creating suspense payment disbursements
BillingCenter disbursements
Querying for disbursements
Modifying disbursements
Approving disbursements
Rejecting disbursements
Voiding disbursements
Get Enhanced Funds Tracking data for disbursements
Search for disbursements
BillingCenter producers
Working with producers
Querying for producers
Creating producers
Modifying producers
Producer codes
Query for producer codes
Create producer codes
Modify producer codes
Producer contacts
Query for producer contacts
Create producer contacts
Modify producer contacts
Delete 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
BillingCenter agency bill
Statement invoices
Querying for statement invoices
Agency bill cycles
Agency bill payments
Query for agency bill payments
Create and distribute agency bill payments
Create an agency bill payment without distribution
Create an agency bill payment with distribution
Retrieve payment distribution information
Agency bill payments in suspense
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
Retrieve promise distribution information
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
Retrieve payment mismatch exceptions
Resolve payment mismatch exceptions
Agency bill suspense items
Agency bill disbursements
Retrieve agency bill disbursements
Create agency bill disbursements
Other agency bill disbursement operations
BillingCenter transactions
BillingCenter trouble tickets
Querying for trouble tickets
Creating trouble tickets
Modifying trouble tickets
Assigning a trouble ticket
Search for trouble tickets
Closing a trouble ticket
Trouble ticket join entities
Querying for trouble ticket join entities
Creating trouble ticket join entities
Deleting trouble ticket join entities
Trouble ticket holds and hold type entries
Querying for trouble ticket holds
Hold type entries
Querying for hold type entries
Creating hold type entries
Modifying hold type entries
Deleting hold type entries
Trouble ticket notes
Querying for trouble ticket notes
Creating trouble ticket notes
BillingCenter T-accounts
Enhanced funds tracking
Enhanced funds sources
Unapplied fund slices
Enhanced funds use events and use event groupings
Funds slice allocations
Creating contacts
ClaimCenter Cloud API
FNOL and adjudication
Executing ClaimCenter FNOL
The FNOL process in ClaimCenter
Draft claims and open claims
Verified and unverified policies
Claim validation at FNOL
The FNOL process in Cloud API
The Cloud API FNOL process
FNOL use cases by policy state
Claim validation at FNOL
Composite request limitations with claims
Canceling claims
Claim modes
Creating test policies
Creating test policy data
Tutorial: Creating a policy using the Test Util API
Creating test data for related objects
POSTing a draft claim
Tutorial: POSTing a minimal draft claim for personal auto
PATCHing a draft claim
Tutorial: PATCHing a draft claim for personal auto
POSTing a typical draft claim
Tutorial: POSTing a typical draft claim for personal auto
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
Minimum criteria for submitting a claim with an unverified policy
Tutorial: POSTing a typical draft claim for personal auto
Canceling a draft claim
Sample payload addendum
Sample policy payload
Sample draft claim payload
Sample composite claim payload
Sample composite first-and-final
ClaimCenter claims
Querying for claims associated with you
Querying for a claim by claim ID
Searching for active and archived claims
Request payload for a claim search
Response payload for a claim search
Retrieving policy information
Summary of the policy endpoints
Assigning claims
Validating claims
ClaimCenter validation levels
Validating a claim through Cloud API
Retrieving claims from archive
Closing claims
ClaimCenter claim contacts
Overview of ClaimContacts in Cloud API
ClaimContact roles
Querying for ClaimContacts
Creating new ClaimContacts
Creating a new ClaimContact with a reserved role
Creating a new ClaimContact with a non-reserved role
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
Masking the taxID field
Role constraint endpoints
Role owners endpoint
Specifying pronouns for contacts
ClaimCenter 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
ClaimCenter exposures
Overview of exposures in ClaimCenter
Overview of exposures in Cloud API
Creating exposures
Minimum creation criteria
Building an exposure payload
Step 1: Identify the coverage type
Step 2: Identify the coverage subtype
Step 3: Create or identify the claimant
Step 4: Create or identify the incident
Step 5: Identify the coverage
Querying for and modifying exposures
Assigning exposures
Deductibles
Additional exposure endpoints
Deleting draft exposures
Validating exposures
Closing exposures
ClaimCenter service requests
Overview of service requests in ClaimCenter
Service request kinds
The service request lifecycle
Invoices for service request
Overview of service requests in the Cloud API
Service request APIs and vendor portals
Required service request data model
Service request numbers
Support for each service request kind
Composite request limitations with service requests
Querying for service requests
Creating service requests
Minimum creation criteria
Modifying existing service requests
PATCHing service requests
Assigning service requests to users
Advancing a service request in its lifecycle
Submitting, accepting, and declining service requests
Completing and canceling service requests
Service request quotes
Service request invoices
Querying for invoices
Creating invoices for service requests
Approving service request invoices
Marking invoices as paid
Withdrawing service request invoices
Service request messages
Service request history events
ClaimCenter matters
Query for matters
Creating matters
PATCHing matters
Assigning matters
Assignment options
Assignment examples
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
Querying for concurrent employers
Creating concurrent employers
Modifying concurrent employers
Deleting concurrent employers
ClaimCenter catastrophes
Querying for catastrophes
Creating catastrophes
Modifying catastrophes
Deleting catastrophes
Catastrophe zones
Querying for catastrophe zones
Creating catastrophe zones
Deleting catastrophe zones
Catastrophe perils
Querying for catastrophe perils
Creating catastrophe perils
Modifying catastrophe perils
Deleting catastrophe perils
Assessment summaries
Querying for assessment summaries
Creating assessment summaries
ClaimCenter financials
ClaimCenter reserves
Overview of reserves in ClaimCenter
Querying for reserves
Creating reserves
Example of creating reserves
Example of adding to reserves
Acknowledging reserve transactions
Creating checks
Querying for check sets and checks
POSTing checks
Check creation in ClaimCenter
Check creation through Cloud API
Example of creating a minimal check set
Recurrences
Recurrences in ClaimCenter
Recurrences in Cloud API
Sending checks every X months on the Nth day
Sending checks every X months on the Nth dayOfWeek
Sending checks every X weeks on dayOfWeek
Deductible handling
Deductible handling in ClaimCenter
Deductible handling in Cloud API
Underpaying and overpaying deductibles
PATCHing checks
DELETEing checks
Check and payment cycles
The check life cycle prior to submission
Advancing a check to submission through Cloud API
The check life cycle after submission
Advancing a check beyond submission through Cloud API
Acknowledging payment transactions
Denying checks
Recoveries and 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
ClaimCenter multicurrency
Multicurrency overview
Multicurrency in ClaimCenter
Multicurrency in Cloud API
Retrieving multicurrency information
Multicurrency reserves
Multicurrency checks
Exchange rate information for transactions
POSTing multicurrency information
POSTing a reserve with multiple currencies
POSTing a reserve with a custom exchange rate
POSTing a check set with multiple currencies
POSTing a check set with a custom exchange rate
Specifying multicurrency line items
Additional exchange rate schema fields
Bulk invoices
Querying for bulk invoices
Creating bulk invoices
Modifying bulk invoices
Deleting bulk invoices
Bulk invoice items
Querying for bulk invoice items
Creating bulk invoice items
Deleting bulk invoice items
Modifying bulk invoice items
Bulk invoice custom actions
Validating bulk invoices
Submitting bulk invoices
Stopping or voiding bulk invoices
Retrying bulk invoices
PolicyCenter Cloud API
PolicyCenter accounts
Creating accounts
Creating an account
The account holder
The primary location
The producer code
Creating an account example payload
Name clearance and account status
Child objects for an account
Creating accounts as an anonymous user
Managing accounts
Querying for accounts
Searching for accounts
Searching for accounts using free-text search
Modifying accounts
Account contacts
Querying for account contacts
Creating account contacts
Modifying account contacts
Linking account contact addresses
Additional behaviors
Account contact addresses
Account contact roles
Account locations
Querying for account locations
Creating account locations
Modifying 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
The producer data model
Changing a policy's producer
Policy jobs
Policy contacts
Policy locations
Policy questions
Prior policies
Querying for prior policy information
Creating prior policy information
Updating prior policy information
Loss history
Loss history in PolicyCenter
Loss history in Cloud API
Querying for loss history information
PATCHing policy-level loss history information
Working with loss history entries
Pre-renewal directions
Retrieving pre-renewal directions
Setting pre-renewal directions
Clearing pre-renewal directions
Additional actions for bound policies
PolicyCenter job types
Policy transaction management
PolicyCenter Cloud API 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
PolicyCenter Cloud API renewals
Initiating a renewal
Modifying the renewal
Quoting the renewal
Completing the renewal
PolicyCenter Cloud API 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/reinstatements
Cancellations
Initiating a cancellation
Modifying and requoting the cancellation
Completing the cancellation
Reinstatements
Initiating a reinstatement
Modifying and quoting the reinstatement
Completing the reinstatement
PolicyCenter Cloud API rewrites
Rewrite transaction
Rewrite new account transaction
PolicyCenter Cloud API rebinds
Rebind transaction
PolicyCenter Cloud API audits
Audit policy endpoints
Audit job endpoints
Job policies
Modifying jobs overview
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
Cloud API blankets
Blanket coverables
Blankets on jobs
Blankets on policies
PolicyCenter Cloud API modifiers
Product and product line modifiers
Line-level and object-level modifiers
Modifier validation
Cloud API questions
Overview of questions
Answering questions
Specifying answers
Question validation
Exposures, exclusions
Overview of exposures, exclusions, and conditions
Adding exposures, exclusions, and conditions
Sync and deferred validation
Out-of-sync policy data
The /sync endpoints
The /sync-coverages endpoints
The /sync-fields endpoints
The /sync-modifiers endpoints
The /sync-questions endpoints
When to call a /sync endpoint
Syncing child objects
Deferring validation
The deferValidation query parameter
Authorization to defer validation
Limitations to deferred validation
Default value creation
The createCoveredLocationForPrimaryLocation query parameter
The createDefaultCoverages query parameter
The createDefaultPolicyLines query parameter
The createPrimaryLocationFromAccount query parameter
The suppressAllDefaults query parameter
PolicyCenter Cloud API 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
Querying for all policy contacts on a job
Adding a policy contact
Updating and deleting policy contacts
Linking policy contact addresses
Additional behaviors
Policy contact addresses
Primary and secondary named insured contacts
Additional named insured contacts
Querying for additional named insureds
Adding additional named insureds
Updating additional named insureds
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
PolicyCenter coinsurance
Policy sections and coinsurance
Query for coinsurance agreement details
Towers and layers
Query for tower details
Create a tower with layers
Update a tower
Delete a tower
Coinsurance agreements
Query for coinsurance agreement details
Create a coinsurance agreement
Update coinsurance agreements
Delete a coinsurance agreement
Policy exchange rates
Job role assignment
Overview of job user role assignment
Retrieving job user roles
Assigning job user roles
PATCHing job user roles
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
PATCH 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
Structure of the JobReviewDiffs resource
Example of a /review-diffs response
Comparing two jobs on the same policy
Structure of the CompareJobAttributes resource
Example of a /compare-jobs response
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
Querying for policy holds
Creating policy holds
Modifying policy holds
Deleting policy holds
Policy hold components
Policy hold rules
Querying for policy hold rules
Adding policy hold rules
Modifying policy hold rules
Deleting policy hold rules
Policy hold geographic zones
Example: Policy hold setup
Create policy hold details
Add rules to the policy hold
Add geographic zones to the policy hold
Quoting
Costs and transactions
Multi-version quoting
Job version properties
Creating a new job version
Selecting a job version
Working with job versions
Rating overrides
Rating overrides in Cloud API
Manual pricing
Adding manual rates for coverage cost and other cost items
Creating a coverage cost with exposure pricing basis
Creating a coverage cost with a cumulative pricing basis
Creating an other cost item with a cumulative pricing basis
Updating manual rates for coverage cost and other cost items
Querying manual rates for coverage cost and other cost items
Reinsurance risks
Account/submission creation
Understanding the Graph API
The Graph API
Graph vs Account and Job APIs
Using Graph API endpoints in a composite request
Order of operations
Adding Ref IDs
Additonal Graph API functionality
Example account and submission creation
Example: Creating a policy using the graph endpoints
Underwriting issues
Underwriting issues in PolicyCenter
Querying for underwriting issues
Creating underwriting issues
Minimum creation criteria
Examples of creating an underwriting issue
Managing underwriting issue approval
Approval underwriting issues
Rejecting underwriting issues
Reopening underwriting issues
Job locks
Locking jobs
Releasing locks
Requesting approval
Requesting approval through Cloud API
Referral reasons
Querying for referral reasons
Creating referral reasons
Closing and reopening referral reasons
PolicyCenter framework APIs
PolicyCenter producers
Commission plans
Organizations
Querying for organizations
Creating organizations
Updating organizations
Organization contacts
Create an organization contact
Updating organization contacts
Organization contact addresses
Producer codes
Querying for producer codes
Creating producer codes
Updating producer codes
Managing producer codes for users and groups
The UserProducerCode and GroupProducerCode endpoints
Querying for user and group producer codes
Associating producer codes with users and groups
Exposing producer codes to external users
PolicyCenter contacts
Querying for contacts
Creating contacts
Updating contacts
Search for contacts
Destroy contact information
Contact addresses
PolicyCenter FX rates
Querying for exchange rate sets
Creating a foreign exchange rate set
Updating a foreign exchange set
Agency bill 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 Cloud API
ContactManager contacts
Overview of contacts in ContactManager
Overview of contacts in Cloud API
Querying for contacts
Creating contacts
Minimum creation criteria for contacts
Vendor contacts
Minimum creation criteria for vendor contacts
Vendor contact services
Postal addresses
Primary addresses
Secondary addresses
History events
Review summaries
Editing and deleting contacts
Additional behaviors
ContactManager search
Basic contact search criteria
Contact subtypes
Minimum search criteria
Tag-based searches
Include "pending create" contacts
Search by organizations
ClaimCenter contact search fields
Proximity searches
Basic proximity searches
Specifying a radius and unit of distance
Limiting results to the N closest contacts
Additional search criteria for proximity searches
Search for preferred vendors
Search for vendors that provide a given service
Search for vendors with a given score or greater
ContactManager auth
InsuranceSuite Framework APIs
Cloud API activities
Querying for activities
Searching for activities
Creating activities
Assigning activities
Assignment options
Assignment examples
Retrieving recommended assignees
Closing activities
Additional activity functionality
Querying for activity documents
Deleting activity documents
Creating claim activity documents
Cloud API documents
Overview of documents
Querying for document information
Querying for document metadata
Querying for document content
POSTing documents
POSTing documents using Postman
PATCHing documents
Sending document metadata only using JSON
DELETEing documents
Cloud API 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
Querying for user information
Creating users
Updating users
Deleting users
Groups
Querying for groups
Creating groups
Assigning users to groups
Updating groups
Deleting groups
Queues
Working with queues
User roles
Querying for user roles
Creating user roles
Updating user roles
Querying for roles and orbits
Authority limit profiles
Retrieving information about authority limit profiles
Creating authority limit profiles
Adding limits to the profile
Updating authority limit profiles
Authority profiles
Retrieving information about underwriting authority profiles
Assigning authority profiles to users
Creating authority profiles
Modifying authority profiles
Authority profile grants
Querying for grants
Creating grants
Modifying grants
Authority limits and authority limit profiles
Querying for authority limits and authority limit profiles
Checking authority limits before making transactions
Custom user attributes
Querying for custom user attributes
Creating custom user attributes
Modifying custom user attributes
Deleting 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
Cloud API holidays
Querying for holidays
Creating holidays
Modifying and deleting holidays
Associating holidays with geographic zones
Date calculator
System time
Cloud API regions
Querying for regions
Creating regions
Modifying and deleting regions
Associating regions with region zones
Cloud API 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
Starting a batch process
Starting a batch process with arguments
Stopping a batch process
Consistency checks
Overview of database consistency checks (DBCCs)
Running DBCCs
Running a previously run DBCC
Querying for DBCC run information
Entity schemas
Retrieve a business entity schema
Business entity schema query parameters
ETag support
CreateSubmissionAttributes schema
Schema properties
Schema properties overview
Schema properties usage
Test Util API
Enabling the Test Util API
View the Test Util API in Swagger UI
Test Util API endpoints