Visma.net Financials API Data Model

attributes

string

☐

Identifies the attributes

COMPANY_CODE

string

☐

Partition to retrieve data from.

createdDateTime

string

☐

Creation date and time.

createdDateTimeCondition

string

☐

System-retrieved information for state/condition

expandAttribute

boolean

☐

Expands project atributes

greaterThanValue

string

☐

Greater than value. The item which is the object for this, varies from API to API.

lastModifiedDateTime

string

☐

System generated value for last modification of transaction/record. Use format: YYYY-MM-DD HH:MM (date and time) to filter from date to present.

lastModifiedDateTimeCondition

string

☐

System retrieved information for state/condition.

nonProject

boolean

☐

Set to true to return the non-project.

numberToRead

int32

☐

This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.

pageNumber

int32

☐

Pagination parameter. Page number.

pageSize

int32

☐

Pagination parameter. Number of items to be collected.

publicId

string

☐

Identifies the Project by its publicId

restrictedEmployee

string

☐

ID of the employee where access restrictions apply

restrictedUser

int64

☐

Id of the odp user where access restrictions apply

skipRecords

int32

☐

This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.

startDate

datetime

☐

Project’s start date

status

string

☐

Use drop down and select Status. (Values: Planned, Active, Completed, Cancelled, OnHold, PendingApproval)

systemTemplate

boolean

☐

If the project is a template

taskStatus

string

☐

Use drop down and select Status. (Values: Planned, Active, Cancelled, Completed)

taskVisibleInAp

boolean

☐

If the project task is visible in the Supplier ledger

taskVisibleInAr

boolean

☐

If the project task is visible in the Customer ledger

taskVisibleInCa

boolean

☐

If the project task is visible in the Cash management workspace

taskVisibleInCr

boolean

☐

If the project task is visible in the CRM workspace

taskVisibleInEa

boolean

☐

If the project task is visible in the Expense workspace

taskVisibleInGl

boolean

☐

If the project task is visible in the General ledger workspace

taskVisibleInIn

boolean

☐

If the project task is visible in the Inventory workspace

taskVisibleInPo

boolean

☐

If the project task is visible in the Purchases workspace

taskVisibleInSo

boolean

☐

If the project task is visible in the Sales workspace

taskVisibleInTa

boolean

☐

If the project task is visible in the Time entities workspace

visibleInAP

boolean

☐

If the project is visible in AP

address_addressId

int32

Address ID

☐

address_addressLine1

string

Address Line 1

☐

Address 1 > The first line of the customer's/supplier's/company's/employee's contact address.

address_addressLine2

string

Address Line 2

☐

Address 2 > The second line of the address.

address_addressLine3

string

Address Line 3

☐

Address 3 > The third line of the address.

address_city

string

City

☐

City > The city.

address_country_errorInfo

string

☐

address_country_id

string

Country ID

☐

Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166.

address_country_metadata_maxPageSize

int64

☐

address_country_metadata_totalCount

int64

☐

address_country_name

string

Country Name

☐

Mandatory field: Country name* > The complete name of the country.

address_county_id

string

County ID

☐

Click the magnifier > The identifier

address_county_name

string

County Name

☐

Click the magnifier > The displayed name

address_postalCode

string

Postal Code

☐

Postcode > The postcode.

allocationRule_active

boolean

☐

allocationRule_description

string

☐

Click on the magnifier. > The description.

allocationRule_id

string

☐

Click on the magnifier. > The identifier.

assets

double

Assets

☐

The top part > Assest > The actual assets for the project.

autoAllocate

boolean

☐

Summary tab > Invoicing and allocation settings section > Run allocation when you release project transactions > A check box that indicates (if selected) that allocation is run automatically during the release of the documents associated with this project.

automaticReleaseAr

boolean

☐

Summary tab > Invoicing and allocation settings section > Automatically release customer documents > A check box that indicates (if selected) that invoice documents are released automatically after the project invoicing is completed.

billingPeriod

string

Billing Period

☐

Summary tab > Invoicing and allocation settings section > Invoicing period > The frequency of invoicing, which can be one of the following options: Week, Month, Quarter, Year, On demand.

billingRule_active

boolean

☐

billingRule_description

string

☐

Click on the magnifier. > The description.

billingRule_id

string

☐

Click on the magnifier. > The identifier.

COMPANY_CODE

string(30)

Company Code

☑

Partition code, segmenting the data.

COMPANY_NAME

string(240)

Company Name

☑

Name of the partition.

contact_attention

string

☐

Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person.

contact_contactId

int32

Contact ID

☐

contact_email

string

Contact Email

☐

Email > The email address of the customer/supplier/company as a business entity.

contact_employeeContact

string

☐

Employee contact > The link to the contact record associated with the employee.

contact_fax

string

Contact Fax

☐

Fax > The fax number.

contact_firstName

string

Contact First Name

☐

First name > The first name of the employee.

contact_lastName

string

Contact Last Name

☐

Mandatory field: Last name* > The last name of the employee.

contact_midName

string

Contact Middle Name

☐

Middle name > The middle name of the employee.

contact_name

string

Contact Name

☐

Name > The legal name of to appear on the documents.

contact_phone1

string

Contact Phone 1

☐

Phone 1 > The default phone number.

contact_phone2

string

Contact Phone 2

☐

Phone 2 > An additional phone number.

contact_phone3

string

Contact Phone 3

☐

Phone 3 > An additional phone number of the employee.

contact_title

string

Contact Title

☐

Title > The courtesy title to be used for the employee.

contact_web

string

Contact Website

☐

Web > The website of the company, if one exists.

customer_name

string

Customer Name

☐

Click the magnifier. > The name.

customer_number

string

Customer Number

☐

customerLocation_id

int32

☐

Click the magnifier > The identifier

customerLocation_name

string

☐

Click the magnifier > The displayed name

defAccount_description

string

☐

Name of item/description

defAccount_number

string

☐

Number of item

defAccount_type

string

☐

defAccrualAccount_description

string

☐

Name of item/description

defAccrualAccount_number

string

☐

Number of item

defAccrualAccount_type

string

☐

defAccrualSub_description

string

☐

Click on the magnifier. > The description.

defAccrualSub_id

string

☐

Click on the magnifier. > The identifier.

defSub_description

string

☐

Click on the magnifier. > The description.

defSub_id

string

☐

Click on the magnifier. > The identifier.

department

string

Department

☐

Mandatory field: General information tab > Employee section > Department* > The department the employee works for.

description_1

string

☐

Mandatory field: The top part > Description* > The description of the project.

description

string

Description

☐

Mandatory field: Description > The description of the task.

employeeId

int32

Employee ID

☐

Mandatory field: The top part > Employee ID* > The unique identifier, which is assigned to the employee in accordance with the configuration of the EMPLOYEE segmented key.

employeeName

string

Employee Name

☐

The top part > Employee name > The name of this employee.

employeeNumber

string

Employee Number

☐

General information tab > Employee settings section > Employee ref. no. > A reference number for the employee.

employeeUserId

string

☐

Employee internal user ID. This is the ID of the user linked to the employee

endDate

datetime

End Date

☐

Summary tab > Project properties section > End date > The date when the project is expected to end.

errorInfo_1

string

☐

errorInfo

string

Error Message

☐

expenses

double

Expenses

☐

The top part > Expenses > The total of the current expenses incurred by the project.

hold

boolean

Hold

☐

The top part > Hold > A check box that you select to indicate that the project should have the In planning status.

income

double

Income

☐

The top part > Income > The income expected from the project.

internalID

int32

Internal ID

☐

lastBillingDate

datetime

Last Billing Date

☐

Summary tab > Invoicing and allocation settings section > Last invoicing date > The date when the latest invoicing was performed for the project.

lastModifiedDateTime_1

datetime

☐

System generated information

lastModifiedDateTime

datetime

Last Modified

☐

liability

double

Liability

☐

The top part > Liabilities > The actual liabilities for the project.

metadata_maxPageSize_1

int64

☐

metadata_maxPageSize

int64

☐

metadata_totalCount_1

int64

☐

metadata_totalCount

int64

Total Count

☐

nextBillingDate

datetime

Next Billing Date

☐

Summary tab > Invoicing and allocation settings section > Next invoicing date > The date for which the next invoicing is scheduled for the project.

plannedEnd

datetime

☐

plannedStart

datetime

☐

projectID

string

Project ID

☐

Mandatory field: The top part > Project ID* > The unique ID for the project.

projectManager_address_addressId

int32

☐

projectManager_address_addressLine1

string

☐

Address 1 > The first line of the customer's/supplier's/company's/employee's contact address.

projectManager_address_addressLine2

string

☐

Address 2 > The second line of the address.

projectManager_address_addressLine3

string

☐

Address 3 > The third line of the address.

projectManager_address_city

string

☐

City > The city.

projectManager_address_country_errorInfo

string

☐

projectManager_address_country_id

string

☐

Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166.

projectManager_address_country_metadata_maxPageSize

int64

☐

projectManager_address_country_metadata_totalCount

int64

☐

projectManager_address_country_name

string

☐

Mandatory field: Country name* > The complete name of the country.

projectManager_address_county_id

string

☐

Click the magnifier > The identifier

projectManager_address_county_name

string

☐

Click the magnifier > The displayed name

projectManager_address_postalCode

string

☐

Postcode > The postcode.

projectManager_contact_attention

string

☐

Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person.

projectManager_contact_contactId

int32

☐

projectManager_contact_email

string

☐

Email > The email address of the customer/supplier/company as a business entity.

projectManager_contact_employeeContact

string

☐

Employee contact > The link to the contact record associated with the employee.

projectManager_contact_fax

string

☐

Fax > The fax number.

projectManager_contact_firstName

string

☐

First name > The first name of the employee.

projectManager_contact_lastName

string

☐

Mandatory field: Last name* > The last name of the employee.

projectManager_contact_midName

string

☐

Middle name > The middle name of the employee.

projectManager_contact_name

string

☐

Name > The legal name of to appear on the documents.

projectManager_contact_phone1

string

☐

Phone 1 > The default phone number.

projectManager_contact_phone2

string

☐

Phone 2 > An additional phone number.

projectManager_contact_phone3

string

☐

Phone 3 > An additional phone number of the employee.

projectManager_contact_title

string

☐

Title > The courtesy title to be used for the employee.

projectManager_contact_web

string

☐

Web > The website of the company, if one exists.

projectManager_department

string

Project Manager Department

☐

Mandatory field: General information tab > Employee section > Department* > The department the employee works for.

projectManager_employeeId

int32

Project Manager Employee ID

☐

Mandatory field: The top part > Employee ID* > The unique identifier, which is assigned to the employee in accordance with the configuration of the EMPLOYEE segmented key.

projectManager_employeeName

string

Project Manager Employee Name

☐

The top part > Employee name > The name of this employee.

projectManager_employeeNumber

string

Project Manager Employee Number

☐

General information tab > Employee settings section > Employee ref. no. > A reference number for the employee.

projectManager_employeeUserId

string

☐

Employee internal user ID. This is the ID of the user linked to the employee

projectManager_errorInfo

string

☐

projectManager_lastModifiedDateTime

datetime

☐

projectManager_metadata_maxPageSize

int64

☐

projectManager_metadata_totalCount

int64

☐

projectManager_status

string

Project Manager Status

☐

Mandatory field: The top part > Status > The status of the employee. The following options are available: Active, On hold, Hold payments, Inactive, One-time.

publicId

string

Public ID

☐

rateTable_description_1

string

☐

Click on the magnifier. > The description.

rateTable_description

string

☐

Click on the magnifier. > The description.

rateTable_id_1

string

☐

Click on the magnifier. > The identifier.

rateTable_id

string

☐

Click on the magnifier. > The identifier.

restrictEmployees_1

boolean

☐

Summary tab > Project properties section > Restrict employees > A check box that indicates (if selected) that only the employees listed on the Employees tab of this window can create activities and documents associated with the current project.

restrictEmployees

boolean

Restrict Employees

☐

Summary tab > Task properties section > Restrict employees > A check box that indicates (if selected) that only the employees listed on the Employees tab of this window can create activities and documents associated with the current task.

restrictEquipment

boolean

Restrict Equipment

☐

startDate_1

datetime

☐

Mandatory field: Summary tab > Project properties section > Start date* > The date when the project starts.

startDate

datetime

Start Date

☐

Start date > The date when the task was actually started.

status_1

string

☐

Mandatory field: Status* > The status of the task, which can be one of the following: In planning, Active, Cancelled, Completed.

status_2

string

☐

The top part > Status > The status of the project, which can be one of the following options: In planning, Active, Completed, Suspended, Cancelled.

status

string

Status

☐

Mandatory field: The top part > Status > The status of the employee. The following options are available: Active, On hold, Hold payments, Inactive, One-time.

systemTemplate

boolean

☐

taskId

string

Task ID

☐

Mandatory field: > Task ID* > The ID of the task.

template_description

string

☐

Name of item/description

template_number

string

Template Number

☐

Number of item

template_status

string

Template Status

☐

visibility_visibleInAp_1

boolean

☐

Supplier ledger

visibility_visibleInAp

boolean

☐

Supplier ledger

visibility_visibleInAr_1

boolean

☐

Customer ledger

visibility_visibleInAr

boolean

☐

Customer ledger

visibility_visibleInCa_1

boolean

☐

Cash management

visibility_visibleInCa

boolean

☐

Cash management

visibility_visibleInCr_1

boolean

☐

visibility_visibleInCr

boolean

☐

visibility_visibleInEa_1

boolean

☐

Expenses

visibility_visibleInEa

boolean

☐

Expenses

visibility_visibleInGl_1

boolean

☐

General ledger

visibility_visibleInGl

boolean

☐

General ledger

visibility_visibleInIn_1

boolean

☐

Inventory

visibility_visibleInIn

boolean

☐

Inventory

visibility_visibleInPo_1

boolean

☐

Purchases

visibility_visibleInPo

boolean

☐

Purchases

visibility_visibleInSo_1

boolean

☐

Sales

visibility_visibleInSo

boolean

☐

Sales

visibility_visibleInTa_1

boolean

☐

Time entries

visibility_visibleInTa

boolean

☐

Time entries