GET api/v1/{facilityId}/ledgers/{ledgerId}/prepay_amount_for/{paymentPeriod}

Request Information

URI Parameters

Name	Type	Additional information
facilityId	globally unique identifier	Required
ledgerId	globally unique identifier	Required
paymentPeriod	integer	Required

Body Parameters

None.

Response Information

Resource Description

PrePayAmountResponseModel

Name	Description	Type	Additional information
amount		decimal number	None.
meta		ApiResponseMeta	None.

Response Formats

application/json, text/json

Sample:

{
  "amount": 1.0,
  "meta": {
    "message": "sample string 1",
    "status_code": 2,
    "request_id": "bc2bdf50-d177-426f-aebb-efc3777d67fc",
    "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:

<PrePayAmountResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.Payments.ShieldApiResponseBaseChildren">
  <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>bc2bdf50-d177-426f-aebb-efc3777d67fc</RequestId>
    <RequestMethod>sample string 4</RequestMethod>
  </Meta>
  <Amount>1</Amount>
</PrePayAmountResponseModel>