Flat Charges API

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

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
elementLocator string
elementStaticLocator string
amount number
chargeCategory Enum cededPremium | commission | credit | fee | flatCededPremium | flatCommission | flatFee | flatPremium | flatTax | invoiceFee | none | nonFinancial | premium | surcharge | tax
chargeType string
handling Enum flat | normal
invoicing Enum immediate | next | scheduled
rate number
referenceRate number

optional
reversalOfLocator string?
rateDifference number?
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[]

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