Our API Components and Unique Identifiers
In order to effectively use our API to manage your tax filings, it’s important to get familiar with our API components and the unique identifiers we use.
Table of Contents:
API Components
Here are the API components of the Create Request JSON for each type of form/service.
1099 Forms:
SubmissionManifest
Contains the tax year and services to be opted for, including:
- Federal filing - Opt for this to e-file 1099 with the IRS.
- State filing - Opt for this to e-file 1099 with the states.
- Postal mailing - Opt for this to let us distribute the recipient copies via mail.
- Online access - Opt for this to share the recipient copies via a secure online portal.
- Schedule filing - Opt for this to schedule 1099 transmission to a particular date.
Return Header
Includes payer Information (referred to as Business) common for 1099, W-2, 94x, and ACA Forms. Multiple 1099s can be created for a single payer. Since the Business object is common, fields specific to other forms can be ignored for 1099 forms.
You can either provide complete payer information or use the BusinessId (generated by TaxBandits) if the business was created previously.
Return Data
An array that allows the creation of multiple 1099s by providing Recipient details and Form Data for each form. You can include a maximum of 250 forms in a request.
- Recipient Details - If you have already filed 1099 for the recipient using TaxBandits, you can use the RecipientId (generated by TaxBandits) instead of supplying the complete recipient data again.
- Form Data - Contains the following details.
- Federal Information - Includes the data required to be reported to the IRS.
- States Information - Includes the data required for the state-specific fields.
- StateReconData - Includes reconciliation form information if required by the corresponding state.
W-2 Forms:
SubmissionManifest
Contains the tax year and services to be opted for, including:
- Federal filing - Opt for this to e-file W-2 with the SSA.
- State filing - Opt for this to e-file 1099 with the states.
- Postal mailing - Opt for this to let us distribute the recipient copies via mail.
- Online access - Opt for this to share the recipient copies via a secure online portal.
- Schedule filing - Opt for this to schedule W-2 transmission to a particular date.
Return Header
Includes payer Information (referred to as Business) common for 1099, W-2, 94x, and ACA Forms. Multiple W-2 forms can be created for a single payer. Since the Business object is common, fields specific to other forms can be ignored for W-2 forms.
You can either provide complete payer information or use the BusinessId (generated by TaxBandits) if the business was created previously.
Return Data
An array that allows the creation of multiple W-2s by providing Employee details and Form Data for each W-2.
- Employee Details - If you have already filed a W-2 for the employee using TaxBandits, you can use the EmployeeId(generated by TaxBandits) instead of supplying the complete employee data again.
- Form Data - Contains the following details.
- Federal Information - Includes the data required to be reported to the SSA.
- States Information - Includes the data required for the state-specific fields.
- StateReconData - Includes reconciliation form information if required by the corresponding state.
94X Forms:
Form94xRecords
Includes the Return Header and Return Data.
Return Header
- Business Details - Includes business name, EIN, contact information, address, and business type. It also contains the signing authority's name and contact information. You can either provide complete business information or use the BusinessId (generated by TaxBandits) if the business was created previously.
- Return Type - Specifies the type of return, the tax year, and the quarter.
- Additional Information - Includes third-party designee information, signature details, and business status details (e.g., if the business is closed or transferred).
Return Data
- Form Data - Contains the required information for 94x form including employee count, taxes withheld, taxes due, etc. This information may vary for each type of 94x form.
WhCertificates:
-
RequestByEmail (Payer-Initiated) Method:
- SubmissionManifest - Indicates whether TIN Matching is requested.
- Requester - Contains the business ID and TIN (Tax Identification Number).
- Recipients - Lists recipients with their payee reference, name, and email.
- Webhook Reference - Provides a unique webhook reference for callback notifications.
- Customization (Applicable only to W-9 endpoint) - Includes the URL of the business logo to customize the email and the W-9 page.
- SubmissionManifest - Indicates whether TIN Matching is requested.
-
RequestByUrl (Payee-Initiated) Method:
- Requester - Indicates business details such as BusinessId, PayerRef, and TIN.
- Recipients - Lists recipients with their PayeeRef, name, and email.
- Customization - Includes customization preferences such as URL for the business logo, Interview flow, etc.
- RedirectUrls - Contains the URLs to which you want the recipients to be redirected once they complete/cancel the form submission.
- Requester - Indicates business details such as BusinessId, PayerRef, and TIN.
ACA Forms:
SubmissionManifest
Contains the tax year and services to be opted for, including:
- Federal filing
- State filing
- Postal mailing
- Online access
ACA Forms
Contains Return Header and Return Data
-
Return Header
- Business Details - Includes payer Information (referred to as Business) common for 1099, W-2, 94x, and ACA Forms. Multiple ACA 1095 forms can be created for a single business. Since the Business object is common, fields specific to other forms can be ignored for 1095 forms. You can either provide complete business information or use the BusinessId (generated by TaxBandits) if the business was created previously.
- Form 1094-C Data - Includes the details required for the transmittal form.
- Additional Information - Includes detailed information about the signing authority and designated government entity if applicable.
-
Return Data
An array that allows the creation of multiple 1095-Cs by providing employee details and return information for each Form 1095-C.
- EmployeeManifest - Contains Form1095CId (A unique id for each 1095-c form) and sequence number.
- Employee Details - If you have already filed a 1095-C for the employee using TaxBandits, you can use the EmployeeId (generated by TaxBandits) instead of supplying the complete employee data again.
- Employee Return Details- Provides necessary information for 1095-C forms.
Unique Identifiers
The following are the unique identifiers we use and their description.
Identifier Name | Description | Applicable to |
---|---|---|
SubmissionId |
|
|
RecordId |
|
|
RecipientId |
|
|
BusinessId |
|
|
PayeeRef |
|
|
PayerRef |
|
|
EmployeeId |
|
|