GET api/v1/{facilityId}/ledgers/{ledgerId}/account_balances/unpaid

Request Information

URI Parameters

Name	Description	Type	Additional information
facilityId		globally unique identifier	Required
ledgerId		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

AccountBalancesResponseModel

Name	Description	Type	Additional information
account_balances		Collection of AccountBalanceResponseDataModel	None.
meta		ApiResponseMeta	None.

Response Formats

application/json, text/json

Sample:

{
  "account_balances": [
    {
      "id": "faa49b31-24c8-46af-abad-f4777c11b912",
      "description": "sample string 2",
      "resolved": true,
      "amount": 4.0,
      "tax_amount": 1.0,
      "amount_leftover": 1.0,
      "effective_on": "2026-08-27T11:05:35.042+00:00",
      "service_start_date": "sample string 6",
      "service_end_date": "sample string 7",
      "accountable_id": "2e871952-3d61-4a95-9098-9eb116b45621"
    },
    {
      "id": "faa49b31-24c8-46af-abad-f4777c11b912",
      "description": "sample string 2",
      "resolved": true,
      "amount": 4.0,
      "tax_amount": 1.0,
      "amount_leftover": 1.0,
      "effective_on": "2026-08-27T11:05:35.042+00:00",
      "service_start_date": "sample string 6",
      "service_end_date": "sample string 7",
      "accountable_id": "2e871952-3d61-4a95-9098-9eb116b45621"
    }
  ],
  "meta": {
    "message": "sample string 1",
    "status_code": 2,
    "request_id": "f79675a3-b257-409a-8806-96504b362f77",
    "error_code": 1,
    "status_message": "sample string 3",
    "status_cat": "http://httpcats.herokuapp.com/2",
    "request_method": "sample string 4",
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 1,
      "total_entries": 1,
      "previous_page": 1,
      "next_page": 1
    },
    "parameters": {}
  }
}

application/xml, text/xml

Sample:

<AccountBalancesResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.AccountBalances">
  <Meta xmlns="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.ApiResponseBase">
    <ErrorCode>1</ErrorCode>
    <HttpStatusCode>2</HttpStatusCode>
    <HttpStatusMessage>sample string 3</HttpStatusMessage>
    <Message>sample string 1</Message>
    <PaginationData>
      <CurrentPage>1</CurrentPage>
      <NextPage>1</NextPage>
      <PerPage>1</PerPage>
      <PreviousPage>1</PreviousPage>
      <TotalEntries>1</TotalEntries>
      <TotalPages>1</TotalPages>
    </PaginationData>
    <Parameters xmlns:d3p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.ApiResponseBase.ParameterClasses" />
    <RequestId>f79675a3-b257-409a-8806-96504b362f77</RequestId>
    <RequestMethod>sample string 4</RequestMethod>
  </Meta>
  <AccountBalances>
    <AccountBalanceResponseDataModel>
      <AccountableId>2e871952-3d61-4a95-9098-9eb116b45621</AccountableId>
      <Amount>4</Amount>
      <AmountLeftover>1</AmountLeftover>
      <Description>sample string 2</Description>
      <EffectiveOn xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2026-08-27T11:05:35.0420248Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </EffectiveOn>
      <Id>faa49b31-24c8-46af-abad-f4777c11b912</Id>
      <Resolved>true</Resolved>
      <ServiceEndDate>sample string 7</ServiceEndDate>
      <ServiceStartDate>sample string 6</ServiceStartDate>
      <TaxAmount>1</TaxAmount>
    </AccountBalanceResponseDataModel>
    <AccountBalanceResponseDataModel>
      <AccountableId>2e871952-3d61-4a95-9098-9eb116b45621</AccountableId>
      <Amount>4</Amount>
      <AmountLeftover>1</AmountLeftover>
      <Description>sample string 2</Description>
      <EffectiveOn xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2026-08-27T11:05:35.0420248Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </EffectiveOn>
      <Id>faa49b31-24c8-46af-abad-f4777c11b912</Id>
      <Resolved>true</Resolved>
      <ServiceEndDate>sample string 7</ServiceEndDate>
      <ServiceStartDate>sample string 6</ServiceStartDate>
      <TaxAmount>1</TaxAmount>
    </AccountBalanceResponseDataModel>
  </AccountBalances>
</AccountBalancesResponseModel>