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): | { |
Status de retorno: (HTTP - Status Code) |
|
Modelo JSON (retorno) quando retorna status 201: | { |
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:
Caso seja informado a "cidadeId", não deve informar a "cidadeNome" e vice-versa |
complemento | |
estado | Os atributos permitidos são:
Exemplo:"estadoNome": São Paulo Exemplo: "estadoUf":"SP" 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:
Caso seja informado o "paisId", não deve informar o "paisNome" e vice-versa |
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): | { |
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) | {
|
Status de retorno: (HTTP - Status Code) | 200 - OK |