CMO Control Management Organizer
2.16
66
API Server

auth

2
GET

auth/login

REFERENCE

Login into system using operator. Creates a session token, to be used in all subsequent calls.

PARAMETERS
username string A valid username.
password password Password
Call Resource
/
auth
/
login.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
401 unauthorized
404 not found
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

auth/logout

REFERENCE

Logout from system and destroy the session token.

PARAMETERS
token string session token
Call Resource
/
auth
/
logout.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php

customers

8
GET

customers/addcustomer

REFERENCE

Add new customer with minimal data

PARAMETERS
token string session token
company string company name
vatcode string company vat code
phone string phone number
fax string fax phone number
address string address
zipcode string zip code address
city string city address
province string province code address
country string country code address
language string language code iso2
fname string first name
lname string last name
fiscalcode string fiscal code
gender string gender type (M or F)
birthday string birthday date (YYYY-MM-DD)
email string email address
email_pec string pec email address
privacy string privacy accept (0/1)
privacydt string date privact accept (YYYY-MM-DD)
Call Resource
/
leads
/
addcustomer.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
402 token not valid
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php

Moreover, in order for the insertion to be successful, the "phone" and "email" pair must be unique in the database.
result:status = 'added' indicates that the name has been added correctly.
result:status = 'duplicate' indicates that the name was not added because it is duplicated by email or phone.
result:status = 'error' indicates that the name was not added because an error occurred, whose detail is contained in result:error.
GET

customers/checkbyfcode

REFERENCE

Check exists customer entry by fiscal code.

PARAMETERS
token string session token
fcode string fiscal code unique
Call Resource
/
customers
/
checkbyfcode.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
406 item not valid (blacklisted)
407 item not valid (error-tag)
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

customers/checkbyvat

REFERENCE

Check exists customer entry by vat code.

PARAMETERS
token string session token
vatcode string vat unique code
Call Resource
/
customers
/
checkbyvat.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
406 item not valid (blacklisted)
407 item not valid (error-tag)
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

customers/loadbyfcode

REFERENCE

Get customer by fiscal code

PARAMETERS
token string session token
fcode string fiscal code unique
Call Resource
/
customers
/
loadbyfcode.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

customers/loadbyid

REFERENCE

Get customer by ID

PARAMETERS
token string session token
id integer customer ID
Call Resource
/
customers
/
loadbyid.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

customers/loadbyname

REFERENCE

Get customer by COMPANY-NAME

PARAMETERS
token string session token
company string company name
fname string first name (alternative to the company name)
lname string last name (alternative to the company name)
Call Resource
/
customers
/
loadbyname.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

customers/loadbyvatcode

REFERENCE

Get customer by VAT CODE

PARAMETERS
token string session token
vatcode string vat unique code
Call Resource
/
customers
/
loadbyvatcode.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

customers/updatecustomer

REFERENCE

Update customer data

PARAMETERS
token string session token
id integer customer ID
company string company name
vatcode string company vat code
phone string phone number
fax string fax phone number
address string address
zipcode string zip code address
city string city address
province string province code address
country string country code address
language string language code iso2
fname string first name
lname string last name
fiscalcode string fiscal code
gender string gender type (M or F)
birthday string birthday date (YYYY-MM-DD)
email string email address
email_pec string pec email address
privacy string privacy accept (0/1)
privacydt string date privact accept (YYYY-MM-DD)
Call Resource
/
leads
/
updatecustomer.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
402 token not valid
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php

Moreover, in order for the insertion to be successful, the "phone" and "email" pair must be unique in the database.
result:status = 'added' indicates that the name has been added correctly.
result:status = 'duplicate' indicates that the name was not added because it is duplicated by email or phone.
result:status = 'error' indicates that the name was not added because an error occurred, whose detail is contained in result:error.

suppliers

6
GET

suppliers/addsupplier

REFERENCE

Add new supplier with minimal data

PARAMETERS
token string session token
company string company name
vatcode string company vat code
phone string phone number
fax string fax phone number
address string address
zipcode string zip code address
city string city address
province string province code address
country string country code address
language string language code iso2
fname string first name
lname string last name
fiscalcode string fiscal code
gender string gender type (M or F)
birthday string birthday date (YYYY-MM-DD)
email string email address
email_pec string pec email address
privacy string privacy accept (0/1)
privacydt string date privact accept (YYYY-MM-DD)
Call Resource
/
suppliers
/
addsupplier.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
402 token not valid
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php

Moreover, in order for the insertion to be successful, the "phone" and "email" pair must be unique in the database.
result:status = 'added' indicates that the name has been added correctly.
result:status = 'duplicate' indicates that the name was not added because it is duplicated by email or phone.
result:status = 'error' indicates that the name was not added because an error occurred, whose detail is contained in result:error.
GET

suppliers/checkbyvat

REFERENCE

Check exists supplier entry by vat code.

PARAMETERS
token string session token
vatcode string vat unique code
Call Resource
/
suppliers
/
checkbyvat.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
406 item not valid (blacklisted)
407 item not valid (error-tag)
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

suppliers/loadbyid

REFERENCE

Get supplier by ID

PARAMETERS
token string session token
id integer supplier ID
Call Resource
/
suppliers
/
loadbyid.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

suppliers/loadbyname

REFERENCE

Get supplier by COMPANY-NAME

PARAMETERS
token string session token
company string company name
fname string first name (alternative to the company name)
lname string last name (alternative to the company name)
Call Resource
/
suppliers
/
loadbyname.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

suppliers/loadbyvatcode

REFERENCE

Get supplier by VAT CODE

PARAMETERS
token string session token
vatcode string vat unique code
Call Resource
/
suppliers
/
loadbyvatcode.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

suppliers/updatesupplier

REFERENCE

Update supplier data

PARAMETERS
token string session token
id integer supplier ID
company string company name
vatcode string company vat code
phone string phone number
fax string fax phone number
address string address
zipcode string zip code address
city string city address
province string province code address
country string country code address
language string language code iso2
fname string first name
lname string last name
fiscalcode string fiscal code
gender string gender type (M or F)
birthday string birthday date (YYYY-MM-DD)
email string email address
email_pec string pec email address
privacy string privacy accept (0/1)
privacydt string date privact accept (YYYY-MM-DD)
Call Resource
/
suppliers
/
updatesupplier.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
402 token not valid
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php

Moreover, in order for the insertion to be successful, the "phone" and "email" pair must be unique in the database.
result:status = 'added' indicates that the name has been added correctly.
result:status = 'duplicate' indicates that the name was not added because it is duplicated by email or phone.
result:status = 'error' indicates that the name was not added because an error occurred, whose detail is contained in result:error.

leads

6
GET

leads/addlead

REFERENCE

Add new lead with minimal data

PARAMETERS
token string session token
email string email address (required at least one)
phone string phone number (required at least one)
fname string first name
lname string last name
gender string gender type (M or F)
birthday string birthday date (YYYY-MM-DD)
address string address
zipcode string zip code address
city string city address
province string province code address
country string country code address
leadcode string custom lead code
leadsource string custom source code
company string company name
vatcode string company vat code
fiscalcode string fiscal code
privacy string privacy accept (0/1)
privacydt string date privact accept (YYYY-MM-DD)
privacyip string ip address source privact accept
promoter string promoter name
subscribedt string subscribe date (YYYY-MM-DD)
Call Resource
/
leads
/
addlead.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
402 token not valid
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php

Moreover, in order for the insertion to be successful, the "phone" and "email" pair must be unique in the database.
result:status = 'added' indicates that the name has been added correctly.
result:status = 'duplicate' indicates that the name was not added because it is duplicated by email or phone.
result:status = 'error' indicates that the name was not added because an error occurred, whose detail is contained in result:error.
GET

leads/checkbyemail

REFERENCE

Check exists lead entry by email address.

PARAMETERS
token string session token
email string email address
Call Resource
/
leads
/
checkbyemail.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
406 item not valid (blacklisted)
407 item not valid (error-tag)
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

leads/checkbyphone

REFERENCE

Check exists lead entry by email address.

PARAMETERS
token string session token
phone string phone number (without internal space)
Call Resource
/
leads
/
checkbyphone.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
406 item not valid (blacklisted)
407 item not valid (error-tag)
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

leads/loadbyid

REFERENCE

Get lead details by ID

PARAMETERS
token string session token
id integer lead ID
Call Resource
/
leads
/
loadbyid.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

leads/loadlist

REFERENCE

Retrieve leads list filtered by source code, tag and subscription date.

PARAMETERS
token string session token
tag string tag value ('new', 'lost', 'reject', 'suspend', 'contact', 'recall', 'quote' 'complete', 'error')
leadsource string custom source code
subscribe_dt_from string from subscribe date (YYYY-MM-DD)
subscribe_dt_to string to subscribe date (YYYY-MM-DD)
Call Resource
/
leads
/
loadlist.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

leads/updatelead

REFERENCE

Update lead data

PARAMETERS
token string session token
id integer lead ID
email string email address
phone string phone number
fname string first name
lname string last name
gender string gender type (M or F)
birthday string birthday date (YYYY-MM-DD)
address string address
zipcode string zip code address
city string city address
province string province code address
country string country code address
leadcode string custom lead code
leadsource string custom source code
company string company name
vatcode string company vat code
fiscalcode string fiscal code
privacy string privacy accept (0/1)
privacydt string date privact accept (YYYY-MM-DD)
privacyip string ip address source privact accept
promoter string promoter name
subscribedt string subscribe date (YYYY-MM-DD)
Call Resource
/
leads
/
updatelead.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
402 token not valid
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php

Moreover, in order for the insertion to be successful, the "phone" and "email" pair must be unique in the database.
result:status = 'added' indicates that the name has been added correctly.
result:status = 'duplicate' indicates that the name was not added because it is duplicated by email or phone.
result:status = 'error' indicates that the name was not added because an error occurred, whose detail is contained in result:error.

partners

8
GET

partners/addpartner

REFERENCE

Add new partner with minimal data

PARAMETERS
token string session token
type_id integer unique partner type id
company string company name
vatcode string company vat code
phone string phone number
fax string fax phone number
address string address
zipcode string zip code address
city string city address
province string province code address
country string country code address
language string language code iso2
fname string first name
lname string last name
fiscalcode string fiscal code
email string email address
zone_id integer unique zone number id
Call Resource
/
partners
/
addpartner.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
402 token not valid
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php

Moreover, in order for the insertion to be successful, the "phone" and "email" pair must be unique in the database.
result:status = 'added' indicates that the name has been added correctly.
result:status = 'duplicate' indicates that the name was not added because it is duplicated by email or phone.
result:status = 'error' indicates that the name was not added because an error occurred, whose detail is contained in result:error.
GET

partners/checkbyfcode

REFERENCE

Check exists partner entry by fiscal code.

PARAMETERS
token string session token
id string country code
fcode string fiscal code
Call Resource
/
partners
/
checkbyfcode.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
406 item not valid (blacklisted)
407 item not valid (error-tag)
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

partners/checkbyvat

REFERENCE

Check exists partner entry by vat code.

PARAMETERS
token string session token
vatcode string vat unique code
Call Resource
/
partners
/
checkbyvat.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
406 item not valid (blacklisted)
407 item not valid (error-tag)
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

partners/loadbyfcode

REFERENCE

Get partners by FISCAL CODE

PARAMETERS
token string session token
id string country code
fcode string fiscal code
Call Resource
/
partners
/
loadbyfcode.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

partners/loadbyid

REFERENCE

Get partners by ID

PARAMETERS
token string session token
id integer partner ID
Call Resource
/
partners
/
loadbyid.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

partners/loadbyname

REFERENCE

Get partner by COMPANY-NAME

PARAMETERS
token string session token
company string company name
fname string first name (alternative to the company name)
lname string last name (alternative to the company name)
Call Resource
/
partners
/
loadbyname.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

partners/loadbyvatcode

REFERENCE

Get partners by VAT CODE

PARAMETERS
token string session token
vatcode string vat unique code
Call Resource
/
partners
/
loadbyvatcode.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

partners/updatepartner

REFERENCE

Update partner data

PARAMETERS
token string session token
id integer partner ID
type_id integer unique partner type id
company string company name
vatcode string company vat code
phone string phone number
fax string fax phone number
address string address
zipcode string zip code address
city string city address
province string province code address
country string country code address
language string language code iso2
fname string first name
lname string last name
fiscalcode string fiscal code
email string email address
zone_id integer unique zone number id
Call Resource
/
partners
/
updatepartner.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
402 token not valid
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php

Moreover, in order for the insertion to be successful, the "phone" and "email" pair must be unique in the database.
result:status = 'added' indicates that the name has been added correctly.
result:status = 'duplicate' indicates that the name was not added because it is duplicated by email or phone.
result:status = 'error' indicates that the name was not added because an error occurred, whose detail is contained in result:error.

invoices

13
GET

invoices/addexpiry

REFERENCE

Add new expiry invoice

PARAMETERS
token string session token
invoice_id integer unique invoice number id
date string expiry date (YYYY-MM-DD)
value decimal expiry value amount (2 decimal digit)
mode integer unique payment-mode number id
note string short description about expiry
account_id integer unique cash/bank-account number id
Call Resource
/
invoices
/
addExpiry.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
402 token not valid
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php

Moreover, in order for the insertion to be successful, the "phone" and "email" pair must be unique in the database.
result:status = 'added' indicates that the name has been added correctly.
result:status = 'duplicate' indicates that the name was not added because it is duplicated by email or phone.
result:status = 'error' indicates that the name was not added because an error occurred, whose detail is contained in result:error.
GET

invoices/addinvoice

REFERENCE

Add new invoice

PARAMETERS
token string session token
date string invoice date (YYYY-MM-DD)
register string vat register code
customer_id integer unique customer number id
title string short description of invoice object
partner_id integer unique partner/technical/agent number id
zone_id integer unique zone number id
payment_id integer id of payment condition
Call Resource
/
invoices
/
addInvoice.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
402 token not valid
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php

Moreover, in order for the insertion to be successful, the "phone" and "email" pair must be unique in the database.
result:status = 'added' indicates that the name has been added correctly.
result:status = 'duplicate' indicates that the name was not added because it is duplicated by email or phone.
result:status = 'error' indicates that the name was not added because an error occurred, whose detail is contained in result:error.
GET

invoices/addrow

REFERENCE

Add new row invoice

PARAMETERS
token string session token
invoice_id integer unique invoice number id
partner_id integer unique partner/technical/agent number id
product_id integer unique product number id
description string product description
price decimal row price amount (2 decimal digit)
discount_value decimal discount value amount (2 decimal digit)
discount_perc decimal discount percent amount (2 decimal digit)
quantity decimal row quantity amount (2 decimal digit)
um string unit of measure code
vat_id integer unique vat code number id
reference1 string reference data
reference2 string reference data
account_code integer account code of accounting plan
purchase_date string purchase date (YYYY-MM-DD)
warranty_exp_date string warranty expiration date (YYYY-MM-DD)
Call Resource
/
invoices
/
addRow.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
402 token not valid
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php

Moreover, in order for the insertion to be successful, the "phone" and "email" pair must be unique in the database.
result:status = 'added' indicates that the name has been added correctly.
result:status = 'duplicate' indicates that the name was not added because it is duplicated by email or phone.
result:status = 'error' indicates that the name was not added because an error occurred, whose detail is contained in result:error.
GET

invoices/getexpiries

REFERENCE

Get expiries about specified invoice

PARAMETERS
token string session token
id integer invoice ID
Call Resource
/
invoices
/
getexpiries.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

invoices/getpdf

REFERENCE

Get invoice in PDF format

PARAMETERS
token string session token
id integer invoice ID
Call Resource
/
invoices
/
getpdf.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

invoices/getrows

REFERENCE

Get rows about specified invoice

PARAMETERS
token string session token
id integer invoice ID
Call Resource
/
invoices
/
getrows.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

invoices/getstatus

REFERENCE

Get invoice STATUS

PARAMETERS
token string session token
id integer invoice ID
Call Resource
/
invoices
/
getstatus.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

invoices/gettotals

REFERENCE

Get invoice amout of docunent, expiries, payment-moves

PARAMETERS
token string session token
id integer invoice ID
Call Resource
/
invoices
/
gettotals.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

invoices/getxml

REFERENCE

Get invoice in XML format (Elettronic Invoice)

PARAMETERS
token string session token
id integer invoice ID
Call Resource
/
invoices
/
getxml.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

invoices/loadbyid

REFERENCE

Get invoice by ID

PARAMETERS
token string session token
id integer invoice ID
Call Resource
/
invoices
/
loadbyid.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

invoices/loadbynum

REFERENCE

Get invoice by NUMBER

PARAMETERS
token string session token
register string vat register code
year integer competence year
number integer invoice NUMBER
Call Resource
/
invoices
/
loadbynum.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

invoices/loadlist

REFERENCE

Retrieve invoices list filtered by customer_id, year and month.

PARAMETERS
token string session token
year integer year selected
month integer month selected (1..12)
customer_id integer unique customer number id
Call Resource
/
invoices
/
loadlist.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

invoices/updateinvoice

REFERENCE

Update invoice data

PARAMETERS
token string session token
id integer invoice ID
number string invoice number
date string invoice date (YYYY-MM-DD)
register string vat register code
customer_id integer unique customer number id
title string short description of invoice object
partner_id integer unique partner/technical/agent number id
zone_id integer unique zone number id
payment_id integer id of payment condition
Call Resource
/
invoices
/
updateInvoice.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
402 token not valid
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php

Moreover, in order for the insertion to be successful, the "phone" and "email" pair must be unique in the database.
result:status = 'added' indicates that the name has been added correctly.
result:status = 'duplicate' indicates that the name was not added because it is duplicated by email or phone.
result:status = 'error' indicates that the name was not added because an error occurred, whose detail is contained in result:error.

products

5
GET

products/addproduct

REFERENCE

Add new product

PARAMETERS
token string session token
code string product unique code
description string product description
price decimal row price amount (2 decimal digit)
discount_value decimal discount value amount (2 decimal digit)
discount_perc decimal discount percent amount (2 decimal digit)
valuta string currency code. default EUR
um string unit of measure code
vat_id integer unique vat code number id
categ_id integer category id
brand_id integer brand id
Call Resource
/
products
/
addproduct.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
402 token not valid
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php

Moreover, in order for the insertion to be successful, the "phone" and "email" pair must be unique in the database.
result:status = 'added' indicates that the name has been added correctly.
result:status = 'duplicate' indicates that the name was not added because it is duplicated by email or phone.
result:status = 'error' indicates that the name was not added because an error occurred, whose detail is contained in result:error.
GET

products/checkbycode

REFERENCE

Check exists product entry by code.

PARAMETERS
token string session token
code string product unique code
Call Resource
/
products
/
checkbycode.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
406 item not valid (blacklisted)
407 item not valid (error-tag)
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

products/loadbycode

REFERENCE

Get product by CODE

PARAMETERS
token string session token
code string product code
Call Resource
/
products
/
loadbycode.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

products/loadbyid

REFERENCE

Get product by ID

PARAMETERS
token string session token
id integer product ID
Call Resource
/
products
/
loadbyid.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

products/updateproduct

REFERENCE

Update product data

PARAMETERS
token string session token
id integer product ID
code string product unique code
description string product description
price decimal row price amount (2 decimal digit)
discount_value decimal discount value amount (2 decimal digit)
discount_perc decimal discount percent amount (2 decimal digit)
valuta string currency code. default EUR
um string unit of measure code
vat_id integer unique vat code number id
categ_id integer category id
brand_id integer brand id
Call Resource
/
products
/
updateproduct.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
402 token not valid
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php

Moreover, in order for the insertion to be successful, the "phone" and "email" pair must be unique in the database.
result:status = 'added' indicates that the name has been added correctly.
result:status = 'duplicate' indicates that the name was not added because it is duplicated by email or phone.
result:status = 'error' indicates that the name was not added because an error occurred, whose detail is contained in result:error.

candidate

9
GET

candidate/addcandidate

REFERENCE

Add new candidate to specified projet with minimal data

PARAMETERS
token string session token
source string provider source code
project integer recruiment project id
fname string first name
lname string last name
gender string gender type (M or F)
birthday string birthday date (YYYY-MM-DD)
address string address
zipcode string zip code address
city string city address
province string province code address
country string country code address
email string email address
phone string phone number
mobile string mobile number
occupation string occupation note
interest string interest note
study string study note
cv_name string cv-document name
cv_content string cv-document content (max 2mb)
Call Resource
/
candidate
/
addcandidate.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
402 token not valid
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php

Moreover, in order for the insertion to be successful, the "phone" and "email" pair must be unique in the database.
result:status = 'added' indicates that the name has been added correctly.
result:status = 'duplicate' indicates that the name was not added because it is duplicated by email or phone.
result:status = 'error' indicates that the name was not added because an error occurred, whose detail is contained in result:error.
GET

candidate/adddocument

REFERENCE

Add new document about candidate

PARAMETERS
token string session token
id integer candidate ID
name string document name
content string document content (max 2mb)
Call Resource
/
candidate
/
addDocument.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
402 token not valid
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php

Moreover, in order for the insertion to be successful, the "phone" and "email" pair must be unique in the database.
result:status = 'added' indicates that the name has been added correctly.
result:status = 'duplicate' indicates that the name was not added because it is duplicated by email or phone.
result:status = 'error' indicates that the name was not added because an error occurred, whose detail is contained in result:error.
GET

candidate/addgeoarea

REFERENCE

Add new geographic area from candidate

PARAMETERS
token string session token
id integer candidate ID
country string country code iso3 (ex.'ITA')
region string region italian istat code (ex.'ITC4')
province string province code (ex.'TO')
geocode string geocode
geodescr string description
rating integer rating value (0..5)
Call Resource
/
candidate
/
addGeoArea.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
402 token not valid
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php

Moreover, in order for the insertion to be successful, the "phone" and "email" pair must be unique in the database.
result:status = 'added' indicates that the name has been added correctly.
result:status = 'duplicate' indicates that the name was not added because it is duplicated by email or phone.
result:status = 'error' indicates that the name was not added because an error occurred, whose detail is contained in result:error.
GET

candidate/addmessage

REFERENCE

Add new message from candidate

PARAMETERS
token string session token
id integer candidate ID
date string message date-time (YYYY-MM-DD HH:mm:ss)
text string text message
Call Resource
/
candidate
/
addMessage.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
402 token not valid
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php

Moreover, in order for the insertion to be successful, the "phone" and "email" pair must be unique in the database.
result:status = 'added' indicates that the name has been added correctly.
result:status = 'duplicate' indicates that the name was not added because it is duplicated by email or phone.
result:status = 'error' indicates that the name was not added because an error occurred, whose detail is contained in result:error.
GET

candidate/getdocuments

REFERENCE

Get documents about specified candidate

PARAMETERS
token string session token
id integer candidate ID
Call Resource
/
candidate
/
getdocuments.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

candidate/getgeoareas

REFERENCE

Get geographical areas about specified candidate

PARAMETERS
token string session token
id integer candidate ID
Call Resource
/
candidate
/
getgeoareas.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

candidate/getmessages

REFERENCE

Get messages about specified candidate

PARAMETERS
token string session token
id integer candidate ID
Call Resource
/
candidate
/
getmessages.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

candidate/getskills

REFERENCE

Get skills about specified candidate

PARAMETERS
token string session token
id integer candidate ID
Call Resource
/
candidate
/
getskills.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

candidate/loadbyid

REFERENCE

Get candidate details by ID

PARAMETERS
token string session token
id integer candidate ID
Call Resource
/
candidate
/
loadbyid.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php

database

9
GET

database/loadlist_account

REFERENCE

Retrieve cash/bank account list

PARAMETERS
token string session token
Call Resource
/
database
/
loadlist_account.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

database/loadlist_brand

REFERENCE

Retrieve product brand list

PARAMETERS
token string session token
Call Resource
/
database
/
loadlist_brand.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

database/loadlist_category

REFERENCE

Retrieve product category list

PARAMETERS
token string session token
Call Resource
/
database
/
loadlist_category.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

database/loadlist_paycond

REFERENCE

Retrieve payment conditions list

PARAMETERS
token string session token
Call Resource
/
database
/
loadlist_paycond.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

database/loadlist_payment

REFERENCE

Retrieve payments mode list

PARAMETERS
token string session token
Call Resource
/
database
/
loadlist_payment.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

database/loadlist_ptype

REFERENCE

Retrieve partner type list

PARAMETERS
token string session token
Call Resource
/
database
/
loadlist_ptype.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

database/loadlist_regvat

REFERENCE

Retrieve var registry list

PARAMETERS
token string session token
Call Resource
/
database
/
loadlist_regvat.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

database/loadlist_vat

REFERENCE

Retrieve vat codes list

PARAMETERS
token string session token
Call Resource
/
database
/
loadlist_vat.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php
GET

database/loadlist_zone

REFERENCE

Retrieve zone list

PARAMETERS
token string session token
Call Resource
/
database
/
loadlist_zone.php
Request
GET https://cmo2.engageconsulting.it/api
Response
200
BODY
General
200 Ok! operation done succesufully
Application Errors
400 general error
404 not found
405 missing data required
IMPORTANT NOTE: In order the TOKEN to be recognized CURL requests must keep the session alive.
http://php.net/curl
http://php.net/manual/it/book.curl.php