SOsoraban
Entities

Create an entity

Changed on

Adds another entity to an existing client.

post/entities

Request

Request body

namestring required

Entity name.

user_idinteger required

The client who owns this entity.

entity_typestring required

For example Individual, Partnership, S-Corporation.

external_entity_idstring

Your own identifier for this entity.

streetstring
citystring
statestring
zipstring
countrystring
business_emailstring email
other_emailstring email

Example request

{
  "entity_type": "Partnership"
}

Response

The created entity.

idinteger
entity_typestring nullable
namestring nullable
streetstring nullable
statestring nullable
citystring nullable
zipstring nullable
countrystring nullable
inactiveboolean nullable
created_atstring date-time
upload_linkstring nullable
business_emailstring nullable
other_emailstring nullable
external_entity_idstring nullable
deleted_atstring date-time nullable
hash_idstring nullable
firm_role_summarystring

A formatted, human-readable summary of who holds which role on the entity, not structured data. Empty when no roles are assigned. Use GET /entities/{entity_id}/firm_role_assignments if you need the underlying ids.

firm_group_idinteger nullable
firm_groupobject nullable

Example response

{
  "firm_role_summary": "Partner: Jane Doe, Manager: John Smith"
}

Changes

  • 1c230fa547adRevision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      removed the enum value Corporation of the request property

    • breaking

      removed the enum value Estate of the request property

    • breaking

      removed the enum value Individual of the request property

    • breaking

      removed the enum value Other of the request property

    • breaking

      removed the enum value Partnership of the request property

    • breaking

      removed the enum value Trust of the request property

    • breaking

      the request property format changed from no format to email

    • breaking

      the request property format changed from no format to email

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the // response's property type changed from string to string null, and format from email to no format for status

    • breaking

      the // response's property type changed from string to string null, and format from email to no format for status

    • breaking

      the response's property type changed from string to string null, and format from uri to no format for status

    • breaking

      the / response's property type changed from string to string null, and format from email to no format for status

    • breaking

      the / response's property type changed from string to string null, and format from email to no format for status

    • breaking

      removed the required property from the response with the status

    • info

      api operation id createEntity was added

    • info

      the endpoint scheme security bearerAuth was removed from the API

    • info

      api tag Entities added

    • info

      added the new optional request property

    • info

      removed the pattern ^[^/]+$ from the request property

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status