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ção | URL Exemplo |
|---|---|
| POST | {{url_base}}/PostAddCustomerFinancial |
| Exemplo | http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddCustomerFinancial" |
Parâmetros de Entrada
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| CustomerNo | String(25) | Sim | Código externo do cliente |
| CustomerAuxiliaryNo | String(25) | Não | Código externo auxiliar do cliente |
| BranchNo | String(25) | Não | Código externo da filial |
| CreditTotal | Float | Não | Valor do crédito total do cliente |
| CreditUsage | Float | Não | Valor do crédito utilizado pelo cliente (deve ser maior ou igual a zero) |
| CreditEspecial | Float | Não | Valor do crédito especial do cliente |
| CreditEspecialUsage | Float | Não | Valor do crédito especial utilizado pelo cliente |
| CreditDisponible | Float | Não | Valor do crédito disponível do cliente (deve ser maior ou igual a zero) |
| OpenDocuments | Integer | Não | Quantidade de documentos em aberto |
| OverdueDocuments | Integer | Não | Quantidade de documentos vencidos |
| OverdueDocumentsTotal | Float | Não | Valor total dos documentos vencidos |
| LastDocumentPaymentDate | DataHora | Não | Data do último pagamento de documento |
| LastDocumentPaymentNo | String(40) | Não | Número do último documento pago |
| NextDocumentPaymentDate | DataHora | Não | Data do próximo pagamento de documento |
| NextDocumentPaymentNo | String(40) | Não | Número do próximo documento a pagar |
| CustomerSince | DataHora | Não | Data desde quando o cliente é cliente |
| CheckBlocksActive | CheckBlocksActive | Não | Tipo 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) |
| OverwriteIfExists | Boolean | Não | Flag que indica que os dados devem ser sobrescritos caso o registro já exista |
Retorno
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| WebServiceReturn | WebServiceReturn | Sim | Informações padrão de resposta do WebService na execução do método |
| CustomerFinancialCode | Integer | Sim | Có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ódigo | Mensagem |
|---|---|
| ACT‑004 | Parâmetro "CustomerFinancial" informado já existe para este "CustomerNo"! |