Flat Charges API

Endpoint Index

Action	Endpoint
Add Charges	POST /billing/{tenantLocator}/accounts/{accountLocator}/charges
Reverse Charges	POST /billing/{tenantLocator}/accounts/{accountLocator}/charges/reverse
Add or update invoice fee on a quote	PATCH /policy/{tenantLocator}/quotes/{locator}/invoiceFeeAmount
Add or update invoice fee on a policy	PATCH /policy/{tenantLocator}/policies/{locator}/invoiceFeeAmount
Fetch Charges by Account	GET /billing/{tenantLocator}/accounts/{accountLocator}/charges/list
Fetch Charges by Policy	GET /billing/{tenantLocator}/policies/{policyLocator}/charges/list
Fetch Charges by Transaction	GET /billing/{tenantLocator}/transactions/{transactionLocator}/charges/list

Create and Reverse

Add Charges

addCharges

POST /billing/{tenantLocator}/accounts/{accountLocator}/charges

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
accountLocator	path	string	required

Request:ChargesCreateRequest
Response:ChargeResponse[]
Security Group:charges   Permission:write

ChargesCreateRequest

required
charges ChargeCreateRequest[]

optional
policyLocator string?
currency string?
invoicing Enum? immediate | next | scheduled

ChargeCreateRequest

required
amount number
chargeType string

optional
transactionLocator string?
elementLocator string?
elementStaticLocator string?
tag string?

Since charges are created with reference to an account, any policyLocator or transactionLocator in the charge creation request must belong to the account. If transactionLocator and elementLocator are provided, the elementLocator must belong to the transaction specified by transactionLocator.

ChargeResponse

required
locator string
accountLocator string
currency string
amount number
chargeCategory Enum cededPremium | commission | credit | fee | flatCededPremium | flatCommission | flatFee | flatPremium | flatTax | invoiceFee | none | nonFinancial | premium | surcharge | tax
chargeInvoicing Enum immediate | next | scheduled
chargeType string

optional
policyLocator string?
transactionLocator string?
elementLocator string?
elementStaticLocator string?
reversalOfLocator string?
tag string?

Reverse Charges

reverseCharges

POST /billing/{tenantLocator}/accounts/{accountLocator}/charges/reverse

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
accountLocator	path	string	required

Request:ChargesReversalRequest
Response:ChargeResponse[]
Security Group:charges   Permission:write

ChargesReversalRequest

required
invoicing Enum immediate | next | scheduled
charges string[]

Add Invoice Fee to Policy or Quote

Add or update invoice fee on a quote

updateQuoteInvoiceFeeAmount

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

Request Parameters:

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

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

Add or update invoice fee on a policy

updatePolicyInvoiceFeeAmount

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

Request Parameters:

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

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

UpdateInvoiceFeeAmountRequest

required
invoiceFeeAmount number

Fetch

Fetch Charges by Account

fetchChargesByAccount

GET /billing/{tenantLocator}/accounts/{accountLocator}/charges/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
accountLocator	path	string	required
offset	query	int?	optional
count	query	int?	optional

Response:ListPageResponseChargeResponse
Security Group:charges   Permissions:read,list

ListPageResponseChargeResponse

required
listCompleted boolean
items ChargeResponse[]

Fetch Charges by Policy

fetchChargesByPolicy

GET /billing/{tenantLocator}/policies/{policyLocator}/charges/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
policyLocator	path	string	required
offset	query	int?	optional
count	query	int?	optional

Response:ListPageResponseChargeResponse
Security Group:charges   Permissions:read,list

Fetch Charges by Transaction

fetchChargesByTransaction

GET /billing/{tenantLocator}/transactions/{transactionLocator}/charges/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
transactionLocator	path	string	required
includeAll	query	boolean?	optional
offset	query	int?	optional
count	query	int?	optional

Response:ListPageResponseChargeResponse
Security Group:charges   Permissions:read,list