Entities and Endpoints

Api Log

ApiLog - stores the request/result call for debugging but also for the safety guard

APIDescription
GET api/ApiLog

Retrieves all the api logs

GET api/ApiLog(id)

Retrieves a api log with the specified key

POST api/ApiLog

Creates a new api log object

DELETE api/ApiLog(id)

Deletes the api_log with the specified key

Article

Articles (=products, parts, materials). Used for Sales and Services

APIDescription
GET api/Article

Retrieves all the articles

GET api/Article(id)

Retrieves the article with the specified key

POST api/Article

Creates a new article

PUT api/Article(id)

Updates the article with the specified key

Article Category

Used to organize the articles in a hierarchical tree. Each article can only be linked to 1 category (Sales,Services).

APIDescription
GET api/ArticleCategory

Retrieves all the article categories

GET api/ArticleCategory(id)

Retrieves the article category with the specified key

POST api/ArticleCategory

Creates a new article category

PUT api/ArticleCategory(id)

Updates the article category with the specified key

DELETE api/ArticleCategory(id)

Deletes the article category with the specified key

Article Group1

Group 1. Used to organize the articles in a non-hierarchical way (Sales,Services). Each article needs to be assigned to one item of each of the activated article groups . Article groups can be Material, Size, Colour,...

APIDescription
GET api/ArticleGroup1

Retrieves all items of article group 1

GET api/ArticleGroup1(id)

Retrieves the item of article group 1 with the specified key

POST api/ArticleGroup1

Creates a new item within article group 1

PUT api/ArticleGroup1(id)

Updates the item of article group 1 with the specified key

DELETE api/ArticleGroup1(id)

Deletes the item of article group 1 with the specified key

Article Group2

Group 2. Used to organize the articles in a non-hierarchical way (Sales,Services). Each article needs to be assigned to one item of each of the activated article groups . Article groups can be Material, Size, Colour,...

APIDescription
GET api/ArticleGroup2

Retrieves all items of article group 2

GET api/ArticleGroup2(id)

Retrieves the item of article group 2 with the specified key

POST api/ArticleGroup2

Creates a new item within article group 2

PUT api/ArticleGroup2(id)

Updates the item of article group 2 with the specified key

DELETE api/ArticleGroup2(id)

Deletes the item of article group 2 with the specified key

Article Group3

Group 3. Used to organize the articles in a non-hierarchical way (Sales,Services). Each article needs to be assigned to one item of each of the activated article groups . Article groups can be Material, Size, Colour,...

APIDescription
GET api/ArticleGroup3

Retrieves all items of article group 3

GET api/ArticleGroup3(id)

Retrieves the item of article group 3 with the specified key

POST api/ArticleGroup3

Creates a new item within article group 3

PUT api/ArticleGroup3(id)

Updates the item of article group 3 with the specified key

DELETE api/ArticleGroup3(id)

Deletes the item of article group 3 with the specified key

Article Group4

Group 4. Used to organize the articles in a non-hierarchical way (Sales,Services). Each article needs to be assigned to one item of each of the activated article groups . Article groups can be Material, Size, Colour,...

APIDescription
GET api/ArticleGroup4

Retrieves all items of article group 4

GET api/ArticleGroup4(id)

Retrieves the item of article group 4 with the specified key

POST api/ArticleGroup4

Creates a new item within article group 4

PUT api/ArticleGroup4(id)

Updates the item of article group 4 with the specified key

DELETE api/ArticleGroup4(id)

Deletes the item of article group 4 with the specified key

Article Group5

Group 5. Used to organize the articles in a non-hierarchical way (Sales,Services). Each article needs to be assigned to one item of each of the activated article groups . Article groups can be Material, Size, Colour,...

APIDescription
GET api/ArticleGroup5

Retrieves all items of article group 5

GET api/ArticleGroup5(id)

Retrieves the item of article group 5 with the specified key

POST api/ArticleGroup5

Creates a new item within article group 5

PUT api/ArticleGroup5(id)

Updates the item of article group 5 with the specified key

DELETE api/ArticleGroup5(id)

Deletes the item of article group 5 with the specified key

Article Group6

Group 6. Used to organize the articles in a non-hierarchical way (Sales,Services). Each article needs to be assigned to one item of each of the activated article groups . Article groups can be Material, Size, Colour,...

APIDescription
GET api/ArticleGroup6

Retrieves all items of article group 6

GET api/ArticleGroup6(id)

Retrieves the item of article group 6 with the specified key

POST api/ArticleGroup6

Creates a new item within article group 6

PUT api/ArticleGroup6(id)

Updates the item of article group 6 with the specified key

DELETE api/ArticleGroup6(id)

Deletes the item of article group 6 with the specified key

Article Stock Location

Article Stock Location (if you are working with different stock location and not a central stock (article.physical_stock)

APIDescription
GET api/ArticleStockLocation

Retrieves all the article stock location

GET api/ArticleStockLocation(id)

Retrieves the article stock location with the specified key

POST api/ArticleStockLocation

Creates a new article stock location

PUT api/ArticleStockLocation(id)

Updates the article stock location with the specified key

Article Stock Location List

Article Stock Location List (stock value for this stock for this article)

APIDescription
GET api/ArticleStockLocationList

Retrieves all the article stock location lists

GET api/ArticleStockLocationList(id)

Retrieves the article stock location list with the specified key

POST api/ArticleStockLocationList

Creates a new article stock location list

PUT api/ArticleStockLocationList(id)

Updates the article stock location list with the specified key

DELETE api/ArticleStockLocationList(id)

Deletes the article stock location list object with the specified key

Cars (If you whish to store the car travel)

APIDescription
GET api/Car

Retrieves all the cars

GET api/Car(id)

Retrieves a car with the specified key

POST api/Car

Creates a new car

PUT api/Car(id)

Updates the car with the specified key

DELETE api/Car(id)

Deletes the car object with the specified key

Car Travel

Car Travel . Used to place car travel

APIDescription
GET api/CarTravel

Retrieves all the car travels

GET api/CarTravel(id)

Retrieves a car travel with the specified key

Company

Companies (clients, supliers, debtors). Used for Sales and Services

APIDescription
GET api/Company

Retrieves all the companies

GET api/Company(id)

Retrieves the company with the specified key

POST api/Company

Creates a new company

PUT api/Company(id)

Updates the company with the specified key

Company Sales Territory List

Used to link company to more than one territory (main territory is on company.sales_territory_id)

APIDescription
GET api/CompanySalesTerritoryList

Retrieves all the company_sales_territory_list objects

GET api/CompanySalesTerritoryList(id)

Retrieves the company_sales_territory_list object with the specified key

POST api/CompanySalesTerritoryList

Creates a new company_sales_territory_list object

PUT api/CompanySalesTerritoryList(id)

Updates the company_sales_territory_list object with the specified key

DELETE api/CompanySalesTerritoryList(id)

Deletes the company_sales_territory_list object with the specified key

Company Type

Company Type. Allows you to add a specification to you clients, suppliers and debtors

APIDescription
GET api/CompanyType

Retrieves all the type

GET api/CompanyType(id)

Retrieves the type with the specified key

POST api/CompanyType

Creates a new type

PUT api/CompanyType(id)

Updates the type with the specified key

DELETE api/CompanyType(id)

Deletes the type with the specified key

Contact

Contacts

APIDescription
GET api/Contact

Retrieves all the contacts

GET api/Contact(id)

Retrieves the contact with the specified key

POST api/Contact

Creates a new contact object

PUT api/Contact(id)

Updates the contact with the specified key

Contract

Contract

APIDescription
GET api/Contract

Retrieves all the contracts

GET api/Contract(id)

Retrieves the Contract with the specified key

POST api/Contract

Creates a new Contract object

PUT api/Contract(id)

Updates the Contract with the specified key

Country

Countries using ISO 3166

APIDescription
GET api/Country

Retrieves all countries

GET api/Country(id)

Retrieves the country with the specified key

Db Address

Addresses of companies. Project can use the default company address or a specific one

APIDescription
GET api/DbAddress

Retrieves all db_address

GET api/DbAddress(id)

Retrieves the db_address with the specified key

POST api/DbAddress

Create a a new db_address usable for a company

PUT api/DbAddress(id)

Updates the work order type with the specified key

Db File

File (Document Manager,Linked files or files generated)

APIDescription
POST api/DbFile/Add?db_table_id={db_table_id}&id_in_table={id_in_table}&description={description}

Uses to upload files to a entity (like a task)

GET api/DbFile/GetFileContent/{id}

Get the content of the file

GET api/DbFile

Retrieves all db_file

GET api/DbFile(id)

Retrieves the db_file with the specified key

POST api/DbFile

Creates a new db_file by supplying directly the field db_file.file_content as Byte Array

PUT api/DbFile(id)

Update a db_file by supplying directly the field db_file.file_content as Byte Array

DELETE api/DbFile(id)

Deletes the global db_file object (or files linked to entity but not JobApprovalPDF/OrderPDF/PurchaseOrderPDF) with the specified key

Db File Folder

Add files to a task

APIDescription
GET api/DbFileFolder

No documentation available.

GET api/DbFileFolder(id)

No documentation available.

POST api/DbFileFolder

No documentation available.

PUT api/DbFileFolder(id)

No documentation available.

DELETE api/DbFileFolder(id)

No documentation available.

Db Info

Chapters of the info fields (See "Info Fields" help guide for more information)

APIDescription
GET api/DbInfo

Retrieves all objects db_info that belongs to a static category (like Company,Project,...)

GET api/DbInfo(id)

Retrieves an object of the specified key if belongs to a static category (like Company,Project,...)

POST api/DbInfo

Creates a new object that belongs to a static category (like Company,Project,...)

PUT api/DbInfo(id)

Updates the modifications done on the object that belongs to a static category (like Company,Project,...)

DELETE api/DbInfo(id)

Deletes the object of the specified key

Db Info Data

Values of the info fields (See "Info Fields" help guide for more information)

APIDescription
GET api/DbInfoData

Retrieves all the db_info_data objects

GET api/DbInfoData(id)

Retrieves the db_info_data object with the specified key

POST api/DbInfoData

Creates a new db_info_data object

PUT api/DbInfoData(id)

Updates the db_info_data object with the specified key ///

DELETE api/DbInfoData(id)

Deletes the db_info_data object with the specified key

Db Info Field

Info fields (See "Info Fields" help guide for more information)

APIDescription
GET api/DbInfoField

Retrieves all items

GET api/DbInfoField(id)

Retrieves the item with the specified key

POST api/DbInfoField

Creates a new item

PUT api/DbInfoField(id)

Updates the item with the specified key

DELETE api/DbInfoField(id)

Deletes the item with the specified key

Db Info Field Property

Items for certain types of info fields (like ComboBox,SelectBox or RadioButton - See "Info Fields" help guide for more information)

APIDescription
GET api/DbInfoFieldProperty

Retrieves all items

GET api/DbInfoFieldProperty(id)

Retrieves the item with the specified key

POST api/DbInfoFieldProperty

Creates a new item

PUT api/DbInfoFieldProperty(id)

Updates the item with the specified key

DELETE api/DbInfoFieldProperty(id)

Deletes the item with the specified key

Db Notes

Notes which can be linked to some object (Company/Jobs/Project/Task)

APIDescription
GET api/DbNotes

Retrieves all db notes

GET api/DbNotes(id)

Retrieves the db note with the specified key

POST api/DbNotes

Create a new db note

PUT api/DbNotes(id)

Updates the db note with the specified key

DELETE api/DbNotes(id)

Deletes the db note with the specified key

Db Report

Reports (based on InfoField system) used on WorkOrderReport and Visit Report (See "Db Report" help guide for more information)

APIDescription
GET api/DbReport

Retrieves all db Reports

GET api/DbReport(id)

Retrieves the db report with the specified key

POST api/DbReport

Creates a new db report

PUT api/DbReport(id)

Updates the db report with the specified key

DELETE api/DbReport(id)

Deletes the db report with the specified key

Equipment Brand

Equipment Brand

APIDescription
GET api/EquipmentBrand

Retrieves all the equipment_brand objects

GET api/EquipmentBrand(id)

Retrieves the equipment_brand object with the specified key

POST api/EquipmentBrand

Creates a new equipment_brand object

PUT api/EquipmentBrand(id)

Updates the equipment_brand object with the specified key

DELETE api/EquipmentBrand(id)

Deletes the equipment_brand object with the specified key

Equipment Family

Project types

APIDescription
GET api/EquipmentFamily

Retrieves all the equipment_family objects

GET api/EquipmentFamily(id)

Retrieves the equipment_family object with the specified key

POST api/EquipmentFamily

Creates a new equipment_family object

PUT api/EquipmentFamily(id)

Updates the equipment_family object with the specified key

DELETE api/EquipmentFamily(id)

Deletes the equipment_family object with the specified key

Equipment Model

Equipment Model

APIDescription
GET api/EquipmentModel

Retrieves all the equipment_model objects

GET api/EquipmentModel(id)

Retrieves the equipment_model object with the specified key

POST api/EquipmentModel

Creates a new equipment_model object

PUT api/EquipmentModel(id)

Updates the equipment_model object with the specified key

DELETE api/EquipmentModel(id)

Deletes the equipment_model object with the specified key

Fee List

FeeList (Services). Used to configure the price for invoicable timesheets

APIDescription
GET api/FeeList

Retrieves all the fee lists

GET api/FeeList(id)

Retrieves the fee list with the specified key

POST api/FeeList

Creates a new fee list object

PUT api/FeeList(id)

Updates the fee list with the specified key

Fee List Price

FeeList Price (Services). Contains the Matrix of price (rules) for invoicable timesheets

APIDescription
GET api/FeeListPrice

Retrieves all the fee list prices

GET api/FeeListPrice(id)

Retrieves the fee list price with the specified key

POST api/FeeListPrice

Creates a new fee list price object

PUT api/FeeListPrice(id)

Updates the fee list price with the specified key

Hour Type

Hour Type. Used by CarTravel/UserTimesheet to generate the invoicable timesheets (Job Non Part Usage)

APIDescription
GET api/HourType

Retrieves all the hour_type objects

GET api/HourType(id)

Retrieves the hour_type object with the specified key

POST api/HourType

Creates a new hour_type object

PUT api/HourType(id)

Updates the hour_type object with the specified key

DELETE api/HourType(id)

Deletes the hour_type object with the specified key

Hour Type Group

Group of Hour Type

APIDescription
GET api/HourTypeGroup

Retrieves all the hour_type_group objects

GET api/HourTypeGroup(id)

Retrieves the hour_type_group object with the specified key

POST api/HourTypeGroup

Creates a new hour_type_group object

PUT api/HourTypeGroup(id)

Updates the hour_type_group object with the specified key

DELETE api/HourTypeGroup(id)

Deletes the hour_type_group object with the specified key

Job Approval

Contains all information about the Dialy or full work order approvals

APIDescription
GET api/JobApproval

Retrieves all the job approvals

GET api/JobApproval(id)

Retrieves the job approval with the specified key

Job Estimated Quantity

Estimation of parts that should be used during a work order (including quantities)

APIDescription
GET api/JobEstimatedQuantity

Retrieves all the job_estimated_quantity objects

GET api/JobEstimatedQuantity(id)

Retrieves the job_estimated_quantity with the specified key

POST api/JobEstimatedQuantity

Creates a new job_estimated_quantity object

PUT api/JobEstimatedQuantity(id)

Updates the job_estimated_quantity object with the specified key

DELETE api/JobEstimatedQuantity(id)

Deletes the job_estimated_quantity object with the specified key

Job Non Part Usage

Invoicable timesheets and car travels for a work order

APIDescription
GET api/JobNonPartUsage

Retrieves all the job_non_part_usage objects

GET api/JobNonPartUsage(id)

Retrieves the job_non_part_usage object with the specified key

Job Part Usage

Parts (=article, materials) used to complete the work order

APIDescription
GET api/JobPartUsage

Retrieves all used parts

GET api/JobPartUsage(id)

Retrieves the used part with the specified key

Job Priority

Priorities (High, Critical, low) used to describe work orders

APIDescription
GET api/JobPriority

Retrieves all the job_priority objects

GET api/JobPriority(id)

Retrieves the job_priority object with the specified key

POST api/JobPriority

Creates a new job_priority object

PUT api/JobPriority(id)

Updates the job_priority object with the specified key

DELETE api/JobPriority(id)

Deletes the job_priority object with the specified key

Work orders Main object

APIDescription
GET api/Jobs

Retrieves all the work orders

GET api/Jobs(id)

Retrieves the work order with the specified key

POST api/Jobs

Creates a new work order

PUT api/Jobs(id)

Updates the work order with the specified key

DELETE api/Jobs(id)

Deletes the work order with the specified key

Job Type

Work order Types (E.g. Maintenance, Intervention, inspection)

APIDescription
GET api/JobType

Retrieves all work order types

GET api/JobType(id)

Retrieves the work order type with the specified key

POST api/JobType

Creates a new work order type

PUT api/JobType(id)

Updates the work order type with the specified key

DELETE api/JobType(id)

Deletes the work order type with the specified key

Language

Language (used in company, contact, user) using ISO 639-1

APIDescription
GET api/Language

Retrieves all languages

GET api/Language(id)

Retrieves the language with the specified key

Marketing Segment

Marketing Segment. Define in which segment belongs the companies

APIDescription
GET api/MarketingSegment

Retrieves all the type

GET api/MarketingSegment(id)

Retrieves the type with the specified key

POST api/MarketingSegment

Creates a new type

PUT api/MarketingSegment(id)

Updates the type with the specified key ///

DELETE api/MarketingSegment(id)

Deletes the type with the specified key

Project

Projects (Equipments, Installation)

APIDescription
GET api/Project

Retrieves all the projects

GET api/Project(id)

Retrieves the project with the specified key

POST api/Project

Creates a new project

PUT api/Project(id)

Updates the project with the specified key

DELETE api/Project(id)

Deletes the project with the specified key

Project Status

Project Statuses. (E.g. Set up, in production, out of order)

APIDescription
GET api/ProjectStatus

Retrieves project statuses

GET api/ProjectStatus(id)

Retrieves the project status with the specified key

POST api/ProjectStatus

Creates a new project status

PUT api/ProjectStatus(id)

Updates the project status with the specified key

DELETE api/ProjectStatus(id)

Deletes the project status with the specified key

Purchase Order

Purchase Order header of articles on Work orders

APIDescription
GET api/PurchaseOrder

Retrieves all the purchase orders

GET api/PurchaseOrder(id)

Retrieves the purchase order with the specified key

POST api/PurchaseOrder

Creates a new purchase order

PUT api/PurchaseOrder(id)

Updates the purchase order with the specified key

DELETE api/PurchaseOrder(id)

Deletes the purchase order with the specified key

Purchase Order Details

Order lines of the Purchase orders

APIDescription
GET api/PurchaseOrderDetails

Retrieves all the purchase order order lines

GET api/PurchaseOrderDetails(id)

Retrieves the purchase order order lines with the specified key

POST api/PurchaseOrderDetails

Creates a new purchase order order line

PUT api/PurchaseOrderDetails(id)

Updates the purchase order order lines with the specified key

DELETE api/PurchaseOrderDetails(id)

Deletes the purchase order order lines with the specified key

Sales Organization

Sales / Service Organizations

APIDescription
GET api/SalesOrganization

Retrieves all organizations

GET api/SalesOrganization(id)

Retrieves organization with the specified key

POST api/SalesOrganization

Creates a new organization

PUT api/SalesOrganization(id)

Updates the organization with the specified key ///

DELETE api/SalesOrganization(id)

Deletes the organization with the specified key

Sales Territory

Territories. Sub division of the Organizations

APIDescription
GET api/SalesTerritory

Retrieves all territories

GET api/SalesTerritory(id)

Retrieves the territory with the specified key

POST api/SalesTerritory

Creates a new territory

PUT api/SalesTerritory(id)

Updates the territory with the specified key ///

DELETE api/SalesTerritory(id)

Deletes the territory with the specified key

Skills, can be required to perform a Work order. Users can have 0 to N skills.

APIDescription
GET api/Skill

Retrieves all skills

GET api/Skill(id)

Retrieves the skill with the specified key

POST api/Skill

Creates a new skill

PUT api/Skill(id)

Updates the skill with the specified key

DELETE api/Skill(id)

Deletes the skill with the specified key

Task. Used for Sales and Services

APIDescription
GET api/Task

Retrieves all the tasks

GET api/Task(id)

Retrieves the task with the specified key

POST api/Task

Creates a new task

PUT api/Task(id)

Updates the task with the specified key

Task Priority

Task Priorities (E.g. Low,Medium,High,Urgent)

APIDescription
GET api/TaskPriority

Retrieves all task priorities

GET api/TaskPriority(id)

Retrieves the task priority with the specified key

POST api/TaskPriority

Creates a new task priority

PUT api/TaskPriority(id)

Updates the task priority with the specified key

DELETE api/TaskPriority(id)

Deletes the task priority with the specified key

Task Status

Task Status (E.g. InProgress,Closed)

APIDescription
GET api/TaskStatus

Retrieves all task status

GET api/TaskStatus(id)

Retrieves the task status with the specified key

POST api/TaskStatus

Creates a new task status

PUT api/TaskStatus(id)

Updates the task status with the specified key

DELETE api/TaskStatus(id)

Deletes the task status with the specified key

Task Type

Task Types (E.g. Call, Prepare Document)

APIDescription
GET api/TaskType

Retrieves all task types

GET api/TaskType(id)

Retrieves the task type with the specified key

POST api/TaskType

Creates a new task type

PUT api/TaskType(id)

Updates the task type with the specified key

DELETE api/TaskType(id)

Deletes the task type with the specified key

Users,Technicians,Sales People, Managers

APIDescription
GET api/User

Retrieves all users

GET api/User(id)

Retrieves the user with the specified key

POST api/User

Creates a new user

PUT api/User(id)

Updates the user with the specified key

User Sales Organization List

Used to link users to Organization

APIDescription
GET api/UserSalesOrganizationList

Retrieves all the user_sales_organization_list objects

GET api/UserSalesOrganizationList(id)

Retrieves the user_sales_organization_list object with the specified key

POST api/UserSalesOrganizationList

Creates a new user_sales_organization_list object

PUT api/UserSalesOrganizationList(id)

Updates the user_sales_organization_list object with the specified key

DELETE api/UserSalesOrganizationList(id)

Deletes the user_sales_organization_list object with the specified key

User Sales Territory List

Used to link users to Territories

APIDescription
GET api/UserSalesTerritoryList

Retrieves all the user_sales_territory_list objects

GET api/UserSalesTerritoryList(id)

Retrieves the user_sales_territory_list object with the specified key

POST api/UserSalesTerritoryList

Creates a new user_sales_territory_list object

PUT api/UserSalesTerritoryList(id)

Updates the user_sales_territory_list object with the specified key

DELETE api/UserSalesTerritoryList(id)

Deletes the user_sales_territory_list object with the specified key

User Skill List

Used to link users to skills

APIDescription
GET api/UserSkillList

Retrieves all the user_skill_list objects

GET api/UserSkillList(id)

Retrieves the user_skill_list object with the specified key

POST api/UserSkillList

Creates a new user_skill_list object

PUT api/UserSkillList(id)

Updates the user_skill_list object with the specified key

DELETE api/UserSkillList(id)

Deletes the user_skill_list object with the specified key

User Timesheet

User timesheet

APIDescription
GET api/UserTimesheet

Retrieves all the user timesheet

GET api/UserTimesheet(id)

Retrieves a user timesheet with the specified key

User Unavailability

User Unavailabilities (ill, holidays,...)

APIDescription
GET api/UserUnavailability

Retrieves all unavailabilities

GET api/UserUnavailability(id)

Retrieves the unavailability with the specified key

POST api/UserUnavailability

Creates a new unavailability

PUT api/UserUnavailability(id)

Updates the unavailability with the specified key

DELETE api/UserUnavailability(id)

Deletes the unavailability with the specified key

User Unavailability Type

Types of user unavailabilities

APIDescription
GET api/UserUnavailabilityType

Retrieves all unavailability types

GET api/UserUnavailabilityType(id)

Retrieves the unavailability type with the specified key

POST api/UserUnavailabilityType

Creates a new unavailability type

PUT api/UserUnavailabilityType(id)

Updates the unavailability type with the specified key

DELETE api/UserUnavailabilityType(id)

Deletes the unavailability type with the specified key

User Week Approval

User Week Approval

APIDescription
GET api/UserWeekApproval

Retrieves all the user week approval

GET api/UserWeekApproval(id)

Retrieves a user week approval with the specified key