-
Web Service URL: https://[SERVER_ADDRESS]/ContractsWS/ContractsData.asmx
-
MPS Versão: A partir da 5.13.0
Descrição
Este método retorna os dados de custo extra do fechamento.
Sintaxe
public string RetrieveClosingExtraCost(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: ExtraCostDescription;ExtraCost |
Campos de retorno reconhecidos em FieldsList
|
Nome do campo |
Descrição |
|
ExtraCostDescription |
Descrição do custo extra que está sendo cobrado ou descontado do fechamento |
|
ExtraCost |
Valor extra sendo cobrado ou descontado |
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.