Company – Reference

This reference page will give you all public API details for retrieving, inserting, updating and deleting data in RecMan.

Read our quickstart guide to learn how to do a basic get, select, insert, update and delete operation in RecMan API.

GET method details

Get is the method for retrieving data. Please visit the GET company page for more information.

URL GET https://api.recman.no/v2/get/
Scope company
Example https://api.recman.no/v2/get/?key=YOUR_KEY&scope=company&fields=name,email
Parameters companyId, companyIds, departmentId, userId

POST method details

The POST method is used for inserting, updating and deleting companies. More information on each operation can be found in the sidebar menu.

URL POST https://api.recman.no/v2/post/
Scope company
Operation insert / update / delete
Fields See details below

Company Fields

Fields Description
companyIdinteger Company IDRequired on operation: update delete
parentCompanyIdinteger Parent company ID
namestring NameRequired on operation: insert
numberstring Company number (if not defined: The system will automatically generate a number)
dunsIdinteger D‑U‑N‑S Number is a unique nine-digit identifier for businesses
vatNumberinteger VAT number
companyNumberstring Company number (POST only)
emailstring Email
webstring Web
officePhonestring Office phone
invoiceEmailstring Invoice email
newsletterboolean Newsletter. No=0 and Yes=1Valid values: 0 1
linkedinstring LinkedIn
facebookstring Facebook
twitterstring Twitter
skypestring Skype
employeeCountinteger Employee count
branchCategoryIdinteger Branch category ID
descriptionstring Description
notesstring Notes
invoiceNotesstring Invoice notes
creditTimeinteger Credit time
createddate-time CreatedFormat: Y-m-d H:i:s
updateddate-time UpdatedFormat: Y-m-d H:i:s
departmentIdsarray of integer Array of department IDsDeparment reference
userIdsarray of integer Array of user IDs
directionsstring Directions
invoiceSendMethodstring Invoice send methodValid values: emailWithTrackingLink emailWithAttachment print ehf
invoiceIntervalstring Invoice interval
invoiceFactorinteger Returns the invoice factor from a company if it's added
creditRatingstring Credit rating
approvedCreditLimitstring Approved credit limit
recommendedCreditLimitstring Recommended credit limit
typestring TypeValid values: customer collaborator supplier prospect suspect competitor freelance terminated ownCompany notApplicable formerCustomer others lostCustomer subcontractor
workUnitPeriodTypestring Work unit period typeValid values: monthly cutoffFriday cutoffSunday
projectDataarray of strings Returns the info of the project data on a company card
addresses (multiple, see lis)object See fields below
attributesobject See fields below
fileobject See fields below
eInvoiceobject See fields below
salaryMatrixCategoryobject See fields below
naceobject See fields below

Addresses fields

Field
visitAddressobject
postAddressobject
invoiceAddressobject
deliveryAddressobject
Sub Fields Description
address1string Address 1
address2string Address 2
postalCodestring Postal Code
citystring City
countrystring Country
View JSON example
JSON
{
  "key": "YOUR_KEY",
  "scope": "company",
  "operation": "insert",
  "data": {
    "name": "RecMan AS",
    "visitAddress": {
      "address1": "Karenslyst Allé 10",
      "address2": "2st floor",
      "postalCode": "0278",
      "city": "Oslo",
      "country": "Norway"
    }
  }
}

File fields

Field
fileobject
Sub Fields Description
fileIdinteger Required on operation: delete
namestring File name, must include extensionRequired on operation: insert
extensionstring File ExtensionRequired on operation: insert
base64string Base64 encoded fileRequired on operation: insert

Attribute fields

Field
attributesobject
Sub Fields Description
attributeIdstring The ID of attributeRequired on operation: insert
companyAttributeIdstring The ID of the attribute on companyRequired on operation: update delete
ratinginteger Valid values: 1 2 3 4 5
checkboxIdsarray of integer Checkbox Ids, or to include rating use an array with the key 'id' and 'rating'. Like array('id'=>387','rating'=>4)
dropdownIdinteger Download Id
textstring Text
boolboolean Boolean ValueValid values: 0 1

eInvoice fields

Field
eInvoiceobject
Sub Fields Description
companyNumberstring Company number
invoiceNamestring Invoice Name
referencestring Reference

Company Contact – Reference

URL GET https://api.recman.no/v2/get/
Scope companyContact
Example https://api.recman.no/v2/get/?key=YOUR_KEY&scope=companyContact&fields=name,email
URL https://api.recman.no/v2/post/
Scope companyContact
Operations insert / update / delete
Fields See details below

Company Contact Fields

Fields Description
companyContactIdstring Company Contact IDRequired on operation: update delete
companyIdinteger Company IDRequired on operation: insert
namestring Name
emailstring Email
mobilePhonestring Mobile phone
officePhonestring Office phone
homePhonestring Home phone
notesstring Notes
newsletterboolean Newsletter. No=0 and Yes=1Valid values: 0 1
activeboolean Active. No=0 and Yes=1Valid values: 0 1
twitterstring Twitter
linkedinstring LinkedIn
facebookstring Facebook
skypestring Skype
updateddate-time UpdatedFormat: Y-m-d H:i:s
createddate-time CreatedFormat: Y-m-d H:i:s
profilePicturestring Profile picture
attributesobject See fields below
userIdsarray of integer A list of responsible users

Company Contact Attribute fields

Field
attributesobject
Sub Fields Description
attributeIdinteger The ID of AttributeRequired on operation: insert
companyContactAttributeIdinteger The ID of inserted attributeRequired on operation: update delete
ratinginteger RatingValid values: 1 2 3 4 5
boolstring True / False - 0 = False, True = 1Valid values: 0 1
textstring Text, limited to 255 characters.
dropdownIdinteger The ID of dropdown value
checkboxIdsarray of integer Array of checked IDs

Salary Matrix Category fields

Field
salaryMatrixCategoryobject
Sub Fields Description
salaryMatrixCategoryIdstring
salaryCalculationstring
salarystring
invoiceCalculationstring
invoicestring
invoiceAdditionstring
invoiceFactorstring

NACE fields

Fields Description
codestring NACE code
descriptionstring Description of the NACE code

Company Tags

Allows you to view, add or remove tags from a company.

Company Tags

Tag ID can be found here.

Fields Description
companyIdinteger Company IDRequired on operation: get insert delete
tagIdinteger Tag ID. Required on operation: get update delete