Bons de commande

Obtenir des bons de commande

GET /purchaseorders/purchaseorders[/status/#{status}][/start_date/#{start_date}][/end_date/#{end_date}][/clients/#{clients}][/tags/#{tags}][/number/#{number}][/amount_total_operator/#{amount_total_operator}][/amount_total/#{amount_total}][/currency/#{currency}][/user/#{user_id}]

Arguments de l'URI

Argument	Type	Requis	Valeur/Description
status	string		Un ou des statuts à filtrer. Vous pouvez passer plusieurs statuts en même temps en les séparant par ":". Par exemple : /status/draft:sent:unsigned Voir les valeurs possibles de status.
start_date	date		Si l'argument n'est pas renseigné, la valeur par défaut est le premier jour du mois courant.
end_date	date		Si l'argument n'est pas renseigné, la valeur par défaut est le dernier jour du mois courant.
clients	string		Un ou des clients à filtrer. Vous pouvez passer plusieurs clients en même temps en les séparant par ":". Par exemple : /clients/Client%20Name:Another%20Client%20Name
tags	string		Un ou des tags à filtrer. Vous pouvez passer plusieurs tags en même temps en les séparant par ":". Par exemple : /tags/Tag%201:Tag%202
number	string		Tout ou partie d'un numéro de bon de commande à filtrer (équivalent à la fonction MySQL "LIKE '#{number}%'".
amount_total_operator	string		Voir les valeurs possibles de operator.
amount_total	double		Un montant total.
currency	string		Voir les valeurs possibles de currency.
user	integer		Le #{user_id} de l'utilisateur pour lequel filtrer les résultats.

Exemple de requête avec cURL

	
curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/purchaseorders/purchaseorders/start_date/2010-09-01
	

Exemple de réponse XML

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?>
<xml>
	<purchaseorders>
		<purchaseorder>
			<purchaseorder_id>4</purchaseorder_id>
			<company_name>Company Name</company_name>
			<client_id>2</client_id>
			<purchaseorder_number>BC10090004</purchaseorder_number>
			<estimate_number>D10090005</estimate_number>
			<related_estimate_id>5</related_estimate_id>
			<date_purchaseorder>2010-09-29</date_purchaseorder>
			<total>600</total><!-- Total HT -->
			<grand_total>717.6</grand_total><!-- Total TTC -->
			<currency>EUR</currency>
			<status>draft</status>
		</purchaseorder>
		<purchaseorder>
		...
		</purchaseorder>
	</purchaseorders>
</xml>
	

Haut

---

Obtenir un bon de commande

GET /purchaseorders/purchaseorder/id/#{purchaseorder_id}

Arguments de l'URI

Argument	Type	Requis	Valeur
id	integer	oui	Le #{purchaseorder_id} de commande que vous souhaitez obtenir.

Exemple de requête avec cURL

	
curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/purchaseorders/purchaseorder/id/4
	

Exemple de réponse XML

HTTP Status: 200 OK

<xml>
	<purchaseorder>
		<purchaseorder_id>4</purchaseorder_id>
		<user_id>1</user_id>
		<company_id>1</company_id>
		<company_name>Company Name</company_name>
                <summary></summary>
		<client_id>2</client_id>
		<client_name>Client Name</client_name>
		<client_language>french</client_language>
		<client_tax_id></client_tax_id>
		<purchaseorder_number>BC10090004</purchaseorder_number>
		<related_estimate_number>D10090005</related_estimate_number>
		<related_estimate_id>5</related_estimate_id>
		<related_invoice_id>24</related_invoice_id>
		<date_creation>2010-09-29 15:03:25</date_creation>
		<date_purchaseorder>2010-09-29</date_purchaseorder>
		<total>600</total><!-- Total HT -->
		<global_discount_total>0</global_discount_total>
		<global_discount_percentage>0</global_discount_percentage>
		<sub_total>600</sub_total><!-- Sous-total HT -->
		<tax_total>117.6</tax_total>
		<alt_tax_total>0</alt_tax_total>
		<tax_name>TVA</tax_name>
		<tax_percentage>19.6</tax_percentage>
		<alt_tax_name>TVA</alt_tax_name>
		<alt_tax_percentage>5.5</alt_tax_percentage>
		<use_tax_inclusive>0</use_tax_inclusive>
		<taxation_mode>simple</taxation_mode>
		<grand_total>717.6</grand_total><!-- Total TTC -->
		<currency>EUR</currency>
		<terms>0</terms>
		<custom_terms></custom_terms>
		<due_date>2010-09-29</due_date>
		<payment>VIR</payment>
		<payment_specified></payment_specified>
		<late_fee>0</late_fee>
		<late_fee_specified>0</late_fee_specified>
		<billing_address>
			<name>Client Name</name>
			<address1></address1>
			<address2></address2>
			<address3></address3>
			<address4></address4>
			<city></city>
			<state></state>
			<postalcode></postalcode>
			<country>FR</country>
		</billing_address>
		<terms_of_agreement></terms_of_agreement>
		<status>draft</status>
		<lines>
			<line>
				<line_id>7</line_id>
				<line_number>1</line_number>
				<kind>1</kind>
				<qty>4</qty>
				<description>Lorem ipsum dolor sit amet</description>
				<tax_percentage>19.6</tax_percentage>
				<alt_tax_percentage>0</alt_tax_percentage>
				<unit_price>200</unit_price>
				<reduction_percentage>0</reduction_percentage>
			</line>
		</lines>
	</purchaseorder>
</xml>
	

Haut

---

Obtenir un bon de commande au format PDF

GET /purchaseorders/purchaseorder/id/#{purchaseorder_id}/format/pdf

Arguments de l'URI

Argument	Type	Requis	Valeur
id	integer	oui	Le #{purchaseorder_id} du bon de commande que vous souhaitez obtenir.

Exemple de requête avec cURL

	
curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/purchaseorders/purchaseorder/id/4/format/pdf
	

Exemple de réponse XML

HTTP Status: 200 OK
Content-Type: application/pdf

%PDF-1.4

...

%%EOF
	

Haut

---

Mettre à jour le statut d'un bon de commande

PUT /purchaseorders/purchaseorder_status/id/#{purchaseorder_id}

Arguments de l'URI

Argument	Type	Requis	Valeur
id	integer	oui	Le #{purchaseorder_id} du bon de commande dont vous souhaitez modifier le statut.

Champs de la requête

Champ	Type	Requis	Description
status	string	oui	Voir les valeurs possibles de status.

Exemple de requête avec cURL

curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X PUT\
-d "status=sent"\
https://#{subdomain}.iscriba.com/api/purchaseorders/purchaseorder_status/id/1
	

Exemple de réponse XML

HTTP Response: 200 OK

<?xml version="1.0" encoding="utf-8"?>
<xml>
	<purchaseorder>
		<id>1</id>
		<status>sent</status>
	</purchaseorder>
</xml>	
	

Haut

---

Obtenir les documents liés à un bon de commande

GET /purchaseorders/purchaseorder_related_documents/id/#{purchaseorder_id}

Arguments de l'URI

Argument	Type	Requis	Valeur
id	integer	oui	Le #{purchaseorder_id} du bon de commande dont vous souhaitez obtenir les documents liés.

Exemple de requête avec cURL

	
curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/purchaseorders/purchaseorder_related_documents/id/19
	

Exemple de réponse XML

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?>
<xml>
	<purchaseorder_related_documents>
		<purchaseorder_related_document>
			<id>6</id>
			<number>BL10120001</number>
			<date_creation>2010-12-01 16:54:29</date_creation>
			<date>2010-12-01</date>
			<total></total>
			<currency></currency>
			<type></type>
			<kind>packinglist</kind>
			<status>draft</status>
		</purchaseorder_related_document>
		<purchaseorder_related_document>
			...
		</purchaseorder_related_document>
	</purchaseorder_related_documents>
</xml>
	

Haut

---

Obtenir les tags liés à un bon de commande

GET /purchaseorders/purchaseorder_related_tags/id/#{purchaseorder_id}

Arguments de l'URI

Argument	Type	Requis	Valeur
id	integer	oui	Le #{purchaseorder_id} du bon de commande dont vous souhaitez obtenir les tags liés.

Exemple de requête avec cURL

	
curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/purchaseorders/purchaseorder_related_tags/id/19
	

Exemple de réponse XML

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?>
<xml>
	<purchaseorder_related_tags>
		<purchaseorder_related_tag>
			<tag_id>5</tag_id>
			<tag_name>lorem</tag_name>
		</purchaseorder_related_tag>
		<purchaseorder_related_tag>
		...
		</purchaseorder_related_tag>
	</purchaseorder_related_tags>
</xml>
	

Haut

---