API Reference

for object "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 the contract data




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>