Histórico da Página

...

Método de inclusão de fornecedores.

Chamada

POST [URLAPI]/CadastrosEstruturaisAPI/api/v1/Fornecedor

Permissionamento

Antes de prosseguir, certifique-se de que o usuário, utilizado para autenticação de uso na API, está com as devidas permissões no Sistema/Módulo/Aplicações e na empresa desejada.

Para isso, acesse o módulo SegurançaWeb > Permissões > Associação de Permissão Usuário / Grupo > Sistemas/Módulo/Aplicações > Comercial Web > API Cadastros Estruturais > API Cadastros Estruturais

Image Added

Imagem 01 - Configurações de Sistemas/Módulos/Aplicações

Assuntos Relacionados

Para saber mais sobre permissionamentos acesse Permissões - Segurança Web.

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

Parâmetros URI (URI Parameters)

...

Parâmetros do Corpo (Body Parameters)

AdicionarFornecedorReqDto

	Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
	tipo*	Tipo do fornecedor. Valores: D - Distribuidor, I - Indústria, S - Prestador de Serviços.	string	Tamanho Máximo: 1
	microEmpresa*	Fornecedor é micro empresa. Valores: S - Sim, N - Não.	string	Tamanho Máximo: 1
	condicaoFrete*	Condição do frete. Valores: C - CIF, F - FOB, S - CSP, R - RETIRA.	string	Tamanho Máximo: 1
	status*	Status do fornecedor. Valores: A - Ativo, I - Inativo, S - Suspenso.	string	Tamanho Máximo: 1
	dadosAdicionais	Dados adicionais sobre o fornecedor.	string	Tamanho Máximo: 250
pessoa	AdicionarFornecedorPessoaReqDto
	nomeRazaoSocial*	Nome ou razão social da pessoa.	string	Tamanho Máximo: 100
	fantasia	Nome fantasia.	string	Tamanho Máximo: 30
	tipoPessoa	Indica o tipo da pessoa. Valores: F - Física, J - Jurídica.	string	Tamanho Máximo: 1
	sexo	Sexo da pessoa. Valores: M - Masculino, F - Feminino, O - Outros.	string	Tamanho Máximo: 1
	status*	Status da pessoa. Valores: A - Ativo, I - Inativo, P- Prospect, O - Outros.	string	Tamanho Máximo: 1
	nomeCidade	Nome da cidade.	string	Tamanho Máximo: 30 Será verificado se existe uma cidade cadastrada, se não tiver, ela será cadastrada.
	ufCidade	UF da cidade.	string	Tamanho Máximo: 2
	paisCidade	País da cidade.	string	Tamanho Máximo: 25
	codigoMunicipio	Código do município.	integer($int64)	Tamanho Máximo:

99999

Tamanho Mínimo: 0

codigoPais

Código do país.

integer($int64)

Tamanho Máximo:

99999

99999 Tamanho Mínimo: 0
nomeBairro	Nome do bairro.	string	Tamanho Máximo: 30 Será verificado se existe o bairro cadastrado, se não tiver, ele será cadastrado.
tipoLogradouro	Tipo do logradouro.	string	Tamanho Máximo: 25
nomeLogradouro	Nome do logradouro.	string	Tamanho Máximo: 150
numeroLogradouro	Número do logradouro.	string	Tamanho Máximo: 10
complementoLogradouro	Complemento do logradouro.	string	Tamanho Máximo: 60
cep	CEP.	string	Tamanho Máximo: 12
telefoneDDD1	DDD do telefone 1.	string	Tamanho Máximo: 5
telefoneNumero1	Número do telefone 1.	string	Tamanho Máximo: 12
telefoneComplemento1	Complemento do telefone 1.	string	Tamanho Máximo: 12
telefoneDDD2	DDD do telefone 2.	string	Tamanho Máximo: 5
telefoneNumero2	Número do telefone 2.	string	Tamanho Máximo: 12
telefoneComplemento2	Complemento do telefone 2.	string	Tamanho Máximo: 12
telefoneDDD3	DDD do telefone 3.	string	Tamanho Máximo: 5
telefoneNumero3	Número do telefone 3.	string	Tamanho Máximo: 12
telefoneComplemento3	Complemento do telefone 3.	string	Tamanho Máximo: 12
numeroCPFCNPJ	Número do CPF ou CNPJ.	integer($int64)	Tamanho Máximo:

9999999999999

Tamanho Mínimo: 0

digitoCPFCNPJ

Dígito do CPF ou CNPJ.

integer($int64)

Tamanho Máximo:

99

Tamanho Mínimo: 0

inscricaoEstadualRG

Número da inscrição estadual ou RG.

string

Tamanho Máximo:

20

20
email	E-mail para contato.	string	Tamanho Máximo:

50

50
homePage	Home Page.	string	Tamanho Máximo:

80

80
estadoCivil	Estado civil. Valores: S - Solteiro, C - Casado, V - Viúvo, Q - Desquitado, D - Divorciado, A - Amasiado, P - Separado, O - Outros.	string	Tamanho Máximo:

1

1
contribuinteICMS	Indica se é contribuinte do ICMS. Valores: S - Sim, N - Não.	string	Tamanho Máximo:

1

1
produtorRural	Indica se é produtor rural. Valores: S - Sim, N - Não.	string	Tamanho Máximo:

1

1
microEmpresa	Indica se é micro empresa. Valores: S - Sim, N - Não.	string	Tamanho Máximo:

1

1
inscricaoProdutorRural	Número da inscrição estadual do produtor rural.	string	Tamanho Máximo:

15

15
numeroCNPJProdutorRural	Número do CNPJ do produtor rural.	integer($int64)	Tamanho Máximo:

9999999999999

Tamanho Mínimo: 0

digitoCNPJProdutorRural

Dígito do CNPJ do produtor rural.

integer($int64)

Tamanho Máximo:

99

Tamanho Mínimo: 0

produtorRuralComCPF

Indica se produtor rural usa CPF. Valores: S - Sim, N - Não.

string

Tamanho Máximo:

1

1
numeroCPFProdutorRural	Número do CPF do produtor rural.	integer($int64)	Tamanho Máximo:

9999999999999

Tamanho Mínimo: 0

digitoCPFProdutorRural

Dígito do CPF do produtor rural.

integer($int64)

Tamanho Máximo:

99

Tamanho Mínimo: 0

fornecedorDivisao

AdicionarFornecedorDivisaoReqDto

idDivisao*

Identificador da divisão.

integer($int64)

Tamanho Máximo:

999

Tamanho Mínimo: 0

numeroRegimeTributacao

Número do regime de tributação.

integer($int64)

Tamanho Máximo:

99999

Tamanho Mínimo: 0

idComprador*

Identificador do comprador.

integer($int64)

Tamanho Máximo:

999

Tamanho Mínimo: 0

prazoMedioVisita*

Prazo médio de visita. Prazo estimado em dias.

number($double)

Tamanho Máximo:

999

999.9

Tamanho Mínimo: 0

prazoMedioEntrega*

Prazo médio da entrega. Prazo estimado em dias.

number($double)

Tamanho Máximo:

999

999.9

Tamanho Mínimo: 0

prazoMedioAtrasoEntrega*

Prazo médio de atraso por entrega. Prazo estimado em dias.

number($double)

Tamanho Máximo:

999

999.9 Tamanho Mínimo: 0
prazoPagamento*	Prazo de pagamento. 'Prazo estimado em dias com a separação por /(Barras).	string	Tamanho Máximo: 40
formaPagamento	Forma de pagamento. Valores: F - Faturamento, S - Fora a Semana, D - Fora a Dezena, Q - Fora a Quinzena, M - Fora o Mês.	string	Tamanho Máximo: 1
valorMinimoPedidoCompra	Valor mínimo do pedido de compra.	number($double)	Tamanho Máximo:

9999999

9999999.99
classificacaoComercialABC	Classificação Comercial ABC.	string	Tamanho Máximo: 1
status*	Status da divisão do fornecedor. Valores: A - Ativo, I - Inativo, S - Suspenso.	string	Tamanho Máximo: 1
tipoDataBaseVencimento	Tipo da data base de vencimento. Valores: E - Data de Emissão, R - Data de Entrada, S - Data de Saída.	string	Tamanho Máximo: 1
tipoValorMinimo	Tipo valor mínimo. Valores: L - Líquido, B- Bruto.	string	Tamanho Máximo: 1

Informações para Resposta (Response Information)

...

Bloco de código

language	actionscript3

{
  "idFornecedor": 0,
  "tipo": "string",
  "microEmpresa": "string",
  "condicaoFrete": "string",
  "status": "string",
  "dadosAdicionais": "string",
  "pessoa": {
    "idPessoa": 0,
    "nomeRazaoSocial": "string",
    "fantasia": "string",
    "tipoPessoa": "string",
    "sexo": "string",
    "status": "string",
    "nomeCidade": "string",
    "ufCidade": "string",
    "paisCidade": "string",
    "nomeBairro": "string",
    "descricaoLogradouro": "string",
    "numeroLogradouro": "string",
    "complementoLogradouro": "string",
    "cep": "string",
    "telefoneDDD1": "string",
    "telefoneNumero1": "string",
    "telefoneComplemento1": "string",
    "telefoneDDD2": "string",
    "telefoneNumero2": "string",
    "telefoneComplemento2": "string",
    "telefoneDDD3": "string",
    "telefoneNumero3": "string",
    "telefoneComplemento3": "string",
    "numeroCPFCNPJ": 0,
    "digitoCPFCNPJ": 0,
    "inscricaoEstadualRG": "string",
    "email": "string",
    "homePage": "string",
    "estadoCivil": "string",
    "contribuinteICMS": "string",
    "produtorRural": "string",
    "microEmpresa": "string",
    "inscricaoProdutorRural": "string",
    "numeroCNPJProdutorRural": 0,
    "digitoCNPJProdutorRural": 0,
    "produtorRuralComCPF": "string",
    "numeroCPFProdutorRural": 0,
    "digitoCPFProdutorRural": 0
  },
  "fornecedorDivisao": [
    {
      "idDivisao": 0,
      "numeroRegimeTributacao": 0,
      "idComprador": 0,
      "prazoMedioVisita": 0,
      "prazoMedioEntrega": 0,
      "prazoMedioAtrasoEntrega": 0,
      "prazoPagamento": "string",
      "formaPagamento": "string",
      "valorMinimoPedidoCompra": 0,
      "classificacaoComercialABC": "string",
      "status": "string",
      "tipoDataBaseVencimento": "string",
      "tipoValorMinimo": "string"
    }
  ]
}

application/json, text/json

CODE 400 - BAD

Bloco de código

language	actionscript3

{
  "code": "string",
  "message": "string",
  "detailedMessage": "string",
  "helpUrl": "string",
  "details": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "notificationType": 0,
      "code": "string",
      "message": "string",
      "detailedMessage": "string",
      "status": 0
    }
  ]
}

...

Árvore de páginas

Versões comparadas

Versão antiga 2

Nova versão Atual

Chave

Chamada

Permissionamento

Assuntos Relacionados

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

Parâmetros URI (URI Parameters)

Parâmetros do Corpo (Body Parameters)

Informações para Resposta (Response Information)