ForceManager CRM (Preview)
ForceManager CRM is designed by and for field sales representatives. Built with their needs and priorities in mind, ForceManager's goal is to make sales reps' jobs easier, so they can focus on what really matters: sales and building strong relationships with customers.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | ForceManager CRM |
| URL | https://www.forcemanager.com/contact/ |
| [email protected] |
| Connector Metadata | |
|---|---|
| Publisher | Tritium Software S.L. |
| Website | https://www.forcemanager.com |
| Privacy Policy | https://www.forcemanager.com/privacy-policy |
| Categories | Productivity;Business Management |
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| Public Key (publicKey) | securestring | Specify the Public Key from your service credentials. | True |
| Private Key (privateKey) | securestring | Specify the Private Key from your service credentials. | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Create a Contact |
This operation allows you to create a Contact. |
| Create a Sales Order |
This operation allows you to create a Sales Order. |
| Create a Sales Order Line |
This operation allows you to create a Sales Order Line. |
| Create an Account |
This operation allows you to create am Account. |
| Create an Opportunity |
This operation allows you to create an Opportunity. |
| Delete a Contact |
This operation allows you to delete a specific Contact from the user's ForceManager implementation database. |
| Delete a Sales Order |
This operation allows you to delete a specific Sales Order from the user's ForceManager implementation database. |
| Delete a Sales Order Line |
This operation allows you to delete a specific Sales Order Line from the user's ForceManager implementation database. |
| Delete an Account |
This operation allows you to delete a specific Account from the user's ForceManager implementation database. |
| Delete an Opportunity |
This operation allows you to delete a specific Opportunity from the user's ForceManager implementation database. |
| Get a Contact |
This operation retrieves data of a specific Contact. |
| Get a Sales Order |
This operation retrieves data of a specific Sales Order. |
| Get a Sales Order Line |
This operation retrieves data of a specific Sales Order Line. |
| Get an Account |
This operation retrieves data of a specific Account. |
| Get an Opportunity |
This operation retrieves data of a specific Opportunity. |
| List Account Segments |
Returns all Account Segments available in the user's ForceManager implementation database. |
| List Account Statuses |
Returns all Account Statuses available in the user's ForceManager implementation database. |
| List Account Types |
Returns all Account Types available in the user's ForceManager implementation database. |
| List Accounts |
Returns Accounts available in the user's ForceManager implementation database. |
| List Activity Types |
Returns all Activity Types available in the user's ForceManager implementation database. |
| List Branches |
Returns all Branches. |
| List Contact Types |
Returns all Contact Types available in the user's ForceManager implementation database. |
| List Contacts |
Returns Contacts available in the user's ForceManager implementation database. |
| List Countries |
Returns all Countries available. |
| List Currencies |
Returns all Currencies available. |
| List Opportunities |
Returns Opportunities available in the user's ForceManager implementation database. |
| List Opportunity Statuses |
Returns all Opportunity Statuses available in the user's ForceManager implementation database. |
| List Opportunity Types |
Returns all Opportunity Types available in the user's ForceManager implementation database. |
| List Sales Order Statuses |
Returns all Sales Order Statuses available in the user's ForceManager implementation database. |
| List Sales Orders |
Returns Sales Orders available in the user's ForceManager implementation database. |
| List Sales Orders Lines |
Returns Sales Orders Lines available in the user's ForceManager implementation database. |
| List Timezones |
Returns all Timezones available. |
| List Users |
Returns Users available in the user's ForceManager implementation database. |
| Update a Contact |
This operation allows you to update a specific Contact. |
| Update a Sales Order |
This operation allows you to update a specific Sales Order. |
| Update a Sales Order Line |
This operation allows you to update a specific Sales Order Line. |
| Update an Account |
This operation allows you to update a specific Account. |
| Update an Opportunity |
This operation allows you to update a specific Opportunity. |
Create a Contact
This operation allows you to create a Contact.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Returns
- Body
- PostResponse
Create a Sales Order
This operation allows you to create a Sales Order.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Returns
- Body
- PostResponse
Create a Sales Order Line
This operation allows you to create a Sales Order Line.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Returns
- Body
- PostResponse
Create an Account
This operation allows you to create am Account.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Returns
- Body
- PostResponse
Create an Opportunity
This operation allows you to create an Opportunity.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Returns
- Body
- PostResponse
Delete a Contact
This operation allows you to delete a specific Contact from the user's ForceManager implementation database.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Entity ID
|
id | True | integer |
Unique identifier of the entity |
Returns
- Body
- DeleteResponse
Delete a Sales Order
This operation allows you to delete a specific Sales Order from the user's ForceManager implementation database.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Entity ID
|
id | True | integer |
Unique identifier of the entity |
Returns
- Body
- DeleteResponse
Delete a Sales Order Line
This operation allows you to delete a specific Sales Order Line from the user's ForceManager implementation database.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Entity ID
|
id | True | integer |
Unique identifier of the entity |
Returns
- Body
- DeleteResponse
Delete an Account
This operation allows you to delete a specific Account from the user's ForceManager implementation database.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Entity ID
|
id | True | integer |
Unique identifier of the entity |
Returns
- Body
- DeleteResponse
Delete an Opportunity
This operation allows you to delete a specific Opportunity from the user's ForceManager implementation database.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Entity ID
|
id | True | integer |
Unique identifier of the entity |
Returns
- Body
- DeleteResponse
Get a Contact
This operation retrieves data of a specific Contact.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Entity ID
|
id | True | integer |
Unique identifier of the entity |
Returns
- Body
- ContactResponse
Get a Sales Order
This operation retrieves data of a specific Sales Order.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Entity ID
|
id | True | integer |
Unique identifier of the entity |
Returns
- Body
- SalesOrderResponse
Get a Sales Order Line
This operation retrieves data of a specific Sales Order Line.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Entity ID
|
id | True | integer |
Unique identifier of the entity |
Returns
Get an Account
This operation retrieves data of a specific Account.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Entity ID
|
id | True | integer |
Unique identifier of the entity |
Returns
- Body
- AccountResponse
Get an Opportunity
This operation retrieves data of a specific Opportunity.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Entity ID
|
id | True | integer |
Unique identifier of the entity |
Returns
- Body
- OpportunityResponse
List Account Segments
Returns all Account Segments available in the user's ForceManager implementation database.
Returns
- response
- array of GenericValueListResponse
List Account Statuses
Returns all Account Statuses available in the user's ForceManager implementation database.
Returns
- response
- array of AccountStatusListResponse
List Account Types
Returns all Account Types available in the user's ForceManager implementation database.
Returns
- response
- array of GenericValueListResponse
List Accounts
Returns Accounts available in the user's ForceManager implementation database.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Where
|
where | string |
Allows to filter data using any SQL string parameter |
|
|
Page
|
page | integer |
Define the pagination data for the returned objects |
|
|
Order
|
order | string |
Organise and view the results for a specific attribute in descendent order |
|
|
Language
|
lang | string |
Define the language in which you want to receive the response |
|
|
Count
|
count | integer |
The number of records to return in each page of results |
Returns
- response
- array of AccountResponse
List Activity Types
Returns all Activity Types available in the user's ForceManager implementation database.
Returns
- response
- array of GenericValueListResponse
List Branches
List Contact Types
Returns all Contact Types available in the user's ForceManager implementation database.
Returns
- response
- array of GenericValueListResponse
List Contacts
Returns Contacts available in the user's ForceManager implementation database.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Where
|
where | string |
Allows to filter data using any SQL string parameter |
|
|
Page
|
page | integer |
Define the pagination data for the returned objects |
|
|
Order
|
order | string |
Organise and view the results for a specific attribute in descendent order |
|
|
Language
|
lang | string |
Define the language in which you want to receive the response |
|
|
Count
|
count | integer |
The number of records to return in each page of results |
Returns
- response
- array of ContactResponse
List Countries
List Currencies
List Opportunities
Returns Opportunities available in the user's ForceManager implementation database.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Where
|
where | string |
Allows to filter data using any SQL string parameter |
|
|
Page
|
page | integer |
Define the pagination data for the returned objects |
|
|
Order
|
order | string |
Organise and view the results for a specific attribute in descendent order |
|
|
Language
|
lang | string |
Define the language in which you want to receive the response |
|
|
Count
|
count | integer |
The number of records to return in each page of results |
Returns
- response
- array of OpportunityResponse
List Opportunity Statuses
Returns all Opportunity Statuses available in the user's ForceManager implementation database.
Returns
List Opportunity Types
Returns all Opportunity Types available in the user's ForceManager implementation database.
Returns
- response
- array of GenericValueListResponse
List Sales Order Statuses
Returns all Sales Order Statuses available in the user's ForceManager implementation database.
Returns
List Sales Orders
Returns Sales Orders available in the user's ForceManager implementation database.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Where
|
where | string |
Allows to filter data using any SQL string parameter |
|
|
Page
|
page | integer |
Define the pagination data for the returned objects |
|
|
Order
|
order | string |
Organise and view the results for a specific attribute in descendent order |
|
|
Language
|
lang | string |
Define the language in which you want to receive the response |
|
|
Count
|
count | integer |
The number of records to return in each page of results |
Returns
- response
- array of SalesOrderResponse
List Sales Orders Lines
Returns Sales Orders Lines available in the user's ForceManager implementation database.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Where
|
where | string |
Allows to filter data using any SQL string parameter |
|
|
Page
|
page | integer |
Define the pagination data for the returned objects |
|
|
Order
|
order | string |
Organise and view the results for a specific attribute in descendent order |
|
|
Language
|
lang | string |
Define the language in which you want to receive the response |
|
|
Count
|
count | integer |
The number of records to return in each page of results |
Returns
- response
- array of SalesOrderLineResponse
List Timezones
List Users
Returns Users available in the user's ForceManager implementation database.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Where
|
where | string |
Allows to filter data using any SQL string parameter |
|
|
Page
|
page | integer |
Define the pagination data for the returned objects |
|
|
Order
|
order | string |
Organise and view the results for a specific attribute in descendent order |
|
|
Language
|
lang | string |
Define the language in which you want to receive the response |
|
|
Count
|
count | integer |
The number of records to return in each page of results |
Returns
- response
- array of UserResponse
Update a Contact
This operation allows you to update a specific Contact.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Entity ID
|
id | True | integer |
Unique identifier of the entity |
|
body
|
body | True | dynamic |
Returns
- Body
- PutResponse
Update a Sales Order
This operation allows you to update a specific Sales Order.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Entity ID
|
id | True | integer |
Unique identifier of the entity |
|
body
|
body | True | dynamic |
Returns
- Body
- PutResponse
Update a Sales Order Line
This operation allows you to update a specific Sales Order Line.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Entity ID
|
id | True | integer |
Unique identifier of the entity |
|
body
|
body | True | dynamic |
Returns
- Body
- PutResponse
Update an Account
This operation allows you to update a specific Account.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Entity ID
|
id | True | integer |
Unique identifier of the entity |
|
body
|
body | True | dynamic |
Returns
- Body
- PutResponse
Update an Opportunity
This operation allows you to update a specific Opportunity.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Entity ID
|
id | True | integer |
Unique identifier of the entity |
|
body
|
body | True | dynamic |
Returns
- Body
- PutResponse
Triggers
| When a Sales Order is created |
This operation triggers a flow when a new Sales Order is created. |
| When an Account is created |
This operation triggers a flow when a new Account is created. |
| When an Account is updated |
This operation triggers a flow when a new Account is updated. |
| When an Contact is created |
This operation triggers a flow when a new Contact is created. |
| When an Contact is updated |
This operation triggers a flow when a new Contact is updated. |
| When an Opportunity is created |
This operation triggers a flow when a new Opportunity is created. |
| When an Opportunity is updated |
This operation triggers a flow when a new Opportunity is updated. |
| When an Sales Order is updated |
This operation triggers a flow when a new Sales Order is updated. |
When a Sales Order is created
This operation triggers a flow when a new Sales Order is created.
Returns
- response
- array of SalesOrderResponse
When an Account is created
This operation triggers a flow when a new Account is created.
Returns
- response
- array of AccountResponse
When an Account is updated
This operation triggers a flow when a new Account is updated.
Returns
- response
- array of AccountResponse
When an Contact is created
This operation triggers a flow when a new Contact is created.
Returns
- response
- array of ContactResponse
When an Contact is updated
This operation triggers a flow when a new Contact is updated.
Returns
- response
- array of ContactResponse
When an Opportunity is created
This operation triggers a flow when a new Opportunity is created.
Returns
- response
- array of OpportunityResponse
When an Opportunity is updated
This operation triggers a flow when a new Opportunity is updated.
Returns
- response
- array of OpportunityResponse
When an Sales Order is updated
This operation triggers a flow when a new Sales Order is updated.
Returns
- response
- array of SalesOrderResponse
Definitions
AccountResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | integer | |
|
Name
|
name | string | |
|
Status Name
|
statusId.value | string | |
|
Status ID
|
statusId.id | integer | |
|
Type Name
|
typeId.value | string | |
|
Type ID
|
typeId.id | integer | |
|
Vat Number
|
vatNumber | string | |
|
Phone
|
phone | string | |
|
Email
|
string | ||
|
Branch Name
|
branchId.value | string | |
|
Branch ID
|
branchId.id | integer | |
|
Sales Rep 1 Name
|
salesRepId1.value | string | |
|
Sales Rep 1 ID
|
salesRepId1.id | integer | |
|
Sales Rep 2 Name
|
salesRepId2.value | string | |
|
Sales Rep 2 ID
|
salesRepId2.id | integer | |
|
Sales Rep 3 Name
|
salesRepId3.value | string | |
|
Sales Rep 3 ID
|
salesRepId3.id | integer | |
|
Sales Rep 4 Name
|
salesRepId4.value | string | |
|
Sales Rep 4 ID
|
salesRepId4.id | integer | |
|
Sales Rep 5 Name
|
salesRepId5.value | string | |
|
Sales Rep 5 ID
|
salesRepId5.id | integer | |
|
Comment
|
comment | string | |
|
Address 1
|
address1 | string | |
|
Address 2
|
address2 | string | |
|
City
|
city | string | |
|
Postal Code
|
postcode | string | |
|
Region
|
region | string | |
|
Country Name
|
countryId.value | string | |
|
Country ID
|
countryId.id | integer | |
|
External ID
|
extId | string | |
|
Created At
|
dateCreated | date-time | |
|
Updated At
|
dateUpdated | date-time | |
|
Deleted At
|
dateDeleted | date-time | |
|
Sales Rep ID (Account Creation)
|
salesRepIdCreated | integer | |
|
Sales Rep ID (Account Update)
|
salesRepIdUpdated | integer | |
|
Sales Rep ID (Account Deletion)
|
salesRepIdDeleted | integer | |
|
Phone 2
|
phone2 | string | |
|
Phone 3
|
phone3 | string | |
|
Fax
|
fax | string | |
|
Website
|
website | string | |
|
Geocoded
|
geocoded | boolean | |
|
Geocoding Accuracy
|
geocodingAccuracy | integer | |
|
Latitude
|
latitude | number | |
|
Longitude
|
longitude | number | |
|
Permission Level
|
permissionLevel | integer | |
|
Public
|
public | boolean | |
|
Read-Only
|
readOnly | boolean | |
|
Rate Name
|
rateId.value | string | |
|
Rate ID
|
rateId.id | integer | |
|
Segment Name
|
segmentId.value | string | |
|
Segment ID
|
segmentId.id | integer |
ContactResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | integer | |
|
First Name
|
firstName | string | |
|
Last Name
|
lasttName | string | |
|
Account Name
|
accountId.value | string | |
|
Account ID
|
accountId.id | integer | |
|
Type Name
|
typeId.value | string | |
|
Type ID
|
typeId.id | integer | |
|
Phone 1
|
phone1 | string | |
|
Phone 2
|
phone2 | string | |
|
Fax
|
fax | string | |
|
Email
|
string | ||
|
Email 2
|
email2 | string | |
|
Email 3
|
email3 | string | |
|
Sales Rep Name
|
salesRepId.value | string | |
|
Sales Rep ID
|
salesRepId.id | integer | |
|
Comment
|
comment | string | |
|
Address 1
|
address1 | string | |
|
City
|
city | string | |
|
Postal Code
|
postcode | string | |
|
Region
|
region | string | |
|
Country Name
|
countryId.value | string | |
|
Country ID
|
countryId.id | integer | |
|
External ID
|
extId | string | |
|
Created At
|
dateCreated | date-time | |
|
Updated At
|
dateUpdated | date-time | |
|
Deleted At
|
dateDeleted | date-time | |
|
Sales Rep ID (Account Creation)
|
salesRepIdCreated | integer | |
|
Sales Rep ID (Account Update)
|
salesRepIdUpdated | integer | |
|
Sales Rep ID (Account Deletion)
|
salesRepIdDeleted | integer | |
|
Birthday
|
birthday | date-time | |
|
LinkedIn
|
string | ||
|
Skype
|
skype | string | |
|
Use Company Address
|
useCompanyAddress | integer | |
|
Permission Level
|
permissionLevel | integer | |
|
Marketing Communications
|
marketingCommunications | boolean | |
|
Read-Only
|
readOnly | boolean | |
|
Gender Name
|
gender.value | string | |
|
Gender ID
|
gender.id | integer |
OpportunityResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | integer | |
|
Reference
|
reference | string | |
|
Type Name
|
type_id.value | string | |
|
Type ID
|
type_id.id | integer | |
|
Status Name
|
statusId.value | string | |
|
Status ID
|
statusId.id | integer | |
|
Total
|
total | number | |
|
Currency Name
|
currencyId.value | string | |
|
Currency ID
|
currencyId.id | integer | |
|
Account 1 Name
|
accountId1.value | string | |
|
Account 1 ID
|
accountId1.id | integer | |
|
Sales Forecast Date
|
salesForecastDate | date-time | |
|
Sales Probability
|
salesProbability | integer | |
|
Sales Rep Name
|
salesRepId.value | string | |
|
Sales Rep ID
|
salesRepId.id | integer | |
|
Comments
|
comments | string | |
|
Branch Name
|
branchId.value | string | |
|
Branch ID
|
branchId.id | integer | |
|
Account 2 Name
|
accountId2.value | string | |
|
Account 2 ID
|
accountId2.id | integer | |
|
Account 3 Name
|
accountId3.value | string | |
|
Account 3 ID
|
accountId3.id | integer | |
|
Address 1
|
address1 | string | |
|
Address 2
|
address2 | string | |
|
City
|
city | string | |
|
Postal Code
|
postcode | string | |
|
Region
|
region | string | |
|
Country Name
|
countryId.value | string | |
|
Country ID
|
countryId.id | integer | |
|
Closed Date
|
closedDate | date-time | |
|
Won Date
|
wonDate | date-time | |
|
Lost Date
|
lostDate | date-time | |
|
Date Created
|
dateCreated | date-time | |
|
Date Deleted
|
dateDeleted | date-time | |
|
Date Updated
|
dateUpdated | date-time | |
|
Deleted
|
deleted | boolean | |
|
External ID
|
extId | string | |
|
Geocoded
|
geocoded | boolean | |
|
Geocoding Accuracy
|
geocodingAccuracy | integer | |
|
Latitude
|
latitude | number | |
|
Longitude
|
longitude | number | |
|
Permission Level
|
permissionLevel | integer | |
|
Read-Only
|
readOnly | boolean | |
|
Sales Rep ID (Opportunity Creation)
|
salesRepIdCreated | integer | |
|
Sales Rep ID (Opportunity Update)
|
salesRepIdUpdated | integer | |
|
Sales Rep ID (Opportunity Deletion)
|
salesRepIdDeleted | integer |
SalesOrderResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | integer | |
|
Reference
|
reference | string | |
|
Order Number
|
number | integer | |
|
Year
|
year | integer | |
|
Status Name
|
statusId.value | string | |
|
Status ID
|
statusId.id | integer | |
|
Total
|
total | number | |
|
Discount 1
|
discount1 | number | |
|
Discount 2
|
discount2 | number | |
|
Discount 3
|
discount3 | number | |
|
Discount 4
|
discount4 | number | |
|
Currency Name
|
currencyId.value | string | |
|
Currency ID
|
currencyId.id | integer | |
|
Account Name
|
accountId.value | string | |
|
Account ID
|
accountId.id | integer | |
|
Sales Forecast Date
|
salesForecastDate | date-time | |
|
Sales Rep Name
|
salesRepId.value | string | |
|
Sales Rep ID
|
salesRepId.id | integer | |
|
Comments
|
comment | string | |
|
Comments
|
internalComment | string | |
|
Branch Name
|
branchId.value | string | |
|
Branch ID
|
branchId.id | integer | |
|
Opportunity Name
|
opportunityId.value | string | |
|
Opportunity ID
|
opportunityId.id | integer | |
|
Contact Name
|
contactId.value | string | |
|
Contact ID
|
contactId.id | integer | |
|
Rate Name
|
rateId.value | string | |
|
Rate ID
|
rateId.id | integer | |
|
Account Address Name
|
accountAddressId.value | string | |
|
Account Address ID
|
accountAddressId.id | integer | |
|
Closed Date
|
closedDate | date-time | |
|
Date Created
|
dateCreated | date-time | |
|
Date Deleted
|
dateDeleted | date-time | |
|
Date Updated
|
dateUpdated | date-time | |
|
Main Sales Order
|
mainSalesorder | boolean | |
|
Archived
|
archived | boolean | |
|
Blocked
|
blocked | boolean | |
|
Deleted
|
deleted | boolean | |
|
External ID
|
extId | string | |
|
Read-Only
|
readOnly | boolean | |
|
Sales Rep ID (Opportunity Creation)
|
salesRepIdCreated | integer | |
|
Sales Rep ID (Opportunity Update)
|
salesRepIdUpdated | integer | |
|
Sales Rep ID (Opportunity Deletion)
|
salesRepIdDeleted | integer |
SalesOrderLineResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | integer | |
|
Description
|
description | string | |
|
Product Name
|
productId.value | string | |
|
Product ID
|
productId.id | integer | |
|
Quantity
|
quantity | integer | |
|
Price
|
price | number | |
|
Total
|
total | number | |
|
Discount 1
|
discount1 | number | |
|
Discount 2
|
discount2 | number | |
|
Discount 3
|
discount3 | number | |
|
Discount 4
|
discount4 | number | |
|
Sales Order Reference
|
salesOrderId.value | string | |
|
Sales Order ID
|
salesOrderId.id | integer | |
|
Order
|
order | integer | |
|
Date Created
|
dateCreated | date-time | |
|
Date Deleted
|
dateDeleted | date-time | |
|
Date Updated
|
dateUpdated | date-time | |
|
Deleted
|
deleted | boolean | |
|
Sales Rep ID (Opportunity Creation)
|
salesRepIdCreated | integer | |
|
Sales Rep ID (Opportunity Update)
|
salesRepIdUpdated | integer | |
|
Sales Rep ID (Opportunity Deletion)
|
salesRepIdDeleted | integer |
UserResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | integer |
Unique identifier |
|
Deleted
|
deleted | boolean |
Flag to state if the entry has been deleted |
|
First Name
|
name | string |
User's first name |
|
Last Name
|
lastName | string |
User's last name |
|
Email
|
string |
User's email |
|
|
Phone Country ID
|
idPrefix | integer |
User's phone number Country ID |
|
Phone Extension
|
phoneExtension | string |
User's phone number extension |
|
Phone
|
phone | string |
User's phone |
|
Nickname
|
nic | string |
User's nickname |
|
description
|
description | string |
Entity label |
|
Created At
|
dateCreated | date-time | |
|
Updated At
|
dateUpdated | date-time | |
|
Deleted At
|
dateDeleted | date-time | |
|
Password Changed At
|
lastPasswordChangeDate | date-time |
Date when the password was last changed |
|
Is Active
|
isActive | boolean |
Flag to state if the User is activated, being visible and capable to login in the apps |
|
Is Billable
|
billable | boolean |
Flag to state if the User must be counted as a payable licence |
|
Compute SFM
|
computeSfm | boolean |
Flag to state if the User counts for the sales analytics |
|
Locale
|
locale | string |
The User language |
|
Database locale
|
dbLanguage | string |
The User database language |
|
UI locale
|
uiLanguage | string |
The User language for mobile and web apps |
|
External ID
|
extId | string |
External ID of the User from a third party system |
|
Permission Level
|
level | integer |
Permission level of the User from 1 to 5 |
|
Branch Restriction
|
branchRestriction | boolean |
Flag to state if the User has limited visibility in some branches |
|
Branch Name
|
branches.description | string | |
|
Branch ID
|
branches.id | integer | |
|
Type Name
|
userTypeId.description | string | |
|
Type ID
|
userTypeId.id | integer | |
|
User Name
|
managerId.description | string | |
|
User ID
|
managerId.id | integer | |
|
Rate Name
|
rateId.description | string | |
|
Rate ID
|
rateId.id | integer |
PostResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | integer | |
|
Message
|
message | string |
PutResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Message
|
message | string |
DeleteResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Message
|
message | string |
BranchResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | integer |
Unique identifier |
|
Order
|
order | integer |
The position of the entry in the value list |
|
Deleted
|
deleted | boolean |
Flag to state if the entry has been deleted |
|
description
|
description | string |
Entity label |
|
descriptionES
|
descriptionES | string |
Entity label in Spanish |
|
descriptionEN
|
descriptionEN | string |
Entity label in English |
|
descriptionUS
|
descriptionUS | string |
Entity label in American English |
|
descriptionIT
|
descriptionIT | string |
Entity label in Italian |
|
descriptionDE
|
descriptionDE | string |
Entity label in German |
|
descriptionFR
|
descriptionFR | string |
Entity label in French |
|
descriptionBR
|
descriptionBR | string |
Entity label in Brasilian Portuguese |
|
descriptionDK
|
descriptionDK | string |
Entity label in Dutch |
|
descriptionPT
|
descriptionPT | string |
Entity label in Portuguese |
|
descriptionRU
|
descriptionRU | string |
Entity label in Russian |
|
Created At
|
dateCreated | date-time | |
|
Updated At
|
dateUpdated | date-time | |
|
Deleted At
|
dateDeleted | date-time | |
|
Sales Rep ID (Account Creation)
|
salesRepIdCreated | integer | |
|
Sales Rep ID (Account Update)
|
salesRepIdUpdated | integer | |
|
Sales Rep ID (Account Deletion)
|
salesRepIdDeleted | integer | |
|
Internal
|
default | boolean |
Flag to state if the Branch is the one assigned by default |
|
Public
|
imperialSystem | boolean |
Flag to state if the Branch adopts the imperial system measurement (i.e. miles instead of km) |
|
Public
|
mainEnvironment | boolean |
Flag to state if the Branch is the main one, for long tail implementations |
|
Currency Name
|
currencyId.value | string | |
|
Currency ID
|
currencyId.id | integer | |
|
Time Zone Name
|
timeZoneId.value | string | |
|
Time Zone ID
|
timeZoneId.id | integer |
CountryResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | integer |
Unique identifier |
|
Order
|
order | integer |
The position of the entry in the value list |
|
Deleted
|
deleted | boolean |
Flag to state if the entry has been deleted |
|
description
|
description | string |
Entity label |
|
descriptionES
|
descriptionES | string |
Entity label in Spanish |
|
descriptionEN
|
descriptionEN | string |
Entity label in English |
|
descriptionUS
|
descriptionUS | string |
Entity label in American English |
|
descriptionIT
|
descriptionIT | string |
Entity label in Italian |
|
descriptionDE
|
descriptionDE | string |
Entity label in German |
|
descriptionFR
|
descriptionFR | string |
Entity label in French |
|
descriptionBR
|
descriptionBR | string |
Entity label in Brasilian Portuguese |
|
descriptionDK
|
descriptionDK | string |
Entity label in Dutch |
|
descriptionPT
|
descriptionPT | string |
Entity label in Portuguese |
|
descriptionRU
|
descriptionRU | string |
Entity label in Russian |
|
Created At
|
dateCreated | date-time | |
|
Updated At
|
dateUpdated | date-time | |
|
Deleted At
|
dateDeleted | date-time | |
|
Sales Rep ID (Account Creation)
|
salesRepIdCreated | integer | |
|
Sales Rep ID (Account Update)
|
salesRepIdUpdated | integer | |
|
Sales Rep ID (Account Deletion)
|
salesRepIdDeleted | integer | |
|
ISO 3166 Alpha-2 Code
|
iso2 | string |
The ISO 3166 alpha-2 code of the Country |
|
ISO 3166 Alpha-3 Code
|
iso3 | string |
The ISO 3166 alpha-3 code of the Country |
|
ISO 3166 Numeric Code
|
isoNum | integer |
The ISO 3166 numeric code of the Country |
|
Phone Code
|
phoneCode | string |
Phone code of the specific the Country |
|
strName
|
strName | string |
Generic Country Name |
CurrencyResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | integer |
Unique identifier |
|
Order
|
order | integer |
The position of the entry in the value list |
|
Deleted
|
deleted | boolean |
Flag to state if the entry has been deleted |
|
description
|
description | string |
Entity label |
|
descriptionES
|
descriptionES | string |
Entity label in Spanish |
|
descriptionEN
|
descriptionEN | string |
Entity label in English |
|
descriptionUS
|
descriptionUS | string |
Entity label in American English |
|
descriptionIT
|
descriptionIT | string |
Entity label in Italian |
|
descriptionDE
|
descriptionDE | string |
Entity label in German |
|
descriptionFR
|
descriptionFR | string |
Entity label in French |
|
descriptionBR
|
descriptionBR | string |
Entity label in Brasilian Portuguese |
|
descriptionDK
|
descriptionDK | string |
Entity label in Dutch |
|
descriptionPT
|
descriptionPT | string |
Entity label in Portuguese |
|
descriptionRU
|
descriptionRU | string |
Entity label in Russian |
|
Created At
|
dateCreated | date-time | |
|
Updated At
|
dateUpdated | date-time | |
|
Deleted At
|
dateDeleted | date-time | |
|
Sales Rep ID (Account Creation)
|
salesRepIdCreated | integer | |
|
Sales Rep ID (Account Update)
|
salesRepIdUpdated | integer | |
|
Sales Rep ID (Account Deletion)
|
salesRepIdDeleted | integer | |
|
ISO4217 Code
|
isoCode | string |
The ISO 4217 code of the Currency |
|
Symbol
|
symbol | string |
The literal symbol of the Currency |
TimezoneResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | integer |
Unique identifier |
|
Deleted
|
deleted | boolean |
Flag to state if the entry has been deleted |
|
description
|
description | string |
Entity label |
|
descriptionES
|
descriptionES | string |
Entity label in Spanish |
|
descriptionEN
|
descriptionEN | string |
Entity label in English |
|
descriptionUS
|
descriptionUS | string |
Entity label in American English |
|
descriptionIT
|
descriptionIT | string |
Entity label in Italian |
|
descriptionDE
|
descriptionDE | string |
Entity label in German |
|
descriptionFR
|
descriptionFR | string |
Entity label in French |
|
descriptionBR
|
descriptionBR | string |
Entity label in Brasilian Portuguese |
|
descriptionDK
|
descriptionDK | string |
Entity label in Dutch |
|
descriptionPT
|
descriptionPT | string |
Entity label in Portuguese |
|
descriptionRU
|
descriptionRU | string |
Entity label in Russian |
|
Created At
|
dateCreated | date-time | |
|
Updated At
|
dateUpdated | date-time | |
|
Deleted At
|
dateDeleted | date-time | |
|
Sales Rep ID (Account Creation)
|
salesRepIdCreated | integer | |
|
Sales Rep ID (Account Update)
|
salesRepIdUpdated | integer | |
|
Sales Rep ID (Account Deletion)
|
salesRepIdDeleted | integer | |
|
IANA Zone
|
idIanaZone | string |
The literal name of the IANA Zone |
|
Short Description
|
shortDescription | string |
Time Zone brief description |
|
Full Description
|
fullDescription | string |
Time Zone long description |
GenericValueListResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | integer |
Unique identifier |
|
Order
|
order | integer |
The position of the entry in the value list |
|
Deleted
|
deleted | boolean |
Flag to state if the entry has been deleted |
|
description
|
description | string |
Entity label |
|
descriptionES
|
descriptionES | string |
Entity label in Spanish |
|
descriptionEN
|
descriptionEN | string |
Entity label in English |
|
descriptionUS
|
descriptionUS | string |
Entity label in American English |
|
descriptionIT
|
descriptionIT | string |
Entity label in Italian |
|
descriptionDE
|
descriptionDE | string |
Entity label in German |
|
descriptionFR
|
descriptionFR | string |
Entity label in French |
|
descriptionBR
|
descriptionBR | string |
Entity label in Brasilian Portuguese |
|
descriptionDK
|
descriptionDK | string |
Entity label in Dutch |
|
descriptionPT
|
descriptionPT | string |
Entity label in Portuguese |
|
descriptionRU
|
descriptionRU | string |
Entity label in Russian |
|
Created At
|
dateCreated | date-time | |
|
Updated At
|
dateUpdated | date-time | |
|
Deleted At
|
dateDeleted | date-time | |
|
Sales Rep ID (Account Creation)
|
salesRepIdCreated | integer | |
|
Sales Rep ID (Account Update)
|
salesRepIdUpdated | integer | |
|
Sales Rep ID (Account Deletion)
|
salesRepIdDeleted | integer | |
|
Branch Visibility
|
branchVisibility | array of object |
In which Branch the entry is visible |
|
Branch Name
|
branchVisibility.value | string | |
|
Branch ID
|
branchVisibility.id | integer | |
|
Internal
|
internal | boolean |
Flag to state if the entry is for internal use only |
|
Public
|
computeSfm | boolean |
Flag to state if the entry counts for sales analytics |
|
Visit Cycle
|
visitCycle | integer |
Visit cycle linked to the entry |
AccountStatusListResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | integer |
Unique identifier |
|
Order
|
order | integer |
The position of the entry in the value list |
|
Deleted
|
deleted | boolean |
Flag to state if the entry has been deleted |
|
description
|
description | string |
Entity label |
|
descriptionES
|
descriptionES | string |
Entity label in Spanish |
|
descriptionEN
|
descriptionEN | string |
Entity label in English |
|
descriptionUS
|
descriptionUS | string |
Entity label in American English |
|
descriptionIT
|
descriptionIT | string |
Entity label in Italian |
|
descriptionDE
|
descriptionDE | string |
Entity label in German |
|
descriptionFR
|
descriptionFR | string |
Entity label in French |
|
descriptionBR
|
descriptionBR | string |
Entity label in Brasilian Portuguese |
|
descriptionDK
|
descriptionDK | string |
Entity label in Dutch |
|
descriptionPT
|
descriptionPT | string |
Entity label in Portuguese |
|
descriptionRU
|
descriptionRU | string |
Entity label in Russian |
|
Created At
|
dateCreated | date-time | |
|
Updated At
|
dateUpdated | date-time | |
|
Deleted At
|
dateDeleted | date-time | |
|
Sales Rep ID (Account Creation)
|
salesRepIdCreated | integer | |
|
Sales Rep ID (Account Update)
|
salesRepIdUpdated | integer | |
|
Sales Rep ID (Account Deletion)
|
salesRepIdDeleted | integer | |
|
Branch Visibility
|
branchVisibility | array of object |
In which Branch the entry is visible |
|
Branch Name
|
branchVisibility.value | string | |
|
Branch ID
|
branchVisibility.id | integer | |
|
Won
|
won | boolean |
Flag to state if the entry refers to a won status |
|
Lost
|
lost | boolean |
Flag to state if the entry refers to a lost status |
OpportunityStatusListResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | integer |
Unique identifier |
|
Order
|
order | integer |
The position of the entry in the value list |
|
Deleted
|
deleted | boolean |
Flag to state if the entry has been deleted |
|
description
|
description | string |
Entity label |
|
descriptionES
|
descriptionES | string |
Entity label in Spanish |
|
descriptionEN
|
descriptionEN | string |
Entity label in English |
|
descriptionUS
|
descriptionUS | string |
Entity label in American English |
|
descriptionIT
|
descriptionIT | string |
Entity label in Italian |
|
descriptionDE
|
descriptionDE | string |
Entity label in German |
|
descriptionFR
|
descriptionFR | string |
Entity label in French |
|
descriptionBR
|
descriptionBR | string |
Entity label in Brasilian Portuguese |
|
descriptionDK
|
descriptionDK | string |
Entity label in Dutch |
|
descriptionPT
|
descriptionPT | string |
Entity label in Portuguese |
|
descriptionRU
|
descriptionRU | string |
Entity label in Russian |
|
statusDetails
|
statusDetails | string |
Status Details |
|
statusDetailsEN
|
statusDetailsEN | string |
Status Details in English |
|
statusDetailsUS
|
statusDetailsUS | string |
Status Details in American English |
|
statusDetailsIT
|
statusDetailsIT | string |
Status Details in Italian |
|
statusDetailsDE
|
statusDetailsDE | string |
Status Details in German |
|
statusDetailsFR
|
statusDetailsFR | string |
Status Details in French |
|
statusDetailsBR
|
statusDetailsBR | string |
Status Details in Brasilian Portuguese |
|
statusDetailsDK
|
statusDetailsDK | string |
Status Details in Dutch |
|
statusDetailPTs
|
statusDetailsPT | string |
Status Details in Portuguese |
|
statusDetailsRU
|
statusDetailsRU | string |
Status Details in Russian |
|
Created At
|
dateCreated | date-time | |
|
Updated At
|
dateUpdated | date-time | |
|
Deleted At
|
dateDeleted | date-time | |
|
Sales Rep ID (Account Creation)
|
salesRepIdCreated | integer | |
|
Sales Rep ID (Account Update)
|
salesRepIdUpdated | integer | |
|
Sales Rep ID (Account Deletion)
|
salesRepIdDeleted | integer | |
|
Branch Visibility
|
branchVisibility | array of object |
In which Branch the entry is visible |
|
Branch Name
|
branchVisibility.value | string | |
|
Branch ID
|
branchVisibility.id | integer | |
|
Parent ID
|
idParent | integer | |
|
Won
|
won | integer |
Flag to state if the entry refers to a won or lost status |
|
End Status
|
endStatus | boolean |
Flag to state if the entry refers to a closed status |
SalesOrderStatusListResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | integer |
Unique identifier |
|
Order
|
order | integer |
The position of the entry in the value list |
|
Deleted
|
deleted | boolean |
Flag to state if the entry has been deleted |
|
description
|
description | string |
Entity label |
|
descriptionES
|
descriptionES | string |
Entity label in Spanish |
|
descriptionEN
|
descriptionEN | string |
Entity label in English |
|
descriptionUS
|
descriptionUS | string |
Entity label in American English |
|
descriptionIT
|
descriptionIT | string |
Entity label in Italian |
|
descriptionDE
|
descriptionDE | string |
Entity label in German |
|
descriptionFR
|
descriptionFR | string |
Entity label in French |
|
descriptionBR
|
descriptionBR | string |
Entity label in Brasilian Portuguese |
|
descriptionDK
|
descriptionDK | string |
Entity label in Dutch |
|
descriptionPT
|
descriptionPT | string |
Entity label in Portuguese |
|
descriptionRU
|
descriptionRU | string |
Entity label in Russian |
|
statusDetails
|
statusDetails | string |
Status Details |
|
statusDetailsEN
|
statusDetailsEN | string |
Status Details in English |
|
statusDetailsUS
|
statusDetailsUS | string |
Status Details in American English |
|
statusDetailsIT
|
statusDetailsIT | string |
Status Details in Italian |
|
statusDetailsDE
|
statusDetailsDE | string |
Status Details in German |
|
statusDetailsFR
|
statusDetailsFR | string |
Status Details in French |
|
statusDetailsBR
|
statusDetailsBR | string |
Status Details in Brasilian Portuguese |
|
statusDetailsDK
|
statusDetailsDK | string |
Status Details in Dutch |
|
statusDetailPTs
|
statusDetailsPT | string |
Status Details in Portuguese |
|
statusDetailsRU
|
statusDetailsRU | string |
Status Details in Russian |
|
Created At
|
dateCreated | date-time | |
|
Updated At
|
dateUpdated | date-time | |
|
Deleted At
|
dateDeleted | date-time | |
|
Sales Rep ID (Account Creation)
|
salesRepIdCreated | integer | |
|
Sales Rep ID (Account Update)
|
salesRepIdUpdated | integer | |
|
Sales Rep ID (Account Deletion)
|
salesRepIdDeleted | integer | |
|
Branch Visibility
|
branchVisibility | array of object |
In which Branch the entry is visible |
|
Branch Name
|
branchVisibility.value | string | |
|
Branch ID
|
branchVisibility.id | integer | |
|
Won
|
won | boolean |
Flag to state if the entry refers to a won status |
|
Lost
|
lost | boolean |
Flag to state if the entry refers to a lost status |