Recherche dans la base de connaissances

Propositions

Les propositions

Propositions - Ajouter de nouvelles propositions

POST  votredomaine.com/api/proposals

Header

json

Champ

Type

Description

Authorization

String

Jeton d'authentification d'accès de base.

Paramètre

json

Champ

Type

Description

subject

String

Obligatoire. Nom du sujet de la proposition.

Related

String

Obligatoire. Lié à la proposition.

Valeurs autorisées : "lead", "customer"

rel_id

Number

Obligatoire. Identifiant associé.

proposal_to

String

Obligatoire. Nom du prospect/client.

date

Date

Obligatoire. Date de début de la proposition.

open_till

Date

Facultatif. Proposition ouverte jusqu'à la date.

currency

String

Obligatoire. identifiant de devise.

discount_type

String

Facultatif. Proposition ouverte jusqu'à la date.

status

String

Facultatif. identifiant de status.

Assigned

String

Facultatif. Identifiant du cessionnaire.

Email

String

Obligatoire. Identifiant de messagerie.

newitems

Déployer

Obligatoire. Nouveaux éléments à ajouter.

Succès 200

json

Champ

Type

Description

status

booléen

État de la demande.

message

String

Proposition ajoutée réussie.

Erreur 4xx

json

Nom

Type

Description

status

booléen

État de la demande.

message

String

Échec de l'ajout de la proposition.

  • Réponse réussie

HTTP/1.1 200 OK{  "status": true,  "message": "Proposal add successful."}

  • Réponse d’erreur

HTTP/1.1 404 Not Found{  "status": false,  "message": "Proposal add fail."}

Propositions - Supprimer la proposition

SUPPRIMER  votredomaine.com/api/proposals/:id

Header

json

Champ

Type

Description

Authorization

String

Jeton d'authentification d'accès de base.

Paramètre

json

Champ

Type

Description

id

Number

ID unique de la proposition.

Succès 200

json

Champ

Type

Description

status

booléen

État de la demande.

message

String

Propositions supprimées avec succès

Erreur 4xx

json

Nom

Type

Description

status

booléen

État de la demande.

message

String

Échec de la suppression des propositions

  • Réponse réussie

HTTP/1.1 200 OK{  "status": true,  "message": "Proposals Deleted Successfully"}

  • Réponse d’erreur

HTTP/1.1 404 Not Found{  "status": false,  "message": "Proposal Delete Fail"}

Propositions - Demander des informations sur la proposition

OBTENEZ  votredomaine.com/api/proposals

Header

json

Champ

Type

Description

Authorization

String

Jeton d'authentification d'accès de base.

Paramètre

json

Champ

Type

Description

id

Number

ID unique de la proposition

Succès 200

json

Champ

Type

Description

Proposal

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",
"subject": "Test Proposal",
"content": "{proposal_items}",
"addedfrom": "1",
"datecreated": "2021-08-01 13:38:08",
"total": "10.00",
"subtotal": "10.00",
"total_tax": "0.00",
"adjustment": "0.00",
"discount_percent": "0.00",
"discount_total": "0.00",
"discount_type": "",
"show_quantity_as": "1",
"currency": "1",
"open_till": "2021-08-08",
"date": "2021-08-01",
"rel_id": "1",
"rel_type": "customer",
"assigned": "0",
"hash": "9fc38e5ad2f8256b1b8430ee41069f75",
"proposal_to": "test",
"country": "102",
"zip": "30000202",
"state": "Test",
"city": "Test",
"address": "Test",
"email": "test@gmail.com",
"phone": "01324568903",
"allow_comments": "1",
"status": "6",
"estimate_id": null,
"invoice_id": null,
"date_converted": null,
"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": [],
"items": [
{
"id": "4",
"rel_id": "1",
"rel_type": "proposal",
"description": "item 1",
"long_description": "item 1 description",
"qty": "1.00",
"rate": "10.00",
"unit": "1",
"item_order": "1"
}
],
"visible_attachments_to_customer_found": false,
"customfields": [
{
"label": "Custom Field",
"value": "Custom Field value"
}
]
}

  • Réponse d’erreur

HTTP/1.1 404 Not Found{  "status": false,  "message": "No data were found"}

Propositions - Rechercher des informations sur les propositions

OBTENEZ  votredomaine.com/api/proposals/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

Proposals

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",
"subject": "Test 2",
"content": "{proposal_items}",
"addedfrom": "1",
"datecreated": "2021-08-01 13:43:49",
"total": "10.00",
"subtotal": "10.00",
"total_tax": "0.00",
"adjustment": "0.00",
"discount_percent": "0.00",
"discount_total": "0.00",
"discount_type": "",
"show_quantity_as": "1",
"currency": "1",
"open_till": "2021-08-08",
"date": "2021-08-01",
"rel_id": "1",
"rel_type": "customer",
"assigned": "0",
"hash": "6fe6cd0bc66dff03663154660acc1a93",
"proposal_to": "test",
"country": "102",
"zip": "300000",
"state": "test",
"city": "test",
"address": "test",
"email": "test@gmail.com",
"phone": "01324568903",
"allow_comments": "1",
"status": "6",
"estimate_id": null,
"invoice_id": null,
"date_converted": null,
"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",
"customfields": [
{
"label": "Custom Field",
"value": "Custom Field value"
}
]
}

  • Réponse d’erreur

HTTP/1.1 404 Not Found{  "status": false,  "message": "No Data Were Found"}

Propositions - Mettre à jour une proposition

PUT  votredomaine.com/api/proposal/:id

Header

json

Champ

Type

Description

Authorization

String

Jeton d'authentification d'accès de base.

Paramètre

json

Champ

Type

Description

subject

String

Obligatoire. Nom du sujet de la proposition.

  

String

Lié à la proposition.

Valeurs autorisées : "lead", "customer"

rel_id

Number

Obligatoire. Identifiant associé.

proposal_to

String

Obligatoire. Nom du prospect/client.

date

String

Obligatoire. Date de début de la proposition.

open_till

string

Facultatif. Proposition ouverte jusqu'à la date.

currency

Number

Obligatoire. identifiant de devise.

discount_type

string

Facultatif. Proposition ouverte jusqu'à la date.

status

Date

Facultatif. identifiant de status.

Assigned

Date

Facultatif. Identifiant du cessionnaire.

Email

string

Obligatoire. Identifiant de messagerie.

newitems

string

Obligatoire. Nouveaux éléments à ajouter.

items

string

Facultatif. Articles existants avec ID

removed_items

string

Facultatif. Éléments à retirer

  • Réponse réussie

HTTP/1.1 200 OK{  "status": false,  "message": "Proposal Updated Successfully"}

  • Réponse d’erreur

HTTP/1.1 404 Not Found{  "status": false,  "message": "Proposal Update Fail"}

 

Avez-vous trouvé cet article utile ?

Articles associés

  • Introduction

    API REST GlueCRM Commandes disponibles et exemples d'API REST pour GlueCRM Introduction L'API foncti...

  • Clients

    Client Client - Ajouter un nouveau client POST votredomaine.com/api/customers Header json Champ...

  • Contacts

    Contact Contact - Ajouter un nouveau contact POST votredomaine.com/api/contacts/ Header json Ch...

  • Factures

    Facture Facture - Ajouter une nouvelle facture POST votredomaine.com/api/invoices Header json C...

  • Articles

    Articles Articles - Demander des informations sur les articles OBTENEZ votredomaine.com/api/items/i...