TOTVS Motor Fiscal

Árvore de páginas

Versões comparadas

Versão antiga 24

changes.mady.by.user Suellen de Oliveira Baptista

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Paulo Henrique dos Reis_

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Endpoint:

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

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

{
    "codigoExterno": "Ator01001",
    "tipoAtor": "PESSOA_JURIDICA",
    "documento": "12345678912345",
    "nomeFantasia": "EMPRESA S.A.",
    "razaoSocial": "EMPRESA S.A.",
    "nome": null,
    "ativo": true,
    "inscricaoEstadual": null4566789,
    "inscricaoMunicipal": 1234586,
    "contribuinteIcms": false,
    "ramoAtividade": "COMERCIAL",
    "numDependentes": 2,
    "regimeTributario": "REGIME_NORMAL",
    "enderecos": [
        {
            "paisId": 1,
            "paisNome": "Brasil",
            "estadoId": 26,
            "estadoNome": "São Paulo",
            "estadoUf": "SP",
            "cidadeId": 5270,
            "cidadeNome": "São Paulo",
            "bairro": "Jardim das Pedras",
            "cepZipCode": "05215458",
            "logradouro": "Rua Afonso Pena",
            "numero": "55A",
            "complemento": "Conjunto 2",
            "principal": true,
            "email": "contato@totvs.com.br",
            "telefone": "999999999"
        }
    ],
    "cnaes": [
        {
            "id": "0c276bea-e138-a157-eb76-0011bddd4126",
            "principal": true
        },
        {
            "id": "bc4791b2-ef13-84aa-20b0-4c92f0f23ae6",
            "principal": false
        }
    ]
}

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": "abdfdcf5-80a5-4289-9144-318bd405365b",
    "codigo": "Ator01001",
    "tipoAtor": "PESSOA_JURIDICA",
    "documento": "12345678912345",
    "nomeFantasia": "EMPRESA S.A.",
    "razaoSocial": "EMPRESA S.A.",
    "ativo": true,
    "codigoExterno": "Ator01001",
    "contribuinteIcms": false,
    "inscricaoEstadual": 4566789,
    "inscricaoMunicipal": 1234586,
    "enderecos": [
        {
            "paisId": 1,
            "estadoId": 26,
            "cidadeId": 5270,
            "bairro": "Jardim das Pedras",
            "cepZipCode": "05215458",
            "logradouro": "Rua Afonso Pena",
            "numero": "55A",
            "complemento": "Conjunto 2",
            "principal": true,
            "email": "contato@totvs.com.br",
            "telefone": "999999999"
        }
    ],
    "ramoAtividade": "COMERCIAL",
    "regimeTributario": "REGIME_NORMAL",
    "numDependentes": 2,
    "cnaes": [
        {
            "id": "0c276bea-e138-a157-eb76-0011bddd4126",
            "codigo": "0111-3/03",
            "descricao": "Cultivo De Trigo",
            "principal": "true"
        },
        {
            "id": "bc4791b2-ef13-84aa-20b0-4c92f0f23ae6",
            "codigo": "01.12-1",
            "descricao": "Cultivo De Algodão Herbáceo E De Outras Fibras De Lavoura Temporária",
            "principal": "false"
        }
    ]
}

...

Endpoint:

Ambiente Stage: https://stg.motorfiscal.raas.varejo.totvs.com.br/registering/api/v1/ator/{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):

{
    "codigoExterno": "ATOR008",
    "tipoAtor": "PESSOA_JURIDICA",
    "documento": "123456789123459",
    "nomeFantasia": "EMPRESA S.A.",
    "razaoSocial": "EMPRESA S.A.",
    "nome": null,
    "ativo": true,
    "inscricaoEstadual": 4566789,
    "inscricaoMunicipal": null1234586,
    "contribuinteIcms": false,
    "numDependentes": 1,
    "regimeTributario": "SIMPLES_NACIONAL",
    "enderecos": [
        {
            "paisId": 1,
            "paisNome": "Brasil",
            "estadoId": 24,
            "estadoNome": "São Paulo",
            "estadoUf": "SP",
            "cidadeId": 4549,
            "cidadeNome": "São Paulo",
            "bairro": "Jardim das Pedras",
            "cepZipCode": "05215458",
            "logradouro": "Rua Afonso Pena",
            "numero": "55A",
            "complemento": "Conjuto 2",
            "principal": true,
            "email": "contato@totvs.com.br",
            "telefone": "9988887777"
        }
    ],
    "ramoAtividade": "COMERCIAL",
    "cnaes": [
        {
            "id": "95192310-508f-3ece-77d0-e11965cd45a8",
            "principal": true
        },
        {
            "id": "aa13d02e-6943-186b-a973-453324f123a1",
            "principal": false
        }
    ]
}

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

...

Endpoint:

Ambiente Stage: https://stg.motorfiscal.raas.varejo.totvs.com.br/registering/api/v1/ator/{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": "99701d8d-c888-441e-9569-692123053aab",
    "codigo": "ATOR008",
    "tipoAtor": "PESSOA_JURIDICA",
    "documento": "999999999",
    "nomeFantasia": "EMPRESA S.A.",
    "razaoSocial": "EMPRESA S.A.",
    "nome": null,
    "ativo": true,
    "codigoExterno": "ATOR008",
    "inscricaoEstadual": null4566789,
    "inscricaoMunicipal": 1234586,
    "contribuinteIcms": false,
    "numDependentes": 1,
    "regimeTributario": "SIMPLES_NACIONAL",
    "enderecos": [
        {
            "paisId": 1,
            "paisNome": "Brasil",
            "estadoId": 24,
            "estadoUf": "SC",
            "estadoCodIbge": 42,
            "estadoNome": "Santa Catarina",
            "cidadeId": 4549,
            "cidadeCodIbge": 4209102,
            "cidadeNome": "Joinville",
            "bairro": "Jardim das Pedras",
            "cepZipCode": "05215458",
            "logradouro": "Rua Afonso Pena",
            "numero": "55A",
            "complemento": "Conjuto 2",
            "principal": true,
            "email": "contato@totvs.com.br",
            "telefone": "9988887777"
        }
    ],
    "ramoAtividade": "COMERCIAL",
    "cnaes": [
        {
            "id": "95192310-508f-3ece-77d0-e11965cd45a8",
            "codigo": "0119-9/01",
            "descricao": "Cultivo De Abacaxi"

            "principal": "true"
        },
        {
            "id": "aa13d02e-6943-186b-a973-453324f123a1",
            "codigo": "0721-9/01",
            "descricao": "Extração De Minério De Alumínio"

            "principal": "false"
        }
    ]
}

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

...

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

Filtros:

  • tipoAtor: tipo do ator (PESSOA_FISICA, PESSOA_JURIDICA, ESTRANGEIRO)
  • documento: numero do documento fiscal do ator (CNPJ, CPF, ID ESTRANGEIRO)
  • 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": "99701d8d-c888-441e-9569-692123053aab",
            "codigo": "ATOR008",
            "tipoAtor": "PESSOA_JURIDICA",
            "documento": "1234567891234599",
            "nomeFantasia": "EMPRESA S.A.",
            "razaoSocial": "EMPRESA S.A.",
            "nome": null,
            "ativo": true,
            "codigoExterno": "ATOR008",
            "inscricaoEstadual": null            "inscricaoEstadual": 4566789,
            "inscricaoMunicipal": 1234586,
            "contribuinteIcms": false,
            "enderecos": [
                {
                    "paisId": 1,
                    "paisNome": "Brasil",
                    "estadoId": 24,
                    "estadoUf": "SC",
                    "estadoCodIbge": 42,
                    "estadoNome": "Santa Catarina",
                    "cidadeId": 4549,
                    "cidadeCodIbge": 4209102,
                    "cidadeNome": "Joinville",
                    "bairro": "Jardim das Pedras",
                    "cepZipCode": "05215458",
                    "logradouro": "Rua Afonso Pena",
                    "numero": "55A",
                    "complemento": "Conjuto 2",
                    "principal": true,
                    "email": "contato@totvs.com.br",
                    "telefone": "12345678912345"
                }
            ],
            "ramoAtividade": "COMERCIAL",
            "numDependentes": 2,
            "regimeTributario": "REGIME_NORMAL",
            "cnaes": [
                {
                    "id": "95192310-508f-3ece-77d0-e11965cd45a8",
                    "codigo": "0119-9/01",
                    "descricao": "Cultivo De Abacaxi"



                    "principal": "true"
                },
                {
                    "id": "aa13d02e-6943-186b-a973-453324f123a1",
                    "codigo": "0721-9/01",
                    "descricao": "Extração De Minério De Alumínio"

                    "principal": "false"
                }
            ]
        }
    ],
    "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