Billing API Index

Main Index

• Installments API
• Installment Lattices API
• Invoices API
• Payments API
• Disbursements API
• Credit Distribution API
• Credits API
• Account Balances API
• Financial Instruments and External Cash Transactions API
• Delinquency API
• Billing Holds API
• Write-Offs API

Policy Service Endpoints

The following endpoints are used to update billing parameters but are hosted on their respective services:

Update Policy Billing Trigger

Deprecated

updatePolicyBillingTrigger

This endpoint will be removed in a future release.

PATCH /policy/{tenantLocator}/policies/{locator}/billingTrigger

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	locator	required

Request:BillingTriggerUpdateRequest
Response:PolicyResponse
Security Group:policies   Permission:write

BillingTriggerUpdateRequest

Deprecated

This entity will be removed in a future release.

required
billingTrigger Enum accept | issue

Update Billing Level for an Account

updateBillingLevelForAnAccount

PATCH /policy/{tenantLocator}/accounts/{locator}/billingLevel

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	locator	required

Request:UpdateBillingLevelRequest
Response:AccountResponse
Security Group:accounts   Permission:write

Update Billing Level for a Policy

updateBillingLevelForAPolicy

PATCH /policy/{tenantLocator}/policies/{locator}/billingLevel

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	locator	required

Request:UpdateBillingLevelRequest
Response:PolicyResponse
Security Group:policies   Permission:write

Update Billing Level for a Quote

updateBillingLevelForAQuote

PATCH /policy/{tenantLocator}/quotes/{locator}/billingLevel

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	locator	required

Request:UpdateBillingLevelRequest
Response:QuoteResponse
Security Group:quotes   Permission:write