TOTVS Motor Fiscal

Árvore de páginas

CONTEÚDO

01. Inserir

Endpoint:

Ambiente Stage: https://stg.motorfiscal.raas.varejo.totvs.com.br/registering/api/v1/estabelecimento

Método:POST
Descrição:Utilize este recurso para inserir um novo cadastro.
Modelo JSON (envio):

{
  "ativo": true,
  "tipoDocumento": "PESSOA_JURIDICA",
  "nome": null,
  "nomeFantasia": "TESTE RAZAO",
  "documento": "12345678912345",
  "codigoExterno": "teste",
  "razaoSocial": "TESTE RAZAO",
  "inscricaoEstadual": "123456789",
  "inscricaoMunicipal": "123456789",
  "regimeTributario": null,
  "cnae": null,
  "rntrc": null,
  "enderecos": [
    {
      "indTabela": 0,
      "principal": true,
      "paisId": "1",
      "paisNome": "Brasil",
      "estadoId": "1",
      "estadoUf": "AC",
      "estadoNome": "Acre",
      "cidadeId": "79",
      "cidadeNome": "Acrelândia",
      "bairro": "jd teste",
      "cepZipCode": "02864564",
      "logradouro": "Rua teste",
      "numero": "240",
      "telefone": null,
      "email": null,
      "complemento": null
    }
  ]
}

Status de retorno:
(HTTP - Status Code)
  • 201 - Created (Criado)
  • 400 - Bad Request (Um ou mais campos estão inválidos. Faça o preenchimento correto e tente novamente)
  • 401 - Unauthorized (Falha na autenticação)
  • 500 - Internal Error (Falha de comunicação com a fila: fiscal-motor-starting-calculating-topic ou Dados mínimos precisam ser preenchidos)
Modelo JSON (retorno) quando retorna status 201:

{
    "id": "cdbdc2c2-9305-45f2-9a24-d0d3b03e90fb",
    "tipoDocumento": "PESSOA_JURIDICA",
    "documento": "12345678912345",
    "nomeFantasia": "TESTE RAZAO",
    "razaoSocial": "TESTE RAZAO",
    "ativo": true,
    "inscricaoEstadual": "123456789",
    "inscricaoMunicipal": "123456789",
    "cnae": 0,
    "codigoExterno": "teste",
    "enderecos": [
        {
            "paisId": 1,
            "paisNome": "Brasil",
            "estadoId": 1,
            "estadoUf": "AC",
            "estadoCodIbge": 12,
            "estadoNome": "Acre",
            "cidadeId": 79,
            "cidadeCodIbge": 1200013,
            "cidadeNome": "Acrelândia",
            "bairro": "jd teste",
            "cepZipCode": "02864564",
            "logradouro": "Rua teste",
            "numero": "240",
            "principal": true
        }
    ]
}

AtributoDetalhes
codigoExterno
nomeFantasia

Informar apenas quando se tratar de ator PESSOA_JURIDICA.

razaoSocial

Informar apenas quando se tratar de ator PESSOA_JURIDICA.

nome

Informar apenas quando se tratar de ator PESSOA_FISICA ou ESTRANGEIRO.
tipoDocumeto

Os valores permitidos para esse campo são:

  • PESSOA_JURIDICA - Quando é uma entidade (empresa, sociedade, organização etc) e o documento é CNPJ.
  • PESSOA_FISICA - Quando é uma pessoa, individuo e o documento é um CPF.

documento

Preenchido com CNPJ quando for PESSOA_JURIDICA ou com CPF quando for PESSOA_FISICA.

inscricaoEstadual
bairro
cepZipCode
cidade

Os atributos permitidos são:

  • "cidadeId" - Informar quando for o id interno da cidade. Exemplo: "cidadeId": 5270
  • "cidadeNome" - Informar quando for o nome da cidade. O Nome da cidade deve ser preenchido exatamente como está cadastrado no IBGE. Exemplo:"cidadeNome": São Paulo

Caso seja informado a "cidadeId", não deve informar a "cidadeNome" e vice-versa

complemento
estado

Os atributos permitidos são:

  • "estadoId" - Informar quando for o id interno do país. Exemplo: "estadoId": 26
  • "estadoNome" - Informar quando for o nome do estado. O Nome do estado deve ser preenchido exatamente como está cadastrado no IBGE.
  • "estadoUf" - Informar Sigla UF do estado.

Exemplo:"estadoNome": São Paulo

Exemplo: "estadoUf":"SP"

Caso seja informado o "estadoId", não deve informar o "estadoNome" e "estadoUf" e vice-versa

Enviar apenas um dos atributos.

logradouro
numero
pais

Os atributos permitidos são:

  • "paisId" - Informar quando for o id interno do país. Exemplo: "paisId": 1
  • "paisNome" - Informar quando for o nome do país. Exemplo:"paisId": Brasil

Caso seja informado o "paisId", não deve informar o "paisNome" e vice-versa



02. Atualizar

Endpoint:

Ambiente Stage: https://stg.motorfiscal.raas.varejo.totvs.com.br/registering/api/v1/estabelecimento/{id}

Método:PUT
Descrição:Utilize este recurso para atualizar os dados de um registro já cadastrado.
Parâmetro:Id: valor utilizado para encontrar o registro que será alterado com os dados do corpo da requisição.
Modelo JSON (envio):

{
    "id":"cdbdc2c2-9305-45f2-9a24-d0d3b03e90fb1",
    "ativo": true,
    "tipoDocumento": "PESSOA_FISICA",
    "nome": "TESTE RAZAO LEO",
    "documento": "12345678946",
    "codigoExterno": "teste leo",
    "razaoSocial": null,
    "inscricaoEstadual": null,
    "inscricaoMunicipal": null,
    "regimeTributario": "SIMPLES_NACIONAL",
    "cnae": 0,
    "rntrc": null,
    "enderecos": [
        {
            "paisId": 1,
            "paisNome": "Brasil",
            "estadoId": 1,
            "estadoUf": "AC",
            "estadoCodIbge": 12,
            "estadoNome": "Acre",
            "cidadeId": 79,
            "cidadeCodIbge": 1200013,
            "cidadeNome": "Acrelândia",
            "bairro": "jd teste",
            "cepZipCode": "02864070",
            "logradouro": "Rua teste",
            "numero": "240",
            "principal": true,
            "indTabela": 0
        }
    ]
}

Status de retorno:
(HTTP - Status Code)		200 - OK
Observações:As observações citadas na inclusão também se aplicam na alteração.

03. Excluir

Endpoint:

Ambiente Stage: https://stg.motorfiscal.raas.varejo.totvs.com.br/registering/api/v1/estabelecimento/{id}

Método:DELETE
Descrição:Utilize este recurso para excluir um registro.
Parâmetro:Id: valor utilizado para encontrar o registro que será excluído.
Status de retorno:
(HTTP - Status Code)		204 - No Content

04. Consultar Registro Específico

Endpoint:

Ambiente Stage: https://stg.motorfiscal.raas.varejo.totvs.com.br/registering/api/v1/estabelecimento/{id}

Método:GET
Descrição:Utilize este recurso para detalhar os dados de um registro.
Parâmetro:Id: valor utilizado para encontrar o registro que será alterado com os dados do corpo da requisição.
Modelo JSON (retorno)

{
    "id": "2ceb55e1-4112-48d1-bdba-47b47c8725fb",
    "tipoDocumento": "PESSOA_JURIDICA",
    "documento": "12345678912345",
    "nomeFantasia": "TESTE RAZAO ",
    "razaoSocial": "TESTE RAZAO ",
    "ativo": true,
    "inscricaoEstadual": "123456789",
    "inscricaoMunicipal": "123456789",
    "cnae": 0,
    "codigoExterno": "teste ",
    "enderecos": [
        {
            "paisId": 1,
            "paisNome": "Brasil",
            "estadoId": 1,
            "estadoUf": "AC",
            "estadoCodIbge": 12,
            "estadoNome": "Acre",
            "cidadeId": 79,
            "cidadeCodIbge": 1200013,
            "cidadeNome": "Acrelândia",
            "bairro": "jd teste",
            "cepZipCode": "02864564",
            "logradouro": "Rua teste",
            "numero": "240",
            "principal": true
        }
    ]
}

Status de retorno:
(HTTP - Status Code)		200 - OK

05. Consultar

Endpoint:Ambiente Stage: https://stg.motorfiscal.raas.varejo.totvs.com.br/registering/api/v1/estabelecimento/filtros
Método:GET
Descrição:Utilize este recurso para detalhar os dados de um registro.
Parâmetros:

Filtros:

  • tipoDocumento: tipo do ator (PESSOA_FISICA, PESSOA_JURIDICA)
  • documento: numero do documento fiscal do ator (CNPJ, CPF)
  • nomeFantasia: nome do ator (preenchido quando for do tipo pessoa jurídica)
  • razaoSocial: nome jurídico do ator (preenchido quando for do tipo pessoa jurídica)
  • nome: nome do ator (preenchido quando for do tipo pessoa física)
  • codigoExterno: código utilizado para identificação do ator.
Modelo JSON (retorno)

{
    "content": 

{
            "id": "2ceb55e1-4112-48d1-bdba-47b47c8725fb",
            "tipoDocumento": "PESSOA_JURIDICA",
            "documento": "12345678912345",
            "nomeFantasia": "TESTE RAZAO ",
            "razaoSocial": "TESTE RAZAO ",
            "ativo": true,
            "inscricaoEstadual": "123456789",
            "inscricaoMunicipal": "123456789",
            "cnae": 0,
            "codigoExterno": "teste ",
            "enderecos": [
                {
                    "paisId": 1,
                    "paisNome": "Brasil",
                    "estadoId": 1,
                    "estadoUf": "AC",
                    "estadoCodIbge": 12,
                    "estadoNome": "Acre",
                    "cidadeId": 79,
                    "cidadeCodIbge": 1200013,
                    "cidadeNome": "Acrelândia",
                    "bairro": "jd teste",
                    "cepZipCode": "02864564",
                    "logradouro": "Rua teste",
                    "numero": "240",
                    "principal": true
                }
            ]
        },

    ],
    "pageable": {
        "sort": {
            "sorted": false,
            "unsorted": true,
            "empty": true
        },
        "pageNumber": 0,
        "pageSize": 20,
        "offset": 0,
        "unpaged": false,
        "paged": true
    },
    "last": true,
    "totalPages": 1,
    "totalElements": 1,
    "numberOfElements": 1,
    "first": true,
    "size": 20,
    "number": 0,
    "sort": {
        "sorted": false,
        "unsorted": true,
        "empty": true
    },
    "empty": false
}

Status de retorno:
(HTTP - Status Code)		200 - OK