REST API
SOAP API
FAQ
Changelog
Terms & Conditions
Help Center
REST API
SOAP API
FAQ
Changelog
Terms & Conditions
Help Center
  • Common Datatypes
  • AccountService Datatypes
  • AttachmentService Datatypes
  • AuthenticateService Datatypes
  • BudgetService Datatypes
  • ClientService Datatypes
  • CompanyService Datatypes
  • FileService Datatypes
  • InvoiceService Datatypes
  • PaymentService Datatypes
  • PersonService Datatypes
  • ProductService Datatypes
  • ProjectService Datatypes
  • SalesOppService DataTypes
  • TemplateService DataTypes
  • TimeService Datatypes
  • TransactionService DataTypes

CompanyService Datatypes

Back to CompanyService

Company

PropertyTypeDescription
APIExceptionAPIExceptionUsed to inform you of errors when using the API (for instance, a save error). Not a specifiable return property.
IdInt32
ExternalIdString
OrganizationNumberStringMax length 20 characters
NameStringMax length 200 characters
FirstNameStringMax length 50 characters, only in use on Company Type ‘Consumer’
NickNameStringMax length 200 characters
AddressesAddresses
PhoneNumbersPhoneNumbers
EmailAddressesEmailAddresses
UrlStringMax length 255 characters
CountryStringTwo letter country code
NoteStringMax length 1 073 741 823 characters
InvoiceLanguageStringTwo letter country code
TypeEnumNone, Lead (deprecated), Consumer, Business or Supplier
UsernameStringN/A
PasswordStringN/A
IncorporationDateDateTime
DateCreatedDateTime
StatusInt32
PriceListInt32
OwnerInt32
BankAccountNoStringMust be a valid Bank Account Number
BankAccountTypeStringAvailable values: iban, bban, postgiro, bankgiro
BankAccountCountryStringISO 3166 country code
BankAccountBicStringValid BIC Code
TermsOfDeliveryIdInt32
AccountDebitInt16
AccountCreditInt16
DiscountDecimal
TypeGroupInt32
ShareCapitalDecimal
NumberOfEmployeesInt32
TurnoverDecimalNOT IN USE
ProfitDecimalNOT IN USE
IndustryIdInt32
MemberNoInt32
DateChangedDateTime
BlockInvoiceBoolean
RelationsRelation[]
MapsCompanyMap[](ConsumerCompanyNo)
DistributionMethodEnumDefault, Unchanged, Print, EMail, ElectronicInvoice
CurrencyIdStringDefault: LOCAL
PaymentTimeInt16Default (no change): Int16.MinValue
>=1: number of days
0: no credit time
-1: end of month + 30 days
-2: end of month + 60 days
-3: end of month + 90 days
-4: end of month
-5:end of month + 45 days
If the value received is less than -5 and greater than -10.000 is set to "end of month + custom(egendefinert) where you have to subtract the value from 10000 to receive the value. Example: you receive -9940. Then you need to subtract that value from 10000 to get the result of end of month + 60 days.
If the value received is less than -10.000 and greater than -100.000 is set to a fixed Date. The value + 100.000 represent the number of days since epoch. Example: -99999 represents Jan 02 1900 (1 day after epoch), while -79545 represents Jan 01 2026 (20455 days since epoch)
GLNNumberStringDefault value: “”. To set GLNNumber to the value NULL, the value in your request should be set to the string value NULL. Max length 13 characters
FactoringBoolean
LedgerCustomerAccountInt16The account number used for the customer ledger
LedgerSupplierAccountInt16The account number used for the supplier ledger
VatNumberString
PrivateBooleanFalse = "visible to all", true = "visible to owner"
ExplicitlySpecifyNewCompanyIdBooleanSet companyId explicitly

CompanySearchParameters

PropertyTypeDescription
CompanyIdInt32
CompanyIdsInt32[]Submit a list of Company Ids. Limited to 1000 Ids in one request.
ExternalIdString
CompanyNameString
ChangedAfterDateTime
CompanyEmailString
CompanyPhoneString
OrganizationNumberString

ReturnProperties

The return properties consists of an array of Strings. You write in the name of the property you wish to receive on the response from the service. Example below:

<returnProperties>
    <string>Name</string>
    <string>FirstName</string>
    <string>Country</string>
</returnProperties>

APIException

PropertyTypeDescription
TypeStringThe type of error message. Can be: CompanyNotDeleted, CompanyNotSaved, BankAccountException
MessageStringError message
StackTraceStringStacktrace of the error

Relation

PropertyTypeDescription
ContactIdInt32
CompanyIdInt32
FirstNameString
LastNameString
RoleString
RoleIdInt32
PhoneNumbersPhoneNumbers
EmailAddressesEmailAddresses
FaxString

CompanyMap

PropertyTypeDescription
MapTypeInt32You use MapType to specify a type of mapping. This is useful if you are mapping several external Id’s where the ExternalId is not enough.
ExternalIdStringMax length 50 characters
CompanyIdInt32Company Id

Category

PropertyTypeDescription
IdInt32Category Id
NameStringCategory Name
ShowContactBoolean
ShowCompanyBoolean

Group

PropertyTypeDescription
IdInt32
NameString
TypeInt32
MembersGroupMember[]
ChildrenGroup[]

GroupMember

PropertyTypeDescription
IdInt32
RoleNameString
FirstNameString
LastNameString

syncSearchParameters

PropertyTypeDescription
PageInt32The page you want to get. Starting on 1
ActiveboolNot set = get active and inactive Companies
ChangedAfterdateTime
RegisteredAfterdateTime

GetCompanySyncListResult

PropertyTypeDescription
CurrentPagelongThe current page
TotalPageslongTotal number of pages in the result set
TotalItemslongTotal items in the result set
ItemsPerPagelongSet to 1000

SyncCompany

PropertyTypeDescription
CompanyIdInt32
ExternalIdstring
DateChangeddateTime
DateRegistereddateTime
Activebool

Back to CompanyService

Last Updated: 1/7/26, 11:20 AM
Prev
ClientService Datatypes
Next
FileService Datatypes