Payers (profile)

profile

Result: list of elements

UI Equivalent: go to Clients → Payers in the left platform menu.

Displays the list of payers.

Access level: admin, user

Parameter	Type	Required	Value
`id`	Integer	No	Unique payer identifier.
`name`	String	No	Payer name.
`account`	Integer	No	Client to which the payer belongs.
`profiletype`	String (enumeration)	No	Legal status of the payer. Accepts values: `1` — individual; `2` — legal entity; `3` — sole proprietor.
`status`	String (enumeration)	No	Current state. Accepts values: `on` — active; `off` — disabled.

Create a payer

Function: profile.add

Result: successful operation or error message

UI Equivalent: in the client account → go to Client → Payers → click Add. Note: This button is not available in the administrator account.

Access level: user

Parameter Type Required Value

country Integer Yes Payer country. Value must be one of the predefined directory entries..

Parameter	Type	Required	Value
`country`	Integer	Yes	Payer country. Value must be one of the predefined directory entries..
`profiletype`	String (enumeration)	Yes	Legal status of the payer. Accepts values: `1` — individual; `2` — legal entity; `3` — sole proprietor.
`sok`	String	Yes	Value `ok` confirms the operation.

profiletype

String (enumeration)

Yes

Legal status of the payer. Accepts values:

1 — individual;
2 — legal entity;
3 — sole proprietor.

sok String Yes Value ok confirms the operation.

Edit a payer

Function: profile.edit

Result: successful operation or error message

UI Equivalent: go to Client → Payers → select a payer → click Edit.

Used to view and modify object parameters.

Access level: admin, user

Parameter	Type	Required	Value
`elid`	Integer	No	Unique payer identifier.
`profiletype`	String (enumeration)	No	Legal status of the payer. Accepts values: `1` — individual; `2` — legal entity; `3` — sole proprietor. Default value: 2.
`name`	String	No	Payer name.
`person`	String	Yes	Contact person.
`phone`	String	No	Contact phone number.
`fax`	String	No	Fax number.
`email`	String	No	Primary company email.
`maildocs`	String (list)	No	Method of receiving original financial documents. Multiple values are specified via comma. Default value: `0`.
`docflow_box`	String	No	Mailbox for incoming documents.
`docflow_department`	String	No	Department for incoming documents.
`document_type`	String (enumeration)	No	Type of documents sent via the electronic document flow system. Accepts values: `1` — certificate of completed works; `2` — universal transfer document.
`id1c`	String	No	Code for integration with accounting system.
`invoicetype`	String (enumeration)	No	Method of generating certificates of completed works. Accepts values: `0` — based on expenses after payment; `1` — automatically based on advance payments; `2` — based on unpaid expenses; `3` — based on all expenses. Default value: `0`.
`postcompany`	String	No	Company on whose behalf the certificate will be issued.
`postcurrency`	String	No	Currency in which the certificate will be issued.
`invoicedesc`	String	No	Description of services for automatic certificate generation.
`payment_description`	String	No	Purpose of advance payment in the payment list.
`note`	String	No	Comment for the payer.
`wrongaddress`	Flag	No	Indicator of returned sent correspondence. Value `on` enables the option.
`returnreason`	String	No	Reason for correspondence return.
`country_legal`	Integer	No	Country of company registration. Value must be one of the predefined directory entries..
`state_legal`	Integer	No	Region of company registration. Value must be one of the predefined directory entries..
`postcode_legal`	String	Yes	Postal code for the company registration address.
`city_legal`	String	Yes	City of company registration.
`address_legal`	String	Yes	Registration address of the company (street, building, office).
`legaleqphysical`	Flag	No	Specify value `on` if physical and legal addresses match
`country_physical`	Integer	Yes	Country of physical location. Value must be one of the predefined directory entries..
`state_physical`	Integer	Yes	Region of physical location. Value must be one of the predefined directory entries..
`postcode_physical`	String	Yes	Postal code for the physical address.
`city_physical`	String	Yes	City of physical location.
`address_physical`	String	Yes	Physical address (street, building, apartment or office).
`country`	Integer	No	Payer country. Value must be one of the predefined directory entries..
`sok`	String	Yes	Value `ok` confirms the operation.

Example execution

https://IP-address:1500/billmgr?country=5&func=profile.edit&offer_1=on&person=<contact>&sok=ok&profiletype=1&su=example@www.ru

Details

Delete a payer

Function: profile.delete

Result: successful operation or error message

UI Equivalent: go to Client → Payers → select a payer → click Delete.

Supports deletion of multiple payers via comma. Requires confirmation via parameter sok.

Access level: admin, user

Parameter	Type	Required	Value
`elid`	String (list)	Yes	One or several payer `id` values via comma. For example, `123,456`.
`sok`	String	Yes	Value `ok` confirms the operation.

Payer companies

Function: profile.company

Result: list of elements

UI Equivalent: go to Client → Payers → click Companies.

Links the client's payer to provider companies.

Access level: admin, user

Parameter	Type	Required	Value
`id`	Integer	No	Unique company identifier.
`name`	String	No	Company name.
`status`	String (enumeration)	No	Connection status. Accepts values: `on` — active; `off` — disabled.

Enable a company

Function: profile.company.resume

Result: successful operation or error message

UI Equivalent: go to Client → Payers → select a payer → click Companies → select a company → click Enable.

Access level: admin, user

Parameter	Type	Required	Value
`elid`	String (list)	Yes	Unique identifier (element `id` from function `profile.company`).

Disable a company

Function: profile.company.suspend

Result: successful operation or error message

UI Equivalent: go to Client → Payers → select a payer → click Companies → select a company → click Disable.

Access level: admin, user

Parameter	Type	Required	Value
`elid`	String (list)	Yes	Unique identifier (element `id` from function `profile.company`).

Other actions

Enable a payer

Function: profile.resume

Result: successful operation or error message

UI Equivalent: go to Client → Payers → select a payer → click Enable. The button is displayed if the payer is inactive and synchronization is not in progress.

Access level: admin+

Parameter	Type	Required	Value
`elid`	String (list)	Yes	Unique identifier (element `id` from function `profile`). Multiple `id` values are specified via comma.

Disable a payer

Function: profile.suspend

Result: successful operation or error message

UI Equivalent: go to Client → Payers → select a payer → click Disable. The button is displayed if the payer is active and synchronization is not in progress.

Access level: admin+

Parameter	Type	Required	Value
`elid`	String (list)	Yes	Unique identifier (element `id` from function `profile`). Multiple payer `id` values are specified via comma.

Check company connections

Function: profile.docflow

Result: successful operation or error message

UI Equivalent: go to Client → Payers → select a payer → click Search.

Searches for the payer in electronic document flow systems and checks for relationships with connected companies. The button is hidden if electronic document flow is not configured for the company.

Access level: admin+

Parameter	Type	Required	Value
`elid`	String (list)	Yes	Unique identifier (element `id` from function `profile`). Multiple `id` values are specified via comma.

Print envelope

Function: envelope.print

Result: successful operation or error message

UI Equivalent: go to Client → Payers → select a payer → click Envelope.

Allows printing an envelope with payer data.

Access level: admin, user

Parameter	Type	Required	Value
`elid`	Integer	Yes	`id` of the payer for envelope printing.

View payer parameter change history

Function: profile.history

Result: list of elements

UI Equivalent: go to Client → Payers → select a payer → click History.

Displays the change history for payer parameters

Access level: admin, user

Parameter	Type	Required	Value
`changedate`	Date and time	No	Change date. Format: `YYYY-MM-DD HH:MM:SS`.
`desc`	String	No	Change description.
`user`	String	No	User who performed the change.
`ip`	String	No	IP address from which the change was performed.
`action`	String	No	Function that triggered the change.

Write a request to the client

Function: ticket.write.profile

Result: successful operation or error message

UI Equivalent: go to Client → Payers → select a payer → click Ticket.

Opens a form for writing a request to the selected payer.

Access level: admin

Parameter	Type	Required	Value
`elid`	Integer	Yes	`id` of the payer for whom the request is created.

Set filter by client

Function: profile.setfilter

Result: successful operation or error message

UI Equivalent: go to Client → Payers → select a payer → click Filter by client.

Sets a filter by the selected client. Filter conditions are saved and applied to all subsequent profile calls until the filter is changed or reset.

Access level: admin

Parameter	Type	Required	Value
`account`	Integer	No	Filter by client.
`reset`	Flag	No	Value `on` resets all filters.

Log in to the panel with user rights

Function: profile.su

Result: successful operation or error message

UI Equivalent: go to Client → Payers → select a payer → click Log in.

Authorizes the administrator in the control panel with the rights of the selected payer.

Access level: admin

Parameter	Type	Required	Value
`elid`	Integer	Yes	`id` of the payer under whose rights the login is performed.