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/forma-emissao

Ambiente Produção: https://motorfiscal.raas.varejo.totvs.com.br/registering/api/v1/forma-emissao

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

{
    "nome": "Nome da forma de emissão",
    "modeloDocumento": "57",
    "dataIni": "Data Inicial da Contingência (Ex.: 2023-04-24T16:00)",
    "dataFim": "Data Final da Contingência (Ex.: 2023-04-25T19:00)",
    "tipoEmissao": "7",
    "justificativa": "Justificava da contingência.",
    "ativo": true,
    "estabelecimentos": [
        {
            "id": "7c62a772-f6b0-44b6-aba0-d7fdb609caec"
        }
    ]
}

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)
Modelo JSON (retorno) quando retorna status 201:

{
    "id": "e32da8fd-a736-4e24-844c-db200aa83123",
    "nome": "Nome da forma de emissão",
    "tipoEmissao": "7",
    "modeloDocumento": "57",
    "dataIni": "2023-04-24T16:00:00",
    "dataFim": "2023-04-25T19:00:00",
    "justificativa": "Justificava da contingência.",
    "ativo": true,
    "estabelecimentos": [
        {
            "id": "7c62a772-f6b0-44b6-aba0-d7fdb609caec",
            "ativo": false,
            "cnae": 0
        }
    ]
}

AtributoDetalhes
Código
Título

Informar título da mensagem.

Descrição

Informar descrição e conteúdo da mensagem.

tipoEmissao

Informar uma das formas de emissão em contingência :

  • CONTINGENCIA_SVCRS: 7 - Autorização pela SVC-RS que abrange os estados: AC, AL, AM, BA, CE, DF, ES, GO, MA, PA, PB, PI, RJ, RN, RO, SC, SE, TO 
  • CONTINGENCIA_SVCSP: 8 - Autorização pela SVC-SP que abrange os estados: AP, PE, RR;

02. Atualizar

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

{
    "nome": "FE008",
    "modeloDocumento": "57",
    "dataIni": "2023-04-25T16:00",
    "dataFim": "2023-04-27T19:00",
    "tipoEmissao": "7",
    "justificativa": "Contingência Programada Alterada",
    "ativo": true,
    "estabelecimentos": [
        {
            "id": "7c62a772-f6b0-44b6-aba0-d7fdb609caec"
        }
    ]
}

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

03. Excluir

Endpoint:

Ambiente Stage: https://stg.motorfiscal.raas.varejo.totvs.com.br/registering/api/v1/forma-emissao/{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/forma-emissao/{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": "e32da8fd-a736-4e24-844c-db200aa83362",
    "nome": "FE009",
    "tipoEmissao": "7",
    "modeloDocumento": "57",
    "dataIni": "2023-04-24T16:00:00",
    "dataFim": "2023-04-25T19:00:00",
    "justificativa": "Contingência Programada",
    "ativo": true,
    "estabelecimentos": [
        {
            "id": "7c62a772-f6b0-44b6-aba0-d7fdb609caec",
            "cnpj": "01107327000715",
            "nome": "BBM S.A. - Telemaco Borba",
            "razaoSocial": "BBM Logistica S.A",
            "ativo": true,
            "inscricaoEstadual": "9056542687",
            "cnae": 0,
            "codigoExterno": "EMIT002",
            "enderecos": [
                {
                    "paisId": 1,
                    "estadoId": 18,
                    "cidadeId": 3158,
                    "bairro": "Harmonia",
                    "cepZipCode": "84275000",
                    "logradouro": "Rod Pr 160",
                    "numero": "0",
                    "principal": true,
                    "email": "teste@teste.com.br",
                    "telefone": "11111111111"
                }
            ]
        }
    ]
}

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

05. Consultar

Endpoint:

Ambiente Stage: https://stg.motorfiscal.raas.varejo.totvs.com.br/registering/api/v1/forma-emissao/filtros

Método:GET
Descrição:Utilize este recurso para buscar os registros.
Parâmetros:

Filtros:

  • nome: nome da Forma de Emissão. Ex.: Forma Emissao 001 
  • modeloDocumento: tipo do documento. Ex.: 57, 99 e 58
  • tipoEmissao: tipo da emissão. Ex.: 7 ou 8
  • data: data que estiver dentro de um range. Ex.: 2023-04-25T20:00
  • pesquisar:utilizado pelo front-end. Ex.: emit002 (codigo estabelecimento) e cont (parte do nome)
  • ativo: se o registro está ativo. Ex.: ATIVO, INATIVO ou AMBOS
  • justificativa: justificativa. Ex.: Cont
  • codEstabelecimento: código do estabelecimento. Ex.: EMIT002
Modelo JSON (retorno)

{
    "content": [
        {
            "id": "e32da8fd-a736-4e24-844c-db200aa83362",
            "nome": "FE009",
            "tipoEmissao": "7",
            "modeloDocumento": "57",
            "dataIni": "2023-04-24T16:00:00",
            "dataFim": "2023-04-25T19:00:00",
            "justificativa": "Contingência Programada",
            "ativo": true,
            "estabelecimentos": [
                {
                    "id": "7c62a772-f6b0-44b6-aba0-d7fdb609caec",
                    "cnpj": "01107327000715",
                    "nome": "BBM S.A. - Telemaco Borba",
                    "razaoSocial": "BBM Logistica S.A",
                    "ativo": true,
                    "inscricaoEstadual": "9056542687",
                    "cnae": 0,
                    "codigoExterno": "EMIT002",
                    "enderecos": [
                        {
                            "paisId": 1,
                            "estadoId": 18,
                            "cidadeId": 3158,
                            "bairro": "Harmonia",
                            "cepZipCode": "84275000",
                            "logradouro": "Rod Pr 160",
                            "numero": "0",
                            "principal": true,
                            "email": "teste@teste.com.br",
                            "telefone": "11111111111"
                        }
                    ]
                }
            ]
        }
    ],
    "pageable": {
        "sort": {
            "sorted": false,
            "unsorted": true,
            "empty": true
        },
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 20,
        "paged": true,
        "unpaged": false
    },
    "totalElements": 1,
    "totalPages": 1,
    "last": true,
    "size": 20,
    "number": 0,
    "sort": {
        "sorted": false,
        "unsorted": true,
        "empty": true
    },
    "numberOfElements": 1,
    "first": true,
    "empty": false
}

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