GET api/bfg/v1/invoices/balance?clientId={clientId}

Returns the Services account balance for a client (<c>SH_GetAccountsForObject</c>), used as the invoice balance.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

Numeric Paris client identifier.

integer

Required

Body Parameters

None.

Response Information

Resource Description

Services account balance.

GetInvoiceBalanceResponse
NameDescriptionTypeAdditional information
Balance

decimal number

None.

Response Formats

application/json, text/json

Sample:
{
  "Balance": 1.0
}

application/xml, text/xml

Sample:
<GetInvoiceBalanceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Invoice">
  <Balance>1</Balance>
</GetInvoiceBalanceResponse>