Índice | ||||||
---|---|---|---|---|---|---|
|
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): | { |
Ator01001", |
12345678912345", |
": "EMPRESA S.A.", | |
Status de retorno: (HTTP - Status Code) |
|
Modelo JSON (retorno) quando retorna status 201: | { |
, |
4566789, |
inscricaoMunicipal": |
1234586, |
1, |
26, |
5270, |
Conjunto 2", |
true, |
contato@totvs.com.br", |
999999999" |
0c276bea-e138- |
a157- |
eb76-0011bddd4126", |
"true" |
bc4791b2-ef13- |
84aa- |
20b0-4c92f0f23ae6", |
"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:
| ||
documento | Preenchido com CNPJ quando for PESSOA_JURIDICA ou com CPF quando for PESSOA_FISICA. | ||
inscricaoEstadual | |||
bairro | |||
cepZipCode | |||
cidade | Os atributos permitidos são:
| ||
complemento | |||
estado | Os atributos permitidos são:
Exemplo:"estadoNome": São Paulo Exemplo: "estadoUf":"SP"
| ||
logradouro | |||
numero | |||
pais | Os atributos permitidos são:
| ||
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): | { |
123456789123459", |
EMPRESA S.A.", |
EMPRESA S.A.", |
null, |
true, |
4566789, |
": false, |
1, |
24, |
"São Paulo", |
true, |
contato@totvs.com.br", |
9988887777" |
true |
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: | 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 |
...
...
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) | { "principal": "true" "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:
|
Modelo JSON (retorno) | { |
"tipoAtor": "PESSOA_ |
JURIDICA", |
"documento": "1234567891234599", |
4566789, |
{ |
"cepZipCode": "05215458", |
" |
numero": |
"55A", |
"complemento": "Conjuto 2", |
"principal": true,
| |
Status de retorno: (HTTP - Status Code) | 200 - OK |