Nmbrs® API XML references

The following page is a collection of different XML notations in the Nmbrs® API calls. These can be helpful to undestand the XML output of an API call. For each XML notation, on ore more methods are listed.

Cumulative Journals

This XML is the return of method(s):

  • Reports_GetJournalsReportByCompany

XML Structure

<Report>
 <CompanyId>int</CompanyId>
 <StartPeriod>int</StartPeriod>
 <EndPeriod>int</EndPeriod>
  <Items>
   <Item>
    <EmployeeName>string</EmployeeName>
    <Period>int</Period>
    <Year>int</Year>
    <Run>int</Run>
    <Department>string</Department>
    <CostCenter>string</CostCenter>
    <CostUnit>string</CostUnit>
    <Percentage>decimal</Percentage>
    <GeneralLedgerAccount>sring</GeneralLedgerAccount>
    <ComponentName>string</ComponentName>
    <Debit>decimal</Debit>
    <Credit>decimal</Credit>
   </Item>
  </Items>
</Report>
debitcredit node values
debit
credit
Data type Example
Decimal 2000.00
String This is some text
Integer 1234

Journals 

This XML is the return of method(s):

XML Structure

<transactions>
  <transaction>
    <header>
      <date>DateTime</date>
      <period>1/2011</period>
    </header>
    <lines>
      <line id="0">
        <dim1>Integer</dim1>
        <dim2>Integer</dim2>
        <dim3>Integer</dim3>
        <value>Decimal</value>
        <debitcredit></debitcredit>
        <description>String</description>
      </line>
    </lines>   
  </transaction>
</transactions>

 

debitcredit node values
debit
credit
dim Example
dim1 General ledger rule nr.
dim2 cost center nr. / department nr. / employee nr
dim3 cost unit nr. (when cost unit is used)
Data type Example
Decimal 2000.00
String This is some text
Integer 1234

Payslip PDF

This XML is the return of method(s):

SalaryDocuments_GetAllPayslipsPDFByRunCompany 

Get all payslip PDF's of a company for a specific run period, takes year from active year of the company.

SalaryDocuments_GetAllPayslipsPDFByRunCompany_v2

Get all payslip PDF's of a company for a specific run period.

Allow to supply the year to be used.

SalaryDocuments_GetEmployeePayslipsPDFByRunCompany 

Get employee payslips in PDF by run company for a specific run period, takes year from active year of the company.

SalaryDocuments_GetEmployeePayslipsPDFByRunCompany_v2

Get all payslip PDF's of a company for a specific run period.

Allow to supply the year to be used.

 

Payslip XML

This XML is the return of method(s):

XML Structure

<payslips>
  <payslip>
    <employeeid>Integer</employeeid>
    <period>Integer</period>
    <year>Integer</year>
    <header>
      <headerItem>
        <key>String</key>
        <value>String</value>
      </headerItem>
    </header>
    <lines>
      <line>
        <code>Integer</code>
        <description>String</description>
        <group>String</group>
        <amount>Decimal</amount>
        <value>Decimal</value>
        <betaling>Decimal</betaling>
        <tabel>Decimal</tabel>
        <bt>Decimal</bt>
        <svw>Decimal</svw>
        <svwbt>Decimal</svwbt>
        <werkgever>Decimal</werkgever>
        <cumulative>Decimal</cumulative>
      </line>
    </lines>
    <reservations>
      <reservation>
        <key>String</key>
        <value>Decimal</value>
        <saldo>Decimal</saldo>
      </reservation>
    </reservations>
    <footer>
      <footerItem>
        <key>String</key>
        <value>Decimal</value>
      </footerItem>
    </footer>
  </payslip>
</payslips>

 

Group values (Node Line)
Branche
Bruto
Loonheffingen
Netto
None
Other
Payment
PaymentOther
Totalen
WerknemerVerzekering
ZVW
Key values (Node FooterItem)
Arbeidskorting Cum.
Arbeidskorting d.p.
Dagen Gewerkt
Dagen Tijdvak
Fiscaalloon
Fiscaalloon BT
Fiscaalloon Tabel
Franchise Cum.
Franchise d.p.
SVW Loon
Uren Gewerkt
WAO Loon
WW Loon

Zvw Loon
Data type Example
Decimal 2000.00
String This is some text
Integer 1234

Reports

This XML is the return of the methods: 

Note 1: This article is subject to change. 
Note 2: The output of the XML's is totally dependent from the input settings.

Reports_Accountant_EmployeeAbsence

<EmployeeNumber>integer</EmployeeNumber>
<EmployeeName>string</EmployeeName>
<January>decimal</January>
<February>decimal</February>
<March>decimal</March>
<April>decimal</April>
<May>decimal</May>
<June>decimal</June>
<July>decimal</July>
<August>decimal</August>
<September>decimal</September>
<October>decimal</October>
<November>decimal</November>
<December>decimal</December>
<Yeartodate>decimal</Yeartodate>
<CompanyNumber>integer</CompanyNumber>
<CompanyName>string</CompanyName>
<DebtorNumber>integer</DebtorNumber>
<DebtorName>string</DebtorName>

Reports_Accountant_EmployeeContracts

 <EmployeeNumber>integer</EmployeeNumber>
 <EmployeeName>string</EmployeeName>
 <ServiceStartDate>date</ServiceStartDate>
 <ServiceEndDate>date</ServiceEndDate>
 <TotalPeriod>integer</TotalPeriod>
 <ContractStartDate>date</ContractStartDate>
 <ContractEndDate>date</ContractEndDate>
 <CompanyNumber>integer</CompanyNumber>
 <CompanyName>string</CompanyName>
 <DebtorNumber>integer</DebtorNumber>
 <DebtorName>string</DebtorName>

Reports_Accountant_EmployeeHoursSalary

<EmployeeNumber>integer</EmployeeNumber>
<EmployeeName>string</EmployeeName>
<ParttimePercentage>decimal</ParttimePercentage>
<FTE>decimal</FTE>
<TotalHoursWeek>decimal</TotalHoursWeek>
<TotalHoursPeriod>decimal</TotalHoursPeriod>
<SalaryType>string</SalaryType>
<SalaryValue>decimal</SalaryValue>
<SalaryTable>string</SalaryTable>
<SalaryScale>string</SalaryScale>
<SalaryStep>string</SalaryStep>
<CompanyNumber>string</CompanyNumber>
<CompanyName>string</CompanyName>
<DebtorNumber>integer</DebtorNumber>
<DebtorName>string</DebtorName>

Reports_Accountant_EmployeeNameAddress

<EmployeeNumber>integer</EmployeeNumber>
<EmployeeName>string</EmployeeName>
<Title>string</Title>
<Initials>string</Initials>
<FistName>string</FistName>
<NickName>string</NickName>
<BSN>integer</BSN>
<Address>string</Address>
<PostCode>string</PostCode>
<City>string</City>
<Country>string</Country>
<BirthDate>date</BirthDate>
<PlaceOfBirth>string</PlaceOfBirth>
<CountryOfBirth>string</CountryOfBirth>
<State>string</State>
<TelephoneWork>integer</TelephoneWork>
<TelephoneMobileWork>integer</TelephoneMobileWork>
<TelephonePrivate>integer</TelephonePrivate>
<TelephoneMobilePrivate>integer</TelephoneMobilePrivate>
<TelephoneOther>integer</TelephoneOther>
<EmailWork>string</EmailWork>
<EmailPrivate>string</EmailPrivate>
<Gender>string</Gender>
<Nationality>string</Nationality>
<ContractStartDate>date/ContractStartDate>
<ContractEndDate>date</ContractEndDate>
<CompanyNumber>integer</CompanyNumber>
<CompanyName>string</CompanyName>
<DebtorNumber>integer</DebtorNumber>
<DebtorName>string</DebtorName>

Reports_Accountant_EmployeeSVWSettings

<EmployeeNumber>integer</EmployeeNumber>
<EmployeeName>string</EmployeeName>
<ZW>string</ZW>
<WW>string</WW>
<WAO_WIA>string</WAO_WIA>
<PMA>string</PMA>
<ZVW>string</ZVW>
<CodeIabZVW>string</CodeIabZVW>
<TaxCredit></TaxCredit>
<TaxCreditIncrease>string</TaxCreditIncrease>
<InfluenceInsurance>string</InfluenceInsurance>
<Sector>string</Sector>
<RiskGroup>string</RiskGroup>
<CAOCode>string</CAOCode>
<CompanyNumber>integer</CompanyNumber>
<CompanyName>string</CompanyName>
<DebtorNumber>integer</DebtorNumber>
<DebtorName>string</DebtorName>

Reports_Accountant_EmployeeWageTaxSettings

<EmployeeNumber>integer</EmployeeNumber>
<EmployeeName>string</EmployeeName>
<WageTax>string</WageTax>
<WageTaxLevy>string</WageTaxLevy>
<ColorTable>string</ColorTable>
<TimePeriod>string</TimePeriod>
<SpecialTable>string</SpecialTable>
<IncomeType>string</IncomeType>
<HolidayVouchers>string</HolidayVouchers>
<TaxDeduction>string</TaxDeduction>
<CodeCalculation30PercentageRule>string</CodeCalculation30PercentageRule>
<SpecialRate>decimal</SpecialRate>
<SpecialRatePercentage>decimal</SpecialRatePercentage>
<CompanyNumber>integer</CompanyNumber>
<CompanyName>string</CompanyName>
<DebtorNumber>integer</DebtorNumber>
<DebtorName>string</DebtorName>

Wage code reports

This XML is the return of method(s):

XML Structure

<reports>
  <report>
    <employeeid>Integer</employeeid>
    <period>Integer</period>
    <year>Integer</year>
    <lines>
      <line>
        <code>Integer</code>
        <description>String</description>
        <value>Decimal</value>
      </line>
    </lines>
  </report>
</reports>
Data type Example
Decimal 2000.00
String This is some text
Integer 1234

Wage tax

This XML is the return of method:

The XML structure is the same that you can download in Nmbrs. For detailed specifications of the fields, please visit www.belastingdienst.nl

Wage Tax XML Structure example


 <Bericht>
   <IdBer>111222333L01_22</IdBer>
   <DatTdAanm>2015-03-30T19:18:22</DatTdAanm>
   <ContPers>Contactpersoon</ContPers>
   <TelNr>0611223344</TelNr>
   <RelNr>swo00636</RelNr>
   <GebrSwPakket>NMBRS100001</GebrSwPakket>
 </Bericht>
 <AdministratieveEenheid>
   <LhNr>111222333L01</LhNr>
   <NmIP>Test</NmIP>
   <TijdvakAangifte>
     <DatAanvTv>2015-03-01</DatAanvTv>
     <DatEindTv>2015-03-31</DatEindTv>
     <VolledigeAangifte>
       <CollectieveAangifte>
         <TotLnLbPh>0</TotLnLbPh>
         <TotLnSV>0</TotLnSV>
         <PrLnUFO>0</PrLnUFO>
         <IngLbPh>0</IngLbPh>
         <IngBijdrZvw>0</IngBijdrZvw>
         <TotWghZvw>0</TotWghZvw>
         <TotTeBet>0</TotTeBet>
         <TotGen>0</TotGen>
       </CollectieveAangifte>
     </VolledigeAangifte>
   </TijdvakAangifte>
 </AdministratieveEenheid>

last update:

Comments

Knowledge base

Start with
Nmbrs®

Employee / Company settings

Payroll settings

Workflow

Process Payroll

Reports and
salary documents

General ledger accounts
& and Journals

HR

HR Workflow

User accounts

Debtor management

My Nmbrs® account

Import / Export

Integrations

Technical support

Nmbrs® API