Visma.net Financials API Data Model

billable

boolean

☐

Filter invoiceable project tasks.

branch

string

☐

Filter on branch for the project transation.

COMPANY_CODE

string

☐

Partition to retrieve data from.

createdDateTime

string

☐

Creation date and time.

createdDateTimeCondition

string

☐

System-retrieved information for state/condition

date

datetime

☐

Filter on the registration date for the project transaction.

expandNote

boolean

☐

Expands project transaction notes

fromPeriod

string

☐

Mandatory. Start date for the task.

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.

module

string

☐

Select to filter on module; e.g. AR, AP, IN etc. (Values: ModuleGL, ModuleAP, ModuleAR, ModuleCA, ModuleCM, ModuleIN, ModuleSO, ModulePO, ModuleDR, ModuleFA, ModuleEP, ModulePM, ModuleTX, ModuleCR)

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.

project

string

☐

Filter on project ID.

projectTask

string

☐

Filter on Task ID.

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.

status

string

☐

The status of the document. (Values: Hold, Balanced, Released)

toPeriod

string

☐

Mandatory. End date for the task.

accountGroup_name

string

General Ledger Account Group Name

☐

Click the magnifier. > The name.

accountGroup_number

string

General Ledger Account Group Number

☐

Click the magnifier. > The identifier.

allocated

boolean

Allocated

☐

Allocated > A check box that indicates whether the amounts of the transactions were allocated for the project.

amount

double

Amount

☐

Amount > The amount of the transaction.

batchNbr

string

Batch Number

☐

Batch no. > The batch number of the transaction in the General ledger workspace.

billable

boolean

Billable

☐

Invoiceable > A check box indicating whether the transaction is used in calculating the amount charged to the customer for the project task.

billableQuantity

double

Billable Quantity

☐

Qty. that can be invoiced > The total invoiceable quantity for the transactions listed in the table.

branch_name

string

Branch Name

☐

Click the magnifier. > The name.

branch_number

string

Branch Number

☐

Click 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.

creditAccount_description

string

☐

Name of item/description

creditAccount_externalCode1

string

☐

Account class > The identifier of the account class.

creditAccount_externalCode2

string

☐

Account class > The name of the account class.

creditAccount_number

string

☐

Number of item

creditAccount_type

string

☐

Account > The account number.

creditAccountGroup_name

string

☐

Click the magnifier. > The name.

creditAccountGroup_number

string

☐

Click the magnifier. > The identifier.

creditSubaccount_description

string

☐

Click on the magnifier. > The description.

creditSubaccount_id

string

☐

Click on the magnifier. > The identifier.

customerVendor_internalId

int32

☐

customerVendor_name

string

☐

The name of the particular destination of the selected type.

customerVendor_number

string

☐

The identifier of the particular destination of the selected type.

date

datetime

Date

☐

Date > The date the transaction was created.

debitAccount_description

string

☐

Name of item/description

debitAccount_externalCode1

string

☐

Account class > The identifier of the account class.

debitAccount_externalCode2

string

☐

Account class > The name of the account class.

debitAccount_number

string

☐

Number of item

debitAccount_type

string

☐

Account > The account number.

debitAccountGroup_name

string

☐

Click the magnifier. > The name.

debitAccountGroup_number

string

☐

Click the magnifier. > The identifier.

debitSubaccount_description

string

☐

Click on the magnifier. > The description.

debitSubaccount_id

string

☐

Click on the magnifier. > The identifier.

description_1

string

☐

The top part > Description > The description provided for the transaction.

description

string

Description

☐

Description > The description of the transaction.

earningType_code

string

☐

Mandatory field: Code* > The unique ID of the type of hour.

earningType_description

string

☐

Mandatory field: Description > The brief description of the type of hour.

earningType_isActive

boolean

☐

Active > A check box that indicates (if selected) that the type of hour is active and can be used.

earningType_isBillable

boolean

☐

Invoicable > A check box that indicates (if selected) that the type is treated as invoiceable by default.

earningType_isOvertime

boolean

☐

Overtime > A check box that indicates (if selected) that the type of hour is treated as overtime.

earningType_lastModifiedDateTime

datetime

☐

System generated information.

earningType_overtimeMultiplier

double

☐

Multiplier > The value by which the employee cost for this type of hour is multiplied when the time activity is released.

employee_address_addressId

int32

☐

employee_address_addressLine1

string

☐

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

employee_address_addressLine2

string

☐

Address 2 > The second line of the address.

employee_address_addressLine3

string

☐

Address 3 > The third line of the address.

employee_address_city

string

☐

City > The city.

employee_address_country_errorInfo

string

☐

employee_address_country_id

string

☐

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

employee_address_country_metadata_maxPageSize

int64

☐

employee_address_country_metadata_totalCount

int64

☐

employee_address_country_name

string

☐

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

employee_address_county_id

string

☐

Click the magnifier > The identifier

employee_address_county_name

string

☐

Click the magnifier > The displayed name

employee_address_postalCode

string

☐

Postcode > The postcode.

employee_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.

employee_contact_contactId

int32

☐

employee_contact_email

string

☐

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

employee_contact_employeeContact

string

☐

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

employee_contact_fax

string

☐

Fax > The fax number.

employee_contact_firstName

string

☐

First name > The first name of the employee.

employee_contact_lastName

string

☐

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

employee_contact_midName

string

☐

Middle name > The middle name of the employee.

employee_contact_name

string

☐

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

employee_contact_phone1

string

☐

Phone 1 > The default phone number.

employee_contact_phone2

string

☐

Phone 2 > An additional phone number.

employee_contact_phone3

string

☐

Phone 3 > An additional phone number of the employee.

employee_contact_title

string

☐

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

employee_contact_web

string

☐

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

employee_department

string

☐

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

employee_employeeId

int32

☐

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.

employee_employeeName

string

☐

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

employee_employeeNumber

string

☐

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

employee_employeeUserId

string

☐

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

employee_errorInfo

string

☐

employee_lastModifiedDateTime

datetime

☐

employee_metadata_maxPageSize

int64

☐

employee_metadata_totalCount

int64

☐

employee_status

string

☐

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

endDate

datetime

End Date

☐

End date > The end date for this transaction

errorInfo_1

string

☐

errorInfo

string

Error Message

☐

financialPeriod

string

Financial Period

☐

Period > The financial period associated with the transaction.

inventoryId_description

string

☐

Name of item/description

inventoryId_number

string

☐

Number of item

lastModifiedDateTime

datetime

Last Modified

☐

System generated information

location_countryId

string

Location Country ID

☐

Location*.

location_id

string

Location ID

☐

Click the magnifier > The identifier

location_name

string

Location Name

☐

Click the magnifier > The displayed name

metadata_maxPageSize_1

int64

☐

metadata_maxPageSize

int64

☐

metadata_totalCount_1

int64

☐

metadata_totalCount

int64

Total Count

☐

module

string

Module

☐

The top part > Module > The module you create the transactions in.

note_1

string

☐

note

string

Note

☐

origDocNbr

string

Original Document Number

☐

The top part > Orig. doc. no. > The reference number of the underlying document for the transaction.

origDocType

string

Original Document Type

☐

The top part > Orig. doc. no. > The type of the document the transaction is based on. It has one of the following values: Allocation, Time card, Case, Expense claim, Allocation reversal, Reversal, Credit note.

overtimeMultiplier

double

Overtime Multiplier

☐

Multiplier > The multiplier by which the unit rate is multiplied when the labour cost is calculated.

project_description

string

Project Description

☐

Click on the magnifier. > The description.

project_id

string

Project ID

☐

Click on the magnifier. > The identifier.

projectTask_description

string

Project Task Description

☐

Click on the magnifier. > The description.

projectTask_id

string

Project Task ID

☐

Click on the magnifier. > The identifier.

quantity

double

Quantity

☐

Quantity > The quantity for the transaction, such as the number of service hours provided to the customer.

refNbr

string

Reference Number

☐

The top part > Ref. no. > The reference number of the transaction.

released

boolean

Released

☐

Released > A check box indicating whether the transaction has been released.

startDate

datetime

Start Date

☐

Start date > The start date for this transaction.

status

string

Status

☐

The top part > Status > The status of the transaction. The following statuses are possible: Balanced, Released.

tranId

int64

☐

unitRate

double

☐

Unit rate > The price of the item or the rate of the service.

uom

string

Unit of Measure

☐

UoM > The unit of measure used to estimate the quantity for the transaction, such as HOUR or BOX.

useBillableQty

boolean

☐

Use the quantity that can be invoiced in the amount formula > A check box that you select if you want the system to use the invoiceable quantity (the Invoiceable quantity column) instead of the overall quantity (the Quantity column) of the transaction when calculating the amount of transaction.