Cloud API Consumer Guide
BillingCenter 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
GETs
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)
Determining which resources can be included
Query parameters
Overview of query parameters
Viewing query parameter definitions
The fields query parameter
Tutorial: Send a GET with the fields parameter
The filter query parameter
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
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
POSTs
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
PATCHes
Overview of PATCHes
The PATCH payload structure
Designing a request payload
PATCHes and arrays
Sending PATCHes
Send a PATCH using Postman
Tutorial: PATCH an account
Responses to a PATCH
PATCHes and lost updates
Postman behavior with redirects
DELETEs
Overview of DELETEs
Tutorial: DELETE an account contact
DELETEs and lost updates
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 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
The requests section
Using variables to share information across subrequests
Responses to the subrequests
The selections section
Composite request limitations
Administering composite requests
Error handling
Logging
Configuring the maximum number of subrequests
Complete composite request syntax
Request and response inclusion
Syntax for simple parent/child relationships
PATCHes in request inclusion
Additional behaviors with write inclusion
Additional behaviors with read inclusion
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 account using checksums
Checksums for DELETEs
Send a checksum in a request header using Postman
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
Business flows: BillingCenter
Overview of plans
Plan order
Testing plans
Endpoints for testing plans
Plans and multicurrency
Currencies at the plan level
Currencies at the fee/threshold level
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
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
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
Account contacts
Querying for account contacts
Creating account contacts
Additional behaviors
Account-level charges
Unapplied funds
Delinquency processes
PATCHing accounts
Policies
Querying for policies and policy periods
Issuing policies
Canceling policies
Changing a policy’s payment plan
Policy-level charges
Policy notes
Producers
Working with producers
Querying for producers
Creating producers
Modifying producers
Producer codes
Querying for producer codes
Creating producer codes
Modifying producer codes
Producer contacts
Querying for producer contacts
Creating producer contacts
Modifying producer contacts
Deleting producer contacts
Policy commissions
Create a producer, producer contact, and producer code in one call
Agency bill
Agency bill plans
Querying for agency bill plans
Creating agency bill plans
Modifying agency bill plans
Deleting agency bill plans
Statement invoices
Query for statement invoices
Agency bill cycles
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
Modify a 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
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
Working with invoice streams
Querying for an account's invoice streams
Modifying invoice streams
Direct bill payments
Querying for direct bill payments
Creating direct bill payments
Minimum creation criteria
Payments with a specific target
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
Disbursements
Querying for disbursements
Business flows: Framework APIs
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
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
Authority limits and authority limit profiles
Querying for authority limits and authority limit profiles
Checking authority limits before making transactions
Security zones
Querying for security zones
Creating security zones
Modifying and deleting security zones
Associating security zones with other objects
Geographic zones
History events
Batch processes
Overview of batch processes
Querying for batch process information
Managing batch processes
Starting a batch process
Starting a batch process with arguments
Stopping a batch process
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
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