Consulta de Formas de Pagamentos – GET

Objetivo

A finalidade deste método é permitir consultar formas de pagamentos.

Chamada

GET api/v1/sm/payment-form?DATE_UPDATE={DATE_UPDATE}&NUMBER_PAYMENT_FORM={NUMBER_PAYMENT_FORM}&SPECIE_PAYMENT_FORM={SPECIE_PAYMENT_FORM}&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)
date_update	Update Date – (dd/MM/aaaa hh:MM ou ddMMaaaahhmm) – (Optional)	string	Não há.
number_payment_form	Number Payment Form – (00000) – (Optional)	integer	Não há.
specie_payment_form	Form of Payment – Can be a list, separated by commas. Eg.: A,B A – Cumulative Agreement, B – Bank Slip, C – Bank Check, D – Money, E – Debit Card, F – Financial Services, I – Financial POS, N – Promissory Note, O – Others, P – Own Card, R – Credit Card, S – POS Card, T – Food Card, U – Worth (Debit), V – Agreement, X – Change, x – Change Coupon, Y – Gift Card – (Optional)	string	Não há.
status	Status of Associated Companies of Payment Forms – (A = Active or I = Inactive) – (Optional – Default = “A”) If “A” will be returned to the active payment forms for the company, otherwise the inactive ones will be returned.	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)

PaymentFormResponseDTO – List of Payment Forms

Collection of PaymentFormResponseDTO

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
description_payment_form	Description of Payment Form	string	None.
indicates_bank_slip	Indicates if Payment Form is Bank Slip	string	None.
indicates_credit_card	Indicates if Payment Form is Credit Card	string	None.
code_payment_form	Number of Payment Form	integer	None.
specie_payment_form	Form of Payment	string	None.
value_minimum_payment_form	Minimum amount for this Payment Form	decimal number	None.
company	Companies that Accept the Payment form	Collection of PaymentFormCompanyResponseDTO	None.

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

[
  {
    "description_payment_form": "sample string 1",
    "indicates_bank_slip": "sample string 2",
    "indicates_credit_card": "sample string 3",
    "code_payment_form": 4,
    "specie_payment_form": "sample string 5",
    "value_minimum_payment_form": 1.1,
    "company": [
      {
        "number_company": 1,
        "name_company": "sample string 2",
        "code_payment_form": 3,
        "reg_number": 1,
        "reg_number_digit": 1,
        "status": "sample string 4"
      },
      {
        "number_company": 1,
        "name_company": "sample string 2",
        "code_payment_form": 3,
        "reg_number": 1,
        "reg_number_digit": 1,
        "status": "sample string 4"
      }
    ]
  },
  {
    "description_payment_form": "sample string 1",
    "indicates_bank_slip": "sample string 2",
    "indicates_credit_card": "sample string 3",
    "code_payment_form": 4,
    "specie_payment_form": "sample string 5",
    "value_minimum_payment_form": 1.1,
    "company": [
      {
        "number_company": 1,
        "name_company": "sample string 2",
        "code_payment_form": 3,
        "reg_number": 1,
        "reg_number_digit": 1,
        "status": "sample string 4"
      },
      {
        "number_company": 1,
        "name_company": "sample string 2",
        "code_payment_form": 3,
        "reg_number": 1,
        "reg_number_digit": 1,
        "status": "sample string 4"
      }
    ]
  }
]

application/xml, text/xml