-
Web Service URL: https://[SERVER_ADDRESS]/ContractsWS/ContractsData.asmx
-
MPS Version: Starting from 5.5.0
Description
This method returns closing data by volume per printer.
Syntax
public string RetrieveClosingConsolidatedByPrinterAndVolume(string properties)
Assembling properties
The content of string properties must be text in JSON format containing the properties below. For example:
{"DealerName":"dealer","DealerUserEmail":"user@example.com","DealerUserPassword":"k1BAv1w=="}
There is no need to worry about uppercase or lowercase property names, as the Web Service is Case-Insensitive.
Properties accepted by the method
|
Property |
Type |
Required |
Allows null |
Allows empty |
Maximum size |
Description |
|
DealerName |
Text |
Yes |
- |
- |
- |
Provider name |
|
DealerUserEmail |
Text |
Yes |
- |
- |
- |
Provider user email |
|
DealerUserPassword |
Text |
Yes |
- |
- |
- |
Encrypted user password |
|
ClosingID |
Number |
Yes |
- |
- |
- |
Closing identifier number |
|
FieldsList |
Text |
No |
Yes |
Yes |
- |
List of fields that will be returned by the method. They must be specified separated by the character ‘;’. Example: PrinterName;ModelName;SerialNumbe |
Recognized return fields in FieldsList
|
Field name |
Description |
|
PrinterName |
Printer name |
|
BrandName |
Manufacturer name |
|
ModelName |
Printer model name |
|
SerialNumber |
Printer serial number |
|
AddressName |
Printer IP address |
|
AssetNumber |
Asset number defined for the printer |
|
SiteName |
Name of the site to which the printer belongs |
|
SiteDivisionName |
Name of the department to which the printer belongs (blank for printers that do not belong to a department) |
|
FullPrinterName |
Display name of the printer in MPS |
|
ServiceName |
Name of the print service that was calculated at closing |
|
ClosingStartDate |
Start date of the closing period |
|
ClosingFinishDate |
End date of the closing period |
|
StarterReadingDate |
Start date within the base interval where the initial meter data was found |
|
LatterReadingDate |
End date within the base interval where the final meter data was found |
|
ServiceVolume |
Number of pages for the printing service |
|
AprovingAccount |
Name of the user who confirmed the printer closing data |
|
AprovingComment |
User comment on the printer confirmation in this closing |
|
AprovingEmail |
Email address of the user who confirmed the printer |
|
ServiceCost |
Value generated for the printing service |
|
Purged |
Name of the user who confirmed the printer closing data |
|
FixedCost |
Printer rental value |
|
ExtraCostDescription |
Description of the extra cost being charged or discounted for the printer in this closing |
|
ExtraCost |
Extra amount being charged or discounted |
|
Locked |
Indicates whether the printer is confirmed in the closing, returns true or false |
Click here to learn more about the format of the returns.
Possible errors returned
Click here to check the possible errors that may be returned and learn about their reasons.
Restrictions
To execute this method, the user must be an Administrator on the provider.