Árvore de páginas

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

Versão 1 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": "53113791001790",
    "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": "thiano.lima@totvs.com.br",
            "telefone": "18991330757"
        }
    ],
    "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": "53113791001790",
    "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": "thiano.lima@totvs.com.br",
            "telefone": "18991330757"
        }
    ],
    "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 - OK

02. 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):

{
  "nome": "Nome Completo",
  "nomeFantasia": "EMPRESA SA",
  "razaoSocial": "EMPRESA SA",
  "tipoAtor": "PESSOA_FISICA",
  "documento": "9999999999",
  "inscricaoEstadual": "132456789",
  "enderecos": [
    {
      "bairro": "Jardim das Pedras",
      "cepZipCode": "05215458",
      "cidadeId": 0,
      "complemento": "Conjuto 2",
      "estadoId": 0,
      "logradouro": "Rua Afonso Pena",
      "numero": "54A",
      "paisId": 0,
      "principal":true
    }
  ]
}

Status de retorno:
(HTTP - Status Code)
200 - OK
  • Sem rótulos