v

INTERFACES AMADEO PAYROLL

Desenho Funcional

Junho 2015
Interfaces AMADEO PAYROLL

Pgina 1

AVISO DE CONFIDENCIALIDADE

A informao contida neste documento confidencial e pertence FAVVUS-ITHR. Qualquer

divulgao, reproduo, cpia ou distribuio total ou parcial da mesma proibida, no podendo
ser utilizado o seu contedo para outros fins sem autorizao da FAVVUS-ITHR.

NDICE
1 Introduo........................................................................................................................................................ 6

1.1

OBJETIVO................................................................................................................................ 6

1.2

MBITO.................................................................................................................................. 6

2 Descrio Documentos e Relatorios......................................................................................................7

2.1

CONSULTA DE RECIBOS............................................................................................................ 7

2.1.1

Descrio do Interface e seu objetivo......................................................................................7

2.1.2

Destino/Origem............................................................................................................................. 7

2.1.3

Imput/Output................................................................................................................................. 7

2.2

GERAR RECIBOS...................................................................................................................... 8

2.2.1

Descrio do Interface e seu objetivo......................................................................................8

2.2.2

Destino/Origem............................................................................................................................. 8

2.2.3

Imput/Output................................................................................................................................. 8

2.3

GERAR DECLARAES

DE

IRS................................................................................................. 9

2.3.1

Descrio do Interface e seu objetivo......................................................................................9

2.3.2

Destino/Origem............................................................................................................................. 9

2.3.3

Imput/Output................................................................................................................................. 9

Interfaces AMADEO PAYROLL

Pgina 2

IDENTIFICAO

Ttulo do Documento
Organizao

Interfaces AMADEO PAYROLL

FAVVUS ITHR

Referncia

IAP002

Data do Documento
Validade do Documento
Suporte Lgico

05.Feveiro.2016

Registo de alteraes

Data:

Verso: 001

MS-Word
Verso

Motivo de alteraes

001

Elaborao

Autoria

Aprovao

Joo Sousa

Patrcia Paula

05 de Fevereiro de
2016

Data:

05 de Fevereiro de
2016

Interfaces AMADEO PAYROLL

Pgina 3

Interfaces AMADEO PAYROLL

Pgina 4

1I
nt
ro
du

o
1.1 Objetivo
Este documento tem como objetivo definir todos os interfaces que interagem com a aplicao
Amadeo Payroll. Pretendemos assim clarificar todos os interfaces que permitem a comunicao
entre a aplicao Amadeo Payroll e um portal Externo.

1.2 mbito
Este documento abrange apenas o desenho funcional dos interfaces que interagem com a
aplicao Amadeo Payroll. No se pretende com este documento descrever tecnicamente os
sistemas com os quais o Amadeo payroll interage, mas apenas os interfaces que viabilizam a
comunicao entre os dois sistemas.

Interfaces AMADEO PAYROLL

Pgina 5

2D
es
cri

o
D
oc
u
m
en
to
s
e
Re
lat
or
io
s
2.1 Consulta de Recibos
2.1.1 Descrio do Interface e seu objetivo
Interface constitudo por um WebService responsvel pela integrao dos recibos de vencimento
disponiveis referentes a um determinado colaborador. Este interface usado para atualizar
PortalWeb os recibos de vencimento que o colaborador pode escolher ser enviado pelo Amadeo
Payroll.

2.1.2 Destino/Origem
PortalWeb / Amadeo Payroll

Interfaces AMADEO PAYROLL

Pgina 6

2.1.3 Imput/Output

retornarRecibosVencimento

Parmetros de entrada:
-pEmpresa (Cdigo da Empresa) string
-pEmpregado (Cdigo da Empregado) string
Parmetros de sada ( Array Classe ReciboVencimento ):
-ReciboID (ID Interno do Recibo) int
-Empresa (Cdigo Empresa) string
-Empregado (Cdigo Empregado) string
-Ano (Ano Recibo) - int
-Mes (Ms Recibo) - int
-Mail1 (Primeiro email do colaborador) - string
-Mail1 (Segundo email do colaborador) - string
-Mail1 (Terceiro email do colaborador) string

2.2 Gerar Recibos

2.2.1 Descrio do Interface e seu objetivo
Interface constitudo por um WebService responsvel pela criao dos recibos para uma pasta
escolhida pelo utilizador. ( Este interface apenas ir funcionar depois de criar os dados no lado do
Amadeo Payroll para o ano e ms em questo )

2.2.2 Destino/Origem
FOLDER / Amadeo Payroll

2.2.3 Imput/Output

enviarReciboVencimento

Parmetros de entrada:
-pReciboID (ID Interno Recibo) int
-pEmpresa (Cdigo da Empresa) string
-pEmpregado (Cdigo da Empregado) string
-pPastaDestino (Pasta a exportar o documento PDF) string
Parmetros de sada ( Boolean )

Interfaces AMADEO PAYROLL

Pgina 7

2.3 Gerar Declaraes de IRS

2.3.1 Descrio do Interface e seu objetivo
Interface constitudo por um WebService responsvel pela criao das declaraes de reteno na
fonte para para uma pasta escolhida pelo utilizador. ( Este interface apenas ir funcionar depois
de criar os dados no lado do Amadeo Payroll para o ano em questo ). Pode ser usada a verso
NIF para evitar colaboradores que estejam constantemente a mudar de empresa

2.3.2 Destino/Origem
FOLDER / Amadeo Payroll

2.3.3 Imput/Output

enviarDeclaracaoIRS

Parmetros de entrada:
-pAno (Ano da declarao) int
-pEmpresa (Cdigo da Empresa) string
-pEmpregado (Cdigo da Empregado) string
-pPastaDestino (Pasta a exportar o documento PDF) string
Parmetros de sada ( Boolean )

enviarDeclaracaoIRS_NIF

Parmetros de entrada:
-pAno (Ano da declarao) int
-NIF (NIF do Colaborador) string
-pPastaDestino (Pasta a exportar o documento PDF) string

Interfaces AMADEO PAYROLL

Pgina 8

Parmetros de sada ( Boolean )

Interfaces AMADEO PAYROLL

Pgina 9