Flat Charges API

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

Add ChargesaddCharges

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`accountLocator`	path	`ulid`	Yes

Request:ChargesCreateRequest

Response:ChargeResponse[]

Security Group:charges

Permission:

write

ChargesCreateRequest

Required properties

Property	Type	Description
`charges`	`ChargeCreateRequest[]`

Optional properties

Property	Type	Description
`policyLocator`	`ulid?`
`currency`	`string?`
`invoicing`	`Enum? scheduled \| next \| immediate`

ChargeCreateRequest

Required properties

Property	Type	Description
`amount`	`number`
`chargeType`	`string`

Optional properties

Property	Type	Description
`transactionLocator`	`ulid?`
`elementLocator`	`ulid?`
`elementStaticLocator`	`ulid?`
`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.

If the charge creation request references a specific policyLocator, the resulting invoice item or items will assume the policy's timezone. Otherwise, the timezone will be set to the tenant's defaultTimezone.

ChargeResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`accountLocator`	`ulid`
`currency`	`string`
`amount`	`number`
`chargeCategory`	`Enum none \| premium \| tax \| fee \| credit \| invoiceFee \| cededPremium \| nonFinancial \| surcharge`
`chargeInvoicing`	`Enum scheduled \| next \| immediate`
`chargeType`	`string`

Optional properties

Property	Type	Description
`policyLocator`	`ulid?`
`transactionLocator`	`ulid?`
`elementLocator`	`ulid?`
`elementStaticLocator`	`ulid?`
`reversalOfLocator`	`ulid?`
`tag`	`string?`

Reverse Charges

Reverse ChargesreverseCharges

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`accountLocator`	path	`ulid`	Yes

Request:ChargesReversalRequest

Response:ChargeResponse[]

Security Group:charges

Permission:

write

ChargesReversalRequest

Required properties

Property	Type	Description
`invoicing`	`Enum scheduled \| next \| immediate`
`charges`	`ulid[]`

Add Invoice Fee to Policy or Quote

Add or update invoice fee on a quote

Add or update invoice fee on a quoteupdateQuoteInvoiceFeeAmount

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:UpdateInvoiceFeeAmountRequest

Response:QuoteResponse

Security Group:quotes

Permission:

write

Add or update invoice fee on a policy

Add or update invoice fee on a policyupdatePolicyInvoiceFeeAmount

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:UpdateInvoiceFeeAmountRequest

Response:PolicyResponse

Security Group:policies

Permission:

write

UpdateInvoiceFeeAmountRequest

Required properties

Property	Type	Description
`invoiceFeeAmount`	`number`

Fetch

Fetch Charges by Account

Fetch Charges by AccountfetchChargesByAccount

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`accountLocator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseChargeResponse

Security Group:charges

Permissions:

read,list

ListPageResponseChargeResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`ChargeResponse[]`

Fetch Charges by Policy

Fetch Charges by PolicyfetchChargesByPolicy

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`policyLocator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseChargeResponse

Security Group:charges

Permissions:

read,list

Fetch Charges by Transaction

Fetch Charges by TransactionfetchChargesByTransaction

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`transactionLocator`	path	`ulid`	Yes
`includeAll`	query	`boolean?`	No
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseChargeResponse

Security Group:charges

Permissions:

read,list

Flat Charges API

On this page