GET api/v1/{facilityId}/invoiceable_items/insurance

Request Information

URI Parameters

Name	Description	Type	Additional information
facilityId		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

InvoiceableItemsResponseModel

Name	Description	Type	Additional information
invoiceable_items		Collection of InvoiceableItemsDataModel	None.
meta		ApiResponseMeta	None.

Response Formats

application/json, text/json

Sample:

{
  "invoiceable_items": [
    {
      "id": "fb4381f0-9789-4319-8685-2d0449d7d804",
      "product_code": "sample string 2",
      "kind": "sample string 3",
      "description": "sample string 4",
      "required_at_move_in": true,
      "required_at_transfer": true,
      "amount": 1.0,
      "short_description": "sample string 7",
      "show_in_sales_center": true,
      "tax_total": 1.0,
      "total": 1.0,
      "coverage_amount": 1.0,
      "coverage_percentage": 1.0,
      "provider_name": "sample string 9",
      "provider_key": "sample string 10",
      "invoiceable_amounts": [
        {
          "id": "70179475-7ee3-4afb-9d57-4473e8fb25f5",
          "amount": 1.0,
          "kind": "sample string 2",
          "limit": "sample string 3"
        },
        {
          "id": "70179475-7ee3-4afb-9d57-4473e8fb25f5",
          "amount": 1.0,
          "kind": "sample string 2",
          "limit": "sample string 3"
        }
      ]
    },
    {
      "id": "fb4381f0-9789-4319-8685-2d0449d7d804",
      "product_code": "sample string 2",
      "kind": "sample string 3",
      "description": "sample string 4",
      "required_at_move_in": true,
      "required_at_transfer": true,
      "amount": 1.0,
      "short_description": "sample string 7",
      "show_in_sales_center": true,
      "tax_total": 1.0,
      "total": 1.0,
      "coverage_amount": 1.0,
      "coverage_percentage": 1.0,
      "provider_name": "sample string 9",
      "provider_key": "sample string 10",
      "invoiceable_amounts": [
        {
          "id": "70179475-7ee3-4afb-9d57-4473e8fb25f5",
          "amount": 1.0,
          "kind": "sample string 2",
          "limit": "sample string 3"
        },
        {
          "id": "70179475-7ee3-4afb-9d57-4473e8fb25f5",
          "amount": 1.0,
          "kind": "sample string 2",
          "limit": "sample string 3"
        }
      ]
    }
  ],
  "meta": {
    "message": "sample string 1",
    "status_code": 2,
    "request_id": "7fed9e57-eb66-4837-97e3-b86736d2e4b6",
    "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:

<InvoiceableItemsResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.InvoiceableItems">
  <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>7fed9e57-eb66-4837-97e3-b86736d2e4b6</RequestId>
    <RequestMethod>sample string 4</RequestMethod>
  </Meta>
  <InvoiceableItems>
    <InvoiceableItemsDataModel>
      <Amount>1</Amount>
      <CoverageAmount>1</CoverageAmount>
      <CoveragePercentage>1</CoveragePercentage>
      <Description>sample string 4</Description>
      <InvoiceableAmounts>
        <InvoiceableAmounts>
          <Amount>1</Amount>
          <InvoiceableItemId>70179475-7ee3-4afb-9d57-4473e8fb25f5</InvoiceableItemId>
          <Kind>sample string 2</Kind>
          <Limit>sample string 3</Limit>
        </InvoiceableAmounts>
        <InvoiceableAmounts>
          <Amount>1</Amount>
          <InvoiceableItemId>70179475-7ee3-4afb-9d57-4473e8fb25f5</InvoiceableItemId>
          <Kind>sample string 2</Kind>
          <Limit>sample string 3</Limit>
        </InvoiceableAmounts>
      </InvoiceableAmounts>
      <InvoiceableItemId>fb4381f0-9789-4319-8685-2d0449d7d804</InvoiceableItemId>
      <Kind>sample string 3</Kind>
      <ProductCode>sample string 2</ProductCode>
      <ProviderKey>sample string 10</ProviderKey>
      <ProviderName>sample string 9</ProviderName>
      <RequiredAtMoveIn>true</RequiredAtMoveIn>
      <RequiredAtTransfer>true</RequiredAtTransfer>
      <ShortDescription>sample string 7</ShortDescription>
      <ShowInSalesCenter>true</ShowInSalesCenter>
      <TaxTotal>1</TaxTotal>
      <Total>1</Total>
    </InvoiceableItemsDataModel>
    <InvoiceableItemsDataModel>
      <Amount>1</Amount>
      <CoverageAmount>1</CoverageAmount>
      <CoveragePercentage>1</CoveragePercentage>
      <Description>sample string 4</Description>
      <InvoiceableAmounts>
        <InvoiceableAmounts>
          <Amount>1</Amount>
          <InvoiceableItemId>70179475-7ee3-4afb-9d57-4473e8fb25f5</InvoiceableItemId>
          <Kind>sample string 2</Kind>
          <Limit>sample string 3</Limit>
        </InvoiceableAmounts>
        <InvoiceableAmounts>
          <Amount>1</Amount>
          <InvoiceableItemId>70179475-7ee3-4afb-9d57-4473e8fb25f5</InvoiceableItemId>
          <Kind>sample string 2</Kind>
          <Limit>sample string 3</Limit>
        </InvoiceableAmounts>
      </InvoiceableAmounts>
      <InvoiceableItemId>fb4381f0-9789-4319-8685-2d0449d7d804</InvoiceableItemId>
      <Kind>sample string 3</Kind>
      <ProductCode>sample string 2</ProductCode>
      <ProviderKey>sample string 10</ProviderKey>
      <ProviderName>sample string 9</ProviderName>
      <RequiredAtMoveIn>true</RequiredAtMoveIn>
      <RequiredAtTransfer>true</RequiredAtTransfer>
      <ShortDescription>sample string 7</ShortDescription>
      <ShowInSalesCenter>true</ShowInSalesCenter>
      <TaxTotal>1</TaxTotal>
      <Total>1</Total>
    </InvoiceableItemsDataModel>
  </InvoiceableItems>
</InvoiceableItemsResponseModel>