Function: docflow_connection
Result: the list of elements
Document flow
Access level: admin
- id — Id
- company — Company
- module — Connection module
Delete
Function: docflow_connection.delete
Delete
Access level: admin
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of docflow_connection function.
Result: successful operation or error message
Send the documents from the queue and get statuses of already sent documents
Function: docflow_connection.doc_sync
Send the documents from the queue and get statuses of already sent documents
Access level: admin
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of docflow_connection function.
Result: successful operation or error message
Payer
Function: docflow_connection.counteragent
Result: the list of elements
List of contracting parties
Access level: admin
- id — Id
- name — Payer
- vatnum — INN
- status — Status
Suspend
Function: docflow_connection.counteragent.suspend
Suspend
Access level: admin
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of docflow_connection.counteragent function.
Result: successful operation or error message
Resume
Function: docflow_connection.counteragent.resume
Resume
Access level: admin
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of docflow_connection.counteragent function.
Result: successful operation or error message
Function: docflow_connection.counteragent.docflow_box
Access level: admin
Uploading list of contracting parties
Function: docflow_connection.customer_search_all
Access level: admin
The function is simultaneously used to view object's parameters, to change an object, and create new one.
View object's parameters:
- Parameters:
- plid — parent list unique identifier (id element of docflow_connection function).
- elid — unique identifier (id element of docflow_connection.counteragent function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of docflow_connection function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of docflow_connection function).
- elid — unique identifier (id element of docflow_connection.counteragent function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
Update the list
Function: docflow_connection.customer_sync_all
Access level: admin
The function is simultaneously used to view object's parameters, to change an object, and create new one.
View object's parameters:
- Parameters:
- plid — parent list unique identifier (id element of docflow_connection function).
- elid — unique identifier (id element of docflow_connection.counteragent function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of docflow_connection function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of docflow_connection function).
- elid — unique identifier (id element of docflow_connection.counteragent function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
Name
Function: docflow_connection.docflow_box
Result: the list of elements
Boxes
Access level: admin
- id — Id
- name — Name
- box_id — Box Id
- status — Status
Resume
Function: docflow_connection.docflow_box.resume
Resume
Access level: admin
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of docflow_connection.docflow_box function.
Result: successful operation or error message
Edit the selected connection
Function: docflow_connection.edit
Access level: admin
The function is simultaneously used to view object's parameters, to change an object, and create new one.
View object's parameters:
- Parameters:
- elid — unique identifier (id element of docflow_connection function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (id element of docflow_connection function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- profile — Company. Company connected to the electronic document management system
- module — Connection module. You can use this module to connect the electronic document management system
- document_type — Document type . Select what type of documents will be sent by default
- group_items — . (Optional parameter. To enable the option click "on".) Positions will be grouped by tariff plan, payment period, and item amount.
- autoassign — . (Optional parameter. To enable the option click "on".) Search for a payer in the electronic document system when assigning to the company
Add
Function: docflow_connection.add
Add
Access level: admin