Realizar a consulta do de crédito dos clientes.
GET api/v1/sm/customers/commercial-informations?LAST_UPDATE_DATE={LAST_UPDATE_DATE}&ONLY_AFV={ONLY_AFV}&CUSTOMER_SEQUENCE={CUSTOMER_SEQUENCE}®_NUMBER={REG_NUMBER}&NUMBER_SEGMENT={NUMBER_SEGMENT}&STATUS={STATUS}&CREDIT_STATUS={CREDIT_STATUS}&_pageNo={_pageNo}&_pageSize={_pageSize}
Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
last_update_date | Data |
da |
Última |
Atualização |
entre |
as |
Informações |
Comerciais |
e |
suas |
Listas |
Associadas |
- |
Formatos: |
ddmmaaaahhmm |
ou |
dd |
/ |
mm |
/ |
aaaa |
hh: |
mm |
- |
Opcional | string | Não há. |
only_afv | S |
= |
Sim |
(retorna |
apenas |
clientes |
associados |
a |
representantes |
de |
vendas |
usando |
AFV), |
N |
ou |
null |
= |
Não |
(retorna |
todos |
os |
clientes). |
Padrão: |
N |
/ |
nulo |
- |
opcional | string |
Tamanho do campo (entre 0 e 1) | |
customer_sequence | Número |
de |
sequência |
do |
cliente |
- |
opcional | integer | Não há. |
reg_number | Cadastro |
Nacional |
de |
Contribuintes. |
Se |
Pessoa |
Jurídica: |
Cadastro |
Nacional |
de |
Pessoas |
Jurídicas |
(CNPJ) |
- |
Formatos: |
00000000000000 |
ou |
00.000.000 |
/ |
0000-00. |
Se |
Pessoa |
Física: |
Cadastro |
de |
Pessoa |
Física |
(CPF) |
- |
Formatos: |
00000000000 |
ou |
000.000.000-00 |
- |
Opcional | integer | Não há. |
number_segment | Segmento |
de |
número |
para |
filtrar |
- |
opcional | integer | Não há. |
status | Status |
do |
usuário |
- |
Siglas: |
A |
(Ativo), |
I |
(Inativo) |
- |
Opcional | string | Não há. |
credit_status | Status |
do |
cliente |
- |
Siglas: |
A |
(em |
análise), |
L |
(liberado) |
e |
B |
(bloqueado) |
- |
padrão |
'L' |
opcional | string | Não há. | |
_pageNo | integer | Não há. | |
_pageSize | integer | Não há. |
Não há.
CashOperatorsResponseDTO – List of Cashiers
Collection of CashOperatorsResponseDTO
Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
credit_limit | Limite |
de |
crédito | decimal number | Não há. |
credit_situation | Situação |
de |
crédito |
do |
cliente |
B |
= |
Bloqueado |
S |
= |
Suspenso |
L |
= |
Liberado |
A |
= |
Alerta | string | Não há. |
last_update_date | Data |
de |
atualização |
entre |
as |
informações |
do |
cabeçalho | date | Não há. |
in_use_credit_bank_check | Quantidade |
de |
crédito |
do |
cheque |
bancário |
em |
uso | decimal number | Não há. |
in_use_charter_value | Quantidade |
de |
crédito |
de |
fretamento |
em |
uso | decimal number | Não há. |
in_use_credit_value | Quantidade |
de |
crédito |
em |
uso |
(cheques |
e |
ingressos) | decimal number | Não há. |
open_orders_value_attended | Quantidade |
de |
pedidos |
em |
aberto |
atendidos | decimal number | Não há. |
maximum_deadline_payment | Prazo |
Máximo |
para |
Pagamento | integer | Não há. |
building_private_rental | Edifício |
privado |
ou |
alugado | string | Não há. |
reg_number | Cadastro |
Nacional |
de |
Pessoas |
Jurídicas |
(Pessoa |
Jurídica) |
ou |
Pessoa |
Física |
(Pessoa |
Física) | string | Não há. |
seq_customer | Número |
de |
sequência |
do |
cliente | integer | Não há. |
customer_status | Status |
do |
cliente | string | Não há. |
payment_form_list | Informações |
do |
formulário |
de |
pagamento | Collection of AllowedPaymentFormResponseDTO | Não há. |
segment_list | Informações |
de |
segmentos |
associados | Collection of SegmentInfoResponseDTO | |
commercial_agent_list | Informações |
do |
Agente |
Comercial | Collection of CustomerCommercialAgentResponseDTO |
Exemplo (Sample):
Bloco de código | ||
---|---|---|
| ||
[ { "credit_limit": 1.0, "credit_situation": "sample string 2", "last_update_date": "2021-04-16T13:26:31.1096137-03:00", "in_use_credit_bank_check": 1.1, "in_use_charter_value": 1.1, "in_use_credit_value": 1.1, "open_orders_value_attended": 1.1, "maximum_deadline_payment": 1, "building_private_rental": "sample string 3", "reg_number": "sample string 4", "seq_customer": 5, "customer_status": "sample string 6", "payment_form_list": [ { "number_payment_form": 2, "description_payment_form": "sample string 3", "credit_status": "sample string 4", "last_update_date": "2021-04-16T13:26:31.1096137-03:00", "indicates_main": "sample string 5" }, { "number_payment_form": 2, "description_payment_form": "sample string 3", "credit_status": "sample string 4", "last_update_date": "2021-04-16T13:26:31.1096137-03:00", "indicates_main": "sample string 5" } ], "segment_list": [ { "number_segment": 1, "commission_normal": 1.1, "commission_sale": 1.1, "financial_discount": 1.1, "increase_discount_commercial": 1.1, "number_agent": 1, "sales_list": [ { "description": "sample string 3", "number_sales_table": "sample string 4", "status": "sample string 5" }, { "description": "sample string 3", "number_sales_table": "sample string 4", "status": "sample string 5" } ] }, { "number_segment": 1, "commission_normal": 1.1, "commission_sale": 1.1, "financial_discount": 1.1, "increase_discount_commercial": 1.1, "number_agent": 1, "sales_list": [ { "description": "sample string 3", "number_sales_table": "sample string 4", "status": "sample string 5" }, { "description": "sample string 3", "number_sales_table": "sample string 4", "status": "sample string 5" } ] } ], "commercial_agent_list": [ { "name": "sample string 3", "number_commercial_agent": 4, "status": "sample string 5" }, { "name": "sample string 3", "number_commercial_agent": 4, "status": "sample string 5" } ] }, { "credit_limit": 1.0, "credit_situation": "sample string 2", "last_update_date": "2021-04-16T13:26:31.1096137-03:00", "in_use_credit_bank_check": 1.1, "in_use_charter_value": 1.1, "in_use_credit_value": 1.1, "open_orders_value_attended": 1.1, "maximum_deadline_payment": 1, "building_private_rental": "sample string 3", "reg_number": "sample string 4", "seq_customer": 5, "customer_status": "sample string 6", "payment_form_list": [ { "number_payment_form": 2, "description_payment_form": "sample string 3", "credit_status": "sample string 4", "last_update_date": "2021-04-16T13:26:31.1096137-03:00", "indicates_main": "sample string 5" }, { "number_payment_form": 2, "description_payment_form": "sample string 3", "credit_status": "sample string 4", "last_update_date": "2021-04-16T13:26:31.1096137-03:00", "indicates_main": "sample string 5" } ], "segment_list": [ { "number_segment": 1, "commission_normal": 1.1, "commission_sale": 1.1, "financial_discount": 1.1, "increase_discount_commercial": 1.1, "number_agent": 1, "sales_list": [ { "description": "sample string 3", "number_sales_table": "sample string 4", "status": "sample string 5" }, { "description": "sample string 3", "number_sales_table": "sample string 4", "status": "sample string 5" } ] }, { "number_segment": 1, "commission_normal": 1.1, "commission_sale": 1.1, "financial_discount": 1.1, "increase_discount_commercial": 1.1, "number_agent": 1, "sales_list": [ { "description": "sample string 3", "number_sales_table": "sample string 4", "status": "sample string 5" }, { "description": "sample string 3", "number_sales_table": "sample string 4", "status": "sample string 5" } ] } ], "commercial_agent_list": [ { "name": "sample string 3", "number_commercial_agent": 4, "status": "sample string 5" }, { "name": "sample string 3", "number_commercial_agent": 4, "status": "sample string 5" } ] } ] |
Exemplo (Sample):
Bloco de código | ||
---|---|---|
| ||
<ArrayOfCustomerCommercialInfoResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Consinco.SM.Api.Entities.Entities.v1.Customer"> <CustomerCommercialInfoResponseDTO> <COMMERCIAL_AGENT_LIST> <CustomerCommercialAgentResponseDTO> <NAME>sample string 3</NAME> <NUMBER_COMMERCIAL_AGENT>4</NUMBER_COMMERCIAL_AGENT> <NUMBER_SEGMENT>1</NUMBER_SEGMENT> <SEQ_PERSON>2</SEQ_PERSON> <STATUS>sample string 5</STATUS> </CustomerCommercialAgentResponseDTO> <CustomerCommercialAgentResponseDTO> <NAME>sample string 3</NAME> <NUMBER_COMMERCIAL_AGENT>4</NUMBER_COMMERCIAL_AGENT> <NUMBER_SEGMENT>1</NUMBER_SEGMENT> <SEQ_PERSON>2</SEQ_PERSON> <STATUS>sample string 5</STATUS> </CustomerCommercialAgentResponseDTO> </COMMERCIAL_AGENT_LIST> <COUNT>1</COUNT> <CREDIT_LIMIT>1</CREDIT_LIMIT> <CREDIT_SITUATION>sample string 2</CREDIT_SITUATION> <CUSTOMER_STATUS>sample string 6</CUSTOMER_STATUS> <IN_USE_CREDIT_BANK_CHECK>1.1</IN_USE_CREDIT_BANK_CHECK> <IN_USE_CREDIT_CHARTER>1.1</IN_USE_CREDIT_CHARTER> <IN_USE_CREDIT_VALUE>1.1</IN_USE_CREDIT_VALUE> <LAST_UPDATE_DATE>2021-04-16T13:26:31.1096137-03:00</LAST_UPDATE_DATE> <MAXIMUM_DEADLINE_PAYMENT>1</MAXIMUM_DEADLINE_PAYMENT> <OPEN_ORDERS_VALUE_ATTENDED>1.1</OPEN_ORDERS_VALUE_ATTENDED> <PAYMENT_FORM_LIST> <AllowedPaymentFormResponseDTO> <CREDIT_STATUS>sample string 4</CREDIT_STATUS> <DESCRIPTION_PAYMENT_FORM>sample string 3</DESCRIPTION_PAYMENT_FORM> <INDICATES_MAIN>sample string 5</INDICATES_MAIN> <LAST_UPDATE_DATE>2021-04-16T13:26:31.1096137-03:00</LAST_UPDATE_DATE> <NUMBER_PAYMENT_FORM>2</NUMBER_PAYMENT_FORM> <SEQ_PERSON>1</SEQ_PERSON> </AllowedPaymentFormResponseDTO> <AllowedPaymentFormResponseDTO> <CREDIT_STATUS>sample string 4</CREDIT_STATUS> <DESCRIPTION_PAYMENT_FORM>sample string 3</DESCRIPTION_PAYMENT_FORM> <INDICATES_MAIN>sample string 5</INDICATES_MAIN> <LAST_UPDATE_DATE>2021-04-16T13:26:31.1096137-03:00</LAST_UPDATE_DATE> <NUMBER_PAYMENT_FORM>2</NUMBER_PAYMENT_FORM> <SEQ_PERSON>1</SEQ_PERSON> </AllowedPaymentFormResponseDTO> </PAYMENT_FORM_LIST> <PRIVATE_RENTAL_BUILDING>sample string 3</PRIVATE_RENTAL_BUILDING> <REG_NUMBER>sample string 4</REG_NUMBER> <SEGMENT_LIST> <SegmentInfoResponseDTO> <COMMISSION_NORMAL>1.1</COMMISSION_NORMAL> <COMMISSION_SALE>1.1</COMMISSION_SALE> <FINANCIAL_DISCOUNT>1.1</FINANCIAL_DISCOUNT> <INCREASE_DISCOUNT_COMMERCIAL>1.1</INCREASE_DISCOUNT_COMMERCIAL> <NUMBER_AGENT>1</NUMBER_AGENT> <NUMBER_SEGMENT>1</NUMBER_SEGMENT> <SALES_LIST> <SalesTableResponseDTO> <DESCRIPTION>sample string 3</DESCRIPTION> <NUMBER_SALES_TABLE>sample string 4</NUMBER_SALES_TABLE> <NUMBER_SEGMENT>1</NUMBER_SEGMENT> <SEQ_PERSON>2</SEQ_PERSON> <STATUS>sample string 5</STATUS> </SalesTableResponseDTO> <SalesTableResponseDTO> <DESCRIPTION>sample string 3</DESCRIPTION> <NUMBER_SALES_TABLE>sample string 4</NUMBER_SALES_TABLE> <NUMBER_SEGMENT>1</NUMBER_SEGMENT> <SEQ_PERSON>2</SEQ_PERSON> <STATUS>sample string 5</STATUS> </SalesTableResponseDTO> </SALES_LIST> <SEQ_PERSON>1</SEQ_PERSON> </SegmentInfoResponseDTO> <SegmentInfoResponseDTO> <COMMISSION_NORMAL>1.1</COMMISSION_NORMAL> <COMMISSION_SALE>1.1</COMMISSION_SALE> <FINANCIAL_DISCOUNT>1.1</FINANCIAL_DISCOUNT> <INCREASE_DISCOUNT_COMMERCIAL>1.1</INCREASE_DISCOUNT_COMMERCIAL> <NUMBER_AGENT>1</NUMBER_AGENT> <NUMBER_SEGMENT>1</NUMBER_SEGMENT> <SALES_LIST> <SalesTableResponseDTO> <DESCRIPTION>sample string 3</DESCRIPTION> <NUMBER_SALES_TABLE>sample string 4</NUMBER_SALES_TABLE> <NUMBER_SEGMENT>1</NUMBER_SEGMENT> <SEQ_PERSON>2</SEQ_PERSON> <STATUS>sample string 5</STATUS> </SalesTableResponseDTO> <SalesTableResponseDTO> <DESCRIPTION>sample string 3</DESCRIPTION> <NUMBER_SALES_TABLE>sample string 4</NUMBER_SALES_TABLE> <NUMBER_SEGMENT>1</NUMBER_SEGMENT> <SEQ_PERSON>2</SEQ_PERSON> <STATUS>sample string 5</STATUS> </SalesTableResponseDTO> </SALES_LIST> <SEQ_PERSON>1</SEQ_PERSON> </SegmentInfoResponseDTO> </SEGMENT_LIST> <SEQ_PERSON>5</SEQ_PERSON> </CustomerCommercialInfoResponseDTO> <CustomerCommercialInfoResponseDTO> <COMMERCIAL_AGENT_LIST> <CustomerCommercialAgentResponseDTO> <NAME>sample string 3</NAME> <NUMBER_COMMERCIAL_AGENT>4</NUMBER_COMMERCIAL_AGENT> <NUMBER_SEGMENT>1</NUMBER_SEGMENT> <SEQ_PERSON>2</SEQ_PERSON> <STATUS>sample string 5</STATUS> </CustomerCommercialAgentResponseDTO> <CustomerCommercialAgentResponseDTO> <NAME>sample string 3</NAME> <NUMBER_COMMERCIAL_AGENT>4</NUMBER_COMMERCIAL_AGENT> <NUMBER_SEGMENT>1</NUMBER_SEGMENT> <SEQ_PERSON>2</SEQ_PERSON> <STATUS>sample string 5</STATUS> </CustomerCommercialAgentResponseDTO> </COMMERCIAL_AGENT_LIST> <COUNT>1</COUNT> <CREDIT_LIMIT>1</CREDIT_LIMIT> <CREDIT_SITUATION>sample string 2</CREDIT_SITUATION> <CUSTOMER_STATUS>sample string 6</CUSTOMER_STATUS> <IN_USE_CREDIT_BANK_CHECK>1.1</IN_USE_CREDIT_BANK_CHECK> <IN_USE_CREDIT_CHARTER>1.1</IN_USE_CREDIT_CHARTER> <IN_USE_CREDIT_VALUE>1.1</IN_USE_CREDIT_VALUE> <LAST_UPDATE_DATE>2021-04-16T13:26:31.1096137-03:00</LAST_UPDATE_DATE> <MAXIMUM_DEADLINE_PAYMENT>1</MAXIMUM_DEADLINE_PAYMENT> <OPEN_ORDERS_VALUE_ATTENDED>1.1</OPEN_ORDERS_VALUE_ATTENDED> <PAYMENT_FORM_LIST> <AllowedPaymentFormResponseDTO> <CREDIT_STATUS>sample string 4</CREDIT_STATUS> <DESCRIPTION_PAYMENT_FORM>sample string 3</DESCRIPTION_PAYMENT_FORM> <INDICATES_MAIN>sample string 5</INDICATES_MAIN> <LAST_UPDATE_DATE>2021-04-16T13:26:31.1096137-03:00</LAST_UPDATE_DATE> <NUMBER_PAYMENT_FORM>2</NUMBER_PAYMENT_FORM> <SEQ_PERSON>1</SEQ_PERSON> </AllowedPaymentFormResponseDTO> <AllowedPaymentFormResponseDTO> <CREDIT_STATUS>sample string 4</CREDIT_STATUS> <DESCRIPTION_PAYMENT_FORM>sample string 3</DESCRIPTION_PAYMENT_FORM> <INDICATES_MAIN>sample string 5</INDICATES_MAIN> <LAST_UPDATE_DATE>2021-04-16T13:26:31.1096137-03:00</LAST_UPDATE_DATE> <NUMBER_PAYMENT_FORM>2</NUMBER_PAYMENT_FORM> <SEQ_PERSON>1</SEQ_PERSON> </AllowedPaymentFormResponseDTO> </PAYMENT_FORM_LIST> <PRIVATE_RENTAL_BUILDING>sample string 3</PRIVATE_RENTAL_BUILDING> <REG_NUMBER>sample string 4</REG_NUMBER> <SEGMENT_LIST> <SegmentInfoResponseDTO> <COMMISSION_NORMAL>1.1</COMMISSION_NORMAL> <COMMISSION_SALE>1.1</COMMISSION_SALE> <FINANCIAL_DISCOUNT>1.1</FINANCIAL_DISCOUNT> <INCREASE_DISCOUNT_COMMERCIAL>1.1</INCREASE_DISCOUNT_COMMERCIAL> <NUMBER_AGENT>1</NUMBER_AGENT> <NUMBER_SEGMENT>1</NUMBER_SEGMENT> <SALES_LIST> <SalesTableResponseDTO> <DESCRIPTION>sample string 3</DESCRIPTION> <NUMBER_SALES_TABLE>sample string 4</NUMBER_SALES_TABLE> <NUMBER_SEGMENT>1</NUMBER_SEGMENT> <SEQ_PERSON>2</SEQ_PERSON> <STATUS>sample string 5</STATUS> </SalesTableResponseDTO> <SalesTableResponseDTO> <DESCRIPTION>sample string 3</DESCRIPTION> <NUMBER_SALES_TABLE>sample string 4</NUMBER_SALES_TABLE> <NUMBER_SEGMENT>1</NUMBER_SEGMENT> <SEQ_PERSON>2</SEQ_PERSON> <STATUS>sample string 5</STATUS> </SalesTableResponseDTO> </SALES_LIST> <SEQ_PERSON>1</SEQ_PERSON> </SegmentInfoResponseDTO> <SegmentInfoResponseDTO> <COMMISSION_NORMAL>1.1</COMMISSION_NORMAL> <COMMISSION_SALE>1.1</COMMISSION_SALE> <FINANCIAL_DISCOUNT>1.1</FINANCIAL_DISCOUNT> <INCREASE_DISCOUNT_COMMERCIAL>1.1</INCREASE_DISCOUNT_COMMERCIAL> <NUMBER_AGENT>1</NUMBER_AGENT> <NUMBER_SEGMENT>1</NUMBER_SEGMENT> <SALES_LIST> <SalesTableResponseDTO> <DESCRIPTION>sample string 3</DESCRIPTION> <NUMBER_SALES_TABLE>sample string 4</NUMBER_SALES_TABLE> <NUMBER_SEGMENT>1</NUMBER_SEGMENT> <SEQ_PERSON>2</SEQ_PERSON> <STATUS>sample string 5</STATUS> </SalesTableResponseDTO> <SalesTableResponseDTO> <DESCRIPTION>sample string 3</DESCRIPTION> <NUMBER_SALES_TABLE>sample string 4</NUMBER_SALES_TABLE> <NUMBER_SEGMENT>1</NUMBER_SEGMENT> <SEQ_PERSON>2</SEQ_PERSON> <STATUS>sample string 5</STATUS> </SalesTableResponseDTO> </SALES_LIST> <SEQ_PERSON>1</SEQ_PERSON> </SegmentInfoResponseDTO> </SEGMENT_LIST> <SEQ_PERSON>5</SEQ_PERSON> </CustomerCommercialInfoResponseDTO> </ArrayOfCustomerCommercialInfoResponseDTO> |
...