Alteração de Negócio

Alteração de Negócio

Se deseja alterar os dados do negócio criado, você deverá utilizar esse método. O processo é similar a criação de negócio.

Para alterar qualquer um dos dados, toda a estrutura deverá ser enviada novamente, contendo os dados alterados.

Realize a atualização via PUT na rota Url/segments/{segmentId}/companies/{id}.

Para obter o ID do negócio, veja Listar Negócios.

O SegmentID deverá ser informado, saiba mais em Login via API. O uso de seu Bearer Token também será necessário. Repare que, caso possua alguma nova integração com algum de nossos sistemas, você poderá fornecer seus dados necessários para que estes sejam incluídos em sua conta.

Alterar Negócio

PUT {Url}/segments/{segmentId}/companies/{id}

Path Parameters

Name	Type	Description
segmentId*	string	ID de Segmento
id	array	ID de empresas para alterar

Request Body

Name	Type	Description
type*	string	Tipo de Negócio (Pessoa Física: private | Pessoa Jurídica: legal )
document*	string	CPF/CNPJ do Negócio
name*	string	Nome do Negócio
address*	array	Endereço: address.country: ID do país* address.state: ID do estado* address.city: ID da cidade* address.neighborhood: Bairro* address.street: Endereço* address.number: Número do Prédio* address.postalCode: CEP do Endereço* address.complement: Complemento address._id: ID do endereço (em UUID)
contacts*	array	Contatos: contacts.contact: Número de contato* contacts.type: Tipo de contato (Telefone: phone | Celular: cellPhone | WhatsApp: whatsapp)*
activityBranch	string	Ramo de atividade ( retail foods events others )
planType	string	Tipo de plano (Mensal: monthly | Anual: yearly)
logoUrl	string	URL da logo (https://subdominio.site.com.br/foto.ico)
crtId	string	ID do CRT
integration	array	Integrações: PraNotas integration.praNotas.authorization: Chave de Integração* integration.praNotas.certificate: PraNotas Certificate* integration.praNotas.homologation: Ambiente de Homologação ( true | false ) integration.praNotas.status: praNotas status integration.praNotas.count: praNotas initial count integration.praNotas.serie: praNotas número de serie integration.praNotas.csc: praNotas CSC integration.praNotas.cscId: praNotas CSC ID PagaRapido integration.pagaRapido.authorization: Chave de Integração* PraSaques integration.praSaques.token: Token de Autorização*
planId	string	ID do plano
card	array	Cartão: card.name: Nome do Cartão* card.number: Número do Cartão* card.expirationDate: Data de Vencimento* card.cvv: Código de Segurança*
stateInscription*	string	Inscrição Estadual
cnaeList*	object	Objeto com lista de CNAEs da empresa
loyaltyConfiguration	object	Configuração de fidelidade loyaltyConfiguration.ref: Referência* loyaltyConfiguration.metadata: Dados adicionais

400 Informações não foram fornecidas corretamente

[]

401 Verifique se o Bearer Token utilizado é válido e tente novamente.

{
    "tag": "string",
    "message": "string"
}

404 Verifique a rota e método utilizado.

[]

409 Já existe um negócio com o CPF/CNPJ informado

}

200 OK

{
  "_id": "string",
  "createdAt": "2020-01-01T00:00:00Z",
  "updatedAt": "2020-01-01T00:00:00Z",
  "segment": "string",
  "type": "private",
  "document": "string",
  "name": "string",
  "tag": "string",
  "logoUrl": "string",
  "crtId": "string",
  "addresses": [
    {
      "_id": "string",
      "country": "string",
      "state": "string",
      "city": "string",
      "neighborhood": "string",
      "street": "string",
      "number": "string",
      "complement": "string",
      "postalCode": "string"
    }
  ],
  "contacts": [
    {
      "contact": "string",
      "type": "whatsapp"
    }
  ],
  "integration": {
    "praNotas": {
      "authorization": "string",
      "homologation": true,
      "certificate": "string",
      "status": "string",
      "count": 0,
      "serie": "string",
      "csc": "string",
      "cscId": "string"
    },
    "pagaRapido": {
      "authorization": "string",
      "subscription": "string"
    },
    "praSaques": {
      "token": "string"
    }
  },
  "activityBranch": {
    "_id": "string",
    "name": "string",
    "examples": "string",
    "value": "retail"
  },
  "stockSettings": {
    "stockLocalDevice": {
      "_id": "string",
      "createdAt": "2020-01-01T00:00:00Z",
      "updatedAt": "2020-01-01T00:00:00Z",
      "name": "string",
      "company": null,
      "acronym": "string",
      "segment": "string"
    },
    "stockLocalCatalog": {
      "_id": "string",
      "createdAt": "2020-01-01T00:00:00Z",
      "updatedAt": "2020-01-01T00:00:00Z",
      "name": "string",
      "company": null,
      "acronym": "string",
      "segment": "string"
    }
  }
}

Caso a requisição esteja correta, o código 200 OK será retornado. Prossiga para a próxima sessão para realizar o cadastro de seus produtos.

Outros Erros: Caso sejam retornados outros erros, favor entrar em contato com o time de integração.