Fornecedor

fornecedor

Obter Listagem de Fornecedores

get

/fornecedor

Autorizações

AuthorizationstringObrigatório

Parâmetros de consulta

situacaostringOpcional

Situação do Fornecedor (0-Inativo, 1-Ativo)

continuationTokenstringOpcional

Identificador da Paginação da Consulta

campoFiltroDinamicostringOpcional

Campo para filtrar dinamicamente no SQL

valorFiltroDinamicostringOpcional

Valor para filtrar dinamicamente no SQL

paginacaointegerOpcional

Quantidade de itens na paginação de retorno

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/fornecedor

GET /cadastrosgerais/v10/fornecedor HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "continuationToken": "text",
  "data": [
    {
      "codEmpresa": 1,
      "codFornecedor": 1,
      "cpfCnpj": "text",
      "nome": "text",
      "nomeFantasia": "text",
      "inscEstadual": "text",
      "inscMunicipal": "text",
      "situacao": 1,
      "endereco": "text",
      "numero": "text",
      "complemento": "text",
      "bairro": "text",
      "cep": "text",
      "caixaPostal": "text",
      "cidade": "text",
      "estado": "text",
      "codPaisBacen": "text",
      "codIbge": "text",
      "codPais": "text",
      "telefone": "text",
      "telefone1": "text",
      "contato": "text",
      "classificacao": 1,
      "codCategoria": 1,
      "codGrupo": 1,
      "item": 1,
      "paisCidadeExterior": "text",
      "codNIF": "text",
      "idPessoaEstrangeira": "text",
      "contaContabil": "text",
      "codigoEntidade": 1,
      "codTransportador": 1,
      "email": "text",
      "emailNfe": "text",
      "observacao1": "text",
      "observacao2": "text",
      "observacao3": "text",
      "observacao4": "text",
      "codContaContJuros": 1,
      "codContaContMulta": 1,
      "codContaContDesconto": 1,
      "obrigaFluxoCaixa": 0,
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ]
}

Cadastrar um Fornecedor

put

/fornecedor

Autorizações

AuthorizationstringObrigatório

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

codFornecedorinteger · máx: 99999Opcional

Código do Fornecedor

cpfCnpjstring · mín: 1 · máx: 14Opcional

Código do CPF ou CNPJ do Fornecedor (sem formatação)

nomestring · mín: 1 · máx: 60Obrigatório

Nome do Fornecedor

nomeFantasiastring · máx: 30Opcional

Nome Fantasia do Fornecedor

inscEstadualstring · mín: 1 · máx: 17Opcional

Código da Inscrição Estadual do Fornecedor (sem formatação)

inscMunicipalstring · máx: 15Opcional

Código da Inscrição Municipal do Fornecedor (sem formatação)

situacaointegerObrigatório

Situação do Fornecedor (0-Inativo, 1-Ativo)

enderecostring · mín: 1 · máx: 60Obrigatório

Endereço do Fornecedor

numerostring · mín: 1 · máx: 5Obrigatório

Número do Endereço do Fornecedor

complementostring · máx: 30Opcional

Complemento do Endereço do Fornecedor

bairrostring · mín: 1 · máx: 30Obrigatório

Bairro do Fornecedor

cepstring · mín: 1 · máx: 8Obrigatório

Código do CEP do Fornecedor (sem formatação)

caixaPostalstring · máx: 10Opcional

Caixa Postal do Fornecedor

cidadestring · máx: 60Opcional

Cidade do Fornecedor

estadostring · mín: 2 · máx: 2Opcional

Estado do Fornecedor

codPaisBacenstring · máx: 4Opcional

Código do Pais/Bacen do Fornecedor

codIbgestring · máx: 7Opcional

Código do IBGE do Fornecedor

codPaisstring · máx: 3Opcional

Código do País do Fornecedor

telefonestring · máx: 15Opcional

Priemiro Telefone do Fornecedor

telefone1string · máx: 15Opcional

Segundo Telefone do Fornecedor

contatostring · máx: 30Opcional

Contato do Fornecedor

classificacaointeger · enumObrigatório

Classificação do Fornecedor (1-Física, 2-Jurídica, 3-Outros, 4-Produtor,5-Exterior)

Valores possíveis:

codCategoriainteger · mín: 1 · máx: 99Obrigatório

Código da Categoria do Fornecedor

codGrupointeger · mín: 1 · máx: 999Obrigatório

Código do Grupo do Fornecedor

iteminteger · mín: 1 · máx: 999Opcional

Item do Fornecedor

paisCidadeExteriorstring · máx: 30Opcional

País e Cidade do Exterior do Fornecedor

codNIFstring · máx: 35Opcional

Código NIF do Fornecedor

idPessoaEstrangeirastring · máx: 20Opcional

Id de Pessoa Estrangeira

contaContabilstring · máx: 5Opcional

Conta Contábil do Fornecedor

codigoEntidadeinteger · máx: 99999Opcional

Código da Entidade do Fornecedor

codTransportadorinteger · máx: 9999Opcional

Código do Transportador do Fornecedor

emailstring · máx: 50Opcional

E-mail do Fornecedor

emailNfestring · máx: 60Opcional

E-mail para Nota Fiscal Eletrônica do Fornecedor

observacao1string · máx: 35Opcional

Observação

observacao2string · máx: 35Opcional

Continuação da Observação

observacao3string · máx: 35Opcional

Continuação da Observação

observacao4string · máx: 35Opcional

Continuação da Observação

codContaContJurosstring · máx: 5Opcional

Conta Contábil de Juros do Fornecedor

codContaContMultastring · máx: 5Opcional

Conta Contábil de Multa do Fornecedor

codContaContDescontostring · máx: 5Opcional

Conta Contábil de Desconto do Fornecedor

obrigaFluxoCaixainteger · enumOpcional

Obriga o Fluxo de Caixa para o Fornecedor? (0-Não, 1-Sim)

Valores possíveis:

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

put

/fornecedor

PUT /cadastrosgerais/v10/fornecedor HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 846

{
  "codFornecedor": 1,
  "cpfCnpj": "text",
  "nome": "text",
  "nomeFantasia": "text",
  "inscEstadual": "text",
  "inscMunicipal": "text",
  "situacao": 1,
  "endereco": "text",
  "numero": "text",
  "complemento": "text",
  "bairro": "text",
  "cep": "text",
  "caixaPostal": "text",
  "cidade": "text",
  "estado": "text",
  "codPaisBacen": "text",
  "codIbge": "text",
  "codPais": "text",
  "telefone": "text",
  "telefone1": "text",
  "contato": "text",
  "classificacao": 1,
  "codCategoria": 1,
  "codGrupo": 1,
  "item": 1,
  "paisCidadeExterior": "text",
  "codNIF": "text",
  "idPessoaEstrangeira": "text",
  "contaContabil": "text",
  "codigoEntidade": 1,
  "codTransportador": 1,
  "email": "text",
  "emailNfe": "text",
  "observacao1": "text",
  "observacao2": "text",
  "observacao3": "text",
  "observacao4": "text",
  "codContaContJuros": "text",
  "codContaContMulta": "text",
  "codContaContDesconto": "text",
  "obrigaFluxoCaixa": 0,
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

{
  "codEmpresa": 1,
  "codFornecedor": 1,
  "cpfCnpj": "text",
  "nome": "text",
  "nomeFantasia": "text",
  "inscEstadual": "text",
  "inscMunicipal": "text",
  "situacao": 1,
  "endereco": "text",
  "numero": "text",
  "complemento": "text",
  "bairro": "text",
  "cep": "text",
  "caixaPostal": "text",
  "cidade": "text",
  "estado": "text",
  "codPaisBacen": "text",
  "codIbge": "text",
  "codPais": "text",
  "telefone": "text",
  "telefone1": "text",
  "contato": "text",
  "classificacao": 1,
  "codCategoria": 1,
  "codGrupo": 1,
  "item": 1,
  "paisCidadeExterior": "text",
  "codNIF": "text",
  "idPessoaEstrangeira": "text",
  "contaContabil": "text",
  "codigoEntidade": 1,
  "codTransportador": 1,
  "email": "text",
  "emailNfe": "text",
  "observacao1": "text",
  "observacao2": "text",
  "observacao3": "text",
  "observacao4": "text",
  "codContaContJuros": 1,
  "codContaContMulta": 1,
  "codContaContDesconto": 1,
  "obrigaFluxoCaixa": 0,
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Obter um Fornecedor

get

/fornecedor/{id}

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Fornecedor

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/fornecedor/{id}

GET /cadastrosgerais/v10/fornecedor/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "codEmpresa": 1,
  "codFornecedor": 1,
  "cpfCnpj": "text",
  "nome": "text",
  "nomeFantasia": "text",
  "inscEstadual": "text",
  "inscMunicipal": "text",
  "situacao": 1,
  "endereco": "text",
  "numero": "text",
  "complemento": "text",
  "bairro": "text",
  "cep": "text",
  "caixaPostal": "text",
  "cidade": "text",
  "estado": "text",
  "codPaisBacen": "text",
  "codIbge": "text",
  "codPais": "text",
  "telefone": "text",
  "telefone1": "text",
  "contato": "text",
  "classificacao": 1,
  "codCategoria": 1,
  "codGrupo": 1,
  "item": 1,
  "paisCidadeExterior": "text",
  "codNIF": "text",
  "idPessoaEstrangeira": "text",
  "contaContabil": "text",
  "codigoEntidade": 1,
  "codTransportador": 1,
  "email": "text",
  "emailNfe": "text",
  "observacao1": "text",
  "observacao2": "text",
  "observacao3": "text",
  "observacao4": "text",
  "codContaContJuros": 1,
  "codContaContMulta": 1,
  "codContaContDesconto": 1,
  "obrigaFluxoCaixa": 0,
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Atualizar um Fornecedor

put

/fornecedor/{id}

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Fornecedor

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

codFornecedorinteger · máx: 99999Opcional

Código do Fornecedor

cpfCnpjstring · mín: 1 · máx: 14Opcional

Código do CPF ou CNPJ do Fornecedor (sem formatação)

nomestring · mín: 1 · máx: 60Obrigatório

Nome do Fornecedor

nomeFantasiastring · máx: 30Opcional

Nome Fantasia do Fornecedor

inscEstadualstring · mín: 1 · máx: 17Opcional

Código da Inscrição Estadual do Fornecedor (sem formatação)

inscMunicipalstring · máx: 15Opcional

Código da Inscrição Municipal do Fornecedor (sem formatação)

situacaointegerObrigatório

Situação do Fornecedor (0-Inativo, 1-Ativo)

enderecostring · mín: 1 · máx: 60Obrigatório

Endereço do Fornecedor

numerostring · mín: 1 · máx: 5Obrigatório

Número do Endereço do Fornecedor

complementostring · máx: 30Opcional

Complemento do Endereço do Fornecedor

bairrostring · mín: 1 · máx: 30Obrigatório

Bairro do Fornecedor

cepstring · mín: 1 · máx: 8Obrigatório

Código do CEP do Fornecedor (sem formatação)

caixaPostalstring · máx: 10Opcional

Caixa Postal do Fornecedor

cidadestring · máx: 60Opcional

Cidade do Fornecedor

estadostring · mín: 2 · máx: 2Opcional

Estado do Fornecedor

codPaisBacenstring · máx: 4Opcional

Código do Pais/Bacen do Fornecedor

codIbgestring · máx: 7Opcional

Código do IBGE do Fornecedor

codPaisstring · máx: 3Opcional

Código do País do Fornecedor

telefonestring · máx: 15Opcional

Priemiro Telefone do Fornecedor

telefone1string · máx: 15Opcional

Segundo Telefone do Fornecedor

contatostring · máx: 30Opcional

Contato do Fornecedor

classificacaointeger · enumObrigatório

Classificação do Fornecedor (1-Física, 2-Jurídica, 3-Outros, 4-Produtor,5-Exterior)

Valores possíveis:

codCategoriainteger · mín: 1 · máx: 99Obrigatório

Código da Categoria do Fornecedor

codGrupointeger · mín: 1 · máx: 999Obrigatório

Código do Grupo do Fornecedor

iteminteger · mín: 1 · máx: 999Opcional

Item do Fornecedor

paisCidadeExteriorstring · máx: 30Opcional

País e Cidade do Exterior do Fornecedor

codNIFstring · máx: 35Opcional

Código NIF do Fornecedor

idPessoaEstrangeirastring · máx: 20Opcional

Id de Pessoa Estrangeira

contaContabilstring · máx: 5Opcional

Conta Contábil do Fornecedor

codigoEntidadeinteger · máx: 99999Opcional

Código da Entidade do Fornecedor

codTransportadorinteger · máx: 9999Opcional

Código do Transportador do Fornecedor

emailstring · máx: 50Opcional

E-mail do Fornecedor

emailNfestring · máx: 60Opcional

E-mail para Nota Fiscal Eletrônica do Fornecedor

observacao1string · máx: 35Opcional

Observação

observacao2string · máx: 35Opcional

Continuação da Observação

observacao3string · máx: 35Opcional

Continuação da Observação

observacao4string · máx: 35Opcional

Continuação da Observação

codContaContJurosstring · máx: 5Opcional

Conta Contábil de Juros do Fornecedor

codContaContMultastring · máx: 5Opcional

Conta Contábil de Multa do Fornecedor

codContaContDescontostring · máx: 5Opcional

Conta Contábil de Desconto do Fornecedor

obrigaFluxoCaixainteger · enumOpcional

Obriga o Fluxo de Caixa para o Fornecedor? (0-Não, 1-Sim)

Valores possíveis:

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

put

/fornecedor/{id}

PUT /cadastrosgerais/v10/fornecedor/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 846

{
  "codFornecedor": 1,
  "cpfCnpj": "text",
  "nome": "text",
  "nomeFantasia": "text",
  "inscEstadual": "text",
  "inscMunicipal": "text",
  "situacao": 1,
  "endereco": "text",
  "numero": "text",
  "complemento": "text",
  "bairro": "text",
  "cep": "text",
  "caixaPostal": "text",
  "cidade": "text",
  "estado": "text",
  "codPaisBacen": "text",
  "codIbge": "text",
  "codPais": "text",
  "telefone": "text",
  "telefone1": "text",
  "contato": "text",
  "classificacao": 1,
  "codCategoria": 1,
  "codGrupo": 1,
  "item": 1,
  "paisCidadeExterior": "text",
  "codNIF": "text",
  "idPessoaEstrangeira": "text",
  "contaContabil": "text",
  "codigoEntidade": 1,
  "codTransportador": 1,
  "email": "text",
  "emailNfe": "text",
  "observacao1": "text",
  "observacao2": "text",
  "observacao3": "text",
  "observacao4": "text",
  "codContaContJuros": "text",
  "codContaContMulta": "text",
  "codContaContDesconto": "text",
  "obrigaFluxoCaixa": 0,
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

{
  "codEmpresa": 1,
  "codFornecedor": 1,
  "cpfCnpj": "text",
  "nome": "text",
  "nomeFantasia": "text",
  "inscEstadual": "text",
  "inscMunicipal": "text",
  "situacao": 1,
  "endereco": "text",
  "numero": "text",
  "complemento": "text",
  "bairro": "text",
  "cep": "text",
  "caixaPostal": "text",
  "cidade": "text",
  "estado": "text",
  "codPaisBacen": "text",
  "codIbge": "text",
  "codPais": "text",
  "telefone": "text",
  "telefone1": "text",
  "contato": "text",
  "classificacao": 1,
  "codCategoria": 1,
  "codGrupo": 1,
  "item": 1,
  "paisCidadeExterior": "text",
  "codNIF": "text",
  "idPessoaEstrangeira": "text",
  "contaContabil": "text",
  "codigoEntidade": 1,
  "codTransportador": 1,
  "email": "text",
  "emailNfe": "text",
  "observacao1": "text",
  "observacao2": "text",
  "observacao3": "text",
  "observacao4": "text",
  "codContaContJuros": 1,
  "codContaContMulta": 1,
  "codContaContDesconto": 1,
  "obrigaFluxoCaixa": 0,
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Excluir um Fornecedor

delete

/fornecedor/{id}

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Fornecedor

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

delete

/fornecedor/{id}

DELETE /cadastrosgerais/v10/fornecedor/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

Sem conteúdo

AnteriorGrupo de Clientes PróximoTransportadora

Atualizado há 1 hora

Boa noite

Obter Listagem de Fornecedores

Cadastrar um Fornecedor

Obter um Fornecedor

Atualizar um Fornecedor

Excluir um Fornecedor