Previous Next JavaScript must be enabled to correctly display this content

## Get list of withholdings for a specific policy by policy Id

get

/PASService/rest/services/v1/policies/{policyId}/withholdings

Gets a list of the latest withholdings for a policy based on the specified policy Id

### Request

Path Parameters

- policyId(required): string(guid)
  Policy Id

Query Parameters

- expand: string
  codes, all
- q: string
  Search parameter

There's no request body for this operation.

Back to Top

### Response

Supported Media Types

- application/json

#### 200 Response

successful operation
Back to Top

### Examples

This example describes how to get withholdings for a policy based on the specified policy Id.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

    curl \
        -X GET \
        -H "Content-Type: application/json" \
        -u 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
        -L "http://server:port/PASService/rest/services/v1/policies/5F53C523-F201-4CEF-A376-DBA24BC7DC1A/withholdings"

Example Response Body

The following shows an example of the response body in JSON format:

    {
        "withholdings": [
        {
          "links": [
            {
            "href": "http://server:port/PASService/rest/services/policies/5F53C523-F201-4CEF-A376-DBA24BC7DC1A/withholdings/E721D943-8DA7-4FC1-86B1-9D219A8896B9",
            "rel": "self",
            "mediaType": "application/json",
            "method": "GET"
          },
            {
              "href": "http://localhost:8081/PASService/rest/services/codes?codeName=typeCode&codeValue=03",
              "rel": "codes/withholdingType",
              "mediaType": "application/json",
              "method": "GET"
            }
          ],
          "withholdingId": "E721D943-8DA7-4FC1-86B1-9D219A8896B9",
          "typeCode": "03",
          "policyId": "007C2C66-6E6D-4504-857E-001D0DA509AE",

            "StateForm": {
              "textValue": "01",
              "optionText": "Yes"
            },
              "comboField": {
              "textValue": "01",
              "optionText": "Savings"
            },
            "TaxIDSource": {
              "textValue": "01",
              "optionText": "Application"
            },
            "letterSendDate": "2001-01-01T00:00:00Z",
            "federalPercent": "10",
            "federalAmount": "1000",
            "currencyCode":"USD",
            "stateAmount": "1000",
            "statePercent": "10"
          }
      ]
    }

Back to Top