Breadcrumbs

ContractsData

Introduction

The ContractsData Web Service provides features for managing Contracts within MPS.

The available features are described below so that MPS Portal customers can use these functions and integrate them into their systems.

  • WSDL: https://[SERVER_ADDRESS]/ContractsWS/ContractsData.asmx?wsdl

  • MPS Version: Starting with 5.5.0

Methods

Method

Description

RegisterContractPrinter

Creates a printer within the company's contract flow. If there is only one contract in the company, the printer will be automatically inserted into the contract. If the printer already exists and is in a contract flow, its asset number will be updated if provided. The printer contact will always be updated if provided.

RegisterPartnerPrinter

Register a printer in the provider's equipment list

RemoveContractPrinter

Removes a printer from the contract flow. If the printer is in a contract, it will only be removed from both if specified. The printer's movement history between contracts is also removed.

RemoveContractPrinterFromContract

Removes a printer from the contract without removing it from the flow. The printer's movement history between contracts is retained.

RetrieveClosingConsolidatedByPrintLocalAndVolume

Returns closing data by print location

RetrieveClosingConsolidatedByPrinterAndMeasurer

Returns closing data in meters per printer

RetrieveClosingConsolidatedByPrinterAndVolume

Returns closing data by volume per printer

RetrieveClosingExtraCost

Returns the extra cost data from the closing

RetrieveClosingFullDataByPrintLocations

Returns complete closing data by print location

RetrieveClosingFullDataByPrinter

Returns complete closing data by printer, model, and meters.

RetrieveClosings

Returns the list of closings for the specified contract

RetrieveContracts

Brings all contracts that are in the provider. Only returns contracts for which the user has permission in the specified company

RetrieveOutOfContractStatus

Returns the statuses registered by the provider that indicate situations where the equipment is outside of a contract

SetContractPrinterData

Updates data related to an existing contract printer. If the printer is not in the contract flow, it will be inserted into the flow.

SetContractPrinterToContract

Adds a printer that is already in a contract flow to a specific contract

SetGenerateClosingDataQueue

Adds the request to recalculate the data from the last active contract closing to the queue

System example

Click here to get the sample tool, which uses the methods described above.