Soft1
![](https://connectoricons-prod.azureedge.net/master/1.0.1678.3629/soft1/icon.png)
The Soft1 Connector provides an API to work with Soft1 objects
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 | Standard | 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 | Standard | 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 | Constantine Elias |
[email protected] |
Connector Metadata | |
---|---|
Publisher | SoftOne Technologies S.A |
Website | https://www.softone.gr |
Privacy policy | https://www.softone.gr/privacy-policy/ |
Categories | Business Management;Sales and CRM |
The Soft1 Connector provides an API to work with Soft1 objects in order to create automated workflows between Soft1 applications and our favourite apps and services.
Prerequisites
To use this integration, you will need access to a Soft1 installation with Soft1 Microsoft Power Connector module enabled. To make a connection, select Sign In. You will be prompted to provide your Soft1 Serial Number, Username and Password. After the connection is created you're ready to start using this integration.
How to get credentials
To obtain credentials a web account must be configured with access to the Soft1 Microsoft Power Connector module - this account (Username and Password) and your installation serial number will be used for authentication by the Soft1 connector.
Getting started with your connector
Soft1 Connector provides four triggers :
* When a record is created or modified
* When a record is deleted
* When a record is modified
* When a record is created
Each trigger returns a key (id) of the specified of object that was created, modified or deleted, but not its data. In order to fetch the data of this object you have to use the corresponding Get Action filling the field "KEY" with the key returned by the trigger. For example, when a new customer is inserted in Soft1, our trigger "When a record is created" returns the key of the new record and then the Action "Get Customer" returns the customer's data.
Throttling Limits
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Actions
Get Cheque |
Returns all data (or the selected ones from LOCATEINFO) of a record of an Cheque Object |
Get Collections Document |
Returns all data (or the selected ones from LOCATEINFO) of a record of a Collections Object. |
Get Contact |
Returns all data (or the selected ones from LOCATEINFO) of a record of a contact object |
Get Customer |
Returns all data (or the selected ones from LOCATEINFO) of a record of a Customer Object. |
Get Draft entry |
Returns all data (or the selected ones from LOCATEINFO) of a record of a Draft entry object |
Get Email |
Returns all data (or the selected ones from LOCATEINFO) of a record of a Email Object |
Get Expenses |
Returns all data (or the selected ones from LOCATEINFO) of a record of an Expense Object. |
Get Expenses Document |
Returns all data (or the selected ones from LOCATEINFO) of a record of an Expenses Object. |
Get Item |
Returns all data (or the selected ones from LOCATEINFO) of a record of an Item Object. |
Get Meeting |
Returns all data (or the selected ones from LOCATEINFO) of a record of a Meeting Object. |
Get Payments Document |
Returns all data (or the selected ones from LOCATEINFO) of a record of a Payment Object. |
Get Project |
Returns all data (or the selected ones from LOCATEINFO) of a record of a project object |
Get Purchases Document |
Returns all data (or the selected ones from LOCATEINFO) of a record of a Purchase Object. |
Get Sales Document |
Returns all data (or the selected ones from LOCATEINFO) of a record of a Sales Object. |
Get Services |
Returns all data (or the selected ones from LOCATEINFO) of a record of an Service Object. |
Get Stock Document |
Returns all data (or the selected ones from LOCATEINFO) of a record of a Stock Document Object. |
Get Supplier |
Returns all data (or the selected ones from LOCATEINFO) of a record of a Supplier Object. |
Get System parameters |
Returns parameters of the installation |
Get Task |
Returns all data (or the selected ones from LOCATEINFO) of a record of a Task Object. |
Insert or Modify Cheque |
Insert or Modify the data of a Cheque Object identified by a KEY (Cheque ID) . If the KEY is empty or missing a record is inserted.he data of a record in an Cheque Object identified by a KEY. If the KEY is empty or missing a record is inserted. |
Insert or Modify Collections Document |
Insert or Modify the data of a Collections document Object identified by a KEY (Document ID) . If the KEY is empty or missing a record is inserted. |
Insert or Modify Contact |
Insert or Modify the data of a Contact Object identified by a KEY (Contact ID) . If the KEY is empty or missing a record is inserted. |
Insert or Modify Customer |
Insert or Modify the data of a Customer Object identified by a KEY (Customer ID) . If the KEY is empty or missing a record is inserted. |
Insert or Modify Draft entry |
Insert or Modify the data of a Draft entry Object identified by a KEY (Draft entry ID) . If the KEY is empty or missing a record is inserted. |
Insert or Modify Email |
Insert or Modify the data of an Email Object identified by a KEY (Email ID) . If the KEY is empty or missing a record is inserted. |
Insert or Modify Expenses |
Insert or Modify the data of an Expense Object identified by a KEY (Expense ID) . If the KEY is empty or missing a record is inserted.he data of a record in an Expense Object identified by a KEY. If the KEY is empty or missing a record is inserted. |
Insert or Modify Expenses Document |
Insert or Modify the data of an Expenses document object identified by a KEY (Document ID) . If the KEY is empty or missing a record is inserted. |
Insert or Modify Item |
Insert or Modify the data of an Item Object identified by a KEY (Item ID) . If the KEY is empty or missing a record is inserted.he data of a record in an Item Object identified by a KEY. If the KEY is empty or missing a record is inserted. |
Insert or Modify Meeting |
Insert or Modify the data of a Meeting Object identified by a KEY (Meeting ID) . If the KEY is empty or missing a record is inserted. |
Insert or Modify Payments Document |
Insert or Modify the data of a Payments document Object identified by a KEY (Document ID) . If the KEY is empty or missing a record is inserted. |
Insert or Modify Project |
Insert or Modify the data of a Project Object identified by a KEY (Project ID) . If the KEY is empty or missing a record is inserted. |
Insert or Modify Purchases Document |
Insert or Modify the data of a Purchase document Object identified by a KEY (Document ID) . If the KEY is empty or missing a record is inserted. |
Insert or Modify Sales Document |
Insert or Modify the data of a Sales Document record, identified by a KEY. If the KEY is empty or missing, a new record will be created |
Insert or Modify Service |
Insert or Modify the data of a Service Object identified by a KEY (Service ID) . If the KEY is empty or missing a record is inserted. |
Insert or Modify Stock Document |
Insert or Modify the data of a Stock Document record, identified by a KEY. If the KEY is empty or missing, a new record will be created |
Insert or Modify Supplier |
Insert or Modify the data of a Supplier Object identified by a KEY (Supplier ID) . If the KEY is empty or missing a record is inserted. |
Insert or Modify Task |
Insert or Modify the data of a Task Object identified by a KEY (Task ID) . If the KEY is empty or missing a record is inserted. |
Insert Remote Key |
Insert third-party application ID to a Soft1 Object |
Microservice |
Makes a call to a Soft1 microservice. Insert request's body and web service's endpoint. |
Get Cheque
Returns all data (or the selected ones from LOCATEINFO) of a record of an Cheque Object
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify cheque's form |
|
KEY
|
KEY | True | string |
Insert a valid cheque record ID |
LOCATEINFO
|
LOCATEINFO | True | string |
Specify cheque's desired fields |
Returns
Name | Path | Type | Description |
---|---|---|---|
Caption
|
caption | string |
Descriptive caption of the cheque's record |
Remote Key
|
remoteKey | string |
Third party application ID |
bank
|
data.CHEQUE.BANK | string |
The cheque's bank |
bank code
|
data.CHEQUE.BANK_BANK_CODE | string |
The cheque's bank code |
bank name
|
data.CHEQUE.BANK_BANK_NAME | string |
The cheque's bank name |
balance
|
data.CHEQUE.CHEQUEBAL | string |
The cheque's balance |
number
|
data.CHEQUE.CHEQUENUMBER | string |
The cheque's number |
state
|
data.CHEQUE.CHEQUESTATES | string |
The cheque's state |
value
|
data.CHEQUE.CHEQUEVAL | string |
The cheque's value |
company
|
data.CHEQUE.COMPANY | string |
The cheque's company |
issuer address
|
data.CHEQUE.CREATORADDR | string |
The cheque's issuer address |
issuer name
|
data.CHEQUE.CREATORNAME | string |
The cheque's issuer name |
issuer telephone
|
data.CHEQUE.CREATORPHONE | string |
The cheque's issuer telephone |
receipt date
|
data.CHEQUE.CRTDATE | string |
The cheque's receipt date |
issue date
|
data.CHEQUE.DATEOFS | string |
The cheque's issue date |
due date
|
data.CHEQUE.FINALDATE | date-time |
The cheque's due date |
holder address
|
data.CHEQUE.HOLDERADDR | string |
The cheque's holder address |
holder name
|
data.CHEQUE.HOLDERNAME | string |
The cheque's holder name |
issuer T.R.No
|
data.CHEQUE.PUBLISHERAFM | string |
The cheque's issuer Tax Registration Number |
comments
|
data.CHEQUE.REMARKS | string |
The cheque's comments |
series
|
data.CHEQUE.SERIES | string |
The cheque's series |
currency
|
data.CHEQUE.SOCURRENCY | string |
The cheque's currency |
holder code
|
data.CHEQUE.TRDRPOSSESSOR_TRDR_CODE | string |
The cheque's holder code |
issuer code
|
data.CHEQUE.TRDRPUBLISHER_TRDR_CODE | string |
The cheque's issuer code |
Error
|
error | string |
Error message if action is unsuccessful |
Error code
|
errorcode | integer |
Error code if action is unsuccessful |
Success
|
success | boolean |
Is action successful? |
Get Collections Document
Returns all data (or the selected ones from LOCATEINFO) of a record of a Collections Object.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify document's form |
|
KEY
|
KEY | True | string |
Insert a valid document record ID |
LOCATEINFO
|
LOCATEINFO | True | string |
Specify document's desired data fields |
Returns
Name | Path | Type | Description |
---|---|---|---|
Caption
|
caption | string |
Descriptive caption of the document record |
Remote Key
|
remoteKey | string |
Third party application ID |
Credit cards
|
data.CARDLINES | array of object |
Credit cards data array |
No.
|
data.CARDLINES.CRDCARDNUM | string |
The credit card's number |
ID
|
data.CARDLINES.CREDITCARDS | string |
The credit card's name and ID |
line number
|
data.CARDLINES.LINENUM | string |
The credit card's line number |
line value
|
data.CARDLINES.LINEVAL | string |
The credit card's line value |
Cashes
|
data.CASHLINES | array of object |
Cashes data array |
line No.
|
data.CASHLINES.LINENUM | string |
The cash's line number |
line value
|
data.CASHLINES.LINEVAL | string |
The cash's line value |
currency
|
data.CASHLINES.SOCURRENCY | string |
The cash's currency |
collector
|
data.CFNCUSDOC.COLLECTOR | string |
The document's collector ID |
collector surname
|
data.CFNCUSDOC.COLLECTOR_PRSNIN_NAME2 | string |
The document's collector surname |
company
|
data.CFNCUSDOC.COMPANY | string |
The document's company name and ID |
code
|
data.CFNCUSDOC.FINCODE | string |
The document's code |
project
|
data.CFNCUSDOC.PRJC | string |
The document's project ID |
project name
|
data.CFNCUSDOC.PRJC_PRJC_NAME | date-time |
The document's project name |
comments
|
data.CFNCUSDOC.REMARKS | string |
Comments about the document |
salesman
|
data.CFNCUSDOC.SALESMAN | string |
The document's salesman ID |
salesman surname
|
data.CFNCUSDOC.SALESMAN_PRSNIN_NAME2 | string |
The document's salesman surname |
series
|
data.CFNCUSDOC.SERIES | string |
The document's series |
total
|
data.CFNCUSDOC.SUMAMNT | string |
The document's total value |
customer
|
data.CFNCUSDOC.TRDR | string |
The document's customer ID |
customer code
|
data.CFNCUSDOC.TRDR_TRDR_CODE | string |
The document's customer code |
customer name
|
data.CFNCUSDOC.TRDR_TRDR_NAME | string |
The document's customer name |
transaction date
|
data.CFNCUSDOC.TRNDATE | date-time |
The document's transaction date |
Cheque
|
data.CHEQUELINES | array of object |
Cheques data array |
due date
|
data.CHEQUELINES.CFINALDATE | date-time |
CFINALDATE |
code
|
data.CHEQUELINES.CODE | string |
CODE |
series
|
data.CHEQUELINES.CSERIES | string |
CSERIES |
line number
|
data.CHEQUELINES.LINENUM | string |
LINENUM |
line value
|
data.CHEQUELINES.LINEVAL | string |
LINEVAL |
transaction type
|
data.CHEQUELINES.TPRMS | string |
TPRMS |
Error
|
error | string |
Error message if action is unsuccessful |
Error code
|
errorcode | integer |
Error code if action is unsuccessful |
Success
|
success | boolean |
Is action successful? |
Get Contact
Returns all data (or the selected ones from LOCATEINFO) of a record of a contact object
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify contact's form |
|
KEY
|
KEY | True | string |
Insert a valid contact record ID |
LOCATEINFO
|
LOCATEINFO | True | string |
Specify document's desired data fields |
Returns
Name | Path | Type | Description |
---|---|---|---|
Caption
|
caption | string |
Brief caption of the contact record |
Remote Key
|
remoteKey | string |
Third party application ID |
address
|
data.PRSNOUT.ADDRESS | string |
The address of the contact |
T.R.No
|
data.PRSNOUT.AFM | string |
Tax Registration Number of the contact |
geographical area
|
data.PRSNOUT.AREAS | string |
The contact's geographical area ID and name |
Date of birth
|
data.PRSNOUT.BIRTHDATE | string |
The date of birth of the contact |
branch
|
data.PRSNOUT.BRANCH | string |
The contact's branch name and ID |
city
|
data.PRSNOUT.CITY | string |
The contact's city |
code
|
data.PRSNOUT.CODE | string |
The code of the contact |
country
|
data.PRSNOUT.COUNTRY | string |
The contact's country ID and name |
district
|
data.PRSNOUT.DISTRICT | string |
The location area of the contact |
first email
|
data.PRSNOUT.EMAIL | string |
The first email address of the contact |
second email
|
data.PRSNOUT.EMAIL1 | string |
The second email address of the contact |
fax
|
data.PRSNOUT.FAX | string |
The fax number of the contact |
ID card No
|
data.PRSNOUT.IDENTITYNUM | string |
The contact's ID card number |
tax office
|
data.PRSNOUT.IRSDATA | string |
The tax office of the contact |
Active
|
data.PRSNOUT.ISACTIVE | string |
Is contact active? |
mobile telephone
|
data.PRSNOUT.MOBILEPHONE | string |
The contact's mobile telephone |
name
|
data.PRSNOUT.NAME | string |
The contact's name |
surname
|
data.PRSNOUT.NAME2 | string |
The contact's surname |
nationality
|
data.PRSNOUT.NATIONALITY | string |
The contact's nationality ID and name |
Tel. 1
|
data.PRSNOUT.PHONE1 | string |
The first telephone number of the contact |
Tel. 2
|
data.PRSNOUT.PHONE2 | string |
The second telephone number of the contact |
internal telephone
|
data.PRSNOUT.PHONEEXT | string |
The contact's internal telephone |
personal telephone
|
data.PRSNOUT.PHONELOCAL | string |
The contact's home telephone |
comments
|
data.PRSNOUT.REMARKS | string |
The contact's comments |
gender
|
data.PRSNOUT.SOSEX | string |
The gender of the contact |
web page
|
data.PRSNOUT.WEBPAGE | string |
The contact's web page |
zip
|
data.PRSNOUT.ZIP | string |
The contact's zip code |
Attached item
|
data.XTRDOCDATA | array of object |
Attached items data array |
line No.
|
data.XTRDOCDATA.LINENUM | string |
Line number of the attached item |
name
|
data.XTRDOCDATA.NAME | string |
File name of the attached item |
url
|
data.XTRDOCDATA.SOFNAME | string |
Url address of the attached item |
Error
|
error | string |
Error message if action is unsuccessful |
Error code
|
errorcode | integer |
Error code if action is unsuccessful |
Success
|
success | boolean |
Is action successful? |
Get Customer
Returns all data (or the selected ones from LOCATEINFO) of a record of a Customer Object.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify customer's form |
|
KEY
|
KEY | True | string |
Insert a valid customer record ID |
LOCATEINFO
|
LOCATEINFO | True | string |
Specify customer's desired data fields |
Returns
Name | Path | Type | Description |
---|---|---|---|
Caption
|
caption | string |
A descriptive caption of the record. |
Remote Key
|
remoteKey | string |
Third party application ID |
primary Address
|
data.CUSTOMER.ADDRESS | string |
The primary address of the customer |
T.R.No
|
data.CUSTOMER.AFM | string |
tax registration number of the customer |
geographical area
|
data.CUSTOMER.AREAS | string |
The Geographical area of the customer |
city
|
data.CUSTOMER.CITY | string |
The city of the customer |
Code
|
data.CUSTOMER.CODE | string |
Customer's code |
discount (%)
|
data.CUSTOMER.DISCOUNT | string |
Percentage (%) discount of the customer |
location area
|
data.CUSTOMER.DISTRICT | string |
The location area of the customer |
e-mail
|
data.CUSTOMER.EMAIL | string |
The email address of the customer |
fax
|
data.CUSTOMER.FAX | string |
The FAX number of the customer |
tax Office
|
data.CUSTOMER.IRSDATA | string |
The tax office of the customer |
Active
|
data.CUSTOMER.ISACTIVE | string |
Is customer active? |
profession
|
data.CUSTOMER.JOBTYPETRD | string |
The profession of the customer |
name
|
data.CUSTOMER.NAME | string |
The name of the customer |
primary telephone
|
data.CUSTOMER.PHONE01 | string |
The primary phone number of the customer |
comments
|
data.CUSTOMER.REMARKS | string |
Comments on customer record |
tax category
|
data.CUSTOMER.VATSTS | string |
The tax category of the customer |
zip
|
data.CUSTOMER.ZIP | string |
The zip code of the customer |
Error
|
error | string |
Error message if action is unsuccessful |
Error code
|
errorcode | integer |
Error code if action is unsuccessful |
Success
|
success | boolean |
Is action successful? |
Get Draft entry
Returns all data (or the selected ones from LOCATEINFO) of a record of a Draft entry object
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify document's form |
|
KEY
|
KEY | True | string |
Insert a valid document record ID |
LOCATEINFO
|
LOCATEINFO | True | string |
Specify document's desired data fields |
Returns
Name | Path | Type | Description |
---|---|---|---|
Caption
|
caption | string |
Brief caption of the draft entry record |
Remote Key
|
remoteKey | string |
Third party application ID |
address
|
data.SODRAFT.ADDRESS | string |
The draft entry's address |
T.R.No
|
data.SODRAFT.AFM | string |
The draft entry's Tax Registration Number |
city
|
data.SODRAFT.CITY | string |
The draft entry's city |
code
|
data.SODRAFT.CODE | string |
The draft entry's code |
country
|
data.SODRAFT.COUNTRY | string |
The draft entry's country |
area
|
data.SODRAFT.DISTRICT | string |
The draft entry's area |
prefecture
|
data.SODRAFT.DISTRICT1 | string |
The draft entry's prefecture |
category
|
data.SODRAFT.DRAFTTYPE | string |
The draft entry's category |
company email
|
data.SODRAFT.EMAIL | string |
The draft entry's company email |
business email
|
data.SODRAFT.EMAIL1 | string |
The draft entry's business email |
personal email
|
data.SODRAFT.EMAIL2 | string |
The draft entry's personal email |
ID card No
|
data.SODRAFT.IDENTITYNUM | string |
The draft entry's ID card number |
activity
|
data.SODRAFT.JOBTYPETRD | string |
The draft entry's activity |
mobile telephone
|
data.SODRAFT.MOBILEPHONE | string |
The draft entry's mobile telephone |
name/title
|
data.SODRAFT.NAMEC | string |
The draft entry's name/title |
first name
|
data.SODRAFT.NAMEF | string |
The draft entry's first name |
surname
|
data.SODRAFT.NAMEL | string |
The draft entry's surname |
General Com. Reg.
|
data.SODRAFT.NUMCG | string |
The draft entry's General Commercial Registry |
business telephone
|
data.SODRAFT.PHONE1 | string |
The draft entry's business telephone |
internal telephone
|
data.SODRAFT.PHONEEXT | string |
The draft entry's internal telephone |
personal telephone
|
data.SODRAFT.PHONELOCAL | string |
The draft entry's personal telephone |
comments
|
data.SODRAFT.REMARKS | string |
The draft entry's comments |
title
|
data.SODRAFT.SOTITLENAME | string |
The draft entry's title |
web page
|
data.SODRAFT.WEBPAGE | string |
The draft entry's web page |
zip
|
data.SODRAFT.ZIP | string |
The draft entry's zip code |
branch
|
data.SODRAFTLNK.BRANCH | string |
The draft entry's branch name and ID |
business unit
|
data.SODRAFTLNK.BUSUNITS | string |
The draft entry's business unit name and ID |
department
|
data.SODRAFTLNK.DEPART | string |
The draft entry's department |
project
|
data.SODRAFTLNK.PRJC | string |
The draft entry's project |
source
|
data.SODRAFTLNK.PRJCLEAD | string |
The draft entry's source name and ID |
Error
|
error | string |
Error message if action is unsuccessful |
Error code
|
errorcode | integer |
Error code if action is unsuccessful |
Success
|
success | boolean |
Is action successful? |
Get Email
Returns all data (or the selected ones from LOCATEINFO) of a record of a Email Object
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify the email's form |
|
KEY
|
KEY | True | string |
Insert a valid email record ID |
LOCATEINFO
|
LOCATEINFO | True | string |
Specify email's desired data fields |
Returns
Name | Path | Type | Description |
---|---|---|---|
Caption
|
caption | string |
Brief caption of the record |
Remote Key
|
remoteKey | string |
Third party application ID |
operator
|
data.SOACTION.ACTOR | string |
Operator of the task |
operator contact
|
data.SOACTION.ACTPRSN | string |
Contact of the task's operator |
status
|
data.SOACTION.ACTSTATUS | string |
The task's status |
subject
|
data.SOACTION.COMMENTS | string |
The subject of the task |
due date
|
data.SOACTION.FINALDATE | date-time |
Due date of the task |
start date
|
data.SOACTION.FROMDATE | date-time |
Start date of the task |
ordered By
|
data.SOACTION.ORDEREDBY | string |
Orderer of the task |
ordered by contact
|
data.SOACTION.ORDPRSN | string |
Contact of the task's orderer |
priority
|
data.SOACTION.PRIORITY | string |
Priority of the task |
project
|
data.SOACTION.PRJC | string |
The project of the task |
comments
|
data.SOACTION.REMARKS | string |
Comments about the task |
series
|
data.SOACTION.SERIES | string |
The series of the task |
completed
|
data.SOACTION.TASKCOMPLETE | string |
Is task completed? |
customer ID
|
data.SOACTION.TRDR | string |
The task's customer ID |
customer name
|
data.SOACTION.TRDR_GENTRDR_NAME | string |
The task's customer name |
insert date
|
data.SOACTION.TRNDATE | date-time |
The date the task was created |
from address
|
data.SOMAIL.FROMADDRESS | string |
The mailbox owner's and sender's address |
sender
|
data.SOMAIL.FROMNAME | string |
The mailbox owner's and sender's name |
date
|
data.SOMAIL.MAILDATE | date-time |
E-mail's date |
BCC
|
data.SOMAIL.SOBCC | string |
The Bcc recipients of the message |
body
|
data.SOMAIL.SOBODY | string |
The body of the message |
CC
|
data.SOMAIL.SOCC | string |
The Cc recipients of the message |
To
|
data.SOMAIL.SOTO | string |
The recipients of the message |
Attached item
|
data.XTRDOCDATA | array of object |
Attached items data array |
line No.
|
data.XTRDOCDATA.LINENUM | string |
Line number of the attached item |
name
|
data.XTRDOCDATA.NAME | string |
File name of the attached item |
url
|
data.XTRDOCDATA.SOFNAME | string |
Url address of the attached item |
Error
|
error | string |
Error message if action is unsuccessful |
Error code
|
errorcode | integer |
Error code if action is unsuccessful |
Success
|
success | boolean |
Is action successful? |
Get Expenses
Returns all data (or the selected ones from LOCATEINFO) of a record of an Expense Object.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify expense's form |
|
KEY
|
KEY | True | string |
Insert a valid expense record ID |
LOCATEINFO
|
LOCATEINFO | True | string |
Specify service's desired fields |
Returns
Name | Path | Type | Description |
---|---|---|---|
Caption
|
caption | string |
Descriptive caption of the expense's record |
Remote Key
|
remoteKey | string |
Third party application ID |
code
|
data.LINEITEM.CODE | string |
The expense's code |
Active
|
data.LINEITEM.ISACTIVE | string |
Is expense active? |
invoicing category
|
data.LINEITEM.LISOURCETYPE | string |
The expense's invoicing category |
commercial category
|
data.LINEITEM.MTRCATEGORY | string |
The expense's commercial category |
type
|
data.LINEITEM.MTRTYPE | string |
The expense's type |
description
|
data.LINEITEM.NAME | string |
The expense's name |
comments
|
data.LINEITEM.REMARKS | string |
The expense's comments |
Fee value
|
data.LINEITEM.SOPAYVALUE | string |
The expense's fee value |
VAT Group
|
data.LINEITEM.VAT | string |
The expense's Value Added Tax |
Error
|
error | string |
Error message if action is unsuccessful |
Error code
|
errorcode | integer |
Error code if action is unsuccessful |
Success
|
success | boolean |
Is action successful? |
Get Expenses Document
Returns all data (or the selected ones from LOCATEINFO) of a record of an Expenses Object.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify document's form |
|
KEY
|
KEY | True | string |
Insert a valid document record ID |
LOCATEINFO
|
LOCATEINFO | string |
Specify document's desired data fields |
Returns
Name | Path | Type | Description |
---|---|---|---|
Caption
|
caption | string |
Descriptive caption of the document record |
Remote Key
|
remoteKey | string |
Third party application ID |
Expenses
|
data.LINLINES | array of object |
Expenses data array |
line number
|
data.LINLINES.LINENUM | string |
The document's expense line No. |
line value
|
data.LINLINES.LINEVAL | string |
The document's expense line value |
ID
|
data.LINLINES.MTRL | string |
ID of the document's expense |
code
|
data.LINLINES.MTRL_ITEM_CODE | string |
Code of the document's expense |
name
|
data.LINLINES.MTRL_ITEM_NAME | string |
The document's expense name |
VAT ID
|
data.LINLINES.VAT | string |
The document's expense Value Added Tax ID |
VAT amount
|
data.LINLINES.VATAMNT | string |
The document's expense Value Added Tax value |
company
|
data.LINSUPDOC.COMPANY | string |
The document's company ID and Name |
code
|
data.LINSUPDOC.FINCODE | string |
The document's code |
payment
|
data.LINSUPDOC.PAYMENT | string |
The document's payment method |
series
|
data.LINSUPDOC.SERIES | string |
The document's series |
currency
|
data.LINSUPDOC.SOCURRENCY | string |
The document's payment currency |
total
|
data.LINSUPDOC.SUMAMNT | string |
The document's total value |
supplier ID
|
data.LINSUPDOC.TRDR | string |
The document's supplier ID |
supplier T.R.No
|
data.LINSUPDOC.TRDR_SUPPLIER_AFM | string |
The document's supplier Tax Registration Number |
supplier name
|
data.LINSUPDOC.TRDR_SUPPLIER_NAME | string |
The document's supplier name |
transaction date
|
data.LINSUPDOC.TRNDATE | date-time |
The document's transaction date |
VAT amount
|
data.LINSUPDOC.VATAMNT | string |
The document's Value Added Tax amount |
Error
|
error | string |
Error message if action is unsuccessful |
Error code
|
errorcode | integer |
Error code if action is unsuccessful |
Success
|
success | boolean |
Is action successful? |
Get Item
Returns all data (or the selected ones from LOCATEINFO) of a record of an Item Object.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify item's form |
|
KEY
|
KEY | True | string |
Insert a valid item record ID |
LOCATEINFO
|
LOCATEINFO | True | string |
Specify item's desired fields |
Returns
Name | Path | Type | Description |
---|---|---|---|
Caption
|
caption | string |
Descriptive caption of the item's record |
Remote Key
|
remoteKey | string |
Third party application ID |
code
|
data.ITEM.CODE | string |
The item's code |
Active
|
data.ITEM.ISACTIVE | string |
Is item active? |
commercial category
|
data.ITEM.MTRCATEGORY | string |
The item's commercial category |
item Group
|
data.ITEM.MTRGROUP | string |
The item's group |
base unit of measure
|
data.ITEM.MTRUNIT1 | string |
The item's base unit of measure |
description
|
data.ITEM.NAME | string |
The item's name |
retail price
|
data.ITEM.PRICER | string |
The item's retail price |
wholesale price
|
data.ITEM.PRICEW | string |
The item's wholesale price |
comments
|
data.ITEM.REMARKS | string |
The item's comments |
discount (%)
|
data.ITEM.SODISCOUNT | string |
The item's discount |
VAT Group
|
data.ITEM.VAT | string |
The item's Value Added Tax |
Error
|
error | string |
Error message if action is unsuccessful |
Error code
|
errorcode | integer |
Error code if action is unsuccessful |
Success
|
success | boolean |
Is action successful? |
Get Meeting
Returns all data (or the selected ones from LOCATEINFO) of a record of a Meeting Object.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify meeting's form |
|
KEY
|
KEY | True | string |
Insert a valid meeting record ID |
LOCATEINFO
|
LOCATEINFO | True | string |
Specify meeting's desired data fields |
Returns
Name | Path | Type | Description |
---|---|---|---|
Caption
|
caption | string |
Descriptive caption of the meeting record |
Remote Key
|
remoteKey | string |
Third party application ID |
operator
|
data.SOACTION.ACTOR | string |
Operator of the meeting |
operator contact
|
data.SOACTION.ACTPRSN | string |
Contact of the meeting's operator |
status
|
data.SOACTION.ACTSTATUS | string |
The meeting's status |
subject
|
data.SOACTION.COMMENTS | string |
The subject of the meeting |
due date
|
data.SOACTION.FINALDATE | date-time |
Due date of the meeting |
start date
|
data.SOACTION.FROMDATE | date-time |
Start date of the meeting |
ordered By
|
data.SOACTION.ORDEREDBY | string |
Orderer of the meeting |
ordered by contact
|
data.SOACTION.ORDPRSN | string |
Contact of the meeting's orderer |
priority
|
data.SOACTION.PRIORITY | string |
Priority of the meeting |
project
|
data.SOACTION.PRJC | string |
The project of the meeting |
comments
|
data.SOACTION.REMARKS | string |
Comments about the meeting |
series
|
data.SOACTION.SERIES | string |
The series of the meeting |
completed
|
data.SOACTION.TASKCOMPLETE | string |
Is meeting completed? |
customer ID
|
data.SOACTION.TRDR | string |
The meeting's customer ID |
customer name
|
data.SOACTION.TRDR_GENTRDR_NAME | string |
The meeting's customer name |
insert date
|
data.SOACTION.TRNDATE | date-time |
The date the meeting was created |
Error
|
error | string |
Error message if action is unsuccessful |
Error code
|
errorcode | integer |
Error code if action is unsuccessful |
Success
|
success | boolean |
Is action successful? |
Get Payments Document
Returns all data (or the selected ones from LOCATEINFO) of a record of a Payment Object.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify document's form |
|
KEY
|
KEY | True | string |
Insert a valid document record ID |
LOCATEINFO
|
LOCATEINFO | True | string |
Specify document's desired data fields |
Returns
Name | Path | Type | Description |
---|---|---|---|
Caption
|
caption | string |
Descriptive caption of the document record |
Remote Key
|
remoteKey | string |
Third party application ID |
Credit cards
|
data.CARDLINES | array of object |
Credit cards data array |
No.
|
data.CARDLINES.CRDCARDNUM | string |
The credit card's number |
ID
|
data.CARDLINES.CREDITCARDS | string |
The credit card's name and ID |
line number
|
data.CARDLINES.LINENUM | string |
The credit card's line number |
line value
|
data.CARDLINES.LINEVAL | string |
The credit card's line value |
Cashes
|
data.CASHLINES | array of object |
Cashes data array |
line number
|
data.CASHLINES.LINENUM | string |
The cash's line number |
line value
|
data.CASHLINES.LINEVAL | string |
The cash's line value |
line currency
|
data.CASHLINES.SOCURRENCY | string |
The cash's currency |
reason
|
data.CFNSUPDOC.COMMENTS | string |
The document's reason |
company
|
data.CFNSUPDOC.COMPANY | string |
The document's company name and ID |
code
|
data.CFNSUPDOC.FINCODE | string |
The document's code |
project
|
data.CFNSUPDOC.PRJC | string |
The document's project ID |
project name
|
data.CFNSUPDOC.PRJC_PRJC_NAME | date-time |
The document's project name |
series
|
data.CFNSUPDOC.SERIES | string |
The document's series |
total
|
data.CFNSUPDOC.SUMAMNT | string |
The document's total value |
supplier
|
data.CFNSUPDOC.TRDR | string |
The document's supplier ID |
supplier address
|
data.CFNSUPDOC.TRDR_TRDR_ADDRESS | string |
The document's supplier address |
supplier T.R.No
|
data.CFNSUPDOC.TRDR_TRDR_AFM | string |
The document's supplier Tax Registration Number (T.R.No) |
supplier code
|
data.CFNSUPDOC.TRDR_TRDR_CODE | string |
The document's supplier code |
supplier tax office
|
data.CFNSUPDOC.TRDR_TRDR_IRSDATA | string |
The document's supplier tax office |
supplier name
|
data.CFNSUPDOC.TRDR_TRDR_NAME | string |
The document's supplier name |
transaction date
|
data.CFNSUPDOC.TRNDATE | date-time |
The document's transaction date |
Cheque
|
data.CHEQUELINES | array of object |
Cheques data array |
due date
|
data.CHEQUELINES.CFINALDATE | date-time |
CFINALDATE |
code
|
data.CHEQUELINES.CODE | string |
CODE |
series
|
data.CHEQUELINES.CSERIES | string |
CSERIES |
line number
|
data.CHEQUELINES.LINENUM | string |
LINENUM |
line value
|
data.CHEQUELINES.LINEVAL | string |
LINEVAL |
transaction type
|
data.CHEQUELINES.TPRMS | string |
TPRMS |
Error
|
error | string |
Error message if action is unsuccessful |
Error code
|
errorcode | integer |
Error code if action is unsuccessful |
Success
|
success | boolean |
Is action successful? |
Get Project
Returns all data (or the selected ones from LOCATEINFO) of a record of a project object
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify project's form |
|
KEY
|
KEY | True | string |
Insert a valid project record ID |
LOCATEINFO
|
LOCATEINFO | True | string |
Specify project's desired data fields |
Returns
Name | Path | Type | Description |
---|---|---|---|
Caption
|
caption | string |
Brief caption of the project record |
status
|
data.PRJC.ACTSTATUS | string |
The project's status |
code
|
data.PRJC.CODE | string |
The code of the project |
due date
|
data.PRJC.FINALDATE | date-time |
Due date of the project |
start date
|
data.PRJC.FROMDATE | date-time |
Start date of the project |
Active
|
data.PRJC.ISACTIVE | string |
Is project active? |
name
|
data.PRJC.NAME | string |
The project's name |
ID
|
data.PRJC.PRJC | string |
The project's ID |
variation
|
data.PRJC.PRJCRM | string |
The project's variation |
comments
|
data.PRJC.REMARKS | string |
The project's comments |
Attached item
|
data.XTRDOCDATA | array of object |
Attached items data array |
line No.
|
data.XTRDOCDATA.LINENUM | string |
Line number of the attached item |
name
|
data.XTRDOCDATA.NAME | string |
File name of the attached item |
url
|
data.XTRDOCDATA.SOFNAME | string |
Url address of the attached item |
Error
|
error | string |
Error message if action is unsuccessful |
Error code
|
errorcode | integer |
Error code if action is unsuccessful |
Success
|
success | boolean |
Is action successful? |
Get Purchases Document
Returns all data (or the selected ones from LOCATEINFO) of a record of a Purchase Object.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify document's form |
|
KEY
|
KEY | True | string |
Insert a valid document record ID |
LOCATEINFO
|
LOCATEINFO | True | string |
Specify document's desired data fields |
Returns
Name | Path | Type | Description |
---|---|---|---|
Caption
|
caption | string |
Brief caption of the document record |
Remote Key
|
remoteKey | string |
Third party application ID |
Items
|
data.ITELINES | array of object |
Items data array |
discount
|
data.ITELINES.DISC1PRC | string |
The document's item discount |
line number
|
data.ITELINES.LINENUM | string |
The document's item line number |
value
|
data.ITELINES.LINEVAL | string |
The document's item line value |
ID
|
data.ITELINES.MTRL | string |
The document's item ID |
code
|
data.ITELINES.MTRL_ITEM_CODE | string |
Code of the document's item |
name
|
data.ITELINES.MTRL_ITEM_NAME | string |
The document's item name |
price
|
data.ITELINES.PRICE | string |
The document's item price |
quantity
|
data.ITELINES.QTY | string |
The document's item quantity |
Company
|
data.MTRDOC.COMPANY | string |
The document's company ID |
Delivery date
|
data.MTRDOC.DELIVDATE | date-time |
The document's delivery date |
Shipping address
|
data.MTRDOC.SHIPPINGADDR | string |
The document's shipping address |
Warehouse
|
data.MTRDOC.WHOUSE | string |
The document's warehouse name and ID |
company
|
data.PURDOC.COMPANY | string |
The document's company name and ID |
discount (%)
|
data.PURDOC.DISC1PRC | string |
The document's percentage(%) discount |
discount value
|
data.PURDOC.DISC1VAL | string |
The document's discount value |
expenses
|
data.PURDOC.EXPN | string |
The document's expenses |
code
|
data.PURDOC.FINCODE | string |
The document's code |
type
|
data.PURDOC.FPRMS | string |
The document's type |
net amount
|
data.PURDOC.NETAMNT | string |
The document's net amount |
payment
|
data.PURDOC.PAYMENT | string |
The document's payment method |
project
|
data.PURDOC.PRJC | string |
The document's project id |
project code
|
data.PURDOC.PRJC_PRJC_CODE | string |
The document's project code |
project name
|
data.PURDOC.PRJC_PRJC_NAME | string |
The document's project name |
comments
|
data.PURDOC.REMARKS | string |
The document's comments |
series
|
data.PURDOC.SERIES | string |
The series of the document |
purpose of delivery
|
data.PURDOC.SHIPKIND | string |
The document's purpose of delivery |
currency
|
data.PURDOC.SOCURRENCY | string |
The document's payment currency |
total
|
data.PURDOC.SUMAMNT | string |
The document's total value |
supplier ID
|
data.PURDOC.TRDR | string |
The document's supplier ID |
supplier address
|
data.PURDOC.TRDR_SUPPLIER_ADDRESS | string |
The document's supplier address |
supplier T.R.No
|
data.PURDOC.TRDR_SUPPLIER_AFM | string |
The document's supplier Tax Registration No. |
supplier code
|
data.PURDOC.TRDR_SUPPLIER_CODE | string |
The document's supplier code |
supplier Tax Office
|
data.PURDOC.TRDR_SUPPLIER_IRSDATA | string |
The document's supplier tax office |
supplier profession
|
data.PURDOC.TRDR_SUPPLIER_JOBTYPETRD | string |
The document's supplier profession |
supplier name
|
data.PURDOC.TRDR_SUPPLIER_NAME | string |
The document's supplier name |
supplier phone
|
data.PURDOC.TRDR_SUPPLIER_PHONE01 | string |
The document's supplier telephone number |
transaction date
|
data.PURDOC.TRNDATE | date-time |
The transaction date of the document |
VAT amount
|
data.PURDOC.VATAMNT | string |
The document's Value Added Tax amount |
Services
|
data.SRVLINES | array of object |
Services data array |
discount
|
data.SRVLINES.DISC1PRC | string |
The document's service discount |
line number
|
data.SRVLINES.LINENUM | string |
The document's service line number |
value
|
data.SRVLINES.LINEVAL | string |
The document's service line value |
ID
|
data.SRVLINES.MTRL | string |
The document's service ID |
code
|
data.SRVLINES.MTRL_SERVICE_CODE | date-time |
Code of the document's service |
name
|
data.SRVLINES.MTRL_SERVICE_NAME | string |
The document's service name |
price
|
data.SRVLINES.PRICE | string |
The document's service price |
quantity
|
data.SRVLINES.QTY | string |
The document's service quantity |
VAT Analysis
|
data.VATANAL | array of object |
VAT analysis array |
value subject to VAT
|
data.VATANAL.SUBVAL | string |
Document's total value subject to VAT category |
ID and category
|
data.VATANAL.VAT | string |
VAT category's ID |
value
|
data.VATANAL.VATVAL | string |
Total value of VAT category |
percent(%)
|
data.VATANAL.VAT_VAT_PERCNT | string |
VAT category percent (%) |
Error
|
error | string |
Error message if action is unsuccessful |
Error code
|
errorcode | integer |
Error code if action is unsuccessful |
Success
|
success | boolean |
Is action successful? |
Get Sales Document
Returns all data (or the selected ones from LOCATEINFO) of a record of a Sales Object.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify document's form |
|
KEY
|
KEY | True | string |
Insert a valid document record ID |
LOCATEINFO
|
LOCATEINFO | True | string |
Specify document's desired data fields |
Returns
Name | Path | Type | Description |
---|---|---|---|
Caption
|
caption | string |
Descriptive caption of the document record |
Remote Key
|
remoteKey | string |
Third party application ID |
Items
|
data.ITELINES | array of object |
Items data array |
discount
|
data.ITELINES.DISC1PRC | string |
The document's item discount |
line number
|
data.ITELINES.LINENUM | string |
The document's item line No. |
line value
|
data.ITELINES.LINEVAL | string |
The document's item line value |
ID
|
data.ITELINES.MTRL | string |
ID of the document's item |
code
|
data.ITELINES.MTRL_ITEM_CODE | string |
Code of the document's item |
name
|
data.ITELINES.MTRL_ITEM_NAME | string |
The document's item name |
price
|
data.ITELINES.PRICE | string |
The document's item price |
quantity
|
data.ITELINES.QTY | string |
The document's item quantity |
Company
|
data.MTRDOC.COMPANY | string |
The document's company ID |
Delivery date
|
data.MTRDOC.DELIVDATE | date-time |
The document's delivery date |
Shipping address
|
data.MTRDOC.SHIPPINGADDR | string |
The document's shipping address |
Warehouse
|
data.MTRDOC.WHOUSE | string |
The document's warehouse name and ID |
company
|
data.SALDOC.COMPANY | string |
The document's company name and ID |
discount (%)
|
data.SALDOC.DISC1PRC | string |
The document's percentage(%) discount |
discount value
|
data.SALDOC.DISC1VAL | string |
The document's discount value |
expenses
|
data.SALDOC.EXPN | string |
The document's expenses |
code
|
data.SALDOC.FINCODE | string |
The document's code |
type
|
data.SALDOC.FPRMS | string |
The document's type |
net amount
|
data.SALDOC.NETAMNT | string |
The document's net amount |
payment
|
data.SALDOC.PAYMENT | string |
The document's payment method |
comments
|
data.SALDOC.REMARKS | string |
The document's comments |
series
|
data.SALDOC.SERIES | string |
The document's series |
purpose of delivery
|
data.SALDOC.SHIPKIND | string |
The document's purpose of delivery |
currency
|
data.SALDOC.SOCURRENCY | string |
The document's payment currency |
total
|
data.SALDOC.SUMAMNT | string |
The document's total value |
customer ID
|
data.SALDOC.TRDR | string |
The document's customer ID |
customer address
|
data.SALDOC.TRDR_CUSTOMER_ADDRESS | string |
The document's customer address |
customer T.R.No
|
data.SALDOC.TRDR_CUSTOMER_AFM | string |
The document's customer Tax Registration Number |
customer code
|
data.SALDOC.TRDR_CUSTOMER_CODE | string |
The document's customer code |
customer Tax Office
|
data.SALDOC.TRDR_CUSTOMER_IRSDATA | string |
The document's customer tax office |
customer profession
|
data.SALDOC.TRDR_CUSTOMER_JOBTYPETRD | string |
The document's customer profession |
customer name
|
data.SALDOC.TRDR_CUSTOMER_NAME | string |
The document's customer name |
customer phone
|
data.SALDOC.TRDR_CUSTOMER_PHONE01 | string |
The document's customer telephone number |
transaction date
|
data.SALDOC.TRNDATE | date-time |
The document's transaction date |
VAT amount
|
data.SALDOC.VATAMNT | string |
The document's Value Added Tax amount |
Services
|
data.SRVLINES | array of object |
Services data array |
discount
|
data.SRVLINES.DISC1PRC | string |
The document's service discount |
line number
|
data.SRVLINES.LINENUM | string |
The document's service line number |
value
|
data.SRVLINES.LINEVAL | string |
The document's service line value |
ID
|
data.SRVLINES.MTRL | string |
The document's service ID |
code
|
data.SRVLINES.MTRL_SERVICE_CODE | string |
Code of the document's service |
name
|
data.SRVLINES.MTRL_SERVICE_NAME | string |
The document's service name |
price
|
data.SRVLINES.PRICE | string |
The document's service price |
quantity
|
data.SRVLINES.QTY | string |
The document's service quantity |
VAT Analysis
|
data.VATANAL | array of object |
VAT analysis array |
value subject to VAT
|
data.VATANAL.SUBVAL | string |
Document's total value subject to VAT category |
ID and category
|
data.VATANAL.VAT | string |
VAT category's ID |
value
|
data.VATANAL.VATVAL | string |
Total value of VAT category |
percent(%)
|
data.VATANAL.VAT_VAT_PERCNT | string |
VAT category percent (%) |
Error
|
error | string |
Error message if action is unsuccessful |
Error code
|
errorcode | integer |
Error code if action is unsuccessful |
Success
|
success | boolean |
Is action successful? |
Get Services
Returns all data (or the selected ones from LOCATEINFO) of a record of an Service Object.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify service's form |
|
KEY
|
KEY | True | string |
Insert a valid service record ID |
LOCATEINFO
|
LOCATEINFO | True | string |
Specify service's desired fields |
Returns
Name | Path | Type | Description |
---|---|---|---|
Caption
|
caption | string |
Descriptive caption of the service's record |
Remote Key
|
remoteKey | string |
Third party application ID |
code
|
data.SERVICE.CODE | string |
The service's code |
Active
|
data.SERVICE.ISACTIVE | string |
Is service active? |
commercial category
|
data.SERVICE.MTRCATEGORY | string |
The service's commercial category |
service Group
|
data.SERVICE.MTRGROUP | string |
The service's group |
base unit of measure
|
data.SERVICE.MTRUNIT1 | string |
The service's base unit of measure |
description
|
data.SERVICE.NAME | string |
The service's name |
retail price
|
data.SERVICE.PRICER | string |
The service's retail price |
wholesale price
|
data.SERVICE.PRICEW | string |
The service's wholesale price |
comments
|
data.SERVICE.REMARKS | string |
The service's comments |
discount (%)
|
data.SERVICE.SODISCOUNT | string |
The service's discount |
VAT Group
|
data.SERVICE.VAT | string |
The service's Value Added Tax |
Error
|
error | string |
Error message if action is unsuccessful |
Error code
|
errorcode | integer |
Error code if action is unsuccessful |
Success
|
success | boolean |
Is action successful? |
Get Stock Document
Returns all data (or the selected ones from LOCATEINFO) of a record of a Stock Document Object.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify document's form |
|
KEY
|
KEY | True | string |
Insert a valid document record ID |
LOCATEINFO
|
LOCATEINFO | True | string |
Specify document's desired data fields |
Returns
Name | Path | Type | Description |
---|---|---|---|
Caption
|
caption | string |
Descriptive caption of the document record |
Remote Key
|
remoteKey | string |
Third party application ID |
reason
|
data.ITEDOC.COMMENTS | string |
The document's reason |
company
|
data.ITEDOC.COMPANY | string |
The document's company ID and Name |
code
|
data.ITEDOC.FINCODE | string |
The document's code |
comments
|
data.ITEDOC.REMARKS | string |
The document's comments |
series
|
data.ITEDOC.SERIES | string |
The document's series |
transaction date
|
data.ITEDOC.TRNDATE | date-time |
The document's transaction date |
Items
|
data.ITELINES | array of object |
Items data array |
discount
|
data.ITELINES.DISC1PRC | string |
The document's item discount |
line number
|
data.ITELINES.LINENUM | string |
The document's item line No. |
line value
|
data.ITELINES.LINEVAL | string |
The document's item line value |
ID
|
data.ITELINES.MTRL | string |
ID of the document's item |
code
|
data.ITELINES.MTRL_ITEM_CODE | string |
Code of the document's item |
name
|
data.ITELINES.MTRL_ITEM_NAME | string |
The document's item name |
price
|
data.ITELINES.PRICE | string |
The document's item price |
quantity
|
data.ITELINES.QTY | string |
The document's item quantity |
Company
|
data.MTRDOC.COMPANY | string |
The document's company ID |
Delivery date
|
data.MTRDOC.DELIVDATE | date-time |
The document's delivery date |
Shipping address
|
data.MTRDOC.SHIPPINGADDR | string |
The document's shipping address |
Warehouse
|
data.MTRDOC.WHOUSE | string |
The document's warehouse name and ID |
Error
|
error | string |
Error message if action is unsuccessful |
Error code
|
errorcode | integer |
Error code if action is unsuccessful |
Success
|
success | boolean |
Is action successful? |
Get Supplier
Returns all data (or the selected ones from LOCATEINFO) of a record of a Supplier Object.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify supplier's form |
|
KEY
|
KEY | True | string |
Insert a valid supplier record ID |
LOCATEINFO
|
LOCATEINFO | True | string |
Specify supplier's desired data fields |
Returns
Name | Path | Type | Description |
---|---|---|---|
Caption
|
caption | string |
Descriptive caption of the supplier record |
Remote Key
|
remoteKey | string |
Third party application ID |
Bank accounts
|
data.SUPBANKACC | array of object |
Bank accounts data array |
Bank name
|
data.SUPBANKACC.BANK | string |
Bank account's bank name |
code
|
data.SUPBANKACC.BANK_BANK_CODE | string |
Bank's code |
IBAN
|
data.SUPBANKACC.IBAN | string |
International Bank Account number |
line No.
|
data.SUPBANKACC.LINENUM | string |
Bank account's line number |
comments
|
data.SUPBANKACC.REMARKS | string |
Comments about the bank account |
address
|
data.SUPPLIER.ADDRESS | string |
The primary address of the supplier |
T.R.No
|
data.SUPPLIER.AFM | string |
Tax registration number of the supplier |
city
|
data.SUPPLIER.CITY | string |
Percentage (%) discount of the customer |
supplier code
|
data.SUPPLIER.CODE | string |
Supplier record code |
location area
|
data.SUPPLIER.DISTRICT | string |
The location area of the supplier |
e-mail
|
data.SUPPLIER.EMAIL | string |
The email address of the supplier |
FAX
|
data.SUPPLIER.FAX | string |
The FAX number of the supplier |
tax office
|
data.SUPPLIER.IRSDATA | string |
The tax office of the supplier |
Active
|
data.SUPPLIER.ISACTIVE | string |
Is supplier active? |
profession
|
data.SUPPLIER.JOBTYPETRD | string |
The profession of the supplier |
name
|
data.SUPPLIER.NAME | string |
The name of the supplier |
primary telephone
|
data.SUPPLIER.PHONE01 | string |
The primary phone number of the supplier |
comments
|
data.SUPPLIER.REMARKS | string |
Comments on supplier record |
tax category
|
data.SUPPLIER.VATSTS | string |
The tax category of the supplier |
ZIP
|
data.SUPPLIER.ZIP | string |
The zip code of the supplier |
Error
|
error | string |
Error message if action is unsuccessful |
Error code
|
errorcode | integer |
Error code if action is unsuccessful |
Success
|
success | boolean |
Is action successful? |
Get System parameters
Returns parameters of the installation
Returns
Name | Path | Type | Description |
---|---|---|---|
address
|
companyinfo.address | string |
The adress of the company |
T.R.No
|
companyinfo.afm | string |
The Tax Registration Number of the company |
address
|
companyinfo.branch.address | string |
The address of the company's branch |
location area
|
companyinfo.branch.district | string |
The location area of the company's branch |
name
|
companyinfo.branch.name | string |
The name of the company's branch |
zip
|
companyinfo.branch.zip | string |
The zip code of the company's branch |
location area
|
companyinfo.district | string |
The location area of the company |
email
|
companyinfo.email | string |
The email of the company |
Logo
|
companyinfo.image | string |
Url of the company's logo |
tax office
|
companyinfo.irsdata | string |
The tax office of the company |
name
|
companyinfo.name | string |
The name of the company |
telephone number
|
companyinfo.phone | string |
The telephone number of the company |
zip
|
companyinfo.zip | string |
The zip code of the company |
Error
|
error | string |
Error message if action is unsuccessful |
Error code
|
errorcode | integer |
Error code if action is unsuccessful |
Serial number
|
serialnumber | string |
The serial number of the installation |
Success
|
success | boolean |
Is action successful? |
Get Task
Returns all data (or the selected ones from LOCATEINFO) of a record of a Task Object.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify task's form |
|
KEY
|
KEY | True | string |
Insert a valid task record ID |
LOCATEINFO
|
LOCATEINFO | True | string |
Specify task's desired data fields |
Returns
Name | Path | Type | Description |
---|---|---|---|
Caption
|
caption | string |
Descriptive caption of the task record |
Remote Key
|
remoteKey | string |
Third party application ID |
operator
|
data.SOACTION.ACTOR | string |
Operator of the task |
operator contact
|
data.SOACTION.ACTPRSN | string |
Contact of the task's operator |
status
|
data.SOACTION.ACTSTATUS | string |
The task's status |
subject
|
data.SOACTION.COMMENTS | string |
The subject of the task |
due date
|
data.SOACTION.FINALDATE | date-time |
Due date of the task |
start date
|
data.SOACTION.FROMDATE | date-time |
Start date of the task |
ordered By
|
data.SOACTION.ORDEREDBY | string |
Orderer of the task |
ordered by contact
|
data.SOACTION.ORDPRSN | string |
Contact of the task's orderer |
priority
|
data.SOACTION.PRIORITY | string |
Priority of the task |
project
|
data.SOACTION.PRJC | string |
The project of the task |
comments
|
data.SOACTION.REMARKS | string |
Comments about the task |
series
|
data.SOACTION.SERIES | string |
The series of the task |
completed
|
data.SOACTION.TASKCOMPLETE | string |
Is task completed? |
customer ID
|
data.SOACTION.TRDR | string |
The task's customer ID |
customer name
|
data.SOACTION.TRDR_GENTRDR_NAME | string |
The task's customer name |
insert date
|
data.SOACTION.TRNDATE | date-time |
The date the task was created |
Error
|
error | string |
Error message if action is unsuccessful |
Error code
|
errorcode | integer |
Error code if action is unsuccessful |
Success
|
success | boolean |
Is action successful? |
Insert or Modify Cheque
Insert or Modify the data of a Cheque Object identified by a KEY (Cheque ID) . If the KEY is empty or missing a record is inserted.he data of a record in an Cheque Object identified by a KEY. If the KEY is empty or missing a record is inserted.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify cheque's form |
|
KEY
|
KEY | string |
Enter a valid cheque record ID to modify it |
|
Bank
|
BANK | string |
Select bank or enter bank ID |
|
Balance
|
CHEQUEBAL | True | string |
Specify cheque's balance |
Cheque Number
|
CHEQUENUMBER | True | string |
Insert cheque's number |
Status
|
CHEQUESTATES | True | string |
Select cheque's status or enter status ID |
Value
|
CHEQUEVAL | True | string |
Specify cheque's value |
Issuer address
|
CREATORADDR | string |
Specify the issuer's address |
|
Issuer name
|
CREATORNAME | string |
Specify the issuer's name |
|
Issuer telephone
|
CREATORPHONE | string |
Specify the issuer's telephone |
|
Receipt date
|
CRTDATE | string |
Specify the cheque's receipt date in YYYY-MM-DD format, or leave it blank for today |
|
Issue date
|
DATEOFS | True | string |
Specify the cheque's issue date in YYYY-MM-DD format, or leave it blank for today |
Due date
|
FINALDATE | True | date-time |
Specify the cheque's due date in YYYY-MM-DD format, or leave it blank for today |
Holder address
|
HOLDERADDR | string |
Specify cheque's holder address |
|
Holder name
|
HOLDERNAME | string |
Specify cheque's holder name |
|
Issuer T.R.No
|
PUBLISHERAFM | string |
Specify the issuer's Tax Registration Number |
|
Comments
|
REMARKS | string |
Insert comments |
|
Series
|
SERIES | True | string |
Insert a cheque code |
Returns
- Body
- setData200response
Insert or Modify Collections Document
Insert or Modify the data of a Collections document Object identified by a KEY (Document ID) . If the KEY is empty or missing a record is inserted.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Credit card No.
|
CRDCARDNUM | string |
Insert the credit card's number |
|
Credit card
|
CREDITCARDS | integer |
Select a credit card or enter the credit card's ID |
|
Credit card line No.
|
LINENUM | integer |
Specify the credit card's line number or leave it blank for default |
|
Card line value
|
LINEVAL | integer |
Specify the card line value |
|
Cash line No.
|
LINENUM | integer |
Specify the cash line number or leave it blank for default |
|
Cash line value
|
LINEVAL | integer |
Specify the cash line value |
|
Collector
|
COLLECTOR | string |
Select the Collector or enter the Collector ID |
|
Reason
|
COMMENTS | string |
Select the reason or enter the reason ID |
|
Project
|
PRJC | string |
Select the project or enter the project ID |
|
Salesman
|
SALESMAN | string |
Select the Salesman or enter the Salesman ID |
|
Series
|
SERIES | True | string |
Select the Series of the document or enter the Series ID |
Customer
|
TRDR | True | string |
Select the Customer or enter the Customer ID |
Transaction date
|
TRNDATE | string |
Specify transaction date in YYYY-MM-DD format or leave it blank for today |
|
Cheque No.
|
CCHEQUENUMBER | string |
Insert cheque No. |
|
Cheque due date
|
CFINALDATE | date-time |
Specify cheque's due date with format: YYYY-MM-DD or leave it blank for today's date |
|
Cheque
|
CODE | string |
Insert cheque code |
|
Cheque series
|
CSERIES | integer |
Select cheque series or enter cheque series ID |
|
Cheque line number
|
LINENUM | integer |
Specify the cheque line number or leave it blank for default |
|
Cheque line value
|
LINEVAL | integer |
Specify cheque line value |
|
Cheque transaction type
|
TPRMS | integer |
Select transaction type or enter transaction type ID |
|
FORM
|
FORM | string |
Specify the document's form |
|
KEY
|
KEY | string |
Enter a valid document record ID to modify it |
Returns
- Body
- setData200response
Insert or Modify Contact
Insert or Modify the data of a Contact Object identified by a KEY (Contact ID) . If the KEY is empty or missing a record is inserted.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify contact's form |
|
KEY
|
KEY | string |
Enter a valid contact ID to modify it |
|
Address
|
ADDRESS | string |
Specify the address of the contact |
|
T.R.No
|
AFM | string |
Specify the Tax Registration Number of the contact |
|
Geographical Areas
|
AREAS | string |
Select the geographical area |
|
Date of birth
|
BIRTHDATE | date-time |
Specify the date of birth of the contact in YYYY-MM-DD format, or leave it blank for today |
|
City
|
CITY | string |
Specify the city of the contact |
|
Code
|
CODE | True | string |
Insert a contact code |
Country
|
COUNTRY | string |
Select the country or enter the country ID |
|
Area
|
DISTRICT | string |
Specify the area of the contact |
|
Prefecture
|
DISTRICT1 | string |
Specify the prefecture of the contact |
|
Education level
|
EDUCAT | string |
Select the education level of the contact |
|
Email
|
string |
Specify the email of the contact |
||
Email 2
|
EMAIL1 | string |
Specify second email of the contact |
|
Fax
|
FAX | string |
Specify the fax number of the contact |
|
ID card No
|
IDENTITYNUM | string |
Specify the ID card number of the contact |
|
Tax Office
|
IRSDATA | string |
Select the tax office of the contact |
|
Mobile telephone
|
MOBILEPHONE | string |
Specify the mobile telephone number of the contact |
|
Name
|
NAME | True | string |
Specify the name of the contact |
Surname
|
NAME2 | string |
Specify the surname of the contact |
|
Father's name
|
NAME3 | string |
Specify the father's name of the contact |
|
Mother's name
|
NAME4 | string |
Specify the mother's name of the contact |
|
Name of spouse
|
NAME5 | string |
Specify the name of spouse of the contact |
|
Nationality
|
NATIONALITY | string |
Select the nationality or enter the nationality ID |
|
Tel. 1
|
PHONE1 | string |
Specify first telephone number of the contact |
|
Tel. 2
|
PHONE2 | string |
Specify second telephone number of the contact |
|
Internal telephone
|
PHONEEXT | string |
Specify the internal telephone number of the contact |
|
Personal telephone
|
PHONELOCAL | string |
Specify the personal telephone number of the contact |
|
Comments
|
REMARKS | string |
Insert comments |
|
Gender
|
SOSEX | string |
Select the gender of the contact. '1' for Male and '2' for Female |
|
Web page
|
WEBPAGE | string |
Specify the web page of the contact |
|
Zip
|
ZIP | string |
Specify the zip code of the contact |
|
line No
|
LINENUM | string |
Specify the line No. of the attached item |
|
name
|
NAME | string |
Specify the file name of the attached item |
|
url
|
SOFNAME | string |
Specify the url address of the attached item |
Returns
- Body
- setData200response
Insert or Modify Customer
Insert or Modify the data of a Customer Object identified by a KEY (Customer ID) . If the KEY is empty or missing a record is inserted.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify customer's form |
|
KEY
|
KEY | string |
Enter a valid customer ID to modify it |
|
Primary Address
|
ADDRESS | string |
Specify the primary address of the customer |
|
T.R.No
|
AFM | string |
Specify the tax registration number of the customer |
|
Geographical Areas
|
AREAS | string |
Select the geographical area |
|
City
|
CITY | string |
Specify the city of the customer |
|
Code
|
CODE | True | string |
Insert a customer code |
Discount
|
DISCOUNT | integer |
Specify the customer's discount |
|
Location Area
|
DISTRICT | string |
Specify the location area of the customer |
|
e-mail
|
string |
Specify the email address of the customer |
||
Fax
|
FAX | string |
Specify the fax number of the customer |
|
Tax Office
|
IRSDATA | string |
Select the tax office of the customer |
|
Profession
|
JOBTYPETRD | string |
Specify the profession of the customer |
|
Name
|
NAME | True | string |
Specify the name of the customer |
Primary Telephone
|
PHONE01 | string |
Specify the primary telephone number of the customer |
|
Comments
|
REMARKS | string |
Insert comments |
|
Tax Category
|
VATSTS | string |
Select the tax category (0 for Exempted, 1 for Normal, 2 for Reduced) |
|
Zip
|
ZIP | string |
Specify the zip code of the customer |
Returns
- Body
- setData200response
Insert or Modify Draft entry
Insert or Modify the data of a Draft entry Object identified by a KEY (Draft entry ID) . If the KEY is empty or missing a record is inserted.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify draft entry's form |
|
KEY
|
KEY | string |
Enter a valid draft entry ID to modify it |
|
Address
|
ADDRESS | string |
Specify the address of the draft entry |
|
T.R.No
|
AFM | string |
Specify the tax registration number of the draft entry |
|
City
|
CITY | string |
Specify the city of the draft entry |
|
Code
|
CODE | True | string |
Insert a draft entry code |
Country
|
COUNTRY | string |
Specify the country of the draft entry |
|
Area
|
DISTRICT | string |
Specify the area of the draft entry |
|
Prefecture
|
DISTRICT1 | string |
Specify the prefecture of the draft entry |
|
Category
|
DRAFTTYPE | string |
Specify the category of the draft entry |
|
Company email
|
string |
Specify the company email of the draft entry |
||
Business email
|
EMAIL1 | string |
Specify the business email of the draft entry |
|
Personal email
|
EMAIL2 | string |
Specify the personal email of the draft entry |
|
ID card No
|
IDENTITYNUM | string |
Specify the ID card number of the draft entry |
|
Activity
|
JOBTYPETRD | string |
Specify the activity of the draft entry |
|
Mobile telephone
|
MOBILEPHONE | string |
Specify the mobile telephone number of the draft entry |
|
Name/Title
|
NAMEC | string |
Specify the name/title of the draft entry |
|
First name
|
NAMEF | string |
Specify the first name of the draft entry |
|
Surname
|
NAMEL | string |
Specify the surname of the draft entry |
|
General Com. Reg.
|
NUMCG | string |
Specify the general commercial registry of the draft entry |
|
Business telephone
|
PHONE1 | string |
Specify the business telephone number of the draft entry |
|
Internal telephone
|
PHONEEXT | string |
Specify the internal telephone number of the draft entry |
|
Personal telephone
|
PHONELOCAL | string |
Specify the personal telephone number of the draft entry |
|
Comments
|
REMARKS | string |
Insert comments |
|
Title
|
SOTITLENAME | string |
Specify the job title of the draft entry |
|
Web page
|
WEBPAGE | string |
Specify the web page of the draft entry |
|
Zip
|
ZIP | string |
Specify the zip code of the draft entry |
|
Branch
|
BRANCH | string |
Select the branch or enter the branch ID |
|
Business unit
|
BUSUNITS | string |
Select the business unit or enter the business unit ID |
|
Department
|
DEPART | string |
Select the department or enter the department ID |
|
Project
|
PRJC | string |
Select the project or enter the project ID |
|
Source
|
PRJCLEAD | string |
Select the source or enter the source ID |
Returns
- Body
- setData200response
Insert or Modify Email
Insert or Modify the data of an Email Object identified by a KEY (Email ID) . If the KEY is empty or missing a record is inserted.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Status
|
ACTSTATUS | string |
Select status (0 for 'Indifferent', 1 for 'To be activated', 2 for 'In progress', 3 for 'Completed', 4 for 'Cancelled', 5 for 'Waiting', 6 for 'Postponed') |
|
Subject
|
COMMENTS | string |
Specify the subject of the mail |
|
Series
|
SERIES | True | string |
Select the Series of the E-mail or enter the Series ID |
Mail date
|
TRNDATE | date-time |
Specify the E-mail Date in YYYY-MM-DD format, or leave it blank for today |
|
From (Send as)
|
FROMADDRESS | string |
Email address to send mail from (requires "Send as" or "Send on behalf of" permission for that mailbox) |
|
Sender
|
FROMNAME | string |
Specify the mailbox's owner and sender's name |
|
BCC
|
SOBCC | string |
Specify email addresses separated by semicolons like [email protected] |
|
Body
|
SOBODY | string |
Specify the body of the mail |
|
CC
|
SOCC | string |
Specify email addresses separated by semicolons like [email protected] |
|
To
|
SOTO | string |
Specify email addresses separated by semicolons like [email protected] |
|
line No
|
LINENUM | string |
Specify the line No. of the attached item |
|
name
|
NAME | string |
Specify the file name of the attached item |
|
url
|
SOFNAME | string |
Specify the url address of the attached item |
|
FORM
|
FORM | string |
Specify the form of the email |
|
KEY
|
KEY | string |
Enter a valid email record ID to modify it |
Returns
- Body
- setData200response
Insert or Modify Expenses
Insert or Modify the data of an Expense Object identified by a KEY (Expense ID) . If the KEY is empty or missing a record is inserted.he data of a record in an Expense Object identified by a KEY. If the KEY is empty or missing a record is inserted.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify expense's form |
|
KEY
|
KEY | string |
Enter a valid expense record ID to modify it |
|
Code
|
CODE | True | string |
Insert an expense code |
Invoicing category
|
LISOURCETYPE | True | string |
Select invoicing category (12 for 'Suppliers', 13 for 'Customers', 14 for 'Cash accounts',15 for 'Debtors',16 for 'Creditors') |
Commercial category
|
MTRCATEGORY | string |
Specify the expense's commercial category |
|
Type
|
MTRTYPE | string |
Select expense's type (0 for 'Normal', 1 for 'Expense', 2 for 'VAT only') |
|
Name
|
NAME | True | string |
Specify the expense's name |
Comments
|
REMARKS | string |
Insert comments |
|
Fee value
|
SOPAYVALUE | string |
Select fee value (1 for 'Gross Salary', 2 for 'Deductions', 3 for 'Tax',4 for 'Stamp',5 for 'OGA Stamp') |
|
Vat Group
|
VAT | True | string |
Select the expense's Value Added Tax group or enter the Vat ID |
Returns
- Body
- setData200response
Insert or Modify Expenses Document
Insert or Modify the data of an Expenses document object identified by a KEY (Document ID) . If the KEY is empty or missing a record is inserted.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Line No
|
LINENUM | string |
Specify the item's line number or leave it blank for default |
|
Line value
|
LINEVAL | string |
Specify the expense's line value |
|
Expense
|
MTRL | string |
Select an expense or enter the expense ID |
|
VAT
|
VAT | string |
Select VAT or enter the VAT ID |
|
Project
|
PRJC | string |
Select the project or enter the project ID |
|
Comments
|
REMARKS | string |
Insert comments |
|
Series
|
SERIES | True | string |
Select the Series of the document or enter the Series ID |
Supplier
|
TRDR | True | string |
Select the Customer or enter the Customer ID |
Transaction date
|
TRNDATE | string |
Specify the transaction date in YYYY-MM-DD format, or leave it blank for today |
|
FORM
|
FORM | string |
Specify document's form |
|
KEY
|
KEY | string |
Enter a valid document record ID to modify it |
Returns
- Body
- setData200response
Insert or Modify Item
Insert or Modify the data of an Item Object identified by a KEY (Item ID) . If the KEY is empty or missing a record is inserted.he data of a record in an Item Object identified by a KEY. If the KEY is empty or missing a record is inserted.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify item's form |
|
KEY
|
KEY | string |
Enter a valid item record ID to modify it |
|
Code
|
CODE | True | string |
Insert an item code |
Commercial category
|
MTRCATEGORY | string |
Specify the item's commercial category |
|
Item group
|
MTRGROUP | string |
Select the item's group or enter the item's group ID |
|
Base unit of measure
|
MTRUNIT1 | True | string |
Select the item's U.o.M or enter the U.o.M ID |
Name
|
NAME | True | string |
Specify the item's name |
Retail price
|
PRICER | string |
Specify the item's retail price |
|
Wholesale price
|
PRICEW | string |
Specify the item's wholesale price |
|
Comments
|
REMARKS | string |
Insert comments |
|
Discount
|
SODISCOUNT | string |
Specify the item's discount |
|
Vat Group
|
VAT | True | string |
Select the item's Value Added Tax group or enter the Vat ID |
Returns
- Body
- setData200response
Insert or Modify Meeting
Insert or Modify the data of a Meeting Object identified by a KEY (Meeting ID) . If the KEY is empty or missing a record is inserted.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Operator
|
ACTOR | string |
Select the operator or enter the operator ID |
|
Operator contact
|
ACTPRSN | string |
Select the contact of the operator or enter the contact ID |
|
Status
|
ACTSTATUS | string |
Select status (0 for 'Indifferent', 1 for 'To be activated', 2 for 'In progress', 3 for 'Completed', 4 for 'Cancelled', 5 for 'Waiting', 6 for 'Postponed') |
|
Subject
|
COMMENTS | string |
Specify the subject of the meeting |
|
Due date
|
FINALDATE | date-time |
Specify the date the meeting was created in YYYY-MM-DD format, or leave it blank for today |
|
Start date
|
FROMDATE | date-time |
Specify the date the meeting was created in YYYY-MM-DD format, or leave it blank for today |
|
Ordered By
|
ORDEREDBY | string |
Select the orderer or enter the orderer ID |
|
Ordered By Contact
|
ORDPRSN | string |
Select the contact of the orderer or enter the contact ID |
|
Priority
|
PRIORITY | string |
Select priority or enter a valid priority ID |
|
Project
|
PRJC | string |
Select the project or enter the project ID |
|
Comments
|
REMARKS | string |
Insert comments |
|
Series
|
SERIES | True | string |
Select the Series of the Meeting or enter the Series ID |
Customer
|
TRDR | string |
Select the customer or enter the customer ID |
|
Insert date
|
TRNDATE | date-time |
Specify the date the meeting was created in YYYY-MM-DD format, or leave it blank for today |
|
line No
|
LINENUM | string |
Specify the line No. of the attached item |
|
name
|
NAME | string |
Specify the file name of the attached item |
|
url
|
SOFNAME | string |
Specify the url address of the attached item |
|
FORM
|
FORM | string |
Specify the meeting's form |
|
KEY
|
KEY | string |
Enter a valid meeting record ID to modify it |
Returns
- Body
- setData200response
Insert or Modify Payments Document
Insert or Modify the data of a Payments document Object identified by a KEY (Document ID) . If the KEY is empty or missing a record is inserted.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Credit card No.
|
CRDCARDNUM | string |
Specify the credit card's number |
|
Credit card
|
CREDITCARDS | integer |
Select a credit card or enter a credit card ID |
|
Credit card line No.
|
LINENUM | integer |
Specify the credit card's line number or leave it blank for default |
|
Card line value
|
LINEVAL | integer |
Specify the credit card's line value |
|
Cash line No.
|
LINENUM | integer |
Specify the cash line number or leave it blank for default |
|
Cash line value
|
LINEVAL | integer |
Specify the cash line value |
|
Project
|
PRJC | string |
Select the project or enter the project ID |
|
Comments
|
REMARKS | string |
Insert comments |
|
Series
|
SERIES | True | string |
Select the series of the document or enter a series ID |
Supplier
|
TRDR | True | string |
Select the customer or enter the customer ID |
Transaction date
|
TRNDATE | string |
Specify transaction date in YYYY-MM-DD format or leave it blank for today |
|
Cheque No.
|
CCHEQUENUMBER | string |
Insert cheque No. |
|
Cheque due date
|
CFINALDATE | date-time |
Specify cheque's due date with format: YYYY-MM-DD or leave it blank for today's date |
|
Cheque
|
CODE | string |
Insert cheque code |
|
Cheque series
|
CSERIES | integer |
Select cheque series or enter cheque series ID |
|
Cheque line number
|
LINENUM | integer |
Specify the cheque line number or leave it blank for default |
|
Cheque line value
|
LINEVAL | integer |
Specify cheque line value |
|
Cheque transaction type
|
TPRMS | integer |
Select transaction type or enter transaction type ID |
|
FORM
|
FORM | string |
Specify document's form |
|
KEY
|
KEY | string |
Enter a valid document record ID to modify it |
Returns
- Body
- setData200response
Insert or Modify Project
Insert or Modify the data of a Project Object identified by a KEY (Project ID) . If the KEY is empty or missing a record is inserted.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify contact's form |
|
KEY
|
KEY | string |
Enter a valid contact ID to modify it |
|
Status
|
ACTSTATUS | string |
Select status (0 for 'Indifferent', 1 for 'To be activated', 2 for 'In progress', 3 for 'Completed', 4 for 'Cancelled', 5 for 'Waiting', 6 for 'Postponed') |
|
Code
|
CODE | True | string |
Insert a contact code |
Due date
|
FINALDATE | date-time |
Specify the due date of the task in YYYY-MM-DD format, or leave it blank for today |
|
Start date
|
FROMDATE | date-time |
Specify the date the task was created in YYYY-MM-DD format, or leave it blank for today |
|
Name
|
NAME | True | string |
Specify the name of the project |
Variation
|
PRJCRM | string |
Select variation (0 for 'Project', 1 for 'Campaign', 2 for 'Opportunity') |
|
Comments
|
REMARKS | string |
Insert comments |
|
line No
|
LINENUM | string |
Specify the line No. of the attached item |
|
name
|
NAME | string |
Specify the file name of the attached item |
|
url
|
SOFNAME | string |
Specify the url address of the attached item |
Returns
- Body
- setData200response
Insert or Modify Purchases Document
Insert or Modify the data of a Purchase document Object identified by a KEY (Document ID) . If the KEY is empty or missing a record is inserted.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Discount
|
DISC1PRC | integer |
Specify the item's discount |
|
Line No
|
LINENUM | string |
Specify the item's line number or leave it blank for default |
|
Line value
|
LINEVAL | string |
Specify the item's line value |
|
Item
|
MTRL | string |
Select an item or enter the item id |
|
Price
|
PRICE | string |
Specify the item's price |
|
Quantity
|
QTY | integer |
Specify the item's quantity |
|
Warehouse
|
WHOUSE | True | string |
Select the warehouse or insert the warehouse ID |
Discount
|
DISC1PRC | string |
Specify the document's discount |
|
Payment
|
PAYMENT | string |
Select the payment method or enter the payment ID |
|
Project
|
PRJC | string |
Select the project or enter the project ID |
|
Comments
|
REMARKS | string |
Insert comments |
|
Series
|
SERIES | True | string |
Select the series of the document or enter the series ID |
Currency
|
SOCURRENCY | True | string |
Select the payment currency or enter the currency ID |
Total
|
SUMAMNT | string |
Specify the document's total value |
|
Supplier
|
TRDR | True | string |
Select the supplier or enter the supplier ID |
Transaction date
|
TRNDATE | string |
Specify the transaction date in YYYY-MM-DD format, or leave it blank for today |
|
Discount
|
DISC1PRC | integer |
Specify the service's discount |
|
Line No.
|
LINENUM | string |
Specify the service's line number or leave it blank for default |
|
Line value
|
LINEVAL | string |
Specify the service's line value |
|
Service
|
MTRL | string |
Select a service or enter the service id |
|
Price
|
PRICE | string |
Specify the service's price |
|
Quantity
|
QTY | integer |
Specify the service's quantity |
|
FORM
|
FORM | string |
Specify document's form |
|
KEY
|
KEY | string |
Enter a valid document record ID to modify it |
Returns
- Body
- setData200response
Insert or Modify Sales Document
Insert or Modify the data of a Sales Document record, identified by a KEY. If the KEY is empty or missing, a new record will be created
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify document's form |
|
KEY
|
KEY | string |
Enter a valid document record ID to modify it |
|
Discount
|
DISC1PRC | string |
Specify the item's discount |
|
Line No.
|
LINENUM | string |
Specify the item's line number or leave it blank for default. |
|
Line value
|
LINEVAL | string |
Specify the item's line value |
|
Item
|
MTRL | string |
Select an item or enter the item ID |
|
Price
|
PRICE | string |
Specify the item's price |
|
Quantity
|
QTY | string |
Specify the item's quantity |
|
Warehouse
|
WHOUSE | True | string |
Select the warehouse or enter the warehouse ID |
Discount
|
DISC1PRC | string |
Specify the document's Discount |
|
Discount value
|
DISC1VAL | string |
Specify the document's Discount value |
|
Net amount
|
NETAMNT | string |
Specify the document's Net amount |
|
Payment
|
PAYMENT | True | string |
Select the payment method or enter the payment ID |
Project
|
PRJC | string |
Select the project or enter the project ID |
|
Comments
|
REMARKS | string |
Insert comments |
|
Series
|
SERIES | True | string |
Select the Series of the document or enter the Series ID |
Currency
|
SOCURRENCY | True | string |
Select the payment currency or enter the currency ID |
Total
|
SUMAMNT | string |
Specify the document's Total value |
|
Customer
|
TRDR | True | string |
Select the Customer or enter the Customer ID |
Transaction date
|
TRNDATE | string |
Specify the transaction date in YYYY-MM-DD format, or leave it blank for today |
|
VAT
|
VATAMNT | string |
Specify the document's Total VAT |
|
Discount
|
DISC1PRC | integer |
Specify the service's discount |
|
Line No.
|
LINENUM | string |
Specify the service's line number or leave it blank for default |
|
Line value
|
LINEVAL | string |
Specify the service's line value |
|
Service
|
MTRL | string |
Select a service or enter the service ID |
|
Price
|
PRICE | string |
Specify service's price |
|
Quantity
|
QTY | integer |
Specify the service's quantity |
Returns
- Body
- setData200response
Insert or Modify Service
Insert or Modify the data of a Service Object identified by a KEY (Service ID) . If the KEY is empty or missing a record is inserted.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify service's form |
|
KEY
|
KEY | string |
Enter a valid service record ID to modify it |
|
Code
|
CODE | True | string |
Insert a service code |
Commercial category
|
MTRCATEGORY | string |
Specify the service's commercial category |
|
Service group
|
MTRGROUP | string |
Select the service's group or enter the service's group ID |
|
Base unit of measure
|
MTRUNIT1 | True | string |
Select the service's U.o.M or enter the U.o.M ID |
Name
|
NAME | True | string |
Specify the service's name |
Retail price
|
PRICER | string |
Specify the service's retail price |
|
Wholesale price
|
PRICEW | string |
Specify the service's wholesale price |
|
Comments
|
REMARKS | string |
Insert comments |
|
Discount
|
SODISCOUNT | string |
Specify the service's discount |
|
Vat Group
|
VAT | True | string |
Select the service's Value Added Tax group or enter the Vat ID |
Returns
- Body
- setData200response
Insert or Modify Stock Document
Insert or Modify the data of a Stock Document record, identified by a KEY. If the KEY is empty or missing, a new record will be created
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
FORM
|
FORM | string |
Specify document's form |
|
KEY
|
KEY | string |
Enter a valid document record ID to modify it |
|
Reason
|
COMMENTS | string |
Specify document's reason |
|
Comments
|
REMARKS | string |
Insert comments |
|
Series
|
SERIES | True | string |
Select the Series of the document or enter the Series ID |
Transaction date
|
TRNDATE | string |
Specify the transaction date in YYYY-MM-DD format, or leave it blank for today |
|
Discount
|
DISC1PRC | string |
Specify the item's discount |
|
Line No.
|
LINENUM | string |
Specify the item's line number or leave it blank for default. |
|
Line value
|
LINEVAL | string |
Specify the item's line value |
|
Item
|
MTRL | string |
Select an item or enter the item ID |
|
Price
|
PRICE | string |
Specify the item's price |
|
Quantity
|
QTY | string |
Specify the item's quantity |
|
Warehouse
|
WHOUSE | True | string |
Select the warehouse or enter the warehouse ID |
Returns
- Body
- setData200response
Insert or Modify Supplier
Insert or Modify the data of a Supplier Object identified by a KEY (Supplier ID) . If the KEY is empty or missing a record is inserted.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Bank
|
BANK | string |
Select a bank |
|
IBAN
|
IBAN | string |
Insert International Bank Account number |
|
Bank account comments
|
REMARKS | string |
Insert comments for this bank account |
|
Address
|
ADDRESS | string |
Specify the primary address of the supplier |
|
T.R.No
|
AFM | string |
Specify the tax registration number of the supplier |
|
City
|
CITY | string |
Specify the city of the supplier |
|
Code
|
CODE | True | string |
Insert a supplier code |
Location area
|
DISTRICT | string |
Specify the location area of the supplier |
|
Email
|
string |
Specify the email address of the supplier |
||
FAX
|
FAX | string |
Specify the fax number of the supplier |
|
Tax office
|
IRSDATA | string |
Select the tax office of the supplier |
|
Profession
|
JOBTYPETRD | string |
Specify the profession of the supplier |
|
Name
|
NAME | True | string |
Specify the name of the supplier |
Primary telephone
|
PHONE01 | string |
Specify the primary telephone number of the supplier |
|
Comments
|
REMARKS | string |
Insert comments |
|
ZIP
|
ZIP | string |
Specify the zip code of the supplier |
|
FORM
|
FORM | string |
Specify supplier's form |
|
KEY
|
KEY | string |
Enter a valid supplier ID to modify it |
Returns
- Body
- setData200response
Insert or Modify Task
Insert or Modify the data of a Task Object identified by a KEY (Task ID) . If the KEY is empty or missing a record is inserted.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Operator
|
ACTOR | string |
Select the operator or enter the operator ID |
|
Operator contact
|
ACTPRSN | string |
Select the contact of the operator or enter the contact ID |
|
Status
|
ACTSTATUS | string |
Select status (0 for 'Indifferent', 1 for 'To be activated', 2 for 'In progress', 3 for 'Completed', 4 for 'Cancelled', 5 for 'Waiting', 6 for 'Postponed') |
|
Subject
|
COMMENTS | string |
Specify the subject of the task |
|
Due date
|
FINALDATE | date-time |
Specify the due date of the task in YYYY-MM-DD format, or leave it blank for today |
|
Start date
|
FROMDATE | date-time |
Specify the date the task was created in YYYY-MM-DD format, or leave it blank for today |
|
Ordered By
|
ORDEREDBY | string |
Select the orderer or enter the orderer ID |
|
Ordered By Contact
|
ORDPRSN | string |
Select the contact of the orderer or enter the contact ID |
|
Priority
|
PRIORITY | string |
Select priority or enter a valid priority ID |
|
Project
|
PRJC | string |
Select the project or enter the project ID |
|
Comments
|
REMARKS | string |
Insert comments |
|
Series
|
SERIES | True | string |
Select the Series of the Task or enter the Series ID |
Customer
|
TRDR | string |
Select the customer or enter the customer ID |
|
Insert date
|
TRNDATE | date-time |
Specify the date the task was created in YYYY-MM-DD format, or leave it blank for today |
|
line No
|
LINENUM | string |
Specify the line No. of the attached item |
|
name
|
NAME | string |
Specify the file name of the attached item |
|
url
|
SOFNAME | string |
Specify the url address of the attached item |
|
FORM
|
FORM | string |
Specify the task's form |
|
KEY
|
KEY | string |
Enter a valid task record ID to modify it |
Returns
- Body
- setData200response
Insert Remote Key
Insert third-party application ID to a Soft1 Object
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
KEY
|
KEY | True | string |
Enter a valid Soft1 Object ID |
Remote Key
|
REFID | True | string |
Enter a valid third-party application ID |
Soft1 Object
|
SOSOURCE | True | string |
Select Soft1 Object |
Returns
- Body
- setData200response
Microservice
Makes a call to a Soft1 microservice. Insert request's body and web service's endpoint.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Body
|
body | True | string |
Insert request body |
Endpoint
|
endpoint | True | string |
Specify web service's url endpoint |
Returns
Triggers
When a record is created |
This operation triggers when there are newly created records of the selected object |
When a record is created or modified |
This operation triggers when there are newly created or modified records of the selected object |
When a record is deleted |
This operation triggers when a record of the selected object is deleted |
When a record is modified |
This operation triggers when there are modified records of the selected object |
When a record is created
This operation triggers when there are newly created records of the selected object
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Condition
|
condition | string |
Specify a condition |
|
Object
|
object | True | string |
Select an object that triggers this operation |
Returns
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
ID of the record that was created. Use with the corresponding 'Get' action to fetch the content of the record |
When a record is created or modified
This operation triggers when there are newly created or modified records of the selected object
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Condition
|
condition | string |
Specify a condition |
|
Object
|
object | True | string |
Select an object that triggers this operation |
Returns
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
ID of the record that was created or modified. Use with the corresponding 'Get' action to fetch the content of the record |
When a record is deleted
This operation triggers when a record of the selected object is deleted
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Condition
|
condition | string |
Specify a condition |
|
Object
|
object | True | string |
Select an object that triggers this operation |
Returns
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
ID of the record that was deleted |
When a record is modified
This operation triggers when there are modified records of the selected object
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Condition
|
condition | string |
Specify a condition |
|
Object
|
object | True | string |
Select an object that triggers this operation |
Returns
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
ID of the record that was modified. Use with the corresponding 'Get' action to fetch the content of the record |
Definitions
setData200response
Name | Path | Type | Description |
---|---|---|---|
Error
|
error | string |
Error message if action is unsuccessful |
Error code
|
errorcode | integer |
Error code if action is unsuccessful |
ID
|
id | string |
ID of the document record that was created or modified |
Success
|
success | boolean |
Is action successful? |