Report Service

Nmbrs API Report Service provides the ability for the customer to collect readable payroll data (in form of XML) from Nmbrs environment overviews (reports). Because the overviews can contain a big amount of data, Nmbrs Report Service also provides, for each Report Service call, the same call to run in Background, avoiding possible time-out problems to occur.

For more information please check our example  'How to use a Background call'

 

 

List of available Report Service calls:

Webservice name Description Dashlet in Nmbrs
Reports_Accountant_CompanyContactPerson  Generate report company contact person of all companies for the login user account Overviews - Company - Contacts
Reports_Accountant_CompanySVWSettings  Generate report company svw settings of all companies for the login user account Overviews - Company - SVW Settings
Reports_Accountant_CompanySalarySettings  Generate report company salary settings of all companies for the login user account Overviews - Company - Salary Settings
Reports_Accountant_CompanyWageTaxSettings  Generate report company wage tax settings of all companies for the login user account Overviews - Company - Company Wage Tax Settings
Reports_Accountant_CompanyWorkflowSettings  Generate report company workflow settings for the login user account Overviews - Company - Workflow Settings
Reports_Accountant_CompanyWorkflowSettings_Background  Launch the background task to generate report company workflow settings for the login user account Overviews - Company - Workflow Settings
Reports_Accountant_Company_CompanyJournalReport  Generate company journal report within specified period Company - Overviews - Company - Journals Report
Reports_Accountant_Company_CompanyWageComponentsPerPeriod  Generate wage component report per period with all components within specified company and year Company - Overviews - Company - Wage Components Per Period
Reports_Accountant_Company_CompanyWageComponentsPerRun  Generate wage component report per run with all components within specified company and year Company - Overviews - Company - Wage Components Per Run
Reports_Accountant_Company_CompanyWageComponentsPerRunPeriod  Generate wage component report per run period with all components within specified company and year Company - Overviews - Company - Wage Components Per Run/Period
Reports_Accountant_Company_EmployeeWageComponentsPerRun  Generate employees wage component report per run with all components within specified company and year Company - Overviews - Employee - Wage Components Per Run
Reports_Accountant_Company_EmployeeWageComponentsPerRunPeriod  Generate employees wage component report per run period with all components within specified company and year Company - Overviews - Employee - Wage Components Per Run/period
Reports_Accountant_Debtor_CompanySVWSettings  Generate report company svw settings of all companies attached to specified debtor  N.a.
Reports_Accountant_Debtor_CompanySalarySettings  Generate report company salary settings of all companies attached to specified debtor  N.a.
Reports_Accountant_Debtor_EmployeeAbsence  Generate report employee absence for employees attached to specified debtor Debtor - Overviews - Employee HR Absence and Leave - Absence
Reports_Accountant_Debtor_EmployeeAbsence_Background  Launch the background task to generate report employee absence for employees attached to specified debtor Debtor - Overviews - Employee HR Absence and Leave - Absence
Reports_Accountant_Debtor_EmployeeContracts  Generate report employee contracts for employees attached to specified debtor Debtor - Overviews - Employee HR General - Contract
Reports_Accountant_Debtor_EmployeeContracts_Background  Launch the background task to generate report employee contracts for employees attached to specified debtor Debtor - Overviews - Employee HR General - Contract
Reports_Accountant_Debtor_EmployeeHoursSalary  Generate report employee hours and salary for employees attached to specified debtor Debtor - Overviews - Employee Payroll - Hours and Salary
Reports_Accountant_Debtor_EmployeeHoursSalary_Background  Launch the background task to generate report employee hours and salary for employees attached to specified debtor Debtor - Overviews - Employee Payroll - Hours and Salary
Reports_Accountant_Debtor_EmployeeSVWSettings  Generate report employee SVW settings for employees attached to specified debtor Debtor - Overviews - Employee Payroll - SVW Settings
Reports_Accountant_Debtor_EmployeeSVWSettings_Background  Launch the background task to generate report employee SVW settings for employees attached to specified debtor Debtor - Overviews - Employee Payroll - SVW Settings
Reports_Accountant_Debtor_EmployeeWageComponentsPerPeriod  Generate report with all wage components per period for the login user account Debtor - Overviews - Employee Payroll - Wage Components Per Period
Reports_Accountant_Debtor_EmployeeWageTaxSettings  Generate report employee wage tax settings for employees attached to specified debtor Debtor - Overviews - Employee Payroll - Wage Tax Settings
Reports_Accountant_Debtor_EmployeeWageTaxSettings_Background  Launch the background task to generate report employee wage tax settings for employees attached to specified debtor Debtor - Overviews - Employee Payroll - Wage Tax Settings
Reports_Accountant_EmployeeAbsence  Generate report employee absence of all employees for the login user account Overviews - Employee - Absence
Reports_Accountant_EmployeeAbsence_Background  Launch the background task to generate the report employee absence of all employees for the login user account and get the task's Id. Overviews - Employee - Abesence
Reports_Accountant_EmployeeContracts  Generate report employee contracts of all employees for the login user account Overviews - Employee - Contracts
Reports_Accountant_EmployeeContracts_Background  Launch the background task to generate the report employee contracts of all employees for the login user account and get the task's Id. Overviews - Employee - Contracts
Reports_Accountant_EmployeeHoursSalary  Generate report employee hours salary of all employees for the login user account Overviews - Employee - Hours and Salary
Reports_Accountant_EmployeeHoursSalary_Background  Launch the background task to generate the report employee hours salary of all employees for the login user account and get the task's Id. Overviews - Employee - Hours and Salary
Reports_Accountant_EmployeeNameAddress  Generate report employee name and address of all employees for the login user account Overviews - Employee - Name and Address
Reports_Accountant_EmployeeNameAddress_Background  Launch the background task to generate report employee name and address of all employees for the login user account Overviews - Employee - Name and Address
Reports_Accountant_EmployeeSVWSettings  Generate report employee SVW settings of all employees for the login user account Overviews - Employee - SVW Settings
Reports_Accountant_EmployeeSVWSettings_Background  Launch the background task to generate report employee SVW settings of all employees for the login user account Overviews - Employee - SVW Settings
Reports_Accountant_EmployeeWageComponentsPerPeriod  Generate report with all wage components per period for the login user account Overviews - Accountant - Wage Components Per Period
Reports_Accountant_EmployeeWageTaxSettings  Generate report employee wage tax settings of all employees for the login user account Overviews - Employee - Wage Tax Settings
Reports_Accountant_EmployeeWageTaxSettings_Background  Launch the background task to generate report employee wage tax settings of all employees for the login user account Overviews - Employee - Wage Tax Settings
Reports_Accountant_LeasecarOverview  Generate report with all the employee company cars for the login user account Overviews - Employee - Company Car
Reports_Accountant_LeasecarOverview_Background  Launch the background task to generate report with all the employee company cars for the login user account Overviews - Employee - Company Car
Reports_BackgroundTask_Result  The the report generated by the background task with the given TaskId.  N.a.
Reports_Business_CompanySVWSetting  Generate report employee name and address of all employees for the login user account  N.a.
Reports_Business_CompanySVWSetting_Background  Launch the background task to generate report employee name and address of all employees for the login user account  N.a.
Reports_Business_Company_CompanyJournalReport  Generate company journal report within specified period Company - Overviews - Company - Journals Report
Reports_Business_Company_CompanyWageComponentsPerPeriod  Generate wage component report per period with all components within specified company and year Company - Overviews - Company - Wage Components Per Period
Reports_Business_Company_CompanyWageComponentsPerRun  Generate wage component report per run with all components within specified company and year Company - Overviews - Company - Wage Components Per Run
Reports_Business_Company_CompanyWageComponentsPerRunPeriod  Generate wage component report per run period with all components within specified company and year Company - Overviews - Company - Wage Components Per Run/Period
Reports_Business_Company_EmployeeWageComponentsPerRun  Generate employees wage component report per run with all components within specified company and year Company - Overviews - Employee Payroll - Wage Components Per Run
Reports_Business_Company_EmployeeWageComponentsPerRunPeriod  Generate employees wage component report per run period with all components within specified company and year Company - Overviews - Employee Payroll - Wage Components Per/Period
Reports_Business_EmployeeAbsence  Generate report employee absence of all employees for the login user account Overviews - Employee HR Absence and Leave - Absence
Reports_Business_EmployeeAbsence_Background  Launch the background task to generate report employee absence of all employees for the login user account Overviews - Employee HR Absence and Leave - Absence
Reports_Business_EmployeeContracts  Generate report employee contracts of all employees for the login user account Overviews - Employee HR Genereal - Contract
Reports_Business_EmployeeContracts_Background  Launch the background task to generate report employee contracts of all employees for the login user account Overviews - Employee HR Genereal - Contract
Reports_Business_EmployeeHoursSalary  Generate report employee hours salary of all employees for the login user account Overviews - Employee Payroll - Hours and Salary
Reports_Business_EmployeeHoursSalary_Background  Launch the background task to generate report employee hours salary of all employees for the login user account Overviews - Employee Payroll - Hours and Salary
Reports_Business_EmployeeNameAddress  Generate report employee name and address of all employees for the login user account Overviews - Employee HR Genereal - Name and Address
Reports_Business_EmployeeNameAddress_Background  Launch the background task to generate report employee name and address of all employees for the login user account Overviews - Employee HR Genereal - Name and Address
Reports_Business_EmployeeSVWSettings  Generate report employee SVW settings of all employees for the login user account Overviews - Employee Payroll - SVW Settings
Reports_Business_EmployeeSVWSettings_Background  Launch the background task to generate report employee SVW settings of all employees for the login user account Overviews - Employee Payroll - SVW Settings
Reports_Business_EmployeeWageComponentsPerPeriod  Generate report with all wage components per period for the login user account Overviews - Employee Payroll - Wage Components Per Period
Reports_Business_EmployeeWageTaxSettings  Generate report employee wage tax settings of all employees for the login user account Overviews - Employee Payroll - Wage Tax Settings
Reports_Business_EmployeeWageTaxSettings_Background  Launch the background task to generate report employee wage tax settings of all employees for the login user account Overviews - Employee Payroll - Wage Tax Settings

 

 

 

How to use a background call:

Submit initial request for the report:

1.background_report_absence-edit.JPG

A Guid is returned in the response of the initial request which is the TaskId.

With the TaskId, submit a request to Reports_BackgroundTask_Result. It may return different status:

  • Unknown
  • Enqueued
  • Executing
  • Success
  • Error

3.background_report_result_executing-edit.JPG2.background_report_result_enqueued-edit.JPG

 

 

 

When the call returns a "Success" status, the content will also be returned in a string format, just like the already existing synchronous calls.

4.background_report_result_success-edit.JPG

 

 

Volgen

Opmerkingen

Mogelijk gemaakt door Zendesk