TOTVS Motor Fiscal

Árvore de páginas

  • Criado por Usuário desconhecido (thiano.lima), última alteração em 28 set, 2022

Você está vendo a versão antiga da página. Ver a versão atual.

Comparar com o atual Ver Histórico da Página

« Anterior Versão 9 Próxima »

01. Inserir

Endpoint:https://dev-fiscal-motor-registrando-ewqor2fuqq-uc.a.run.app/fiscal-motor-registrando/api/v1/ator
Método:POST
Descrição:Utilize este recurso para inserir um novo cadastro.
Corpo (json):

{
    "codigoExterno": "ATOR008",
    "tipoAtor": "PESSOA_JURIDICA",
    "documento": "12345678912345",
    "nomeFantasia": "CT-E EMITIDO EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL",
    "razaoSocial": "CT-E EMITIDO EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL",
    "nome": null,
    "ativo": true,
    "inscricaoEstadual": null,
    "contribuinteIcms": false,
    "enderecos": [
        {
            "paisId": 1,
            "estadoId": 24,
            "cidadeId": 4549,
            "bairro": "Jardim das Pedras",
            "cepZipCode": "05215458",
            "logradouro": "Rua Afonso Pena",
            "numero": "55A",
            "complemento": "Conjuto 2",
            "principal": true,
            "email": "[email protected]",
            "telefone": "999999999"
        }
    ],
    "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)		201 - Created

02. Atualizar

Endpoint:https://dev-fiscal-motor-registrando-ewqor2fuqq-uc.a.run.app/fiscal-motor-registrando/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.
Corpo (json):

{
    "codigoExterno": "ATOR008",
    "tipoAtor": "PESSOA_JURIDICA",
    "documento": "123456789123459",
    "nomeFantasia": "CT-E EMITIDO EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL",
    "razaoSocial": "CT-E EMITIDO EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL",
    "nome": null,
    "ativo": true,
    "inscricaoEstadual": null,
    "contribuinteIcms": false,
    "enderecos": [
        {
            "paisId": 1,
            "estadoId": 24,
            "cidadeId": 4549,
            "bairro": "Jardim das Pedras",
            "cepZipCode": "05215458",
            "logradouro": "Rua Afonso Pena",
            "numero": "55A",
            "complemento": "Conjuto 2",
            "principal": true,
            "email": "[email protected]",
            "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

03. Excluir

Endpoint:https://dev-fiscal-motor-registrando-ewqor2fuqq-uc.a.run.app/fiscal-motor-registrando/api/v1/ator/{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. Detalhar

Endpoint:https://dev-fiscal-motor-registrando-ewqor2fuqq-uc.a.run.app/fiscal-motor-registrando/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.
Retorno (json):

{
    "id": "99701d8d-c888-441e-9569-692123053aab",
    "codigo": "ATOR008",
    "tipoAtor": "PESSOA_JURIDICA",
    "documento": "999999999",
    "nomeFantasia": "CT-E EMITIDO EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL",
    "razaoSocial": "CT-E EMITIDO EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL",
    "nome": null,
    "ativo": true,
    "codigoExterno": "ATOR008",
    "inscricaoEstadual": null,
    "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": "[email protected]",
            "telefone": "9988887777"
        }
    ],
    "ramoAtividade": "COMERCIAL",
    "cnaes": [
        {
            "id": "95192310-508f-3ece-77d0-e11965cd45a8",
            "codigo": "0119-9/01",
            "descricao": "Cultivo De Abacaxi"
        },
        {
            "id": "aa13d02e-6943-186b-a973-453324f123a1",
            "codigo": "0721-9/01",
            "descricao": "Extração De Minério De Alumínio"
        }
    ]
}

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

05. Consultar

Endpoint:https://dev-fiscal-motor-registrando-ewqor2fuqq-uc.a.run.app/fiscal-motor-registrando/api/v1/ator/filtros
Método:GET
Descrição:Utilize este recurso para detalhar os dados de um registro.
Filtros:
  • pesquisar:
  • 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.
Retorno (json):

{
    "content": [
        {
            "id": "99701d8d-c888-441e-9569-692123053aab",
            "codigo": "ATOR008",
            "tipoAtor": "PESSOA_JURIDICA",
            "documento": "1234567891234599",
            "nomeFantasia": "CT-E EMITIDO EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL",
            "razaoSocial": "CT-E EMITIDO EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL",
            "nome": null,
            "ativo": true,
            "codigoExterno": "ATOR008",
            "inscricaoEstadual": null,
            "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": "[email protected]",
                    "telefone": "12345678912345"
                }
            ],
            "ramoAtividade": "COMERCIAL",
            "cnaes": [
                {
                    "id": "95192310-508f-3ece-77d0-e11965cd45a8",
                    "codigo": "0119-9/01",
                    "descricao": "Cultivo De Abacaxi"
                },
                {
                    "id": "aa13d02e-6943-186b-a973-453324f123a1",
                    "codigo": "0721-9/01",
                    "descricao": "Extração De Minério De Alumínio"
                }
            ]
        }
    ],
    "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
  • Sem rótulos