Nessa rota é possível solicitar a inserção de Participante no sistema.
Requisição
Método HTTP
POST
Endpoint
https://app.plugstorage.com.br/api/sped/participante
Query string
| Nome | Descrição |
|---|---|
| token | Token de identificação da Software House. |
Headers
| Nome | Valor |
|---|---|
| Authorization | Basic encode64(email:senha)== |
Body
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| cpfCnpj | String | Sim. | CPF ou CNPJ do Participante (11 ou 14 caracteres) |
| inscricaoEstadual | String | Não. | Inscrição Estadual sem caracteres especiais. 9 dígitos |
| razaoSocial | String | Não. | Razão social |
| tipo | String | Sim | Tipo de participante: Valores aceitos: 'fornecedor', 'cliente' |
| endereco | endereco | Sim (Para PF) | Vide schema abaixo |
Endereço
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| bairro | String | Sim. | |
| cep | String | Sim. | Cep com 8 dígitos sem caracteres especiais |
| codigoCidade | String | Sim. | Código IBGE do município com 7 dígitos. |
| estado | String | Sim | Sigla do estado com 2 dígitos |
| logradouro | String | Sim | Nome do logradouro do endereço |
| numero | String | Sim | número do endereço |
| codigoPais | String | Sim | código do Pais. BRASIL = 57 |
| complemento | String | Não | Complemento do endereço |
| descricaoCidade | String | Sim | Nome da cidade |
| descricaoPais | String | Sim | Nome do País |
Exemplo:
{
"cpfCnpj": "12343468354337",
"inscricaoEstadual": "123456713",
"razaoSocial": "Empresa Teste",
"tipo": "cliente",
"endereco": {
"bairro": "zona 1",
"cep": "12345678",
"codigoCidade": "1234567",
"estado": "PR",
"logradouro": "avenida São Paulo",
"numero": "123",
"codigoPais": "57",
"descricaoCidade": "MARINGA",
"descricaoPais": "BRASIL"
}
}
Após o envio os dados serão consultados na Receita Federal e deve-se consultar o retorno com a rota GET /Participante.
Em caso de discrepância entre os dados, inicialmente serão processados os dados vindos da Receita.
Resposta
Retorno de sucesso
Status code 201
{
"message": "Inserção de participante iniciada com sucesso.",
"id": "6787cc7a3b9372c410a13e95"
}
Retorno de erro
Status code 400
{
"error": true,
"parametro": \\campo\\
"message": "Motivo de erro."
}
Status code 401
Consulte essa documentação para saber os possíveis retornos de erros de autenticação.
Comentários
0 comentário
Por favor, entre para comentar.