Cash Management API

Endpoint Index

Action	Endpoint
Fetch a cash balance	GET /cashBalances/{cashBalanceLocator}
Transfer funds from one cash balance to another	PATCH /cashBalances/{sourceCashBalanceLocator}
Create a disbursement	POST /cashBalances/{cashBalanceLocator}/disbursements
Update or issue a disbursement	PATCH /disbursements/{disbursementLocator}
Fetch a disbursement	GET /disbursements/{disbursementLocator}
Fetch disbursements	GET /disbursements
Issue a catch-up	POST /cashBalances/{cashBalanceLocator}/invoices
Write off a catch-up	PATCH /catchUps/{catchupLocator}/writeOff
Invalidate a catch-up	PATCH /catchUps/{catchupLocator}/invalidate
Fetch a catch-up	GET /catchUps/{catchupLocator}
Fetch catch-ups	GET /catchUps
Fetch cash balance records	GET /cashBalanceLog/records
Fetch attributed cash balance records	GET /cashBalanceLog/attributedRecords

Cash Balances

Fetch a cash balance¶

GET /cashBalances/{cashBalanceLocator}

Request:

Name	Position	Type	Required
cashBalanceLocator	path	string	required

Response: CashBalanceResponse

CashBalanceResponse¶

required
locator string
policyholderLocator string
policyLocator string
amount number
currency string

Note

Any existing cash balance for a policy will be included in the PolicyResponse for the policy.

Transfer funds from one cash balance to another¶

PATCH /cashBalances/{sourceCashBalanceLocator}

Request:

Name	Position	Type	Required
cashBalanceTransferRequest	body	CashBalanceTransferRequest	required
sourceCashBalanceLocator	path	string	required

Response: CashBalanceTransferResponse

CashBalanceTransferRequest¶

required
name string
amount number
targetCashBalanceLocator string

optional
details string

CashBalanceTransferResponse¶

required
amount number
newSourceCashBalanceAmount number
newTargetCashBalanceAmount number
previousSourceCashBalanceAmount number
previousTargetCashBalanceAmount number
sourceCashBalanceLocator string
targetCashBalanceLocator string

Payments

See the Payments API.

Disbursements

Create a disbursement¶

POST /cashBalances/{cashBalanceLocator}/disbursements

Request:

Name	Position	Type	Required
cashBalanceLocator	path	string	required
request	body	DisbursementCreateRequest	required

Response: DisbursementResponse

DisbursementCreateRequest¶

required
amount number

optional
fieldValues map<string,[string]>

DisbursementResponse¶

required
locator string
displayId string
policyLocator string
state string draft | issued | discarded
createdTimestamp timestamp
updatedTimestamp timestamp
documents [PolicyDocumentResponse]
fieldValues map<string,[string]>
amount number
amountCurrency string
cashBalanceLocator string
mediaByLocator map<string,Media>

optional
issuedTimestamp timestamp

Update or issue a disbursement¶

PATCH /disbursements/{disbursementLocator}

Request:

Name	Position	Type	Required
disbursementLocator	path	string	required
request	body	DisbursementActionRequest	required

Response: DisbursementResponse

DisbursementActionRequest¶

optional
action string issue | discard
disbursementUpdate DisbursementUpdateRequest

Fetch a disbursement¶

GET /disbursements/{disbursementLocator}

Request:

Name	Position	Type	Required
disbursementLocator	path	string	required

Response: DisbursementResponse

Fetch disbursements¶

GET /disbursements

Request:

Name	Position	Type	Required
amount	query	string	optional
cashBalanceLocator	query	string	optional
pageSize	query	string	optional
pagingToken	query	string	optional
policyholderLocator	query	string	optional
policyLocator	query	string	optional

Response: DisbursementsPagedResponse

DisbursementsPagedResponse¶

required
disbursements [DisbursementResponse]

optional
pagingToken string

Catch-Up Invoices

Issue a catch-up¶

POST /cashBalances/{cashBalanceLocator}/invoices

Request:

Name	Position	Type	Required
cashBalanceLocator	path	string	required
catchUpInvoiceIssueRequest	body	CatchUpInvoiceIssueRequest	required

Response: CatchUpInvoiceResponse

CatchUpInvoiceIssueRequest¶

required
dueTimestamp timestamp
totalDue number

CatchUpInvoiceResponse¶

required
locator string
displayId string
policyLocator string
createdTimestamp timestamp
updatedTimestamp timestamp
dueTimestamp timestamp
documents [PolicyDocumentResponse]
totalDue number
invoiceType string
settlementStatus string outstanding | settled
statuses [PolicyInvoiceStatusAndTimeResponse]
totalDueCurrency string
transactionIssued boolean

optional
payment PaymentResponse
settlementType string paid | writtenOff | zeroDue | invalidated | carriedForward

Write off a catch-up¶

PATCH /catchUps/{catchupLocator}/writeOff

Request:

Name	Position	Type	Required
catchupLocator	path	string	required

Response: CatchUpInvoiceResponse

Invalidate a catch-up¶

PATCH /catchUps/{catchupLocator}/invalidate

Request:

Name	Position	Type	Required
catchupLocator	path	string	required

Response: CatchUpInvoiceResponse

Fetch a catch-up¶

GET /catchUps/{catchupLocator}

Request:

Name	Position	Type	Required
catchupLocator	path	string	required

Response: CatchUpInvoiceResponse

Fetch catch-ups¶

GET /catchUps

Request:

Name	Position	Type	Required
cashBalanceLocator	query	string	optional
pageSize	query	string	optional
pagingToken	query	string	optional
policyholderLocator	query	string	optional
policyLocator	query	string	optional
totalDue	query	string	optional

Response: CatchUpPagedResponse

CatchUpPagedResponse¶

required
catchUps [CatchUpInvoiceResponse]

optional
pagingToken string

Cash Balance Log

Fetch cash balance records¶

GET /cashBalanceLog/records

Request:

Name	Position	Type	Required
cashBalanceLocator	query	string	optional
endTimestamp	query	timestamp	optional
eventType	query	string	optional
pageSize	query	integer	optional
pagingToken	query	string	optional
startTimestamp	query	timestamp	optional

Response: CashBalanceLogsPagedResponse

Fetch attributed cash balance records¶

GET /cashBalanceLog/attributedRecords

Request:

Name	Position	Type	Required
cashBalanceLocator	query	string	optional
endTimestamp	query	timestamp	optional
eventType	query	string	optional
pageSize	query	integer	optional
pagingToken	query	string	optional
startTimestamp	query	timestamp	optional

Response: CashBalanceLogsPagedResponse

CashBalanceLogsPagedResponse¶

required
cashBalanceLogs [CashBalanceLogResponse]

optional
pagingToken string

CashBalanceLogResponse¶

required
id string
timestamp timestamp
data CashBalanceLogData
type string

optional
username string

CashBalanceLogData varies depending on the type of cash balance log entry.

Cash Balance Log Data

disbursementEntry

Event types: disbursement.issue

{
  // required
  delta: number
  newCashBalance: number
  disbursementLocator: string
  cashBalanceLocator: string
}

invoicePaymentEntry

Event types: payment.pay, payment.reverse, catchUp.pay, catchUp.pay.reverse

{
  // required
  delta: number
  newCashBalance: number
  invoiceAmount: number
  paymentAmount: number
  paymentLocator: string
  cashBalanceLocator: string
  invoiceLocator: string

  // optional
  name: string        /* included for reversals */
  details: string     /* included for reversals */
}

cashTransferEntry

Event types: cash.transfer

{
  // required
  amount: number
  sourceCashBalanceLocator: string
  newSourceCashBalance: number
  targetCashBalanceLocator: string
  newTargetCashBalance: number
}

catchUpWriteOffEntry

Event types: catchup.writtenOff

{
  // required
  delta: number
  cashBalanceLocator: string
  newCashBalance: number
  invoiceLocator: string
}