Visma.net Financials API Data Model

attributes

string

☐

COMPANY_CODE

string

☐

Partition to retrieve data from.

corporateId

string

☐

Equals Corporate ID from Delivery settings tab.

createdDateTime

string

☐

createdDateTimeCondition

string

☐

email

string

☐

Equals Email for customer.

expandAccountInformation

boolean

☐

expandDirectDebit

boolean

☐

Expand direct debit info

expandPaymentMethods

boolean

☐

greaterThanValue

string

☐

This field does not work and has been deprecated. It will be removed in future versions.

lastModifiedDateTime

string

☐

System retrieved information for last modified date and time.

lastModifiedDateTimeCondition

string

☐

System retrieved information for date, time and state/condition.

name

string

☐

Equals Customer name.

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.]Tells the service to return only {numberToRead} number of records.

pageNumber

int32

☐

Pagination parameter. Page number.

pageSize

int32

☐

Pagination parameter. Number of items to be collected.

phone

string

☐

Equals Phone 1 for customer.

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.]Tells the service to return only records after the first {skipRecords} number of records.

status

string

☐

Drop down and select Status. (Values: Active, OnHold, CreditHold, Inactive, OneTime)

vatRegistrationId

string

☐

Equals VAT registration ID from Delivery settings tab.

acceptAutoInvoices

boolean

Accept Auto-invoices

☐

Invoicing settings > Print and email settings section > Send invoices to AutoInvoice > Select this check box if you are using AutoInvoice and want to send invoices directly to this service.

accountReference

string

Account Reference

☐

General information tab > Main contact section > Account ref. > Your company's account number in the customer's system.

active

boolean

Active

☐

Active > The status of the identifier.

cashDiscountAccount_description

string

☐

Name of item/description

cashDiscountAccount_number

string

☐

Number of item

cashDiscountAccount_type

string

☐

cashDiscountSubaccount_active

boolean

☐

Active > The status of the identifier.

cashDiscountSubaccount_description

string

☐

Description > The description of the identifier.

cashDiscountSubaccount_errorInfo

string

☐

cashDiscountSubaccount_lastModifiedDateTime

datetime

☐

System generated information.

cashDiscountSubaccount_metadata_maxPageSize

int64

☐

cashDiscountSubaccount_metadata_totalCount

int64

☐

cashDiscountSubaccount_segmentDescription

string

☐

The Segment values window > The Top part > The description of the segment.

cashDiscountSubaccount_segmentId

int32

☐

The Segment values window > The Top part > The ID of the segment.

cashDiscountSubaccount_segmentValue

string

☐

The Segment values window > The table > The value of the segment, alphanumeric.

cashDiscountSubaccount_segmentValueDescription

string

☐

The Segment values window > The table > The description of the segment value.

cashDiscountSubaccount_subaccountId

int32

☐

SubID > The identifier of the subaccount.

cashDiscountSubaccount_subaccountNumber

string

☐

Mandatory field: Subaccount* > The subaccount number. Format 9-XX.

COMPANY_CODE

string(30)

Company Code

☑

Partition code, segmenting the data.

COMPANY_NAME

string(240)

Company Name

☑

Name of the partition.

corporateId

string

Corporate ID

☐

Delivery settings tab > Default location settings section > Corporate ID > The customers company ID, associated with the location.

createdDateTime

datetime

Created

☐

Information collected from the system. Not visible on the screen.

creditDaysPastDue

int32

Credit Days Past Due

☐

General information tab > Credit verification rules section > Credit days past due > The maximum number of days by which the customer payment may exceed the invoice date.

creditLimit

double

Credit Limit

☐

The General information tab > Credit verification rules section > Credit limit > The amount, if applicable, that serves as a credit limit for the customer.

creditTerms_description

string

Credit Terms Description

☐

Click on the magnifier. > The description.

creditTerms_id

string

Credit Terms ID

☐

Click on the magnifier. > The identifier.

creditVerification

string

Credit Verification

☐

The General information tab > Credit verification rules > Credit verification > The credit rule applied to this customer. The following options are available: Days past due, Credit limit, Limit and days past due, disabled.

currencyId

string

Currency ID

☐

The General information tab > Financial settings section > Currency ID > The currency used in operations with the customer, which you can select from the list of currencies defined in the system.

customerClass_description

string

Customer Class Description

☐

Click on the magnifier. > The description.

customerClass_id

string

Customer Class ID

☐

Click on the magnifier. > The identifier.

customerLedgerAccount_description

string

☐

Name of item/description

customerLedgerAccount_number

string

☐

Number of item

customerLedgerAccount_type

string

☐

customerLedgerSubaccount_active

boolean

☐

Active > The status of the identifier.

customerLedgerSubaccount_description

string

☐

Description > The description of the identifier.

customerLedgerSubaccount_errorInfo

string

☐

customerLedgerSubaccount_lastModifiedDateTime

datetime

☐

System generated information.

customerLedgerSubaccount_metadata_maxPageSize

int64

☐

customerLedgerSubaccount_metadata_totalCount

int64

☐

customerLedgerSubaccount_segmentDescription

string

☐

The Segment values window > The Top part > The description of the segment.

customerLedgerSubaccount_segmentId

int32

☐

The Segment values window > The Top part > The ID of the segment.

customerLedgerSubaccount_segmentValue

string

☐

The Segment values window > The table > The value of the segment, alphanumeric.

customerLedgerSubaccount_segmentValueDescription

string

☐

The Segment values window > The table > The description of the segment value.

customerLedgerSubaccount_subaccountId

int32

☐

SubID > The identifier of the subaccount.

customerLedgerSubaccount_subaccountNumber

string

☐

Mandatory field: Subaccount* > The subaccount number. Format 9-XX.

defaultPaymentMethodId

string

☐

Invoicing settings tab > Default payment method section > The default payment method.

deliveryAddress_addressId

int32

Delivery Address ID

☐

deliveryAddress_addressLine1

string

Delivery Address Line 1

☐

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

deliveryAddress_addressLine2

string

Delivery Address Line 2

☐

Address 2 > The second line of the address.

deliveryAddress_addressLine3

string

Delivery Address Line 3

☐

Address 3 > The third line of the address.

deliveryAddress_city

string

Delivery Address City

☐

City > The city.

deliveryAddress_country_errorInfo

string

☐

deliveryAddress_country_id

string

Delivery Address Country ID

☐

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

deliveryAddress_country_metadata_maxPageSize

int64

☐

deliveryAddress_country_metadata_totalCount

int64

☐

deliveryAddress_country_name

string

Delivery Address Country Name

☐

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

deliveryAddress_county_id

string

Delivery Address County ID

☐

Click the magnifier > The identifier

deliveryAddress_county_name

string

Delivery Address County Name

☐

Click the magnifier > The displayed name

deliveryAddress_postalCode

string

Delivery Address Postal Code

☐

Postcode > The postcode.

deliveryContact_attention

string

Delivery Contact Attention

☐

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.

deliveryContact_contactId

int32

Delivery Contact ID

☐

deliveryContact_email

string

Delivery Contact Email Address

☐

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

deliveryContact_fax

string

Delivery Contact Fax

☐

Fax > The fax number.

deliveryContact_name

string

Delivery Contact Name

☐

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

deliveryContact_phone1

string

Delivery Contact Phone 1

☐

Phone 1 > The default phone number.

deliveryContact_phone2

string

Delivery Contact Phone 2

☐

Phone 2 > An additional phone number.

deliveryContact_web

string

Delivery Contact Website

☐

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

description

string

Description

☐

Description > The description of the identifier.

discountAccount_description

string

☐

Name of item/description

discountAccount_number

string

☐

Number of item

discountAccount_type

string

☐

eInvoiceContract_fInvoiceContractID

string

☐

eInvoiceContract_fInvoiceIntermediatorID

string

☐

errorInfo_1

string

☐

errorInfo

string

Error Message

☐

freightAccount_description

string

☐

Name of item/description

freightAccount_number

string

☐

Number of item

freightAccount_type

string

☐

freightSubaccount_active

boolean

☐

Active > The status of the identifier.

freightSubaccount_description

string

☐

Description > The description of the identifier.

freightSubaccount_errorInfo

string

☐

freightSubaccount_lastModifiedDateTime

datetime

☐

System generated information.

freightSubaccount_metadata_maxPageSize

int64

☐

freightSubaccount_metadata_totalCount

int64

☐

freightSubaccount_segmentDescription

string

☐

The Segment values window > The Top part > The description of the segment.

freightSubaccount_segmentId

int32

☐

The Segment values window > The Top part > The ID of the segment.

freightSubaccount_segmentValue

string

☐

The Segment values window > The table > The value of the segment, alphanumeric.

freightSubaccount_segmentValueDescription

string

☐

The Segment values window > The table > The description of the segment value.

freightSubaccount_subaccountId

int32

☐

SubID > The identifier of the subaccount.

freightSubaccount_subaccountNumber

string

☐

Mandatory field: Subaccount* > The subaccount number. Format 9-XX.

gln

string

GLN

☐

Delivery settings tab > Default location settings section > GLN > The Global Location Number, associated with the location.

internalId

int32

Internal ID

☐

invoiceAddress_addressId

int32

Invoice Address ID

☐

invoiceAddress_addressLine1

string

Invoice Address Line 1

☐

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

invoiceAddress_addressLine2

string

Invoice Address Line 2

☐

Address 2 > The second line of the address.

invoiceAddress_addressLine3

string

Invoice Address Line 3

☐

Address 3 > The third line of the address.

invoiceAddress_city

string

Invoice Address City

☐

City > The city.

invoiceAddress_country_errorInfo

string

☐

invoiceAddress_country_id

string

Invoice Address Country ID

☐

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

invoiceAddress_country_metadata_maxPageSize

int64

☐

invoiceAddress_country_metadata_totalCount

int64

☐

invoiceAddress_country_name

string

Invoice Address Country Name

☐

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

invoiceAddress_county_id

string

Invoice Address County ID

☐

Click the magnifier > The identifier

invoiceAddress_county_name

string

Invoice Address County Name

☐

Click the magnifier > The displayed name

invoiceAddress_postalCode

string

Invoice Address Postal Code

☐

Postcode > The postcode.

invoiceContact_attention

string

Invoice Contact Attention

☐

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.

invoiceContact_contactId

int32

Invoice Contact ID

☐

invoiceContact_email

string

Invoice Contact Email Address

☐

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

invoiceContact_fax

string

Invoice Contact Fax

☐

Fax > The fax number.

invoiceContact_name

string

Invoice Contact Name

☐

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

invoiceContact_phone1

string

Invoice Contact Phone 1

☐

Phone 1 > The default phone number.

invoiceContact_phone2

string

Invoice Contact Phone 2

☐

Phone 2 > An additional phone number.

invoiceContact_web

string

Invoice Contact Website

☐

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

invoiceToDefaultLocation

boolean

Invoice to Default Location

☐

Delivery settings tab > Default location settings > Invoice to default location > A check box indicating that the default location is to be used.

lastModifiedDateTime_1

datetime

☐

Information collected from the system. Not visible on the screen.

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

mainAddress_addressId

int32

Main Address ID

☐

mainAddress_addressLine1

string

Main Address Line 1

☐

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

mainAddress_addressLine2

string

Main Address Line 2

☐

Address 2 > The second line of the address.

mainAddress_addressLine3

string

Main Address Line 3

☐

Address 3 > The third line of the address.

mainAddress_city

string

Main Address City

☐

City > The city.

mainAddress_country_errorInfo

string

☐

mainAddress_country_id

string

Main Address Country ID

☐

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

mainAddress_country_metadata_maxPageSize

int64

☐

mainAddress_country_metadata_totalCount

int64

☐

mainAddress_country_name

string

Main Address Country Name

☐

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

mainAddress_county_id

string

Main Address County ID

☐

Click the magnifier > The identifier

mainAddress_county_name

string

Main Address County Name

☐

Click the magnifier > The displayed name

mainAddress_postalCode

string

Main Address Postal Code

☐

Postcode > The postcode.

mainContact_attention

string

Main Contact Attention

☐

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.

mainContact_contactId

int32

Main Contact ID

☐

mainContact_email

string

Main Contact Email Address

☐

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

mainContact_fax

string

Fax

☐

Fax > The fax number.

mainContact_name

string

Main Contact Name

☐

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

mainContact_phone1

string

Main Contact Phone 1

☐

Phone 1 > The default phone number.

mainContact_phone2

string

Main Contact Phone 2

☐

Phone 2 > An additional phone number.

mainContact_web

string

Main Contact Website

☐

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

metadata_maxPageSize_1

int64

☐

metadata_maxPageSize

int64

☐

metadata_totalCount_1

int64

☐

metadata_totalCount

int64

Total Count

☐

name

string

Name

☐

Mandatory field: The top part > Customer name* > The name of the customer to appear in the system, which may be a trade name or a doing-business-as (DBA) name.

number

string

Number

☐

Mandatory field: The top part > Customer ID* > The ID of the customer account, which is defined by the BIZACCT segmented key or by the CUSTOMER segmented key. When you are creating a new customer, you must specify an ID.

parentRecord_name

string

Parent Record Name

☐

Click the magnifier. > The name.

parentRecord_number

string

Parent Record Number

☐

Click the magnifier. > The identifier.

prepaymentAccount_description

string

☐

Name of item/description

prepaymentAccount_number

string

☐

Number of item

prepaymentAccount_type

string

☐

prepaymentSubaccount_active

boolean

☐

Active > The status of the identifier.

prepaymentSubaccount_description

string

☐

Description > The description of the identifier.

prepaymentSubaccount_errorInfo

string

☐

prepaymentSubaccount_lastModifiedDateTime

datetime

☐

System generated information.

prepaymentSubaccount_metadata_maxPageSize

int64

☐

prepaymentSubaccount_metadata_totalCount

int64

☐

prepaymentSubaccount_segmentDescription

string

☐

The Segment values window > The Top part > The description of the segment.

prepaymentSubaccount_segmentId

int32

☐

The Segment values window > The Top part > The ID of the segment.

prepaymentSubaccount_segmentValue

string

☐

The Segment values window > The table > The value of the segment, alphanumeric.

prepaymentSubaccount_segmentValueDescription

string

☐

The Segment values window > The table > The description of the segment value.

prepaymentSubaccount_subaccountId

int32

☐

SubID > The identifier of the subaccount.

prepaymentSubaccount_subaccountNumber

string

☐

Mandatory field: Subaccount* > The subaccount number. Format 9-XX.

priceClass_description

string

Price Class Description

☐

Click on the magnifier. > The description.

priceClass_id

string

Price Class ID

☐

Click on the magnifier. > The identifier.

printInvoices

boolean

Print Invoices

☐

Invoicing settings > Print and email settings section > Print invoices > A check box that, if selected, indicates that invoices can be printed in the Print invoice (AR508000) window.

printMultiCurrencyStatements

boolean

Print Multi-Currency Statements

☐

Invoicing settings > Print and email settings section > Multi-currency statements > A check box that indicates (if selected) that this customer's statements must be printed in multi-currency format.

printStatements

boolean

Print Statements

☐

Invoicing settings > Print and email settings section > Print statements > A check box that, if selected, indicates that statements can be printed in the Print statements (AR503500) window.

salesAccount_description

string

☐

Name of item/description

salesAccount_number

string

☐

Number of item

salesAccount_type

string

☐

salesEuAccount_description

string

☐

Name of item/description

salesEuAccount_number

string

☐

Number of item

salesEuAccount_type

string

☐

salesExportAccount_description

string

☐

Name of item/description

salesExportAccount_number

string

☐

Number of item

salesExportAccount_type

string

☐

salesNonTaxableAccount_description

string

☐

Name of item/description

salesNonTaxableAccount_number

string

☐

Number of item

salesNonTaxableAccount_type

string

☐

salesSubaccount_active

boolean

☐

Active > The status of the identifier.

salesSubaccount_description

string

☐

Description > The description of the identifier.

salesSubaccount_errorInfo

string

☐

salesSubaccount_lastModifiedDateTime

datetime

☐

System generated information.

salesSubaccount_metadata_maxPageSize

int64

☐

salesSubaccount_metadata_totalCount

int64

☐

salesSubaccount_segmentDescription

string

☐

The Segment values window > The Top part > The description of the segment.

salesSubaccount_segmentId

int32

☐

The Segment values window > The Top part > The ID of the segment.

salesSubaccount_segmentValue

string

☐

The Segment values window > The table > The value of the segment, alphanumeric.

salesSubaccount_segmentValueDescription

string

☐

The Segment values window > The table > The description of the segment value.

salesSubaccount_subaccountId

int32

☐

SubID > The identifier of the subaccount.

salesSubaccount_subaccountNumber

string

☐

Mandatory field: Subaccount* > The subaccount number. Format 9-XX.

segmentDescription

string

☐

The Segment values window > The Top part > The description of the segment.

segmentId

int32

Segment ID

☐

The Segment values window > The Top part > The ID of the segment.

segmentValue

string

Segment Value

☐

The Segment values window > The table > The value of the segment, alphanumeric.

segmentValueDescription

string

Segment Value Description

☐

The Segment values window > The table > The description of the segment value.

sendInvoicesByEmail

boolean

Send Invoices by Email

☐

Invoicing settings > Print and email settings section > Send invoices by email > A check box that, if selected, indicates that you can send invoices by email by using the Print invoices (AR508000) window.

sendStatementsByEmail

boolean

Send Statements by Email

☐

Invoicing settings > Print and email settings section > Send statement by email > A check box that, if selected, indicates that statements can be sent by email to customers of the class in the Print statements (AR503500) window.

statementType

string

Statement Type

☐

Invoicing settings > Print and email settings section > Statement type > The statement type used by default in relations with the customer, which can be one of the following: Open item, Balance brought forward.

status

string

Status

☐

Mandatory field: The top part > Status* > The status of the customer account. You can select one of the following options: Active, On hold, Credit hold, Inactive, One time.

subaccountId

int32

☐

SubID > The identifier of the subaccount.

subaccountNumber

string

☐

Mandatory field: Subaccount* > The subaccount number. Format 9-XX.

vatRegistrationId

string

VAT Registration ID

☐

Deliver settings tab > Default location settings section > VAT registration ID > The customer's taxpayer ID associated with the location.

vatZone_defaultTaxCategory_description

string

VAT Zone Default Tax Category Description

☐

Name of item/description

vatZone_defaultTaxCategory_number

string

VAT Zone Default Tax Category Number

☐

Number of item

vatZone_defaultVatCategory

string

VAT Zone Default VAT Category

☐

Click the magnifier. The Default VAT category for the VAT zone of the supplier, which is specified in the AP303000 window.

vatZone_description

string

VAT Zone Description

☐

Click the magnifier. The description for the VAT zone of the supplier, which is specified in the AP303000 window.

vatZone_errorInfo

string

☐

vatZone_id

string

VAT Zone ID

☐

Click the magnifier. The identifier for the VAT zone of the supplier, which is specified in the AP303000 window.

vatZone_metadata_maxPageSize

int64

☐

vatZone_metadata_totalCount

int64

☐