Paiements

Obtenir des paiements

GET /payments/payments/[/start_date/#{start_date}][/end_date/#{end_date}][/clients/#{clients}][/number/#{number}][/amount_operator/#{amount_operator}][/amount/#{amount}][/currency/#{currency}]

Arguments de l'URI

Argument	Type	Requis	Valeur/Description
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
number	string		Tout ou partie d'un numéro de paiement à filtrer (équivalent à la fonction MySQL "LIKE '#{number}%'".
amount_operator	string		Voir les valeurs possibles de operator.
amount	double		Un montant.
currency	string		Voir les valeurs possibles de currency.

Exemple de requête avec cURL

	
curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/payments/payments/currency/EUR
	

Exemple de réponse XML

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?>
<xml>
	<payments>
		<payment>
			<payment_id>2</payment_id>
			<number>000002</number>
			<client_name>Client Name</client_name>
			<amount>80.4</amount>
			<amount_unapplied>0</amount_unapplied>
			<currency>EUR</currency>
			<date>2010-12-09</date>
			<method>CRE</method>
			<method_specified></method_specified>
			<reference_number>000001</reference_number>
			<notes></notes>
			<invoices>
				<invoice>
					<invoice_id>29</invoice_id>
					<invoice_number>F10120002</invoice_number>
					<grand_total>119.6</grand_total>
					<amount_applied>80.4</amount_applied>
					<amount_unapplied>0</amount_unapplied>
					<status>ppaid</status>
				</invoice>
			</invoices>
		</payment>
		<payment>
			<payment_id>1</payment_id>
			<number>000001</number>
			<client_name>Client Name</client_name>
			<amount>200</amount>
			<amount_unapplied>0</amount_unapplied>
			<currency>EUR</currency>
			<date>2010-12-09</date>
			<method>CHQ</method>
			<method_specified></method_specified>
			<reference_number>2125232</reference_number>
			<notes></notes>
			<invoices>
			    <invoice>
			    	<invoice_id>28</invoice_id>
			    	<invoice_number>F10120001</invoice_number>
			    	<grand_total>119.6</grand_total>
			    	<amount_applied>119.6</amount_applied>
			    	<amount_unapplied>0</amount_unapplied>
			    	<status>paid</status>
			    </invoice>
			</invoices>
			<credits>
			    <credit>
			    	<payment_id>2</payment_id>
			    	<number>000002</number>
			    	<date>2010-12-09</date>
			    	<amount>80.4</amount>
			    </credit>
			</credits>
		</payment>
		<payment>
		...
		</payment>
	</payments>
</xml>
	

Haut

---

Obtenir un paiement

GET /payments/payment/id/#{payment_id}

Arguments de l'URI

Argument	Type	Requis	Valeur
id	integer	oui	Le #{payment_id} du paiement 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/payments/payment/id/1
	

Exemple de réponse XML

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?>
<xml>
	<payment>
		<payment_id>1</payment_id>
		<number>000001</number>
		<client_name>Client Name</client_name>
		<amount>200</amount>
		<amount_unapplied>0</amount_unapplied>
		<currency>EUR</currency>
		<date>2010-12-09</date>
		<method>CHQ</method>
		<method_specified></method_specified>
		<reference_number>2125232</reference_number>
		<notes></notes>
		<invoices>
			<invoice>
				<invoice_id>28</invoice_id>
				<invoice_number>F10120001</invoice_number>
				<grand_total>119.6</grand_total>
				<amount_applied>119.6</amount_applied>
				<amount_unapplied>0</amount_unapplied>
				<status>paid</status>
			</invoice>
		</invoices>
		<credits>
			<credit>
				<payment_id>2</payment_id>
				<number>000002</number>
				<date>2010-12-09</date>
				<amount>80.4</amount>
			</credit>
		</credits>
	</payment>
</xml>
	

Haut

---

Recevoir un paiement

POST /payments/payment

Champs de la requête

Champ	Type	Requis	Description
amount	double	oui	Le montant du paiement.
client_id	integer	oui	Le #{client_id} du client pour lequel vous recevez le paiement.
currency	string	oui	Monnaie du paiement. Voir les valeurs possibles de currency.
date	date		Date du paiement. Si le champ n'est pas envoyé, la valeur par défaut est le jour courant.
payment	string		Mode de règlement. La valeur par défaut est celle des paramètres de votre compte. Voir les valeurs possibles de payment.
reference_number	string		Une référence représentant le paiement. Cela peut par exemple être un numéro de chèque.
notes	string		Les notes que vous souhaitez ajouter au paiement
invoices	array	oui (au moins une ligne)	Les factures sur lesquelles vous souhaitez distributer le paiement.
invoices[#{invoice_id}]	double	oui	Le montant que vous souhaitez distribuer à la facture.

Exemple de requête avec cURL

curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-d "amount=99.99&client_id=10&currency=EUR&invoices[10]=99.99"\
https://#{subdomain}.iscriba.com/api/payments/payment
	

Exemple de réponse XML

HTTP Status: 201 Created

<?xml version="1.0" encoding="utf-8"?>
<xml>
	<payment_id>1</payment_id>
</xml>	
	

Haut

---

Supprimer un paiement

DELETE /payments/payment/id/#{payment_id}

Arguments de l'URI

Argument	Type	Requis	Valeur
id	integer	oui	Le #{payment_id} du paiement que vous souhaitez supprimer.

Exemple de requête avec cURL

curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X DELETE https://#{subdomain}.iscriba.com/api/payments/payment/id/1
	

Exemple de réponse XML

HTTP Response: 200 OK

<?xml version="1.0" encoding="utf-8"?>
<xml>
	<payment_id>1</payment_id>
</xml>	
	

Haut

---

Utiliser un crédit

POST /payments/credit

Champs de la requête

Champ	Type	Requis	Description
payment_id	integer	oui	Le #{payment_id} du paiement pour lequel vous souhaitez utiliser le montant disponible.
client_id	integer	oui	Le #{client_id} du client pour lequel vous recevez le paiement.
currency	string	oui	Monnaie du paiement. Voir les valeurs possibles de currency.
date	date		Date du paiement. Si le champ n'est pas envoyé, la valeur par défaut est le jour courant.
notes	string		Les notes que vous souhaitez ajouter au paiement.
invoices	array	oui (au moins une ligne)	Les factures sur lesquelles vous souhaitez distributer le paiement.
invoices[#{invoice_id}]	double	oui	Le montant que vous souhaitez distribuer à la facture.

Exemple de requête avec cURL

curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-d "payment_id=1&client_id=10&currency=EUR&invoices[15]=12.30"\
https://#{subdomain}.iscriba.com/api/payments/credit
	

Exemple de réponse XML

HTTP Status: 201 Created

<?xml version="1.0" encoding="utf-8"?>
<xml>
	<payment_id>1</payment_id>
</xml>	
	

Haut

---