Consulta de Empresas Preferenciais por Cliente – GET

Objetivo

A finalidade deste método é permitir consultar as empresas preferencias por clientes.

Chamada

GET api/v1/sm/customer-preferential-companies?REG_NUMBER={REG_NUMBER}&CUSTOMER_SEQUENCE={CUSTOMER_SEQUENCE}&LAST_UPDATE_DATE={LAST_UPDATE_DATE}&STATUS={STATUS}&_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)
reg_number	To Legal Entity: Brazilian Registry of Corporate Taxpayers (CNPJ) – Formats: 00000000000000 or 00.000.000/0001-00 – To Physical Person: Individual Taxpayers (CPF) – Formats: 00000000000 or 000.000.000-00 – Optional	string	None.
customer_sequence	Customer Sequence – Optional	integer	None.
last_update_date	Last Update Date between Peson, Customer and Customer Address – Formats: ddmmaaaahhmm or dd/mm/aaaa hh:mm – Optional	string	None.
status	Customer Status – acronyms: A (Active), I (Inactive) Optional	string	None.
_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)

CustomerPrefCompaniesResponseDTO – Customer data and Preferential Companies list

Collection of CustomerPrefCompaniesResponseDTO

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
reg_number	To Legal Entity: Brazilian Registry of Corporate Taxpayers (CNPJ) – Formats: 00000000000000 or 00.000.000/0001-00 – To Physical Person: Individual Taxpayers (CPF) – Formats: 00000000000 or 000.000.000-00 – Optional	string	None.
customer_sequence	Customer Sequence – Optional	integer	None.
last_update_date	Last Update Date between Peson, Customer and Customer Address – Formats: ddmmaaaahhmm or dd/mm/aaaa hh:mm – Optional	date	None.
status	Customer Status – acronyms: A (Active), I (Inactive), P (Prospect) – Optional	string	None.
customer_pref_comp_list	List of Customer Preferential Companies Optional	Collection of CustomerPrefCompaniesListResponseDTO	None.

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

[
  {
    "reg_number": "sample string 1",
    "customer_sequence": 2,
    "last_update_date": "2020-05-07T15:53:58.3282479-03:00",
    "status": "sample string 3",
    "customer_pref_comp_list": [
      {
        "company_number": 1,
        "preferential_sequence": 1
      },
      {
        "company_number": 1,
        "preferential_sequence": 1
      }
    ]
  },
  {
    "reg_number": "sample string 1",
    "customer_sequence": 2,
    "last_update_date": "2020-05-07T15:53:58.3282479-03:00",
    "status": "sample string 3",
    "customer_pref_comp_list": [
      {
        "company_number": 1,
        "preferential_sequence": 1
      },
      {
        "company_number": 1,
        "preferential_sequence": 1
      }
    ]
  }
]

application/xml, text/xml