Deductions - Child Support

Encompass.Api (1.0)

Download OpenAPI description
sandbox.json
sandbox.yaml
Languages
Servers
Mock server
https://docs.encompassfi.com/_mock/reference/sandbox/

Benefits - Company

Operations

Benefits - Employee

Operations

Companies

Operations

Contractors

Operations

Deductions - Child Support

Operations

Create Child Support Deduction

Request

Path
companyIdstringrequired
Bodyapplication/jsonrequired
employeeIdstring
descriptionstring or null
externalIdstring or null
fipsCodestring or null
effectiveStartstring(date)
effectiveEndstring or null(date)
issuingStatestring(USState)
Enum"AL""AK""AR""AZ""CA""CO""CT""DC""DE""FL"
issueDatestring(date)
amountnumber(double)
maxPercentnumber or null(double)
isManagedboolean
curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/post_tax_deductions/child_support' \
  -H 'Content-Type: application/json' \
  -d '{
    "employeeId": "string",
    "description": "string",
    "externalId": "string",
    "fipsCode": "string",
    "effectiveStart": "2019-08-24",
    "effectiveEnd": "2019-08-24",
    "issuingState": "AL",
    "issueDate": "2019-08-24",
    "amount": 0.1,
    "maxPercent": 0.1,
    "isManaged": true
  }'

Responses

OK

Bodyapplication/json
idstring
employeeIdstring
sourcestring or null
descriptionstring or null
effectiveStartstring(date)
effectiveEndstring or null(date)
externalIdstring or null
fipsCodestring or null
issuingStatestring(USState)
Enum"AL""AK""AR""AZ""CA""CO""CT""DC""DE""FL"
issueDatestring(date)
amountnumber(double)
maxPercentnumber or null(double)
isManagedboolean
isExternalboolean
Response
application/json
{
  "id": "string",
  "employeeId": "string",
  "source": "string",
  "description": "string",
  "effectiveStart": "2019-08-24",
  "effectiveEnd": "2019-08-24",
  "externalId": "string",
  "fipsCode": "string",
  "issuingState": "AL",
  "issueDate": "2019-08-24",
  "amount": 0.1,
  "maxPercent": 0.1,
  "isManaged": true,
  "isExternal": true
}

Query Child Support Deductions

Request

Path
companyIdstringrequired
Query
idArray of stringsrequired
employeeIdstring
descriptionstring
effectivestring(date)
amountAbovenumber(double)
amountBelownumber(double)
pageinteger(int32)
Default 1
pageSizeinteger(int32)
Default 10
curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/post_tax_deductions/child_support?amountAbove=0.1&amountBelow=0.1&description=string&effective=2019-08-24&employeeId=string&id=string&page=1&pageSize=10'

Responses

OK

Bodyapplication/json
hasResourcesboolean
totalResourcesinteger(int32)
totalPagesinteger(int32)
pageSizeinteger(int32)
currentPageinteger or null(int32)
previousPageinteger or null(int32)
nextPageinteger or null(int32)
resultsArray of objects or null(ChildSupportDeduction)
Response
application/json
{
  "hasResources": true,
  "totalResources": 0,
  "totalPages": 0,
  "pageSize": 0,
  "currentPage": 0,
  "previousPage": 0,
  "nextPage": 0,
  "results": [
    { … }
  ]
}

Get Child Support Deduction

Request

Path
companyIdstringrequired
deductionIdstringrequired
curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/post_tax_deductions/child_support/{deductionId}'

Responses

OK

Bodyapplication/json
idstring
employeeIdstring
sourcestring or null
descriptionstring or null
effectiveStartstring(date)
effectiveEndstring or null(date)
externalIdstring or null
fipsCodestring or null
issuingStatestring(USState)
Enum"AL""AK""AR""AZ""CA""CO""CT""DC""DE""FL"
issueDatestring(date)
amountnumber(double)
maxPercentnumber or null(double)
isManagedboolean
isExternalboolean
Response
application/json
{
  "id": "string",
  "employeeId": "string",
  "source": "string",
  "description": "string",
  "effectiveStart": "2019-08-24",
  "effectiveEnd": "2019-08-24",
  "externalId": "string",
  "fipsCode": "string",
  "issuingState": "AL",
  "issueDate": "2019-08-24",
  "amount": 0.1,
  "maxPercent": 0.1,
  "isManaged": true,
  "isExternal": true
}

Update Child Support Deduction

Request

Path
companyIdstringrequired
deductionIdstringrequired
Bodyapplication/jsonrequired
descriptionstring
effectiveStartstring(date)
effectiveEndstring(date)
externalIdstring
fipsCodestring
issuingStatestring
issueDatestring(date)
amountnumber(double)
maxPercentnumber(double)
isManagedboolean
curl -i -X PATCH \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/post_tax_deductions/child_support/{deductionId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "string",
    "effectiveStart": "2019-08-24",
    "effectiveEnd": "2019-08-24",
    "externalId": "string",
    "fipsCode": "string",
    "issuingState": "string",
    "issueDate": "2019-08-24",
    "amount": 0.1,
    "maxPercent": 0.1,
    "isManaged": true
  }'

Responses

OK

Bodyapplication/json
idstring
employeeIdstring
sourcestring or null
descriptionstring or null
effectiveStartstring(date)
effectiveEndstring or null(date)
externalIdstring or null
fipsCodestring or null
issuingStatestring(USState)
Enum"AL""AK""AR""AZ""CA""CO""CT""DC""DE""FL"
issueDatestring(date)
amountnumber(double)
maxPercentnumber or null(double)
isManagedboolean
isExternalboolean
Response
application/json
{
  "id": "string",
  "employeeId": "string",
  "source": "string",
  "description": "string",
  "effectiveStart": "2019-08-24",
  "effectiveEnd": "2019-08-24",
  "externalId": "string",
  "fipsCode": "string",
  "issuingState": "AL",
  "issueDate": "2019-08-24",
  "amount": 0.1,
  "maxPercent": 0.1,
  "isManaged": true,
  "isExternal": true
}

Delete Child Support Deduction

Request

Path
companyIdstringrequired
deductionIdstringrequired
curl -i -X DELETE \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/post_tax_deductions/child_support/{deductionId}'

Responses

OK

Deductions - Miscellaneous

Operations

Departments

Operations

Documents

Operations

Earning Codes

Operations

Employees

Operations

Partner Portfolio

Operations

Payment Schedules

Operations

Payrolls

Operations

Workplaces

Operations