Connectors Reference
The Soft1 Connector provides an API to work with Soft1 ERP objects
|
Status: Preview |
Tier: Standard |
Version: 3.1.0 |
|
Name |
Summary |
|
When a record is created or modified |
|
|
WebhookOnInsert ([internal]string op, WebhookOnInsertParameterBody body) |
When a record is created |
|
WebhookOnUpdate ([internal]string op, WebhookOnUpdateParameterBody body) |
When a record is modified |
|
WebhookOnDelete ([internal]string op, WebhookOnDeleteParameterBody body) |
When a record is deleted |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: DeleteTrigger
Description: DeleteTrigger
Syntax:
Soft1.DeleteTrigger ([internal]string op)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
Returns:
Summary: DeleteTriggerOnInsert
Description: DeleteTriggerOnInsert
Syntax:
Soft1.DeleteTriggerOnInsert ([internal]string op)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
Returns:
Summary: DeleteTriggerOnUpdate
Description: DeleteTriggerOnUpdate
Syntax:
Soft1.DeleteTriggerOnUpdate ([internal]string op)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
Returns:
Summary: DeleteTriggerOnDelete
Description: DeleteTriggerOnDelete
Syntax:
Soft1.DeleteTriggerOnDelete ([internal]string op)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
Returns:
Summary: Get Customer
Description: Returns all data (or the selected ones from LOCATEINFO) of a record of a Customer Object.
Syntax:
Soft1.GetCustomer ([internal]string op, GetCustomerParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:GetCustomerResponse
Summary: Get Sales Document
Description: Returns all data (or the selected ones from LOCATEINFO) of a record of a Sales Object.
Syntax:
Soft1.GetSaldoc ([internal]string op, GetSaldocParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:GetSaldocResponse
Summary: Get Item
Description: Returns all data (or the selected ones from LOCATEINFO) of a record of an Item Object.
Syntax:
Soft1.GetItem ([internal]string op, GetItemParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:GetItemResponse
Summary: Insert or Modify Customer
Description: 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.
Syntax:
Soft1.SetCustomer ([internal]string op, SetCustomerParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:setData200response
Summary: Insert or Modify Item
Description: 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.
Syntax:
Soft1.SetItem ([internal]string op, SetItemParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:setData200response
Summary: Insert or Modify Service
Description: 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.
Syntax:
Soft1.SetService ([internal]string op, SetServiceParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:setData200response
Summary: Get Services
Description: Returns all data (or the selected ones from LOCATEINFO) of a record of an Service Object.
Syntax:
Soft1.GetService ([internal]string op, GetServiceParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:GetServiceResponse
Summary: Insert or Modify Expenses
Description: 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.
Syntax:
Soft1.SetExpense ([internal]string op, SetExpenseParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:setData200response
Summary: Get Expenses
Description: Returns all data (or the selected ones from LOCATEINFO) of a record of an Expense Object.
Syntax:
Soft1.GetExpense ([internal]string op, GetExpenseParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:GetExpenseResponse
Summary: Insert or Modify Cheque
Description: 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.
Syntax:
Soft1.SetCheque ([internal]string op, SetChequeParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:setData200response
Summary: Get Cheque
Description: Returns all data (or the selected ones from LOCATEINFO) of a record of an Cheque Object
Syntax:
Soft1.GetCheque ([internal]string op, GetChequeParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:GetChequeResponse
Summary: Insert or Modify Sales Document
Description: 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
Syntax:
Soft1.SetSaldoc ([internal]string op, SetSaldocParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:setData200response
Summary: Insert or Modify Stock Document
Description: 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
Syntax:
Soft1.SetItedoc ([internal]string op, SetItedocParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:setData200response
Summary: Get Stock Document
Description: Returns all data (or the selected ones from LOCATEINFO) of a record of a Stock Document Object.
Syntax:
Soft1.GetItedoc ([internal]string op, GetItedocParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:GetItedocResponse
Summary: getSelectorData
Description: getSelectorData
Syntax:
Soft1.GetSelectorData ([internal]string op, integer type, string object, string key, string vfields)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
type |
integer
|
|
True |
|
|
object |
string
|
|
True |
|
|
key |
string
|
|
True |
|
|
vfields |
string
|
|
True |
Returns:
Type:array of (GetSelectorDataResponseItem)
Summary: Insert or Modify Purchases Document
Description: 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.
Syntax:
Soft1.SetPurdoc ([internal]string op, SetPurdocParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:setData200response
Summary: Get Purchases Document
Description: Returns all data (or the selected ones from LOCATEINFO) of a record of a Purchase Object.
Syntax:
Soft1.GetPurdoc ([internal]string op, GetPurdocParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:GetPurdocResponse
Summary: Insert or Modify Supplier
Description: 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.
Syntax:
Soft1.SetSupplier ([internal]string op, SetSupplierParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:setData200response
Summary: Get Supplier
Description: Returns all data (or the selected ones from LOCATEINFO) of a record of a Supplier Object.
Syntax:
Soft1.GetSupplier ([internal]string op, GetSupplierParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:GetSupplierResponse
Summary: Insert or Modify Collections Document
Description: 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.
Syntax:
Soft1.SetCFNCUSDOC ([internal]string op, SetCFNCUSDOCParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:setData200response
Summary: Get Collections Document
Description: Returns all data (or the selected ones from LOCATEINFO) of a record of a Collections Object.
Syntax:
Soft1.GetCFNCUSDOC ([internal]string op, GetCFNCUSDOCParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:GetCFNCUSDOCResponse
Summary: Insert or Modify Payments Document
Description: 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.
Syntax:
Soft1.SetCfnsupdoc ([internal]string op, SetCfnsupdocParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:setData200response
Summary: Get Payments Document
Description: Returns all data (or the selected ones from LOCATEINFO) of a record of a Payment Object.
Syntax:
Soft1.GetCfnsupdoc ([internal]string op, GetCfnsupdocParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:GetCfnsupdocResponse
Summary: Insert or Modify Task
Description: 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.
Syntax:
Soft1.SetSOTASK ([internal]string op, SetSOTASKParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:setData200response
Summary: Get Task
Description: Returns all data (or the selected ones from LOCATEINFO) of a record of a Task Object.
Syntax:
Soft1.GetSOTASK ([internal]string op, GetSOTASKParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:GetSOTASKResponse
Summary: Insert or Modify Meeting
Description: 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.
Syntax:
Soft1.SetMeeting ([internal]string op, SetMeetingParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:setData200response
Summary: Get Meeting
Description: Returns all data (or the selected ones from LOCATEINFO) of a record of a Meeting Object.
Syntax:
Soft1.GetMeeting ([internal]string op, GetMeetingParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:GetMeetingResponse
Summary: Insert or Modify Email
Description: 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.
Syntax:
Soft1.SetSOEMAIL ([internal]string op, SetSOEMAILParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:setData200response
Summary: Get Email
Description: Returns all data (or the selected ones from LOCATEINFO) of a record of a Email Object
Syntax:
Soft1.GetSOEMAIL ([internal]string op, GetSOEMAILParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:GetSOEMAILResponse
Summary: Microservice
Description: Makes a call to a Soft1 microservice. Insert request's body and web service's endpoint.
Syntax:
Soft1.Microservice ([internal]string op, MicroserviceParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Summary: Insert or Modify Expenses Document
Description: 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.
Syntax:
Soft1.SetExpensesDoc ([internal]string op, SetExpensesDocParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:setData200response
Summary: Get Expenses Document
Description: Returns all data (or the selected ones from LOCATEINFO) of a record of an Expenses Object.
Syntax:
Soft1.GetExpensesDoc ([internal]string op, [Optional]GetExpensesDocParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
False |
Returns:
Summary: Insert or Modify Draft entry
Description: 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.
Syntax:
Soft1.SetDraftEntry ([internal]string op, SetDraftEntryParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:setData200response
Summary: Get Draft entry
Description: Returns all data (or the selected ones from LOCATEINFO) of a record of a Draft entry object
Syntax:
Soft1.GetDraftEntry ([internal]string op, GetDraftEntryParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Summary: Insert or Modify Contact
Description: 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.
Syntax:
Soft1.SetContact ([internal]string op, SetContactParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:setData200response
Summary: Get Contact
Description: Returns all data (or the selected ones from LOCATEINFO) of a record of a contact object
Syntax:
Soft1.GetContact ([internal]string op, GetContactParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:GetContactResponse
Summary: Get System parameters
Description: Returns parameters of the installation
Syntax:
Soft1.GetSystemParams ([internal]string op, [Optional]GetSystemParamsParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
False |
Returns:
Summary: Insert or Modify Project
Description: 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.
Syntax:
Soft1.SetProject ([internal]string op, SetProjectParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:setData200response
Summary: Get Project
Description: Returns all data (or the selected ones from LOCATEINFO) of a record of a project object
Syntax:
Soft1.GetProject ([internal]string op, GetProjectParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:GetProjectResponse
Summary: When a record is created or modified
Description: This operation triggers when there are newly created or modified records of the selected object
Syntax:
Soft1.Webhook ([internal]string op, WebhookParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Summary: When a record is created
Description: This operation triggers when there are newly created records of the selected object
Syntax:
Soft1.WebhookOnInsert ([internal]string op, WebhookOnInsertParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Summary: When a record is modified
Description: This operation triggers when there are modified records of the selected object
Syntax:
Soft1.WebhookOnUpdate ([internal]string op, WebhookOnUpdateParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Summary: When a record is deleted
Description: This operation triggers when there are deleted records of the selected object
Syntax:
Soft1.WebhookOnDelete ([internal]string op, WebhookOnDeleteParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
op |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
service |
string
|
service |
|
MODE |
string
|
|
|
appId |
string
|
appId |
|
OBJECT |
string
|
OBJECT |
|
KEY |
string
|
Insert a valid document record ID |
|
FORM |
string
|
Specify document's form |
|
LOCATEINFO |
string
|
Specify document's desired data fields |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
success |
boolean Success |
Is action successful? |
|
errorcode |
integer Error code |
Error code if action is unsuccessful |
|
error |
string Error |
Error message if action is unsuccessful |
|
data |
|
The data object of the response |
|
caption |
string
|
Descriptive caption of the document record |
Summary:
Description: The data object of the response
Properties:
|
Name |
Type |
Summary |
|
CFNCUSDOC |
Collections document |
Collections document data object |
|
CASHLINES |
array of (CASHLINESItem)
|
Cashes data array |
|
CARDLINES |
array of (CARDLINESItem)
|
Credit cards data array |
|
CHEQUELINES |
array of (CHEQUELINESItem)
|
Cheques data array |
Summary: Collections document
Description: Collections document data object
Properties:
|
Name |
Type |
Summary |
|
COLLECTOR |
string
|
The document's collector ID |
|
COLLECTOR_PRSNIN_NAME2 |
string
|
The document's collector surname |
|
REMARKS |
string
|
Comments about the document |
|
COMPANY |
string
|
The document's company name and ID |
|
PRJC |
string
|
The document's project ID |
|
PRJC_PRJC_NAME |
string(date-time)
|
The document's project name |
|
FINCODE |
string
|
The document's code |
|
SALESMAN |
string
|
The document's salesman ID |
|
SALESMAN_PRSNIN_NAME2 |
string
|
The document's salesman surname |
|
SERIES |
string
|
The document's series |
|
SUMAMNT |
string
|
The document's total value |
|
TRDR |
string
|
The document's customer ID |
|
TRDR_TRDR_CODE |
string
|
The document's customer code |
|
TRDR_TRDR_NAME |
string
|
The document's customer name |
|
TRNDATE |
string(date-time)
|
The document's transaction date |
Summary:
Description: Cash data object
Properties:
|
Name |
Type |
Summary |
|
LINENUM |
string
|
The cash's line number |
|
LINEVAL |
string
|
The cash's line value |
|
SOCURRENCY |
string
|
The cash's currency |
Summary:
Description: Credit card data object
Properties:
|
Name |
Type |
Summary |
|
CRDCARDNUM |
string
|
The credit card's number |
|
CREDITCARDS |
string
|
The credit card's name and ID |
|
LINENUM |
string
|
The credit card's line number |
|
LINEVAL |
string
|
The credit card's line value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
CFINALDATE |
string
|
CFINALDATE |
|
CODE |
string
|
CODE |
|
CSERIES |
string
|
CSERIES |
|
LINENUM |
string
|
LINENUM |
|
LINEVAL |
string
|
LINEVAL |
|
TPRMS |
string
|
TPRMS |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
service |
string
|
service |
|
MODE |
string
|
|
|
appId |
string
|
appId |
|
OBJECT |
string
|
OBJECT |
|
KEY |
string
|
Insert a valid document record ID |
|
FORM |
string
|
Specify document's form |
|
LOCATEINFO |
string
|
Specify document's desired data fields |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
success |
boolean Success |
Is action successful? |
|
errorcode |
integer Error code |
Error code if action is unsuccessful |
|
error |
string Error |
Error message if action is unsuccessful |
|
data |
|
The data object of the response |
|
caption |
string
|
Descriptive caption of the document record |
Summary:
Description: The data object of the response
Properties:
|
Name |
Type |
Summary |
|
CFNSUPDOC |
Payments document |
Payments document data object |
|
CASHLINES |
array of (CASHLINESItem)
|
Cashes data array |
|
CARDLINES |
array of (CARDLINESItem)
|
Credit cards data array |
|
CHEQUELINES |
array of (CHEQUELINESItem)
|
Cheques data array |
Summary: Payments document
Description: Payments document data object
Properties:
|
Name |
Type |
Summary |
|
FINCODE |
string
|
The document's code |
|
COMMENTS |
string reason |
The document's reason |
|
COMPANY |
string
|
The document's company name and ID |
|
PRJC |
string
|
The document's project ID |
|
PRJC_PRJC_NAME |
string(date-time)
|
The document's project name |
|
SERIES |
string
|
The document's series |
|
SUMAMNT |
string
|
The document's total value |
|
TRDR |
string
|
The document's supplier ID |
|
TRDR_TRDR_AFM |
string
|
The document's supplier Tax Registration Number (T.R.No) |
|
TRDR_TRDR_CODE |
string
|
The document's supplier code |
|
TRDR_TRDR_NAME |
string
|
The document's supplier name |
|
TRDR_TRDR_ADDRESS |
string
|
The document's supplier address |
|
TRDR_TRDR_IRSDATA |
string
|
The document's supplier tax office |
|
TRNDATE |
string(date-time)
|
The document's transaction date |
Summary:
Description: Cash data object
Properties:
|
Name |
Type |
Summary |
|
LINENUM |
string
|
The cash's line number |
|
LINEVAL |
string
|
The cash's line value |
|
SOCURRENCY |
string
|
The cash's currency |
Summary:
Description: Credit card data object
Properties:
|
Name |
Type |
Summary |
|
CRDCARDNUM |
string
|
The credit card's number |
|
CREDITCARDS |
string
|
The credit card's name and ID |
|
LINENUM |
string
|
The credit card's line number |
|
LINEVAL |
string
|
The credit card's line value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
CFINALDATE |
string
|
CFINALDATE |
|
CODE |
string
|
CODE |
|
CSERIES |
string
|
CSERIES |
|
LINENUM |
string
|
LINENUM |
|
LINEVAL |
string
|
LINEVAL |
|
TPRMS |
string
|
TPRMS |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
service |
string
|
|
|
MODE |
string
|
|
|
appId |
string
|
|
|
OBJECT |
string
|
|
|
FORM |
string
|
Specify cheque's form |
|
KEY |
string
|
Insert a valid cheque record ID |
|
LOCATEINFO |
string
|
Specify cheque's desired fields |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
success |
boolean Success |
Is action successful? |
|
errorcode |
integer Error code |
Error code if action is unsuccessful |
|
error |
string Error |
Error message if action is unsuccessful |
|
data |
|
The data object of the response |
|
caption |
string
|
Descriptive caption of the cheque's record |
Summary:
Description: The data object of the response
Properties:
|
Name |
Type |
Summary |
|
CHEQUE |
Cheque |
Cheque data object |
Summary: Cheque
Description: Cheque data object
Properties:
|
Name |
Type |
Summary |
|
BANK |
string bank |
The cheque's bank |
|
BANK_BANK_NAME |
string bank name |
The cheque's bank name |
|
BANK_BANK_CODE |
string bank code |
The cheque's bank code |
|
CHEQUEBAL |
string balance |
The cheque's balance |
|
CHEQUENUMBER |
string number |
The cheque's number |
|
CHEQUESTATES |
string state |
The cheque's state |
|
CHEQUEVAL |
string value |
The cheque's value |
|
COMPANY |
string company |
The cheque's company |
|
CREATORADDR |
string issuer address |
The cheque's issuer address |
|
CREATORNAME |
string issuer name |
The cheque's issuer name |
|
CREATORPHONE |
string
|
The cheque's issuer telephone |
|
PUBLISHERAFM |
string issuer T.R.No |
The cheque's issuer Tax Registration Number |
|
CRTDATE |
string receipt date |
The cheque's receipt date |
|
DATEOFS |
string issue date |
The cheque's issue date |
|
FINALDATE |
string due date |
The cheque's due date |
|
HOLDERADDR |
string holder address |
The cheque's holder address |
|
HOLDERNAME |
string holder name |
The cheque's holder name |
|
SERIES |
string series |
The cheque's series |
|
SOCURRENCY |
string currency |
The cheque's currency |
|
TRDRPOSSESSOR_TRDR_CODE |
string holder code |
The cheque's holder code |
|
TRDRPUBLISHER_TRDR_CODE |
string issuer code |
The cheque's issuer code |
|
REMARKS |
string comments |
The cheque's comments |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
APPID |
integer(int32)
|
APPID |
|
SERVICE |
string
|
SERVICE |
|
MODE |
string
|
|
|
OBJECT |
string
|
OBJECT |
|
KEY |
string
|
Insert a valid contact record ID |
|
FORM |
string
|
Specify contact's form |
|
LOCATEINFO |
string
|
Specify document's desired data fields |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
success |
boolean Success |
Is action successful? |
|
errorcode |
integer Error code |
Error code if action is unsuccessful |
|
error |
string Error |
Error message if action is unsuccessful |
|
data |
|
data |
|
caption |
string
|
Brief caption of the contact record |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
PRSNOUT |
Contact |
The contact data object |
|
XTRDOCDATA |
array of (XTRDOCDATAItem)
|
Attached items data array |
Summary: Contact
Description: The contact data object
Properties:
|
Name |
Type |
Summary |
|
ADDRESS |
string address |
The address of the contact |
|
AFM |
string T.R.No |
Tax Registration Number of the contact |
|
AREAS |
string geographical area |
The contact's geographical area ID and name |
|
BIRTHDATE |
string Date of birth |
The date of birth of the contact |
|
BRANCH |
string branch |
The contact's branch name and ID |
|
CITY |
string city |
The contact's city |
|
CODE |
string code |
The code of the contact |
|
COUNTRY |
string country |
The contact's country ID and name |
|
DISTRICT |
string district |
The location area of the contact |
|
|
string first email |
The first email address of the contact |
|
EMAIL1 |
string second email |
The second email address of the contact |
|
FAX |
string fax |
The fax number of the contact |
|
IDENTITYNUM |
string ID card No |
The contact's ID card number |
|
IRSDATA |
string tax office |
The tax office of the contact |
|
ISACTIVE |
string Active |
Is contact active? |
|
MOBILEPHONE |
string mobile telephone |
The contact's mobile telephone |
|
NAME |
string name |
The contact's name |
|
NAME2 |
string surname |
The contact's surname |
|
NATIONALITY |
string nationality |
The contact's nationality ID and name |
|
PHONE1 |
string Tel. 1 |
The first telephone number of the contact |
|
PHONE2 |
string Tel. 2 |
The second telephone number of the contact |
|
PHONEEXT |
string internal telephone |
The contact's internal telephone |
|
PHONELOCAL |
string personal telephone |
The contact's home telephone |
|
REMARKS |
string comments |
The contact's comments |
|
SOSEX |
string gender |
The gender of the contact |
|
WEBPAGE |
string web page |
The contact's web page |
|
ZIP |
string zip |
The contact's zip code |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
LINENUM |
string
|
Line number of the attached item |
|
SOFNAME |
string
|
Url address of the attached item |
|
NAME |
string
|
File name of the attached item |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
service |
string
|
|
|
MODE |
string
|
|
|
appId |
string
|
|
|
OBJECT |
string
|
|
|
FORM |
string
|
Specify customer's form |
|
KEY |
string
|
Insert a valid customer record ID |
|
LOCATEINFO |
string
|
Specify customer's desired data fields |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
success |
boolean Success |
Is action successful? |
|
errorcode |
integer Error code |
Error code if action is unsuccessful |
|
error |
string Error |
Error message if action is unsuccessful |
|
data |
|
The data object of the response |
|
caption |
string
|
A descriptive caption of the record. |
Summary:
Description: The data object of the response
Properties:
|
Name |
Type |
Summary |
|
CUSTOMER |
Customer |
The customer data object |
Summary: Customer
Description: The customer data object
Properties:
|
Name |
Type |
Summary |
|
CODE |
string Code |
Customer's code |
|
NAME |
string name |
The name of the customer |
|
AFM |
string T.R.No |
tax registration number of the customer |
|
ADDRESS |
string Primary Address |
The primary address of the customer |
|
AREAS |
string geographical area |
The Geographical area of the customer |
|
CITY |
string City |
The city of the customer |
|
DISCOUNT |
string Discount (%) |
Percentage (%) discount of the customer |
|
DISTRICT |
string location area |
The location area of the customer |
|
|
string |
The email address of the customer |
|
FAX |
string fax |
The FAX number of the customer |
|
IRSDATA |
string tax Office |
The tax office of the customer |
|
ISACTIVE |
string Active |
Is customer active? |
|
JOBTYPETRD |
string profession |
The profession of the customer |
|
PHONE01 |
string primary telephone |
The primary phone number of the customer |
|
REMARKS |
string comments |
Comments on customer record |
|
VATSTS |
string tax category |
The tax category of the customer |
|
ZIP |
string zip |
The zip code of the customer |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
APPID |
integer(int32)
|
APPID |
|
SERVICE |
string
|
SERVICE |
|
MODE |
string
|
|
|
OBJECT |
string
|
OBJECT |
|
KEY |
string
|
Insert a valid document record ID |
|
FORM |
string
|
Specify document's form |
|
LOCATEINFO |
string
|
Specify document's desired data fields |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
success |
boolean Success |
Is action successful? |
|
errorcode |
integer Error code |
Error code if action is unsuccessful |
|
error |
string Error |
Error message if action is unsuccessful |
|
data |
|
The data object of the response |
|
caption |
string
|
Brief caption of the draft entry record |
Summary:
Description: The data object of the response
Properties:
|
Name |
Type |
Summary |
|
SODRAFT |
|
Draft entry data object |
|
SODRAFTLNK |
|
Draft entry data object |
Summary:
Description: Draft entry data object
Properties:
|
Name |
Type |
Summary |
|
CODE |
string code |
The draft entry's code |
|
NAMEC |
string name/title |
The draft entry's name/title |
|
NAMEF |
string first name |
The draft entry's first name |
|
NAMEL |
string surname |
The draft entry's surname |
|
AFM |
string T.R.No |
The draft entry's Tax Registration Number |
|
IDENTITYNUM |
string ID card No |
The draft entry's ID card number |
|
SOTITLENAME |
string title |
The draft entry's title |
|
JOBTYPETRD |
string activity |
The draft entry's activity |
|
NUMCG |
string Zip |
The draft entry's General Commercial Registry |
|
DRAFTTYPE |
string category |
The draft entry's category |
|
ADDRESS |
string address |
The draft entry's address |
|
CITY |
string city |
The draft entry's city |
|
DISTRICT |
string area |
The draft entry's area |
|
COUNTRY |
string country |
The draft entry's country |
|
DISTRICT1 |
string prefecture |
The draft entry's prefecture |
|
PHONE1 |
string business telephone |
The draft entry's business telephone |
|
PHONEEXT |
string internal telephone |
The draft entry's internal telephone |
|
PHONELOCAL |
string personal telephone |
The draft entry's personal telephone |
|
MOBILEPHONE |
string mobile telephone |
The draft entry's mobile telephone |
|
|
string company email |
The draft entry's company email |
|
EMAIL1 |
string business email |
The draft entry's business email |
|
EMAIL2 |
string personal email |
The draft entry's personal email |
|
WEBPAGE |
string web page |
The draft entry's web page |
|
ZIP |
string zip |
The draft entry's zip code |
|
REMARKS |
string comments |
The draft entry's comments |
Summary:
Description: Draft entry data object
Properties:
|
Name |
Type |
Summary |
|
BRANCH |
string branch |
The draft entry's branch name and ID |
|
DEPART |
string department |
The draft entry's department |
|
BUSUNITS |
string business unit |
The draft entry's business unit name and ID |
|
PRJC |
string project |
The draft entry's project |
|
PRJCLEAD |
string source |
The draft entry's source name and ID |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
service |
string
|
|
|
MODE |
string
|
|
|
appId |
string
|
|
|
OBJECT |
string
|
|
|
FORM |
string
|
Specify expense's form |
|
KEY |
string
|
Insert a valid expense record ID |
|
LOCATEINFO |
string
|
Specify service's desired fields |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
success |
boolean Success |
Is action successful? |
|
errorcode |
integer Error code |
Error code if action is unsuccessful |
|
error |
string Error |
Error message if action is unsuccessful |
|
data |
|
The data object of the response |
|
caption |
string
|
Descriptive caption of the expense's record |
Summary:
Description: The data object of the response
Properties:
|
Name |
Type |
Summary |
|
LINEITEM |
Expense |
Expense data object |
Summary: Expense
Description: Expense data object
Properties:
|
Name |
Type |
Summary |
|
CODE |
string code |
The expense's code |
|
NAME |
string description |
The expense's name |
|
ISACTIVE |
string Active |
Is expense active? |
|
LISOURCETYPE |
string invoicing category |
The expense's invoicing category |
|
MTRCATEGORY |
string commercial category |
The expense's commercial category |
|
MTRTYPE |
string type |
The expense's type |
|
VAT |
string VAT Group |
The expense's Value Added Tax |
|
SOPAYVALUE |
string Fee value |
The expense's fee value |
|
REMARKS |
string comments |
The expense's comments |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
APPID |
string
|
|
|
SERVICE |
string
|
|
|
OBJECT |
string
|
|
|
FORM |
string
|
Specify document's form |
|
KEY |
string
|
Insert a valid document record ID |
|
LOCATEINFO |
string
|
Specify document's desired data fields |
|
MODE |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
success |
boolean Success |
Is action successful? |
|
errorcode |
integer Error code |
Error code if action is unsuccessful |
|
error |
string Error |
Error message if action is unsuccessful |
|
data |
|
The data object of the response |
|
caption |
string
|
Descriptive caption of the document record |
Summary:
Description: The data object of the response
Properties:
|
Name |
Type |
Summary |
|
LINSUPDOC |
Expenses document |
Expenses document data object |
|
LINLINES |
array of (LINLINESItem)
|
Expenses data array |
Summary: Expenses document
Description: Expenses document data object
Properties:
|
Name |
Type |
Summary |
|
COMPANY |
string company |
The document's company ID and Name |
|
FINCODE |
string
|
The document's code |
|
PAYMENT |
string payment |
The document's payment method |
|
SERIES |
string series |
The document's series |
|
SOCURRENCY |
string currency |
The document's payment currency |
|
SUMAMNT |
string Sum amount |
The document's total value |
|
TRDR |
string supplier ID |
The document's supplier ID |
|
TRDR_SUPPLIER_AFM |
string supplier T.R.No |
The document's supplier Tax Registration Number |
|
TRDR_SUPPLIER_NAME |
string supplier name |
The document's supplier name |
|
TRNDATE |
string(date-time) Date |
The document's transaction date |
|
VATAMNT |
string VAT amount |
The document's Value Added Tax amount |
Summary:
Description: Expense data object
Properties:
|
Name |
Type |
Summary |
|
LINENUM |
string line number |
The document's expense line No. |
|
LINEVAL |
string line value |
The document's expense line value |
|
MTRL |
string MTRL |
ID of the document's expense |
|
MTRL_ITEM_CODE |
string code |
Code of the document's expense |
|
MTRL_ITEM_NAME |
string Item name |
The document's expense name |
|
VAT |
string VAT ID |
The document's expense Value Added Tax ID |
|
VATAMNT |
string VAT amount |
The document's expense Value Added Tax value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
service |
string
|
|
|
MODE |
string
|
|
|
appId |
string
|
|
|
OBJECT |
string
|
|
|
FORM |
string
|
Specify document's form |
|
KEY |
string
|
Insert a valid document record ID |
|
LOCATEINFO |
string
|
Specify document's desired data fields |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
success |
boolean Success |
Is action successful? |
|
errorcode |
integer Error code |
Error code if action is unsuccessful |
|
error |
string Error |
Error message if action is unsuccessful |
|
data |
|
The data object of the response |
|
caption |
string
|
Descriptive caption of the document record |
Summary:
Description: The data object of the response
Properties:
|
Name |
Type |
Summary |
|
ITEDOC |
|
Stock document data object |
|
MTRDOC |
|
|
|
ITELINES |
array of (ITELINESItem)
|
Items data array |
Summary:
Description: Stock document data object
Properties:
|
Name |
Type |
Summary |
|
COMPANY |
string company |
The document's company ID and Name |
|
TRNDATE |
string(date-time) Date |
The document's transaction date |
|
SERIES |
string series |
The document's series |
|
FINCODE |
string
|
The document's code |
|
REMARKS |
string comments |
The document's comments |
|
COMMENTS |
string reason |
The document's reason |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
WHOUSE |
string Warehouse |
The document's warehouse name and ID |
|
COMPANY |
string Company |
The document's company ID |
|
DELIVDATE |
string(date-time) Delivery date |
The document's delivery date |
|
SHIPPINGADDR |
string Shipping address |
The document's shipping address |
Summary:
Description: Item data object
Properties:
|
Name |
Type |
Summary |
|
LINENUM |
string line number |
The document's item line No. |
|
LINEVAL |
string line value |
The document's item line value |
|
MTRL |
string MTRL |
ID of the document's item |
|
MTRL_ITEM_CODE |
string code |
Code of the document's item |
|
MTRL_ITEM_NAME |
string Item name |
The document's item name |
|
DISC1PRC |
string
|
The document's item discount |
|
QTY |
string QTY |
The document's item quantity |
|
PRICE |
string Price |
The document's item price |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
service |
string
|
|
|
MODE |
string
|
|
|
appId |
string
|
|
|
OBJECT |
string
|
|
|
FORM |
string
|
Specify item's form |
|
KEY |
string
|
Insert a valid item record ID |
|
LOCATEINFO |
string
|
Specify item's desired fields |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
success |
boolean Success |
Is action successful? |
|
errorcode |
integer Error code |
Error code if action is unsuccessful |
|
error |
string Error |
Error message if action is unsuccessful |
|
data |
|
The data object of the response |
|
caption |
string
|
Descriptive caption of the item's record |
Summary:
Description: The data object of the response
Properties:
|
Name |
Type |
Summary |
|
ITEM |
Item |
Item data object |
Summary: Item
Description: Item data object
Properties:
|
Name |
Type |
Summary |
|
CODE |
string code |
The item's code |
|
NAME |
string description |
The item's name |
|
ISACTIVE |
string Active |
Is item active? |
|
MTRCATEGORY |
string commercial category |
The item's commercial category |
|
VAT |
string VAT Group |
The item's Value Added Tax |
|
MTRUNIT1 |
string base unit of measure |
The item's base unit of measure |
|
MTRGROUP |
string item Group |
The item's group |
|
PRICEW |
string wholesale price |
The item's wholesale price |
|
PRICER |
string retail price |
The item's retail price |
|
SODISCOUNT |
string
|
The item's discount |
|
REMARKS |
string comments |
The item's comments |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
service |
string
|
service |
|
MODE |
string
|
|
|
appId |
string
|
appId |
|
OBJECT |
string
|
OBJECT |
|
KEY |
string
|
Insert a valid meeting record ID |
|
FORM |
string
|
Specify meeting's form |
|
LOCATEINFO |
string
|
Specify meeting's desired data fields |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
success |
boolean Success |
Is action successful? |
|
errorcode |
integer Error code |
Error code if action is unsuccessful |
|
error |
string Error |
Error message if action is unsuccessful |
|
data |
|
Data object of the response |
|
caption |
string
|
Descriptive caption of the meeting record |
Summary:
Description: Data object of the response
Properties:
|
Name |
Type |
Summary |
|
SOACTION |
Meeting |
Meeting data object |
Summary: Meeting
Description: Meeting data object
Properties:
|
Name |
Type |
Summary |
|
ACTOR |
string
|
Operator of the meeting |
|
ACTPRSN |
string Operator contact |
Contact of the meeting's operator |
|
ACTSTATUS |
string
|
The meeting's status |
|
COMMENTS |
string
|
The subject of the meeting |
|
FINALDATE |
string
|
Due date of the meeting |
|
FROMDATE |
string
|
Start date of the meeting |
|
ORDEREDBY |
string
|
Orderer of the meeting |
|
ORDPRSN |
string Ordered By Contact |
Contact of the meeting's orderer |
|
PRIORITY |
string priority |
Priority of the meeting |
|
PRJC |
string project |
The project of the meeting |
|
REMARKS |
string
|
Comments about the meeting |
|
SERIES |
string
|
The series of the meeting |
|
TASKCOMPLETE |
string
|
Is meeting completed? |
|
TRDR |
string
|
The meeting's customer ID |
|
TRDR_GENTRDR_NAME |
string
|
The meeting's customer name |
|
TRNDATE |
string(date-time)
|
The date the meeting was created |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
APPID |
integer(int32)
|
APPID |
|
SERVICE |
string
|
SERVICE |
|
MODE |
string
|
|
|
OBJECT |
string
|
OBJECT |
|
KEY |
string
|
Insert a valid project record ID |
|
FORM |
string
|
Specify project's form |
|
LOCATEINFO |
string
|
Specify project's desired data fields |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
success |
boolean Success |
Is action successful? |
|
errorcode |
integer Error code |
Error code if action is unsuccessful |
|
error |
string Error |
Error message if action is unsuccessful |
|
data |
|
data |
|
caption |
string
|
Brief caption of the project record |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
PRJC |
Project |
The project data object |
|
XTRDOCDATA |
array of (XTRDOCDATAItem)
|
Attached items data array |
Summary: Project
Description: The project data object
Properties:
|
Name |
Type |
Summary |
|
CODE |
string code |
The code of the project |
|
PRJC |
string name |
The project's ID |
|
NAME |
string name |
The project's name |
|
FINALDATE |
string
|
Due date of the project |
|
FROMDATE |
string
|
Start date of the project |
|
ISACTIVE |
string Active |
Is project active? |
|
ACTSTATUS |
string
|
The project's status |
|
PRJCRM |
string
|
The project's variation |
|
REMARKS |
string comments |
The project's comments |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
LINENUM |
string
|
Line number of the attached item |
|
SOFNAME |
string
|
Url address of the attached item |
|
NAME |
string
|
File name of the attached item |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
APPID |
integer(int32)
|
APPID |
|
SERVICE |
string
|
SERVICE |
|
MODE |
string
|
|
|
OBJECT |
string
|
OBJECT |
|
KEY |
string
|
Insert a valid document record ID |
|
FORM |
string
|
Specify document's form |
|
LOCATEINFO |
string
|
Specify document's desired data fields |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
success |
boolean Success |
Is action successful? |
|
errorcode |
integer Error code |
Error code if action is unsuccessful |
|
error |
string Error |
Error message if action is unsuccessful |
|
data |
|
The data object of the response |
|
caption |
string
|
Brief caption of the document record |
Summary:
Description: The data object of the response
Properties:
|
Name |
Type |
Summary |
|
PURDOC |
Purchases document |
Purchases document data object |
|
MTRDOC |
|
MTRDOC |
|
ITELINES |
array of (ITELINESItem)
|
Items data array |
|
SRVLINES |
array of (SRVLINESItem)
|
Services data array |
|
VATANAL |
array of (VATANALItem)
|
VAT analysis array |
Summary: Purchases document
Description: Purchases document data object
Properties:
|
Name |
Type |
Summary |
|
FINCODE |
string
|
The document's code |
|
DISC1PRC |
string
|
The document's percentage(%) discount |
|
PAYMENT |
string
|
The document's payment method |
|
PRJC |
string
|
The document's project id |
|
PRJC_PRJC_CODE |
string
|
The document's project code |
|
PRJC_PRJC_NAME |
string
|
The document's project name |
|
SERIES |
string
|
The series of the document |
|
SOCURRENCY |
string
|
The document's payment currency |
|
SUMAMNT |
string
|
The document's total value |
|
TRDR |
string
|
The document's supplier ID |
|
TRDR_SUPPLIER_AFM |
string
|
The document's supplier Tax Registration No. |
|
TRDR_SUPPLIER_CODE |
string
|
The document's supplier code |
|
TRDR_SUPPLIER_NAME |
string
|
The document's supplier name |
|
TRDR_SUPPLIER_JOBTYPETRD |
string supplier profession |
The document's supplier profession |
|
TRDR_SUPPLIER_ADDRESS |
string supplier address |
The document's supplier address |
|
TRDR_SUPPLIER_IRSDATA |
string supplier Tax Office |
The document's supplier tax office |
|
TRDR_SUPPLIER_PHONE01 |
string supplier phone |
The document's supplier telephone number |
|
TRNDATE |
string(date-time)
|
The transaction date of the document |
|
VATAMNT |
string
|
The document's Value Added Tax amount |
|
DISC1VAL |
string discount value |
The document's discount value |
|
EXPN |
string expenses |
The document's expenses |
|
REMARKS |
string comments |
The document's comments |
|
NETAMNT |
string net amount |
The document's net amount |
|
COMPANY |
string company |
The document's company name and ID |
|
FPRMS |
string type |
The document's type |
|
SHIPKIND |
string purpose of delivery |
The document's purpose of delivery |
Summary:
Description: MTRDOC
Properties:
|
Name |
Type |
Summary |
|
WHOUSE |
string Warehouse |
The document's warehouse name and ID |
|
COMPANY |
string Company |
The document's company ID |
|
DELIVDATE |
string(date-time) Delivery date |
The document's delivery date |
|
SHIPPINGADDR |
string Shipping address |
The document's shipping address |
Summary:
Description: Item data object
Properties:
|
Name |
Type |
Summary |
|
DISC1PRC |
string
|
The document's item discount |
|
LINENUM |
string
|
The document's item line number |
|
LINEVAL |
string
|
The document's item line value |
|
MTRL |
string
|
The document's item ID |
|
MTRL_ITEM_CODE |
string
|
Code of the document's item |
|
MTRL_ITEM_NAME |
string
|
The document's item name |
|
PRICE |
string
|
The document's item price |
|
QTY |
string
|
The document's item quantity |
Summary:
Description: Service data object
Properties:
|
Name |
Type |
Summary |
|
DISC1PRC |
string
|
The document's service discount |
|
LINENUM |
string
|
The document's service line number |
|
LINEVAL |
string
|
The document's service line value |
|
MTRL |
string
|
The document's service ID |
|
MTRL_SERVICE_CODE |
string(date-time)
|
Code of the document's service |
|
MTRL_SERVICE_NAME |
string
|
The document's service name |
|
PRICE |
string
|
The document's service price |
|
QTY |
string
|
The document's service quantity |
Summary:
Description: VAT analysis of the document
Properties:
|
Name |
Type |
Summary |
|
VAT |
string ID and category |
VAT category's ID |
|
VATVAL |
string value |
Total value of VAT category |
|
SUBVAL |
string value subject to VAT |
Document's total value subject to VAT category |
|
VAT_VAT_PERCNT |
string percent(%) |
VAT category percent (%) |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
service |
string
|
|
|
MODE |
string
|
|
|
appId |
string
|
|
|
OBJECT |
string
|
|
|
FORM |
string
|
Specify document's form |
|
KEY |
string
|
Insert a valid document record ID |
|
LOCATEINFO |
string
|
Specify document's desired data fields |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
success |
boolean Success |
Is action successful? |
|
errorcode |
integer Error code |
Error code if action is unsuccessful |
|
error |
string Error |
Error message if action is unsuccessful |
|
data |
|
The data object of the response |
|
caption |
string
|
Descriptive caption of the document record |
Summary:
Description: The data object of the response
Properties:
|
Name |
Type |
Summary |
|
SALDOC |
|
Sales document data object |
|
MTRDOC |
|
|
|
ITELINES |
array of (ITELINESItem)
|
Items data array |
|
SRVLINES |
array of (SRVLINESItem)
|
Services data array |
|
VATANAL |
array of (VATANALItem)
|
VAT analysis array |
Summary:
Description: Sales document data object
Properties:
|
Name |
Type |
Summary |
|
COMPANY |
string company |
The document's company name and ID |
|
FPRMS |
string type |
The document's type |
|
TRNDATE |
string(date-time) Date |
The document's transaction date |
|
SERIES |
string series |
The document's series |
|
FINCODE |
string
|
The document's code |
|
TRDR |
string customer ID |
The document's customer ID |
|
TRDR_CUSTOMER_CODE |
string customer code |
The document's customer code |
|
TRDR_CUSTOMER_NAME |
string customer name |
The document's customer name |
|
TRDR_CUSTOMER_JOBTYPETRD |
string customer profession |
The document's customer profession |
|
TRDR_CUSTOMER_ADDRESS |
string customer address |
The document's customer address |
|
TRDR_CUSTOMER_AFM |
string customer T.R.No |
The document's customer Tax Registration Number |
|
TRDR_CUSTOMER_IRSDATA |
string customer Tax Office |
The document's customer tax office |
|
TRDR_CUSTOMER_PHONE01 |
string customer phone |
The document's customer telephone number |
|
SOCURRENCY |
string currency |
The document's payment currency |
|
PAYMENT |
string payment |
The document's payment method |
|
VATAMNT |
string VAT amount |
The document's Value Added Tax amount |
|
DISC1PRC |
string Disc1prc |
The document's percentage(%) discount |
|
NETAMNT |
string net amount |
The document's net amount |
|
EXPN |
string expenses |
The document's expenses |
|
DISC1VAL |
string discount value |
The document's discount value |
|
REMARKS |
string comments |
The document's comments |
|
SHIPKIND |
string purpose of delivery |
The document's purpose of delivery |
|
SUMAMNT |
string Sum amount |
The document's total value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
WHOUSE |
string Warehouse |
The document's warehouse name and ID |
|
COMPANY |
string Company |
The document's company ID |
|
DELIVDATE |
string(date-time) Delivery date |
The document's delivery date |
|
SHIPPINGADDR |
string Shipping address |
The document's shipping address |
Summary:
Description: Item data object
Properties:
|
Name |
Type |
Summary |
|
LINENUM |
string line number |
The document's item line No. |
|
LINEVAL |
string line value |
The document's item line value |
|
MTRL |
string MTRL |
ID of the document's item |
|
MTRL_ITEM_CODE |
string code |
Code of the document's item |
|
MTRL_ITEM_NAME |
string Item name |
The document's item name |
|
DISC1PRC |
string
|
The document's item discount |
|
QTY |
string QTY |
The document's item quantity |
|
PRICE |
string Price |
The document's item price |
Summary:
Description: Service data object
Properties:
|
Name |
Type |
Summary |
|
DISC1PRC |
string
|
The document's service discount |
|
LINENUM |
string
|
The document's service line number |
|
LINEVAL |
string
|
The document's service line value |
|
MTRL |
string
|
The document's service ID |
|
MTRL_SERVICE_CODE |
string
|
Code of the document's service |
|
MTRL_SERVICE_NAME |
string
|
The document's service name |
|
PRICE |
string
|
The document's service price |
|
QTY |
string
|
The document's service quantity |
Summary:
Description: VAT analysis of the document
Properties:
|
Name |
Type |
Summary |
|
VAT |
string ID and category |
VAT category's ID |
|
VATVAL |
string value |
Total value of VAT category |
|
SUBVAL |
string value subject to VAT |
Document's total value subject to VAT category |
|
VAT_VAT_PERCNT |
string percent(%) |
VAT category percent (%) |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
VAT |
string
|
VAT |
|
NAME |
string
|
NAME |
|
CODE |
string
|
CODE |
|
MTRUNIT |
string
|
MTRUNIT |
|
SERIES |
string
|
SERIES |
|
SOCURRENCY |
string
|
SOCURRENCY |
|
WHOUSE |
string
|
WHOUSE |
|
MTRL |
string
|
MTRL |
|
PRJC |
string
|
PRJC |
|
TRDR |
string
|
TRDR |
|
MTRGROUP |
string
|
MTRGROUP |
|
PAYMENT |
string
|
PAYMENT |
|
BANK |
string
|
BANK |
|
IRSDATA |
string
|
IRSDATA |
|
PRSN |
string
|
PRSN |
|
NAME2 |
string
|
NAME2 |
|
COMMENTS |
string
|
COMMENTS |
|
TPRMS |
string
|
TPRMS |
|
CREDITCARDS |
string
|
CREDITCARDS |
|
AREAS |
string
|
AREAS |
|
PRIORITY |
string
|
PRIORITY |
|
USERS |
string
|
USERS |
|
MTRCATEGORY |
string
|
MTRCATEGORY |
|
BRANCH |
string
|
BRANCH |
|
BUSUNITS |
string
|
BUSUNITS |
|
CHEQUESTATES |
string
|
CHEQUESTATES |
|
DEPART |
string
|
DEPART |
|
EDUCAT |
string
|
EDUCAT |
|
NATIONALITY |
string
|
NATIONALITY |
|
PRJCLEAD |
string
|
BUSUNITS |
|
COUNTRY |
string
|
COUNTRY |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
service |
string
|
|
|
MODE |
string
|
|
|
appId |
string
|
|
|
OBJECT |
string
|
|
|
FORM |
string
|
Specify service's form |
|
KEY |
string
|
Insert a valid service record ID |
|
LOCATEINFO |
string
|
Specify service's desired fields |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
success |
boolean Success |
Is action successful? |
|
errorcode |
integer Error code |
Error code if action is unsuccessful |
|
error |
string Error |
Error message if action is unsuccessful |
|
data |
|
The data object of the response |
|
caption |
string
|
Descriptive caption of the service's record |
Summary:
Description: The data object of the response
Properties:
|
Name |
Type |
Summary |
|
SERVICE |
Service |
Service data object |
Summary: Service
Description: Service data object
Properties:
|
Name |
Type |
Summary |
|
CODE |
string code |
The service's code |
|
NAME |
string description |
The service's name |
|
ISACTIVE |
string Active |
Is service active? |
|
MTRCATEGORY |
string commercial category |
The service's commercial category |
|
VAT |
string VAT Group |
The service's Value Added Tax |
|
MTRUNIT1 |
string base unit of measure |
The service's base unit of measure |
|
MTRGROUP |
string service Group |
The service's group |
|
PRICEW |
string wholesale price |
The service's wholesale price |
|
PRICER |
string retail price |
The service's retail price |
|
SODISCOUNT |
string
|
The service's discount |
|
REMARKS |
string comments |
The service's comments |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
service |
string
|
service |
|
MODE |
string
|
|
|
appId |
string
|
appId |
|
OBJECT |
string
|
OBJECT |
|
KEY |
string
|
Insert a valid email record ID |
|
FORM |
string
|
Specify the email's form |
|
LOCATEINFO |
string
|
Specify email's desired data fields |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
success |
boolean Success |
Is action successful? |
|
errorcode |
integer Error code |
Error code if action is unsuccessful |
|
error |
string Error |
Error message if action is unsuccessful |
|
data |
|
The data object of the response |
|
caption |
string
|
Brief caption of the record |
Summary:
Description: The data object of the response
Properties:
|
Name |
Type |
Summary |
|
SOACTION |
Email task |
Email task data object |
|
SOMAIL |
|
E-mail data object |
|
XTRDOCDATA |
array of (XTRDOCDATAItem)
|
Attached items data array |
Summary: Email task
Description: Email task data object
Properties:
|
Name |
Type |
Summary |
|
ACTOR |
string
|
Operator of the task |
|
ACTPRSN |
string Operator contact |
Contact of the task's operator |
|
ACTSTATUS |
string
|
The task's status |
|
COMMENTS |
string
|
The subject of the task |
|
FINALDATE |
string
|
Due date of the task |
|
FROMDATE |
string
|
Start date of the task |
|
ORDEREDBY |
string
|
Orderer of the task |
|
ORDPRSN |
string Ordered By Contact |
Contact of the task's orderer |
|
PRIORITY |
string priority |
Priority of the task |
|
PRJC |
string project |
The project of the task |
|
REMARKS |
string
|
Comments about the task |
|
SERIES |
string
|
The series of the task |
|
TASKCOMPLETE |
string
|
Is task completed? |
|
TRDR |
string
|
The task's customer ID |
|
TRDR_GENTRDR_NAME |
string
|
The task's customer name |
|
TRNDATE |
string(date-time)
|
The date the task was created |
Summary:
Description: E-mail data object
Properties:
|
Name |
Type |
Summary |
|
FROMADDRESS |
string
|
The mailbox owner's and sender's address |
|
FROMNAME |
string
|
The mailbox owner's and sender's name |
|
MAILDATE |
string(date-time)
|
E-mail's date |
|
SOBCC |
string
|
The Bcc recipients of the message |
|
SOBODY |
string
|
The body of the message |
|
SOCC |
string
|
The Cc recipients of the message |
|
SOTO |
string
|
The recipients of the message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
LINENUM |
string
|
Line number of the attached item |
|
SOFNAME |
string
|
Url address of the attached item |
|
NAME |
string
|
File name of the attached item |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
service |
string
|
service |
|
MODE |
string
|
|
|
appId |
string
|
appId |
|
OBJECT |
string
|
OBJECT |
|
KEY |
string
|
Insert a valid task record ID |
|
FORM |
string
|
Specify task's form |
|
LOCATEINFO |
string
|
Specify task's desired data fields |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
success |
boolean Success |
Is action successful? |
|
errorcode |
integer Error code |
Error code if action is unsuccessful |
|
error |
string Error |
Error message if action is unsuccessful |
|
data |
|
Data object of the response |
|
caption |
string
|
Descriptive caption of the task record |
Summary:
Description: Data object of the response
Properties:
|
Name |
Type |
Summary |
|
SOACTION |
Task |
Task data object |
Summary: Task
Description: Task data object
Properties:
|
Name |
Type |
Summary |
|
ACTOR |
string
|
Operator of the task |
|
ACTPRSN |
string Operator contact |
Contact of the task's operator |
|
ACTSTATUS |
string
|
The task's status |
|
COMMENTS |
string
|
The subject of the task |
|
FINALDATE |
string
|
Due date of the task |
|
FROMDATE |
string
|
Start date of the task |
|
ORDEREDBY |
string
|
Orderer of the task |
|
ORDPRSN |
string Ordered By Contact |
Contact of the task's orderer |
|
PRIORITY |
string priority |
Priority of the task |
|
PRJC |
string project |
The project of the task |
|
REMARKS |
string
|
Comments about the task |
|
SERIES |
string
|
The series of the task |
|
TASKCOMPLETE |
string
|
Is task completed? |
|
TRDR |
string
|
The task's customer ID |
|
TRDR_GENTRDR_NAME |
string
|
The task's customer name |
|
TRNDATE |
string(date-time)
|
The date the task was created |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
APPID |
integer(int32)
|
APPID |
|
SERVICE |
string
|
SERVICE |
|
MODE |
string
|
|
|
OBJECT |
string
|
OBJECT |
|
KEY |
string
|
Insert a valid supplier record ID |
|
FORM |
string
|
Specify supplier's form |
|
LOCATEINFO |
string
|
Specify supplier's desired data fields |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
success |
boolean Success |
Is action successful? |
|
errorcode |
integer Error code |
Error code if action is unsuccessful |
|
error |
string Error |
Error message if action is unsuccessful |
|
data |
|
The data object of the response |
|
caption |
string
|
Descriptive caption of the supplier record |
Summary:
Description: The data object of the response
Properties:
|
Name |
Type |
Summary |
|
SUPPLIER |
|
Supplier data object |
|
SUPBANKACC |
array of (SUPBANKACCItem)
|
Bank accounts data array |
Summary:
Description: Supplier data object
Properties:
|
Name |
Type |
Summary |
|
ADDRESS |
string
|
The primary address of the supplier |
|
AFM |
string
|
Tax registration number of the supplier |
|
CITY |
string
|
Percentage (%) discount of the customer |
|
CODE |
string
|
Supplier record code |
|
DISTRICT |
string
|
The location area of the supplier |
|
|
string
|
The email address of the supplier |
|
FAX |
string
|
The FAX number of the supplier |
|
IRSDATA |
string
|
The tax office of the supplier |
|
ISACTIVE |
string Active |
Is supplier active? |
|
JOBTYPETRD |
string
|
The profession of the supplier |
|
NAME |
string
|
The name of the supplier |
|
PHONE01 |
string
|
The primary phone number of the supplier |
|
REMARKS |
string
|
Comments on supplier record |
|
VATSTS |
string
|
The tax category of the supplier |
|
ZIP |
string
|
The zip code of the supplier |
Summary:
Description: Bank account data object
Properties:
|
Name |
Type |
Summary |
|
BANK |
string
|
Bank account's bank name |
|
BANK_BANK_CODE |
string
|
Bank's code |
|
IBAN |
string
|
International Bank Account number |
|
LINENUM |
string
|
Bank account's line number |
|
REMARKS |
string
|
Comments about the bank account |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
service |
string
|
service |
|
appId |
string
|
appId |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
success |
boolean Success |
Is action successful? |
|
errorcode |
integer Error code |
Error code if action is unsuccessful |
|
error |
string Error |
Error message if action is unsuccessful |
|
serialnumber |
string Serial number |
The serial number of the installation |
|
companyinfo |
Company |
Information about the company |
Summary: Company
Description: Information about the company
Properties:
|
Name |
Type |
Summary |
|
name |
string name |
The name of the company |
|
address |
string address |
The adress of the company |
|
district |
string location area |
The location area of the company |
|
zip |
string zip |
The zip code of the company |
|
afm |
string T.R.No |
The Tax Registration Number of the company |
|
irsdata |
string tax office |
The tax office of the company |
|
phone |
string telephone number |
The telephone number of the company |
|
|
string |
The email of the company |
|
branch |
Branch |
The branch of the company |
|
image |
string Logo |
Url of the company's logo |
Summary: Branch
Description: The branch of the company
Properties:
|
Name |
Type |
Summary |
|
name |
string name |
The name of the company's branch |
|
address |
string address |
The address of the company's branch |
|
district |
string location area |
The location area of the company's branch |
|
zip |
string zip |
The zip code of the company's branch |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
endpoint |
string
|
Specify web service's url endpoint |
|
body |
string
|
Insert request body |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
APPID |
integer(int32)
|
APPID |
|
SERVICE |
string
|
SERVICE |
|
MODE |
string
|
|
|
OBJECT |
string
|
OBJECT |
|
KEY |
string
|
Enter a valid document record ID to modify it |
|
FORM |
string
|
Specify the document's form |
|
DATA |
|
The data object of the request |
Summary:
Description: The data object of the request
Properties:
|
Name |
Type |
Summary |
|
CFNCUSDOC |
|
|
|
CASHLINES |
array of (CASHLINESItem)
|
Cash data array |
|
CHEQUELINES |
array of (CHEQUELINESItem)
|
Insert cheques data array |
|
CARDLINES |
array of (CARDLINESItem)
|
Cards data array |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
SERIES |
string
|
Select the Series of the document or enter the Series ID |
|
TRNDATE |
string
|
Specify transaction date in YYYY-MM-DD format or leave it blank for today |
|
TRDR |
string
|
Select the Customer or enter the Customer ID |
|
PRJC |
string Project |
Select the project or enter the project ID |
|
SALESMAN |
string
|
Select the Salesman or enter the Salesman ID |
|
COLLECTOR |
string
|
Select the Collector or enter the Collector ID |
|
COMMENTS |
string
|
Select the reason or enter the reason ID |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
LINENUM |
integer(int32)
|
Specify the cash line number or leave it blank for default |
|
LINEVAL |
integer(int32)
|
Specify the cash line value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
LINENUM |
integer(int32) Cheque line number |
Specify the cheque line number or leave it blank for default |
|
TPRMS |
integer(int32) Cheque transaction type |
Select transaction type or enter transaction type ID |
|
CODE |
string
|
Insert cheque code |
|
CSERIES |
integer(int32)
|
Select cheque series or enter cheque series ID |
|
LINEVAL |
integer(int32)
|
Specify cheque line value |
|
CCHEQUENUMBER |
string
|
Insert cheque No. |
|
CFINALDATE |
string
|
Specify cheque's due date with format: YYYY-MM-DD or leave it blank for today's date |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
LINENUM |
integer(int32)
|
Specify the credit card's line number or leave it blank for default |
|
CREDITCARDS |
integer(int32)
|
Select a credit card or enter the credit card's ID |
|
CRDCARDNUM |
string
|
Insert the credit card's number |
|
LINEVAL |
integer(int32)
|
Specify the card line value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
APPID |
integer(int32)
|
APPID |
|
SERVICE |
string
|
SERVICE |
|
MODE |
string
|
|
|
OBJECT |
string
|
OBJECT |
|
KEY |
string
|
Enter a valid document record ID to modify it |
|
FORM |
string
|
Specify document's form |
|
DATA |
|
The data object of the request |
Summary:
Description: The data object of the request
Properties:
|
Name |
Type |
Summary |
|
CFNSUPDOC |
|
|
|
CASHLINES |
array of (CASHLINESItem)
|
Insert cash data array |
|
CHEQUELINES |
array of (CHEQUELINESItem)
|
Insert cheques data array |
|
CARDLINES |
array of (CARDLINESItem)
|
Insert cards data array |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
SERIES |
string
|
Select the series of the document or enter a series ID |
|
TRDR |
string
|
Select the customer or enter the customer ID |
|
TRNDATE |
string
|
Specify transaction date in YYYY-MM-DD format or leave it blank for today |
|
PRJC |
string
|
Select the project or enter the project ID |
|
REMARKS |
string
|
Insert comments |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
LINENUM |
integer(int32) Cash line No. |
Specify the cash line number or leave it blank for default |
|
LINEVAL |
integer(int32) Cash line value |
Specify the cash line value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
LINENUM |
integer(int32) Cheque line number |
Specify the cheque line number or leave it blank for default |
|
TPRMS |
integer(int32) Cheque transaction type |
Select transaction type or enter transaction type ID |
|
CODE |
string
|
Insert cheque code |
|
CSERIES |
integer(int32)
|
Select cheque series or enter cheque series ID |
|
LINEVAL |
integer(int32)
|
Specify cheque line value |
|
CCHEQUENUMBER |
string
|
Insert cheque No. |
|
CFINALDATE |
string
|
Specify cheque's due date with format: YYYY-MM-DD or leave it blank for today's date |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
LINENUM |
integer(int32)
|
Specify the credit card's line number or leave it blank for default |
|
CREDITCARDS |
integer(int32)
|
Select a credit card or enter a credit card ID |
|
CRDCARDNUM |
string
|
Specify the credit card's number |
|
LINEVAL |
integer(int32)
|
Specify the credit card's line value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
service |
string service |
service |
|
MODE |
string
|
|
|
appId |
string appId |
appId |
|
OBJECT |
string OBJECT |
OBJECT |
|
KEY |
string KEY |
Enter a valid cheque record ID to modify it |
|
FORM |
string FORM |
Specify cheque's form |
|
data |
|
The data object of the request |
Summary:
Description: The data object of the request
Properties:
|
Name |
Type |
Summary |
|
CHEQUE |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
SERIES |
string Series |
Insert a cheque code |
|
CREATORNAME |
string Issuer name |
Specify the issuer's name |
|
CREATORPHONE |
string Issuer telephone |
Specify the issuer's telephone |
|
CREATORADDR |
string Issuer address |
Specify the issuer's address |
|
PUBLISHERAFM |
string Issuer T.R.No |
Specify the issuer's Tax Registration Number |
|
CHEQUENUMBER |
string Cheque Number |
Insert cheque's number |
|
CHEQUESTATES |
string Status |
Select cheque's status or enter status ID |
|
CHEQUEVAL |
string Value |
Specify cheque's value |
|
CHEQUEBAL |
string Balance |
Specify cheque's balance |
|
BANK |
string Bank |
Select bank or enter bank ID |
|
CRTDATE |
string Receipt date |
Specify the cheque's receipt date in YYYY-MM-DD format, or leave it blank for today |
|
DATEOFS |
string Issue date |
Specify the cheque's issue date in YYYY-MM-DD format, or leave it blank for today |
|
FINALDATE |
string Due date |
Specify the cheque's due date in YYYY-MM-DD format, or leave it blank for today |
|
HOLDERNAME |
string Holder name |
Specify cheque's holder name |
|
HOLDERADDR |
string Holder address |
Specify cheque's holder address |
|
REMARKS |
string Comments |
Insert comments |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
service |
string service |
service |
|
MODE |
string
|
|
|
appId |
string appId |
appId |
|
OBJECT |
string OBJECT |
OBJECT |
|
KEY |
string KEY |
Enter a valid contact ID to modify it |
|
FORM |
string FORM |
Specify contact's form |
|
data |
|
The data object of the request |
Summary:
Description: The data object of the request
Properties:
|
Name |
Type |
Summary |
|
PRSNOUT |
|
|
|
XTRDOCDATA |
array of (XTRDOCDATAItem)
|
Specify an Attached items array |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
CODE |
string Code |
Insert a contact code |
|
NAME2 |
string Surname |
Specify the surname of the contact |
|
NAME |
string Name |
Specify the name of the contact |
|
SOSEX |
string Gender |
Select the gender of the contact. '1' for Male and '2' for Female Values: [1, 2] |
|
AFM |
string T.R.No |
Specify the Tax Registration Number of the contact |
|
IDENTITYNUM |
string ID card No |
Specify the ID card number of the contact |
|
IRSDATA |
string Tax Office |
Select the tax office of the contact |
|
EDUCAT |
string Education level |
Select the education level of the contact |
|
NAME3 |
string Father's name |
Specify the father's name of the contact |
|
NAME4 |
string Mother's name |
Specify the mother's name of the contact |
|
NAME5 |
string Name of spouse |
Specify the name of spouse of the contact |
|
BIRTHDATE |
string(date-time)
|
Specify the date of birth of the contact in YYYY-MM-DD format, or leave it blank for today |
|
NATIONALITY |
string Nationality |
Select the nationality or enter the nationality ID |
|
ADDRESS |
string Address |
Specify the address of the contact |
|
CITY |
string City |
Specify the city of the contact |
|
DISTRICT |
string Area |
Specify the area of the contact |
|
COUNTRY |
string Country |
Select the country or enter the country ID |
|
DISTRICT1 |
string Prefecture |
Specify the prefecture of the contact |
|
AREAS |
string Geographical Areas |
Select the geographical area |
|
PHONE1 |
string Tel. 1 |
Specify first telephone number of the contact |
|
PHONE2 |
string Tel. 2 |
Specify second telephone number of the contact |
|
PHONEEXT |
string Internal telephone |
Specify the internal telephone number of the contact |
|
PHONELOCAL |
string Personal telephone |
Specify the personal telephone number of the contact |
|
MOBILEPHONE |
string Mobile telephone |
Specify the mobile telephone number of the contact |
|
FAX |
string Fax |
Specify the fax number of the contact |
|
|
string |
Specify the email of the contact |
|
EMAIL1 |
string Email 2 |
Specify second email of the contact |
|
WEBPAGE |
string Web page |
Specify the web page of the contact |
|
ZIP |
string Zip |
Specify the zip code of the contact |
|
REMARKS |
string Comments |
Insert comments |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
LINENUM |
string LINENUM |
Specify the line No. of the attached item |
|
NAME |
string Name |
Specify the file name of the attached item |
|
SOFNAME |
string Url |
Specify the url address of the attached item |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
service |
string service |
service |
|
MODE |
string
|
|
|
appId |
string appId |
appId |
|
OBJECT |
string OBJECT |
OBJECT |
|
KEY |
string KEY |
Enter a valid customer ID to modify it |
|
FORM |
string FORM |
Specify customer's form |
|
data |
|
The data object of the request |
Summary:
Description: The data object of the request
Properties:
|
Name |
Type |
Summary |
|
CUSTOMER |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
CODE |
string Code |
Insert a customer code |
|
NAME |
string Name |
Specify the name of the customer |
|
CITY |
string City |
Specify the city of the customer |
|
AREAS |
string Geographical Areas |
Select the geographical area |
|
ADDRESS |
string Primary Address |
Specify the primary address of the customer |
|
DISTRICT |
string Location Area |
Specify the location area of the customer |
|
JOBTYPETRD |
string Profession |
Specify the profession of the customer |
|
ZIP |
string Zip |
Specify the zip code of the customer |
|
PHONE01 |
string Primary Telephone |
Specify the primary telephone number of the customer |
|
FAX |
string Fax |
Specify the fax number of the customer |
|
|
string |
Specify the email address of the customer |
|
AFM |
string T.R.No |
Specify the tax registration number of the customer |
|
DISCOUNT |
integer(int32) Discount |
Specify the customer's discount |
|
VATSTS |
string Tax Category |
Select the tax category (0 for Exempted, 1 for Normal, 2 for Reduced) Values: [0, 1, 2] |
|
REMARKS |
string Comments |
Insert comments |
|
IRSDATA |
string Tax Office |
Select the tax office of the customer |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
ID of the document record that was created or modified |
|
success |
boolean Success |
Is action successful? |
|
errorcode |
integer Error code |
Error code if action is unsuccessful |
|
error |
string Error |
Error message if action is unsuccessful |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
service |
string service |
service |
|
MODE |
string
|
|
|
appId |
string appId |
appId |
|
OBJECT |
string OBJECT |
OBJECT |
|
KEY |
string KEY |
Enter a valid draft entry ID to modify it |
|
FORM |
string FORM |
Specify draft entry's form |
|
data |
|
The data object of the request |
Summary:
Description: The data object of the request
Properties:
|
Name |
Type |
Summary |
|
SODRAFT |
|
|
|
SODRAFTLNK |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
CODE |
string Code |
Insert a draft entry code |
|
NAMEC |
string Name/Title |
Specify the name/title of the draft entry |
|
NAMEF |
string First name |
Specify the first name of the draft entry |
|
NAMEL |
string Surname |
Specify the surname of the draft entry |
|
AFM |
string T.R.No |
Specify the tax registration number of the draft entry |
|
IDENTITYNUM |
string ID card No |
Specify the ID card number of the draft entry |
|
SOTITLENAME |
string Title |
Specify the job title of the draft entry |
|
JOBTYPETRD |
string Activity |
Specify the activity of the draft entry |
|
NUMCG |
string Zip |
Specify the general commercial registry of the draft entry |
|
DRAFTTYPE |
string Category |
Specify the category of the draft entry |
|
ADDRESS |
string Address |
Specify the address of the draft entry |
|
CITY |
string City |
Specify the city of the draft entry |
|
DISTRICT |
string Area |
Specify the area of the draft entry |
|
COUNTRY |
string Country |
Specify the country of the draft entry |
|
DISTRICT1 |
string Prefecture |
Specify the prefecture of the draft entry |
|
PHONE1 |
string Business telephone |
Specify the business telephone number of the draft entry |
|
PHONEEXT |
string Internal telephone |
Specify the internal telephone number of the draft entry |
|
PHONELOCAL |
string Personal telephone |
Specify the personal telephone number of the draft entry |
|
MOBILEPHONE |
string Mobile telephone |
Specify the mobile telephone number of the draft entry |
|
|
string Company email |
Specify the company email of the draft entry |
|
EMAIL1 |
string Business email |
Specify the business email of the draft entry |
|
EMAIL2 |
string Personal email |
Specify the personal email of the draft entry |
|
WEBPAGE |
string Web page |
Specify the web page of the draft entry |
|
ZIP |
string Zip |
Specify the zip code of the draft entry |
|
REMARKS |
string Comments |
Insert comments |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
BRANCH |
string Branch |
Select the branch or enter the branch ID |
|
DEPART |
string Department |
Select the department or enter the department ID |
|
BUSUNITS |
string Business unit |
Select the business unit or enter the business unit ID |
|
PRJC |
string Project |
Select the project or enter the project ID |
|
PRJCLEAD |
string Source |
Select the source or enter the source ID |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
service |
string service |
service |
|
MODE |
string
|
|
|
appId |
string appId |
appId |
|
OBJECT |
string OBJECT |
OBJECT |
|
KEY |
string KEY |
Enter a valid expense record ID to modify it |
|
FORM |
string FORM |
Specify expense's form |
|
data |
|
The data object of the request |
Summary:
Description: The data object of the request
Properties:
|
Name |
Type |
Summary |
|
LINEITEM |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
CODE |
string Code |
Insert an expense code |
|
NAME |
string Name |
Specify the expense's name |
|
VAT |
string Vat Group |
Select the expense's Value Added Tax group or enter the Vat ID |
|
MTRTYPE |
string Type |
Select expense's type (0 for 'Normal', 1 for 'Expense', 2 for 'VAT only') Values: [0, 1, 2] |
|
MTRCATEGORY |
string Commercial category |
Specify the expense's commercial category |
|
LISOURCETYPE |
string Invoicing category |
Select invoicing category (12 for 'Suppliers', 13 for 'Customers', 14 for 'Cash accounts',15 for 'Debtors',16 for 'Creditors') Values: [12, 13, 14, 15, 16] |
|
SOPAYVALUE |
string Fee value |
Select fee value (1 for 'Gross Salary', 2 for 'Deductions', 3 for 'Tax',4 for 'Stamp',5 for 'OGA Stamp') Values: [1, 2, 3, 4, 5] |
|
REMARKS |
string Comments |
Insert comments |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
APPID |
string appId |
appId |
|
SERVICE |
string service |
service |
|
MODE |
string
|
|
|
OBJECT |
string OBJECT |
OBJECT |
|
KEY |
string KEY |
Enter a valid document record ID to modify it |
|
FORM |
string FORM |
Specify document's form |
|
DATA |
|
The data object of the request |
Summary:
Description: The data object of the request
Properties:
|
Name |
Type |
Summary |
|
LINSUPDOC |
|
LINSUPDOC |
|
LINLINES |
array of (LINLINESItem)
|
Insert an expenses data array |
Summary:
Description: LINSUPDOC
Properties:
|
Name |
Type |
Summary |
|
SERIES |
string Series |
Select the Series of the document or enter the Series ID |
|
TRNDATE |
string
|
Specify the transaction date in YYYY-MM-DD format, or leave it blank for today |
|
TRDR |
string Supplier |
Select the Customer or enter the Customer ID |
|
PRJC |
string Project |
Select the project or enter the project ID |
|
REMARKS |
string Comments |
Insert comments |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
LINENUM |
string LINENUM |
Specify the item's line number or leave it blank for default |
|
MTRL |
string Expense |
Select an expense or enter the expense ID |
|
VAT |
string Item |
Select VAT or enter the VAT ID |
|
LINEVAL |
string LINEVAL |
Specify the expense's line value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
service |
string service |
service |
|
MODE |
string
|
|
|
appId |
string appId |
appId |
|
OBJECT |
string OBJECT |
OBJECT |
|
KEY |
string KEY |
Enter a valid document record ID to modify it |
|
FORM |
string FORM |
Specify document's form |
|
data |
|
The data object of the request |
Summary:
Description: The data object of the request
Properties:
|
Name |
Type |
Summary |
|
ITEDOC |
|
|
|
MTRDOC |
|
|
|
ITELINES |
array of (ITELINESItem)
|
Insert an items data array |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
SERIES |
string Series |
Select the Series of the document or enter the Series ID |
|
TRNDATE |
string
|
Specify the transaction date in YYYY-MM-DD format, or leave it blank for today |
|
COMMENTS |
string Reason |
Specify document's reason |
|
REMARKS |
string REMARKS |
Insert comments |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
WHOUSE |
string Warehouse |
Select the warehouse or enter the warehouse ID |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
LINENUM |
string LINENUM |
Specify the item's line number or leave it blank for default. |
|
MTRL |
string Item |
Select an item or enter the item ID |
|
QTY |
string Quantity |
Specify the item's quantity |
|
PRICE |
string PRICE |
Specify the item's price |
|
DISC1PRC |
string Discount |
Specify the item's discount |
|
LINEVAL |
string LINEVAL |
Specify the item's line value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
service |
string service |
service |
|
MODE |
string
|
|
|
appId |
string appId |
appId |
|
OBJECT |
string OBJECT |
OBJECT |
|
KEY |
string KEY |
Enter a valid item record ID to modify it |
|
FORM |
string FORM |
Specify item's form |
|
data |
|
The data object of the request |
Summary:
Description: The data object of the request
Properties:
|
Name |
Type |
Summary |
|
ITEM |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
CODE |
string Code |
Insert an item code |
|
NAME |
string Name |
Specify the item's name |
|
VAT |
string Vat Group |
Select the item's Value Added Tax group or enter the Vat ID |
|
MTRUNIT1 |
string Base unit of measure |
Select the item's U.o.M or enter the U.o.M ID |
|
MTRCATEGORY |
string Commercial category |
Specify the item's commercial category |
|
MTRGROUP |
string Item group |
Select the item's group or enter the item's group ID |
|
PRICEW |
string Wholesale price |
Specify the item's wholesale price |
|
PRICER |
string Retail price |
Specify the item's retail price |
|
SODISCOUNT |
string Discount1 |
Specify the item's discount |
|
REMARKS |
string Comments |
Insert comments |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
APPID |
integer(int32)
|
APPID |
|
SERVICE |
string
|
SERVICE |
|
MODE |
string
|
|
|
OBJECT |
string
|
OBJECT |
|
KEY |
string
|
Enter a valid meeting record ID to modify it |
|
FORM |
string
|
Specify the meeting's form |
|
DATA |
|
The data object of the request |
Summary:
Description: The data object of the request
Properties:
|
Name |
Type |
Summary |
|
SOACTION |
|
|
|
XTRDOCDATA |
array of (XTRDOCDATAItem)
|
Insert attached items array |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
SERIES |
string
|
Select the Series of the Meeting or enter the Series ID |
|
COMMENTS |
string
|
Specify the subject of the meeting |
|
TRDR |
string
|
Select the customer or enter the customer ID |
|
TRNDATE |
string(date-time)
|
Specify the date the meeting was created in YYYY-MM-DD format, or leave it blank for today |
|
FROMDATE |
string
|
Specify the date the meeting was created in YYYY-MM-DD format, or leave it blank for today |
|
FINALDATE |
string
|
Specify the date the meeting was created in YYYY-MM-DD format, or leave it blank for today |
|
PRIORITY |
string Priority |
Select priority or enter a valid priority ID |
|
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') Values: [0, 1, 2, 3, 4, 5, 6] |
|
PRJC |
string Project |
Select the project or enter the project ID |
|
ORDEREDBY |
string Ordered By |
Select the orderer or enter the orderer ID |
|
ORDPRSN |
string Ordered By Contact |
Select the contact of the orderer or enter the contact ID |
|
ACTOR |
string Operator |
Select the operator or enter the operator ID |
|
ACTPRSN |
string Operator contact |
Select the contact of the operator or enter the contact ID |
|
REMARKS |
string
|
Insert comments |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
LINENUM |
string LINENUM |
Specify the line No. of the attached item |
|
NAME |
string Name |
Specify the file name of the attached item |
|
SOFNAME |
string Url |
Specify the url address of the attached item |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
service |
string service |
service |
|
MODE |
string
|
|
|
appId |
string appId |
appId |
|
OBJECT |
string OBJECT |
OBJECT |
|
KEY |
string KEY |
Enter a valid contact ID to modify it |
|
FORM |
string FORM |
Specify contact's form |
|
data |
|
The data object of the request |
Summary:
Description: The data object of the request
Properties:
|
Name |
Type |
Summary |
|
PRJC |
|
|
|
XTRDOCDATA |
array of (XTRDOCDATAItem)
|
Specify an Attached items array |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
CODE |
string Code |
Insert a contact code |
|
NAME |
string Name |
Specify the name of the project |
|
FROMDATE |
string
|
Specify the date the task was created in YYYY-MM-DD format, or leave it blank for today |
|
FINALDATE |
string
|
Specify the due date of the task in YYYY-MM-DD format, or leave it blank for today |
|
PRJCRM |
string
|
Select variation (0 for 'Project', 1 for 'Campaign', 2 for 'Opportunity') Values: [0, 1, 2] |
|
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') Values: [0, 1, 2, 3, 4, 5, 6] |
|
REMARKS |
string Comments |
Insert comments |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
LINENUM |
string LINENUM |
Specify the line No. of the attached item |
|
NAME |
string Name |
Specify the file name of the attached item |
|
SOFNAME |
string Url |
Specify the url address of the attached item |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
APPID |
integer(int32)
|
APPID |
|
SERVICE |
string
|
SERVICE |
|
MODE |
string
|
|
|
OBJECT |
string
|
OBJECT |
|
KEY |
string
|
Enter a valid document record ID to modify it |
|
FORM |
string
|
Specify document's form |
|
DATA |
|
The data object of the request |
Summary:
Description: The data object of the request
Properties:
|
Name |
Type |
Summary |
|
PURDOC |
|
|
|
MTRDOC |
|
|
|
ITELINES |
array of (ITELINESItem)
|
Insert an items data array |
|
SRVLINES |
array of (SRVLINESItem)
|
Insert a services data array |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
SERIES |
string
|
Select the series of the document or enter the series ID |
|
TRDR |
string
|
Select the supplier or enter the supplier ID |
|
TRNDATE |
string
|
Specify the transaction date in YYYY-MM-DD format, or leave it blank for today |
|
PAYMENT |
string
|
Select the payment method or enter the payment ID |
|
SOCURRENCY |
string
|
Select the payment currency or enter the currency ID |
|
PRJC |
string
|
Select the project or enter the project ID |
|
DISC1PRC |
string DISC1PRC |
Specify the document's discount |
|
SUMAMNT |
string SUMAMNT |
Specify the document's total value |
|
REMARKS |
string REMARKS |
Insert comments |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
WHOUSE |
string Warehouse |
Select the warehouse or insert the warehouse ID |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
LINENUM |
string LINENUM |
Specify the item's line number or leave it blank for default |
|
MTRL |
string
|
Select an item or enter the item id |
|
QTY |
integer(int32)
|
Specify the item's quantity |
|
PRICE |
string PRICE |
Specify the item's price |
|
DISC1PRC |
integer(int32)
|
Specify the item's discount |
|
LINEVAL |
string LINEVAL |
Specify the item's line value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
LINENUM |
string LINENUM |
Specify the service's line number or leave it blank for default |
|
MTRL |
string
|
Select a service or enter the service id |
|
QTY |
integer(int32)
|
Specify the service's quantity |
|
PRICE |
string PRICE |
Specify the service's price |
|
DISC1PRC |
integer(int32)
|
Specify the service's discount |
|
LINEVAL |
string LINEVAL |
Specify the service's line value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
service |
string service |
service |
|
MODE |
string
|
|
|
appId |
string appId |
appId |
|
OBJECT |
string OBJECT |
OBJECT |
|
KEY |
string KEY |
Enter a valid document record ID to modify it |
|
FORM |
string FORM |
Specify document's form |
|
data |
|
The data object of the request |
Summary:
Description: The data object of the request
Properties:
|
Name |
Type |
Summary |
|
SALDOC |
|
|
|
MTRDOC |
|
|
|
ITELINES |
array of (ITELINESItem)
|
Insert an items data array |
|
SRVLINES |
array of (SRVLINESItem)
|
Insert a services data array |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
SERIES |
string Series |
Select the Series of the document or enter the Series ID |
|
TRDR |
string Customer |
Select the Customer or enter the Customer ID |
|
TRNDATE |
string
|
Specify the transaction date in YYYY-MM-DD format, or leave it blank for today |
|
PAYMENT |
string Payment |
Select the payment method or enter the payment ID |
|
SOCURRENCY |
string Currency |
Select the payment currency or enter the currency ID |
|
PRJC |
string Project |
Select the project or enter the project ID |
|
DISC1PRC |
string DISC1PRC |
Specify the document's Discount |
|
SUMAMNT |
string SUMAMNT |
Specify the document's Total value |
|
VATAMNT |
string VATAMNT |
Specify the document's Total VAT |
|
NETAMNT |
string NETAMNT |
Specify the document's Net amount |
|
DISC1VAL |
string DISC1VAL |
Specify the document's Discount value |
|
REMARKS |
string REMARKS |
Insert comments |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
WHOUSE |
string Warehouse |
Select the warehouse or enter the warehouse ID |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
LINENUM |
string LINENUM |
Specify the item's line number or leave it blank for default. |
|
MTRL |
string Item |
Select an item or enter the item ID |
|
QTY |
string Quantity |
Specify the item's quantity |
|
PRICE |
string PRICE |
Specify the item's price |
|
DISC1PRC |
string Discount |
Specify the item's discount |
|
LINEVAL |
string LINEVAL |
Specify the item's line value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
LINENUM |
string LINENUM |
Specify the service's line number or leave it blank for default |
|
MTRL |
string
|
Select a service or enter the service ID |
|
QTY |
integer(int32)
|
Specify the service's quantity |
|
PRICE |
string PRICE |
Specify service's price |
|
DISC1PRC |
integer(int32)
|
Specify the service's discount |
|
LINEVAL |
string LINEVAL |
Specify the service's line value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
service |
string service |
service |
|
MODE |
string
|
|
|
appId |
string appId |
appId |
|
OBJECT |
string OBJECT |
OBJECT |
|
KEY |
string KEY |
Enter a valid service record ID to modify it |
|
FORM |
string FORM |
Specify service's form |
|
data |
|
The data object of the request |
Summary:
Description: The data object of the request
Properties:
|
Name |
Type |
Summary |
|
SERVICE |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
CODE |
string Code |
Insert a service code |
|
NAME |
string Name |
Specify the service's name |
|
VAT |
string Vat Group |
Select the service's Value Added Tax group or enter the Vat ID |
|
MTRUNIT1 |
string Base unit of measure |
Select the service's U.o.M or enter the U.o.M ID |
|
MTRCATEGORY |
string Commercial category |
Specify the service's commercial category |
|
MTRGROUP |
string Service group |
Select the service's group or enter the service's group ID |
|
PRICEW |
string Wholesale price |
Specify the service's wholesale price |
|
PRICER |
string Retail price |
Specify the service's retail price |
|
SODISCOUNT |
string Discount1 |
Specify the service's discount |
|
REMARKS |
string Comments |
Insert comments |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
APPID |
integer(int32)
|
APPID |
|
SERVICE |
string
|
SERVICE |
|
MODE |
string
|
|
|
OBJECT |
string
|
OBJECT |
|
KEY |
string
|
Enter a valid email record ID to modify it |
|
FORM |
string
|
Specify the form of the email |
|
DATA |
|
The data object of the request |
Summary:
Description: The data object of the request
Properties:
|
Name |
Type |
Summary |
|
SOACTION |
|
|
|
SOMAIL |
|
|
|
XTRDOCDATA |
array of (XTRDOCDATAItem)
|
Specify an Attached items array |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
SERIES |
string
|
Select the Series of the E-mail or enter the Series ID |
|
TRNDATE |
string(date-time)
|
Specify the E-mail Date in YYYY-MM-DD format, or leave it blank for today |
|
COMMENTS |
string
|
Specify the subject of the mail |
|
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') Values: [0, 1, 2, 3, 4, 5, 6] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
FROMADDRESS |
string
|
Email address to send mail from (requires "Send as" or "Send on behalf of" permission for that mailbox) |
|
FROMNAME |
string
|
Specify the mailbox's owner and sender's name |
|
SOTO |
string
|
Specify email addresses separated by semicolons like someone@softone.gr |
|
SOCC |
string
|
Specify email addresses separated by semicolons like someone@softone.gr |
|
SOBCC |
string
|
Specify email addresses separated by semicolons like someone@softone.gr |
|
SOBODY |
string
|
Specify the body of the mail |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
LINENUM |
string LINENUM |
Specify the line No. of the attached item |
|
NAME |
string Name |
Specify the file name of the attached item |
|
SOFNAME |
string Url |
Specify the url address of the attached item |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
APPID |
integer(int32)
|
APPID |
|
SERVICE |
string
|
SERVICE |
|
MODE |
string
|
|
|
OBJECT |
string
|
OBJECT |
|
KEY |
string
|
Enter a valid task record ID to modify it |
|
FORM |
string
|
Specify the task's form |
|
DATA |
|
The data object of the request |
Summary:
Description: The data object of the request
Properties:
|
Name |
Type |
Summary |
|
SOACTION |
|
|
|
XTRDOCDATA |
array of (XTRDOCDATAItem)
|
Specify an Attached items array |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
SERIES |
string
|
Select the Series of the Task or enter the Series ID |
|
COMMENTS |
string
|
Specify the subject of the task |
|
TRDR |
string
|
Select the customer or enter the customer ID |
|
TRNDATE |
string(date-time)
|
Specify the date the task was created in YYYY-MM-DD format, or leave it blank for today |
|
FROMDATE |
string
|
Specify the date the task was created in YYYY-MM-DD format, or leave it blank for today |
|
FINALDATE |
string
|
Specify the due date of the task in YYYY-MM-DD format, or leave it blank for today |
|
PRIORITY |
string Priority |
Select priority or enter a valid priority ID |
|
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') Values: [0, 1, 2, 3, 4, 5, 6] |
|
PRJC |
string Project |
Select the project or enter the project ID |
|
ORDEREDBY |
string Ordered By |
Select the orderer or enter the orderer ID |
|
ORDPRSN |
string Ordered By Contact |
Select the contact of the orderer or enter the contact ID |
|
ACTOR |
string Operator |
Select the operator or enter the operator ID |
|
ACTPRSN |
string Operator contact |
Select the contact of the operator or enter the contact ID |
|
REMARKS |
string
|
Insert comments |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
LINENUM |
string LINENUM |
Specify the line No. of the attached item |
|
NAME |
string Name |
Specify the file name of the attached item |
|
SOFNAME |
string Url |
Specify the url address of the attached item |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
APPID |
integer(int32)
|
APPID |
|
SERVICE |
string
|
SERVICE |
|
MODE |
string
|
|
|
OBJECT |
string
|
OBJECT |
|
KEY |
string
|
Enter a valid supplier ID to modify it |
|
FORM |
string
|
Specify supplier's form |
|
DATA |
|
The data object of the request |
Summary:
Description: The data object of the request
Properties:
|
Name |
Type |
Summary |
|
SUPPLIER |
|
|
|
SUPBANKACC |
array of (SUPBANKACCItem)
|
Bank accounts data array |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
CODE |
string
|
Insert a supplier code |
|
NAME |
string
|
Specify the name of the supplier |
|
JOBTYPETRD |
string
|
Specify the profession of the supplier |
|
ADDRESS |
string
|
Specify the primary address of the supplier |
|
DISTRICT |
string
|
Specify the location area of the supplier |
|
PHONE01 |
string
|
Specify the primary telephone number of the supplier |
|
AFM |
string
|
Specify the tax registration number of the supplier |
|
|
string
|
Specify the email address of the supplier |
|
CITY |
string
|
Specify the city of the supplier |
|
ZIP |
string
|
Specify the zip code of the supplier |
|
FAX |
string
|
Specify the fax number of the supplier |
|
IRSDATA |
string
|
Select the tax office of the supplier |
|
REMARKS |
string
|
Insert comments |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
BANK |
string
|
Select a bank |
|
IBAN |
string
|
Insert International Bank Account number |
|
REMARKS |
string
|
Insert comments for this bank account |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
object |
string object |
Select an object that triggers this operation Values: [Cheque, Collections document, Contacts, Customer, Draft entry, Email, Expenses, Expenses document, Meeting, Item, Payments document, Projects, Purchases document, Sales document, Services, Stock document, Supplier, Task] |
|
condition |
string Condition |
Specify a condition |
|
config |
config |
config |
|
event |
string Event |
Specify an event |
Summary: config
Description: config
Properties:
|
Name |
Type |
Summary |
|
url |
string url |
url |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
object |
string object |
Select an object that triggers this operation Values: [Cheque, Collections document, Contacts, Customer, Draft entry, Email, Expenses, Expenses document, Meeting, Item, Payments document, Projects, Purchases document, Sales document, Services, Stock document, Supplier, Task] |
|
condition |
string Condition |
Specify a condition |
|
config |
config |
config |
|
event |
string Event |
Specify an event |
Summary: config
Description: config
Properties:
|
Name |
Type |
Summary |
|
url |
string url |
url |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
object |
string object |
Select an object that triggers this operation Values: [Cheque, Collections document, Contacts, Customer, Draft entry, Email, Expenses, Expenses document, Meeting, Item, Payments document, Projects, Purchases document, Sales document, Services, Stock document, Supplier, Task] |
|
condition |
string Condition |
Specify a condition |
|
config |
config |
config |
|
event |
string Event |
Specify an event |
Summary: config
Description: config
Properties:
|
Name |
Type |
Summary |
|
url |
string url |
url |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
object |
string object |
Select an object that triggers this operation Values: [Cheque, Collections document, Contacts, Customer, Draft entry, Email, Expenses, Expenses document, Meeting, Item, Payments document, Projects, Purchases document, Sales document, Services, Stock document, Supplier, Task] |
|
condition |
string Condition |
Specify a condition |
|
config |
config |
config |
|
event |
string Event |
Specify an event |
Summary: config
Description: config
Properties:
|
Name |
Type |
Summary |
|
url |
string url |
url |