-
Web Service URL: https://[SERVER_ADDRESS]/ContractsWS/ContractsData.asmx
-
MPS Versão: A partir da 5.5.0
Descrição
Este método retorna os dados de fechamento completos por impressora, modelo e medidores.
Sintaxe
public string RetrieveClosingFullDataByPrinter(string properties)
Montagem das propriedades
O conteúdo de string properties deve ser um texto em formato JSON contendo as propriedades abaixo. Por exemplo:
{"DealerName":"dealer","DealerUserEmail":"user@example.com","DealerUserPassword":"k1BAv1w=="}
Não é necessário se preocupar com nomes de propriedades maiúsculos ou minúsculos, o Web Service é Case-Insensitive.
Propriedades aceitas pelo método
|
Propriedade |
Tipo |
Obrigatório |
Permite nulo |
Permite vazio |
Tamanho máximo |
Descrição |
|
DealerName |
Texto |
Sim |
- |
- |
- |
Nome do provedor |
|
DealerUserEmail |
Texto |
Sim |
- |
- |
- |
E-mail do usuário do provedor |
|
DealerUserPassword |
Texto |
Sim |
- |
- |
- |
Senha do usuário criptografada |
|
ClosingID |
Número |
Sim |
- |
- |
- |
Número identificador do fechamento |
|
FieldsList |
Texto |
Não |
Sim |
Sim |
- |
Lista dos campos que serão retornados pelo método. Devem ser especificados separando-os pelo caractere ‘;’. Exemplo: PrinterName;ModelName;SerialNumber |
Campos de retorno reconhecidos em FieldsList
|
Nome do campo |
Descrição |
|
PrinterName |
Nome da impressora |
|
BrandName |
Nome do fabricante |
|
ModelName |
Nome do modelo da impressora |
|
SerialNumber |
Número de série da impressora |
|
AddressName |
IP da impressora |
|
AssetNumber |
Número do patrimônio definido para a impressora |
|
SiteName |
Nome do site qual a impressora pertence |
|
SiteDivisionName |
Nome do departamento qual a impressora pertence (vazio para impressoras que estão sem departamento) |
|
FullPrinterName |
Nome de exibição da impressora no MPS |
|
ServiceName |
Nome do serviço de impressão que foi calculado no fechamento |
|
ClosingStartDate |
Data de inicio do período do fechamento |
|
ClosingFinishDate |
Data de fim do período do fechamento |
|
StarterReadingDate |
Data inicial dentro do intervalo base onde foi encontrado os dados do medidor inicial |
|
LatterReadingDate |
Medidor final encontrado para este intervalo |
|
StarterBaseNumber |
Data base de início deste intervalo da impressora no fechamento |
|
LatterBaseNumber |
Data base de fim deste intervalo da impressora no fechamento |
|
ServiceVolume |
Volume de páginas do serviço de impressão |
|
AprovingAccount |
Nome do usuário que confirmou os dados de fechamento da impressora |
|
AprovingComment |
Comentário do usuário sobre a confirmação da impressora nesse fechamento |
|
AprovingEmail |
E-mail do usuário que confirmou a impressora |
|
ServiceCost |
Valor gerado para o serviço de impressão |
|
Purged |
Indica se a impressora foi expurgada do fechamento, retorna true ou false |
|
FixedCost |
Valor do aluguel da impressora |
|
ExtraCostDescription |
Descrição do custo extra que está sendo cobrado ou descontado da impressora nesse fechamento |
|
ExtraCost |
Valor extra sendo cobrado ou descontado |
|
Locked |
Indica se a impressora está confirmada no fechamento, retorna true ou false |
Clique aqui para saber mais sobre o formato dos retornos.
Possíveis erros retornados
Clique aqui para verificar os possíveis erros que podem ser retornados e conhecer seus motivos.
Restrições
Para executar este método, o usuário informado precisa ser Administrador no provedor.