The Universal Payment Report has been built to produce transactional payment data in a format that can be easily read by accounting software. The report pulls payment information from your Agreements, including IFRS Component and Non IFRS Component Payments.
You can run the report using using a preset, using the default set up that loads when you open the report, or you can customise it to fit your existing accounting needs. When customising the report, you can use a range of functions, operators, and hard-coded fields. This article will list those functions, operators, and fields, and provide some explanation of what each does.
Please note: Currently, this report is only visible for select customers. If your company has not requested to use the report, you will not see it available in your view of the system. If you believe the report would be useful for your company's accounting practices, please reach out to your Account Manager or our Support Team (support@nomosone.com) to discuss further.
Functions
A unique feature of the Universal Payment Report is the ability to add Excel functions to the Column Builder, to customise the output. Using functions can help produce a report output that more closely matches your external accounting practices.
Below is a list of some functions that you may like to use in the Universal Payment Report. We have collated this list based on what functions customers commonly use, and what we expect you may like to see in your external accounting practices.
| Function | Type | Description |
|---|---|---|
| AND | Logical | Returns TRUE if all of its arguments are TRUE |
| IF | Logical | Specifies a logical test to perform |
| IFS | Logical | Checks whether one or more conditions are met and returns a value that corresponds to the first TRUE condition. |
| OR | Logical | Returns TRUE if any argument is TRUE |
| ABS | Math | Returns the absolute value of a number |
| EVEN | Math | Rounds a number up to the nearest even integer |
| ODD | Math | Rounds a number up to the nearest odd integer |
| PRODUCT | Math | Multiplies its arguments |
| ROUND | Math | Rounds a number to a specified number of digits |
| ROUNDDOWN | Math | Rounds a number down, toward zero |
| ROUNDUP | Math | Rounds a number up, away from zero |
| SUM | Math | Adds its arguments |
| AVERAGEA | Statistical | Returns the averages of its arguments |
| COUNT | Statistical | Counts how many numbers are in the list of arguments |
| ISNUMBER | Information | Returns TRUE if the value is a number |
| DELTA | Engineering | Tests whether two values are equal |
| DATEVALUE | Date and time | Converts a date in the form of text to a serial number |
| DATEDIF | Date and time | Calculates the number of days, months, or years between two dates |
| EOMONTH | Date and time | Returns the serial number of the last day of the month before or after a specified number of months |
| YEARFRAC | Date and time | Returns the year fraction representing the number of whole days between start_date and end_date |
| CONCATENATE | Text | Joins several text items into one text item |
| CONCAT | Text | Combines the text from multiple ranges and/or strings, but it doesn't provide the delimiter or IgnoreEmpty arguments. |
| DOLLAR | Text | Converts a number to text, using the $ (dollar) currency format |
| EXACT | Text | Checks to see if two text values are identical |
| LEFT | Text | Returns the leftmost characters from a text value |
| MID | Text | Returns a specific number of characters from a text string starting at the position you specify |
| REPLACE | Text | Replaces characters within text |
| RIGHT | Text | Returns the rightmost characters from a text value |
| SEARCH | Text | Finds one text value within another (not case-sensitive) |
| TEXT | Text | Formats a number and converts it to text |
| TRIM | Text | Removes spaces from text |
Operators
Alongside the multitude of functions you can use in the column, you can also add operators to get your desired output. You can use operators to specify the calculation to apply to a formula. Check out the tables below to see the operators you can use in the Column Builder.
Arithmetic operators
| Operator Sign | Common Name | Meaning | Example |
|---|---|---|---|
| + | plus sign | addition | 15+20 |
| - | minus sign |
subtraction negation |
150-20 -10 |
| * | asterisk | multiplication | 10*5 |
| / | forward slash | division | 25/5 |
| % | percent sign | percent | 15% |
| ^ | caret/exponent | exponentiation | 5^3 |
Comparison operators
| Operator Sign | Common Name | Meaning | Example |
|---|---|---|---|
| = | equal sign | equal to | A1=B1 |
| > | greater than sign | greater than | B1>C1 |
| < | less than sign | less than | C1<B1 |
| >= | greater than or equal to sign | greater than or equal to | D1>=E1 |
| <= | less than or equal to sign | less than or equal to | E1<=D1 |
| <> | not equal to sign | not equal to | A1<>E1 |
Fields
When entering information into the Value field of a column, typing a forward slash (/) brings up a list of text options. These are what we call “data fields”.
These data fields pull information from other parts of the Nomos One system, in order to produce the report output. For example, the data field “agreement.agreementId” will produce the Agreement ID in any column where the data field has been added.
In the following lists, the Syntax column will display how the data field appears once added to the Value field. The Field column then separates out that data field syntax for readability. The Description column will explain what information the data field will pull through into the report output.
Agreement Fields
| Syntax | Field | Description |
|---|---|---|
| agreement.agreementId | Agreement ID | The system-generated ID for the Agreement |
| agreement.agreementKnownAs | Agreement Known As | The name of the Agreement |
| agreement.agreementType | Agreement Type | The Agreement type selected on the Settings page (lease, sublease, etc.) |
| agreement.client | Client | The role selected on the Settings page (landlord, tenant, etc.) |
| agreement.fileMatterReference | File Matter Reference | The reference entered in the File/Matter Reference field on the Settings page |
| agreement.subMode | Sub Mode | The selection made in the Sub Mode field on the Settings page. For more information about how this field works with the UPR, check out this article. |
| agreement.created | Created | The date that the Agreement was created in Nomos One |
| agreement.fileOwner | File Owner | The Nomos One Organisation that the Agreement is in |
| agreement.firstPaymentDate | First Payment Date | The date entered into the “First Payment Date” field on the Rent & Payment Page |
| agreement.initialRent | Initial Rent | The initial total monthly rent recorded on the Rent & Payment page |
| agreement.expiryDate | Expiry Date | The final expiry date of the Agreement, as recorded on the Events page |
| agreement.commencementDate | Commencement Date | The date entered in the Commencement Date field on the Events page |
| agreement.paymentMode | Payment Mode | Whether rent is paid in advance or in arrears |
| agreement.currencyCode | Currency Code | The code of the currency selected on the Rent & Payment Page |
| agreement.currencySymbol | Currency Symbol | The symbol of the currency selected on the Rent & Payment Page |
| agreement.annualTotalRent | Annual Total Rent | The current total of the annual rent, calculated by adding the Premises and Carpark rent |
| agreement.annualPremisesRent | Annual Premises Rent | The current annual rent for the Premises |
| agreement.annualCarparksRent | Annual Carparks Rent | The current annual rent for the Carparks, if any |
| agreement.monthlyTotalRent | Monthly Total Rent | The current total of the monthly rent, calculated by adding the Premises and Carpark rent |
| agreement.monthlyPremisesRent | Monthly Premises Rent | The current monthly rent for the Premises |
| agreement.monthlyCarparksRent | Monthly Carparks Rent | The current monthly rent for the Carparks, if any |
| agreement.weeklyTotalRent | Weekly Total Rent | The current total of the weekly rent, calculated by adding the Premises and Carpark rent |
| agreement.weeklyPremisesRent | Weekly Premises Rent | The current weekly rent for the Premises |
| agreement.weeklyCarparksRent | Weekly Carparks Rent | The current weekly rent for the Carparks, if any |
| agreement.proportionOfOutgoings | Proportion of Outgoings | The information entered in the Proportion of Outgoings field on the Rent & Payment page |
| agreement.defaultInterestRate | Default Interest Rate | The information entered in the Default Interest Rate field on the Rent & Payment page |
| agreement.glTemplateId | GL Template ID | The system-generated ID for the GL Template that is assigned to the Agreement |
The data fields agreement.currency, agreement.assetClass, agreement.knownAs, agreement.hoursUnrestrictedAccess, agreement.normalAirConditioningDays, agreement.normalAirConditioningHours, agreement,publicRiskInsuranceSum, agreement.bankGuaranteeSum, and agreement.leaseMadeDate appear in the data field drop down, but do not work.
Payment Fields
| Syntax | Field | Description |
|---|---|---|
| payment.paymentDate | Payment Date | The date the payment is scheduled for |
| payment.amount | Amount | The amount of money, either as recorded or as calculated based on total amount and payment frequency |
| payment.description | Description | If an IFRS or Non IFRS Component Payment, the information recorded in the Description field |
| payment.paymentType | Payment Type | The type of payment it is, whether it is a regular rent payment, or one of the numerous IFRS or Non IFRS Component payments |
| payment.detail | Detail | Identifies regular rent payments and wash up / pro rata payments |
The data fields payment.glCode and payment.split appear in the data field drop down, but do not work.
Entity Fields
| Syntax | Field | Description |
|---|---|---|
| entity.completeName | Complete Name | The complete name, including title and middle names, of the entity |
| entity.entityType | Entity Type | The selected entity type |
| entity.role | Entity Role | The entity's role in the relevant Agreement |
| entity.title | Title | If the type is “individual”, the recorded title |
| entity.firstName | First Name | If the type is “individual”, the recorded first name |
| entity.middleNames | Middle Name/s | If the type is “individual”, the recorded middle name |
| entity.lastName | Last Name | If the type is “individual”, the recorded surname |
| entity.companyNumber | Entity Company Number | If “company”, “trust”, or "other, the recorded company number |
| entity.website | Entity Website | If “company”, “trust”, or "other, the recorded website URL |
| entity.entityContact | Contact Person | The contact person recorded in the “contact” section |
| entity.emailAddress | Email Address | The email address recorded in the “contact” section |
| entity.addressLine1 | Entity Address | The street address recorded in the “contact” section |
| entity.poBox | Entity P.O. Box | The P.O. box recorded in the “contact” section |
| entity.city | Entity City | The city recorded in the “contact” section |
| entity.postcode | Entity Postcode | The postcode recorded in the “contact” section |
| entity.state | Entity State | The state recorded in the “contact” section |
| entity.country | Entity Country | The country recorded in the “contact” section |
| entity.phone | Phone | The phone number recorded in the “contact” section |
| entity.mobile | Mobile | The mobile phone number recorded in the “contact” section |
| entity.fax | Fax | The fax number recorded in the “contact” section |
The data fields entity.firmInternalRef and entity.subtype appear in the data field drop down, but do not work.
Entity Mappings
To use the above fields in conjunction with keys created in the Mapping section, simply remove the word “entity” from the start of the syntax, and replace it with the key (including both “key.” and the second half of the key). For example, to use a Mapping key to produce a column that just displays the complete name of the landlord for each Agreement, we would take the data field “entity.completeName”, and replace “entity” with key.landlord". For more information about using Mappings, check out this article.
Property Fields
| Syntax | Field | Description |
|---|---|---|
| property.propertyKnownAs | Property Known As | The name of the property |
| property.propertyType | Property Type | The selected property type |
| property.propertySubType | Property Sub Type | The selected property sub-type, if one has been selected |
| property.fullAddress | Property Address | The full address of the property |
| property.propertyShortName | Property Short Name | The name of all of the properties in the hierarchy, and the recorded Internal Reference formatted in parentheses |
| property.propertyInternalReference | Property Internal Reference | The information recorded in the Internal Reference field |
| property.propertyTopLevel | Property Top Level | If this property is at the top of a property hierarchy, this field will display “Top Level”. If not, this field will display “Child” |
| property.propertyNumber | Property Number | The street number of the property |
| property.propertyName | Property Name | If you edit the address of the property, you can give it a specific name (e.g. Nomos Hall) in this field |
| property.city | Property City | The city of the property |
| property.state | Property State | The state of the property |
| property.country | Property Country | The country of the property |
| property.postCode | Property Postcode | The postcode of the property |
| property.longitude | Longitude | The longitude of the property |
| property.latitude | Latitude | The latitude of the property |
| property.propertyDescription | Description | The information recorded in the Full Description field |
| property.propertyComputerRegisterIdentitifer | Computer Register Identifier | The information recorded in the Computer Register Identifier field |
| property.propertyLegalDescription | Legal Description | The information recorded in the Legal Description field |
| property.rentableArea | Rentable Area | The area of the space being leased |
| property.buildingArea | Building Area | If the property type is Building, the recorded area of the whole building (opposed to just the space being leased) |
The data fields property.addressLine1, property.addressLine2, and property.addressLine3 appear in the data field drop down, but do not work.
Custom Fields
If your Organisation has Custom Data Fields set up, these fields can be used in the Universal Payment Report. The data field name for use in the report will depend on how the custom field is named in your Organisation, and what kind of custom field it is.
For Agreement custom fields, these appear using the format of agreement.custom.ExampleField. Note the inclusion of custom. before the name of the custom data field. The actual name of the custom field will appear in the report with all words combined, with the first letter of each word capitalised. For example, an Agreement custom field called “New Zealand Region” will appear as a data field in the report as agreement.custom.NewZealandRegion. An Agreement custom field called “Bank” will appear as a data field in the report as agreement.custom.Bank.
For Entity and Property custom fields, these appear using the format entity.ExampleField and property.ExampleField respectively. The actual name of the custom field will appear in the report with all words combined, with the first letter of each word capitalised. For example, an Entity custom field called “Account Manager” will appear as a data field in the report as entity.AccountManager. A Property custom field called “Registration” will appear as a data field in the report as property.Registration.
Nomos One does not provide or purport to provide any accounting, financial, tax, legal or any professional advice, nor does Nomos One purport to offer a financial product or service. Nomos One is not responsible or liable for any claim, loss, damage, costs or expenses resulting from your use of or reliance on these resource materials. It is your responsibility to obtain accounting, financial, legal and taxation advice to ensure your use of the Nomos One system meets your individual requirements.