Entities

In a multi-entity shared company, entities represent a separate tax identification or a separately secured, fully balancing set of books. Entities typically represent divisions, franchises, affiliates, associations, locations, chapters, self-balancing funds or subsidiaries, with a shared chart of accounts.

List entities

get/objects/company-config/entity

Returns up to 100 entities from the collection with a key, ID, and link for each entity. This operation is mostly for use in testing; use the query service to find entities that meet specific criteria and to specify the properties that you want in the response.

SecurityOAuth2

Responses

200

400

Bad Request

Request samples

Response samples

application/json

{"ia::result": [{"key": "195",
"id": "entity1692705208",
"href": "/objects/company-config/entity/195"
},
{"key": "196",
"id": "entity21692704288",
"href": "/objects/company-config/entity/196"
},
{"key": "197",
"id": "entity11692704288",
"href": "/objects/company-config/entity/196"
}
],
"ia::meta": {"totalCount": 3,
"start": 1,
"pageSize": 100,
"next": null,
"previous": null
}
}

Create an entity

post/objects/company-config/entity

Creates a new entity.

SecurityOAuth2

Request

Request Body schema: application/json
required

Create entity object

required

string

Unique identifier of the entity. 20 characters max. The ID cannot be changed after the entity has been created.

Example: "Lyon"

name

required

string

Name of the entity.

Example: "California"

federalId

required

string or null

The federal tax ID for the entity. This value is required but is only used if the company is configured to issue a separate 1099 for each US entity.

Example: "123456789"

startDate

string or null <date>

The date when the entity became operational.

Example: "2022-02-02"

endDate

string or null <date>

The date when the entity was taken out of operation.

Example: "2023-03-03"

firstFiscalMonth

string or null

Default: null

First fiscal month

Enum: "april" "august" "december" "february" "january" "july" "june" "march" "may" "november" null "october" "september"

Example: "may"

firstTaxMonth

string or null

Default: null

First tax month

Enum: "april" "august" "december" "february" "january" "july" "june" "march" "may" "november" null "october" "september"

Example: "may"

weekStart

string or null

Default: null

The first day of each week. This enables the system to provide accurate data for reports that begin on the first day of a week.

Enum: "friday" "monday" null "saturday" "sunday" "thursday" "tuesday" "wednesday"

Example: "monday"

object

Contact information for the entity.

object

Primary contact information. This could be for the entity itself and not for an individual.

key	string System-assigned unique key for the contact. Example: "21"
id	string Contact ID. Example: "jsmith"
lastName	string or null Deprecated Last name. Example: "Smith"
firstName	string or null Deprecated First name. Example: "John"
middleName	string or null Deprecated Middle name. Example: "Archibald"
prefix	string or null Deprecated Prefix, such as Mr., Mrs., or Ms. Example: "Mr"
printAs	string Deprecated The contact's name as it will appear on documents. Example: "John Smith"
email1	string or null Deprecated Primary email address. Example: "[email protected]"
email2	string or null Deprecated Secondary email address. Example: "[email protected]"
phone1	string or null Deprecated Primary phone number. Example: "14085551212"
phone2	string or null Deprecated Secondary phone number. Example: "14085559876"
mobile	string or null Deprecated Mobile phone number. Example: "14085554420"
pager	string or null Deprecated Pager number. Example: "14085559987"
fax	string or null Deprecated Fax number. Example: "14085555309"
URL1	string or null Deprecated Web page address for this contact. Example: "https://mycompany.com"
URL2	string or null Deprecated Secondary web page address. Example: "https://anothercompany.com"
companyName	string or null Deprecated Name of the company. Example: "AlcoSoft Inc"
	object Mailing address.

object

Contact information to use for shipping, if the entity uses a different address for receiving goods and services.

key	string System-assigned unique key for the contact. Example: "21"
id	string Contact ID. Example: "jsmith"
lastName	string or null Deprecated Last name. Example: "Smith"
firstName	string or null Deprecated First name. Example: "John"
middleName	string or null Deprecated Middle name. Example: "Archibald"
prefix	string or null Deprecated Prefix, such as Mr., Mrs., or Ms. Example: "Mr"
printAs	string Deprecated The contact's name as it will appear on documents. Example: "John Smith"
email1	string or null Deprecated Primary email address. Example: "[email protected]"
email2	string or null Deprecated Secondary email address. Example: "[email protected]"
phone1	string or null Deprecated Primary phone number. Example: "14085551212"
phone2	string or null Deprecated Secondary phone number. Example: "14085559876"
mobile	string or null Deprecated Mobile phone number. Example: "14085554420"
pager	string or null Deprecated Pager number. Example: "14085559987"
fax	string or null Deprecated Fax number. Example: "14085555309"
URL1	string or null Deprecated Web page address for this contact. Example: "https://mycompany.com"
URL2	string or null Deprecated Secondary web page address. Example: "https://anothercompany.com"
companyName	string or null Deprecated Name of the company. Example: "AlcoSoft Inc"
	object Mailing address.

legalCategory

string

Identifies the type of organization under French law, encompassing various recognized forms for both private and public entities.

Example: "24 Fiduciary"

mainActivity

string

Specifies the primary economic activities the business engages in, helping classify the nature of operations.

Example: "10.3 Transformation and conservation of fruits and vegetables"

typeOfCompany

string

Classifies the business entity based on legal structure, size, activities, or other key characteristics.

Example: "03 Intermediate sized enterprises"

registeredCapital

integer

Represents the total capital invested by shareholders upon the company's formation.

Example: "37 000"

valueAddedTaxRegime

string

Details the specific VAT rules and regulations applicable to the business, including requirements for VAT collection, application, and reporting within France.

Example: "Monthly"

object

Texts used in invoices and reports.

message	string or null Message text Example: "Superior financial Applications. Real-time business visibility. Open, on-demand platform."
marketing	string or null Marketing text Example: "Intacct. A Better Way to Run Your Business"
footnote	string or null Footnote text that will appear on reports and invoices that are printed for the entity. Example: "All sales final."
reportPrintAs	string The name of the entity as it will appear on reports and invoices that are printed for the entity. Example: "My Company LLC"
customTitle	string or null Entity information displayed in reports, in addition to the entity name. For example, an entity title might include the address and manager name. Example: "San Jose, California"

businessDays

Array of strings

Default: []

Work days in each week.

Example: ["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY"]

weekends

Array of strings

Default: []

Weekend days.

Example: ["SATURDAY","SUNDAY"]

taxId

string or null

The state or territory tax ID, or VAT ID.

Example: "192354308"

defaultCountryForAddresses

string or null

Default: "unitedStates"

Default country for addresses

Enum: "afghanistan" "alandIslands" "albania" "algeria" "americanSamoa" "andorra" "angola" "anguilla" "antarctica" "antiguaAndBarbuda" "argentina" "armenia" "aruba" "australia" "austria" "azerbaijan" "bahamas" "bahrain" "bangladesh" "barbados" "belarus" "belgium" "belize" "benin" "bermuda" "bhutan" "bolivia" "bonaire,SintEustatiusAndSaba" "bosniaAndHerzegovina" "botswana" "bouvetIsland" "brazil" "britishIndianOceanTerritory" "bruneiDarussalam" "bulgaria" "burkinaFaso" "burundi" "cambodia" "cameroon" "canada" "capeVerde" "caymanIslands" "centralAfricanRepublic" "chad" "chile" "china" "christmasIsland" "cocos(Keeling)Islands" "colombia" "comoros" "congo" "congo,DemocraticRepublic" "cookIslands" "costaRica" "croatia" "cuba" "curaçao" "cyprus" "czechRepublic" "côteD'Ivoire" "denmark" "djibouti" "dominica" "dominicanRepublic" "ecuador" "egypt" "elSalvador" "equatorialGuinea" "eritrea" "estonia" "eswatini" "ethiopia" "falklandIslands(Malvinas)" "faroeIslands" "fiji" "finland" "france" "frenchGuiana" "frenchPolynesia" "frenchSouthernTerritories" "gabon" "gambia" "georgia" "germany" "ghana" "gibraltar" "greece" "greenland" "grenada" "guadeloupe" "guam" "guatemala" "guernsey" "guinea" "guineaBissau" "guyana" "haiti" "heardIs.&McdonaldIslands" "honduras" "hongKong" "hungary" "iceland" "india" "indonesia" "iran,IslamicRepublicOf" "iraq" "ireland" "isleOfMan" "israel" "italy" "jamaica" "japan" "jersey" "jordan" "kazakhstan" "kenya" "kiribati" "korea,Demo.People'sRep." "korea,RepublicOf" "kosovo" "kuwait" "kyrgyzstan" "lao" "latvia" "lebanon" "lesotho" "liberia" "libyanArabJamahiriya" "liechtenstein" "lithuania" "luxembourg" "macao" "macedonia" "madagascar" "malawi" "malaysia" "maldives" "mali" "malta" "marshallIslands" "martinique" "mauritania" "mauritius" "mayotte" "mexico" "micronesia" "moldova,RepublicOf" "monaco" "mongolia" "montenegro" "montserrat" "morocco" "mozambique" "myanmar" "namibia" "nauru" "nepal" "netherlands" "netherlandsAntilles" "newCaledonia" "newZealand" "nicaragua" "niger" "nigeria" "niue" "norfolkIsland" "northernMarianaIslands" "norway" null "oman" "pakistan" "palau" "palestinianTerritory,Occupied" "panama" "papuaNewGuinea" "paraguay" "peru" "philippines" "pitcairn" "poland" "portugal" "puertoRico" "qatar" "reunion" "romania" "russianFederation" "rwanda" "s.Georgia&S.SandwichIs." "saintBarthelemy" "saintHelena" "saintKittsAndNevis" "saintLucia" "saintMartin" "saintPierreAndMiquelon" "saintVincentAndTheGrenadines" "samoa" "sanMarino" "saoTomeAndPrincipe" "saudiArabia" "senegal" "serbia" "seychelles" "sierraLeone" "singapore" "sintMaarten" "slovakia" "slovenia" "solomonIslands" "somalia" "southAfrica" "southSudan" "spain" "sriLanka" "sudan" "suriname" "svalbardAndJanMayen" "sweden" "switzerland" "syrianArabRepublic" "taiwan" "tajikistan" "tanzania,UnitedRepublicOf" "thailand" "timorLeste" "togo" "tokelau" "tonga" "trinidadAndTobago" "tunisia" "turkey" "turkmenistan" "turksAndCaicosIslands" "tuvalu" "uSMinorOutlyingIslands" "uganda" "ukraine" "unitedArabEmirates" "unitedKingdom" "unitedStates" "uruguay" "uzbekistan" "vanuatu" "vaticanCityState" "venezuela" "vietnam" "virginIslands,British" "virginIslands,U.S." "wallisAndFutuna" "westernSahara" "yemen" "zambia" "zimbabwe"

Example: "france"

businessId

string or null

A company's Business ID (SIRET) is a 14-digit number that starts with the SIREN (a 9-digit number that identifies the company itself) followed by 5 digits that identifies the company's physical location or branch.

Example: "453 983 245 12345"

openBooksStartDate

string or null <date>

Open books from

Example: "2021-01-01"

operatingCountry

string or null

Default: null

The country in which the entity operates.

Example: "france"

object

Legal contact to be used on 1099 form, 1096 form, and taxable payments annual report (TPAR).

enableOnTaxForms

boolean

Default: false

Set to true to include the legal name and address on forms 1099 and 1096 for this entity.

Example: false

enableOnTPAR

boolean

Default: false

Set to true to include the legal name and address on taxable payments annual report (TPAR) for Australian companies and entities.

Example: false

name

string or null

Legal name, to be printed on 1099 form, 1096 form and taxable payments annual report (TPAR).

Example: "Expert Sage Intacct LTD"

object

Legal address to be used on 1099 form, 1096 form and taxable payments annual report (TPAR).

address1	string or null Legal address line 1 Example: "300 Park Avenue"
address2	string or null Legal address line 2 Example: "Suite 1400"
address3	string or null Legal address line 3 Example: "Western industrial area"
city	string or null Legal city Example: "San Jose"
state	string or null Legal state or territory Example: "California"
zipCode	string or null Legal ZIP or postal code Example: "95110"
country	string or null Legal country Example: "United States"
countryCode	string or null Default: null Legal country code Enum: "ad" "ae" "af" "ag" "ai" "al" "am" "an" "ao" "aq" "ar" "as" "at" "au" "aw" "ax" "az" "ba" "bb" "bd" "be" "bf" "bg" "bh" "bi" "bj" "bl" "bm" "bn" "bo" "bq" "br" "bs" "bt" "bv" "bw" "by" "bz" "ca" "cc" "cd" "cf" "cg" "ch" "ci" "ck" "cl" "cm" "cn" "co" "cr" "cu" "cv" "cw" "cx" "cy" "cz" "de" "dj" "dk" "dm" "do" "dz" "ec" "ee" "eg" "eh" "er" "es" "et" "fi" "fj" "fk" "fm" "fo" "fr" "ga" "gb" "gd" "ge" "gf" "gg" "gh" "gi" "gl" "gm" "gn" "gp" "gq" "gr" "gs" "gt" "gu" "gw" "gy" "hk" "hm" "hn" "hr" "ht" "hu" "id" "ie" "il" "im" "in" "io" "iq" "ir" "is" "it" "je" "jm" "jo" "jp" "ke" "kg" "kh" "ki" "km" "kn" "kp" "kr" "kw" "ky" "kz" "la" "lb" "lc" "li" "lk" "lr" "ls" "lt" "lu" "lv" "ly" "ma" "mc" "md" "me" "mf" "mg" "mh" "mk" "ml" "mm" "mn" "mo" "mp" "mq" "mr" "ms" "mt" "mu" "mv" "mw" "mx" "my" "mz" "na" "nc" "ne" "nf" "ng" "ni" "nl" "no" "np" "nr" "nu" null "nz" "om" "pa" "pe" "pf" "pg" "ph" "pk" "pl" "pm" "pn" "pr" "ps" "pt" "pw" "py" "qa" "re" "ro" "rs" "ru" "rw" "sa" "sb" "sc" "sd" "se" "sg" "sh" "si" "sj" "sk" "sl" "sm" "sn" "so" "sr" "ss" "st" "sv" "sx" "sy" "sz" "tc" "td" "tf" "tg" "th" "tj" "tk" "tl" "tm" "tn" "to" "tr" "tt" "tv" "tw" "tz" "ua" "ug" "um" "us" "uy" "uz" "va" "vc" "ve" "vg" "vi" "vn" "vu" "wf" "ws" "xk" "ye" "yt" "za" "zm" "zw" Example: "us"

object

Taxable payments annual report (TPAR) form elements.

	object Legal contact for taxable payments annual report (TPAR).
branchNumber	string or null Legal branch number on taxable payments annual report (TPAR). Example: "001"

isPartialExempt

boolean

Default: false

Enable partial VAT exemption. When set to true, users can enter bills with items that are eligible for partial exemption in agreement with the HMRC. Requires that tax solution is United Kingdom - VAT.

Example: true

isDefaultPartialExempt

boolean

Default: false

Set to true to mark items as partial exempt by default on bills and invoices for Accounts Payable and Purchasing with the following tax solutions - Australia GST (RITC), Canadian Sales Tax (ITC), UK VAT.

Example: true

accountingType

string or null

Default: "entity"

Accounting type

Enum: "entity" "fund" null

Example: "entity"

statutoryReportingPeriodDate

string or null <date>

Max lock date for the given entity, used for GL Setup Approval Configuration.

Example: "2021-01-01"

object

Customer associated with the entity.

key	string or null Unique key of the associated customer. Example: "15"
id	string Unique identifier for the customer. Example: "C-00003"

object

Vendor associated with the entity.

key	string Unique key of the vendor. Example: "15"
id	string Vendor ID. Example: "V-00014"

object

Unrecoverable tax account for this entity.

key	string or null Unrecoverable tax account key Example: "23"
id	string or null Unrecoverable tax account ID Example: "123.45"

enableInterEntityRelationships

boolean

Default: false

Set to true to enable different accounts based on the target entity.

Example: true

object

Inter-entity payable account that this entity is associated with. Only applicable if enableInterEntityRelationships = true.

key	string or null System-assigned unique key of the account for payable inter-entity transactions. Example: "89"
id	string or null Inter-entity payable account ID. Example: "555.99"

object

Inter-entity receivable account that this entity is associated with. Only applicable if enableInterEntityRelationships = true.

key	string or null System-assigned unique key of the account for receivable inter-entity transactions. Example: "876"
id	string or null Inter-entity receivable account ID. Example: "555.98"

object

The employee who manages the entity.

id	string Manager employee ID. Example: "jsmith"
key	string System-assigned unique key of the manager employee. Example: "81"

object

The tax solution to be used by this entity. Only for companies subscribed to the Taxes application.

key	string Tax solution Example: "23"
id	string Tax solution Example: "Australia - GST"

isLimitedEntity

boolean

Default: false

Set to 'true' to indicate that this entity is a limited entity.

Example: true

enableEInvoicing

boolean

Default: false

Set to 'true' to indicate that this entity is e-invoice enabled.

Example: true

status

string

Default: "active"

Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.

Enum: "active" "inactive"

Example: "active"

Responses

201

Created

400

Bad Request

Request samples

application/json

{"id": "Hungary",
"name": "Hungary",
"defaultCountryForAddresses": "hungary",
"operatingCountry": "hungary",
"reportPrintAs": "Hungary",
"weekStart": "monday",
"contacts": {"primary": {"id": "-1-13S(V1-13S)"
},
"shipTo": {"id": "0000-1S(V0000-1S)"
}
},
"manager": {"key": "14"
},
"texts": {"message": "Superior financial Applications. Real-time business visibility. Open, on-demand platform.",
"marketing": "Intacct. A Better Way to Run Your Business",
"footnote": "Hungary",
"customTitle": "Hungary"
},
"isRoot": true,
"businessDays": ["MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY"
],
"weekends": ["SATURDAY",
"SUNDAY"
],
"taxId": "192354308",
"startDate": "2023-01-12",
"openBooksStartDate": "2023-10-01",
"isLimitedEntity": false
}

Response samples

application/json

{"ia::result": {"key": "184",
"id": "Hungary",
"href": "/objects/company-config/entity/184"
},
"ia::meta": {"totalCount": 1,
"totalSuccess": 1,
"totalError": 0
}
}

Get an entity

get/objects/company-config/entity/{key}

Returns detailed information for a specified entity.

SecurityOAuth2

Request

path Parameters

key

required

string

System-assigned unique key for the entity.

Example: 99

Responses

200

400

Bad Request

Request samples

Response samples

application/json

{"ia::result": {"id": "entity1693567215",
"key": "601",
"name": "entity1693567215",
"manager": {"name": "Supervisor",
"id": "b.ruth",
"key": "81",
"href": "/objects/company-config/employee/81"
},
"contacts": {"primary": {"mailingAddress": {"addressLine1": "744 Edgewater Blvd",
"addressLine2": "Suite 10",
"addressLine3": "Industrial area",
"city": "Kansas City",
"state": "KS",
"postCode": "66104",
"country": "United States"
},
"id": "AMoore",
"lastName": "Moore",
"firstName": "Andy",
"middleName": "Robert",
"prefix": "Mr.",
"printAs": "Andy Moore",
"email1": "[email protected]",
"email2": "[email protected]",
"phone1": "9134598676",
"phone2": "9133459867",
"mobile": "9133132299",
"pager": "9133132299",
"fax": "9134598677",
"URL1": "http://andy.exampledomain.com",
"URL2": "http://andy.exampledomainsecond.com",
"companyName": "Ecology Corp",
"key": "237",
"href": "/objects/company-config/contact/237"
},
"shipTo": {"mailingAddress": {"addressLine1": "300 Park Avenue",
"addressLine2": "Suite 1400",
"addressLine3": "Western industrial area",
"city": "San Jose",
"state": "California",
"postCode": "95110",
"country": "United States"
},
"id": "Vendor_A0000001",
"lastName": "Smith",
"firstName": "Sara",
"middleName": "Sue",
"prefix": "Ms.",
"printAs": "Sara Smith",
"email1": "[email protected]",
"email2": "[email protected]",
"phone1": "14085551212",
"phone2": "14123321255",
"mobile": "14085554420",
"pager": "14085559987",
"fax": "14085555309",
"URL1": "https://smith.example.com",
"URL2": "https://sarasue.example.com",
"companyName": null,
"key": "198",
"href": "/objects/company-config/contact/198"
},
"legalCategory": "24 Fiduciary",
"mainActivity": "10.3 Transformation and conservation of fruits and vegetables",
"typeOfCompany": "03 Intermediate sized enterprises",
"registeredCapital": 500,
"valueAddedTaxRegime": "Monthly"
},
"startDate": "2020-01-01",
"endDate": null,
"status": "active",
"audit": {"createdDateTime": "2023-09-01T11:20:19Z",
"modifiedDateTime": "2023-09-01T11:20:19Z",
"createdBy": "99",
"modifiedBy": "99",
"createdByUser": {"key": "99",
"id": "Admin",
"href": "/objects/company-config/user/99"
},
"modifiedByUser": {"key": "99",
"id": "Admin",
"href": "/objects/company-config/user/99"
}
},
"federalId": "123456789",
"firstFiscalMonth": "april",
"weekStart": "monday",
"interEntityPayableGLAccount": {"id": null,
"accountNumber": null,
"key": null
},
"interEntityReceivableGLAccount": {"id": "1",
"accountNumber": 123436,
"key": "1"
},
"texts": {"message": "Superior financial Applications. Real-time business visibility. Open, on-demand platform.",
"marketing": "Intacct. A Better Way to Run Your Business",
"footnote": "Net 30 days",
"reportPrintAs": "California"
},
"isRoot": false,
"vendor": {"name": "Pac bell",
"id": "V-00014"
},
"customer": {"id": "15",
"name": "Logic Solutions"
},
"enableInterEntityRelationships": false,
"customTitle": "California",
"businessDays": ["SUNDAY",
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY"
],
"weekends": ["FRIDAY",
"SATURDAY"
],
"firstTaxMonth": "january",
"taxId": "192354308",
"siret": "01234567890123456789",
"defaultCountryForAddresses": "westernSahara",
"openBooksStartDate": "1990-01-01",
"legalContact": {"enableOnTaxForms": false,
"name": "Expert Sage Intacct LTD",
"address": {"address1": "300 Park Avenue",
"address2": "Suite 1400",
"address3": "Western industrial area",
"city": "San Jose",
"state": "California",
"zipCode": "95110",
"country": "United States",
"countryCode": "us"
},
"tpar": {"contact": {"name": "John Doe",
"phone": "1022223333",
"fax": "1009288888",
"email": "[email protected]"
},
"branchNumber": "001"
},
"enableOnTPAR": false
},
"operatingCountry": "france",
"taxSolution": {"key": "23",
"id": "23",
"taxMethod": "Advanced tax",
"href": "/objects/tax/tax-solution/23"
},
"isPartialExempt": false,
"isDefaultPartialExempt": false,
"unrecoverableTaxAccount": {"id": null
},
"accountingType": "entity",
"statutoryReportingPeriodDate": "2021-01-01",
"isLimitedEntity": false,
"href": "/objects/company-config/entity/601"
},
"ia::meta": {"totalCount": 1,
"totalSuccess": 1,
"totalError": 0
}
}

Update an entity

patch/objects/company-config/entity/{key}

Updates an existing entity by setting field values. Any fields not provided remain unchanged.

SecurityOAuth2

Request

path Parameters

key

required

string

System-assigned unique key for the entity.

Example: 99

Request Body schema: application/json

name

string

Name of the entity.

Example: "California"

startDate

string or null <date>

The date when the entity became operational.

Example: "2022-02-02"

endDate

string or null <date>

The date when the entity was taken out of operation.

Example: "2023-03-03"

federalId

string or null

The federal tax ID for the entity. This value is required but is only used if the company is configured to issue a separate 1099 for each US entity.

Example: "123456789"

firstFiscalMonth

string or null

Default: null

First fiscal month

Enum: "april" "august" "december" "february" "january" "july" "june" "march" "may" "november" null "october" "september"

Example: "may"

firstTaxMonth

string or null

Default: null

First tax month

Enum: "april" "august" "december" "february" "january" "july" "june" "march" "may" "november" null "october" "september"

Example: "may"

weekStart

string or null

Default: null

The first day of each week. This enables the system to provide accurate data for reports that begin on the first day of a week.

Enum: "friday" "monday" null "saturday" "sunday" "thursday" "tuesday" "wednesday"

Example: "monday"

object

Contact information for the entity.

object

Primary contact information. This could be for the entity itself and not for an individual.

key	string System-assigned unique key for the contact. Example: "21"
id	string Contact ID. Example: "jsmith"
lastName	string or null Deprecated Last name. Example: "Smith"
firstName	string or null Deprecated First name. Example: "John"
middleName	string or null Deprecated Middle name. Example: "Archibald"
prefix	string or null Deprecated Prefix, such as Mr., Mrs., or Ms. Example: "Mr"
printAs	string Deprecated The contact's name as it will appear on documents. Example: "John Smith"
email1	string or null Deprecated Primary email address. Example: "[email protected]"
email2	string or null Deprecated Secondary email address. Example: "[email protected]"
phone1	string or null Deprecated Primary phone number. Example: "14085551212"
phone2	string or null Deprecated Secondary phone number. Example: "14085559876"
mobile	string or null Deprecated Mobile phone number. Example: "14085554420"
pager	string or null Deprecated Pager number. Example: "14085559987"
fax	string or null Deprecated Fax number. Example: "14085555309"
URL1	string or null Deprecated Web page address for this contact. Example: "https://mycompany.com"
URL2	string or null Deprecated Secondary web page address. Example: "https://anothercompany.com"
companyName	string or null Deprecated Name of the company. Example: "AlcoSoft Inc"
	object Mailing address.

object

Contact information to use for shipping, if the entity uses a different address for receiving goods and services.

key	string System-assigned unique key for the contact. Example: "21"
id	string Contact ID. Example: "jsmith"
lastName	string or null Deprecated Last name. Example: "Smith"
firstName	string or null Deprecated First name. Example: "John"
middleName	string or null Deprecated Middle name. Example: "Archibald"
prefix	string or null Deprecated Prefix, such as Mr., Mrs., or Ms. Example: "Mr"
printAs	string Deprecated The contact's name as it will appear on documents. Example: "John Smith"
email1	string or null Deprecated Primary email address. Example: "[email protected]"
email2	string or null Deprecated Secondary email address. Example: "[email protected]"
phone1	string or null Deprecated Primary phone number. Example: "14085551212"
phone2	string or null Deprecated Secondary phone number. Example: "14085559876"
mobile	string or null Deprecated Mobile phone number. Example: "14085554420"
pager	string or null Deprecated Pager number. Example: "14085559987"
fax	string or null Deprecated Fax number. Example: "14085555309"
URL1	string or null Deprecated Web page address for this contact. Example: "https://mycompany.com"
URL2	string or null Deprecated Secondary web page address. Example: "https://anothercompany.com"
companyName	string or null Deprecated Name of the company. Example: "AlcoSoft Inc"
	object Mailing address.

legalCategory

string

Identifies the type of organization under French law, encompassing various recognized forms for both private and public entities.

Example: "24 Fiduciary"

mainActivity

string

Specifies the primary economic activities the business engages in, helping classify the nature of operations.

Example: "10.3 Transformation and conservation of fruits and vegetables"

typeOfCompany

string

Classifies the business entity based on legal structure, size, activities, or other key characteristics.

Example: "03 Intermediate sized enterprises"

registeredCapital

integer

Represents the total capital invested by shareholders upon the company's formation.

Example: "37 000"

valueAddedTaxRegime

string

Details the specific VAT rules and regulations applicable to the business, including requirements for VAT collection, application, and reporting within France.

Example: "Monthly"

object

Texts used in invoices and reports.

message	string or null Message text Example: "Superior financial Applications. Real-time business visibility. Open, on-demand platform."
marketing	string or null Marketing text Example: "Intacct. A Better Way to Run Your Business"
footnote	string or null Footnote text that will appear on reports and invoices that are printed for the entity. Example: "All sales final."
reportPrintAs	string The name of the entity as it will appear on reports and invoices that are printed for the entity. Example: "My Company LLC"
customTitle	string or null Entity information displayed in reports, in addition to the entity name. For example, an entity title might include the address and manager name. Example: "San Jose, California"

businessDays

Array of strings

Default: []

Work days in each week.

Example: ["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY"]

weekends

Array of strings

Default: []

Weekend days.

Example: ["SATURDAY","SUNDAY"]

taxId

string or null

The state or territory tax ID, or VAT ID.

Example: "192354308"

defaultCountryForAddresses

string or null

Default: "unitedStates"

Default country for addresses

Example: "france"

businessId

string or null

Example: "453 983 245 12345"

openBooksStartDate

string or null <date>

Open books from

Example: "2021-01-01"

operatingCountry

string or null

Default: null

The country in which the entity operates.

Example: "france"

object

Legal contact to be used on 1099 form, 1096 form, and taxable payments annual report (TPAR).

enableOnTaxForms

boolean

Default: false

Set to true to include the legal name and address on forms 1099 and 1096 for this entity.

Example: false

enableOnTPAR

boolean

Default: false

Set to true to include the legal name and address on taxable payments annual report (TPAR) for Australian companies and entities.

Example: false

name

string or null

Legal name, to be printed on 1099 form, 1096 form and taxable payments annual report (TPAR).

Example: "Expert Sage Intacct LTD"

object

Legal address to be used on 1099 form, 1096 form and taxable payments annual report (TPAR).

address1	string or null Legal address line 1 Example: "300 Park Avenue"
address2	string or null Legal address line 2 Example: "Suite 1400"
address3	string or null Legal address line 3 Example: "Western industrial area"
city	string or null Legal city Example: "San Jose"
state	string or null Legal state or territory Example: "California"
zipCode	string or null Legal ZIP or postal code Example: "95110"
country	string or null Legal country Example: "United States"
countryCode	string or null Default: null Legal country code Enum: "ad" "ae" "af" "ag" "ai" "al" "am" "an" "ao" "aq" "ar" "as" "at" "au" "aw" "ax" "az" "ba" "bb" "bd" "be" "bf" "bg" "bh" "bi" "bj" "bl" "bm" "bn" "bo" "bq" "br" "bs" "bt" "bv" "bw" "by" "bz" "ca" "cc" "cd" "cf" "cg" "ch" "ci" "ck" "cl" "cm" "cn" "co" "cr" "cu" "cv" "cw" "cx" "cy" "cz" "de" "dj" "dk" "dm" "do" "dz" "ec" "ee" "eg" "eh" "er" "es" "et" "fi" "fj" "fk" "fm" "fo" "fr" "ga" "gb" "gd" "ge" "gf" "gg" "gh" "gi" "gl" "gm" "gn" "gp" "gq" "gr" "gs" "gt" "gu" "gw" "gy" "hk" "hm" "hn" "hr" "ht" "hu" "id" "ie" "il" "im" "in" "io" "iq" "ir" "is" "it" "je" "jm" "jo" "jp" "ke" "kg" "kh" "ki" "km" "kn" "kp" "kr" "kw" "ky" "kz" "la" "lb" "lc" "li" "lk" "lr" "ls" "lt" "lu" "lv" "ly" "ma" "mc" "md" "me" "mf" "mg" "mh" "mk" "ml" "mm" "mn" "mo" "mp" "mq" "mr" "ms" "mt" "mu" "mv" "mw" "mx" "my" "mz" "na" "nc" "ne" "nf" "ng" "ni" "nl" "no" "np" "nr" "nu" null "nz" "om" "pa" "pe" "pf" "pg" "ph" "pk" "pl" "pm" "pn" "pr" "ps" "pt" "pw" "py" "qa" "re" "ro" "rs" "ru" "rw" "sa" "sb" "sc" "sd" "se" "sg" "sh" "si" "sj" "sk" "sl" "sm" "sn" "so" "sr" "ss" "st" "sv" "sx" "sy" "sz" "tc" "td" "tf" "tg" "th" "tj" "tk" "tl" "tm" "tn" "to" "tr" "tt" "tv" "tw" "tz" "ua" "ug" "um" "us" "uy" "uz" "va" "vc" "ve" "vg" "vi" "vn" "vu" "wf" "ws" "xk" "ye" "yt" "za" "zm" "zw" Example: "us"

object

Taxable payments annual report (TPAR) form elements.

	object Legal contact for taxable payments annual report (TPAR).
branchNumber	string or null Legal branch number on taxable payments annual report (TPAR). Example: "001"

isPartialExempt

boolean

Default: false

Example: true

isDefaultPartialExempt

boolean

Default: false

Example: true

accountingType

string or null

Default: "entity"

Accounting type

Enum: "entity" "fund" null

Example: "entity"

statutoryReportingPeriodDate

string or null <date>

Max lock date for the given entity, used for GL Setup Approval Configuration.

Example: "2021-01-01"

object

Customer associated with the entity.

key	string or null Unique key of the associated customer. Example: "15"
id	string Unique identifier for the customer. Example: "C-00003"

object

Vendor associated with the entity.

key	string Unique key of the vendor. Example: "15"
id	string Vendor ID. Example: "V-00014"

object

Unrecoverable tax account for this entity.

key	string or null Unrecoverable tax account key Example: "23"
id	string or null Unrecoverable tax account ID Example: "123.45"

enableInterEntityRelationships

boolean

Default: false

Set to true to enable different accounts based on the target entity.

Example: true

object

Inter-entity payable account that this entity is associated with. Only applicable if enableInterEntityRelationships = true.

key	string or null System-assigned unique key of the account for payable inter-entity transactions. Example: "89"
id	string or null Inter-entity payable account ID. Example: "555.99"

object

Inter-entity receivable account that this entity is associated with. Only applicable if enableInterEntityRelationships = true.

key	string or null System-assigned unique key of the account for receivable inter-entity transactions. Example: "876"
id	string or null Inter-entity receivable account ID. Example: "555.98"

object

The employee who manages the entity.

id	string Manager employee ID. Example: "jsmith"
key	string System-assigned unique key of the manager employee. Example: "81"

object

The tax solution to be used by this entity. Only for companies subscribed to the Taxes application.

key	string Tax solution Example: "23"
id	string Tax solution Example: "Australia - GST"

isLimitedEntity

boolean

Default: false

Set to 'true' to indicate that this entity is a limited entity.

Example: true

enableEInvoicing

boolean

Default: false

Set to 'true' to indicate that this entity is e-invoice enabled.

Example: true

status

string

Default: "active"

Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.

Enum: "active" "inactive"

Example: "active"

Responses

200

400

Bad Request

Request samples

application/json

{"endDate": "2023-12-31",
"status": "inactive"
}

Response samples

application/json

{"ia::result": {"key": "1",
"id": "entity1693567215",
"href": "/objects/company-config/entity/1"
},
"ia::meta": {"totalCount": 1,
"totalSuccess": 1,
"totalError": 0
}
}

Delete an entity

delete/objects/company-config/entity/{key}

Deletes an entity.

SecurityOAuth2

Request

path Parameters

key

required

string

System-assigned unique key for the entity.

Example: 99

Responses

204

No Content

400

Bad Request

Request samples

Response samples

application/json

{"ia::result": {"ia::error": {"code": "invalidRequest",
"message": "A POST request requires a payload",
"errorId": "REST-1028",
"additionalInfo": {"messageId": "IA.REQUEST_REQUIRES_A_PAYLOAD",
"placeholders": {"OPERATION": "POST"
},
"propertySet": { }
},
"supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
}
},
"ia::meta": {"totalCount": 1,
"totalSuccess": 0,
"totalError": 1
}
}

Entities

List entities

Create an entity

Request Body schema: application/jsonrequired

Get an entity

path Parameters

Update an entity

path Parameters

Request Body schema: application/json

Delete an entity

path Parameters

Request Body schema: application/json
required