Consulta de Condições de Pagamentos – GET

Filtros


Atalhos para busca

Objetivo

A finalidade deste método é permitir consultar condições de pagamentos.

Chamada

GET api/v1/sm/payment-condition?NUMBER_PAYMENT_CONDITION={NUMBER_PAYMENT_CONDITION}&LAST_UPDATE_DATE={LAST_UPDATE_DATE}&STATUS={STATUS}&USES_SFA={USES_SFA}&_pageNo={_pageNo}&_pageSize={_pageSize}

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Nome (Name) Descrição (Description) Tipo (Type) Informações Adicionais (Adittional Information)
number_payment_condition Number Payment Condition – (000) – (Optional) integer Não há.
last_update_date Update Date – (Optional) – (dd/MM/aaaa hh:mm or ddMMaaaahhmm) – Note: Will be considerate update date of all commercial informations, including the lists. string Não há.
status Payment Condition Status – (A = Active or I = Inactive) – (Optional – Default = “A”) string Não há.
uses_SFA Uses Sales Force Automation (‘S’ – Yes, ‘N’ – No) string String length: inclusive between 0 and 1
_pageNo integer Não há.
_pageSize integer Não há.

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • OK (200)
  • NotFound (404)
  • BadRequest (400)
  • Unauthorized (401)
  • InternalServerError (500)

Descrição do Recurso (Resource Description)

PaymentConditionResponseDTO – List of Payment Conditions

Collection of PaymentConditionResponseDTO

Nome (Name) Descrição (Description) Tipo (Type) Informações Adicionais (Adittional Information)
average_payment_plan_period Average Payment Plan Period decimal number Não há.
description_payment_condition Description of Payment Condition string Não há.
fixed_due_date_1 Fixed Due Date date Não há.
fixed_due_date_2 Fixed Due Date date Não há.
fixed_due_date_3 Fixed Due Date date Não há.
last_update_date LesT Update Date from Payment Condition date Não há.
number_days_payment_term_1 Number of Days of Payment Term – (1st Installment) integer Não há.
number_days_payment_term_2 Number of Days of Payment Term – (2nd Installment) integer Não há.
number_days_payment_term_3 Number of Days of Payment Term – (3rd Installment) integer Não há.
number_days_payment_term_4 Number of Days of Payment Term – (4th Installment) integer Não há.
number_days_payment_term_5 Number of Days of Payment Term – (5th Installment) integer Não há.
number_days_payment_term_6 Number of Days of Payment Term – (6th Installment) integer Não há.
number_days_payment_term_7 Number of Days of Payment Term – (7th Installment) integer Não há.
number_days_payment_term_8 Number of Days of Payment Term – (8th Installment) integer Não há.
number_days_payment_term_9 Number of Days of Payment Term – (9th Installment) integer Não há.
number_days_payment_term_10 Number of Days of Payment Term – (10th Installment) integer Não há.
number_days_payment_term_11 Number of Days of Payment Term – (11th Installment) integer Não há.
number_days_payment_term_12 Number of Days of Payment Term – (12th Installment) integer Não há.
number_installments Number of Installments integer Não há.
number_payment_condition Number of Payment Condition integer Não há.
type_installment Type of Installment – C = Customized, M = Monthly, F = Flexible, T = Fixed Day, V = Variable string Não há.
type_payment_term Type of Payment Term – N = Normal, G = Negotiated, I = Inactive, B = Bonus string Não há.
type_sale Type of Sale – VP = Sale on Time, VV = Sale at Sight string Não há.

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

[
  {
    "average_payment_plan_period": 1.1,
    "description_payment_condition": "sample string 3",
    "fixed_due_date_1": "2019-11-22T15:55:22.8558405-03:00",
    "fixed_due_date_2": "2019-11-22T15:55:22.8558405-03:00",
    "fixed_due_date_3": "2019-11-22T15:55:22.8558405-03:00",
    "last_update_date": "2019-11-22T15:55:22.8558405-03:00",
    "number_days_payment_term_1": 1,
    "number_days_payment_term_2": 1,
    "number_days_payment_term_3": 1,
    "number_days_payment_term_4": 1,
    "number_days_payment_term_5": 1,
    "number_days_payment_term_6": 1,
    "number_days_payment_term_7": 1,
    "number_days_payment_term_8": 1,
    "number_days_payment_term_9": 1,
    "number_days_payment_term_10": 1,
    "number_days_payment_term_11": 1,
    "number_days_payment_term_12": 1,
    "number_installments": 1,
    "number_payment_condition": 5,
    "type_installment": "sample string 6",
    "type_payment_term": "sample string 7",
    "type_sale": "sample string 8"
  },
  {
    "average_payment_plan_period": 1.1,
    "description_payment_condition": "sample string 3",
    "fixed_due_date_1": "2019-11-22T15:55:22.8558405-03:00",
    "fixed_due_date_2": "2019-11-22T15:55:22.8558405-03:00",
    "fixed_due_date_3": "2019-11-22T15:55:22.8558405-03:00",
    "last_update_date": "2019-11-22T15:55:22.8558405-03:00",
    "number_days_payment_term_1": 1,
    "number_days_payment_term_2": 1,
    "number_days_payment_term_3": 1,
    "number_days_payment_term_4": 1,
    "number_days_payment_term_5": 1,
    "number_days_payment_term_6": 1,
    "number_days_payment_term_7": 1,
    "number_days_payment_term_8": 1,
    "number_days_payment_term_9": 1,
    "number_days_payment_term_10": 1,
    "number_days_payment_term_11": 1,
    "number_days_payment_term_12": 1,
    "number_installments": 1,
    "number_payment_condition": 5,
    "type_installment": "sample string 6",
    "type_payment_term": "sample string 7",
    "type_sale": "sample string 8"
  }
]
application/xml, text/xml 

Exemplo (Sample):

<ArrayOfPaymentConditionResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="http://schemas.datacontract.org/2004/07/Consinco.SM.Api.Entities.Entities.v1.Common">
  <PaymentConditionResponseDTO>
    <AVERAGE_PAYMENT_PLAN_PERIOD>1.1</AVERAGE_PAYMENT_PLAN_PERIOD>
    <COUNT>1</COUNT>
    <DESCRIPTION_PAYMENT_CONDITION>sample string 3</DESCRIPTION_PAYMENT_CONDITION>
    <DUE_DATE>2019-11-22T15:55:22.8558405-03:00</DUE_DATE>
    <FIXED_DUE_DATE_1>2019-11-22T15:55:22.8558405-03:00</FIXED_DUE_DATE_1>
    <FIXED_DUE_DATE_2>2019-11-22T15:55:22.8558405-03:00</FIXED_DUE_DATE_2>
    <FIXED_DUE_DATE_3>2019-11-22T15:55:22.8558405-03:00</FIXED_DUE_DATE_3>
    <LAST_UPDATE_DATE>2019-11-22T15:55:22.8558405-03:00</LAST_UPDATE_DATE>
    <NUMBER_DAYS_PAYMENT_TERM_1>1</NUMBER_DAYS_PAYMENT_TERM_1>
    <NUMBER_DAYS_PAYMENT_TERM_10>1</NUMBER_DAYS_PAYMENT_TERM_10>
    <NUMBER_DAYS_PAYMENT_TERM_11>1</NUMBER_DAYS_PAYMENT_TERM_11>
    <NUMBER_DAYS_PAYMENT_TERM_12>1</NUMBER_DAYS_PAYMENT_TERM_12>
    <NUMBER_DAYS_PAYMENT_TERM_2>1</NUMBER_DAYS_PAYMENT_TERM_2>
    <NUMBER_DAYS_PAYMENT_TERM_3>1</NUMBER_DAYS_PAYMENT_TERM_3>
    <NUMBER_DAYS_PAYMENT_TERM_4>1</NUMBER_DAYS_PAYMENT_TERM_4>
    <NUMBER_DAYS_PAYMENT_TERM_5>1</NUMBER_DAYS_PAYMENT_TERM_5>
    <NUMBER_DAYS_PAYMENT_TERM_6>1</NUMBER_DAYS_PAYMENT_TERM_6>
    <NUMBER_DAYS_PAYMENT_TERM_7>1</NUMBER_DAYS_PAYMENT_TERM_7>
    <NUMBER_DAYS_PAYMENT_TERM_8>1</NUMBER_DAYS_PAYMENT_TERM_8>
    <NUMBER_DAYS_PAYMENT_TERM_9>1</NUMBER_DAYS_PAYMENT_TERM_9>
    <NUMBER_INSTALLMENTS>1</NUMBER_INSTALLMENTS>
    <NUMBER_PAYMENT_CONDITION>5</NUMBER_PAYMENT_CONDITION>
    <PAY_DUE_NUMBER_DUE_DATE>1</PAY_DUE_NUMBER_DUE_DATE>
    <PAY_NUMBER_DUE_DATE>1</PAY_NUMBER_DUE_DATE>
    <SEQ_PAYMENT_CONDITION>2</SEQ_PAYMENT_CONDITION>
    <SUM_NUMBER_DUE_DATE>1</SUM_NUMBER_DUE_DATE>
    <TYPE_INSTALLMENT>sample string 6</TYPE_INSTALLMENT>
    <TYPE_PAYMENT_TERM>sample string 7</TYPE_PAYMENT_TERM>
    <TYPE_SALE>sample string 8</TYPE_SALE>
  </PaymentConditionResponseDTO>
  <PaymentConditionResponseDTO>
    <AVERAGE_PAYMENT_PLAN_PERIOD>1.1</AVERAGE_PAYMENT_PLAN_PERIOD>
    <COUNT>1</COUNT>
    <DESCRIPTION_PAYMENT_CONDITION>sample string 3</DESCRIPTION_PAYMENT_CONDITION>
    <DUE_DATE>2019-11-22T15:55:22.8558405-03:00</DUE_DATE>
    <FIXED_DUE_DATE_1>2019-11-22T15:55:22.8558405-03:00</FIXED_DUE_DATE_1>
    <FIXED_DUE_DATE_2>2019-11-22T15:55:22.8558405-03:00</FIXED_DUE_DATE_2>
    <FIXED_DUE_DATE_3>2019-11-22T15:55:22.8558405-03:00</FIXED_DUE_DATE_3>
    <LAST_UPDATE_DATE>2019-11-22T15:55:22.8558405-03:00</LAST_UPDATE_DATE>
    <NUMBER_DAYS_PAYMENT_TERM_1>1</NUMBER_DAYS_PAYMENT_TERM_1>
    <NUMBER_DAYS_PAYMENT_TERM_10>1</NUMBER_DAYS_PAYMENT_TERM_10>
    <NUMBER_DAYS_PAYMENT_TERM_11>1</NUMBER_DAYS_PAYMENT_TERM_11>
    <NUMBER_DAYS_PAYMENT_TERM_12>1</NUMBER_DAYS_PAYMENT_TERM_12>
    <NUMBER_DAYS_PAYMENT_TERM_2>1</NUMBER_DAYS_PAYMENT_TERM_2>
    <NUMBER_DAYS_PAYMENT_TERM_3>1</NUMBER_DAYS_PAYMENT_TERM_3>
    <NUMBER_DAYS_PAYMENT_TERM_4>1</NUMBER_DAYS_PAYMENT_TERM_4>
    <NUMBER_DAYS_PAYMENT_TERM_5>1</NUMBER_DAYS_PAYMENT_TERM_5>
    <NUMBER_DAYS_PAYMENT_TERM_6>1</NUMBER_DAYS_PAYMENT_TERM_6>
    <NUMBER_DAYS_PAYMENT_TERM_7>1</NUMBER_DAYS_PAYMENT_TERM_7>
    <NUMBER_DAYS_PAYMENT_TERM_8>1</NUMBER_DAYS_PAYMENT_TERM_8>
    <NUMBER_DAYS_PAYMENT_TERM_9>1</NUMBER_DAYS_PAYMENT_TERM_9>
    <NUMBER_INSTALLMENTS>1</NUMBER_INSTALLMENTS>
    <NUMBER_PAYMENT_CONDITION>5</NUMBER_PAYMENT_CONDITION>
    <PAY_DUE_NUMBER_DUE_DATE>1</PAY_DUE_NUMBER_DUE_DATE>
    <PAY_NUMBER_DUE_DATE>1</PAY_NUMBER_DUE_DATE>
    <SEQ_PAYMENT_CONDITION>2</SEQ_PAYMENT_CONDITION>
    <SUM_NUMBER_DUE_DATE>1</SUM_NUMBER_DUE_DATE>
    <TYPE_INSTALLMENT>sample string 6</TYPE_INSTALLMENT>
    <TYPE_PAYMENT_TERM>sample string 7</TYPE_PAYMENT_TERM>
    <TYPE_SALE>sample string 8</TYPE_SALE>
  </PaymentConditionResponseDTO>
</ArrayOfPaymentConditionResponseDTO>

 

Este artigo foi útil para você?
Sim
Não
Confirmar que o artigo não foi útil