incwo

Introduction

Our applications provide developers with a REST-type API.

It allows you to create automations, or mashup applications composed with incwo.com apps and other services. For example :

  • Use a desktop app to enter timesheets in a snap

  • Bill directly from your web boutique each time there's a sale

  • Receive a SMS when you reach some sales targets

  • Import contacts automatically from another application

If you create public applications with our APIs please let us know, we'll add your application to our application repository and we'll promote your application.

We edit several applications, each will have different API access policies based on your service plan. Check on our websites to know more. But each will allow you to test some API calls before going to pay mode.

Give us your feedback : If you need more APIs, we'll add more APIs.






Access authentification

Authentication is managed through HTTP Basic Authentication. To use these APIs, you need a server address, a login/password combination. To get them :

  • Login to the incwo.com application, and go to the Settings/Users and then to the APIs settings panel

  • Activate API access : it will allow your application to respond to XML requests

  • Note the server address : the API server address displayed in the APIs settings panel is the one you need

  • Choose the authorized user account : choose the user account that you want to authorize. The login/password you will use for your API will be these of the user






Testing the access

When connected to your application with your browser, go to a contact, and add .xml at the end of the address in the browser. It will return the XML version of your contact.

You can also use curl to test access to the API. Set the 'Content-Type' header to 'application/xml'.

# Try the following to get a list of your contacts, and return a XML-formatted response :

curl -u #{login}:#{password} - X GET \		
-H 'Content-Type: application/xml' \		
#{server}/contacts.xml

# Note that in the code samples, #{text} indicates a section that has to be replaced by your data

<?xml version="1.0" encoding="UTF-8"?>		
<contact>	
	 <id>30416</id>
  	 <first_name>Bob</first_name>
  	 <last_name>Robertson</last_name>
	 <creator_id>433</creator_id>		
	 <contact_items>		
    	  <contact_item>			
      		   <type_id>24</type_id>			
			   <value>01 45 21 28 27</value>
		  </contact_item>
	 </contact_items>
 </contact> 




Error management

HTTP Status Code will be returned with the XML response:

  • 200 if all is ok

  • 201 if all is ok and an object was created

  • 404 if the resource couldn't be found

  • 500 if and error happened






Reading data

The following example returns a list of firms :




Note the pagination block providing information about the potential number of pages.
To access the next page, just add the ?page=#{page_number} to your request url.

curl -u #{login}:#{password} \		
-H 'Content-Type: application/xml' \
#{server}/firms.xml


<?xml version="1.0" encoding="UTF-8"?>
<pagination>	
	 <current_page>1</current_page>
	 <total_pages>62</total_pages>
</pagination>
<firms>
	 <firm>
		  <id>63462</id>
		  <name>C.O</name>
		  <firm_type>client</firm_type>
		  <siren></siren>
		  <tva></tva>
	 </firm>
	 <firm>
		  <id>62601</id>
		  <name>2C Comm</name>
		  <firm_type>client</firm_type>
		  <siren></siren>
		  <tva></tva>
	</firm>
</firms>

# With no surprise, details on one firm will be requested via the following :

curl -u #{login}:#{password} \		
-H 'Content-Type: application/xml' \
#{server}/firms/#{id of firm}.xml



Creating new objects

Data will be inserted the following way, using the POST action. (Example with a firm)
This returns the newly created object from which you can extract the id.

curl -u #{login}:#{password} -X POST \
-H 'Content-Type: application/xml' \
-d '<firm><name>apitest</name><firm_type>client</firm_type></firm>' \
#{server}/firms.xml




Updating objects

Data will be updated the following way, using the PUT action. (Example with a firm)

curl -u #{login}:#{password} -X PUT \
-H 'Content-Type: application/xml' \
-d '<firm><name>apitest</name><firm_type>client</firm_type></firm>' \
#{server}/firms/#{id of the object}.xml




Deleting objects

Data will be deleted the following way, using the DELETE action. (Example with a firm)

curl -u #{login}:#{password} -X DELETE \
-H 'Content-Type: application/xml' \
#{server}/firms/#{id of the object}.xml




Ruby On Rails

You are using RubyOnRails ? Download here a sample application to play with our APIs.

PHP

You are using PHP ? Download here a sample application to play with our APIs.

You build some sample code for other languages ?

Send it to us, we'll integrate it here






Ruby On Rails sample code

To use this API you need :

  • An incwo.com account

  • On this account, one application Bureau Virtuel, ma-facturation, or gestion-auto-entrepreneur

  • On one of these applications above, you need to activate the APIs in users/api setup

Required info

After the above step, here's the info you must have :

  • The user login and password

  • The server address and file number

  • On one of these applications above, you need to activate the APIs in users/api setup

Try it manually

Here's how to try the APIs manually :

  • Login to your application using a browser, and go to your invoices for example

  • Your current browser address will be something like https://www.incwo.com/bill_sheets/list/10232 (Where 10232 will be replaced by your own file number)

  • Add .xml at the end of the URL, https://www.incwo.com/bill_sheets/list/10232.xml

  • As a result you get a paginated list of bills in XML format

  • Another try : go to one of your bills. Your current browser address is close to https://www.incwo.com/bill_sheets/show/10232/38580 (Where 10232 will be replaced by your own file number, and 38580 will be replaced by the id of the bill you're looking at)

  • Add .xml at the end of the URL, https://www.incwo.com/bill_sheets/show/10232/38580.xml

  • As a result you get your bill displayed in XML format

Automate it

Now to automate :

  • If you're using a REST based library to access the API, provide server address, login, password, and reproduce the data model of the APis in your app

  • If you're not, and access the server using http calls, you'll have to rebuild the URLs yourself using the above examples.






What's the application store ?

You created a mashup using our applications and other web services ?

A desktop application ?

A mobile application ?

It comes for free ? It has a cost ?

The Application Store is a registry of applications or resources using our services

Send us the details : We'll post your application on our catalog, and advertise it on our community of users !






You have talent ?

You are a talented developer and love our products ?

You would like to build innovative products around our solutions ?

You would like to advertise your services (with a price of course) to build custom applications for other people ?

We have a Registered Developer Program to make your life easier

Why register ?

  • Get access to the developer extranet, with tech updates and information

  • Have faster access to tech support

  • Be listed, if you choose, in the developer's public listing. It may help you find customers interesting in building an app with our API, and ... your skills

  • Promote your app in our application store

How to apply ?

Login to your account






Contacts

Find here the list of actions to apply on the objects, and the data reference for this object.

What is a contact ?

A contact is a person, with a first name, last name, and contact data (phones, emails, etc). A contact can be linked to a firm.

Getting the contacts list

GET /contacts.xml

Returns all contacts , page by page
Add a page parameter to navigate


Getting a selection of the list

Add these parameters to GET to narrow selection

  • text_search_filter : Wide text search
  • text_search_target : Additional parameter to narrow wide search. Values = { email | first_name | last_name | job | first_last_name | exact_first_last_name | name (company name) | exact_name (company name) }
  • contact_list_id : Get only items in contact list


Getting a single contact

GET /contacts/#{id}.xml
Returns a single contact identified by its id


Creating a new contact

POST contacts.xml
Creates a new contact , and returns thecontactdata


Updating an existing contact

PUT contacts/#{id}.xml
Updates some fields of an existing contact


Deleting an existing contact

DELETE contacts/#{id}.xml
Deletes the contact identified by its id

Possible values of client/firm type

  • client for a client
  • prospect for a prospect
  • supplier for a supplier
  • press for a journalist
  • partner for a partner
  • staff for a staff member or potential member
  • perso for a personal contact
  • other for none of the above

Possible values of civility_label_id

  • 18 : Madame
  • 634 : Mesdames
  • 19 : Mademoiselle
  • 635 : Mesdemoiselles
  • 17 : Monsieur
  • 636 : Messieurs
  • 752 : Monsieur et Madame
  • 637 : Veuve
  • 638 : Docteur
  • 639 : Docteurs
  • 640 : Professeur
  • 641 : Professeurs
  • 642 : Maitre
  • 643 : Maitres
  • 644 : Monseigneur

Possible values of contact_item_type for contacts

  • 27 : E-mail Pro
  • 471 : Tel Pro Standard
  • 24 : Tel Pro
  • 26 : Fax Pro
  • 88 : Tel mobile Pro
  • 554 : Tel mobile Perso
  • 28 : E-mail Perso
  • 23 : Tel Perso
  • 25 : Fax Perso
  • 646 : Skype Perso
  • 430 : Skype Pro
  • 200114 : Profil Facebook
  • 200116 : Profil LinkedIn
  • 200117 : Compte Twitter
  • 200118 : Profil Google+
  • 200115 : Profil Viadeo
  • 431 : Yahoo Messenger
  • 432 : MSN Messenger
  • 433 : AIM Messenger
  • 457 : ICQ Messenger
  • 626 : Google Talk
  • 648 : Tel IP Pro
  • 649 : Tel IP Perso
  • 753 : Site Web

Possible values of contact_address_type

  • 21 : Adresse Pro
  • 20 : Adresse Perso
  • 22 : Autre


#Object Data

<contact> <id>id of contact</id> <civility_label_id>civility (see below)</civility_label_id> <last_name>last name</last_name> <first_name>first name</first_name> <comment>comment</comment> <job_title>job title</job_title> <job_department>department in company</job_department> <country>France</country> <contact_type>type of contact (see below)</contact_type> <firm_id>id of firms the contact belongs to</firm_id> <contact_addresses>  <contact_address>   <address_type>type of address (see below)</address_type>   <street_address>street address</street_address>   <street_address2>more address</street_address2>   <zip_code>zip code</zip_code>   <city>city</city>   <country>France</country>  </contact_address> </contact_addresses> <contact_items>  <contact_item>   <type_id>type of contact_item (see below)</type_id>   <value>tel, email, etc.</value>  </contact_item> </contact_items> </contact>

Firms

Find here the list of actions to apply on the objects, and the data reference for this object.

What is a firm ?

A firm is a company, with a name, some administrative data, and contact info. A firm can contain several contacts.

Getting the firms list

GET /firms.xml

Returns all firms , page by page
Add a page parameter to navigate


Getting a selection of the list

Add these parameters to GET to narrow selection

  • text_search_filter : Wide text search
  • text_search_target : Additional parameter to narrow wide search. Values = { email | first_name | last_name | job | name (company name) | exact_name }
  • contact_list_id : Get only items in contact list


Getting a single firm

GET /firms/#{id}.xml
Returns a single firm identified by its id


Creating a new firm

POST firms.xml
Creates a new firm , and returns thefirmdata


Updating an existing firm

PUT firms/#{id}.xml
Updates some fields of an existing firm


Deleting an existing firm

DELETE firms/#{id}.xml
Deletes the firm identified by its id

Possible values of client/firm type

  • client for a client
  • prospect for a prospect
  • supplier for a supplier
  • press for a journalist
  • partner for a partner
  • staff for a staff member or potential member
  • perso for a personal contact
  • other for none of the above

Possible values of contact_item_type for firms

  • 71 : Téléphone
  • 72 : Fax
  • 73 : E-mail
  • 74 : Site Web
  • 627 : Skype
  • 200500 : Profil Facebook
  • 200501 : Profil LinkedIn
  • 200502 : Compte Twitter
  • 200503 : Profil Google+
  • 200504 : Profil Viadeo
  • 628 : Yahoo Messenger
  • 629 : MSN Messenger
  • 630 : AIM Messenger
  • 631 : ICQ Messenger
  • 647 : Tel IP
  • 632 : Google Talk

Possible values of contact_address_type

  • 21 : Adresse Pro
  • 20 : Adresse Perso
  • 22 : Autre


#Object Data

<firm> <id>id of firm</id> <name>name of firm</name> <firm_type>type of firm (see below)</firm_type> <project_id>id of related project</project_id> <siren>company identification number</siren> <tva>intra vat number</tva> <contact_addresses>  <contact_address>   <address_type>type of address (see below)</address_type>   <street_address>street address</street_address>   <street_address2>more address</street_address2>   <zip_code>zip code</zip_code>   <city>city</city>   <country>France</country>  </contact_address> </contact_addresses> <contact_items>  <contact_item>   <type_id>type of contact_item (see below)</type_id>   <value>tel, email, etc.</value>  </contact_item> </contact_items> </firm>

Leads

Find here the list of actions to apply on the objects, and the data reference for this object.

What is a lead ?

A lead contains information (amount of sale, signing date, expectations) on a sales prospect or a client, and it's linked to a contact or firm.

Getting the leads list

GET /leads.xml

Returns all leads , page by page
Add a page parameter to navigate



Getting a single lead

GET /leads/#{id}.xml
Returns a single lead identified by its id


Creating a new lead

POST leads.xml
Creates a new lead , and returns theleaddata


Updating an existing lead

PUT leads/#{id}.xml
Updates some fields of an existing lead


Deleting an existing lead

DELETE leads/#{id}.xml
Deletes the lead identified by its id

Possible values of steps for leads

  • 459 : Projet
  • 460 : Analyse
  • 461 : Proposition
  • 462 : Négociation
  • 463 : En closing
  • 464 : En production
  • 467 : En exploitation
  • 469 : Contrat servi
  • 470 : Perdu
  • 535 : En sommeil


#Object Data

<lead>  <id>id of this object</id>  <manager_id>user id of the manager of the lead</manager_id>  <client_name>Name of client</client_name>  <topic>Topic of this lead</topic>  <contact_id>id of related contact (or 0)</firm_id>  <firm_id>id of related firm (or 0)</firm_id>  <is_engaged>0 for prospect, 1 for customer</is_engaged>  <importance>0 not important to 5 most important</importance>  <product_category_id>id in your own typology of products you sell</category>  <value>amount of sale without taxes</value>  <value_date>expected date of signing the sale</value_date>  <confidence_pct>percentage of confidence (0-100)</confidence_pct>  <project_id>id of related project</project_id>  <description>Some description of the lead</description>  <learning_on_customer>Some info about the customer (budget, timing, etc.)</learning_on_customer>  <learning_on_sales_tools>Some learnings on your own sales tools (website, brochures, etc.)</learning_on_sales_tools>  <learning_on_products>Some learnings on your products (too expensive, etc.)</learning_on_products> </lead>

Contact lists

Find here the list of actions to apply on the objects, and the data reference for this object.

What is a Contact_list ?

A contact_list is a list of contacts and firms

Getting the contact_lists list

GET /contact_lists.xml

Returns all contact_lists , page by page
Add a page parameter to navigate



Getting a single contact_list

GET /contact_lists/#{id}.xml
Returns a single contact_list identified by its id


Creating a new contact_list

POST contact_lists.xml
Creates a new contact_list , and returns thecontact_listdata


Updating an existing contact_list

PUT contact_lists/#{id}.xml
Updates some fields of an existing contact_list


Deleting an existing contact_list

DELETE contact_lists/#{id}.xml
Deletes the contact_list identified by its id


#Object Data

<contact_list>
      <name>name of the list</name>
      <description>some description</description>
  <contact_list_items>
    <contact_list_item>...</contact_list_item>
    <contact_list_item>...</contact_list_item>
  </contact_list_items>
  </contact_list>

"Contact List Item"

Find here the list of actions to apply on the objects, and the data reference for this object.

What is a contact_list_item ?

A contact_list_item is an element of a contact_list


Getting a single contact_list_item

GET /contact_list_items/#{id}.xml
Returns a single contact_list_item identified by its id


Creating a new contact_list_item

POST contact_list_items.xml
Creates a new contact_list_item , and returns thecontact_list_itemdata


Updating an existing contact_list_item

PUT contact_list_items/#{id}.xml
Updates some fields of an existing contact_list_item


Deleting an existing contact_list_item

DELETE contact_list_items/#{id}.xml
Deletes the contact_list_item identified by its id


#Object Data

<contact_list_item>
    <contact_list_id>id of contact list</contact_list_id>
    <contact_id>id of contact or firm</contact_id>
    <email_id>id of contact's email (contact_item)</email_id>
    <phone_id>id of contact's phone (contact_item)</phone_id>
    <address_id>id of contact's email (contact_address)</address_id>
    <kind>contact | firm</kind>
</contact_list_item>

"Catalog of products"

Find here the list of actions to apply on the objects, and the data reference for this object.

What is a customer product ?

A customer_product is an item from the catalog of products you sell to customers, or you buy from vendors, or both.

Getting the products list

GET /customer_products.xml

Returns all products , page by page
Add a page parameter to navigate


Getting a selection of the list

Add these parameters to GET to narrow selection

  • is_from_vendor : Additional parameter to narrow search.
    Values = { 0 | 1 | 2 }
    • 0 = only products in sale catalog
    • 1 = only products in purchase catalog
    • 2 = products in both catalogs


Getting a single product

GET /customer_products/#{id}.xml
Returns a single product identified by its id


Creating a new product

POST customer_products.xml
Creates a new product , and returns theproductdata


Updating an existing product

PUT customer_products/#{id}.xml
Updates some fields of an existing product


Deleting an existing product

DELETE customer_products/#{id}.xml
Deletes the product identified by its id

Possible values of type_of_product_id

  • 20000 for Fourniture
  • 20001 for Matiere premiere
  • 20002 for Consommable
  • 20003 for Produit semi-fini
  • 20004 for Produit fini
  • 20005 for Investissement

Possible values of activity_classification_choice

  • for a product :
    • commerce : product
  • for a service :
    • service : generic service
    • service_bnc : service of kind bnc
    • liberal : service of kind liberal
    • mixte : service of composit kind

Possible values of manage_serial_lots_out_order

  • 0 if FIFO
  • 1 if LIFO
  • 2 if FIFV : increasing peremption date
  • 3 if LIFV : decreasing peremption date

Possible values of manage_serial_numbers_out_order

  • 0 if FIFO
  • 1 if LIFO

Possible values of vat_id

  • 607 for 20%
  • 552 for 10%
  • 223 for 5.5%
  • 222 for 2.1%
  • 225 for 0%
  • 224 for 19.6%
  • 200036 for 7%
  • 700075 for 22%
  • 544 for 21%
  • 500041 for 19.25%
  • 529 for 19%
  • 567 for 18%
  • 200035 for 17%
  • 546 for 16%
  • 551 for 15%
  • 700007 for 14%
  • 620132 for 13%
  • 645 for 12%
  • 543 for 8.5%
  • 569 for 8.5% NPR
  • 200015 for 8%
  • 545 for 7.6%
  • 615 for 6%
  • 1019 for 5%
  • 553 for 3%
  • 700554 for 2.5%
  • 200014 for 2.4%
  • 700482 for 20% ENC
  • 700485 for 20% DEB

Possible values of currency_id

  • 58 for Euros
  • 576 for Dollars canadien
  • 577 for Francs suisses
  • 579 for Dinars tunisiens
  • 580 for Dirhams marocains
  • 578 for Dinars algériens
  • 59 for Dollars
  • 60 for Livres sterling
  • 608 for Francs pacifique
  • 611 for Francs CFA
  • 868 for Dirham des E.A.U.
  • 869 for Afghani
  • 870 for Lek
  • 871 for Dram arménien
  • 872 for Florin des Antilles Néerlandaises
  • 873 for Kwanza
  • 874 for Peso argentin
  • 875 for Dollar australien
  • 876 for Dollar australien
  • 877 for Florin d'Aruba
  • 878 for Nouveau Manat
  • 879 for Mark convertible
  • 880 for Dollar de Barbade
  • 881 for Taka
  • 882 for Lev
  • 883 for Dinar de Bahrein
  • 884 for Franc du Burundi
  • 885 for Dollar des Bermudes
  • 886 for Dollar de Brunei
  • 887 for Boliviano
  • 888 for Real
  • 889 for Dollar des Bahamas
  • 890 for Ngultrum
  • 891 for Pula
  • 892 for Rouble de Bélarus
  • 893 for Dollar de Belize
  • 894 for Franc congolais
  • 895 for Peso chilien
  • 896 for Yuan Ren-Min-Bi
  • 897 for Peso colombien
  • 898 for Colon de Costa Rica
  • 899 for Peso cubain
  • 900 for Escudo du Cap Vert
  • 901 for Couronne tchèque
  • 902 for Franc de Djibouti
  • 903 for Couronne danoise
  • 904 for Peso dominicain
  • 905 for Couronne estonienne
  • 906 for Livre égyptienne
  • 907 for Nakfa
  • 908 for Birr éthiopien
  • 909 for Dollar de Fidji
  • 910 for Lari
  • 911 for Ghana Cedi
  • 912 for Livre de Gibraltar
  • 913 for Dalasi
  • 914 for Franc guinéen
  • 915 for Quetzal
  • 916 for Peso de Guinée Bissau
  • 917 for Dollar de Guyane
  • 918 for Dollar de Hong Kong
  • 919 for Lempira
  • 920 for Kuna
  • 921 for Gourde
  • 922 for Forint
  • 923 for Rupiah
  • 924 for Nouveau sheqel israélien
  • 925 for Roupie indienne
  • 926 for Dinar irakien
  • 927 for Rial iranien
  • 928 for Couronne islandaise
  • 929 for Dollar jamaïcain
  • 930 for Dinar jordanien
  • 931 for Yen
  • 932 for Shilling du Kenya
  • 933 for Som
  • 934 for Riel
  • 935 for Franc des Comores
  • 936 for Won
  • 937 for Dinar koweitien
  • 938 for Dollar des Iles Cayman
  • 939 for Tenge
  • 940 for Kip
  • 941 for Livre libanaise
  • 942 for Roupie de Sri Lanka
  • 943 for Dollar libérien
  • 944 for Loti
  • 945 for Litas lituanien
  • 946 for Lats letton
  • 947 for Dinar libyen
  • 948 for Leu de Moldovie
  • 949 for Malagasy Ariary
  • 950 for Denar
  • 951 for Kyat
  • 952 for Tugrik
  • 953 for Pataca
  • 954 for Ouguija
  • 955 for Roupie de Maurice
  • 956 for Rufiyaa
  • 957 for Kwacha
  • 958 for Peso mexicain
  • 959 for Ringgit malaysien
  • 960 for Metical
  • 961 for Dollar Namibien
  • 962 for Naira
  • 963 for Cordoba Oro
  • 964 for Couronne norvégienne
  • 965 for Roupie népalaise
  • 966 for Dollar néo-zélandais
  • 967 for Rial omani
  • 968 for Balboa
  • 969 for Nuevo Sol
  • 970 for Kina
  • 971 for Peso philippin
  • 972 for Roupie du Pakistan
  • 973 for Zloty
  • 974 for Guarani
  • 975 for Riyal du Qatar
  • 976 for Leu Roumain
  • 977 for Dinar Serbe
  • 978 for Rouble russe
  • 979 for Franc rwandais
  • 980 for Riyal saoudien
  • 981 for Roupie des Seychelles
  • 982 for Livre soudanais
  • 983 for Couronne suédoise
  • 984 for Dollar de Singapour
  • 985 for Leone
  • 986 for Shilling de Somalie
  • 987 for Dollar de Suriname
  • 988 for Dobra
  • 989 for Colon du El Salvador
  • 990 for Livre syrienne
  • 991 for lilangeni
  • 992 for Baht
  • 993 for Somoni
  • 994 for Manat
  • 995 for Pa'anga
  • 996 for Nouvelle Livre turque
  • 620081 for Dollar de Taiwan
  • 997 for Dollar de Trinité et Tobago
  • 998 for Shilling de Tanzanie
  • 999 for Hryvnia
  • 1000 for Shilling ougandais
  • 1001 for Peso uruguayen
  • 1002 for Soum d'Ouzbékistan
  • 1003 for Bolívar Fuerte
  • 1004 for Dong
  • 1005 for Franc CFA - BEAC
  • 1006 for Dollar des Caraïbes Orientales
  • 1007 for Franc CFA - BCEAO
  • 1008 for Rial yéménite
  • 1009 for Rand
  • 1010 for Kwacha
  • 1011 for Dollar de Zimbabwe


#Object Data

<customer_product>
<id>id of product</id>
<reference>reference for sale</reference>
<vendor_reference>reference for purchase</vendor_reference>
<is_active>product is active ? 0 | 1</is_active>
<is_from_vendor>which catalog ? 0=sale | 1=vendor | 2=both</is_from_vendor>
<name>product name for sale</name>
<name_vendor>product name for purchase</name_vendor>
<additional_public_infos>public description</additional_public_infos>
<description>private description</description>
<additional_public_infos_vendor>public description from vendor</additional_public_infos_vendor>
<description_vendor>private descriptor from vendor</description_vendor>
<type_of_product_id>type of product (see below)</type_of_product_id>
<activity_classification_choice>is product or service</activity_classification_choice>
<link_to_product>link to product</link_to_product>
<link_text>name for link to product</link_text>
<currency_id>currency of sale price</currency_id>
<cost_currency_id>currenty of purchase cost</cost_currency_id>
<product_category_id>ID of customer_product_category object</product_category_id>
<pos_has_no_quantity>xxxx</pos_has_no_quantity>
<price>sale price of product</price>
<price_distributor>sale price of product for distributors</price_distributor>
<eco_participation>eco participation</eco_participation>
<unit>unit</unit>
<unit_vendor>unit for purchase</unit_vendor>
<vat_id>product vat</vat_id>
<cost>cost of purchase</cost>
<weight_kg>weight in weight_kg_unit</weight_kg>
<weight_kg_unit>1=kg</weight_kg_unit>
<alert_stock>alert stock for the product</alert_stock>
<total_stock>current total stock</total_stock>
<enter_prices_in_ttc>prices should be entered in ttc ? 0 | 1</enter_prices_in_ttc>
<entered_price_in_ttc>ttc price that was entered</entered_price_in_ttc>
<entered_price_distributor_in_ttc>ttc price that was entered for distributors</entered_price_distributor_in_ttc>
<compound_product>product is made of sub-products ? 0 | 1</compound_product>
<compound_product_stock_method>method of stock movements ? 0:move products 1:move components</compound_product_stock_method>
<accounting_ref>accounting ref of product</accounting_ref>
<barcode>product barcode</barcode>
<manage_serial_lots>product has lots management</manage_serial_lots>
<manage_serial_lots_out_order>lots ordering (see below)</manage_serial_lots_out_order>
<manage_serial_numbers>product has serial number management</manage_serial_numbers>
<manage_serial_numbers_out_order>serial numbers ordering (see below)</manage_serial_numbers_out_order>
<dimension_height>height of product</dimension_height>
<dimension_width>width of product</dimension_width>
<dimension_depth>depth of product</dimension_depth>
<dimension_unit>1=centimeter</dimension_unit>
<duration>product required duration</duration>
<duration_unit_id>530=hour | 531=halfday</duration_unit_id>
<volume>volume of unit</volume>
<volume_unit>1=dm3</volume_unit>
<approach_expense_percent>xxxx</approach_expense_percent>
</customer_product>

Proposals

Find here the list of actions to apply on the objects, and the data reference for this object.

What is a customer proposal ?

An proposal (we call it a proposal sheet) represents a quotation your make for your prospects and clients.

Getting the proposals list

GET /proposal_sheets.xml

Returns all proposals , page by page
Add a page parameter to navigate


Getting a selection of the list

Add these parameters to GET to narrow selection

  • contact_id : search by contact
  • firm_id : search by firm


Getting a single proposal

GET /proposal_sheets/#{id}.xml
Returns a single proposal identified by its id


Creating a new proposal

POST proposal_sheets.xml
Creates a new proposal , and returns theproposaldata


Updating an existing proposal

PUT proposal_sheets/#{id}.xml
Updates some fields of an existing proposal


Deleting an existing proposal

DELETE proposal_sheets/#{id}.xml
Deletes the proposal identified by its id

Possible values of vat_id

  • 607 for 20%
  • 552 for 10%
  • 223 for 5.5%
  • 222 for 2.1%
  • 225 for 0%
  • 224 for 19.6%
  • 200036 for 7%
  • 700075 for 22%
  • 544 for 21%
  • 500041 for 19.25%
  • 529 for 19%
  • 567 for 18%
  • 200035 for 17%
  • 546 for 16%
  • 551 for 15%
  • 700007 for 14%
  • 620132 for 13%
  • 645 for 12%
  • 543 for 8.5%
  • 569 for 8.5% NPR
  • 200015 for 8%
  • 545 for 7.6%
  • 615 for 6%
  • 1019 for 5%
  • 553 for 3%
  • 700554 for 2.5%
  • 200014 for 2.4%
  • 700482 for 20% ENC
  • 700485 for 20% DEB

Possible values of proposal progress

  • 555 for En rédaction
  • 556 for Envoyé
  • 557 for Accepté
  • 558 for Refusé
  • 559 for Ajourné
  • 620105 for Terminé

Possible values of proposal sheet type

  • proposal for a proposal you send to your customers (you propose)
  • delivery_note for a delivery note you send to your customers (you deliver)
  • purchase_order for a purchase order you send to your vendors (you order)
  • production_order for an internal production order
  • insertion_order for an insertion order you send to your customers
  • sale_order for an sale order (confirmation of customer order)
  • intervention_sheet for an intervention sheet
  • loan_receipt for a loan receipt
  • price_quote for a price quote


#Object Data

<proposal_sheet>  <id>id of proposal</id>  <sheet_type>proposal or other document (see below)</sheet_type>  <progress_id>id of proposal progress (see below)</progress_id>  <contact_id>attached to contact id (0 if none)</contact_id>  <firm_id>attached to firm id (0 if none)</firm_id>  <bank_account_id>id of bank account to display on proposal</bank_account_id>  <reference>reference of proposal (automatic)</reference>  <title>title</title>  <subtitle>subtitle</subtitle>  <billing_date>date of proposal (DD-MM-YYYY)</billing_date>  <reduction_percent>percentage of reduction</reduction_percent>  <vat_value_id>vat code id (see below)</vat_value_id>  <vat_cost>vat value</vat_cost>  <shipping_cost>cost of shipping</shipping_cost>  <vat_exl_total>total of proposal without vat</vat_exl_total>  <vat_inc_total>total of proposal with vat</vat_inc_total>  <vat_exc_total_with_shipping>total of proposal without vat with shipping</vat_exc_total_with_shipping>  <billing_add_street_address>billing street address</billing_add_street_address>  <billing_add_name>billing address complement</billing_add_name>  <billing_add_zip_code>billing address zip</billing_add_zip_code>  <billing_add_city>billing address city</billing_add_city>  <billing_add_country>France</billing_add_country>  <shipping_add_street_address>shipping street address</shipping_add_street_address>  <shipping_add_name>shipping address complement</shipping_add_name>  <shipping_add_zip_code>shipping address zip</shipping_add_zip_code>  <shipping_add_city>shipping address city</shipping_add_city>  <shipping_add_country>France</shipping_add_country>  <comment_for_party>comment to display for the party</comment_for_party>  <party_agreement_text>Text to display in signature box</party_agreement_text>  <lead_id>id of related lead</lead_id>  <project_id>id of related project</project_id>  <validity_show>show validity date (0 or 1)</validity_show>  <validity_date>validity date of proposal</validity_date>  <proposal_lines>   <proposal_line>    <description>description of line</description>    <description_more>more description of line</description_more>    <unit_price>price per unit</unit_price>    <quantity>quantity</quantity>    <total_price>total line price</total_price>    <vat_value_id>id of vat (see below)</vat_value_id>    <vat_value>value of vat</vat_value>    <ordering>ordering index</ordering>   </proposal_line>  </proposal_lines> </proposal_sheet>

"Sale orders"

Find here the list of actions to apply on the objects, and the data reference for this object.

What is a sale order ?

An sale order (it is a proposal sheet of a certain kind) represents a sale confirmation to a customer.

Getting the sale orders list

GET /proposal_sheets.xml?sheet_type=sale_order

Returns all sale orders , page by page
Add a page parameter to navigate


Getting a selection of the list

Add these parameters to GET to narrow selection

  • contact_id : search by contact
  • firm_id : search by firm


Getting a single sale order

GET /proposal_sheets/#{id}.xml
Returns a single sale order identified by its id


Creating a new sale order

POST proposal_sheets.xml
Creates a new sale order , and returns thesale orderdata


Updating an existing sale order

PUT proposal_sheets/#{id}.xml
Updates some fields of an existing sale order


Deleting an existing sale order

DELETE proposal_sheets/#{id}.xml
Deletes the sale order identified by its id

Possible values of vat_id

  • 607 for 20%
  • 552 for 10%
  • 223 for 5.5%
  • 222 for 2.1%
  • 225 for 0%
  • 224 for 19.6%
  • 200036 for 7%
  • 700075 for 22%
  • 544 for 21%
  • 500041 for 19.25%
  • 529 for 19%
  • 567 for 18%
  • 200035 for 17%
  • 546 for 16%
  • 551 for 15%
  • 700007 for 14%
  • 620132 for 13%
  • 645 for 12%
  • 543 for 8.5%
  • 569 for 8.5% NPR
  • 200015 for 8%
  • 545 for 7.6%
  • 615 for 6%
  • 1019 for 5%
  • 553 for 3%
  • 700554 for 2.5%
  • 200014 for 2.4%
  • 700482 for 20% ENC
  • 700485 for 20% DEB

Possible values of proposal progress

  • 555 for En rédaction
  • 556 for Envoyé
  • 557 for Accepté
  • 558 for Refusé
  • 559 for Ajourné
  • 620105 for Terminé

Possible values of proposal sheet type

  • proposal for a proposal you send to your customers (you propose)
  • delivery_note for a delivery note you send to your customers (you deliver)
  • purchase_order for a purchase order you send to your vendors (you order)
  • production_order for an internal production order
  • insertion_order for an insertion order you send to your customers
  • sale_order for an sale order (confirmation of customer order)
  • intervention_sheet for an intervention sheet
  • loan_receipt for a loan receipt
  • price_quote for a price quote


#Object Data

<proposal_sheet>  <id>id of proposal</id>  <sheet_type>proposal or other document (see below)</sheet_type>  <progress_id>id of proposal progress (see below)</progress_id>  <contact_id>attached to contact id (0 if none)</contact_id>  <firm_id>attached to firm id (0 if none)</firm_id>  <bank_account_id>id of bank account to display on proposal</bank_account_id>  <reference>reference of proposal (automatic)</reference>  <title>title</title>  <subtitle>subtitle</subtitle>  <billing_date>date of proposal (DD-MM-YYYY)</billing_date>  <reduction_percent>percentage of reduction</reduction_percent>  <vat_value_id>vat code id (see below)</vat_value_id>  <vat_cost>vat value</vat_cost>  <shipping_cost>cost of shipping</shipping_cost>  <vat_exl_total>total of proposal without vat</vat_exl_total>  <vat_inc_total>total of proposal with vat</vat_inc_total>  <vat_exc_total_with_shipping>total of proposal without vat with shipping</vat_exc_total_with_shipping>  <billing_add_street_address>billing street address</billing_add_street_address>  <billing_add_name>billing address complement</billing_add_name>  <billing_add_zip_code>billing address zip</billing_add_zip_code>  <billing_add_city>billing address city</billing_add_city>  <billing_add_country>France</billing_add_country>  <shipping_add_street_address>shipping street address</shipping_add_street_address>  <shipping_add_name>shipping address complement</shipping_add_name>  <shipping_add_zip_code>shipping address zip</shipping_add_zip_code>  <shipping_add_city>shipping address city</shipping_add_city>  <shipping_add_country>France</shipping_add_country>  <comment_for_party>comment to display for the party</comment_for_party>  <party_agreement_text>Text to display in signature box</party_agreement_text>  <lead_id>id of related lead</lead_id>  <project_id>id of related project</project_id>  <validity_show>show validity date (0 or 1)</validity_show>  <validity_date>validity date of proposal</validity_date>  <proposal_lines>   <proposal_line>    <description>description of line</description>    <description_more>more description of line</description_more>    <unit_price>price per unit</unit_price>    <quantity>quantity</quantity>    <total_price>total line price</total_price>    <vat_value_id>id of vat (see below)</vat_value_id>    <vat_value>value of vat</vat_value>    <ordering>ordering index</ordering>   </proposal_line>  </proposal_lines> </proposal_sheet>

"Invoices"

Find here the list of actions to apply on the objects, and the data reference for this object.

What is an invoice ?

An invoice (we call it a bill sheet) represents the document your company emits to bill a product or service sale to a customer.

Getting the invoices list

GET /bill_sheets.xml

Returns all invoices , page by page
Add a page parameter to navigate


Getting a selection of the list

Add these parameters to GET to narrow selection

  • contact_id : search by contact
  • firm_id : search by firm
  • project_id : search by project
  • lead_id : search by lead
  • from_date : returns invoices with billing_date after or equal to date. format %e%%m/%Y
  • to_date : returns invoices with billing_date before or equal to date. format %e/%m/%Y


Getting a single invoice

GET /bill_sheets/#{id}.xml
Returns a single invoice identified by its id


Creating a new invoice

POST bill_sheets.xml
Creates a new invoice , and returns theinvoicedata


Updating an existing invoice

PUT bill_sheets/#{id}.xml
Updates some fields of an existing invoice


Deleting an existing invoice

DELETE bill_sheets/#{id}.xml
Deletes the invoice identified by its id

Sending an invoice by email

GET /bill_sheets/email/#{id}.xml
Generates the invoice PDF, and delivers it to the contact email.
curl -u LOGIN:PWD www.incwo.com/bill_sheets/email/
BUSINESS_FILE_ID/BILL_SHEET_ID.xml

Getting an invoice PDF

GET /bill_sheets/print/#{id}.xml
Generates the invoice PDF, attaches it to the object, and returns it.
curl -u LOGIN:PWD www.incwo.com/bill_sheets/print/
BUSINESS_FILE_ID/BILL_SHEET_ID.xml

Possible values of vat_id

  • 607 for 20%
  • 552 for 10%
  • 223 for 5.5%
  • 222 for 2.1%
  • 225 for 0%
  • 224 for 19.6%
  • 200036 for 7%
  • 700075 for 22%
  • 544 for 21%
  • 500041 for 19.25%
  • 529 for 19%
  • 567 for 18%
  • 200035 for 17%
  • 546 for 16%
  • 551 for 15%
  • 700007 for 14%
  • 620132 for 13%
  • 645 for 12%
  • 543 for 8.5%
  • 569 for 8.5% NPR
  • 200015 for 8%
  • 545 for 7.6%
  • 615 for 6%
  • 1019 for 5%
  • 553 for 3%
  • 700554 for 2.5%
  • 200014 for 2.4%
  • 700482 for 20% ENC
  • 700485 for 20% DEB

Possible values of bill progress

  • 617 : En rédaction
  • 619 : Envoyé au client
  • 618 : Terminé

Possible values of bill sheet type

  • invoice if the sheet is for an invoice
  • credit if the sheet is for a credit
  • invoice_maybe if the sheet is for an invoice to confirm
  • credit_maybe if the sheet is for a credit to confirm

Possible values of cash_deposits/kind

  • plan for an deposit date agreed in sales conditions
  • deposit for a real deposit
  • account_value for a bank account situation
  • prevision for a prevision of expected cash deposit
  • pref_client for a preferred deposit condition related to a customer
  • pref_vendor for a preferred deposit condition related to a vendor

Possible values of cash_deposits/deposit_date_model

  • 10000 : Immediate
  • 700237 : On receipt of invoice
  • 20007 : With order
  • 20008 : On delivery
  • 500035 : On delivery
  • 620106 : On installation
  • 700168 : Before shipment
  • 620083 : Net 8 days
  • 610181 : Net 15 days
  • 10001 : Net 30 days
  • 10002 : 30 days end of month
  • 10004 : 30 days end of month the 10th
  • 21070 : 35 days from billing date
  • 20006 : Net 45 days
  • 200019 : 45 days end of month
  • 700470 : 30 days end of month the 10th
  • 700455 : 45 days from billing date
  • 10003 : Net 60 days
  • 10024 : 60 days end of month
  • 10025 : 60 days end of month the 10th
  • 700174 : Net 90 days
  • 700308 : Net 90 days
  • 700416 : 1 of the month
  • 700389 : 2 of the month
  • 700392 : 3 of the month
  • 700398 : 4 of the month
  • 700407 : 5 of the month
  • 700404 : 6 of the month
  • 700413 : 7 of the month
  • 700419 : 8 of the month
  • 700422 : 9 of the month
  • 700425 : 10 of the month
  • 700410 : 11 of the month
  • 700494 : 12 of the month
  • 700497 : 13 of the month
  • 700503 : 14 of the month
  • 700509 : 15 of the month
  • 700515 : 16 of the month
  • 700521 : 17 of the month
  • 700518 : 18 of the month
  • 700512 : 19 of the month
  • 700506 : 20 of the month
  • 700539 : 21 of the month
  • 700524 : 22 of the month
  • 700527 : 23 of the month
  • 700533 : 24 of the month
  • 700530 : 25 of the month
  • 700536 : 26 of the month
  • 700500 : 27 of the month
  • 700542 : 28 of the month
  • 700545 : 29 of the month
  • 700551 : 30 of the month
  • 700548 : 31 of the month
  • 700611 : On agreed agenda


#Object Data

<bill_sheet> <sheet_type>invoice or credit note (see below)</sheet_type> <sheet_subtype>0 for invoice or 1 for fees</sheet_subtype> <progress_id>id of bill progress (see below)</progress_id> <project_id>id of related project</project_id> <reference>reference of invoice (automatic)</reference> <contact_id>attached to contact id (0 if none)</contact_id> <firm_id>attached to firm id (0 if none)</firm_id> <title>title of invoice</title> <subtitle>subtitle of invoice</subtitle> <billing_date>billing date (DD-MM-YYYY)</billing_date> <vat_value_id>vat code id (see below)</vat_value_id> <vat_cost>vat value</vat_cost> <shipping_cost>cost of shipping</shipping_cost> <vat_exl_total>total of invoice without vat</vat_exl_total> <vat_inc_total>total of invoice with vat</vat_inc_total> <vat_exc_total_with_shipping>total of invoice without vat with shipping</vat_exc_total_with_shipping> <bank_account_id>related bank account</bank_account_id> <billing_add_street_address>billing street address</billing_add_street_address> <billing_add_name>billing address complement</billing_add_name> <billing_add_zip_code>billing address zip</billing_add_zip_code> <billing_add_city>billing address city</billing_add_city> <billing_add_country>billing address country</billing_add_country> <shipping_add_street_address>shipping street address</shipping_add_street_address> <shipping_add_name>shipping address complement</shipping_add_name> <shipping_add_zip_code>shipping address zip</shipping_add_zip_code> <shipping_add_city>shipping address city</shipping_add_city> <shipping_add_country>shipping address country</shipping_add_country> <lead_id>related to lead file</lead_id> <projec_id>related to project</projec_id> <reduction_percent>global percent of reduction</reduction_percent> <partial_bill_percent>partial billing (100 for total bill)</partial_bill_percent> <late_penalty_show>should display late penalty (0 or 1)</late_penalty_show> <early_gain_show>should display early payment credit (0 or 1)</early_gain_show> <bill_lines>  <bill_line>   <description>description of line</description>   <description_more>more description of line</description_more>   <unit_price>price per unit</unit_price>   <quantity>quantity</quantity>   <total_price>total line price</total_price>   <vat_value_id>id of vat (see below)</vat_value_id>   <vat_value>value of vat</vat_value>   <ordering>ordering index</ordering>  </bill_line> </bill_lines> <cash_deposits>  <cash_deposit>   <kind>type of deposit (see below)</kind>   <direction>in | out</direction>   <payment_type_info>0</payment_type_info>   <payer_staff_id>id of paying staff</payer_staff_id>   <bank_reconciled>seen on bank account : 0 | 1</bank_reconciled>   <amount_ttc>amount</amount_ttc>   <deposit_date_model_id>date calculation model (see below)</deposit_date_model_id>   <account_date>date, format : 01-07-2013</account_date>   <comments>comments</comments>  </cash_deposit> </cash_deposits> </bill_sheet>

Cash deposits

Find here the list of actions to apply on the objects, and the data reference for this object.

What is a cash deposit ?

A cash deposit is a movement of money IN or OUT of your bank account. It's related to a sale via a bill sheet, or a purchase via an emitted payment. It can be a real movement, a movement agreed in sales conditions, or a prevision of the movement.

Getting the cash deposits list

GET /cash deposits.xml

Returns all cash deposits , page by page
Add a page parameter to navigate


Getting a selection of the list

Add these parameters to GET to narrow selection

  • what : Additional parameter to narrow search.
    Values = { bill_sheets | emitted_payments | plan | account_value | prevision }
    • bill_sheets = encaissements
    • emitted_payments = décaissements
    • plan = échéances
    • account_value = situation du compte
    • prevision = prévisionnel


Getting a single cash deposit

GET /cash deposits/#{id}.xml
Returns a single cash deposit identified by its id


Creating a new cash deposit

POST cash deposits.xml
Creates a new cash deposit , and returns thecash depositdata


Updating an existing cash deposit

PUT cash deposits/#{id}.xml
Updates some fields of an existing cash deposit


Deleting an existing cash deposit

DELETE cash deposits/#{id}.xml
Deletes the cash deposit identified by its id

Possible values of cash_deposits/kind

  • plan for an deposit date agreed in sales conditions
  • deposit for a real deposit
  • account_value for a bank account situation
  • prevision for a prevision of expected cash deposit
  • pref_client for a preferred deposit condition related to a customer
  • pref_vendor for a preferred deposit condition related to a vendor

Possible values of cash_deposits/sheet_name

  • bill_sheets when the movement is attached to a bill
  • emitted_payments when the movement is attached to a purchase
  • proposal_sheets when the movement is attached to a proposal or other
  • contacts when the movement is attached to a contact
  • firms when the movement is attached to a firm
  • leads when the movement is attached to a lead
  • other when the movement is attached to nothing

Possible values of payment type

  • 55 for Check
  • 56 for Credit card
  • 57 for Cash
  • 265 for Wire transfer
  • 370 for Coupon
  • 532 for TIP
  • 574 for Direct debit
  • 621 for Draft
  • 200037 for Draft
  • 622 for Letter of change
  • 624 for PayPal
  • 625 for Service Check
  • 500042 for Holiday Check
  • 20009 for Ticket Restaurant
  • 1020 for Compensation
  • 620099 for Compensation

Possible values of cash_deposits/deposit_date_model

  • 10000 : Immediate
  • 700237 : On receipt of invoice
  • 20007 : With order
  • 20008 : On delivery
  • 500035 : On delivery
  • 620106 : On installation
  • 700168 : Before shipment
  • 620083 : Net 8 days
  • 610181 : Net 15 days
  • 10001 : Net 30 days
  • 10002 : 30 days end of month
  • 10004 : 30 days end of month the 10th
  • 21070 : 35 days from billing date
  • 20006 : Net 45 days
  • 200019 : 45 days end of month
  • 700470 : 30 days end of month the 10th
  • 700455 : 45 days from billing date
  • 10003 : Net 60 days
  • 10024 : 60 days end of month
  • 10025 : 60 days end of month the 10th
  • 700174 : Net 90 days
  • 700308 : Net 90 days
  • 700416 : 1 of the month
  • 700389 : 2 of the month
  • 700392 : 3 of the month
  • 700398 : 4 of the month
  • 700407 : 5 of the month
  • 700404 : 6 of the month
  • 700413 : 7 of the month
  • 700419 : 8 of the month
  • 700422 : 9 of the month
  • 700425 : 10 of the month
  • 700410 : 11 of the month
  • 700494 : 12 of the month
  • 700497 : 13 of the month
  • 700503 : 14 of the month
  • 700509 : 15 of the month
  • 700515 : 16 of the month
  • 700521 : 17 of the month
  • 700518 : 18 of the month
  • 700512 : 19 of the month
  • 700506 : 20 of the month
  • 700539 : 21 of the month
  • 700524 : 22 of the month
  • 700527 : 23 of the month
  • 700533 : 24 of the month
  • 700530 : 25 of the month
  • 700536 : 26 of the month
  • 700500 : 27 of the month
  • 700542 : 28 of the month
  • 700545 : 29 of the month
  • 700551 : 30 of the month
  • 700548 : 31 of the month
  • 700611 : On agreed agenda


#Object Data

<cash_deposit>
<id>the id</id>
<kind>kind of deposit, see values below</kind>
<sheet_name>the type of object this deposit is attached to</sheet_name>
<sheet_id>the id of object this deposit is attached to</sheet_name>
<direction>in | out</direction>
<payment_type_id>mean of payment, see values below</payment_type_id>
<payment_type_info>additional info on payment type (example : check number)</payment_type_info>
<payer_staff_id>id of payer staff_member</payer_staff_id>
<bank_reconciled>seen on account ? 0 | 1</bank_reconciled>
<contact_id>id of related contact</contact_id>
<firm_id>id of related firm</firm_id>
<amount_ttc>amount with taxes</amount_ttc>
<deposit_date>13-11-2013</deposit_date>
<bank_account_id>ID of bank account</bank_account_id>
<deposit_date_model_id>Date calculation model, see values below</deposit_date_model_id>
<deposit_date_estimation>13-11-2013</deposit_date_estimation>
<sheet_reason>Additional infos</sheet_reason>
</cash_deposit>

Bank account

Find here the list of actions to apply on the objects, and the data reference for this object.

What is a bank account ?

It contains all your bank information

Getting the bank accounts list

GET /bank_accounts.xml

Returns all bank accounts , page by page
Add a page parameter to navigate



Getting a single bank account

GET /bank_accounts/#{id}.xml
Returns a single bank account identified by its id


Creating a new bank account

POST bank_accounts.xml
Creates a new bank account , and returns thebank accountdata


Updating an existing bank account

PUT bank_accounts/#{id}.xml
Updates some fields of an existing bank account


Deleting an existing bank account

DELETE bank_accounts/#{id}.xml
Deletes the bank account identified by its id


#Object Data

<bank_account>  <id>id of this object</id>  <name>your name for this bank account</name>  <bank_name>name of bank</bank_name>  <bank_code>code of bank</bank_code>  <bank_desk>number of branch</bank_desk>  <bank_account>your account</bank_account>  <bank_key>your account key</bank_key>  <bank_iban>your account iban code</bank_iban>  <bank_bic>your account bics code</bank_bic>  <bank_dom>name of branch</bank_dom>  <street_address>address of branch</street_address>  <street_address2>address of branch</street_address2>  <zip_code>zip of branch</zip_code>  <city>city of branch</city>  <country>France</country> </bank_account>

Pruchase bills

Find here the list of actions to apply on the objects, and the data reference for this object.

What is a purchase bill ?

An purchase bill (we call it an emitted payment) represents the document your company records when purchasing a past or future product or service from a vendor.

Getting the purchase bills list

GET /emitted_payments.xml

Returns all purchase bills , page by page
Add a page parameter to navigate



Getting a single purchase bill

GET /emitted_payments/#{id}.xml
Returns a single purchase bill identified by its id


Creating a new purchase bill

POST emitted_payments.xml
Creates a new purchase bill , and returns thepurchase billdata


Updating an existing purchase bill

PUT emitted_payments/#{id}.xml
Updates some fields of an existing purchase bill


Deleting an existing purchase bill

DELETE emitted_payments/#{id}.xml
Deletes the purchase bill identified by its id

Possible values of vat_id

  • 607 for 20%
  • 552 for 10%
  • 223 for 5.5%
  • 222 for 2.1%
  • 225 for 0%
  • 224 for 19.6%
  • 200036 for 7%
  • 700075 for 22%
  • 544 for 21%
  • 500041 for 19.25%
  • 529 for 19%
  • 567 for 18%
  • 200035 for 17%
  • 546 for 16%
  • 551 for 15%
  • 700007 for 14%
  • 620132 for 13%
  • 645 for 12%
  • 543 for 8.5%
  • 569 for 8.5% NPR
  • 200015 for 8%
  • 545 for 7.6%
  • 615 for 6%
  • 1019 for 5%
  • 553 for 3%
  • 700554 for 2.5%
  • 200014 for 2.4%
  • 700482 for 20% ENC
  • 700485 for 20% DEB


#Object Data

<emitted_payment>  <id>id of purchase</id>  <title>purchase details</title>  <supplier_id>id of attached contact (0 if not attached to contact)</supplier_id>  <supplier_firm_id>id of attached firm (0 if not attached to firm)</supplier_firm_id>  <supplier_name>name of supplier if not attached</supplier_name>  <payment_date>date of purchase commitment (DD-MM-YYYY)</payment_date>  <bill_reference>reference of vendor bill</bill_reference>  <amount>amount of purchase with VAT</amount>  <vat_value_id>vat id (see below)</vat_value_id>  <vat_value>vat value</vat_value>  <payed_amount>paid amount today</payed_amount>  <project_id>id of related project</project_id>  <lead_id>id of related lead</lead_id> </emitted_payment>

Pruchase orders

Find here the list of actions to apply on the objects, and the data reference for this object.

What is a purchase order ?

An purchase order (it is a proposal sheet of a certain kind) represents a purchase order you send to vendors

Getting the purchase orders list

GET /proposal_sheets.xml?sheet_type=purchase_order

Returns all purchase orders , page by page
Add a page parameter to navigate


Getting a selection of the list

Add these parameters to GET to narrow selection

  • contact_id : search by contact
  • firm_id : search by firm


Getting a single purchase order

GET /proposal_sheets/#{id}.xml
Returns a single purchase order identified by its id


Creating a new purchase order

POST proposal_sheets.xml
Creates a new purchase order , and returns thepurchase orderdata


Updating an existing purchase order

PUT proposal_sheets/#{id}.xml
Updates some fields of an existing purchase order


Deleting an existing purchase order

DELETE proposal_sheets/#{id}.xml
Deletes the purchase order identified by its id

Possible values of vat_id

  • 607 for 20%
  • 552 for 10%
  • 223 for 5.5%
  • 222 for 2.1%
  • 225 for 0%
  • 224 for 19.6%
  • 200036 for 7%
  • 700075 for 22%
  • 544 for 21%
  • 500041 for 19.25%
  • 529 for 19%
  • 567 for 18%
  • 200035 for 17%
  • 546 for 16%
  • 551 for 15%
  • 700007 for 14%
  • 620132 for 13%
  • 645 for 12%
  • 543 for 8.5%
  • 569 for 8.5% NPR
  • 200015 for 8%
  • 545 for 7.6%
  • 615 for 6%
  • 1019 for 5%
  • 553 for 3%
  • 700554 for 2.5%
  • 200014 for 2.4%
  • 700482 for 20% ENC
  • 700485 for 20% DEB

Possible values of proposal progress

  • 560 for En rédaction
  • 561 for Accord pour commander
  • 568 for Refus de commander
  • 562 for Envoyé au fournisseur
  • 700012 for Partiellement reçu
  • 563 for Reçu
  • 564 for Terminé

Possible values of proposal sheet type

  • proposal for a proposal you send to your customers (you propose)
  • delivery_note for a delivery note you send to your customers (you deliver)
  • purchase_order for a purchase order you send to your vendors (you order)
  • production_order for an internal production order
  • insertion_order for an insertion order you send to your customers
  • sale_order for an sale order (confirmation of customer order)
  • intervention_sheet for an intervention sheet
  • loan_receipt for a loan receipt
  • price_quote for a price quote


#Object Data

<proposal_sheet>  <id>id of proposal</id>  <sheet_type>proposal or other document (see below)</sheet_type>  <progress_id>id of proposal progress (see below)</progress_id>  <contact_id>attached to contact id (0 if none)</contact_id>  <firm_id>attached to firm id (0 if none)</firm_id>  <bank_account_id>id of bank account to display on proposal</bank_account_id>  <reference>reference of proposal (automatic)</reference>  <title>title</title>  <subtitle>subtitle</subtitle>  <billing_date>date of proposal (DD-MM-YYYY)</billing_date>  <reduction_percent>percentage of reduction</reduction_percent>  <vat_value_id>vat code id (see below)</vat_value_id>  <vat_cost>vat value</vat_cost>  <shipping_cost>cost of shipping</shipping_cost>  <vat_exl_total>total of proposal without vat</vat_exl_total>  <vat_inc_total>total of proposal with vat</vat_inc_total>  <vat_exc_total_with_shipping>total of proposal without vat with shipping</vat_exc_total_with_shipping>  <billing_add_street_address>billing street address</billing_add_street_address>  <billing_add_name>billing address complement</billing_add_name>  <billing_add_zip_code>billing address zip</billing_add_zip_code>  <billing_add_city>billing address city</billing_add_city>  <billing_add_country>France</billing_add_country>  <shipping_add_street_address>shipping street address</shipping_add_street_address>  <shipping_add_name>shipping address complement</shipping_add_name>  <shipping_add_zip_code>shipping address zip</shipping_add_zip_code>  <shipping_add_city>shipping address city</shipping_add_city>  <shipping_add_country>France</shipping_add_country>  <comment_for_party>comment to display for the party</comment_for_party>  <party_agreement_text>Text to display in signature box</party_agreement_text>  <lead_id>id of related lead</lead_id>  <project_id>id of related project</project_id>  <validity_show>show validity date (0 or 1)</validity_show>  <validity_date>validity date of proposal</validity_date>  <proposal_lines>   <proposal_line>    <description>description of line</description>    <description_more>more description of line</description_more>    <unit_price>price per unit</unit_price>    <quantity>quantity</quantity>    <total_price>total line price</total_price>    <vat_value_id>id of vat (see below)</vat_value_id>    <vat_value>value of vat</vat_value>    <ordering>ordering index</ordering>   </proposal_line>  </proposal_lines> </proposal_sheet>

Delivery notes

Find here the list of actions to apply on the objects, and the data reference for this object.

What is a delivery note ?

An delivery note (it is a proposal sheet of a certain kind) represents a delivery note you make for your and clients.

Getting the delivery notes list

GET /proposal_sheets.xml?sheet_type=delivery_note

Returns all delivery notes , page by page
Add a page parameter to navigate


Getting a selection of the list

Add these parameters to GET to narrow selection

  • contact_id : search by contact
  • firm_id : search by firm


Getting a single delivery note

GET /proposal_sheets/#{id}.xml
Returns a single delivery note identified by its id


Creating a new delivery note

POST proposal_sheets.xml
Creates a new delivery note , and returns thedelivery notedata


Updating an existing delivery note

PUT proposal_sheets/#{id}.xml
Updates some fields of an existing delivery note


Deleting an existing delivery note

DELETE proposal_sheets/#{id}.xml
Deletes the delivery note identified by its id

Possible values of vat_id

  • 607 for 20%
  • 552 for 10%
  • 223 for 5.5%
  • 222 for 2.1%
  • 225 for 0%
  • 224 for 19.6%
  • 200036 for 7%
  • 700075 for 22%
  • 544 for 21%
  • 500041 for 19.25%
  • 529 for 19%
  • 567 for 18%
  • 200035 for 17%
  • 546 for 16%
  • 551 for 15%
  • 700007 for 14%
  • 620132 for 13%
  • 645 for 12%
  • 543 for 8.5%
  • 569 for 8.5% NPR
  • 200015 for 8%
  • 545 for 7.6%
  • 615 for 6%
  • 1019 for 5%
  • 553 for 3%
  • 700554 for 2.5%
  • 200014 for 2.4%
  • 700482 for 20% ENC
  • 700485 for 20% DEB

Possible values of proposal progress

  • 565 for En rédaction
  • 566 for Envoyé au client
  • 700006 for Terminé

Possible values of proposal sheet type

  • proposal for a proposal you send to your customers (you propose)
  • delivery_note for a delivery note you send to your customers (you deliver)
  • purchase_order for a purchase order you send to your vendors (you order)
  • production_order for an internal production order
  • insertion_order for an insertion order you send to your customers
  • sale_order for an sale order (confirmation of customer order)
  • intervention_sheet for an intervention sheet
  • loan_receipt for a loan receipt
  • price_quote for a price quote


#Object Data

<proposal_sheet>  <id>id of proposal</id>  <sheet_type>proposal or other document (see below)</sheet_type>  <progress_id>id of proposal progress (see below)</progress_id>  <contact_id>attached to contact id (0 if none)</contact_id>  <firm_id>attached to firm id (0 if none)</firm_id>  <bank_account_id>id of bank account to display on proposal</bank_account_id>  <reference>reference of proposal (automatic)</reference>  <title>title</title>  <subtitle>subtitle</subtitle>  <billing_date>date of proposal (DD-MM-YYYY)</billing_date>  <reduction_percent>percentage of reduction</reduction_percent>  <vat_value_id>vat code id (see below)</vat_value_id>  <vat_cost>vat value</vat_cost>  <shipping_cost>cost of shipping</shipping_cost>  <vat_exl_total>total of proposal without vat</vat_exl_total>  <vat_inc_total>total of proposal with vat</vat_inc_total>  <vat_exc_total_with_shipping>total of proposal without vat with shipping</vat_exc_total_with_shipping>  <billing_add_street_address>billing street address</billing_add_street_address>  <billing_add_name>billing address complement</billing_add_name>  <billing_add_zip_code>billing address zip</billing_add_zip_code>  <billing_add_city>billing address city</billing_add_city>  <billing_add_country>France</billing_add_country>  <shipping_add_street_address>shipping street address</shipping_add_street_address>  <shipping_add_name>shipping address complement</shipping_add_name>  <shipping_add_zip_code>shipping address zip</shipping_add_zip_code>  <shipping_add_city>shipping address city</shipping_add_city>  <shipping_add_country>France</shipping_add_country>  <comment_for_party>comment to display for the party</comment_for_party>  <party_agreement_text>Text to display in signature box</party_agreement_text>  <lead_id>id of related lead</lead_id>  <project_id>id of related project</project_id>  <validity_show>show validity date (0 or 1)</validity_show>  <validity_date>validity date of proposal</validity_date>  <proposal_lines>   <proposal_line>    <description>description of line</description>    <description_more>more description of line</description_more>    <unit_price>price per unit</unit_price>    <quantity>quantity</quantity>    <total_price>total line price</total_price>    <vat_value_id>id of vat (see below)</vat_value_id>    <vat_value>value of vat</vat_value>    <ordering>ordering index</ordering>   </proposal_line>  </proposal_lines> </proposal_sheet>

"Stock movement"

Find here the list of actions to apply on the objects, and the data reference for this object.

What is a stock movement ?

A stock movement contains information about the stock movement of a customer product in a warehouse

Getting the stock movements list

GET /stock_movements.xml

Returns all stock movements , page by page
Add a page parameter to navigate



Getting a single stock movement

GET /stock_movements/#{id}.xml
Returns a single stock movement identified by its id


Creating a new stock movement

POST stock_movements.xml
Creates a new stock movement , and returns thestock movementdata


Updating an existing stock movement

PUT stock_movements/#{id}.xml
Updates some fields of an existing stock movement


Deleting an existing stock movement

DELETE stock_movements/#{id}.xml
Deletes the stock movement identified by its id

Possible values of stock_movements/direction

  • 1 for enter
  • -1 for exit
  • 99 for transfert
  • 0 for inventory


#Object Data

<stock_movement>
<id>id of movement</id>
<customer_product_id>id of product</customer_product_id>
<quantity>quantity moved</quantity>
<origin_warehouse_id>id of origin warehouse</origin_warehouse_id>
<destination_warehouse_id>id of destination</destination_warehouse_id>
<direction>direction, see below</direction>
<moved_at>date moved 06-07-2010-00-00</moved_at>
<comments/>
</stock_movement>

Serial numbers

Find here the list of actions to apply on the objects, and the data reference for this object.

What is a serial number ?

A serial number is attached to a stock movement and a product and identifies the product uniquely.

Getting the serial_numbers list

GET /serial_numbers.xml

Returns all serial_numbers , page by page
Add a page parameter to navigate



Getting a single serial_number

GET /serial_numbers/#{id}.xml
Returns a single serial_number identified by its id


Creating a new serial_number

POST serial_numbers.xml
Creates a new serial_number , and returns theserial_numberdata


Updating an existing serial_number

PUT serial_numbers/#{id}.xml
Updates some fields of an existing serial_number


Deleting an existing serial_number

DELETE serial_numbers/#{id}.xml
Deletes the serial_number identified by its id

Possible values of stock_movements/direction

  • 1 for enter
  • -1 for exit
  • 99 for transfert
  • 0 for inventory


#Object Data

<serial_number>
<id>id of the number</id>
<lot_reference>the serial number</lot_reference>
<stock_movement_id>id of stock movement</stock_movement_id>
<customer_product_id>id of product</customer_product_id>
<warehouse_id>id of warehouse</warehouse_id>
<quantity>quantity moved</quantity>
<direction>see below</direction>
<peremption_date>11-02-2013</peremption_date>
</serial_number>

Lot numbers

Find here the list of actions to apply on the objects, and the data reference for this object.

What is a lot number ?

A lot number is attached to a stock movement and a product and identifies the lot the product belongs to.

Getting the serial_lots list

GET /serial_lots.xml

Returns all serial_lots , page by page
Add a page parameter to navigate



Getting a single serial_lot

GET /serial_lots/#{id}.xml
Returns a single serial_lot identified by its id


Creating a new serial_lot

POST serial_lots.xml
Creates a new serial_lot , and returns theserial_lotdata


Updating an existing serial_lot

PUT serial_lots/#{id}.xml
Updates some fields of an existing serial_lot


Deleting an existing serial_lot

DELETE serial_lots/#{id}.xml
Deletes the serial_lot identified by its id

Possible values of stock_movements/direction

  • 1 for enter
  • -1 for exit
  • 99 for transfert
  • 0 for inventory


#Object Data

<serial_lot>
 <id>id of the lot</id>
 <lot_reference>reference of the lot</lot_reference>
 <stock_movement_id>id of stock movement</stock_movement_id>
 <customer_product_id>id of product</customer_product_id>
 <warehouse_id>id of warehouse</warehouse_id>
 <quantity>quantity moved</quantity>
 <direction>see below</direction>
 <peremption_date>11-02-2013</peremption_date>
 </serial_lot>

Project

Find here the list of actions to apply on the objects, and the data reference for this object.

What is a project ?

A project is one of the big topics of your company daily activity

Getting the projects list

GET /projects.xml

Returns all projects , page by page
Add a page parameter to navigate



Getting a single project

GET /projects/#{id}.xml
Returns a single project identified by its id


Creating a new project

POST projects.xml
Creates a new project , and returns theprojectdata


Updating an existing project

PUT projects/#{id}.xml
Updates some fields of an existing project


Deleting an existing project

DELETE projects/#{id}.xml
Deletes the project identified by its id

Possible values of status

  • 1 if active
  • 2 if suspended
  • 3 if done


#Object Data

<project>  <id>if of this object</id>  <name>project's name</name>  <reference>a reference of the project</reference>  <description></description>  <status_id>status (see below)</status_id>  <budget_euros>cost budget in euros</budget_euros>  <budget_hours>time budget in hours</budget_hours>  <budget_halfdays>time budget in hours</budget_halfdays>  <start_date>start date</start_date>  <end_date>end date</end_date> </project>

Task

Find here the list of actions to apply on the objects, and the data reference for this object.

What is a task ?

A task is a to-do item.

Getting the tasks list

GET /tasks.xml

Returns all tasks , page by page
Add a page parameter to navigate


Getting a selection of the list

Add these parameters to GET to narrow selection

  • status_id : Filter tasks by status
  • priority_id : Search tasks by prority
  • type_id : Search tasks by type
  • assigned_user_id : Search tasks assigned to
  • creator_filter : Search tasks assigned by


Getting a single task

GET /tasks/#{id}.xml
Returns a single task identified by its id


Creating a new task

POST tasks.xml
Creates a new task , and returns thetaskdata


Updating an existing task

PUT tasks/#{id}.xml
Updates some fields of an existing task


Deleting an existing task

DELETE tasks/#{id}.xml
Deletes the task identified by its id

Possible values of task status

  • 236 : En cours
  • 237 : Terminée
  • 238 : Annulée
  • 239 : Archivée

Possible values of service

  • 81 for Direction
  • 80 for Opérations
  • 79 for Commercial
  • 83 for Marketing
  • 84 for Achats
  • 575 for IT
  • 525 for R&D
  • 200016 for Production
  • 200017 for Logistique
  • 82 for Ressources Humaines
  • 85 for Administratif
  • 620 for - Non travaillé -

Possible values of task priority

  • 257 : Haute
  • 258 : Normale
  • 259 : Basse

Possible values of task importance

  • 46 : Haute
  • 44 : Normale
  • 45 : Basse


#Object Data

<task>  <id>id of the task</id>  <title>title</title>  <content>content</content>  <type_id>importance id (see below)</type_id>  <service_id>service id (see below)</service_id>  <status_id>status id (see below)</status_id>  <priority_id>priority id (see below)</priority_id>  <assigned_user_id>id of user to which the task is assigned</assigned_user_id>  <project_id>id of the project this task belongs to</project_id>  <due_at>due date</due_at>  <done_at>date at which the task was terminated</done_at>  <object_name>name of object to which the task is attached (if any)</object_name>  <object_zid>id of object to which the task is attached (if any)</object_zid> </task>

"Timesheet"

Find here the list of actions to apply on the objects, and the data reference for this object.

What is a timesheet ?

A timesheet contains indication of time spend on what.

Getting the timesheets list

GET /timesheets.xml

Returns all timesheets , page by page
Add a page parameter to navigate



Getting a single timesheet

GET /timesheets/#{id}.xml
Returns a single timesheet identified by its id


Creating a new timesheet

POST timesheets.xml
Creates a new timesheet , and returns thetimesheetdata


Updating an existing timesheet

PUT timesheets/#{id}.xml
Updates some fields of an existing timesheet


Deleting an existing timesheet

DELETE timesheets/#{id}.xml
Deletes the timesheet identified by its id

Possible values of service

  • 81 for Direction
  • 80 for Opérations
  • 79 for Commercial
  • 83 for Marketing
  • 84 for Achats
  • 575 for IT
  • 525 for R&D
  • 200016 for Production
  • 200017 for Logistique
  • 82 for Ressources Humaines
  • 85 for Administratif
  • 620 for - Non travaillé -

Possible values of unit

  • 530 : Heures
  • 531 : Demi-journees

Possible values of status

  • 76 : En cours de rédaction
  • 77 : En attente de validation
  • 600104 : Validée
  • 78 : Archivée


#Object Data

<timesheet>  <id>id of this object</id>  <period>month it is related to (date format)</period>  <user_id>user it is related to</user_id>  <status_id>timesheet status (see below)</status_id>  <validated_at>date of validation</validated_at>  <validator_id>user who validated the timesheet</validator_id>  <unit>time unit (see below)</unit>  <timesheet_lines>   <timesheet_line>    <user_id>user it is related to</user_id>    <branch_id>service it is related to (see below)</branch_id>    <day>day of month</day>    <duration>duration in the time unit of the timesheet</duration>    <description>description</description>    <comment>additional comments</comment>    <lead_id>id of related lead</lead_id>    <project_id>id of related project</project_id>   </timesheet_line>  </timesheet_lines> </timesheet>

"Staff Member"

Find here the list of actions to apply on the objects, and the data reference for this object.

What is a Staff Member ?

A staff_member is an employee, past or present, of your company.

Getting the staff members list

GET /staff_members.xml

Returns all staff members , page by page
Add a page parameter to navigate



Getting a single staff member

GET /staff_members/#{id}.xml
Returns a single staff member identified by its id


Creating a new staff member

POST staff_members.xml
Creates a new staff member , and returns thestaff memberdata


Updating an existing staff member

PUT staff_members/#{id}.xml
Updates some fields of an existing staff member


Deleting an existing staff member

DELETE staff_members/#{id}.xml
Deletes the staff member identified by its id

Possible values of civility_label_id

  • 18 : Madame
  • 634 : Mesdames
  • 19 : Mademoiselle
  • 635 : Mesdemoiselles
  • 17 : Monsieur
  • 636 : Messieurs
  • 752 : Monsieur et Madame
  • 637 : Veuve
  • 638 : Docteur
  • 639 : Docteurs
  • 640 : Professeur
  • 641 : Professeurs
  • 642 : Maitre
  • 643 : Maitres
  • 644 : Monseigneur

Possible values of family situation

  • 450 : Célibataire
  • 451 : Marié
  • 452 : Divorcé
  • 453 : Veuf
  • 454 : Concubinage


#Object Data

<staff_member>  <id>id of this object</id>  <user_id>id of the user related to this staff_member, if any</user_id>  <civility_label_id>civility (see below)</civility_label_id>  <first_name>first name of staff</first_name>  <last_name>last name of staff</last_name>  <birth_date>date of birth</birth_date>  <birth_city>city of birth</birth_city>  <birth_country_id>France (name, not id)</birth_country_id>  <nationality_country_id>France (name, not id)</nationality_country_id>  <address>address</address>  <city>city</city>  <zip>zip</zip>  <s_security_nb>social security number</s_security_nb>  <arrival_date>date of arrival in the company</arrival_date>  <departure_date>date of departure in the company (if any)</departure_date>  <job_label>name of the job</job_label>  <job_description>description of the job (several lines)</job_description>  <rank>rank of the job</rank>  <job_level>level of the job</job_level>  <job_qualification>qualification of the job</job_qualification>  <email>contact email</email>  <comment>comment</comment>  <family_situation_id>id of family situation (see below)</family_situation_id>  <salary>raw salary perceived per year</salary>  <category>category of worker (employee, intern, etc)</category>  <time_conditions>work hours</time_conditions>  <contract_type>type of contract</contract_type>  <cdi>1 if the work contract if unlimited duration contract</cdi>  <transportation>detail of transportation gratification</transportation>  <work_contract>content of work contract</work_contract>  <doc_work_contract>1 if work contract is stored</doc_work_contract>  <doc_id>1 if copy of identification card is stored</doc_id>  <doc_social_card>1 if copy of social information is stored</doc_social_card>  <rib_bank>bank info : bank</rib_bank>  <rib_sub>bank info : bank branch</rib_sub>  <rib_account>bank info : account number</rib_account>  <rib_key>bank info : key</rib_key> </staff_member>

"Month of salaries"

Find here the list of actions to apply on the objects, and the data reference for this object.

What is a Staff Member ?

A month of salary (salary_campaigns) contains the list of salaries paid to each employee this month.

Getting the month of salaries list

GET /salary_campaigns.xml

Returns all month of salaries , page by page
Add a page parameter to navigate



Getting a single month of salary

GET /salary_campaigns/#{id}.xml
Returns a single month of salary identified by its id


Creating a new month of salary

POST salary_campaigns.xml
Creates a new month of salary , and returns themonth of salarydata


Updating an existing month of salary

PUT salary_campaigns/#{id}.xml
Updates some fields of an existing month of salary


Deleting an existing month of salary

DELETE salary_campaigns/#{id}.xml
Deletes the month of salary identified by its id

Possible values of salary month status

  • 52 : En cours de rédaction
  • 53 : En attente de validation
  • 54 : Validé


#Object Data

<salary_campaign>  <id>id of this object</id>  <status_id>status of this month (see below)</status_id>  <period>month for this (a date)</period>  <salaries>   <salary>    <staff_member_id>id of staff</staff_member_id>    <base_salary>base salary paid this month</base_salary>    <base_salary_is_net>1 if base salary is net</base_salary_is_net>    <result_bonus>result bonus paid this month</result_bonus>    <result_bonus_is_net>1 if bonus is net</result_bonus_is_net>    <exceptional_bonus>exceptional bonus paid this month</exceptional_bonus>    <exceptional_bonus_is_net>1 if exceptional bonus is net</exceptional_bonus_is_net>    <vacation_days_nb>number of days of vacation this month</vacation_days_nb>    <recup_days_nb>number of days of rest this month</recup_days_nb>    <recup_gained_days>number of days of rest gained this month</recup_gained_days>    <RTT_employee_nb>number of days of employee rtt this month</RTT_employee_nb>    <RTT_employer_nb>number of days of employer rtt this month</RTT_employer_nb>    <RTT_gained_days>number of days of gained days of rtt this month</RTT_gained_days>    <vacation_gained_days>number of days of vacation gained this month</vacation_gained_days>    <sickness_days_nb>number of days of sickness this month</sickness_days_nb>    <absence_days_nb>number of days of absence this month</absence_days_nb>    <comment></comment>    <insurance>1 if employee has social insurance this month</insurance>    <arrival_day>day of arrival in the month, if in the month</arrival_day>    <departure_day>day of departure in the month, if in the month</departure_day>    <meal_tickets_nb>number of meal tickets this month</meal_tickets_nb>    <commute_zones_nb>number of transport zones</commute_zones_nb>   </salary>  </salaries> </salary_campaign>

Vacations

Find here the list of actions to apply on the objects, and the data reference for this object.

What is a vacation request ?

It's a request from an employee for days of vacations or absences

Getting the vacation requests list

GET /vacation_requests.xml

Returns all vacation requests , page by page
Add a page parameter to navigate



Getting a single vacation request

GET /vacation_requests/#{id}.xml
Returns a single vacation request identified by its id


Creating a new vacation request

POST vacation_requests.xml
Creates a new vacation request , and returns thevacation requestdata


Updating an existing vacation request

PUT vacation_requests/#{id}.xml
Updates some fields of an existing vacation request


Deleting an existing vacation request

DELETE vacation_requests/#{id}.xml
Deletes the vacation request identified by its id

Possible values of status

  • 509 : En cours de rédaction
  • 65 : En attente de validation
  • 66 : Acceptée
  • 67 : Refusée
  • 600118 : Archivée

Possible values of vacation type

  • 61 for Congé payé
  • 62 for Récupération
  • 63 for RTT employeur
  • 64 for RTT employé
  • 68 for Congé sans solde
  • 573 for Congé maladie
  • 500044 for Congé exceptionnel


#Object Data

<vacation_request>  <id>id of this object</id>  <status_id>status of request (see below)</status_id>  <staff_member_id>id of the staff member</staff_member_id>  <start_date>first day of absence</start_date>  <stop_date>day of return</stop_date>  <duration>number of days of absence</duration>  <vacation_type_id>type of absence (see below)</vacation_type_id> </vacation_request>

Expenses

Find here the list of actions to apply on the objects, and the data reference for this object.

What is an expense ?

It's a payment made by an employee on the payroll, for a purpose serving the company. This payment will be reimbursed by the company to the employee.

Getting the expenses list

GET /expense_sheets.xml

Returns all expenses , page by page
Add a page parameter to navigate



Getting a single expense

GET /expense_sheets/#{id}.xml
Returns a single expense identified by its id


Creating a new expense

POST expense_sheets.xml
Creates a new expense , and returns theexpensedata


Updating an existing expense

PUT expense_sheets/#{id}.xml
Updates some fields of an existing expense


Deleting an existing expense

DELETE expense_sheets/#{id}.xml
Deletes the expense identified by its id

Possible values of status

  • 509 : En cours de rédaction
  • 65 : En attente de validation
  • 66 : Acceptée
  • 67 : Refusée
  • 600118 : Archivée

Possible values of vacation type

  • 61 for Congé payé
  • 62 for Récupération
  • 63 for RTT employeur
  • 64 for RTT employé
  • 68 for Congé sans solde
  • 573 for Congé maladie
  • 500044 for Congé exceptionnel


#Object Data

<expense_sheet>  <id>id of this object</id>  <staff_member_id>id of staff member for this expense sheet</staff_member_id>  <vehicule_fiscal_power>fiscal power of employees vehicle</vehicule_fiscal_power>  <period>month for this expense sheet (a date)</period>  <advance_amount>advance amount paid to employee</advance_amount>  <status_id>status of expense (see below)</status_id>  <submission_date>date of submission of sheet</submission_date>  <validator_id>user id of validator</validator_id>  <validated_at>date of validation</validated_at>  <expense_lines>  <expense_line>   <day>day in the month</day>   <description>description of this</description>   <type_id>type of expense (see below)</type_id>   <amount>value including tax</amount>   <tva_pct>vat id (see below)</tva_pct>  </expense_line>  </expense_lines> </expense_sheet>

Interview

Find here the list of actions to apply on the objects, and the data reference for this object.

What is an interview ?

An interview contains the data related to the interview of a candidate for a job you offer.

Getting the interviews list

GET /interviews.xml

Returns all interviews , page by page
Add a page parameter to navigate



Getting a single interview

GET /interviews/#{id}.xml
Returns a single interview identified by its id


Creating a new interview

POST interviews.xml
Creates a new interview , and returns theinterviewdata


Updating an existing interview

PUT interviews/#{id}.xml
Updates some fields of an existing interview


Deleting an existing interview

DELETE interviews/#{id}.xml
Deletes the interview identified by its id


#Object Data

<interview> <id>id of this object</id> <interview_date>date of this interview</interview_date> <candidate_ref>reference of the candidate</candidate_ref> <target_job>expected position</target_job> <staff_member_id>staff member id of the interviewer</staff_member_id> <candidate_information>candidate has been informed or answer (see below)</candidate_information> <candidate_information_answer>comments on candidate information</candidate_information_answer> <candidate_motivation>candidate looks motivated ?</candidate_motivation> <candidate_origin>who referred the candidate ?</candidate_origin> <candidate_training>education of the candidate</candidate_training> <candidate_availability>when is candidate available</candidate_availability> <is_objectif_oriented>is candidate objectif oriented ?</is_objectif_oriented> <is_organized>is candidate organized ?</is_organized> <is_experienced>is candidate experienced ?</is_experienced> <is_organized>is candidate organized ?</is_organized> <is_rigorous>is candidate rigorous ?</is_rigorous> <is_with_initiative>has candidate initiave ?</is_with_initiative> <is_polyvalent>is candidate polyvalent ?</is_polyvalent> <is_influent>is candidate influent ?</is_influent> <is_self_conscious>is candidate self conscious ?</is_self_conscious> <is_analytical>is candidate analytical ?</is_analytical> <is_sales_oriented>is candidate sales oriented ?</is_sales_oriented> <is_competent>is candidate competent ?</is_competent> <is_potential_employee>has candidate the potential to become employee ?</is_potential_employee> <is_potential_manager>has candidate the potential to become manager ?</is_potential_manager> <is_ok_wordprocessor>is candidate ok with wordprocessor tools ?</is_ok_wordprocessor> <is_ok_spreadsheed>is candidate ok with spreadsheet tools ?</is_ok_spreadsheed> <is_ok_slideshow>is candidate ok with presentation tools ?</is_ok_slideshow> <is_ok_internetsearch>is candidate fluent in internet search ?</is_ok_internetsearch> <is_ok_spelling>is candidate's spelling ok ?</is_ok_spelling> <is_language1_fluent>is candidate fluent in another language 1 ?</is_language1_fluent> <is_language2_fluent>is candidate fluent in another language 2 ?</is_language2_fluent> <proof_objectif_oriented>description of proof of objectif orientation</proof_objectif_oriented> <proof_organized>description of proof of organization</proof_organized> <proof_experienced>description of proof of experience</proof_experienced> <proof_rigorous>description of proof of rigor</proof_rigorous> <proof_with_initiative>description of proof of initiative</proof_with_initiative> <proof_polyvalent>description of proof of polyvalence</proof_polyvalent> <proof_influent>description of proof of influence</proof_influent> <proof_self_conscious>description of proof of self-consciousness</proof_self_conscious> <proof_analytical>description of proof of analytical skills</proof_analytical> <proof_sales_oriented>description of proof of sales orientation</proof_sales_oriented> <proof_competent>description of proof of competency</proof_competent> <proof_potential_employee>why is candidate a potential employee</proof_potential_employee> <proof_potential_manager>why is candidate a potential manager</proof_potential_manager> <proof_ok_wordprocessor>description of proof of word processing skills</proof_ok_wordprocessor> <proof_ok_spreadsheed>description of proof of spreadsheet skills</proof_ok_spreadsheed> <proof_ok_slideshow>description of proof of presentation software skills</proof_ok_slideshow> <proof_ok_internetsearch>description of proof of internet search skills</proof_ok_internetsearch> <proof_ok_spelling>description of proof of good spelling</proof_ok_spelling> <proof_language1_fluent>first language</proof_language1_fluent> <proof_language2_fluent>second language</proof_language2_fluent> <would_hire>1 if would hire the candidate</would_hire> <why_would_hire>reasons why would hire</why_would_hire> <comments></comments> </interview>

Notes

Find here the list of actions to apply on the objects, and the data reference for this object.

What is a note ?

It's a piece of text of interest for your business

Getting the notes list

GET /notes.xml

Returns all notes , page by page
Add a page parameter to navigate



Getting a single note

GET /notes/#{id}.xml
Returns a single note identified by its id


Creating a new note

POST notes.xml
Creates a new note , and returns thenotedata


Updating an existing note

PUT notes/#{id}.xml
Updates some fields of an existing note


Deleting an existing note

DELETE notes/#{id}.xml
Deletes the note identified by its id

Possible values of note type

  • 474 : Information
  • 241 : Pense-bête
  • 507 : Documentation
  • 473 : Article
  • 29 : Réunion client
  • 30 : Réunion interne
  • 256 : Concurrence
  • 455 : Environnement économique
  • 240 : Idée marketing
  • 456 : Idée produit
  • 31 : R&D


#Object Data

<note>  <id>id of this object</id>  <title>title</title>  <content>content</content>  <type_id>type of note (see below)</type_id>  <link_text>the name of a link related to the note</link_text>  <link_url>the link related to the note</link_url> </note>

Files

Find here the list of actions to apply on the objects, and the data reference for this object.

What is a file ?

An upload_file is a file located on our servers. This file can be attached to nothing, or to any object of your application.

Getting the files list

GET /upload_files.xml

Returns all files , page by page
Add a page parameter to navigate


Getting a selection of the list

Add these parameters to GET to narrow selection

  • object_zname : For objects with type name (ex 'bill_sheets' for invoices)
  • object_zid : For objects with ID


Getting a single file

GET /upload_files/#{id}.xml
Returns a single file identified by its id


Creating a new file

POST upload_files.xml
Creates a new file , and returns thefiledata


Updating an existing file

PUT upload_files/#{id}.xml
Updates some fields of an existing file


Deleting an existing file

DELETE upload_files/#{id}.xml
Deletes the file identified by its id


#Object Data

<upload_file>  <id>id of this object</id>  <upload_file_name>name of the file</upload_file_name>  <object_zname>name of the object it is attached to, if any</object_zname>  <object_zid>id of the object it is attached to, if any</object_zid>  <upload_file_size>size in octets of the file</upload_file_size>  <upload_file_description>user description</upload_file_description>  <file_data>file content bytes (alternative 1)</file_data>  <file_data_in_base64>file content bytes encoded in base64 (alternative 2)</file_data_base64> </upload_file>

Contracts

Find here the list of actions to apply on the objects, and the data reference for this object.

What is a contract ?

Save in contracts all the information regarding contracts that you have signed : vendors, customers, etc.

Getting the contracts list

GET /contracts.xml

Returns all contracts , page by page
Add a page parameter to navigate



Getting a single contract

GET /contracts/#{id}.xml
Returns a single contract identified by its id


Creating a new contract

POST contracts.xml
Creates a new contract , and returns thecontractdata


Updating an existing contract

PUT contracts/#{id}.xml
Updates some fields of an existing contract


Deleting an existing contract

DELETE contracts/#{id}.xml
Deletes the contract identified by its id


#Object Data

<contract>  <signing_date>signing date</signing_date>  <title>title</title>  <party>name of signing party</party>  <staff_member_id>id of signing staff</staff_member_id>  <begin_date>date of beginning of contract</begin_date>  <end_date>date of termination of contract</end_date>  <renew_date>date of renewal of contract</renew_date>  <reference>reference</reference> </contract>