Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Objetivo

Método que permite inserir novos clientes.

Chamada

POST api/v1/cliente

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

Parâmetros URI (URI Parameters)

Não há.

Parâmetros do Corpo (Body Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
SEQCLIENTE*

Código ou CNPJ do cliente. Vinculado ao campo TIPCODIGO.

integer

Máximo: 999999999999999

TIPCODIGO*

Tipo do código do cliente:
I – Código Interno(Padrão)
C – CNPJ.

stringTamanho Máximo: 1
NOMERAZAO*

Nome ou razão social do cliente.

stringTamanho Máximo: 100
FANTASIA

Nome fantasia do cliente.

string

Tamanho Máximo: 30

CIDADE*

Nome da cidade do cliente.

stringTamanho Máximo: 30
UF*Sigla da UF da cidade do cliente.stringTamanho Máximo: 2
BAIRROBairro do cliente.stringTamanho Máximo: 30
LOGRADOUROEndereço do cliente. Nome da rua/avenida, número, etc.stringTamanho Máximo: 55
STATUS*Status do cliente:
A – Ativo
I – Inativo.
stringTamanho Máximo: 1
FISICAJURIDICA*Tipo da pessoa:
J – Jurídica
F – Física.
stringTamanho Máximo: 1
NROCGCCPF*Número do CNPJ, caso seja pessoa jurídica, ou CPF, caso seja pessoa física. Não informar o dígito.integerMáximo: 9999999999999
DIGCGCCPF*Digito do CNPJ, caso seja pessoa jurídica, ou CPF, caso seja pessoa física.integerMáximo: 99
OBSERVACAOObservação do cliente.stringTamanho Máximo: 240
PERCVALIDADERECPercentual de data de validade do produto que o cliente poderá receber.decimalMáximo: 99,99

Formatos de Request(Request Formats)

application/json, text/json

Bloco de código
{
  "seqCliente": 1,
  "tipCodigo": "I",
  "nomeRazao": "sample string 1",  
  "fantasia": "sample string 2",
  "bairro": "sample string 3",
  "logradouro": "sample string 4",
  "cidade": "sample string 5",
  "uf": "SP",  
  "status": "A",
  "FisicaJuridica": "F",
  "NroCgcCpf": 999999999,
  "DigCgcCpf": 99,
  "PercValidadeRec": 99.99
}


Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • OK (201)
  • BadRequest (400)