Histórico da Página
Esta entidade exibe informações sobre Clientes e suporta as seguintes operações: GET, PUT, POST, DELETE
Campos do retorno
Nome | Descrição | Tamanho do campo | Tipo | Mais detalhes |
id | Código do cliente | 6 | Caracter | - |
name | Nome do cliente | 100 | Caracter | - |
documentType | Tipo de documento | 1 | Caracter | - |
Document | Documento | 18 | Caracter |
|
PersonType | Tipo de Cliente | 1 | Caracter |
|
ZipCode | CEP | 8 | Caracter |
|
Address | Endereço | 50 | Caracter |
|
Neighborhood | Bairro | 30 | Caracter |
|
Region | Região | 6 | Caracter |
|
City | Cidade | 35 | Caracter |
|
State | Estado | 2 | Caracter |
|
IbgeCityCode | Código da Cidade | 7 | Caracter |
|
Country | Pais | 4 | Caracter |
|
StateInscription | Inscrição Estadual | 18 | Caracter |
|
MunicipalInscription | Inscrição Municipal | 18 | Caracter |
|
Phone | Fone | 15 | Caracter |
|
CellPhone | Celular | 15 | Caracter |
|
70 | Caracter |
| ||
HomePage | HomePage | 55 | Caracter |
|
Active | Ativo | 1 | Caracter |
|
Leitura de registro específico(GET):
/first/api/v1/supplier/000007 |
{ "pk": "000007", "id": "000007", "name": "BRASPRESS TRANSPORTES URGENTES LTDA", "documentType": "J", "document": "48.740.351/0001-65", "personType": "7", "zipCode": "02068050", "address": "RUA CEL MARQUES RIBEIRO, 225", "neighborhood": "SAO PAULO", "region": "", "city": "SAO PAULO", "state": "SP", "ibgeCityCode": "50308", "country": "1058", "stateInscription": "116945108113", "municipalInscription": "116945108113", "phone": "", "cellPhone": "", "email": "", "homePage": "", "active": "1", "defaultSalesman1": "000001" } |
Leitura de registro com filtro (GET)
/first/api/v1/supplier?Country=1058 |
{ "pk": "000007", "id": "000007", "name": "BRASPRESS TRANSPORTES URGENTES LTDA", "documentType": "J", "document": "48.740.351/0001-65", "personType": "7", "zipCode": "02068050", "address": "RUA CEL MARQUES RIBEIRO, 225", "neighborhood": "SAO PAULO", "region": "", "city": "SAO PAULO", "state": "SP", "ibgeCityCode": "50308", "country": "1058", "stateInscription": "116945108113", "municipalInscription": "116945108113", "phone": "", "cellPhone": "", "email": "", "homePage": "", "active": "1", "defaultSalesman1": "000001" } |
Atualização de Registro (PUT)
/first/api/v1/supplier/000028 |
Body: "region": "TST" |
Retorno: { "url": "/first/api/v1/ supplier/000028", "id": "000028" } |
Inclusão (POST)
/first/api/v1/supplier |
Body:
{ "id": "000200", "name": "XEROMIDIO MARTINS DE OLIVEIRA", "documentType": "J", "document": "63.329.189/0001-80", "personType": "7", "zipCode": "64001120", "address": "RUA PAISSANDU, 901", "neighborhood": "CENTRO", "region": "PI1", "city": "TERESINA", "state": "PI", "ibgeCityCode": "11001", "country": "1058", "stateInscription": "194179419", "municipalInscription": "", "phone": "(86)3221-0156", "cellPhone": "", "email": "", "homePage": "", "active": "1", "defaultSalesman1": "000002" } |
Retorno: { "url": "/first/api/v1/supplier", "id": "000200” } |
Exclusão (DELETE)
/first/api/v1/supplier/000200 |
Retorno : { "url": "/first/api/v1/supplier/000200 "id": "200" } |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas