Function: company
Result: the list of elements
Companies
Access level: admin
- id — Id
- name — Name
Add
Function: company.add
Add
Access level: admin
Name
Function: company.project
Result: the list of elements
Providers associated with this company
Access level: admin
- id — Id
- name — Name
- status — Status
Resume
Function: company.project.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 company.project function.
Result: successful operation or error message
Suspend
Function: company.project.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 company.project function.
Result: successful operation or error message
Name
Function: company.contract
Result: the list of elements
Contracts
Access level: admin
- id — Id
- name — Name
- contracttype — Contract type
- doctmpl_name — Template
Name
Function: company.contract.appendix
Result: the list of elements
Examples of contract annexes
Access level: admin
- id — Id
- name — Name
- doctmpl_name -
Edit the selected annex
Function: company.contract.appendix.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:
- plid — parent list unique identifier (id element of company.contract function).
- elid — unique identifier (id element of company.contract.appendix 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 company.contract 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 company.contract function).
- elid — unique identifier (id element of company.contract.appendix function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- name — Name. Enter the name for the contract annex
- project — Provider. This annex will be generated, if a client has services of the selected type
- itemtype — Product type . This annex will be generated, if a client has services of the selected type
- nocheck — . (Optional parameter. To enable the option click "on".) Select the check box if you don't want the billing system to check that a client has this service before generating a contract appendix
- doctmpl — Template. Appendix template. You can add and modify it in the "Document templates" module
Delete
Function: company.contract.appendix.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 company.contract.appendix function.
Result: successful operation or error message
Edit the selected contract
Function: company.contract.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:
- plid — parent list unique identifier (id element of company function).
- elid — unique identifier (id element of company.contract 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 company 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 company function).
- elid — unique identifier (id element of company.contract function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- name — Contract type . Name of the contract example
- contracttype — Contract type . Select a contract type
- accepttype — User accepts offer . Select how you want your clients to read and accepts the offer
- itemtype — Product types. A client will be asked to sign a contract if he has the selected services
- accountgroup — Client groups. This contract will be available for the selected client group
- profiletype — Payer status. Select a payer status
- doctmpl — Contract template. Contract template. You can create and edit it in the "Document templates" module
- suffix — Contract number suffix . This suffix will be added to the contract number. The contract number is generated as follows: PAYER_ID + SUFFIX. E.g. payer id — 1, suffix — '/contract'. The contract number will look like '1/contract'
- start_date — Start date. The contract won't be generated automatically after this date
- end_date — Expiration date. After this date the contract won't be generated for clients
Delete
Function: company.contract.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 company.contract function.
Result: successful operation or error message
Delete
Function: company.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 company function.
Result: successful operation or error message
Edit company details
Function: company.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 company 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 company function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name — Name. Enter a company name
- email — Email. Enter the company's email
- www — Web-site URL. Enter the URL of the company's web-site. It can be used in print templates
- fax — Fax. Enter the fax number
- phone — Phone number. Enter the phone number
- payment_description — Purpose of advance payment. Enter a purpose of advance payments
- country_legal — Country. Select a contry where the company is registered
- state_legal — Region . Region where the company is registered
- postcode_legal — ZIP code. Enter the zip code of the company's registration address
- city_legal — City. Enter the city where the company is registered
- address_legal — Address. Enter address where the company is registered (including the street, building and office)
- country_physical — Country. Select a country where the company is located
- state_physical — Region . Region where the company is located
- postcode_physical — ZIP code. Enter the zip code of the city where this company is located
- city_physical — City. Enter the city where the company is located
- address_physical — Address. Enter address where the company is located (including the street, building and office)
- regdate — Foundation date. Enter the date when the company was founded
- locale — Documents localization. Language that is used for documents
- doctmpl_payment — Invoice template for payment. Template of the invoice that can be printed. It can be modified in the payment methods edit form
- numtmpl_payment — Invoice number template. Template of the invoice number. You can use the following macros: {id} — payment id and {num} — invoice numerical number. If both macros are not present, {num} will be used
- nextnum_payment — Next numerical number of the invoice. Enter the next numerical number of the payment. This value is taken into account only if you specified invoice number template and didn't specify a template in the payment method edit form
- doctmpl_invoice — Invoice template. Select an invoice print template
- numtmpl_invoice — Invoice number template. Invoice number template. You can use the macros {id} — invoice id, and {num} — invoice numerical order. If both macros are not present, the {num} macro will be used
- nextnum_invoice — Next order number of the invoice. Enter the next order number of the invoice
- doctmpl_envelope — Envelope template. Template of the envelope
- doctmpl_reconciliation — Reconciliation report template. Select a reconciliation report template. You can add or edit it in the "Document templates" module. If you do not select a template, your users won't be able to create a reconciliation report
- sendcostcurrency — Currency . Select currency of the cost of sending documents
- sendcost — Cost of sending documents . The cost of sending documents by post. The billing system will add a corresponding expense