MIDAS API: mod_client

Modifies an existing client record.

Two sets of parameters are required (outlined in the tables below) - the first set controls which client(s) to modify, the second set specifies which parameters of the selected client(s) to modify.

Controlling which client(s) to modify

Required Parameters (at least 1 required)	Possible Values	Description
id	Client ID	The unique numerical id of the client (which can be determined from the "get_client" call) Passing this parameter will override all other required parameters in this table
client	String	The name of the existing client to be modified
org	String	Organization name
email	Email address	Email address
address	String	Postal/Mailing address
phone	Number	Telephone number
fax	Number	Fax number
mobile	Number	Mobile/Cell number
notes	String	Notes about the client
tax_exempt	0 | 1	Specifies whether the client is exempt from being charged tax on their invoices
credit	Number	[MIDAS v4.12+] Applies an initial amount of credit to the client. Client credit is then automatically applied to their subsequent invoices and decreased accordingly

To ensure that only a single client is modified, pass only the "id" parameter, or alternatively as many of the other above parameters as possible to ensure a specific individual client is modified, rather than a group of clients. For example, if you only pass the "org" parameter alone ALL clients in the database that match the organization name you supply will be modified. Whereas passing both the client name and the organization name will ensure that only client records that match BOTH will be modified. Passing "client_id" alone will ensure that only one client will be modified.

Setting new values

Required Parameters (at least 1 required)	Possible Values	Description
new_client	String	The new Client name
new_org	String	The new Organization name
new_email	Email address	The new Email address
new_address	String	The new Postal/Mailing address
new_phone	Number	The new Telephone number
new_fax	Number	The new Fax number
new_mobile	Number	The new Mobile/Cell number
new_notes	String	New notes about the client
new_tax_exempt	0 | 1	Specifies whether the client is exempt from being charged tax on their invoices
new_credit	Number	[MIDAS v4.12+] The new amount of credit to attach to the client

Omitting any of the above parameters will leave its current value unchanged. Passing any of the above parameters with a "blank" value will clear/delete the current value of the corresponding field.

Example Response

{ "clients_modified":"1" }

Variables Returned	Description
clients_modified	The number of clients modified