Import (create or update) the entity on a project.

post

https://k1creator-publicapi.k1x.io/v1/projects/{projectId}/entities

Validates and upserts the supplied entity onto the project identified by
projectId, which must belong to the tenant your API key resolves to. A
project holds at most one entity: if the project has no entity yet one is created, otherwise
the existing entity is updated in place. If the record fails validation the request is
rejected and nothing is written. Use dryRun=true to validate a payload without
applying it.

The entity's identity is resolved server-side from the project, so no identifier is required
on the request. The optional externalId you send is echoed back on the response so you
can map your own identifier to the Creator-assigned entityId.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

projectId

int32

required

The project to import the entity into.

Query Params

dryRun

boolean

When true, validation runs but no changes are applied.

Body Params

The entity to create or update.

The entity to create or update through the public import API. A project holds at most one
entity, so this request carries a single entity rather than a list; whether it creates or
updates is resolved from the project's existing entity, not from any caller-supplied identifier.

externalId

string | null

An optional caller-owned identifier for this record. It is not stored or used for matching;
it is echoed back on the response so you can correlate the result to the record you sent.

name

string

required

The entity's name. Required.

name2

string | null

A second name line.

name3

string | null

A third name line.

ein

string

required

The employer identification number. Required. Exactly 9 digits with no dashes, spaces, or other
characters — 123456789. The dashed 12-3456789 form is not accepted.

entityType

string

enum

required

The entity type. Required. One of LLC, LLP, Partnership, or PubliclyTradedPartnership.

Allowed:

yearStart

date-time

required

The tax year start date. Required and must be earlier than YearEnd.

yearEnd

date-time

required

The tax year end date. Required and must be later than YearStart.

addressLine1

string

required

The first address line. Required.

addressLine2

string | null

The second address line.

city

string

required

The city. Required.

state

string

required

The state name or two-letter code. Required.

zipCode

string

required

The postal (ZIP) code. Required. Accepts 12345 or 12345-6789.

finalK1

boolean | null

Whether the K-1 is final.

amendedK1

boolean | null

Whether the K-1 is amended.

finalK3

boolean | null

Whether the K-3 is final.

amendedK3

boolean | null

Whether the K-3 is amended.

irsServiceCenter

string | null

The IRS service center.

isItemK1IncludesLiabilityAmountsFromLowertierPartnerships

boolean | null

Whether item K-1 includes liability amounts from lower-tier partnerships.

moreThanOneActivityForAtRiskPurposes

boolean | null

Whether there is more than one activity for at-risk purposes.

moreThanOneActivityForPassiveActivityPurposes

boolean | null

Whether there is more than one activity for passive-activity purposes.

reportableTransactionOrTaxshelterRegistrationNumbers

string | null

Reportable transaction or tax-shelter registration numbers.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

200The payload was valid; the summary reports the applied row and its identifier.

400The record failed validation; nothing was written.

404No project exists with the given identifier, it has been deleted, or it belongs to another tenant.