CONTEÚDO
Índice |
---|
minLevel | 2 |
---|
exclude | CONTEÚDO |
---|
style | none |
---|
|
01. Inserir
dev-fiscal-motor-registrando-ewqor2fuqq-uc.a.run.app/fiscal-motor-registrandoCorpo jsonenvio): | { "codigoExterno": " |
ATOR008Ator01001", "tipoAtor": "PESSOA_JURIDICA", "documento": " |
999999999912345678912345", "nomeFantasia": " |
CT-E EMITIDO EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCALEMPRESA S.A.", "razaoSocial": " |
CT-E EMITIDO EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL null true true, "inscricaoEstadual": |
nullcontribuinteIcms falseenderecos "cepZipCode": "05215458[ { "paisId": 1, "estadoId": 24, "cidadeId": 4549, "bairro": "Jardim das Pedras",false, "ramoAtividade": "COMERCIAL", "numDependentes": 2, "regimeTributario": "REGIME_NORMAL", "enderecos": [ { "paisId": 1, "paisNome": "Brasil", " |
logradouro"Rua Afonso Pena"numero55AcomplementoConjuto 2principal trueemailthiano.lima@totvs.com.brtelefone999999999" } ] ramoAtividadeCOMERCIAL "cnaes": [ {id95192310-508f-3ece-77d0-e11965cd45a8principal true }, {idaa13d02e-6943-186b-a973-453324f123a1Conjunto 2", "principal": |
falseEndpoint: | 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": "99999999999", "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 true, "email": "contato@totvs.com.br", "telefone": "999999999" } ] |
}Status de retorno: (HTTP - Status Code) | 201 - Created |
02. Atualizar
, "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 |
4549 5270, "bairro": "Jardim das Pedras", "cepZipCode": "05215458", "logradouro": "Rua Afonso Pena", "numero": "55A", "complemento": " |
Conjuto 2Conjunto 2", "principal": |
truethiano.lima@9999999999999999999" } ], "ramoAtividade": "COMERCIAL", " |
cnaes[ { "id": "95192310-508f-3ece-77d0-e11965cd45a8", "principal": true }, "REGIME_NORMAL", "numDependentes": 2, "cnaes": [ { "id": " |
aa13d02e6943186ba973453324f123a1principal false } ]}Status de retorno: (HTTP - Status Code) | 200 - OK |
03. Excluir
...
"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" } ] } |
Atributo | Detalhes |
---|
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. |
tipoAtor | 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.
- ESTRANGEIRO - Quando é uma pessoa de outro país.
|
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
Aviso |
---|
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" Aviso |
---|
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
Aviso |
---|
Caso seja informado o "paisId", não deve informar o "paisNome" e vice-versa |
|
|
|
02. Atualizar
04. Detalhar
...
{
"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": "999999999999"
}
],
"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"
}
]
}
...
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", 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",
|
999999999999 CT-E EMITIDO EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL "razaoSocial": "EMPRESA S.A.", "nome": null, "ativo": |
"CT-E EMITIDO EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL" nome null ativo true codigoExterno"ATOR008" inscricaoEstadual null contribuinteIcms false 1 24 estadoUfSC "estadoCodIbge": 42, "estadoNomeSanta Catarina 4549 " "cidadeCodIbge": 4209102,Joinville "bairro": "Jardim das Pedras",
|
"cepZipCode": "05215458",
|
"logradouro": "Rua Afonso Pena",
|
"complemento": "Conjuto 2",
|
true thiano.lima@ 18991330757 "ramoAtividade": "COMERCIAL",
|
"id": "95192310-508f-3ece-77d0-e11965cd45a8",
|
codigo "0119-9/01", "descricao": "Cultivo De Abacaxi" -186b-a973-453324f123a1", "codigo": "0721-9/01-186b-a973-453324f123a1",
|
descricao"Extração De Minério De Alumínio" ] } |
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
04. Consultar Registro Específico
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": 4566789, "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 |
05. Consultar
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": 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" }
|
}, { "id": "7e50556d-1805-4bae-afb9-72e75cc80320", "codigo": "ATOR004", "tipoAtor": "PESSOA_FISICA", "documento": "9999999999", "nomeFantasia": null, "razaoSocial": null, "nome": "CT-E EMITIDO EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL", "ativo": true, "codigoExterno": "ATOR004", "inscricaoEstadual": null, "contribuinteIcms": false, "enderecos": [ { "paisId": 1, "paisNome": "Brasil", "estadoId": 26, "estadoUf": "SP", "estadoCodIbge": 35, "estadoNome": "São Paulo", "cidadeId": 5270, "cidadeCodIbge": 3550308, "cidadeNome": "São Paulo", "bairro": "Jardim das Pedras", "cepZipCode": "05215458", "logradouro": "Rua Afonso Pena", "numero": "54A", "complemento": "Conjuto 2", "principal": true, "email": "thiano.lima@totvs.com.br", "telefone": null } ], "ramoAtividade": null, "cnaes": [] }, { "id": "e1e36d9f-3ff0-4e27-9c3e-7bd4880ca6a4", "codigo": "ATOR007", "tipoAtor": "PESSOA_JURIDICA", "documento": "44016707000161", "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": "ATOR007", "inscricaoEstadual": "669084351110", "contribuinteIcms": true, "enderecos": [ { "paisId": 1, "paisNome": "Brasil", "estadoId": 26, "estadoUf": "SP", "estadoCodIbge": 35, "estadoNome": "São Paulo", "cidadeId": 5270, "cidadeCodIbge": 3550308, "cidadeNome": "São Paulo", "bairro": "Jardim das Pedras", "cepZipCode": "05215458", "logradouro": "Rua Afonso Pena", "numero": "54A", "complemento": "Conjuto 2", "principal": true, "email": "thiano.lima@totvs.com.br", "telefone": null } ], "ramoAtividade": null, "cnaes": [] }, { "id": "22464d03-c120-4f88-ad1b-8486a42353fe", "codigo": "ATOR006", "tipoAtor": "PESSOA_JURIDICA", "documento": "52625015000149", "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": "ATOR006", "inscricaoEstadual": "669084351110", "contribuinteIcms": true, "enderecos": [ { "paisId": 1, "paisNome": "Brasil", "estadoId": 18, "estadoUf": "PR", "estadoCodIbge": 41, "estadoNome": "Paraná", "cidadeId": 2976, "cidadeCodIbge": 4113700, "cidadeNome": "Londrina", "bairro": "Jardim das Pedras", "cepZipCode": "05215458", "logradouro": "Rua Afonso Pena", "numero": "54A", "complemento": "Conjuto 2", "principal": true, "email": "thiano.lima@totvs.com.br", "telefone": null } ], "ramoAtividade": null, "cnaes": [] }, { "id": "d005713d-4c93-4cb1-9678-0d5006243ad0", "codigo": "ATOR002", "tipoAtor": "PESSOA_JURIDICA", "documento": "55061165000165", "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": "ATOR002", "inscricaoEstadual": "669084351110", "contribuinteIcms": false, "enderecos": [ { "paisId": 1, "paisNome": "Brasil", "estadoId": 26, "estadoUf": "SP", "estadoCodIbge": 35, "estadoNome": "São Paulo", "cidadeId": 5270, "cidadeCodIbge": 3550308, "cidadeNome": "São Paulo", "bairro": "Jardim das Pedras", "cepZipCode": "05215458", "logradouro": "Rua Afonso Pena", "numero": "54A", "complemento": "Conjuto 2", "principal": true, "email": "thiano.lima@totvs.com.br", "telefone": null } ], "ramoAtividade": null, "cnaes": [] } ], "pageable": { "sort": { "sorted": |
false true true 0 20 0 false true true 1 5 5 true 20 0 false true true false false } |
Status de retorno: (HTTP - Status Code) | 200 - OK |