API Field Directory - CompaniesFields available via the API for Company records, with required formatting.
Field Name
Format
Example
Description
UserId *
String
"USER_10"
The Colleague 7 User ID (mandatory)
CompanyId
int32
"1"
Unique ID of the Company record
CompanyName *
String
"Colleague Software"
Name of the Company
Searchname
String
"ColleagueSoftware"
Company name search key
FullName
String
"ColleagueSoftware"
Full name of the Company
EntityDescription
String
"Colleague Software"
Summary description of the record
CompanyType
String/Lookup
"Supplier"
Company Type lookup
IndustryCode
String/Lookup
"IT" or lookup code
Industry lookup description or code
IndustryCodeLookups
String
"IDENG,IT,SOFTWAREIC"
Industry lookup codes, comma separated
RegistrationNumber
String
"CSL12345"
Company registration number
VatNumber
String
"GB 123 45 6"
VAT number of the Company
EmployeeCount
int32
"25"
Number of employees
Turnover
Decimal
"250000.0"
Annual turnover
CompanyEmail
String
"support@colleaguesoftware.com"
Email address of the Company
WebAddress
String
"http://www.colleaguesoftware.com"
Website address of the Company
TelephoneNumber
String
"01603 735935"
Telephone number of the Company
FaxNumber
String
"01603 735935"
Fax number of the Company
AllNumbers
String
"~01603735935~"
All phone numbers, tilde separated
MailshotStatus
String/Lookup
"Allow All"
Mailshot status
MailshotExpiry
date-time
"2026-08-01 00:00:00.000"
Date the mailshot status expires
ParentCompanyId
int32
"0"
ID of the parent Company record
ParentCompany
String
null
Name of the parent Company
PreviousRequirement
Boolean (0/1)
"1"
Company has had previous requirements
PreviousPlacement
Boolean (0/1)
"1"
Company has had previous placements
LiveRequirements
int32
"73"
Number of live requirements
ForwardInterviews
int32
"0"
Number of upcoming interviews
NumberofContacts
int32
"10"
Number of Contacts linked to the Company
SkillCount
int32
"42"
Number of skills held against the Company
ReferenceChecked
Boolean (0/1)
"1"
Company references have been checked
ReferenceCheckedBy
String
"USER_8"
User who checked the references
DateReferenceChecked
date (dd MMM yyyy)
"07 Apr 2026"
Date the references were checked
OwnerId
int32
"1"
ID of the record owner
OwnedBy
String
"Ben Ryder, Brett Cole"
Users who own the record
DateOwned
date (dd MMM yyyy)
null
Date the current ownership began
DateCreated
date-time
"2009-05-19 13:30:42.000"
Date the record was created
CreatedBy
String
"DemoConsultant"
User who created the record
DateAmended
date-time
"2026-09-30 10:43:35.630"
Date the record was last amended
AmendedBy
String
"David Demo"
User who last amended the record
LastContacted
date-time
"2026-09-28 10:45:38.123"
Date the Company was last contacted
ArchivedDate
date-time
null
Date the record was archived
ArchivedBy
String
null
User who archived the record
NoteId
int32
"3252"
ID of the notes held against the record
Alert
String
""
Alert flag text
AlertText
String
""
Alert text shown on the record
ImportedRecord
Boolean (0/1)
"0"
Record was created by an import
FullContactXML
String
null
FullContact enrichment data
FullContactXMLLastUpdatedDate
date-time
null
Date the FullContact data was last updated
PrimaryAddress
String
"The Control Tower Witchcraft Way Rackheath Norwich NR13 6GA"
Primary address as a single line
AddressId
int32
"2575"
ID of the primary address
AddressType
int32
"1"
Address type code
AddressDesc
String
"Branch"
Address description
AddressLine1
String
"The Control Tower"
First line of address
AddressLine2
String
"Witchcraft Way"
Second line of address
AddressLine3
String
"Rackheath"
Third line of address
City
String
"Norwich"
Town of address
County
String
"Norfolk"
County of address
Postcode
String
"NR13 6GA"
Postcode of address
PostcodePrefix
String
"NR136GA"
Postcode with spaces removed
Country
String/Lookup
"United Kingdom" or lookup code
Country of address
CountryDescription
String
"United Kingdom"
Country lookup description
PrimaryFlag
Boolean (0/1)
"1"
Address is the primary address
AddressDateCreated
date-time
"2017-02-17 09:03:58.030"
Date the address was created
AddressCreatedBy
String
"John Smith"
User who created the address
AddressDateAmended
date-time
"2026-05-21 12:12:37.273"
Date the address was last amended
AddressAmendedBy
String
"David Demo"
User who last amended the address
AddressTaxCode
String
null
Tax code held against the address
AddressVatNumber
String
null
VAT number held against the address
AddressCreditLimit
Decimal
"0.0"
Credit limit held against the address
AddressInsuredCreditLimit
Decimal
"0.0"
Insured credit limit held against the address
AddressLink
String
HTML link to Google Maps
Link to view the address location
AllAddresses
String
"|The Control Tower Witchcraft Way...|"
All addresses, pipe separated
AddressLine1All
String
"|The Control Tower|Unit 3D...|"
First line of every address, pipe separated
AddressLine2All
String
"|Witchcraft Way|Vinnetrow Road|"
Second line of every address, pipe separated
AddressLine3All
String
"|Rackheath|"
Third line of every address, pipe separated
CityAll
String
"|Norwich|Chichester|"
Town of every address, pipe separated
CountyAll
String
"|Norfolk|West Sussex|"
County of every address, pipe separated
PostcodeAll
String
"|NR13 6GA|PO20 1QH|"
Postcode of every address, pipe separated
AccountReference
String
"ACCREF5566"
Account reference
InvoiceAddress
Boolean (0/1)
"1"
Address is an invoice address
InvoiceAddressId
int32
"2575"
ID of the invoice address
InvoiceCompany
String
"Colleague Software"
Company invoices are sent to
InvoiceCompanyId
int32
"1"
ID of the invoice Company
InvoiceContact
String
"Mike Granger"
Contact invoices are sent to
InvoiceContactId
int32
"2"
ID of the invoice Contact
AdditionalInvoiceContacts
String
null
Additional Contacts that receive invoices
InvoiceMethod
String/Lookup
"Company/Candidate"
Invoice method
InvoiceFrequency
String/Lookup
"Monthly"
Invoice frequency
InvoicePeriod
int32
"0"
Invoice period code
InvoiceIdPrefix
int32
"0"
Invoice number prefix
NextInvoiceId
int32
"0"
Next invoice number
PaymentTerms
String/Lookup
"30 Days"
Payment terms
PaymentMethod
String/Lookup
"BACS"
Payment method
PaymentFrequency
String/Lookup
null
Payment frequency
TaxCode
String
"20"
Tax code
CreditLimit
Decimal
"0.0"
Credit limit
InsuredCreditLimit
Decimal
"0.0"
Insured credit limit
AllowSelfBilling
Boolean (0/1)
"1"
Self billing is allowed
MarginOnly
Boolean (0/1)
"0"
Company is billed on margin only
PurchaseOrderCheckValue
int32
"0"
Purchase order check value
TimesheetMethod
String/Lookup
null
Timesheet method
DefaultTimesheetStatus
int32
"0"
Default timesheet status code
AuthorisationLevel
int32
"0"
Authorisation level
PAYECalculatorOption
String
null
PAYE calculator option
* Mandatory field.
|