Estimations
Estimations - Ajouter de nouvelles estimations
POST votredomaine.com/api/estimates
Header
json
|
Champ |
Type |
Description |
|
Authorization |
String |
Jeton d'authentification d'accès de base. |
Paramètre
json
|
Champ |
Type |
Description |
|
clientid |
Number |
Obligatoire. Customer_id |
|
number |
Number |
Obligatoire. Number d'estimations |
|
date |
Date |
Obligatoire. Date des estimations |
|
duedate (facultatif) |
Date |
Facultatif. Date d'expiration des estimations |
|
currency |
Number |
Obligatoire. champ de devise |
|
newitems |
Déployer |
Obligatoire. Nouveaux éléments à ajouter |
|
subtotal |
Décimal |
Obligatoire. calcul basé sur la quantité, le taux et la taxe de l'article |
|
total |
Décimal |
Obligatoire. calcul basé sur le sous-total, la remise et l'ajustement |
|
billing_street |
String |
Facultatif. Adresse de la rue |
|
billing_city (facultatif) |
String |
Facultatif. Nom de la ville pour la facturation |
|
billing_state (facultatif) |
String |
Facultatif. Nom de l'état pour la facturation |
|
billing_zip (facultatif) |
Number |
Facultatif. Code postal |
|
billing_country (facultatif) |
Number |
Facultatif. Code postal |
|
shipping_street (facultatif) |
String |
Facultatif. Adresse d'expédition |
|
shipping_city (facultatif) |
String |
Facultatif. Nom de la ville pour l'expédition |
|
shipping_state (facultatif) |
String |
Facultatif. Nom de l'état pour l'expédition |
|
shipping_zip (facultatif) |
Number |
Facultatif. Code postal pour l'expédition |
|
shipping_country (facultatif) |
Number |
Facultatif. Code postal |
|
tags (facultatif) |
String |
Facultatif. Tags (séparés par des virgules |
|
status (facultatif) |
Number |
Facultatif. ID de status (le status par défaut est Accepté) |
|
Reference (facultatif) |
String |
Facultatif. Nom de référence |
|
sale_agent (facultatif) |
Number |
Facultatif. Nom de l'agent de vente |
|
adminnote (facultatif) |
String |
Facultatif. notes de l'administrateur |
|
clientnote (facultatif) |
String |
Facultatif. remarques clients |
|
terms (facultatif) |
String |
Facultatif. Conditions |
Succès 200
json
|
Champ |
Type |
Description |
|
status |
booléen |
État de la demande. |
|
message |
String |
Estimations ajoutées avec succès |
Erreur 4xx
json
|
Nom |
Type |
Description |
|
status |
booléen |
État de la demande. |
|
message |
String |
Échec de l'ajout des estimations |
|
newitems[] |
String |
Le champ Articles est obligatoire |
|
number |
String |
Le numéro de devis est déjà utilisé |
|
subtotal |
String |
Le champ Sous-total est obligatoire |
|
total |
String |
Le champ Total est obligatoire |
-
Réponse réussie
HTTP/1.1 200 OK{ "status": true, "message": "Estimates Added Successfully"}
-
Réponse d’erreur
HTTP/1.1 404 Not Found{ "status": false, "message": "Estimates Add Fail"}
Estimations - Supprimer l'estimation
SUPPRIMER votredomaine.com/api/estimates/:id
Header
json
|
Champ |
Type |
Description |
|
Authorization |
String |
Jeton d'authentification d'accès de base. |
Succès 200
json
|
Champ |
Type |
Description |
|
status |
booléen |
État de la demande. |
|
message |
String |
Estimations supprimées avec succès |
Erreur 4xx
json
|
Nom |
Type |
Description |
|
status |
booléen |
État de la demande. |
|
message |
String |
Échec de la suppression de l'estimation |
-
Réponse réussie
HTTP/1.1 200 OK{ "status": true, "message": "Estimate Deleted Successfully"}
-
Réponse d’erreur
HTTP/1.1 404 Not Found{ "status": false, "message": "Estimate Delete Fail"}
Devis - Demander des informations sur le devis
OBTENEZ votredomaine.com/api/estimates/:id
Header
json
|
Champ |
Type |
Description |
|
Authorization |
String |
Jeton d'authentification d'accès de base. |
Paramètre
json
|
Champ |
Type |
Description |
|
id |
Number |
Contacter l'identifiant unique |
Succès 200
json
|
Champ |
Type |
Description |
|
Estimate |
Objet |
information. |
Erreur 4xx
json
|
Nom |
Type |
Description |
|
status |
booléen |
État de la demande. |
|
message |
String |
Aucune donnée n'a été trouvée. |
-
Réponse réussie
HTTP/1.1 200 OK{"id": "1","sent": "0","datesend": null,"clientid": "1","deleted_customer_name": null,"project_id": "0","number": "1","prefix": "EST-","number_format": "1","hash": "b12ae9de6471d0cf153d7846f05128af","datecreated": "2021-07-31 11:06:49","date": "2021-07-31","expirydate": "2021-08-07","currency": "1","subtotal": "1200.00","total_tax": "0.00","total": "1200.00","adjustment": "0.00","addedfrom": "1","status": "1","clientnote": "","adminnote": "","discount_percent": "0.00","discount_total": "0.00","discount_type": "","invoiceid": null,"invoiced_date": null,"terms": "","reference_no": "","sale_agent": "0","billing_street": "Thangadh, Gujarat, India<br />\r\nShipping","billing_city": "Thangadh","billing_state": "Gujarat","billing_zip": "363630","billing_country": "102","shipping_street": "Thangadh, Gujarat, India<br />\r\nShipping","shipping_city": "Thangadh","shipping_state": "Gujarat","shipping_zip": "363630","shipping_country": "102","include_shipping": "1","show_shipping_on_estimate": "1","show_quantity_as": "1","pipeline_order": "0","is_expiry_notified": "0","acceptance_firstname": null,"acceptance_lastname": null,"acceptance_email": null,"acceptance_date": null,"acceptance_ip": null,"signature": null,"short_link": null,"symbol": "$","name": "USD","decimal_separator": ".","thousand_separator": ",","placement": "before","isdefault": "1","currencyid": "1","currency_name": "USD","attachments": [],"visible_attachments_to_customer_found": false,"items": [{"id": "2","rel_id": "1","rel_type": "estimate","description": "test","long_description": "test","qty": "1.00","rate": "1200.00","unit": "1","item_order": "1"}],"client": {"userid": "1","company": "test","vat": "","phonenumber": "01324568903","country": "102","city": "test","zip": "3000","state": "Test","address": "Test","website": "","datecreated": "2021-07-30 16:29:46","active": "1","leadid": null,"billing_street": "Test","billing_city": "Test","billing_state": "Test","billing_zip": "3000","billing_country": "102","shipping_street": "Test","shipping_city": "Test","shipping_state": "Test","shipping_zip": "3000","shipping_country": "102","longitude": null,"latitude": null,"default_language": "","default_currency": "0","show_primary_contact": "0","stripe_id": null,"registration_confirmed": "1","addedfrom": "1"},"scheduled_email": null,"customfields": []}
-
Réponse d’erreur
HTTP/1.1 404 Not Found{ "status": false, "message": "No data were found"}
Estimations - Rechercher des informations sur les estimations
OBTENEZ votredomaine.com/api/estimates/search/:keysearch
Header
json
|
Champ |
Type |
Description |
|
Authorization |
String |
Jeton d'authentification d'accès de base. |
Paramètre
json
|
Champ |
Type |
Description |
|
keysearch |
String |
Rechercher des mots-clés. |
Succès 200
json
|
Champ |
Type |
Description |
|
Estimate |
Objet |
Information. |
Erreur 4xx
json
|
Nom |
Type |
Description |
|
status |
booléen |
État de la demande. |
|
message |
String |
Aucune donnée n'a été trouvée. |
-
Réponse réussie
HTTP/1.1 200 OK{"id": "2","sent": "0","datesend": null,"clientid": "1","deleted_customer_name": null,"project_id": "0","number": "2","prefix": "EST-","number_format": "1","hash": "ac754972999f948ade369c70bb44d696","datecreated": "2021-07-30 16:29:46","date": "2021-08-01","expirydate": "2021-08-08","currency": "1","subtotal": "1200.00","total_tax": "0.00","total": "1200.00","adjustment": "0.00","addedfrom": "1","status": "1","clientnote": "","adminnote": "adminnote","discount_percent": "0.00","discount_total": "0.00","discount_type": "","invoiceid": null,"invoiced_date": null,"terms": "","reference_no": "","sale_agent": "0","billing_street": "Test","billing_city": "Test","billing_state": "Test","billing_zip": "3000","billing_country": "102","shipping_street": "Test","shipping_city": "Test","shipping_state": "Test","shipping_zip": "3000","shipping_country": "102","include_shipping": "1","show_shipping_on_estimate": "1","show_quantity_as": "1","pipeline_order": "0","is_expiry_notified": "0","acceptance_firstname": null,"acceptance_lastname": null,"acceptance_email": null,"acceptance_date": null,"acceptance_ip": null,"signature": null,"short_link": null,"userid": "1","company": "test","vat": "","phonenumber": "01324568903","country": "102","city": "Test","zip": "3000","state": "Test","address": "Test","website": "","active": "1","leadid": null,"longitude": null,"latitude": null,"default_language": "","default_currency": "0","show_primary_contact": "0","stripe_id": null,"registration_confirmed": "1","estimateid": "2","customfields": []}
-
Réponse d’erreur
HTTP/1.1 404 Not Found{ "status": false, "message": "No Data Were Found"}
Estimations - Mettre à jour une estimation
METTRE votredomaine.com/api/estimates/:id
Header
json
|
Champ |
Type |
Description |
|
Authorization |
String |
Jeton d'authentification d'accès de base. |
Paramètre
json
|
Champ |
Type |
Description |
|
clientid |
String |
Obligatoire. Client. |
|
billing_street |
String |
Obligatoire. Adresse de la rue |
|
billing_city (facultatif) |
String |
Facultatif. Nom de la ville pour la facturation |
|
billing_state (facultatif) |
String |
Facultatif. Nom de l'état pour la facturation |
|
billing_zip (facultatif) |
Number |
Facultatif. Code postal |
|
billing_country (facultatif) |
Number |
Facultatif. Code postal |
|
include_shipping (facultatif) |
booléen |
Facultatif. définissez oui si vous voulez ajouter une adresse de livraison Valeur par défaut:no |
|
show_shipping_on_estimate (facultatif) |
booléen |
Facultatif. Affiche les détails d'expédition dans l'estimation. |
|
shipping_street (facultatif) |
String |
Facultatif. Adresse d'expédition |
|
shipping_city (facultatif) |
String |
Facultatif. Nom de la ville pour l'expédition |
|
shipping_state (facultatif) |
String |
Facultatif. Nom de l'état pour l'expédition |
|
shipping_zip (facultatif) |
Number |
Facultatif. Code postal pour l'expédition |
|
shipping_country (facultatif) |
Number |
Facultatif. Code postal |
|
number |
Number |
Obligatoire. Estimation du Number |
|
date |
Date |
Obligatoire. Date d'estimation |
|
expirydate (facultatif) |
Date |
Facultatif. Date d'expiration de l'estimation |
|
tags (facultatif) |
String |
Facultatif. Tags (séparés par des virgules |
|
currency |
Number |
Obligatoire. champ de devise |
|
status |
Number |
Obligatoire. Status de l'estimation (par exemple, brouillon, envoyé) |
|
reference_no (facultatif) |
String |
Facultatif. Référence # |
|
sale_agent (facultatif) |
Number |
Facultatif. Nom de l'agent de vente |
|
discount_type (facultatif) |
String |
Facultatif. type de réduction avant taxes / après taxes |
|
adminnote (facultatif) |
String |
Facultatif. notes de l'administrateur |
|
items (facultatif) |
Déployer |
Obligatoire. Articles existants avec ID |
|
removed_items (facultatif) |
Déployer |
Facultatif. Éléments à retirer |
|
newitems (facultatif) |
Déployer |
Facultatif. Nouveaux éléments à ajouter |
|
subtotal |
Décimal |
Obligatoire. calcul basé sur la quantité, le taux et la taxe de l'article |
|
total |
Décimal |
Obligatoire. calcul basé sur le sous-total, la remise et l'ajustement |
|
clientnote (facultatif) |
String |
Facultatif. remarques clients |
|
terms (facultatif) |
String |
Facultatif. Conditions |
Erreur 4xx
json
|
Nom |
Type |
Description |
|
Number |
String |
Le numéro d'estimation est déjà utilisé |
-
Réponse réussie
HTTP/1.1 200 OK{ "status": false, "message": "Estimate Updated Successfully"}
-
Réponse d’erreur
HTTP/1.1 404 Not Found{ "status": false, "message": "Estimate Update Fail"}