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

OK

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


id
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
Last name.


 
 Example:  "Smith"
firstName
string or null
First name.


 
 Example:  "John"
middleName
string or null
Middle name.


 
 Example:  "Archibald"
prefix
string or null
Prefix, such as Mr., Mrs., or Ms.


 
 Example:  "Mr"
printAs
string
The contact's name as it will appear on documents.


 
 Example:  "John Smith"
email1
string or null
Primary email address.


 
 Example:  "[email protected]"
email2
string or null
Secondary email address.


 
 Example:  "[email protected]"
phone1
string or null
Primary phone number.


 
 Example:  "14085551212"
phone2
string or null
Secondary phone number.


 
 Example:  "14085559876"
mobile
string or null
Mobile phone number.


 
 Example:  "14085554420"
pager
string or null
Pager number.


 
 Example:  "14085559987"
fax
string or null
Fax number.


 
 Example:  "14085555309"
URL1
string or null
Web page address for this contact.


 
 Example:  "https://mycompany.com"
URL2
string or null
Secondary web page address.


 
 Example:  "https://anothercompany.com"
companyName
string or null
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
Last name.


 
 Example:  "Smith"
firstName
string or null
First name.


 
 Example:  "John"
middleName
string or null
Middle name.


 
 Example:  "Archibald"
prefix
string or null
Prefix, such as Mr., Mrs., or Ms.


 
 Example:  "Mr"
printAs
string
The contact's name as it will appear on documents.


 
 Example:  "John Smith"
email1
string or null
Primary email address.


 
 Example:  "[email protected]"
email2
string or null
Secondary email address.


 
 Example:  "[email protected]"
phone1
string or null
Primary phone number.


 
 Example:  "14085551212"
phone2
string or null
Secondary phone number.


 
 Example:  "14085559876"
mobile
string or null
Mobile phone number.


 
 Example:  "14085554420"
pager
string or null
Pager number.


 
 Example:  "14085559987"
fax
string or null
Fax number.


 
 Example:  "14085555309"
URL1
string or null
Web page address for this contact.


 
 Example:  "https://mycompany.com"
URL2
string or null
Secondary web page address.


 
 Example:  "https://anothercompany.com"
companyName
string or null
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.


 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"
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
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
OK


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": {
        },
      • "shipTo": {
        },
      • "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"
      },
    • "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": {
        },
      • "tpar": {
        },
      • "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
Last name.


 
 Example:  "Smith"
firstName
string or null
First name.


 
 Example:  "John"
middleName
string or null
Middle name.


 
 Example:  "Archibald"
prefix
string or null
Prefix, such as Mr., Mrs., or Ms.


 
 Example:  "Mr"
printAs
string
The contact's name as it will appear on documents.


 
 Example:  "John Smith"
email1
string or null
Primary email address.


 
 Example:  "[email protected]"
email2
string or null
Secondary email address.


 
 Example:  "[email protected]"
phone1
string or null
Primary phone number.


 
 Example:  "14085551212"
phone2
string or null
Secondary phone number.


 
 Example:  "14085559876"
mobile
string or null
Mobile phone number.


 
 Example:  "14085554420"
pager
string or null
Pager number.


 
 Example:  "14085559987"
fax
string or null
Fax number.


 
 Example:  "14085555309"
URL1
string or null
Web page address for this contact.


 
 Example:  "https://mycompany.com"
URL2
string or null
Secondary web page address.


 
 Example:  "https://anothercompany.com"
companyName
string or null
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
Last name.


 
 Example:  "Smith"
firstName
string or null
First name.


 
 Example:  "John"
middleName
string or null
Middle name.


 
 Example:  "Archibald"
prefix
string or null
Prefix, such as Mr., Mrs., or Ms.


 
 Example:  "Mr"
printAs
string
The contact's name as it will appear on documents.


 
 Example:  "John Smith"
email1
string or null
Primary email address.


 
 Example:  "[email protected]"
email2
string or null
Secondary email address.


 
 Example:  "[email protected]"
phone1
string or null
Primary phone number.


 
 Example:  "14085551212"
phone2
string or null
Secondary phone number.


 
 Example:  "14085559876"
mobile
string or null
Mobile phone number.


 
 Example:  "14085554420"
pager
string or null
Pager number.


 
 Example:  "14085559987"
fax
string or null
Fax number.


 
 Example:  "14085555309"
URL1
string or null
Web page address for this contact.


 
 Example:  "https://mycompany.com"
URL2
string or null
Secondary web page address.


 
 Example:  "https://anothercompany.com"
companyName
string or null
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.


 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"
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
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
OK


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": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}
Query entities
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "company-config/entity"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or has (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the result set, 4000 maximum.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "company-config/entity",
  • "filters": [
    • {
      • "$ne": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "name",
    • "endDate"
    ],
  • "orderBy": [
    • {
      • "endDate": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "9",
      • "id": "HI",
      • "name": "Hawaii",
      • "endDate": "2023-04-01"
      }
    ],
  • "ia::meta": {
    • "totalCount": 1,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}