I am going to implement following methods
- Account
- Though API, you can obtain all necessary information about the account: name, paid period, account’s users and their privileges, guides on custom contact and lead fields, lead status guide, event types guide, task types guide and other account parameters.
- getCurrentAccount : Acquisition of information on the authorized account.
- Lead
- This is one of the general entities of the system.
- It consists of a predefined set of fields and custom fields created by the account administrator.
- Each lead can be linked to one or more contacts, or to none.
- A responsible user may be assigned to each lead in order to assign access privileges among the account’s personnel.
- Each lead has a status, which specifies the current position of the lead within its lifecycle (business process).
- Status must be necessarily assigned to any lead.
- The list of statuses within the account may be changed except for two final system statuses.
- createLeads : This method allows to create new leads, and also to update information on the already existing leads.
- getLeads : This method allows obtaining detailed information on already created leads with possibility of filtration and page-by-page selection.
- Company
- This entity is identical with “contact” entity.
- It consists of a predefined set of fields and custom fields created by the account administrator.
- Each company may take part in one or more leads, or may be not linked to any leads at all.
- The e-mail address and phone number are used as identifiers in association with other systems.
- A responsible user may be assigned to each company in order to assign access privileges among the account’s personnel.
- getCompany : A method for obtaining company lists with possibility of filtration and page-by-page selection.
- createCompany : This method allows to add companies one by one or in packages, and also to update data for the already existing companies.
- Customer
- A customer is similar to a lead.
- It consists of a set of preset fields, and account administrators can add additional custom fields.
- Each customer may be attached to one or more contacts or not attached at all.
- For every customer, user access rights can be modified including assigning a user as the responsible manager.
- The current stage that a customer is in is also displayed.
- Stages represent the position of the customer in the purchase process.
- getCustomer : This method allows obtaining detailed information on already created customers with possibility of filtration and page-by- page selection.
- createCustomer : A method that allows you to create / update / delete a customer individually or in batches.
- Transaction
- A transaction is the main characteristic of a purchase (date and amount) and is connected to a "customer".
- createTransaction : A method for getting a filterable list of transactions.
- getTransaction : A method for getting a filterable list of transactions.
- Task
- Each task must necessarily have a responsible user and date (day and time) assigned to it.
- Also, a task may be linked to a lead or contact, but not necessarily.
- It may be not linked to any object.It is possible to set a result for a completed task by means of POST notes/set method.
- createTask : This method allows to create new tasks, and also to update information on the already existing tasks.
- getTask : A method for obtaining a list of already created tasks with possibility of filtration and page-by-page selection.
- Custom fields
- This method allows creating or deleting custom fields one by one or in packages.
- The user will not be able to change their values from the interface, but can browse them and use them for filtering.
- Creation or deletion of a field is also possible from the interface.
- getCustomFields : This section describes how to transmit values of custom fields.
No comments:
Post a Comment