GET api/Office/Accounts/CalculateTopupRequirement/{companyId}

Request Information

URI Parameters

Name	Description	Type	Additional information
companyId	integer	integer	Required

Body Parameters

None.

Response Information

Resource Description

TopupRequirement

Name	Description	Type	Additional information
CurrentBalance	decimal number	decimal number	None.
PendingClaimsAmount	decimal number	decimal number	None.
AmountNeedToTopup	decimal number	decimal number	None.
TotalAmountNeedToTopup	decimal number	decimal number	None.
HasTopupWarning	boolean	boolean	None.
HasTopupAlert	boolean	boolean	None.
Tax	decimal number	decimal number	None.
AdminFees	decimal number	decimal number	None.

Response Formats

application/json, text/json

Sample:

{
  "CurrentBalance": 1.0,
  "PendingClaimsAmount": 2.0,
  "AmountNeedToTopup": 1.0,
  "TotalAmountNeedToTopup": 4.0,
  "HasTopupWarning": true,
  "HasTopupAlert": false,
  "Tax": 1.0,
  "AdminFees": 1.0
}

application/xml, text/xml

Sample:

<TopupRequirement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CC.Interfaces.Domain">
  <AdminFees>1</AdminFees>
  <CurrentBalance>1</CurrentBalance>
  <PendingClaimsAmount>2</PendingClaimsAmount>
  <Tax>1</Tax>
  <TotalAmountNeedToTopup>4</TotalAmountNeedToTopup>
</TopupRequirement>