BillingCenter 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 fields query parameter
The filter query parameter
The sort query parameter
The pagination query parameters
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
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
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
Business flows: BillingCenter
Overview of plans
Plan order
Testing plans
Plans and multicurrency
Billing plans
Delinquency plans
Querying for delinquency plans
Creating delinquency plans
Modifying delinquency plans
Delinquency plan workflows
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
Accounts
Querying for accounts
Creating an account
Payment instruments
Account contacts
Account-level charges
Unapplied funds
Delinquency processes
PATCHing accounts
Policies
Querying for policies and policy periods
Issuing policies
Canceling policies
Reinstating policies
Rewriting policies
Changing a policy’s payment plan
Policy-level charges
Policy period contacts
Policy notes
Producers
Working with producers
Producer codes
Producer contacts
Producer payment instruments
Policy commissions
Create a producer, producer contact, and producer code in one call
Agency bill
Agency bill plans
Statement invoices
Agency bill cycles
Agency bill payments
Querying for agency bill payments
Creating and distributing agency bill payments
Payment mismatch exceptions
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
Charges and charge patterns
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
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
Creating contacts from a contact management system
Business flows: Framework APIs
Activities
Querying for 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 account and policy notes
Additional notes functionality
Users and groups
Users
Groups
Queues
User roles
Authority limits and authority limit profiles
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
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
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
Agency bill in BillingCenter: Statement Bill