Visma.net Financials API Data Model

COMPANY_CODE

string

☐

Partition to retrieve data from.

customerCd

string

☑

greaterThanValue

string

☐

Filter on Order no. greater than value.

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.

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.

orderBy

string

☐

This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result.

orderType

string

☐

Filter by Order type.

pageNumber

int32

☐

Pagination parameter. Page number.

pageSize

int32

☐

Pagination parameter. Number of items to be collected.

showNotes

boolean

☐

Set to true to include notes.

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

☐

Select to filter on status on order. (Values: Open, Hold, CreditHold, Completed, Cancelled, BackOrder, Shipping, Invoiced, PendingApproval, Voided)

alternateID

string

Alternate ID

☐

Alternate ID > The alternate ID for the item, such as the item ID used by the customer.

branchNumber_name_1

string

☐

Click the magnifier. > The name.

branchNumber_name

string

Branch Name

☐

Click the magnifier. > The name.

branchNumber_number_1

string

☐

Click the magnifier. > The identifier.

branchNumber_number

string

Branch Number

☐

Click the magnifier. > The identifier.

cancelBy

datetime

Cancel by

☐

Delivery settings tab > Shipping information section > Cancel by > The date when the order should be cancelled if the Back order allowed option has been selected in the Shipping rule field.

canceled

boolean

Canceled

☐

The Delivery settings tab > The Shipping information section > Cancelled > A check box that indicates that the order has been cancelled on the date specified in Cancel by.

cashAccount

string

Cash Account

☐

Payment settings tab > Cash account

cashDiscountDate

datetime

Cash Discount Date

☐

Financial settings tab > Financial information section > Cash discount date > The date when the cash discount is available for the invoice based on the credit terms.

commissionable

boolean

Commissionable

☐

VAT code > The VAT category of the goods mentioned in this line.

commissionableAmount

string

☐

The Commissions tab > Commissionable amount> The amount used to calculate the commission.

commissionAmount

string

☐

The Commissions tab > Commission amt. >The commission amount earned by the salesperson on this document.

commissionPercent

string

☐

The Commissions tab > Commission (%) > The percentage of commission generally earned by the salesperson.

COMPANY_CODE

string(30)

Company Code

☑

Partition code, segmenting the data.

COMPANY_NAME

string(240)

Company Name

☑

Name of the partition.

completed

boolean

Completed

☐

Completed > A check box that can be selected to indicate to the system that this line is completed.

contactId

int32

Contact ID

☐

The top part > Contact > The contact person of the customer.

currency

string

Currency

☐

The top part > Currency > The currency of the document.

customer_internalId

int32

Customer Internal ID

☐

customer_name

string

Customer Name

☐

The name of the particular destination of the selected type.

customer_number

string

Customer Number

☐

The identifier of the particular destination of the selected type.

customerOrder

string

Customer Order

☐

The top part > Customer order > The reference number of the original customer document that the sales order is based on.

customerRefNo

string

Customer Reference Number

☐

The top part > External reference > The reference number of the sales order in a third-party application if Visma.net Financials is integrated with such an application and imports the sales orders from it.

customerVATZone_defaultTaxCategory_description

string

VAT Zone Default Tax Category Description

☐

Name of item/description

customerVATZone_defaultTaxCategory_number

string

VAT Zone Default Tax Category Number

☐

Number of item

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

customerVATZone_description

string

VAT Zone Description

☐

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

customerVATZone_errorInfo

string

☐

customerVATZone_id

string

VAT Zone ID

☐

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

customerVATZone_metadata_maxPageSize

int64

☐

customerVATZone_metadata_totalCount

int64

☐

date

datetime

Date

☐

Mandatory field: The top part > Date* > The date of the document.

description

string

Description

☐

The top part > Description > A brief description of the document.

discountAmount

double

☐

Document details tab > Discount amount > The amount of the line-level discount that has been applied manually or automatically to this line item (if the item is not a free item).

discountCode

string

Discount Code

☐

Mandatory field: Document details tab > Discount details tab > Discount code* > The code of the discount that has been applied to this line.

discountPercent

double

Discount Percent

☐

Document details tab > Discount percent > The percent of the line-level discount that has been applied manually or automatically to this line item (if the item is not a free item).

discountTotal

double

Discount Total

☐

discountTotalInBaseCurrency

double

☐

discUnitPrice

double

☐

Document details tab > Disc. unit price > The unit price, which has been recalculated after the application of discounts.

dueDate

datetime

Due Date

☐

Financial settings tab > Financial information section > Due date > The due date of the invoice according to the credit terms.

errorInfo

string

Error Message

☐

exchangeRate

double

Exchange Rate

☐

expirationDate

datetime

Expiration Date

☐

Expiration date > The expiration date for the item with the specified lot number.

externalLink

string

☐

extPrice

double

☐

Document details tab > Extended cost > The extended price, which is the unit price multiplied by the quantity.

fobPoint_description

string

☐

Click on the magnifier. > The description.

fobPoint_id

string

☐

Click on the magnifier. > The identifier.

freeItem

boolean

☐

A check box that indicates (if selected) that the stock item specified in the row is a free item. This information is collected from the system and not visible on the sales order line.

hold

boolean

Hold

☐

The top part > Hold > A check box that you select if the document is on hold and should not be processed further at this time.

insurance

boolean

Insurance

☐

Delivery settings tab > Shipping information section > Insurance > A check box that you select to indicate that insurance is required for this order.

inventory_description

string

Inventory Description

☐

Name of item/description

inventory_number

string

Inventory Number

☐

Number of item

invoiceDate

datetime

Invoice Date

☐

Financial settings tab > Financial information section > Invoice date> The date of the invoice generated for the order.

invoiceNbr_1

string

☐

Financial settings tab > Financial information section > Invoice no.> The invoice number of the invoice generated for this order.

invoiceNbr

string

Invoice Number

☐

The reference number of the invoice generated for this order. This number is collected from the system and not visible on the sales order line.

invoiceSeparately

boolean

Invoice Separately

☐

Financial settings tab > Financial information section > Invoice separately > A check box that indicating that this document is to be invoiced separately (if that is required).

isRotRutDeductible_1

boolean

☐

A check box indicating if the document is Rot/rut deductible (applicable for the Swedish markets)

isRotRutDeductible

boolean

☐

lastModifiedDateTime

datetime

Last Modified

☐

Background information collected from the system.

lineDescription

string

Line Description

☐

Document details tab > Line description > The description of the unit.

lineNbr

int32

☐

Document details tab > Line no. > The line number of the document.

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

lotSerialNbr

string

☐

Lot/serial no. > The lot or serial number of the item for returns

manualDiscount

boolean

☐

Document details tab > Manual discount > A check box that indicates (if selected) that the discount has been applied manually.

markForPO

boolean

☐

Mark for purchase order > A check box that indicates (if selected) that the order line was marked for purchasing (if it has not been shipped completely).

metadata_maxPageSize

int64

☐

metadata_totalCount

int64

Total Count

☐

note_1

string

☐

Icon Notes on top of the window > Pop-up window for providing any user-defined text connected to the order.

note

string

Note

☐

Tables in tab > Icon Notes > Pop-up window for providing any user-defined text connected to the order.

openQty

double

Open Quantity

☐

Document details tab > Open qty. > The quantity of the item to be shipped; that is, the total quantity minus the quantity shipped according to closed shipment documents.

operation

string

Operation

☐

The operation to be performed in the workspace to fulfil the order. This information is collected from the system and not visible on the sales order line.

orderNo

string

Order Number

☐

The top part > Order no.: > The reference number of the document.

orderTotal

double

Order Total

☐

The top part > Order total > The total amount of the document, which is calculated as follows:Line Total + Misc.Charges + Freight + Premium Freight – Discount Total+ Tax Total

orderTotalInBaseCurrency

double

☐

orderType

string

Order Type

☐

Mandatory field: The top part > Order type > The type of the document, which is one of the predefined order types or a custom order type created by using the (SO201000) window.

origOrderNbr

string

☐

The top part > Order no. > The order number of the document.

origOrderType

string

☐

Mandatory field: The top part > Order type* > The type of the document, which is one of the predefined order types or a custom order type created by using the window SO201000.

overshipThreshold

double

☐

Overship threshold (%) > The maximum percentage of goods shipped (with respect to the ordered quantity) allowed by the customer.

owner_employeeId

string

☐

The Financial settings tab > The Financial information section > Owner > Click the magnifier > Employee ID > The unique identifier, which is assigned to the employee in accordance with the configuration of the EMPLOYEEsegmented key. This information is retrieved from window EP203000.

owner_id

string

Owner ID

☐

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

owner_name

string

Owner Name

☐

The Financial settings tab > The Financial information section > Owner > Click the magnifier > Employee name > The name of this employee. This information is retrieved from window EP203000.

paymentMethod_description

string

Payment Method Description

☐

Click on the magnifier. > The description.

paymentMethod_id

string

Payment Method ID

☐

Click on the magnifier. > The identifier.

paymentRef

string

Payment Reference

☐

Payment settings tab > Payment ref.

poSource

string

PO Source

☐

Purchase order source > The purchase order source to be used to fulfill this line, which can be one of the following options: Purchase to order, Drop-shipment.

postPeriod

string

Post Period

☐

The Financial settings tab > Financial information section > Post period > The period to post the transactions generated by the invoice. Format MMYYYY.

preferredWarehouse_description

string

Preferred Warehouse Description

☐

Click on the magnifier. > The description.

preferredWarehouse_id

string

Preferred Warehouse ID

☐

Click on the magnifier. > The identifier.

printDescriptionOnInvoice

boolean

Print Description on Invoice

☐

The top part > Print description on invoice > A check box

printNoteOnExternalDocuments

boolean

Print Note on External Documents

☐

The top part > Print note on external sales documents > A check box

printNoteOnInternalDocuments

boolean

Print Note on Internal Documents

☐

The top part > Print line note on internal sales documents > A check box

priority

int32

Priority

☐

Delivery settings tab > Shipping information section > Priority > Field only for informational purposes. The level of priority for processing order of this customer, as specified for the customer on the Shipping settings tab on the AR303000 window.

project

int32

Project

☐

Mandatory field: The top part > Project* > The field consists of Project ID and Project description. Project ID: The identifier for the project with which this document is associated, or the code indicating that this document is not associated with any project; the non-project code is specified in the Project accounting preferences (PM101000) window.

projectTask

int32

Project Task

☐

Project task > The particular task of the project with which this document is associated.

projectTaskCd

string

☐

Project task code > The particular task code of the project with which this document is associated.

qtyOnShipments

double

☐

Document details tab > Qty. on shipments > A read-only column that displays the quantity of the stock item being prepared for shipment and already shipped for this order.

quantity

double

Quantity

☐

Document details tab > Quantity > The quantity of the item sold, measured in the UoM.

reasonCode

string

☐

Reason code > The reason code to be used for creation or cancellation of the order, if applicable.

requestedOn

datetime

Requested on

☐

Mandatory field: The top part > Requested on* > The date when the customer wants to receive the goods. The default value is the current business date.

requestOn

datetime

Request On

☐

Mandatory field: The top part > Requested on > The date when the customer wants to receive the goods; this date provides the default values for the Requested on dates for order lines.

residentialDelivery

boolean

Residential Delivery

☐

Delivery settings tab > Shipping information section > Residential delivery > A check box that you select to indicate that the shipment should be delivered to a residential area.

salesPerson_description_1

string

☐

Click on the magnifier. > The description.

salesPerson_description

string

Sales Person Description

☐

Click on the magnifier. > The description.

salesPerson_id_1

string

☐

Click on the magnifier. > The identifier.

salesPerson_id

string

Sales Person ID

☐

Click on the magnifier. > The identifier.

saturdayDelivery

boolean

Saturday Delivery

☐

Delivery settings tab > Shipping information section > Saturday delivery > A check box that indicates that the order may be delivered on Saturday.

schedShipment

datetime

☐

Delivery settings tab > Shipping information section > Sched. shipment > The date when the ordered goods are scheduled to be shipped.

shipComplete_1

string

☐

Delivery settings tab > Shipping information section > Shipping rule > An option that controls whether incomplete and partial shipments for the order are allowed.

shipComplete

string

☐

Shipping rule > An option that controls whether incomplete and partial shipments for the order are allowed. (Values: Ship complete, Back order allowed, Cancel remainder)

shipOn

datetime

☐

Ship on > The date when the item is to be shipped.

shippingTerms_description

string

Shipping Terms Description

☐

Click on the magnifier. > The description.

shippingTerms_id

string

Shipping Terms ID

☐

Click on the magnifier. > The identifier.

shippingZone_description

string

Shipping Zone Description

☐

Click on the magnifier. > The description.

shippingZone_id

string

Shipping Zone ID

☐

Click on the magnifier. > The identifier.

shipSeparately

boolean

Ship Separately

☐

Delivery settings tab > Shipping information section > Ship separately > This check box indicates that the goods for the customer should be shipped separately for each sales order.

shipVia_description

string

Ship via Description

☐

Click on the magnifier. > The description.

shipVia_id

string

Ship via ID

☐

Click on the magnifier. > The identifier.

soBillingAddress_addressId

int32

☐

soBillingAddress_addressLine1

string

☐

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

soBillingAddress_addressLine2

string

☐

Address 2 > The second line of the address.

soBillingAddress_addressLine3

string

☐

Address 3 > The third line of the address.

soBillingAddress_city

string

☐

City > The city.

soBillingAddress_country_errorInfo

string

☐

soBillingAddress_country_id

string

☐

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

soBillingAddress_country_metadata_maxPageSize

int64

☐

soBillingAddress_country_metadata_totalCount

int64

☐

soBillingAddress_country_name

string

☐

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

soBillingAddress_county_id

string

☐

Click the magnifier > The identifier

soBillingAddress_county_name

string

☐

Click the magnifier > The displayed name

soBillingAddress_overrideAddress

boolean

☐

Override address > A check box indicating that you want to override the default address information.

soBillingAddress_postalCode

string

☐

Postcode > The postcode.

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

soBillingContact_contactId

int32

☐

soBillingContact_email

string

☐

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

soBillingContact_fax

string

☐

Fax > The fax number.

soBillingContact_name

string

☐

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

soBillingContact_overrideContact

boolean

☐

Override contact > A check box indicating that you want to override the default contact information.

soBillingContact_phone1

string

☐

Phone 1 > The default phone number.

soBillingContact_phone2

string

☐

Phone 2 > An additional phone number.

soBillingContact_web

string

☐

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

sortOrder

int32

☐

Document details tab > Line order > The order number of the document line. The system regenerates this number automatically when you reorder the lines in the table.

soShippingAddress_addressId

int32

☐

soShippingAddress_addressLine1

string

☐

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

soShippingAddress_addressLine2

string

☐

Address 2 > The second line of the address.

soShippingAddress_addressLine3

string

☐

Address 3 > The third line of the address.

soShippingAddress_city

string

☐

City > The city.

soShippingAddress_country_errorInfo

string

☐

soShippingAddress_country_id

string

☐

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

soShippingAddress_country_metadata_maxPageSize

int64

☐

soShippingAddress_country_metadata_totalCount

int64

☐

soShippingAddress_country_name

string

☐

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

soShippingAddress_county_id

string

☐

Click the magnifier > The identifier

soShippingAddress_county_name

string

☐

Click the magnifier > The displayed name

soShippingAddress_overrideAddress

boolean

☐

Override address > A check box indicating that you want to override the default address information.

soShippingAddress_postalCode

string

☐

Postcode > The postcode.

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

soShippingContact_contactId

int32

☐

soShippingContact_email

string

☐

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

soShippingContact_fax

string

☐

Fax > The fax number.

soShippingContact_name

string

☐

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

soShippingContact_overrideContact

boolean

☐

Override contact > A check box indicating that you want to override the default contact information.

soShippingContact_phone1

string

☐

Phone 1 > The default phone number.

soShippingContact_phone2

string

☐

Phone 2 > An additional phone number.

soShippingContact_web

string

☐

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

status

string

Status

☐

The top part > Status > The status of the document, which can be one of the following options: On hold, Credit hold, Pending aååroval, Rejected, Open, Cancelled, Shipping, Back order, Invoiced, Completed.

subaccount_description

string

Subaccount Description

☐

Click on the magnifier. > The description.

subaccount_id

string

Subaccount ID

☐

Click on the magnifier. > The identifier.

taxCategory

string

Tax Category

☐

VAT code > The VAT category of the goods mentioned in this line.

taxTotal

double

Tax Total

☐

The top part > VAT total > The total amount of tax paid on the document.

taxTotalInBaseCurrency

double

☐

terms_description

string

Terms Description

☐

Click on the magnifier. > The description.

terms_id

string

Terms ID

☐

Click on the magnifier. > The identifier.

transactionType_description

string

Transaction Type Description

☐

Click on the magnifier. > The description.

transactionType_id

int32

Transaction Type ID

☐

Click on the magnifier. > The identifier.

unbilledAmount

double

☐

Document details tab > Amount not yet invoiced > The amount of cancelled shipments and cancelled remainders.

undershipThreshold

double

☐

Undership threshold (%) > The minimal percentage of goods shipped (with respect to the ordered quantity) to consider the order shipped completely.

unitCost

double

Unit Cost

☐

Document details tab > Unit Cost > The cost of the unit on the sales order.

unitPrice

double

☐

Document details tab > Unit price > The price of the unit on the sales order.

unitPriceInBaseCurrency

double

☐

uom

string

Unit of Measure

☐

Mandatory field: Document details tab > UoM* > The unit of measure (UoM) used for the item with this item ID.

vatExemptTotal

double

VAT Exempt Total

☐

The top part > VAT exempt total > The document total that is exempt from VAT.

vatExemptTotalInBaseCurrency

double

☐

vatTaxableTotal

double

VAT Taxable Total

☐

The top part > VAT taxable total > The document total that is subject to VAT.

vatTaxableTotalInBaseCurrency

double

☐

warehouse_description

string

Warehouse Description

☐

Click on the magnifier. > The description.

warehouse_id

string

Warehouse ID

☐

Click on the magnifier. > The identifier.