This guide describes how to manage instances using the API.
The request is sent via the HTTP POST method:
Bash
curl -X 'POST' \
'https://api-aggregator.k1x.io/api/instance' \
-H 'accept: text/plain' \
-H 'Content-Type: application/json' \
-H 'X-K1X-Account: <ACCOUNT>' \
-H 'X-K1X-Token: <TOKEN>' \
-d '[
{
"name": "<InstanceName>",
"clientId": "<ClientID>",
"identifyingNumber": "<IdentifyingNumber>",
"incomeType": "<IncomeTypeEnumValue>",
"taxYear": <TaxYear>,
"entityType": "<EntityType>",
"yearSequence": <YearSequence>,
"taxFormType": "<TaxFormType>",
"stateOfResidence": "<State>"
}
]'
Header Name Type Description X-K1X-AccountString Required. Your account identifier. X-K1X-TokenString Required. Authorization token. Content-TypeString Should be application/json.
The request body must contain a list of instance objects, with each object structured as shown below:
Field Type Required Description nameString Yes The name of the instance. Maximum 250 characters. clientIdString Yes Client ID associated with the instance. Maximum 250 characters. identifyingNumberString Yes A unique identifying number for the instance. Maximum 20 characters. incomeTypeEnum Yes Type of income. See Income Type for possible values. taxYearInteger Yes The tax year. Must be greater than or equal to 2018. entityTypeEnum Yes The entity type. See Entity Type for possible values. yearSequenceInteger Conditional Required when the entityType is Trust. taxFormTypeEnum Yes The tax form type. See Tax Form Type for possible values. stateOfResidenceEnum Conditional Required when taxFormType is Form1040. State of residence. See State of Residence for possible values.
The response is a list of json objects, structured as follows:
Type Description idInt Unique identifier of the instance. nameString Name of the instance.
Value Description UsPartnershipU.S. Partnership UsCorporationU.S. Corporation ForeignPartnershipForeign Partnership ForeignCorporationForeign Corporation ScorpS-Corp PrivateCompanyWholly Owned TrustTrust SmllcSMLLC IndividualIndividual
Value Description TaxableIncomeTaxable Income UbiUBI BothTaxableIncomeAndUbiBoth Taxable Income and UBI
Value Description Form10401040 Form10411041 Form11201120 Form1120S1120S Form10651065 UBI990TPFUBI 990-T/PF UBI990TUBI 990-T UBI990PFUBI 990-PF
Value Description AlAlabama AkAlaska AzArizona ArArkansas CaCalifornia CoColorado CtConnecticut DeDelaware FlFlorida GaGeorgia HiHawaii IdIdaho IlIllinois InIndiana IaIowa KsKansas KyKentucky LaLouisiana MeMaine MdMaryland MaMassachusetts MiMichigan MnMinnesota MsMississippi MoMissouri MtMontana NeNebraska NvNevada NhNew Hampshire NjNew Jersey NmNew Mexico NyNew York NycNew York City NcNorth Carolina NdNorth Dakota OhOhio OkOklahoma OrOregon PaPennsylvania RiRhode Island ScSouth Carolina SdSouth Dakota TnTennessee TxTexas UtUtah VtVermont VaVirginia WaWashington DcWashington D.C. WvWest Virginia WiWisconsin WyWyoming NoneNo State ForeignForeign
The following validation rules are applied to the request body:
Name : Required, maximum length 250 characters.ClientId : Required, maximum length 250 characters.IncomeType : Required, must be a valid enum value.EntityType : Required, must be a valid enum value.TaxFormType : Required, must be a valid enum value.IdentifyingNumber : Required, maximum length 20 characters.TaxYear : Required, must be greater than 2017.YearSequence : Required if entityType is Trust.StateOfResidence : Required when taxFormType is Form1040.
This API retrieves a list of instances based on the specified parameters, such as taxYear. The response is a list of InstanceViewModel objects.
The request is sent via the HTTP GET method:
curl -X 'GET' \
'https://api-aggregator.k1x.io/api/instance/list?taxYear=<TaxYear>' \
-H 'accept: text/plain' \
-H 'X-K1X-Account: <YourAccountID>' \
-H 'X-K1X-Token: <YourAuthToken>'
Header Name Type Description X-K1X-AccountString Required. Your account identifier. X-K1X-TokenString Required. Authorization token. Content-TypeString Should be application/json.
Parameter Name Type Required Description taxYearInteger Yes The tax year for which the instances are retrieved.
The response is a list of json objects, structured as follows:
Type Description idInt Unique identifier of the instance. nameString Name of the instance.
