Empresas / Companies

Cadastro / Add

[PT] Este serviço permite o cadastro de uma nova empresa. Um JSON no formato abaixo relacionado deve ser enviado como payload. Os campos obrigatórios estão marcados com um "*" na aba "Model".

[EN] Creates a new company. The payload to be sent is the bellow JSON. Required fields have a asterisk mark "*" in "Model" tab.

post/companies

Request

  • Base URL: https://api.nexti.com
  • URL: https://api.nexti.com/companies
  • Auth: OAuth 2 (client credentials, token URL https://api.nexti.com/security/oauth/token)

Request body

idinteger

[PT]ID da empresa [EN]Company ID

companyNamestring required

[PT]Nome da empresa [EN]Company name

companyNumberType'CPF' | 'CNPJ'

[PT]Tipo do número da empresa. [EN]Company Number Type.

companyNumberstring

[PT]Número da empresa - Desconsiderar caracteres especiais. [EN]Company Number - Disregard special characters.

fantasyNamestring required

[PT]Nome Fantasia da empresa [EN]Fantasy company Name

externalIdstring

[PT]ID externo da empresa [EN]External company ID

activeboolean required

[PT]Empresa ativa(sim ou não) [EN]Active company(true or false)

Example request

{
  "companyNumberType": "CPF | CNPJ"
}

Response

OK

idinteger

ID do response

messagestring

Mensagem do response

commentsstring[]

Comentários do response

Example response

{
  "value": {
    "companyNumberType": "CPF | CNPJ"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.