Forma de Pagamento

O endpoint PostAddPaymentMethod é responsável pelo cadastro de uma nova forma de pagamento no sistema MIMS.

---

Como cadastrar uma forma de pagamento

Request HTTP Post

Tipo da Requisição	URL Exemplo
POST	{{url_base}}/PostAddPaymentMethod
Exemplo	http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddPaymentMethod"

Parâmetros de Entrada

Parâmetro	Tipo	Obrigatório	Descrição
PaymentMethodNo	String(25)	Sim	Código externo da forma de pagamento
DescriptionPayment	String(40)	Sim	Descrição da forma de pagamento
InstallmentQty	Integer	Sim	Quantidade de parcelas
ToleranceDays	Integer	Não	Dias de tolerância
TolerancePercent	Float	Não	Percentual de tolerância
IsInactive	Boolean	Não	Flag que indica que a forma de pagamento está inativa
ItemList	AddPaymentMethodItemList	Sim	Lista de parcelas da forma de pagamento
OverwriteIfExists	Boolean	Não	Flag que indica que os dados devem ser sobrescritos caso o registro já exista

📝 Objeto AddPaymentMethodItemList

O objeto AddPaymentMethodItemList representa uma lista com as parcelas da forma de pagamento.

Parâmetros de Entrada

Parâmetro	Tipo	Obrigatório	Descrição
InstallmentNo	Integer	Sim	Número da parcela
InstallmentPercent	Float	Sim	Percentual da parcela
Days	Integer	Não	Dias para pagamento da parcela

---

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
PaymentMethodCode	Integer	Sim	Código interno da forma de pagamento gerado no sistema MIMS

---

Exemplo de Request

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddPaymentMethod"' \
--header 'Content-Type: application/json' \
--data '{
    "PaymentMethodNo": "PM001",
    "DescriptionPayment": "Pagamento à Vista",
    "IsInactive": false,
    "InstallmentQty": 1,
    "ToleranceDays": 0,
    "TolerancePercent": 0,
    "OverwriteIfExists": true,
    "ItemList": [
        {
            "InstallmentNo": 1,
            "InstallmentPercent": 100.0,
            "Days": 0
        }
    ]
}'

---

Exemplo de Response

{
    "WebServiceReturn": {
        "Status": "wrsSuccess",
        "ErrorCode": "",
        "Message": "",
        "Actor": "",
        "ReturnQuestion": null
    },
    "PaymentMethodCode": 123
}

---

🐞 Possíveis Erros

Código	Mensagem
APM‑001	Parâmetro Código Externo da Forma de Pagamento (PaymentMethodNo) informado já existe!

---