Tax Withholding Settings

openapi: 3.0.3 info: title: Account Services APIs - Tax Withholding Settings version: v1 description: APIs for Account Services contact: name: Digital Core @ Jack Henry and Associates, inc. url: https://www.jackhenry.com/ email: DC-Operations@jackhenry.com servers: - url: https://{API_ENDPOINT} variables: API_ENDPOINT: default: digital.garden-fi.com security: - bearerAuth: [] tags: - name: Tax Withholding Settings description: V1 APIs for Tax Withholding Settings paths: /a/api/acct-svcs/v1/{InstitutionUniversalId}/tax-withholding-settings: get: operationId: TaxWithholdingSettingsGet tags: - Tax Withholding Settings summary: API to get tax withholding settings for an institution description: API to get tax withholding settings for an institution parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - federalTaxWithholdingRate - federalTaxWithholdingDesc - stateTaxWithholdingSettings properties: federalTaxWithholdingRate: type: number format: float64 description: This attribute defines the federal tax withholding rate. example: 12.34 nullable: false federalTaxWithholdingDesc: type: string example: Federal Tax Withholding Description description: This attribute defines the description of the federal tax withholding. stateTaxWithholdingSettings: type: array items: type: object required: - stateTaxWithholdingSettings properties: id: type: string format: uuid description: A unique identifier for the state tax withholding setting. nullable: false stateCode: type: string description: A two-character abbreviation for the state setting. enum: - AL - AK - AZ - AR - CA - CO - CT - DE - FL - GA - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - OH - OK - OR - PA - RI - SC - SD - TN - TX - UT - VT - VA - WA - WV - WI - WY example: NY stateTaxWithholdingRate: type: number format: float64 description: This attribute defines the state tax withholding rate. example: 12.34 nullable: false stateTaxWithholdingDesc: type: string example: NY State Tax Withholding Description description: This attribute defines the description of the state tax withholding. additionalProperties: false '400': description: The server could not process the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string fieldDetails: type: array description: An array of objects which provide additional details to specific fields in the request that caused the error. items: type: object properties: field: type: string description: The name or path of the field in the request that caused the error. detail: type: string description: A end-user readable message describing the error related to the field. data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: badRequest: summary: Bad request value: type: acct-svcs/bad-request title: Rule violation details: - exampleField is invalid or malformed. fieldDetails: - field: exampleField detail: Provide a valid value for this field. '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: acct-svcs/internal-server-error title: Unexpected error details: - An unexpected error occurred. Please contact your service provider and/or try again later. /a/api/acct-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/tax-withholding-settings: get: operationId: TaxWithholdingSettingsGetWithEnterpriseUserId tags: - Tax Withholding Settings summary: API to get tax withholding settings for an institution description: API to get tax withholding settings for an institution parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. responses: '200': description: Success content: application/json: schema: type: object required: - federalTaxWithholdingRate - federalTaxWithholdingDesc - stateTaxWithholdingSettings properties: federalTaxWithholdingRate: type: number format: float64 description: This attribute defines the federal tax withholding rate. example: 12.34 nullable: false federalTaxWithholdingDesc: type: string example: Federal Tax Withholding Description description: This attribute defines the description of the federal tax withholding. stateTaxWithholdingSettings: type: array items: type: object required: - stateTaxWithholdingSettings properties: id: type: string format: uuid description: A unique identifier for the state tax withholding setting. nullable: false stateCode: type: string description: A two-character abbreviation for the state setting. enum: - AL - AK - AZ - AR - CA - CO - CT - DE - FL - GA - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - OH - OK - OR - PA - RI - SC - SD - TN - TX - UT - VT - VA - WA - WV - WI - WY example: NY stateTaxWithholdingRate: type: number format: float64 description: This attribute defines the state tax withholding rate. example: 12.34 nullable: false stateTaxWithholdingDesc: type: string example: NY State Tax Withholding Description description: This attribute defines the description of the state tax withholding. additionalProperties: false '400': description: The server could not process the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string fieldDetails: type: array description: An array of objects which provide additional details to specific fields in the request that caused the error. items: type: object properties: field: type: string description: The name or path of the field in the request that caused the error. detail: type: string description: A end-user readable message describing the error related to the field. data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: badRequest: summary: Bad request value: type: acct-svcs/bad-request title: Rule violation details: - exampleField is invalid or malformed. fieldDetails: - field: exampleField detail: Provide a valid value for this field. '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: acct-svcs/internal-server-error title: Unexpected error details: - An unexpected error occurred. Please contact your service provider and/or try again later. /a/api/acct-svcs/v1/{InstitutionUniversalId}/tax-withholding-settings/federal: post: operationId: FederalTaxWithholdingSettingsCreate tags: - Tax Withholding Settings summary: API to create federal tax withholding settings description: API to create federal tax withholding settings parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: The federal tax withholding setting to be create content: application/json: schema: type: object required: - federalTaxWithholdingRate properties: federalTaxWithholdingRate: type: number format: float64 description: This attribute defines the federal tax withholding rate. example: 12.34 nullable: false federalTaxWithholdingDesc: type: string example: Federal Tax Withholding Description description: This attribute defines the description of the federal tax withholding. additionalProperties: false responses: '201': description: Success content: application/json: schema: type: object required: - id properties: id: type: string format: uuid description: A unique identifier for the tax withholding setting. nullable: false additionalProperties: false '400': description: The server could not process the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string fieldDetails: type: array description: An array of objects which provide additional details to specific fields in the request that caused the error. items: type: object properties: field: type: string description: The name or path of the field in the request that caused the error. detail: type: string description: A end-user readable message describing the error related to the field. data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: badRequest: summary: Bad request value: type: acct-svcs/bad-request title: Rule violation details: - exampleField is invalid or malformed. fieldDetails: - field: exampleField detail: Provide a valid value for this field. '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: acct-svcs/internal-server-error title: Unexpected error details: - An unexpected error occurred. Please contact your service provider and/or try again later. put: operationId: FederalTaxWithholdingSettingsUpdate tags: - Tax Withholding Settings summary: API to update the federal tax withholding settings description: API to update the federal tax withholding settings parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: The federal tax withholding setting to be updated content: application/json: schema: type: object required: - federalTaxWithholdingRate properties: federalTaxWithholdingRate: type: number format: float64 description: This attribute defines the federal tax withholding rate. example: 12.34 nullable: false federalTaxWithholdingDesc: type: string example: Federal Tax Withholding Description description: This attribute defines the description of the federal tax withholding. additionalProperties: false responses: '204': description: Success - No Content '400': description: The server could not process the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string fieldDetails: type: array description: An array of objects which provide additional details to specific fields in the request that caused the error. items: type: object properties: field: type: string description: The name or path of the field in the request that caused the error. detail: type: string description: A end-user readable message describing the error related to the field. data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: badRequest: summary: Bad request value: type: acct-svcs/bad-request title: Rule violation details: - exampleField is invalid or malformed. fieldDetails: - field: exampleField detail: Provide a valid value for this field. '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: acct-svcs/internal-server-error title: Unexpected error details: - An unexpected error occurred. Please contact your service provider and/or try again later. /a/api/acct-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/tax-withholding-settings/federal: post: operationId: FederalTaxWithholdingSettingsCreateWithEnterpriseUserId tags: - Tax Withholding Settings summary: API to create federal tax withholding settings description: API to create federal tax withholding settings parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. requestBody: description: The federal tax withholding setting to be create content: application/json: schema: type: object required: - federalTaxWithholdingRate properties: federalTaxWithholdingRate: type: number format: float64 description: This attribute defines the federal tax withholding rate. example: 12.34 nullable: false federalTaxWithholdingDesc: type: string example: Federal Tax Withholding Description description: This attribute defines the description of the federal tax withholding. additionalProperties: false responses: '201': description: Success content: application/json: schema: type: object required: - id properties: id: type: string format: uuid description: A unique identifier for the tax withholding setting. nullable: false additionalProperties: false '400': description: The server could not process the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string fieldDetails: type: array description: An array of objects which provide additional details to specific fields in the request that caused the error. items: type: object properties: field: type: string description: The name or path of the field in the request that caused the error. detail: type: string description: A end-user readable message describing the error related to the field. data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: badRequest: summary: Bad request value: type: acct-svcs/bad-request title: Rule violation details: - exampleField is invalid or malformed. fieldDetails: - field: exampleField detail: Provide a valid value for this field. '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: acct-svcs/internal-server-error title: Unexpected error details: - An unexpected error occurred. Please contact your service provider and/or try again later. put: operationId: FederalTaxWithholdingSettingsUpdateWithEnterpriseUserId tags: - Tax Withholding Settings summary: API to update the federal tax withholding settings description: API to update the federal tax withholding settings parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. requestBody: description: The federal tax withholding setting to be updated content: application/json: schema: type: object required: - federalTaxWithholdingRate properties: federalTaxWithholdingRate: type: number format: float64 description: This attribute defines the federal tax withholding rate. example: 12.34 nullable: false federalTaxWithholdingDesc: type: string example: Federal Tax Withholding Description description: This attribute defines the description of the federal tax withholding. additionalProperties: false responses: '204': description: Success '400': description: The server could not process the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string fieldDetails: type: array description: An array of objects which provide additional details to specific fields in the request that caused the error. items: type: object properties: field: type: string description: The name or path of the field in the request that caused the error. detail: type: string description: A end-user readable message describing the error related to the field. data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: badRequest: summary: Bad request value: type: acct-svcs/bad-request title: Rule violation details: - exampleField is invalid or malformed. fieldDetails: - field: exampleField detail: Provide a valid value for this field. '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: acct-svcs/internal-server-error title: Unexpected error details: - An unexpected error occurred. Please contact your service provider and/or try again later. /a/api/acct-svcs/v1/{InstitutionUniversalId}/tax-withholding-settings/state: post: operationId: StateTaxWithholdingSettingsCreate tags: - Tax Withholding Settings summary: API to create a state tax withholding settings description: API to create a state tax withholding settings parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: The state tax withholding setting to be create content: application/json: schema: type: object required: - stateCode - stateTaxWithholdingRate properties: stateCode: type: string description: A two-character abbreviation for the state setting. enum: - AL - AK - AZ - AR - CA - CO - CT - DE - FL - GA - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - OH - OK - OR - PA - RI - SC - SD - TN - TX - UT - VT - VA - WA - WV - WI - WY example: NY stateTaxWithholdingRate: type: number format: float64 description: This attribute defines the state tax withholding rate. example: 12.34 nullable: false stateTaxWithholdingDesc: type: string example: NY State Tax Withholding Description description: This attribute defines the description of the state tax withholding. additionalProperties: false responses: '201': description: Success - Created content: application/json: schema: type: object required: - id properties: id: type: string format: uuid description: A unique identifier for the tax withholding setting. nullable: false additionalProperties: false '400': description: The server could not process the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string fieldDetails: type: array description: An array of objects which provide additional details to specific fields in the request that caused the error. items: type: object properties: field: type: string description: The name or path of the field in the request that caused the error. detail: type: string description: A end-user readable message describing the error related to the field. data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: badRequest: summary: Bad request value: type: acct-svcs/bad-request title: Rule violation details: - exampleField is invalid or malformed. fieldDetails: - field: exampleField detail: Provide a valid value for this field. '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: acct-svcs/internal-server-error title: Unexpected error details: - An unexpected error occurred. Please contact your service provider and/or try again later. /a/api/acct-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/tax-withholding-settings/state: post: operationId: StateTaxWithholdingSettingsCreateWithEnterpriseUserId tags: - Tax Withholding Settings summary: API to create a state tax withholding settings description: API to create a state tax withholding settings parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. requestBody: description: The state tax withholding setting to be create content: application/json: schema: type: object required: - stateCode - stateTaxWithholdingRate properties: stateCode: type: string description: A two-character abbreviation for the state setting. enum: - AL - AK - AZ - AR - CA - CO - CT - DE - FL - GA - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - OH - OK - OR - PA - RI - SC - SD - TN - TX - UT - VT - VA - WA - WV - WI - WY example: NY stateTaxWithholdingRate: type: number format: float64 description: This attribute defines the state tax withholding rate. example: 12.34 nullable: false stateTaxWithholdingDesc: type: string example: NY State Tax Withholding Description description: This attribute defines the description of the state tax withholding. additionalProperties: false responses: '201': description: Success - Created content: application/json: schema: type: object required: - id properties: id: type: string format: uuid description: A unique identifier for the tax withholding setting. nullable: false additionalProperties: false '400': description: The server could not process the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string fieldDetails: type: array description: An array of objects which provide additional details to specific fields in the request that caused the error. items: type: object properties: field: type: string description: The name or path of the field in the request that caused the error. detail: type: string description: A end-user readable message describing the error related to the field. data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: badRequest: summary: Bad request value: type: acct-svcs/bad-request title: Rule violation details: - exampleField is invalid or malformed. fieldDetails: - field: exampleField detail: Provide a valid value for this field. '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: acct-svcs/internal-server-error title: Unexpected error details: - An unexpected error occurred. Please contact your service provider and/or try again later. /a/api/acct-svcs/v1/{InstitutionUniversalId}/tax-withholding-settings/state/{Id}: put: operationId: StateTaxWithholdingSettingsUpdate tags: - Tax Withholding Settings summary: API to update a state tax withholding settings description: API to update a state tax withholding settings parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: Id in: path description: A unique identifier for the tax withholding setting. required: true schema: type: string format: uuid requestBody: description: The state tax withholding setting to be update content: application/json: schema: type: object required: - stateTaxWithholdingRate properties: stateTaxWithholdingRate: type: number format: float64 description: This attribute defines the state tax withholding rate. example: 12.34 nullable: false stateTaxWithholdingDesc: type: string example: NY State Tax Withholding Description description: This attribute defines the description of the state tax withholding. additionalProperties: false responses: '204': description: Success - No Content '400': description: The server could not process the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string fieldDetails: type: array description: An array of objects which provide additional details to specific fields in the request that caused the error. items: type: object properties: field: type: string description: The name or path of the field in the request that caused the error. detail: type: string description: A end-user readable message describing the error related to the field. data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: badRequest: summary: Bad request value: type: acct-svcs/bad-request title: Rule violation details: - exampleField is invalid or malformed. fieldDetails: - field: exampleField detail: Provide a valid value for this field. '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: acct-svcs/internal-server-error title: Unexpected error details: - An unexpected error occurred. Please contact your service provider and/or try again later. /a/api/acct-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/tax-withholding-settings/state/{Id}: put: operationId: StateTaxWithholdingSettingsUpdateWithEnterpriseUserId tags: - Tax Withholding Settings summary: API to update a state tax withholding settings description: API to update a state tax withholding settings parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: Id in: path description: A unique identifier for the tax withholding setting. required: true schema: type: string format: uuid requestBody: description: The state tax withholding setting to be update content: application/json: schema: type: object required: - stateTaxWithholdingRate properties: stateTaxWithholdingRate: type: number format: float64 description: This attribute defines the state tax withholding rate. example: 12.34 nullable: false stateTaxWithholdingDesc: type: string example: NY State Tax Withholding Description description: This attribute defines the description of the state tax withholding. additionalProperties: false responses: '204': description: Success - No Content '400': description: The server could not process the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string fieldDetails: type: array description: An array of objects which provide additional details to specific fields in the request that caused the error. items: type: object properties: field: type: string description: The name or path of the field in the request that caused the error. detail: type: string description: A end-user readable message describing the error related to the field. data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: badRequest: summary: Bad request value: type: acct-svcs/bad-request title: Rule violation details: - exampleField is invalid or malformed. fieldDetails: - field: exampleField detail: Provide a valid value for this field. '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: acct-svcs/internal-server-error title: Unexpected error details: - An unexpected error occurred. Please contact your service provider and/or try again later.

Please ignore this field