Check taxability of benefit contributions
curl --request POST \
--url https://ste.symmetry.com/ste-hosted/v1/benefitStatus \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"BenefitStatusRequest": {
"payDate": "<string>",
"taxIDSearchString": "<string>",
"nonActiveTaxes": true
}
}
'import requests
url = "https://ste.symmetry.com/ste-hosted/v1/benefitStatus"
payload = { "BenefitStatusRequest": {
"payDate": "<string>",
"taxIDSearchString": "<string>",
"nonActiveTaxes": True
} }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
BenefitStatusRequest: {payDate: '<string>', taxIDSearchString: '<string>', nonActiveTaxes: true}
})
};
fetch('https://ste.symmetry.com/ste-hosted/v1/benefitStatus', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://ste.symmetry.com/ste-hosted/v1/benefitStatus",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'BenefitStatusRequest' => [
'payDate' => '<string>',
'taxIDSearchString' => '<string>',
'nonActiveTaxes' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://ste.symmetry.com/ste-hosted/v1/benefitStatus"
payload := strings.NewReader("{\n \"BenefitStatusRequest\": {\n \"payDate\": \"<string>\",\n \"taxIDSearchString\": \"<string>\",\n \"nonActiveTaxes\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://ste.symmetry.com/ste-hosted/v1/benefitStatus")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"BenefitStatusRequest\": {\n \"payDate\": \"<string>\",\n \"taxIDSearchString\": \"<string>\",\n \"nonActiveTaxes\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://ste.symmetry.com/ste-hosted/v1/benefitStatus")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"BenefitStatusRequest\": {\n \"payDate\": \"<string>\",\n \"taxIDSearchString\": \"<string>\",\n \"nonActiveTaxes\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"errorStatus": {
"errorCode": 123,
"errorMessage": "<string>"
},
"transactionStamp": {
"calcDateTime": "<string>",
"failedTransactions": 123,
"schemaVersion": "<string>",
"steVersion": "<string>",
"totalTransactions": 123
},
"benefitItem": [
{
"is125EmployerContribution": true,
"is125Pretax": true,
"is401KEmployerContribution": true,
"is401KPretax": true,
"is403BEmployerContribution": true,
"is403BPretax": true,
"is457EmployerContribution": true,
"is457Pretax": true,
"isFSADCEmployerContribution": true,
"isFSADCPretax": true,
"isFSAEmployerContribution": true,
"isFSAPretax": true,
"isHSAEmployerContribution": true,
"isHSAPretax": true,
"isRoth401KEmployerContribution": true,
"isRoth401KPretax": true,
"isRoth403BEmployerContribution": true,
"isRoth403BPretax": true,
"isRoth457EmployerContribution": true,
"isRoth457Pretax": true,
"isSimpleIRAEmployerContribution": true,
"isSimpleIRAPretax": true,
"isRothSimpleIRAEmployerContribution": true,
"isRothSimpleIRAPretax": true,
"isRothSimpleIRANonelectiveEmployerContribution": true,
"isRothSimpleIRANonelectivePretax": true,
"isStarter401KPretax": true,
"isStarter401KEmployerContribution": true,
"isRothStarter401KPretax": true,
"isRothStarter401KEmployerContribution": true,
"isSimpleIRANonelectivePretax": true,
"isSimpleIRANonelectiveEmployerContribution": true,
"isEHTCashBenefitPretax": true,
"isEHTCashBenefitEmployerContribution": true,
"isHSFCashBenefitQuebecPretax": true,
"isHSFCashBenefitQuebecEmployerContribution": true,
"isEHTNonCashBenefitPretax": true,
"isEHTNonCashBenefitEmployerContribution": true,
"isHSFNonCashBenefitQuebecPretax": true,
"isHSFNonCashBenefitQuebecEmployerContribution": true,
"isEHTEarningsPretax": true,
"isEHTEarningsEmployerContribution": true,
"isHSFEarningsQuebecPretax": true,
"isHSFEarningsQuebecEmployerContribution": true,
"isEHTPayInLieuPretax": true,
"isEHTPayInLieuEmployerContribution": true,
"isDependentCustodialAccountPretax": true,
"isDependentCustodialAccountEmployerContribution": true,
"isEducationalAssistancePretax": true,
"isEducationalAssistanceEmployerContribution": true,
"isEducationalAssistanceLoanRepaymentPretax": true,
"isEducationalAssistanceLoanRepaymentEmployerContribution": true,
"uniqueTaxID": "<string>"
}
]
}Check taxability of benefit contributions
Retrieve the taxability status of different benefit contributions by employees and employers. This is purely informational and is not required to run before computing payroll calculations.
POST
/
v1
/
benefitStatus
Check taxability of benefit contributions
curl --request POST \
--url https://ste.symmetry.com/ste-hosted/v1/benefitStatus \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"BenefitStatusRequest": {
"payDate": "<string>",
"taxIDSearchString": "<string>",
"nonActiveTaxes": true
}
}
'import requests
url = "https://ste.symmetry.com/ste-hosted/v1/benefitStatus"
payload = { "BenefitStatusRequest": {
"payDate": "<string>",
"taxIDSearchString": "<string>",
"nonActiveTaxes": True
} }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
BenefitStatusRequest: {payDate: '<string>', taxIDSearchString: '<string>', nonActiveTaxes: true}
})
};
fetch('https://ste.symmetry.com/ste-hosted/v1/benefitStatus', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://ste.symmetry.com/ste-hosted/v1/benefitStatus",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'BenefitStatusRequest' => [
'payDate' => '<string>',
'taxIDSearchString' => '<string>',
'nonActiveTaxes' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://ste.symmetry.com/ste-hosted/v1/benefitStatus"
payload := strings.NewReader("{\n \"BenefitStatusRequest\": {\n \"payDate\": \"<string>\",\n \"taxIDSearchString\": \"<string>\",\n \"nonActiveTaxes\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://ste.symmetry.com/ste-hosted/v1/benefitStatus")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"BenefitStatusRequest\": {\n \"payDate\": \"<string>\",\n \"taxIDSearchString\": \"<string>\",\n \"nonActiveTaxes\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://ste.symmetry.com/ste-hosted/v1/benefitStatus")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"BenefitStatusRequest\": {\n \"payDate\": \"<string>\",\n \"taxIDSearchString\": \"<string>\",\n \"nonActiveTaxes\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"errorStatus": {
"errorCode": 123,
"errorMessage": "<string>"
},
"transactionStamp": {
"calcDateTime": "<string>",
"failedTransactions": 123,
"schemaVersion": "<string>",
"steVersion": "<string>",
"totalTransactions": 123
},
"benefitItem": [
{
"is125EmployerContribution": true,
"is125Pretax": true,
"is401KEmployerContribution": true,
"is401KPretax": true,
"is403BEmployerContribution": true,
"is403BPretax": true,
"is457EmployerContribution": true,
"is457Pretax": true,
"isFSADCEmployerContribution": true,
"isFSADCPretax": true,
"isFSAEmployerContribution": true,
"isFSAPretax": true,
"isHSAEmployerContribution": true,
"isHSAPretax": true,
"isRoth401KEmployerContribution": true,
"isRoth401KPretax": true,
"isRoth403BEmployerContribution": true,
"isRoth403BPretax": true,
"isRoth457EmployerContribution": true,
"isRoth457Pretax": true,
"isSimpleIRAEmployerContribution": true,
"isSimpleIRAPretax": true,
"isRothSimpleIRAEmployerContribution": true,
"isRothSimpleIRAPretax": true,
"isRothSimpleIRANonelectiveEmployerContribution": true,
"isRothSimpleIRANonelectivePretax": true,
"isStarter401KPretax": true,
"isStarter401KEmployerContribution": true,
"isRothStarter401KPretax": true,
"isRothStarter401KEmployerContribution": true,
"isSimpleIRANonelectivePretax": true,
"isSimpleIRANonelectiveEmployerContribution": true,
"isEHTCashBenefitPretax": true,
"isEHTCashBenefitEmployerContribution": true,
"isHSFCashBenefitQuebecPretax": true,
"isHSFCashBenefitQuebecEmployerContribution": true,
"isEHTNonCashBenefitPretax": true,
"isEHTNonCashBenefitEmployerContribution": true,
"isHSFNonCashBenefitQuebecPretax": true,
"isHSFNonCashBenefitQuebecEmployerContribution": true,
"isEHTEarningsPretax": true,
"isEHTEarningsEmployerContribution": true,
"isHSFEarningsQuebecPretax": true,
"isHSFEarningsQuebecEmployerContribution": true,
"isEHTPayInLieuPretax": true,
"isEHTPayInLieuEmployerContribution": true,
"isDependentCustodialAccountPretax": true,
"isDependentCustodialAccountEmployerContribution": true,
"isEducationalAssistancePretax": true,
"isEducationalAssistanceEmployerContribution": true,
"isEducationalAssistanceLoanRepaymentPretax": true,
"isEducationalAssistanceLoanRepaymentEmployerContribution": true,
"uniqueTaxID": "<string>"
}
]
}Authorizations
API key for authentication. Provide the raw key as the value of the Authorization header (no "Bearer" prefix).
Body
application/jsonapplication/xml
Show child attributes
Show child attributes
⌘I

