ePlugin
Introdução ¶
O ePlugin é uma plataforma que permite aos clientes da Alterdata, integrar diversos recursos de sistemas de terceiros ao eContador através de funcionalidades disponibilizadas por um conjunto de APIs RestFul/JSON.
Obter Acesso
Para obter acesso às APIs, é necessário ser um cliente do pacote eContador Master, em seguida será necessário gerar o seu Token através da plataforma eContador, para isso, siga os passos abaixo:
-
Acesse a plataforma eContador
-
Acesse o menu Configurações
-
Localize a opção ePlugin e clique em Gerar para obter o seu Token
Agora que você já possui o seu Token, conheça as APIs disponíveis e inicie a implementação do sistema
API’s
Abaixo está uma lista das API’s que possuem os serviços presentes na documentação:
As listadas acima utilizam a especificação JSON:API.
Admissões ¶
Detalhes
Introdução
Através deste end-point é possível registrar admissões de novos colaboradores no sistema eContador, especificamente no módulo de Pré-Admissão. As informações enviadas são integradas automaticamente ao módulo de Departamento Pessoal, eliminando a necessidade de lançamentos manuais no sistema.
Fluxo de Negócio
Ao consumir este endpoint com os dados do colaborador recém-contratado, as informações são registradas no módulo de Pré-Admissão do eContador. Este módulo centraliza e organiza os dados iniciais de novos funcionários, garantindo um processo de admissão mais ágil e integrado ao Departamento Pessoal.
Campos Obrigatórios
Antes de explorar os campos, recomendamos um breve conhecimento na estrutura JSON:API.
Os campos que constam como ‘Talvez’ na coluna ‘Obrigatório’, podem ser configurados como obrigatórios no eContador acessando: “Configurações” -> “Pré-admissão” -> “Campos Obrigatórios”.
Seguem abaixo os Campos Obrigatórios por padrão para realizar uma Admissão:
| Campo | Tipo | Obrigatório | Exemplo \ Type | Categoria |
|---|---|---|---|---|
| nome | string | Sim | ‘Sergio Mendes’ | attribute |
| cpf | number | Sim | 13268843794 | attribute |
| admissao | date | Sim | ‘2025-01-01’ | attribute |
| empresa | object | Sim | empresas |
relationship |
Seguem abaixo os Campos Obrigatórios de Dados Pessoais passíveis de configuração:
| Campo | Tipo | Obrigatório | Exemplo \ Type | Categoria |
|---|---|---|---|---|
| nascimento | date | Talvez | ‘1990-03-02’ | attribute |
| nomedamae | string | Talvez | ‘Maria Mendes’ | attribute |
| nomedopai | string | Talvez | ‘João Mendes’ | attribute |
| municipionascimento | string | Talvez | ‘Nova Iguaçu’ | attribute |
| possuideficiencia | boolean | Não | false | attribute |
| observacao | string | Talvez | ‘observação’ | attribute |
| ocorrencia | string | Talvez | ‘ocorrencia’ | attribute |
| foto | object | Talvez | fotos |
relationship |
| estadocivil | object | Talvez | tipos-estado-civil |
relationship |
| sexo | object | Talvez | tipos-sexo |
relationship |
| raca | object | Talvez | tipos-raca |
relationship |
| escolaridade | object | Talvez | tipos-escolaridade |
relationship |
| naturalidade | object | Talvez | estados |
relationship |
| nacionalidade | object | Talvez | paises |
relationship |
| paisnascimento | object | Talvez | paises |
relationship |
Seguem abaixo os Campos Possíveis de Endereço e Contato passíveis de configuração:
| Campo | Tipo | Obrigatório | Exemplo \ Type | Categoria |
|---|---|---|---|---|
| cep | string | Talvez | ‘26220-400’ | attribute |
| rua | string | Talvez | ‘Rua Venâncio Flores’ | attribute |
| numero | integer | Talvez | ‘012’ | attribute |
| bairro | string | Talvez | ‘Califórnia’ | attribute |
| complemento | string | Não | ‘Esquina Tal’ | attribute |
| cidade | string | Talvez | ‘Nova Iguaçu’ | attribute |
| string | Talvez | ‘email@gmail.com’ | attribute | |
| telefone | String | Talvez | ‘(21)62728768’ | attribute |
| celular | string | Talvez | ‘(21)899999999’ | attribute |
| estado | object | Talvez | estados |
relationship |
| pais | object | Talvez | paises |
relationship |
Seguem abaixo os Campos Possíveis de Dados Contratuais passíveis de configuração:
| Campo | Tipo | Obrigatório | Exemplo \ Type | Categoria |
|---|---|---|---|---|
| nomecargo | string | Sim | ‘Cargo Tal’ | attribute |
| dataatestadoocupacional | date | Talvez | ‘2025-01-01’ | attribute |
| diascontratoexperiencia | integer | Talvez | 90 | attribute |
| dataterminocontrato | date | Talvez | ‘2025-01-01’ | attribute |
| primeiroemprego | boolean | Talvez | true | attribute |
| salario | double | Talvez | 1450.0 | attribute |
| proventosedescontos | string | Talvez | ‘[]’ | attribute |
| requersegurodesemprego | boolean | Não | false | attribute |
| tipoadmissao | object | Talvez | tipos-admissao |
relationship |
| tipovinculotrabalhista | object | Talvez | tipos-vinculos-trabalhista |
relationship |
| categoriawdp | object | Talvez | tipos-categoria |
relationship |
| formapagamento | object | Talvez | tipos-forma-de-pagamento |
relationship |
| funcao | object | Talvez | funcoes |
relationship |
| departamento | object | Talvez | departamentos |
relationship |
Seguem abaixo os Campos Possíveis de Documentos passíveis de configuração:
| Campo | Tipo | Obrigatório | Exemplo \ Type | Categoria |
|---|---|---|---|---|
| pis | string | Talvez | ‘30256107060’ | attribute |
| datapis | date | Talvez | ‘2025-01-01’ | attribute |
| cnh | string | Não | ‘96371650501’ | attribute |
| emissaocnh | date | Talvez | ‘2025-01-01’ | attribute |
| orgaoemissorcnh | string | Não | ‘DETRAN’ | attribute |
| validadecnh | date | Não | ‘2025-01-01’ | attribute |
| primeiraemissaocnh | date | Não | ‘2025-01-01’ | attribute |
| orgaoemissoridentidade | string | Talvez | ‘DETRAN’ | attribute |
| identidade | string | Talvez | ‘209000199’ | attribute |
| dataidentidade | date | Não | ‘2001-01-01’ | attribute |
| ctps | number | Talvez | 1965198196 | attribute |
| seriectps | string | Talvez | ‘8’ | attribute |
| datactps | date | Talvez | ‘2025-01-01’ | attribute |
| tituloeleitor | number | Talvez | 620450660159 | attribute |
| zonatituloeleitor | integer | Talvez | ‘001’ | attribute |
| secaotituloeleitor | integer | Talvez | ‘002’ | attribute |
| agencia | string | Talvez | ‘00019’ | attribute |
| conta | string | Talvez | ‘1234567’ | attribute |
| historicosolicitacao | string | Não | ‘[]’ | attribute |
| categoriacnh | object | Não | tipos-cnh |
relationship |
| banco | string | Talvez | ‘001’ (Bancos) | relationship |
| tipoconta | object | Talvez | tipos-de-conta |
relationship |
| tipoidentidade | object | Talvez | tipos-identidade |
relationship |
| ufidentidade | object | Talvez | estados |
relationship |
| ufctps | object | Talvez | estados |
relationship |
| ufcnh | object | Não | estados |
relationship |
Seguem abaixo os Campos Possíveis de Informações Adicionais:
| Campo | Tipo | Obrigatório | Exemplo | Categoria |
|---|---|---|---|---|
| valestrasnportes | string | Não | ‘[{“Descricao”:“a”,“Quantidade”:2,“Valor”: 1.00}]’ | attribute |
Seguem abaixo os Campos de Registro:
| Campo | Tipo | Obrigatório | Exemplo | Categoria |
|---|---|---|---|---|
| usuariocriacao | string | Não | ‘ALTERDATA TECNOLOGIA LTDA’ | attribute |
| datacriacao | date | Não | ‘2025-06-20T19:07:22.89146Z’ | attribute |
Como obter os dados? (relationship)
Os valores marcados com tags são os resources. É possível obter seus respectivos valores fazendo uma
requisição do tipo GET, fornecendo a rota que é o próprio type.
Exemplo:
🔗 tipos-estado-civil: Consulte os valores disponíveis em /api/v1/tipos-estado-civil. Com o valor de id e type é possível construir o object de relationship. Também é necessário fornecer o Header de Autorização para estes end-points: Authorization: Bearer token.
Inclusão de Admissão ¶
Inclusão de AdmissãoPOST/api/v1/candidatos
Através deste end-point é possível enviar uma Admissão de um novo funcionário para o eContador.
Example URI
POST https://dp.pack.alterdata.com.br/api/v1/candidatos
Request
Headers
Content-Type: application/vnd.api+json
Authorization: Bearer TOKENBody
{
"data": {
"type": "candidatos",
"attributes": {
"nascimento": "1990-03-02",
"telefone": "(21)62728768",
"municipionascimento": "Nova Iguaçu",
"valestrasnportes": "[]",
"dataidentidade": "2001-01-01",
"cpf": 13268843794,
"ctps": 1965198196,
"pis": "30256107060",
"possuideficiencia": false,
"nomedamae": "Maria Mendes",
"bairro": "Califórnia",
"secaotituloeleitor": "002",
"banco": "001",
"nome": "Sergio Mendes",
"identidade": "209000199",
"admissao": "2025-01-01",
"datapis": "2025-01-01",
"seriectps": "8",
"proventosedescontos": "[]",
"usuariocriacao": "ALTERDATA TECNOLOGIA LTDA",
"zonatituloeleitor": "001",
"cidade": "Nova Iguaçu",
"tituloeleitor": 620450660159,
"numero": "012",
"datacriacao": "2025-06-20T19:07:22.89146Z",
"conta": "1234567",
"nomecargo": "Alguma coisa",
"agencia": "00019",
"cep": "26220-400",
"celular": "(21)899999999",
"cnh": "96371650501",
"email": "email@gmail.com",
"historicosolicitacao": "[]",
"orgaoemissorcnh": "DETRAN",
"orgaoemissoridentidade": "DETRAN",
"diascontratoexperiencia": 90,
"salario": 1450,
"validadecnh": "2025-01-01",
"primeiraemissaocnh": "2025-01-01",
"primeiroemprego": true,
"ocorrencia": "ocorrencia",
"datactps": "2025-01-01",
"requersegurodesemprego": false,
"rua": "Rua Venâncio Flores",
"complemento": "Esquina Tal"
},
"relationships": {
"statusadmissao": {
"data": {
"type": "tipos-status-admissao",
"id": "3"
}
},
"estado": {
"data": {
"type": "estados",
"id": "21"
}
},
"estadocivil": {
"data": {
"type": "tipos-estado-civil",
"id": "1"
}
},
"tipovinculotrabalhista": {
"data": {
"type": "tipos-vinculos-trabalhista",
"id": "10"
}
},
"naturalidade": {
"data": {
"type": "estados",
"id": "21"
}
},
"tipoconta": {
"data": {
"type": "tipos-de-conta",
"id": "1"
}
},
"tipoadmissao": {
"data": {
"type": "tipos-admissao",
"id": "1"
}
},
"empresa": {
"data": {
"type": "empresas",
"id": "1"
}
}
}
}
}Response
201Body
{
"data": {
"id": "1174",
"type": "candidatos",
"attributes": {
"nascimento": "1990-03-02",
"telefone": "(21)62728768",
"municipionascimento": "Nova Iguaçu",
"valestrasnportes": "[]",
"dataidentidade": "2001-01-01",
"cpf": 13268843794,
"ctps": 1965198196,
"pis": "30256107060",
"possuideficiencia": false,
"nomedamae": "Maria Mendes",
"bairro": "Califórnia",
"secaotituloeleitor": "002",
"banco": "001",
"nome": "Sergio Mendes",
"identidade": "209000199",
"admissao": "2025-01-01",
"datapis": "2025-01-01",
"seriectps": "8",
"proventosedescontos": "[]",
"usuariocriacao": "ALTERDATA TECNOLOGIA LTDA",
"zonatituloeleitor": "001",
"cidade": "Nova Iguaçu",
"tituloeleitor": 620450660159,
"numero": "012",
"datacriacao": "2025-06-20T19:07:22.89146Z",
"conta": "1234567",
"nomecargo": "Alguma coisa",
"agencia": "00019",
"cep": "26220-400",
"celular": "(21)899999999",
"cnh": "96371650501",
"email": "email@gmail.com",
"historicosolicitacao": "[]",
"orgaoemissorcnh": "DETRAN",
"orgaoemissoridentidade": "DETRAN",
"diascontratoexperiencia": 90,
"salario": 1450,
"validadecnh": "2025-01-01",
"primeiraemissaocnh": "2025-01-01",
"primeiroemprego": true,
"ocorrencia": "ocorrencia",
"datactps": "2025-01-01",
"requersegurodesemprego": false,
"rua": "Rua Venâncio Flores",
"complemento": "Esquina Tal"
},
"relationships": {
"funcao": {
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/relationships/funcao",
"related": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/funcao"
}
},
"statusadmissao": {
"data": {
"id": "3",
"type": "tipos-status-admissao"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/relationships/statusadmissao",
"related": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/statusadmissao"
}
},
"estado": {
"data": {
"id": "21",
"type": "estados"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/relationships/estado",
"related": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/estado"
}
},
"categoriacnh": {
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/relationships/categoriacnh",
"related": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/categoriacnh"
}
},
"estadocivil": {
"data": {
"id": "1",
"type": "tipos-estado-civil"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/relationships/estadocivil",
"related": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/estadocivil"
}
},
"ufcnh": {
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/relationships/ufcnh",
"related": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/ufcnh"
}
},
"tipoidentidade": {
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/relationships/tipoidentidade",
"related": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/tipoidentidade"
}
},
"tipovinculotrabalhista": {
"data": {
"id": "10",
"type": "tipos-vinculos-trabalhista"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/relationships/tipovinculotrabalhista",
"related": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/tipovinculotrabalhista"
}
},
"naturalidade": {
"data": {
"id": "21",
"type": "estados"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/relationships/naturalidade",
"related": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/naturalidade"
}
},
"tipoconta": {
"data": {
"id": "1",
"type": "tipos-de-conta"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/relationships/tipoconta",
"related": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/tipoconta"
}
},
"tipoadmissao": {
"data": {
"id": "1",
"type": "tipos-admissao"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/relationships/tipoadmissao",
"related": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/tipoadmissao"
}
},
"tipoDeDeficiencia": {
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/relationships/tipoDeDeficiencia",
"related": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/tipoDeDeficiencia"
}
},
"escolaridade": {
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/relationships/escolaridade",
"related": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/escolaridade"
}
},
"statusatestadoocupacional": {
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/relationships/statusatestadoocupacional",
"related": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/statusatestadoocupacional"
}
},
"ufidentidade": {
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/relationships/ufidentidade",
"related": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/ufidentidade"
}
},
"paisnascimento": {
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/relationships/paisnascimento",
"related": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/paisnascimento"
}
},
"pais": {
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/relationships/pais",
"related": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/pais"
}
},
"foto": {
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/relationships/foto",
"related": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/foto"
}
},
"ufctps": {
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/relationships/ufctps",
"related": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/ufctps"
}
},
"raca": {
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/relationships/raca",
"related": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/raca"
}
},
"departamento": {
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/relationships/departamento",
"related": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/departamento"
}
},
"empresa": {
"data": {
"id": "1",
"type": "empresas"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/relationships/empresa",
"related": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/empresa"
}
},
"categoriawdp": {
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/relationships/categoriawdp",
"related": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/categoriawdp"
}
},
"sexo": {
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/relationships/sexo",
"related": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/sexo"
}
},
"nacionalidade": {
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/relationships/nacionalidade",
"related": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/nacionalidade"
}
},
"formapagamento": {
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/relationships/formapagamento",
"related": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1/formapagamento"
}
}
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/candidatos/1174"
}
}
}Agendamento de Férias ¶
Detalhes
Introdução
Esta API permite registrar o agendamento de férias dos colaboradores no sistema eContador, especificamente no módulo de Agendamento de Férias. As informações enviadas por meio desta API são integradas automaticamente ao módulo de Departamento Pessoal.
Fluxo de Negócio
Ao consumir este endpoint com os dados de férias do colaborador, as informações são registradas no módulo de Agendamento de Férias do eContador. Este módulo centraliza e organiza os dados de férias dos funcionários, garantindo um agendamento mais ágil e integrado ao Departamento Pessoal.
Campos Obrigatórios
Os campos obrigatórios para realizar um Agendamento de Férias, são:
| Campo | Tipo | Obrigatório | Exemplo \ Type | Categoria |
|---|---|---|---|---|
| Funcionário | object | Sim | Ver abaixo | relationship |
| Período De | date | Sim | ‘2025-02-01’ | attribute |
| Período Até | date | Sim | ‘2025-01-01’ | attribute |
| Adiantamento Décimo Terceiro | boolean | Sim | true | attribute |
| Solicitação | date time | Sim | ‘2023-08-08T15:48:59.335Z’ | attribute |
| Status | object | Sim | Ver abaixo | relationship |
Exemplo de Funcionário
“funcionario”: { “data”: { “id”: “32”, “type”: “funcionarios” } }
Nesse campo deve ser incluído o id do funcionário e o “type”, que nesse caso será “funcionarios”.
Exemplo de Status
“status”: { “data”: { “id”: 1, “type”: “tipos-status-agendamento” } }
Nesse campo deve ser incluído o tipo de do funcionário e o “type”, que nesse caso será “tipos-status-agendamento”.
Abaixo segue uma referência para a estrutura, baseada no seu type :
Erros comuns
| Código | Motivo | Como resolver |
|---|---|---|
| 400 | Campo obrigatório ausente | Verifique se os campos obrigatórios estão preenchidos |
| 401 | Token inválido ou expirado | Refaça login e atualize o token |
| 422 | Dados inválidos (formato) | Certifique-se do formato da data ou tipo de dado |
Inclusão de Agendamento de Férias ¶
Inclusão de Agendamento de FériasPOST/api/v1/agendamentos-ferias
Através deste end-point é possível enviar Agendamento de Férias de um funcionário para o eContador.
Estruturas de Dados
Uma estrutura de dados é utilizada para realizar a inclusão de um Agendamento de Férias.
Abaixo segue uma referência para a estrutura, baseada no seu type :
Example URI
POST https://dp.pack.alterdata.com.br/api/v1/agendamentos-ferias
Request
Headers
Content-Type: application/vnd.api+json
Authorization: Bearer TOKENBody
{
"data": {
"relationships": {
"funcionario": {
"data": {
"id": "32",
"type": "funcionarios"
}
},
"status": {
"data": {
"id": 1,
"type": "tipos-status-agendamento"
}
}
},
"type": "agendamentos-ferias",
"attributes": {
"de": "2023-08-01",
"solicitacao": "2023-08-08T15:48:59.335Z",
"ate": "2023-08-16",
"abonodias": 14,
"adiantamentodecimoterceiro": true,
"anotacoes": "Teste agendamento de férias"
}
}
}Response
201Body
{
"data": {
"id": "1054",
"type": "agendamentos-ferias",
"attributes": {
"de": "2023-08-01",
"aquisitivode": null,
"situacao": null,
"empresaId": null,
"adiantamentodecimoterceiro": true,
"aquisitivoate": null,
"abonodata": null,
"exceptions": null,
"observacoes": null,
"solicitacao": "2023-08-08T15:48:59.335Z",
"ate": "2023-08-16",
"abonodias": 14,
"anotacoes": "Teste agendamento de férias",
"pagamento": null
},
"relationships": {
"funcionario": {
"data": {
"id": "32",
"type": "funcionarios"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/agendamentos-ferias/1054/relationships/funcionario",
"related": "https://dp.pack.alterdata.com.br/api/v1/agendamentos-ferias/1054/funcionario"
}
},
"status": {
"data": {
"id": "1",
"type": "tipos-status-agendamento"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/agendamentos-ferias/1054/relationships/status",
"related": "https://dp.pack.alterdata.com.br/api/v1/agendamentos-ferias/1054/status"
}
}
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/agendamentos-ferias/1054"
}
}
}Atendimentos ¶
Campos obrigatórios
Os campos obrigatórios para realizar um Atendimento, são:
-
Descrição
-
Departamento
-
Providenciar até
-
Parecer
Inclusão de Atendimento ¶
Inclusão de AtendimentoPOST/api/v1/integracao/atendimentos
Através deste end-point é possível abrir um Atendimento no eContador
Example URI
POST https://dp.pack.alterdata.com.br/api/v1/integracao/atendimentos
Request
Headers
Content-Type: application/vnd.api+json
Authorization: Bearer TOKENBody
{
"data": {
"type": "integracao/atendimentos",
"attributes": {
"parecerInicial": {
"texto": "Teste Doc",
"data": "2023-08-07T18:01:33.612Z"
},
"aberto": true,
"abertura": "2023-08-07T18:01:33.612Z",
"exportado": false,
"abertoNaWeb": true,
"descricao": "Teste Doc",
"previsao": "2023-08-18T00:00:00.000Z",
"abridorId": 35867439046
},
"relationships": {
"empresa": {
"data": {
"type": "empresas",
"id": 3595
}
},
"departamento": {
"data": {
"type": "integracao/departamentos-do-bureau",
"id": "36"
}
},
"operador": {
"data": {
"type": "operadores",
"id": 221
}
}
}
}
}Response
201Body
{
"data": {
"id": "1737",
"type": "integracao/atendimentos",
"attributes": {
"fase": null,
"abridorId": 35867439046,
"abertura": "2023-08-17T18:22:03.259",
"previsao": "2023-08-18T00:00:00",
"parecerInicial": {
"id": 17335,
"texto": "Teste Doc",
"data": "2023-08-17T18:22:03.259Z",
"atendimento": null,
"leituras": null,
"lido": null,
"idDaEmpresa": null
},
"encerrado": null,
"descricao": "Teste Doc",
"status": null,
"pareceres": null
},
"relationships": {
"departamento": {
"data": {
"id": "36",
"type": "integracao/departamentos-do-bureau"
},
"links": {
"self": "https://atendimentos.pack.alterdata.com.br/api/v1/integracao/atendimentos/1737/relationships/departamento",
"related": "https://atendimentos.pack.alterdata.com.br/api/v1/integracao/atendimentos/1737/departamento"
}
},
"empresa": {
"data": {
"id": "3595",
"type": "empresas"
},
"links": {
"self": "https://atendimentos.pack.alterdata.com.br/api/v1/integracao/atendimentos/1737/relationships/empresa",
"related": "https://atendimentos.pack.alterdata.com.br/api/v1/integracao/atendimentos/1737/empresa"
}
},
"operador": {
"data": {
"id": "221",
"type": "operadores"
},
"links": {
"self": "https://atendimentos.pack.alterdata.com.br/api/v1/integracao/atendimentos/1737/relationships/operador",
"related": "https://atendimentos.pack.alterdata.com.br/api/v1/integracao/atendimentos/1737/operador"
}
}
},
"links": {
"self": "https://atendimentos.pack.alterdata.com.br/api/v1/integracao/atendimentos/1737"
}
}
}Categorias ¶
Consulta de Categorias ¶
Consulta de CategoriasGET/api/v1/integracao/categoria-documento
Através deste end-point é possível efetuar a consultar das Catgorias que estão armazenadas na plataforma eContador.
Example URI
GET https://dp.pack.alterdata.com.br/api/v1/integracao/categoria-documento
URI Parameters
- filter[login]
integer(required)Filtrar categorias que o usuário possui permissão.
Request
Headers
Authorization: Bearer TOKENResponse
200Body
{
"data": [
{
"id": "1",
"type": "integracao/categoria-documento",
"attributes": {
"personalizada": false,
"pagavel": false,
"login": null,
"descricao": "Balancetes e Demonstrativos"
},
"links": {
"self": "https://documentos.pack.alterdata.com.br/api/v1/integracao/categoria-documento/1"
}
},
{
"id": "2",
"type": "integracao/categoria-documento",
"attributes": {
"personalizada": false,
"pagavel": true,
"login": null,
"descricao": "Departamento Pessoal"
},
"links": {
"self": "https://documentos.pack.alterdata.com.br/api/v1/integracao/categoria-documento/2"
}
}
],
"links": {
"first": "https://documentos.pack.alterdata.com.br/api/v1/integracao/categoria-documento/?page[limit]=25",
"last": "https://documentos.pack.alterdata.com.br/api/v1/integracao/categoria-documento/?page[limit]=25",
"next": null,
"prev": null
},
"meta": {
"totalResourceCount": 2
}
}Certidões ¶
Consulta de Certidões ¶
Consulta de CertidõesGET/api/v1/integracao/certidoes{?include,fields,sort}
Através deste end-point é possível efetuar a consulta das CNDs controladas pelo eCND.
Example URI
GET https://dp.pack.alterdata.com.br/api/v1/integracao/certidoes?include=&fields=&sort=
URI Parameters
- filter[empresaId]
integer(required)Filtrar por Empresa
- filter[ultimasemissoes]
boolean(optional)Filtrar ultimas emissões
- include
string(optional)Incluir valores no retorno
Choices:
mimeTypetipoCertidaoagendamentoempresastatus- fields
string(optional)Incluir campos no retorno
Choices:
nomeOrgaoEmissorultimoErroemissaoconferidavencimentonomeAbrangenciacomplementoCnd- sort
string(optional)Ordenar por campos
Choices:
-emissao- page[offset]
integer(optional)Página da paginação
- page[limit]
integer(optional)Quantidade de item por página
Request
Headers
Authorization: Bearer TOKENResponse
200Body
{
"data": [
{
"id": "4591",
"type": "integracao/certidoes",
"attributes": {
"empresaId": 15148538000115,
"arquivo": "base64",
"abrangencia": "Federal",
"mimeType": null,
"emissao": "2021-12-20T00:00:00Z",
"vencimento": "2022-12-20T00:00:00Z",
"status": "Positiva"
},
"relationships": {
"tipoCertidao": {
"data": {
"id": "0",
"type": "integracao/tipoCertidao"
},
"links": {
"self": "https://cnd.pack.alterdata.com.br/api/v1/integracao/certidoes/4591/relationships/tipoCertidao",
"related": "https://cnd.pack.alterdata.com.br/api/v1/integracao/certidoes/4591/tipoCertidao"
}
}
},
"links": {
"self": "https://cnd.pack.alterdata.com.br/api/v1/integracao/certidoes/4591"
}
},
{
"id": "4606",
"type": "integracao/certidoes",
"attributes": {
"empresaId": 15148538000115,
"arquivo": "base64",
"abrangencia": "Federal",
"mimeType": null,
"emissao": "2021-12-20T00:00:00Z",
"vencimento": "2022-12-20T00:00:00Z",
"status": "Positiva"
},
"relationships": {
"tipoCertidao": {
"data": {
"id": "0",
"type": "integracao/tipoCertidao"
},
"links": {
"self": "https://cnd.pack.alterdata.com.br/api/v1/integracao/certidoes/4606/relationships/tipoCertidao",
"related": "https://cnd.pack.alterdata.com.br/api/v1/integracao/certidoes/4606/tipoCertidao"
}
}
},
"links": {
"self": "https://cnd.pack.alterdata.com.br/api/v1/integracao/certidoes/4606"
}
}
],
"links": {
"first": "https://cnd.pack.alterdata.com.br/api/v1/integracao/certidoes?page[limit]=25&filter[integracao/certidoes][empresaId][EQ]=15148538000115",
"last": "https://cnd.pack.alterdata.com.br/api/v1/integracao/certidoes?page[limit]=25&filter[integracao/certidoes][empresaId][EQ]=15148538000115"
},
"meta": {
"totalResourceCount": 10
}
}Consulta de Certidão por Id ¶
Consulta de Certidão por IdGET/api/v1/integracao/certidoes/{id}{?include,sort}
Através deste end-point é possível efetuar a consulta de uma CND controladas pelo eCND.
Example URI
GET https://dp.pack.alterdata.com.br/api/v1/integracao/certidoes/id?include=&sort=
URI Parameters
- id
integer(required)Id da CND a ser consultada
- filter[empresaId]
integer(required)Id da Empresa
- include
string(optional)Incluir valores no retorno
Choices:
statusorgaoEmissordataCadastroagendamento- sort
string(optional)Ordenar por campos
Choices:
-emissao- page[offset]
integer(optional)Página da paginação
- page[limit]
integer(optional)Quantidade de item por página
Request
Headers
Authorization: Bearer TOKENResponse
200Body
{
"data": {
"id": "4591",
"type": "integracao/certidoes",
"attributes": {
"empresaId": 15148538000115,
"arquivo": "base64",
"abrangencia": "Federal",
"mimeType": null,
"emissao": "2021-12-20T00:00:00Z",
"vencimento": "2022-12-20T00:00:00Z",
"status": "Positiva"
},
"relationships": {
"tipoCertidao": {
"data": {
"id": "0",
"type": "integracao/tipoCertidao"
},
"links": {
"self": "https://cnd.pack.alterdata.com.br/api/v1/integracao/certidoes/4591/relationships/tipoCertidao",
"related": "https://cnd.pack.alterdata.com.br/api/v1/integracao/certidoes/4591/tipoCertidao"
}
}
},
"links": {
"self": "https://cnd.pack.alterdata.com.br/api/v1/integracao/certidoes/4591"
}
},
"included": [
{
"id": "0",
"type": "integracao/tipoCertidao",
"attributes": {
"nome": "Manual"
},
"links": {
"self": "https://cnd.pack.alterdata.com.br/api/v1/integracao/tipoCertidao/0"
}
}
]
}Consulta de Tipo de Certidão ¶
Consulta de CertidõesGET/api/v1/integracao/tipoCertidao
Através deste end-point é possível efetuar a consulta dos Tipos de Certidões controladas pelo eCND.
Example URI
GET https://dp.pack.alterdata.com.br/api/v1/integracao/tipoCertidao
URI Parameters
- filter[usuario]
integer(optional)Filtrar por Usuário
Request
Headers
Authorization: Bearer TOKENResponse
200Body
{
"data": [
{
"id": "0",
"type": "integracao/tipoCertidao",
"attributes": {
"nome": "Manual"
},
"links": {
"self": "https://cnd.pack.alterdata.com.br/api/v1/integracao/tipoCertidao/0"
}
},
{
"id": "1",
"type": "integracao/tipoCertidao",
"attributes": {
"nome": "Certidão de FGTS"
},
"links": {
"self": "https://cnd.pack.alterdata.com.br/api/v1/integracao/tipoCertidao/1"
}
}
],
"links": {
"first": "https://cnd.pack.alterdata.com.br/api/v1/integracao/tipoCertidao?page[limit]=25",
"last": "https://cnd.pack.alterdata.com.br/api/v1/integracao/tipoCertidao?page[limit]=25&page[offset]=400",
"next": "https://cnd.pack.alterdata.com.br/api/v1/integracao/tipoCertidao?page[limit]=25&page[offset]=25"
},
"meta": {
"totalResourceCount": 403
}
}Consulta de Tipo de Certidão por Id ¶
Consulta de Certidão por IdGET/api/v1/integracao/tipoCertidao/{id}
Através deste end-point é possível efetuar a consulta de um Tipo de Certidão controlada pelo eCND.
Example URI
GET https://dp.pack.alterdata.com.br/api/v1/integracao/tipoCertidao/id
URI Parameters
- id
integer(required)Id do Tipo de Certidão a ser consultada
Request
Headers
Authorization: Bearer TOKENResponse
200Body
{
"data": {
"id": "1",
"type": "integracao/tipoCertidao",
"attributes": {
"nome": "Certidão de FGTS"
},
"links": {
"self": "https://cnd.pack.alterdata.com.br/api/v1/integracao/tipoCertidao/1"
}
}
}Desligamentos ¶
Campos obrigatórios
Os campos obrigatórios para realizar uma Pré-Demissão, são:
-
Funcionário
-
Documento
-
Tipo de aviso prévio
-
Emissor
-
Data
-
Tipo de desligamento
Realizar Desligamento ¶
Realizar DesligamentoPOST/api/v1/notificacoes-rescisao
Através deste end-point é possível enviar a solicitação de Pré-Demissão de funcionários para o eContador.
Estruturas de Dados
Algumas estruturas de dados são utilizadas para realizar a pré demissão.
Abaixo segue uma referência para estas estruturas, baseadas no seu type :
Example URI
POST https://dp.pack.alterdata.com.br/api/v1/notificacoes-rescisao
Request
Headers
Content-Type: application/vnd.api+json
Authorization: Bearer TOKENBody
{
"data": {
"relationships": {
"emissornotificacao": {
"data": {
"id": "2",
"type": "tipos-emissor"
}
},
"avisoPrevio": {
"data": {
"id": "2",
"type": "tipos-aviso-previo"
}
},
"documentorescisao": {
"data": {
"id": "1",
"type": "tipos-documento-rescisao"
}
},
"funcionario": {
"data": {
"id": "1497",
"type": "funcionarios"
}
},
"empresa": {
"data": {
"id": "1",
"type": "empresas"
}
},
"tipoDesligamento": {
"data": {
"id": "75",
"type": "tipos-desligamento"
}
}
},
"type": "notificacoes-rescisao",
"attributes": {
"solicitacao": "2023-08-01",
"criacao": "2023-08-08T18:23:36.750Z",
"importacao": null,
"simulacao": false
}
}
}Response
201Body
{
"data": {
"id": "590",
"type": "notificacoes-rescisao",
"attributes": {
"solicitacao": "2023-08-01",
"importacao": null,
"simulacao": false,
"criacao": "2023-08-08"
},
"relationships": {
"emissornotificacao": {
"data": {
"id": "2",
"type": "tipos-emissor"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/notificacoes-rescisao/590/relationships/emissornotificacao",
"related": "https://dp.pack.alterdata.com.br/api/v1/notificacoes-rescisao/590/emissornotificacao"
}
},
"avisoPrevio": {
"data": {
"id": "2",
"type": "tipos-aviso-previo"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/notificacoes-rescisao/590/relationships/avisoPrevio",
"related": "https://dp.pack.alterdata.com.br/api/v1/notificacoes-rescisao/590/avisoPrevio"
}
},
"tipoDesligamento": {
"data": {
"id": "75",
"type": "tipos-desligamento"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/notificacoes-rescisao/590/relationships/tipoDesligamento",
"related": "https://dp.pack.alterdata.com.br/api/v1/notificacoes-rescisao/590/tipoDesligamento"
}
},
"documentorescisao": {
"data": {
"id": "1",
"type": "tipos-documento-rescisao"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/notificacoes-rescisao/590/relationships/documentorescisao",
"related": "https://dp.pack.alterdata.com.br/api/v1/notificacoes-rescisao/590/documentorescisao"
}
},
"funcionario": {
"data": {
"id": "1497",
"type": "funcionarios"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/notificacoes-rescisao/590/relationships/funcionario",
"related": "https://dp.pack.alterdata.com.br/api/v1/notificacoes-rescisao/590/funcionario"
}
},
"empresa": {
"data": {
"id": "1",
"type": "empresas"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/notificacoes-rescisao/590/relationships/empresa",
"related": "https://dp.pack.alterdata.com.br/api/v1/notificacoes-rescisao/590/empresa"
}
}
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/notificacoes-rescisao/590"
}
}
}Documentos ¶
Consulta de Documentos ¶
Consulta de DocumentosGET/api/v1/integracao/documentos{?include,sort}
Através deste end-point é possível efetuar a consultar os Documentos que estão armazenados na plataforma eContador.
Example URI
GET https://dp.pack.alterdata.com.br/api/v1/integracao/documentos?include=&sort=
URI Parameters
- filter[empresaId]
integer(required)Filtrar por Empresa
- filter[pago]
boolean(optional)Filtrar por documentos pagos
- filter[criacao]
localDateTime(optional)Filtrar pela data de criação do documento
- filter[vencimento]
localDateTime(optional)Filtrar pela data de vencimento do documento
- filter[expiracao]
localDateTime(optional)Filtrar pela data de expiração do documento
- filter[pagamento]
localDateTime(optional)Filtrar pela data de pagamento do documento
- include
string(optional)Incluir campos no retorno
Choices:
abridorcategoriastatusempresadepartamento- sort
string(optional)Ordenar por campos
Choices:
-criacao- page[offset]
integer(optional)Página da paginação
- page[limit]
integer(optional)Quantidade de item por página
Request
Headers
Authorization: Bearer TOKENResponse
200Body
{
"data": [
{
"id": "24",
"type": "integracao/documentos",
"attributes": {
"expiracao": null,
"empresaId": 36462778000160,
"categoria": "Departamento Pessoal",
"valor": 0,
"titulo": "Relatório Gerencial",
"departamento": null,
"vencimento": null,
"criacao": "2020-02-11T16:21:19",
"pagamento": null,
"pago": false,
"descricao": "Registro de Empregados\r\n\r\nEmpresa (00001) ALTERDATA TECNOLOGIA EM INFORMATICA.",
"status": "Recebido"
},
"relationships": {
"arquivos": {
"data": [],
"links": {
"self": "https://documentos-interno-pack.alterdata.com.br/api/v1/integracao/documentos/24/relationships/arquivos",
"related": "https://documentos-interno-pack.alterdata.com.br/api/v1/integracao/documentos/24/arquivos"
}
}
},
"links": {
"self": "https://documentos-interno-pack.alterdata.com.br/api/v1/integracao/documentos/24"
}
},
{
"id": "26",
"type": "integracao/documentos",
"attributes": {
"expiracao": null,
"empresaId": 36462778000160,
"categoria": "Departamento Pessoal",
"valor": 0,
"titulo": "Folha de Pagamento",
"departamento": null,
"vencimento": null,
"criacao": "2020-02-11T16:24:01",
"pagamento": null,
"pago": false,
"descricao": "mês 09/2018",
"status": "Recebido"
},
"relationships": {
"arquivos": {
"data": [],
"links": {
"self": "https://documentos-interno-pack.alterdata.com.br/api/v1/integracao/documentos/26/relationships/arquivos",
"related": "https://documentos-interno-pack.alterdata.com.br/api/v1/integracao/documentos/26/arquivos"
}
}
},
"links": {
"self": "https://documentos-interno-pack.alterdata.com.br/api/v1/integracao/documentos/26"
}
}
],
"links": {
"first": "https://documentos-interno-pack.alterdata.com.br/api/v1/integracao/documentos/?page[limit]=25",
"last": "https://documentos-interno-pack.alterdata.com.br/api/v1/integracao/documentos/?page[limit]=25&page[offset]=3800",
"next": "https://documentos-interno-pack.alterdata.com.br/api/v1/integracao/documentos/?page[limit]=25&page[offset]=25",
"prev": null
},
"meta": {
"totalResourceCount": 3811
}
}Consulta de Documento por Id ¶
Consulta de Documento por IdGET/api/v1/integracao/documentos/{id}{?include,sort}
Através deste end-point é possível efetuar a consulta de um Documento que está armazenado na plataforma eContador.
Example URI
GET https://dp.pack.alterdata.com.br/api/v1/integracao/documentos/id?include=&sort=
URI Parameters
- id
integer(required)Id do documento
- filter[empresaId]
integer(required)Filtrar por Empresa
- include
string(optional)Incluir campos no retorno
Choices:
abridorcategoriastatusempresadepartamentoarquivos- sort
string(optional)Ordenar por campos
Choices:
-criacao- page[offset]
integer(optional)Página da paginação
- page[limit]
integer(optional)Quantidade de item por página
- fields[arquivos]
string(optional)Trazer informações dos arquivos
Request
Headers
Authorization: Bearer TOKENResponse
200Body
{
"data": {
"id": "916",
"type": "integracao/documentos",
"attributes": {
"expiracao": "2020-02-28T21:00:00",
"empresaId": 36462778000160,
"categoria": "Guias",
"valor": 50,
"titulo": "teste88",
"departamento": "DEPARTAMENTO PESSOAL",
"vencimento": "2020-04-07T21:00:00",
"criacao": "2020-04-09T14:21:23",
"pagamento": "2022-06-17T00:00:00",
"pago": true,
"descricao": "teste 88",
"status": "Recebido"
},
"relationships": {
"arquivos": {
"data": [
{
"id": "2678",
"type": "integracao/arquivos"
}
],
"links": {
"self": "https://documentos.pack.alterdata.com.br/api/v1/integracao/documentos/916/relationships/arquivos",
"related": "https://documentos.pack.alterdata.com.br/api/v1/integracao/documentos/916/arquivos"
}
}
},
"links": {
"self": "https://documentos.pack.alterdata.com.br/api/v1/integracao/documentos/916"
}
}
}Empresas ¶
Consulta de Empresas ¶
Consulta de EmpresasGET/api/v1/empresas
Através deste end-point é possível efetuar a consulta das Empresas que estão cadastradas na plataforma eContador.
Example URI
GET https://dp.pack.alterdata.com.br/api/v1/empresas
URI Parameters
- filter[empresas][ativa][EQ]
boolean(optional)Filtrar por tarefas ativas
- page[offset]
integer(optional)Página da paginação
- page[limit]
integer(optional)Quantidade de item por página
Request
Headers
Authorization: Bearer TOKENResponse
200Body
{
"data": [
{
"id": "1",
"type": "empresas",
"attributes": {
"tipoMovimentoPermitido": "1,2",
"endereco": "Rua Prefeito Sebastião Teixeira",
"externoid": "00001",
"nome": "ALTERDATA TECNOLOGIA EM INFORMATICA",
"ativa": true,
"cpfcnpj": 36462778000160,
"controlaTransferenciaTomadores": false
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/empresas/1"
}
},
{
"id": "23",
"type": "empresas",
"attributes": {
"tipoMovimentoPermitido": "1,2,3,4,5,6",
"endereco": "AV. JOSÉ LUIS DE CASTRO",
"externoid": "00031",
"nome": "FREIRE E PAIVA LTDA EPP FILIAL (Baixada)",
"ativa": true,
"cpfcnpj": 36462778000161,
"controlaTransferenciaTomadores": false
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/empresas/23"
}
}
],
"links": {
"first": "https://dp.pack.alterdata.com.br/api/v1/empresas?page[limit]=25",
"last": "https://dp.pack.alterdata.com.br/api/v1/empresas?page[limit]=25&page[offset]=4225",
"next": "https://dp.pack.alterdata.com.br/api/v1/empresas?page[limit]=25&page[offset]=25"
},
"meta": {
"totalResourceCount": 4230
}
}Consulta de Empresa por Id ¶
Consulta de Empresa por IdGET/api/v1/empresas/{id}
Através deste end-point é possível efetuar a consulta dos dados de uma Empresa que está cadastrada na plataforma eContador.
Example URI
GET https://dp.pack.alterdata.com.br/api/v1/empresas/id
URI Parameters
- id
integer(required)Id da Empresa
Request
Headers
Authorization: Bearer TOKENResponse
200Body
{
"data": {
"id": "1",
"type": "empresas",
"attributes": {
"tipoMovimentoPermitido": "1,2",
"endereco": "Rua Prefeito Sebastião Teixeira",
"externoid": "00001",
"nome": "ALTERDATA TECNOLOGIA EM INFORMATICA",
"ativa": true,
"cpfcnpj": 36462778000160,
"controlaTransferenciaTomadores": false
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/empresas/1"
}
}
}Consulta de Empresa por Id Simplificada ¶
Consulta de Empresa por IdGET/api/v1/integracao/empresas/{id}
Através deste end-point é possível efetuar a consulta dos dados simplificados de uma Empresa que está cadastrada na plataforma eContador.
Example URI
GET https://dp.pack.alterdata.com.br/api/v1/integracao/empresas/id
URI Parameters
- id
integer(required)Id da Empresa
Request
Headers
Authorization: Bearer TOKENResponse
200Body
{
"data": {
"id": "0",
"type": "integracao/empresas",
"attributes": {
"codigo": "2021",
"nomeFantasia": "",
"nome": "Teste LM"
},
"links": {
"self": "https://identificacao.pack.alterdata.com.br/api/v1/integracao/empresas/0"
}
}
}Consulta de Empresas por Usuário ¶
Consulta de Empresa por IdGET/api/v1/integracao/usuarios/{id}/relationships/empresas
Através deste end-point é possível efetuar a consulta das Empresas que estão cadastradas na plataforma eContador por Usuário.
Example URI
GET https://dp.pack.alterdata.com.br/api/v1/integracao/usuarios/id/relationships/empresas
URI Parameters
- id
integer(required)Id do Usuário
Request
Headers
Authorization: Bearer TOKENResponse
200Body
{
"data": [
{
"id": "0",
"type": "integracao/empresas",
"attributes": {
"codigo": "2021",
"nomeFantasia": "",
"nome": "Teste LM"
},
"links": {
"self": "https://identificacao.pack.alterdata.com.br/api/v1/integracao/empresas/0"
}
},
{
"id": "62869472000132",
"type": "integracao/empresas",
"attributes": {
"codigo": "77778",
"nomeFantasia": "Teste PGSQL",
"nome": "Teste PGSQL"
},
"links": {
"self": "https://identificacao.pack.alterdata.com.br/api/v1/integracao/empresas/62869472000132"
}
}
],
"links": {
"first": "https://identificacao.pack.alterdata.com.br/api/v1/integracao/usuarios/2009349000110/relationships/empresas/?page[limit]=25",
"last": "https://identificacao.pack.alterdata.com.br/api/v1/integracao/usuarios/2009349000110/relationships/empresas/?page[limit]=25&page[offset]=1075",
"next": "https://identificacao.pack.alterdata.com.br/api/v1/integracao/usuarios/2009349000110/relationships/empresas/?page[limit]=25&page[offset]=50",
"prev": "https://identificacao.pack.alterdata.com.br/api/v1/integracao/usuarios/2009349000110/relationships/empresas/?page[limit]=25"
},
"meta": {
"totalResourceCount": 1089
}
}eTarefas ¶
Consulta de Histórico De Tarefas ¶
Consulta de Histórico De TarefasGET/api/v1/integracao/historico-tarefas{?dataInicial,dataFinal}
Através deste end-point é possível consultar os Históricos de Tarefas das empresas.
Example URI
GET https://dp.pack.alterdata.com.br/api/v1/integracao/historico-tarefas?dataInicial=2023-08-17&dataFinal=2023-08-18
URI Parameters
- dataInicial
string(required) Example: 2023-08-17Data inicial de um período
- dataFinal
string(required) Example: 2023-08-18Data final de um período
Request
Headers
Authorization: Bearer TOKENResponse
200Body
[
{
"nome": "Agendamento de férias: 000679 - teste",
"prazoEntrega": "2023-08-17",
"prazoLegal": "2023-07-30",
"responsavel": "Teste operador eTarefas (todas as permissões)",
"status": "Atrasada",
"dataConclusao": null,
"empresa": "00001 - ALTERDATA TECNOLOGIA EM INFORMATICA",
"departamento": "Departamento Pessoal"
},
{
"nome": "Atendimento: Teste Doc",
"prazoEntrega": "2023-08-17",
"prazoLegal": "2023-08-18",
"responsavel": "Usuário sem Funcionário nas Empresas",
"status": "Atrasada",
"dataConclusao": null,
"empresa": "55555 - EMPRESA TESTE AUTOMATIZADO",
"departamento": "teste"
},
{
"nome": "Admissão do funcionário: teste",
"prazoEntrega": "2023-08-17",
"prazoLegal": "2023-08-16",
"responsavel": "Teste operador eTarefas (todas as permissões)",
"status": "Atrasada",
"dataConclusao": null,
"empresa": "00001 - ALTERDATA TECNOLOGIA EM INFORMATICA",
"departamento": "Departamento Pessoal"
},
{
"nome": "Desligamento de funcionário: 000753 - Caio Nelson GOmes",
"prazoEntrega": "2023-08-18",
"prazoLegal": "2023-07-31",
"responsavel": "Teste operador eTarefas (todas as permissões)",
"status": "A fazer",
"dataConclusao": null,
"empresa": "00001 - ALTERDATA TECNOLOGIA EM INFORMATICA",
"departamento": "Departamento Pessoal"
},
{
"nome": "Desligamento de funcionário: 000804 - 123 TESTE Versão 105",
"prazoEntrega": "2023-08-18",
"prazoLegal": "2023-08-01",
"responsavel": "Teste operador eTarefas (todas as permissões)",
"status": "A fazer",
"dataConclusao": null,
"empresa": "00001 - ALTERDATA TECNOLOGIA EM INFORMATICA",
"departamento": "Departamento Pessoal"
},
{
"nome": "Desligamento de funcionário: 000753 - Caio Nelson GOmes",
"prazoEntrega": "2023-08-18",
"prazoLegal": "2023-07-31",
"responsavel": "Teste operador eTarefas (todas as permissões)",
"status": "A fazer",
"dataConclusao": null,
"empresa": "00001 - ALTERDATA TECNOLOGIA EM INFORMATICA",
"departamento": "Departamento Pessoal"
},
{
"nome": "Desligamento de funcionário: 000753 - Caio Nelson GOmes",
"prazoEntrega": "2023-08-18",
"prazoLegal": "2023-07-31",
"responsavel": "Teste operador eTarefas (todas as permissões)",
"status": "A fazer",
"dataConclusao": null,
"empresa": "00001 - ALTERDATA TECNOLOGIA EM INFORMATICA",
"departamento": "Departamento Pessoal"
},
{
"nome": "Atendimento: Atendimento alterar vencimento tarefa avulsa",
"prazoEntrega": "2023-08-18",
"prazoLegal": "2023-08-25",
"responsavel": "Teste operador eTarefas (todas as permissões)",
"status": "A fazer",
"dataConclusao": null,
"empresa": "00001 - ALTERDATA TECNOLOGIA EM INFORMATICA",
"departamento": "DEPARTAMENTO AUTOMATIZADO"
}
]Folha de Pagamento ¶
Campos obrigatórios
Os campos obrigatórios para criar um Movimento, são:
-
Empresa
-
Funcionário
-
Tipo de Movimento
-
Evento
-
Quantidade
-
Período
Inclusão de valores na Folha de Pagamento ¶
Inclusão de valores na Folha de PagamentoPOST/api/v1/movimentos
Através deste end-point é possível enviar valores a serem considerados na Folha de Pagamento dos funcionários.
Estruturas de Dados
Uma estrutura de dados é utilizada para realizar a inclusão de um Movimento.
Abaixo segue uma referência para a estrutura, baseada no seu type :
Example URI
POST https://dp.pack.alterdata.com.br/api/v1/movimentos
Request
Headers
Content-Type: application/vnd.api+json
Authorization: Bearer TOKENBody
{
"data": {
"relationships": {
"funcionario": {
"data": {
"id": "3322",
"type": "funcionarios"
}
},
"empresa": {
"data": {
"id": "1",
"type": "empresas"
}
},
"tipomovimento": {
"data": {
"id": "1",
"type": "tipos-movimento"
}
},
"evento": {
"data": {
"id": "2",
"type": "eventos"
}
}
},
"type": "movimentos",
"attributes": {
"databaixa": null,
"faltas": [
{
"empresaId": "1",
"empresa": null,
"funcionarioId": "3322",
"funcionario": null,
"inicio": "2023-08-01",
"fim": "2023-08-31",
"dia": "2023-08-01"
},
{
"empresaId": "1",
"empresa": null,
"funcionarioId": "3322",
"funcionario": null,
"inicio": "2023-08-01",
"fim": "2023-08-31",
"dia": "2023-08-17"
}
],
"created": "2023-08-09T16:12:42Z",
"valor": "1:00",
"inicio": "2023-08-01T03:00:00Z",
"fim": "2023-08-31T03:00:00Z",
"horaquantidade": null,
"comentario": null
}
}
}Response
201Body
{
"data": {
"id": "4065",
"type": "movimentos",
"attributes": {
"databaixa": null,
"complemento": null,
"periodo": null,
"created": "2023-08-09T16:12:42Z",
"valor": "1:00",
"inicio": "2023-08-01T03:00:00Z",
"fim": "2023-08-31T03:00:00Z",
"comentario": null,
"faltas": [
{
"id": 971,
"empresaId": 1,
"empresa": null,
"funcionarioId": 3322,
"funcionario": null,
"inicio": "2023-08-01",
"fim": "2023-08-31",
"dia": "2023-08-01"
},
{
"id": 972,
"empresaId": 1,
"empresa": null,
"funcionarioId": 3322,
"funcionario": null,
"inicio": "2023-08-01",
"fim": "2023-08-31",
"dia": "2023-08-17"
}
]
},
"relationships": {
"evento": {
"data": {
"id": "2",
"type": "eventos"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/movimentos/4065/relationships/evento",
"related": "https://dp.pack.alterdata.com.br/api/v1/movimentos/4065/evento"
}
},
"departamento": {
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/movimentos/4065/relationships/departamento",
"related": "https://dp.pack.alterdata.com.br/api/v1/movimentos/4065/departamento"
}
},
"tipomovimento": {
"data": {
"id": "1",
"type": "tipos-movimento"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/movimentos/4065/relationships/tipomovimento",
"related": "https://dp.pack.alterdata.com.br/api/v1/movimentos/4065/tipomovimento"
}
},
"funcionario": {
"data": {
"id": "3322",
"type": "funcionarios"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/movimentos/4065/relationships/funcionario",
"related": "https://dp.pack.alterdata.com.br/api/v1/movimentos/4065/funcionario"
}
},
"empresa": {
"data": {
"id": "1",
"type": "empresas"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/movimentos/4065/relationships/empresa",
"related": "https://dp.pack.alterdata.com.br/api/v1/movimentos/4065/empresa"
}
}
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/movimentos/4065"
}
}
}Funcionários ¶
Consulta de Funcionários ¶
Consulta de FuncionáriosGET/api/v1/funcionarios{?fields,sort}
Através deste end-point é possível efetuar a consulta dos Funcionários das empresas que estão cadastradas na plataforma eContador.
Example URI
GET https://dp.pack.alterdata.com.br/api/v1/funcionarios?fields=&sort=
URI Parameters
- filter[empresaId]
integer(optional)Id da Empresa
- filter[status]
string(optional)Filtrar por status
Choices:
ativo- fields
string(optional)Incluir campos no retorno
Choices:
codigonomeafastamentodescricao- sort
string(optional)Ordenar por campos
Choices:
codigo
Request
Headers
Authorization: Bearer TOKENResponse
200Body
{
"data": [
{
"id": "11",
"type": "funcionarios",
"attributes": {
"codigo": "000001",
"afastamentodescricao": "",
"nome": "Nelson Rodrigues",
"status": "Ativo",
"dataAtualizacao": "2025-08-11T15:12:43.663145"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/funcionarios/11"
}
},
{
"id": "3231",
"type": "funcionarios",
"attributes": {
"codigo": "000004",
"afastamentodescricao": "Salário Maternidade",
"nome": "VERA LUCIA MELO COSTA",
"status": "Ativo"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/funcionarios/3231"
}
}
],
"links": {
"first": "https://dp.pack.alterdata.com.br/api/v1/funcionarios?filter[funcionarios][status][EQ]=ativo&page[limit]=25&fields[funcionarios]=codigo%2Cnome%2Cstatus%2Cafastamentodescricao&filter[funcionarios][empresa.id][EQ]=1&sort[funcionarios]=codigo",
"last": "https://dp.pack.alterdata.com.br/api/v1/funcionarios?filter[funcionarios][status][EQ]=ativo&page[limit]=25&page[offset]=225&fields[funcionarios]=codigo%2Cnome%2Cstatus%2Cafastamentodescricao&filter[funcionarios][empresa.id][EQ]=1&sort[funcionarios]=codigo",
"next": "https://dp.pack.alterdata.com.br/api/v1/funcionarios?filter[funcionarios][status][EQ]=ativo&page[limit]=25&page[offset]=25&fields[funcionarios]=codigo%2Cnome%2Cstatus%2Cafastamentodescricao&filter[funcionarios][empresa.id][EQ]=1&sort[funcionarios]=codigo"
},
"meta": {
"totalResourceCount": 226
}
}Consulta de Funcionário por Id ¶
Consulta de Funcionário por IdGET/api/v1/funcionarios{?include}
Através deste end-point é possível efetuar a consulta dos dados de um Funcionário das empresas que estão cadastradas na plataforma eContador.
Example URI
GET https://dp.pack.alterdata.com.br/api/v1/funcionarios?include=
URI Parameters
- filter[id]
integer(required)Id do Funcionário
- include
string(optional)Incluir campos no retorno
Choices:
naturalidadeestadofotoestadocivildepartamentosexoformadepagamentonacionalidadepaistipoDeContatipoDeChavePix
Request
Headers
Authorization: Bearer TOKENResponse
200Body
{
"data": [
{
"id": "11",
"type": "funcionarios",
"attributes": {
"nascimento": "1950-09-01T00:00:00Z",
"cidade": "",
"telefone": "",
"numero": 0,
"carteiradetrabalho": 11,
"afastamento": null,
"afastamentodescricao": "",
"cep": "25975-000",
"complemento": "",
"dataAtualizacao": "2025-08-11T15:12:43.663145",
"cpf": 78056752013,
"chavePix": "12333123244412312312312314512314826yskdjfhsd89se976rvbdcvsuidr02",
"conta": "00001-1",
"agencia": "00001",
"nomeDoBanco": "Banco ABC Brasil S.A.",
"banco": 246,
"externoid": "ZZZG7DEA030A052A11A0F62F8B1B4A0E06",
"pis": "",
"email": "nome@email.com.br",
"dataprorrogacaocontratoexperiencia": null,
"dataemissaocarteiradetrabalho": null,
"datavencimentocontratoexperiencia": "2022-07-24",
"codigo": "000001",
"telefonecelular": "",
"demissao": null,
"bairro": "",
"nomefuncao": "000104 - PROFESSOR DE EDUCAÇÃO",
"nome": "Nelson Rodrigues",
"identidade": "12345678",
"admissao": "2022-06-10T00:00:00Z",
"retorno": null,
"horarios": {
"entrada": "0800",
"inicioAlmoco": "1200",
"retornoAlmoco": "1400",
"saida": "1800",
"minutosIntervaloLanche": "0",
"escala": false,
"descansoSemanal": {
"segunda": false,
"terca": false,
"quarta": false,
"quinta": false,
"sexta": false,
"sabado": false,
"domingo": true
},
"complementares": null
},
"dataemissaoidentidade": null,
"serie": null,
"orgaoemissor": "Detran",
"rua": "",
"status": "Ativo",
"matriculaESocial": "12345678901234567890123456789012"
},
"relationships": {
"formadepagamento": {
"data": {
"id": "4",
"type": "tipos-forma-de-pagamento"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/funcionarios/11/relationships/formadepagamento",
"related": "https://dp.pack.alterdata.com.br/api/v1/funcionarios/11/formadepagamento"
}
},
"naturalidade": {
"data": null,
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/funcionarios/11/relationships/naturalidade",
"related": "https://dp.pack.alterdata.com.br/api/v1/funcionarios/11/naturalidade"
}
},
"estado": {
"data": null,
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/funcionarios/11/relationships/estado",
"related": "https://dp.pack.alterdata.com.br/api/v1/funcionarios/11/estado"
}
},
"foto": {
"data": {
"id": "12",
"type": "fotos"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/funcionarios/11/relationships/foto",
"related": "https://dp.pack.alterdata.com.br/api/v1/funcionarios/11/foto"
}
},
"estadocivil": {
"data": {
"id": "1",
"type": "tipos-estado-civil"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/funcionarios/11/relationships/estadocivil",
"related": "https://dp.pack.alterdata.com.br/api/v1/funcionarios/11/estadocivil"
}
},
"departamento": {
"data": {
"id": "4",
"type": "departamentos"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/funcionarios/11/relationships/departamento",
"related": "https://dp.pack.alterdata.com.br/api/v1/funcionarios/11/departamento"
}
},
"empresa": {
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/funcionarios/11/relationships/empresa",
"related": "https://dp.pack.alterdata.com.br/api/v1/funcionarios/11/empresa"
}
},
"sexo": {
"data": {
"id": "1",
"type": "tipos-sexo"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/funcionarios/11/relationships/sexo",
"related": "https://dp.pack.alterdata.com.br/api/v1/funcionarios/11/sexo"
}
},
"nacionalidade": {
"data": {
"id": "105",
"type": "paises"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/funcionarios/11/relationships/nacionalidade",
"related": "https://dp.pack.alterdata.com.br/api/v1/funcionarios/11/nacionalidade"
}
},
"pais": {
"data": null,
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/funcionarios/11/relationships/pais",
"related": "https://dp.pack.alterdata.com.br/api/v1/funcionarios/11/pais"
}
}
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/funcionarios/11"
},
"tipoDeConta": {
"data": {
"id": "3",
"type": "tipo-conta"
},
"links": {
"self": "http://localhost:1025/api/v1/funcionarios/4225/relationships/tipoDeConta",
"related": "http://localhost:1025/api/v1/funcionarios/4225/tipoDeConta"
}
},
"tipoDeChavePix": {
"data": {
"id": "4",
"type": "tipo-chave-pix"
},
"links": {
"self": "http://localhost:1025/api/v1/funcionarios/4225/relationships/tipoDeChavePix",
"related": "http://localhost:1025/api/v1/funcionarios/4225/tipoDeChavePix"
}
}
}
],
"included": [
{
"id": "4",
"type": "departamentos",
"attributes": {
"cei": "123456789012",
"externoid": "0010000002",
"nome": "Departamento 18/11"
},
"relationships": {
"empresa": {
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/departamentos/4/relationships/empresa",
"related": "https://dp.pack.alterdata.com.br/api/v1/departamentos/4/empresa"
}
}
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/departamentos/4"
}
},
{
"id": "12",
"type": "fotos",
"attributes": {
"tamanho": 0,
"imagem": ""
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/fotos/12"
}
},
{
"id": "105",
"type": "paises",
"attributes": {
"sigla": "BRA",
"nome": "Brasil"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/paises/105"
}
},
{
"id": "1",
"type": "tipos-estado-civil",
"attributes": {
"descricao": "Solteiro"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/tipos-estado-civil/1"
}
},
{
"id": "4",
"type": "tipos-forma-de-pagamento",
"attributes": {
"descricao": "Mensal"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/tipos-forma-de-pagamento/4"
}
},
{
"id": "1",
"type": "tipos-sexo",
"attributes": {
"descricao": "Masculino"
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/tipos-sexo/1"
}
},
{
"id": "4",
"type": "tipo-chave-pix",
"attributes": {
"descricao": "Chave aleatória"
},
"links": {
"self": "http://localhost:1025/api/v1/tipo-chave-pix/4"
}
},
{
"id": "3",
"type": "tipo-conta",
"attributes": {
"descricao": "Salário"
},
"links": {
"self": "http://localhost:1025/api/v1/tipo-conta/3"
}
}
],
"links": {
"first": "https://dp.pack.alterdata.com.br/api/v1/funcionarios?page[limit]=25&filter[funcionarios][id][EQ]=11&include[funcionarios]=naturalidade%2Cestado%2Cfoto%2Cestadocivil%2Cdepartamento%2Csexo%2Cformadepagamento%2Cnacionalidade%2Cpais",
"last": "https://dp.pack.alterdata.com.br/api/v1/funcionarios?page[limit]=25&filter[funcionarios][id][EQ]=11&include[funcionarios]=naturalidade%2Cestado%2Cfoto%2Cestadocivil%2Cdepartamento%2Csexo%2Cformadepagamento%2Cnacionalidade%2Cpais"
},
"meta": {
"totalResourceCount": 1
}
}Histórico de Funções ¶
Consulta de Histórico de Funções ¶
Consulta de Histórico de FunçõesGET/api/v1/historico-funcoes
Através deste end-point é possível efetuar a consultar dos Histórico de Funções dos funcionários que estão armazenadas na plataforma eContador.
Example URI
GET https://dp.pack.alterdata.com.br/api/v1/historico-funcoes
URI Parameters
- filter[funcionarioId]
integer(required)Filtrar histórico de funções que o funcionário possui.
Request
Headers
Authorization: Bearer TOKENResponse
200Body
{
"data": [
{
"id": "6",
"type": "historico-funcoes",
"attributes": {
"dataAlteracaoFuncao": "2023-06-27",
"funcaoAtual": {
"id": 1559,
"externoid": "ZZZG7E631E091F1527405679B585355719",
"codigo": "001071",
"nome": "ESCOLHEDOR DE PAPEL",
"cbo": 391225
},
"externoId": "s2312433424",
"funcaoAnterior": {
"id": 1559,
"externoid": "ZZZG7E631E091F1527405679B585355719",
"codigo": "001071",
"nome": "ESCOLHEDOR DE PAPEL",
"cbo": 391225
}
},
"links": {
"self": "https://dp.pack.alterdata.com.br/api/v1/historico-funcoes/6"
}
}
],
"links": {
"first": "https://dp.pack.alterdata.com.br/api/v1/historico-funcoes?page[limit]=25",
"last": "https://dp.pack.alterdata.com.br/api/v1/historico-funcoes?page[limit]=25"
},
"meta": {
"totalResourceCount": 1
}
}Integração Alterdata ¶
Arquivos de Lançamento
Os arquivos enviados devem estar no formato TXT e seguir o padrão de nome:
Lançamentos_contabeis_DD_MM_AAAA_a_DD_MM_AAAA.txt
Layout do Arquivo TXT
O conteúdo do arquivo TXT deverá seguir o layout de importação do Sistema Contábil Windows, conforme abaixo:
| Categoria | Descrição |
|---|---|
| 1 | Código do Lançamento Automático. |
| 2 | Código Conta Débito (Código de Chamada). |
| 3 | Código Conta Crédito (Código de Chamada). |
| 4 | Data do Lançamento (dd/mm/aaaa). |
| 5 | Valor do Lançamento. |
| 6 | Código do Histórico Padrão. |
| 7 | Descrição do Histórico. |
| 8 | Número documento. |
Exemplo
‘00001’,’’,‘28’,‘01/01/1998’,‘500,50’,‘00010’
Campos Obrigatórios na API
Para realizar uma integração com a Alterdata, os seguintes campos são obrigatórios:
| Campo | Descrição |
|---|---|
| Documento | Identificador único do documento contábil. |
| Categoria | Categoria do lançamento conforme tabela de categorias. |
| CNPJ Remetente | CNPJ do remetente dos dados. |
Integração Alterdata ¶
Integração AlterdataPOST/api/v1/integracao/integracaoAlterdata
Example URI
POST https://dp.pack.alterdata.com.br/api/v1/integracao/integracaoAlterdata
Request
Headers
Content-Type: application/vnd.api+json
Authorization: Bearer TOKENBody
{
"data": {
"type": "integracao/integracaoAlterdata",
"attributes": {
"documento": "Lançamentos_contabeis_DD_MM_AAAA_a_DD_MM_AAAA.txt", //nome do seu arquivo seguindo esse formato
"categoriaId": 1,
"cnpjremetente": "36462778000160",
"arquivoBase64":"U2V1IGJhc2UgNjQgYXF1aQ==" //seu arquivo em base64 aqui
}
}
}Response
201Body
{
"data": {
"id": "540",
"type": "integracao/integracaoAlterdata",
"attributes": {
"cnpjremetente": "36462778000160",
"entrada": "2023-12-04T15:41:30.671",
"documento": "Lançamentos_contabeis_DD_MM_AAAA_a_DD_MM_AAAA.txt",
"arquivoBase64": "U2V1IGJhc2UgNjQgYXF1aQ==",
"categoriaId": 1
},
"links": {
"self": "https://documentos.pack.alterdata.com.br/api/v1/integracao/integracaoAlterdata/540"
}
}
}Usuários ¶
Consulta de Usuário por Id ¶
Consulta de Usuário por IdGET/api/v1/integracao/usuarios/{id}
Através deste end-point é possível efetuar a consulta de um Usuário que está cadastrado na plataforma eContador.
Example URI
GET https://dp.pack.alterdata.com.br/api/v1/integracao/usuarios/id
URI Parameters
- id
integer(required)Id do Usuário
Request
Headers
Content-Type: application/vnd.api+json
Authorization: Bearer TOKENResponse
200Body
{
"data": {
"id": "2009349000110",
"type": "integracao/usuarios",
"attributes": {
"nome": "Alterdata Interno ",
"email": "nome@email.com.br"
},
"relationships": {
"empresas": {
"links": {
"self": "https://identificacao.pack.alterdata.com.br/api/v1/api/v1/integracao/usuarios/2009349000110/relationships/empresas",
"related": "https://identificacao.pack.alterdata.com.br/api/v1/api/v1/integracao/usuarios/2009349000110/empresas"
}
}
},
"links": {
"self": "https://identificacao.pack.alterdata.com.br/api/v1/api/v1/integracao/usuarios/2009349000110"
}
}
}Consulta de Todos os Usuários Clientes ¶
Consulta de Todos os UsuáriosGET/api/v1/integracao/usuarios
Através deste end-point é possível efetuar a consulta de todos os Usuários do tipo Cliente que estão cadastrados e ativos na plataforma eContador.
Example URI
GET https://dp.pack.alterdata.com.br/api/v1/integracao/usuarios
URI Parameters
- page[offset]
integer(optional)Página da paginação
- page[limit]
integer(optional)Quantidade de item por página
Request
Headers
Authorization: Bearer TOKENResponse
200Body
{
"data": [
{
"id": "34330308045",
"type": "integracao/usuarios",
"attributes": {
"telefone": "(21)999999999",
"nome": "Cliente Econtador",
"email": "nome@email.com.br"
},
"relationships": {
"empresas": {
"links": {
"self": "https://identificacao.pack.alterdata.com.br/api/v1/api/v1/integracao/usuarios/34330308045/relationships/empresas",
"related": "https://identificacao.pack.alterdata.com.br/api/v1/api/v1/integracao/usuarios/34330308045/empresas"
}
}
},
"links": {
"self": "https://identificacao.pack.alterdata.com.br/api/v1/api/v1/integracao/usuarios/34330308045"
}
}
],
"links": {
"first": "https://identificacao.pack.alterdata.com.br/api/v1/api/v1/integracao/usuarios/?page[limit]=1",
"last": "https://identificacao.pack.alterdata.com.br/api/v1/api/v1/integracao/usuarios/?page[limit]=1&page[offset]=1",
"next": "https://identificacao.pack.alterdata.com.br/api/v1/api/v1/integracao/usuarios?page[limit]=1&page[offset]=1",
"prev": null
},
"meta": {
"totalResourceCount": 2
}
}Estruturas de Dados ¶
Status Admissão
| ID | Status |
|---|---|
| 0 | Pendente |
| 1 | Analise |
| 2 | Aguardando Cliente |
| 3 | Cadastrado |
| 4 | Cancelado |
| 5 | A concluir |
Estado
| ID | Nome | Sigla |
|---|---|---|
| 1 | Acre | AC |
| 2 | Alagoas | AL |
| 3 | Amapá | AP |
| 4 | Amazonas | AM |
| 5 | Bahia | BA |
| 6 | Ceará | CE |
| 7 | Distrito Federal | DF |
| 8 | Espírito Santo | ES |
| 9 | Goiás | GO |
| 10 | Maranhão | MA |
| 11 | Mato Grosso | MT |
| 12 | Mato Grosso do Sul | MS |
| 13 | Minas Gerais | MG |
| 14 | Pará | PA |
| 15 | Paraíba | PB |
| 16 | Paraná | PR |
| 17 | Pernambuco | PE |
| 18 | Piauí | PI |
| 19 | Roraima | RR |
| 20 | Rondônia | RO |
| 21 | Rio de Janeiro | RJ |
| 22 | Rio Grande do Norte | RN |
| 23 | Rio Grande do Sul | RS |
| 24 | Santa Catarina | SC |
| 25 | São Paulo | SP |
| 26 | Sergipe | SE |
| 27 | Tocantins | TO |
Estado Civil
| ID | Estado |
|---|---|
| 1 | Solteiro |
| 2 | Casado |
| 3 | Divorciado |
| 4 | Viúvo |
| 5 | União Estável |
| 6 | Outros |
Vinculo Trabalhista
| ID | Vínculo |
|---|---|
| 10 | Trabalhador urbano vinculado a empregador pessoa jurídica por contrato de trabalho regido pela CLT por prazo indeterminado |
| 15 | Trabalhador urbano vinculado a empregador pessoa física por contrato de trabalho regido pela CLT por prazo indeterminado |
| 20 | Trabalhador rural vinculado a empregador pessoa jurídica por contrato de trabalho regido pela Lei nº 5,889/73 por prazo indeterminado |
| 25 | Trabalhador rural vinculado a empregador pessoa física por contrato de trabalho regido pela Lei nº 5,889/73 por prazo indeterminado |
| 30 | Servidor regido pelo Regime Jurídico Único (federal, estadual e municipal) e militar |
| 31 | Servidor regido pelo Regime Jurídico Único (federal, estadual e municipal) e militar, vinculado ao Regime Geral da Previdência Social |
| 35 | Servidor público não-efetivo (demissível ad nutum ou admitido por legislaçäo especial, näo regido pela CLT |
| 40 | Trabalhador avulso (trabalho administrado pelo sindicato da categoria ou pelo órgão gestor de mão-de-obra) para o qual é devido depósito de FGTS - CF 88, art. 7, inciso III |
| 50 | Trabalhador temporário, regido pela Lei nº 6.019 de 03/01/74 |
| 55 | Menor aprendiz |
| 60 | Trabalhador urbano vinculado a empregador pessoa jurídica por contrato de trabalho regido pela CLT, por tempo determinado ou obra certa |
| 65 | Trabalhador urbano vinculado a empregador pessoa física por contrato de trabalho regido pela CLT, por tempo determinado ou obra certa |
| 70 | Trabalhador rural vinculado a empregador pessoa jurídica por contrato de trabalho regido pela Lei nº 5.889/73, por prazo determinado |
| 75 | Trabalhador rural vinculado a empregador pessoa física por contrato de trabalho regido pela Lei nº 5.889/73, por prazo determinado |
| 80 | Diretor sem vínculo empregatício para o qual a empresa/entidade tenha optado por recolhimento ao FGTS |
| 90 | Contrato de Trabalho por Prazo Determinado, regido pela Lei nº 9.601 de 21/01/98 |
| 95 | Contrato de Trabalho por Tempo Determinado, regido pela Lei nº 8,745, de 9 de dezembro de 1993, com redação dada pela Lei nº. 9,849, de 26 de outubro de 1999 |
| 96 | Contrato de Trabalho por Tempo Determinado, regido por Lei Estadual |
Tipo Conta
| ID | Conta |
|---|---|
| 1 | Conta Corrente |
| 2 | Poupança |
| 3 | Conta Salário |
| 4 | Não Possui |
Tipo Banco
| ID (Código) | Banco |
|---|---|
| 246 | Banco ABC Brasil S.A. |
| 075 | Banco ABN AMRO S.A. |
| 121 | Banco Agibank S.A. |
| 025 | Banco Alfa S.A. |
| 065 | Banco Andbank (Brasil) S.A. |
| 096 | Banco B3 S.A. |
| 024 | Banco BANDEPE S.A. |
| 318 | Banco BMG S.A. |
| 752 | Banco BNP Paribas Brasil S.A. |
| 107 | Banco BOCOM BBM S.A. |
| 237 | Banco Bradesco S.A. |
| 218 | Banco BS2 S.A. |
| 208 | Banco BTG Pactual S.A. |
| 336 | Banco C6 S.A. |
| 473 | Banco Caixa Geral - Brasil S.A. |
| 040 | Banco Cargill S.A. |
| 739 | Banco Cetelem S.A. |
| 233 | Banco Cifra S.A. |
| 745 | Banco Citibank S.A. |
| 756 | Banco Cooperativo do Brasil S.A. - BANCOOB |
| 748 | Banco Cooperativo Sicredi S.A. |
| 222 | Banco Credit Agricole Brasil S.A. |
| 505 | Banco Credit Suisse (Brasil) S.A. |
| 368 | Banco CSF S.A. |
| 003 | Banco da Amazônia S.A. |
| 083 | Banco da China Brasil S.A. |
| 707 | Banco Daycoval S.A. |
| 654 | Banco Digimais S.A. |
| 335 | Banco Digio S.A. |
| 001 | Banco do Brasil S.A. |
| 047 | Banco do Estado de Sergipe S.A. |
| 037 | Banco do Estado do Pará S.A. |
| 041 | Banco do Estado do Rio Grande do Sul S.A. |
| 004 | Banco do Nordeste do Brasil S.A. |
| 224 | Banco Fibra S.A. |
| 094 | Banco Finaxis S.A. |
| 612 | Banco Guanabara S.A. |
| 012 | Banco Inbursa S.A. |
| 604 | Banco Industrial do Brasil S.A. |
| 653 | Banco Indusval S.A. |
| 077 | Banco Inter S.A. |
| 376 | Banco J. P. Morgan S.A. |
| 074 | Banco J. Safra S.A. |
| 217 | Banco John Deere S.A. |
| 600 | Banco Luso Brasileiro S.A. |
| 243 | Banco Máxima S.A. |
| 389 | Banco Mercantil do Brasil S.A. |
| 370 | Banco Mizuho do Brasil S.A. |
| 746 | Banco Modal S.A. |
| 456 | Banco MUFG Brasil S.A. |
| 212 | Banco Original S.A. |
| 623 | Banco PAN S.A. |
| 611 | Banco Paulista S.A. |
| 643 | Banco Pine S.A. |
| 747 | Banco Rabobank International Brasil S.A. |
| 633 | Banco Rendimento S.A. |
| 120 | Banco Rodobens S.A. |
| 422 | Banco Safra S.A. |
| 033 | Banco Santander (Brasil) S.A. |
| 743 | Banco Semear S.A. |
| 276 | Banco Senff S.A. |
| 630 | Banco Smartbank S.A. |
| 366 | Banco Société Générale Brasil S.A. |
| 299 | Banco Sorocred S.A. - Banco Múltiplo (AFINZ) |
| 464 | Banco Sumitomo Mitsui Brasileiro S.A. |
| 082 | Banco Topázio S.A. |
| 634 | Banco Triângulo S.A. |
| 655 | Banco Votorantim S.A. |
| 610 | Banco VR S.A. |
| 119 | Banco Western Union do Brasil S.A. |
| 102 | Banco XP S.A. |
| 021 | BANESTES S.A. Banco do Estado do Espírito Santo |
| 755 | Bank of America Merrill Lynch Banco Múltiplo S.A. |
| 250 | BCV - Banco de Crédito e Varejo S.A. |
| 144 | BEXS Banco de Câmbio S.A. |
| 017 | BNY Mellon Banco S.A. |
| 070 | BRB - Banco de Brasília S.A. |
| 104 | Caixa Econômica Federal |
| 320 | China Construction Bank (Brasil) Banco Múltiplo S.A. |
| 477 | Citibank N.A. |
| 487 | Deutsche Bank S.A. - Banco Alemão |
| 062 | Hipercard Banco Múltiplo S.A. |
| 269 | HSBC Brasil S.A. - Banco de Investimento |
| 492 | ING Bank N.V. |
| 341 | Itaú Unibanco S.A. |
| 488 | JPMorgan Chase Bank |
| 399 | Kirton Bank S.A. - Banco Múltiplo |
| 128 | MS Bank S.A. Banco de Câmbio |
| 254 | Paraná Banco S.A. |
| 125 | Plural S.A. - Banco Múltiplo |
| 751 | Scotiabank Brasil S.A. Banco Múltiplo |
| 095 | Travelex Banco de Câmbio S.A. |
| 129 | UBS Brasil Banco de Investimento S.A. |
| 260 | Nu Pagamentos S.A. |
Tipo Admissao
| ID | Tipo |
|---|---|
| 1 | Admissão |
| 2 | Transferência |
| 3 | Sucessão |
| 4 | Cessão |
Status de Agendamento
| ID | Status |
|---|---|
| 1 | Aguardando Liberação |
| 2 | Aguardando Importação |
| 3 | Aguardando Confirmação |
| 4 | Confirmado |
| 5 | Confirmado com Observações |
| 6 | Férias Processadas |
| 7 | Excluído |
| 8 | Cancelado |
Tipo Emissor
| ID | Emissor |
|---|---|
| 1 | Empregado |
| 2 | Empresa |
Tipo Documento Rescisao
| ID | Tipo |
|---|---|
| 1 | Aviso prévio |
| 2 | Comunicado de dispensa |
Tipo Aviso Previo
| ID | Tipo |
|---|---|
| 1 | Trabalhado |
| 2 | Indenizado |
| 3 | Dispensa de aviso |
Tipo Desligamento
| ID | Tipo |
|---|---|
| 10 | Desligar o funcionário com justa causa |
| 11 | Desligar o funcionário sem justa causa |
| 12 | Término de contrato do funcionário |
| 20 | Pedido de demissão com justa causa (Rescisão indireta) |
| 21 | Pedido de demissão sem justa causa ou exoneração a pedido |
| 30 | Transferência/movimentação do empregado/servidor entre estabelecimentos da mesma empresa/entidade, ou para outra empresa/entidade, com ônus para a cedente (com ônus para empresa de origem) |
| 31 | Transferência/movimentação do empregado/servidor ou dirigente sindical entre estabelecimentos da mesma empresa/entidade, ou para outra empresa/entidade, sem ônus para a cedente (sem ônus para empresa de origem) |
| 33 | Rescisão por acordo entre as partes |
| 33 | Rescisão por acordo entre as partes |
| 40 | Mudança de regime trabalhista |
| 41 | Rescisão do contrato de aprendizagem por desempenho insuficiente ou inadaptação do aprendiz |
| 44 | Agrupamento contratual |
| 50 | Reforma de militar para a reserva remunerada |
| 60 | Falecimento |
| 62 | Falecimento decorrente de acidente do trabalho típico (que ocorre no exercício do trabalho à serviço do estabelecimento) |
| 63 | Falecimento decorrente de acidente do trabalho de trajeto |
| 64 | Falecimento decorrente de doença profissional |
| 70 | Aposentadoria por tempo de serviço, com rescisão contratual |
| 71 | Aposentadoria por tempo de serviço, sem rescisão contratual |
| 72 | Aposentadoria por idade, com rescisão contratual |
| 73 | Aposentadoria por invalidez, decorrente de acidente do trabalho |
| 74 | Aposentadoria por invalidez, decorrente de doença profissional |
| 75 | Aposentadoria compulsória |
| 76 | Aposentadoria por invalidez, exceto a decorrente de doença profissional ou acidente do trabalho |
| 78 | Aposentadoria por idade, sem rescisão contratual |
| 79 | Aposentadoria especial, com rescisão do contrato |
| 80 | Aposentadoria especial, sem rescisão do contrato |
Tipo Movimento
| ID | Tipo |
|---|---|
| 1 | Folha |
| 2 | Férias |
| 3 | Rescisão |
| 4 | Adiantamento |
| 5 | 1° parcela do 13º |
| 6 | 2° parcela do 13º |
Status Tarefas
| ID | Status |
|---|---|
| 1 | A fazer |
| 2 | Concluído |
| 5 | Atrasada |
| 6 | Risco de multas |
| 7 | Enviado |
Tipo Categoria
| ID | Tipo |
|---|---|
| 1 | Laçamento Contabil |
Vertical ¶
Consulta de Vertical ¶
Consulta de VerticalGET/api/v1/integracao/user-connections/verificar-vertical
Através deste end-point é possível efetuar a consultar da vertical do cliente.
Example URI
GET https://dp.pack.alterdata.com.br/api/v1/integracao/user-connections/verificar-vertical
Request
Headers
Authorization: Bearer TOKENResponse
200Body
{
"data": {
"id": "id",
"type": "identificacao/user-connection",
"attributes": {
"vertical": "Pack"
},
"relationships": {},
"links": {}
}
}Estruturas de Serviço ¶
JSON API
O que é?
A JSON:API é uma especificação para a construção de APIs que padroniza como clientes devem solicitar dados e como servidores devem respondê-los. Ela foi criada para tornar as APIs mais eficientes, flexíveis e escaláveis, focando na redução do número de requisições e na padronização da estrutura das respostas.
Como a JSON:API funciona?
A principal característica da JSON:API é a sua estrutura de dados uniforme. Isso significa que, independentemente do tipo de recurso que você está buscando, a forma como os dados são apresentados e relacionados será sempre a mesma. Essa padronização facilita a integração de clientes e servidores, tornando o desenvolvimento mais rápido e menos propenso a erros.
Basicamente, a JSON:API organiza as informações em torno de dois conceitos principais:
-
Recursos (Resources): Representam os dados centrais da sua aplicação, como um usuário, um produto ou um pedido. Cada recurso possui um type (tipo) e um id (identificador único), além de attributes (atributos) que descrevem suas propriedades (ex: nome, email, nascimento).
-
Relacionamentos (Relationships): Descrevem como os recursos se conectam uns aos outros, é aqui que o JSON:API se destaca, permitindo que você represente conexões complexas de forma clara e eficiente.
Como lidar com os Relationships?
Diante de um campo da categoria Relationship precisamos construir ele seguindo um padrão estrutural, por exemplo o relacionamento com endereço:
Precisamos utilizar as keys:
-
relationships: Representa o bloco de vínculos entre o recurso principal; -
entity: Representa o nome do recurso [dentro de relationships]; -
data: Contém o objeto de relacionamento [dentro de entity]; -
type: Indica o tipo do recurso [dentro de data]; -
id: Indica o identificador único do recurso [dentro de data];
Resultado do objeto de relacionamento:
“relationships”: { “endereco”: { “data”: { “type”: “enderecos”, “id”: “201” } } }
Abaixo podemos visualizar um exemplo de como ficaria esta estrutura:
Exemplo de estrutura
A seguir temos o exemplo da construção de um body para comunicar com o JSON:API:
-
Exemplo:
{ "data": [ { "type": "clientes", "id": "101", "attributes": { "nome_completo": "Ana Paula Costa", "data_cadastro": "2025-11-15T10:00:00Z" }, "relationships": { "endereco": { "data": { "type": "enderecos", "id": "201" }, "links": { "related": "/enderecos/201" } }, "contatos": { "data": [ { "type": "contatos", "id": "301" }, { "type": "contatos", "id": "302" } ], "links": { "related": "/clientes/101/contatos" } } } }, { "type": "clientes", "id": "102", "attributes": { "nome_completo": "Bruno Mendes", "data_cadastro": "2024-01-20T14:30:00Z" }, "relationships": { "endereco": { "data": { "type": "enderecos", "id": "202" }, "links": { "related": "/enderecos/202" } }, "contatos": { "data": [ { "type": "contatos", "id": "303" } ], "links": { "related": "/clientes/102/contatos" } } } } ] }