Pular para o conteúdo principal

Financeiro de Cliente

O endpoint PostAddCustomerFinancial é responsável pelo cadastro das informações financeiras de um cliente no sistema MIMS.


Como cadastrar informações financeiras de um cliente

Request HTTP Post

Tipo da RequisiçãoURL Exemplo
POST{{url_base}}/PostAddCustomerFinancial
Exemplohttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddCustomerFinancial"

Parâmetros de Entrada

ParâmetroTipoObrigatórioDescrição
CustomerNoString(25)SimCódigo externo do cliente
CustomerAuxiliaryNoString(25)NãoCódigo externo auxiliar do cliente
BranchNoString(25)NãoCódigo externo da filial
CreditTotalFloatNãoValor do crédito total do cliente
CreditUsageFloatNãoValor do crédito utilizado pelo cliente (deve ser maior ou igual a zero)
CreditEspecialFloatNãoValor do crédito especial do cliente
CreditEspecialUsageFloatNãoValor do crédito especial utilizado pelo cliente
CreditDisponibleFloatNãoValor do crédito disponível do cliente (deve ser maior ou igual a zero)
OpenDocumentsIntegerNãoQuantidade de documentos em aberto
OverdueDocumentsIntegerNãoQuantidade de documentos vencidos
OverdueDocumentsTotalFloatNãoValor total dos documentos vencidos
LastDocumentPaymentDateDataHoraNãoData do último pagamento de documento
LastDocumentPaymentNoString(40)NãoNúmero do último documento pago
NextDocumentPaymentDateDataHoraNãoData do próximo pagamento de documento
NextDocumentPaymentNoString(40)NãoNúmero do próximo documento a pagar
CustomerSinceDataHoraNãoData desde quando o cliente é cliente
CheckBlocksActiveCheckBlocksActiveNãoTipo de bloqueio ativo: ckNotAssigned (Não atribuido), ckDelay (Bloqueio por atraso), ckInsufficientCredit (Bloqueio por crédito insuficiente) ou ckBoth (Bloqueio por atraso e crédito insuficiente)
OverwriteIfExistsBooleanNãoFlag que indica que os dados devem ser sobrescritos caso o registro já exista

Retorno

ParâmetroTipoObrigatórioDescrição
WebServiceReturnWebServiceReturnSimInformações padrão de resposta do WebService na execução do método
CustomerFinancialCodeIntegerSimCódigo interno do financeiro do cliente gerado no sistema MIMS

Exemplo de Request

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddCustomerFinancial"' \
--header 'Content-Type: application/json' \
--data '{
"CustomerNo": "CUST001",
"CustomerAuxiliaryNo": "",
"BranchNo": "FIL001",
"CreditTotal": 10000.00,
"CreditUsage": 2500.00,
"CreditEspecial": 5000.00,
"CreditEspecialUsage": 0.00,
"CreditDisponible": 7500.00,
"OpenDocuments": 5,
"OverdueDocuments": 2,
"OverdueDocumentsTotal": 1500.00,
"LastDocumentPaymentDate": "2024-01-10T00:00:00",
"LastDocumentPaymentNo": "DOC001",
"NextDocumentPaymentDate": "2024-02-15T00:00:00",
"NextDocumentPaymentNo": "DOC002",
"CustomerSince": "2020-01-01T00:00:00",
"CheckBlocksActive": "ckNotAssigned",
"OverwriteIfExists": true
}'

Exemplo de Response

{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
},
"CustomerFinancialCode": 789
}

🐞 Possíveis Erros

CódigoMensagem
ACT‑004Parâmetro "CustomerFinancial" informado já existe para este "CustomerNo"!