-
Web Service URL: https://[SERVER_ADDRESS]/ContractsWS/ContractsData.asmx
-
MPS Version: Starting from 5.5.0
Description
Returns the list of closings for the specified contract.
Syntax
public string RetrieveClosings(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 |
|
ContractID |
Number |
Yes |
- |
- |
- |
Contract identifier number. Obtained using the RetrieveContracts method. |
Return fields
|
Field name |
Description |
|
ClosingID |
Identify closure |
|
ClosingAlias |
Reference month |
|
ClosingStartDate |
Closure start date |
|
ClosingFinishDate |
Closure end date |
|
Frozen |
1 for frozen closure and 0 for closure under review or verification |
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.