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
Business flows: BillingCenter
Overview of plans
Plan order
Endpoints for testing
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
PATCHing accounts
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
Modifying account contacts
Policies
Querying for an account's policies
Charges and charge patterns
Overview of charge patterns
Working with charge patterns
Invoices
Overview of invoices
Working with invoices
Working with invoice streams
Querying for an account's invoice streams
Direct bill payments
Creating direct bill payments
Minimum creation criteria
Payments with a specific target
Payment requests
Querying for payment requests
Creating payment requests
Business flows: Framework APIs
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
Security zones
Querying for security zones
Creating security zones
Modifying and deleting security zones
Associating security zones with other objects
Geographic zones
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