Visma.net Financials API Data Model

COMPANY_CODE

string

☐

Partition to retrieve data from.

greaterThanValue

string

☐

Filter on order no. and forward

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.

orderStatus

string

☐

Select and filter on Status. (Values: Balanced, Cancelled, Closed, Hold, Open, PendingEmail, PendingPrint, Printed, Voided)

orderType

string

☐

Select and filter on Type. (Values: RegularOrder, DropShip, Blanket, StandardBlanket)

pageNumber

int32

☐

Pagination parameter. Page number.

pageSize

int32

☐

Pagination parameter. Number of items to be collected.

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.

supplier

string

☐

Filter on Supplier.

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.

controlTotal

double

Total for Control

☐

The top part > Control total > The order's total amount (including VAT), which you must enter manually when you attempt to save the order with the Balanced status.

controlTotalInBaseCurrency

double

☐

The top part > View base > A button that recalculates the Control total to your base currency if the amount on the purchase order is in another currency then base currency. When you click the button, the button toggles to View currency.

currency

string

Currency

☐

The top part > Currency > The currency the purchase order will be paid in.

date

datetime

Date

☐

Mandatory field: The top part > Date* > The date when the purchase order was created.

description

string

Description

☐

The top part > Description > A brief description of the purchase order.

discount

double

Discount

☐

The table > Discount percent > The discount percent if by definition the discount is calculated as a percentage.

discountableAmt

double

☐

The table > Discountable amt. > The amount used as a base for discount calculation if the discount is defined as based on the amount.

discountableQty

double

☐

The table > Discountable qty. > The quantity used as a base for discount calculation if the discount is defined as based on the item quantity.

discountAmt

double

Discount Amount

☐

The table > Discount amt. > The amount of the discount.

discountCode

string

Discount Code

☐

Mandatory field: The table > Discount code* > The discount code of the supplier discount applied to the document automatically or manually.

dontEmail

boolean

Don't Email

☐

Other information > Do not email > A check box that indicates (if selected) indicates that the purchase order should not be emailed.

dontPrint

boolean

Don't Print

☐

Other information > Do not print > A check box that indicates (if selected) that the current purchase order should not be printed.

emailed

boolean

Emailed

☐

Other information > Emailed > A check box that indicates (if selected) indicates that the current purchase order was emailed.

errorInfo

string

Error Message

☐

exchangeRate

double

Exchange Rate

☐

fobPoint

string

☐

Delivery instructions tab > The Delivery instructions section > FOB point > The FOB point where the title of goods (listed on this purchase order) is transferred from the supplier to the company.

freeItem

int32

☐

The table > Free item > The item ID of the free item, if one is specified by the discount applied to the document.

freeItemQty

double

☐

The table > Free item qty.> The quantity of the free item to be added as the discount.

hold

boolean

Hold

☐

The top part > Hold > A check box that you select to give the purchase order the On hold status.

lastModifiedDateTime

datetime

Last Modified

☐

System generated information.

lineNbr

int32

☐

The table > Line number.

lineTotal

double

Line Total

☐

The top part > Line total > The total sum of the Extended amount entries for all lines in the current purchase order. This value is calculated by the system and users cannot manually change it.

lineTotalInBaseCurrency

double

☐

The top part > View base > A button that recalculates the Line total to your base currency if the amount on the purchase order is in another currency then base currency. When you click the button, the button toggles to View currency.

location_id

int32

Location ID

☐

Click the magnifier > The identifier

location_name

string

Location Name

☐

Click the magnifier > The displayed name

manualDiscount

boolean

☐

The table > Manual discount > A check box that indicates (if selected) that the supplier discount shown in this row has been applied manually .

metadata_maxPageSize

int64

☐

metadata_totalCount

int64

Total Count

☐

note

string

Note

☐

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

openBalance

double

Open Balance

☐

Other information > Open amount > The amount of these items that are ordered but not received.

openQuantity

double

☐

Other information > Open Quantity > The difference between the quantities of ordered and received items.

orderNbr

string

Order Number

☐

The top part > Order no. > The unique reference number of the purchase order, which the system assigns based on the number series assigned to purchase orders of this type, as specified in the PO101000 window.

orderTotal

double

Order Total

☐

The Top part > Order total > The total sum for the purchase order, including VAT. This read-only value is the sum of the Line total and VAT total values.

orderTotalInBaseCurrency

double

☐

The top part > View base > A button that recalculates the Order total to your base currency if the amount on the purchase order is in another currency then base currency. When you click the button, the button toggles to View currency.

orderType

string

Order Type

☐

The top part > Type > The type of the purchase order, which can be one of these options: Normal, Drop-ship, Blanket, Default

owner_id

string

Owner ID

☐

Click the magnifier > The identifier

owner_name

string

Owner Name

☐

Click the magnifier > The displayed name

paymentRefNbr

string

Payment Reference Number

☐

Other information tab > Prepayment ref. no. > The reference number of the prepayment request linked to this purchase order, if any.

printed

boolean

Printed

☐

Other information > Printed > A check box that indicates (if selected) that the current purchase order was printed.

promisedOn

datetime

Promised on

☐

The top part > Delivery date > The date when the supplier promised that the items listed in the order will be received at their destination location.

remitAddress_addressId

int32

☐

remitAddress_addressLine1

string

☐

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

remitAddress_addressLine2

string

☐

Address 2 > The second line of the address.

remitAddress_addressLine3

string

☐

Address 3 > The third line of the address.

remitAddress_city

string

☐

City > The city.

remitAddress_country_errorInfo

string

☐

remitAddress_country_id

string

☐

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

remitAddress_country_metadata_maxPageSize

int64

☐

remitAddress_country_metadata_totalCount

int64

☐

remitAddress_country_name

string

☐

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

remitAddress_county_id

string

☐

Click the magnifier > The identifier

remitAddress_county_name

string

☐

Click the magnifier > The displayed name

remitAddress_overrideAddress

boolean

☐

The Supplier info tab > The Supplier address section > Override > A check box that you select to override (that is, to edit ) the default shipping address for the supplier.

remitAddress_postalCode

string

☐

Postcode > The postcode.

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

remitContact_contactId

int32

☐

remitContact_email

string

☐

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

remitContact_fax

string

☐

Fax > The fax number.

remitContact_name

string

☐

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

remitContact_overrideContact

boolean

☐

The Supplier information tab > The Supplier contact section > Override > A check box that you select to override (edit) the default contact settings for the supplier.

remitContact_phone1

string

☐

Phone 1 > The default phone number.

remitContact_phone2

string

☐

Phone 2 > An additional phone number.

remitContact_web

string

☐

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

requisitionRefNbr

string

☐

Other information tab > Requisition ref. no. > The reference number of the requisition document associated with the purchase order, if any.

salesOrderNbr

string

☐

Other information tab > Sales order no. > The ID of the sales order associated with the purchase order.

salesOrderType

string

☐

Other information tab > Sales order type > The type of the sales order associated with the purchase order.

sequanceID

string

☐

Mandatory field: The table > Series ID* > The ID of the discount sequence applied to the document.

shippingAddress_addressId

int32

☐

shippingAddress_addressLine1

string

☐

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

shippingAddress_addressLine2

string

☐

Address 2 > The second line of the address.

shippingAddress_addressLine3

string

☐

Address 3 > The third line of the address.

shippingAddress_city

string

☐

City > The city.

shippingAddress_country_errorInfo

string

☐

shippingAddress_country_id

string

☐

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

shippingAddress_country_metadata_maxPageSize

int64

☐

shippingAddress_country_metadata_totalCount

int64

☐

shippingAddress_country_name

string

☐

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

shippingAddress_county_id

string

☐

Click the magnifier > The identifier

shippingAddress_county_name

string

☐

Click the magnifier > The displayed name

shippingAddress_overrideAddress

boolean

☐

The Supplier info tab > The Supplier address section > Override > A check box that you select to override (that is, to edit ) the default shipping address for the supplier.

shippingAddress_postalCode

string

☐

Postcode > The postcode.

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

shippingContact_contactId

int32

☐

shippingContact_email

string

☐

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

shippingContact_fax

string

☐

Fax > The fax number.

shippingContact_name

string

☐

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

shippingContact_overrideContact

boolean

☐

The Supplier information tab > The Supplier contact section > Override > A check box that you select to override (edit) the default contact settings for the supplier.

shippingContact_phone1

string

☐

Phone 1 > The default phone number.

shippingContact_phone2

string

☐

Phone 2 > An additional phone number.

shippingContact_web

string

☐

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

shippingDestinationType

string

☐

Shipping instructions tab > The Delivery address section > Shipping destination type > The type of the shipping destination, which is one of the following options: Branch location (meaning a branch of your company), Customer, Supplier, and Warehouse.

shippingLocation_id

int32

Shipping Location ID

☐

Click the magnifier > The identifier

shippingLocation_name

string

Shipping Location Name

☐

Click the magnifier > The displayed name

shipTerms

string

☐

Delivery instructions tab > The Delivery instructions section > Shipping terms > The shipping terms for the purchase order.

shipTo_internalId

int32

☐

shipTo_name

string

☐

The name of the particular destination of the selected type.

shipTo_number

string

☐

The identifier of the particular destination of the selected type.

shipVia

string

Ship Via

☐

Delivery instructions tab > The Delivery instructions section > Ship via > The carrier selected to ship the goods for the purchase order.

skipDiscount

boolean

☐

The table > Skip discount > A check box that you select to cancel a Group or Document level discount for the document.

status

string

Status

☐

The top part > Status > The system-generated status of the purchase order, which can be one of the following options: On hold, Open, Pending approval, Rejected, Pending printing, Pending e-mail, Closed, Cancelled.

supplier_internalId

int32

Supplier Internal ID

☐

supplier_name

string

Supplier Name

☐

The name of the particular destination of the selected type.

supplier_number

string

Supplier Number

☐

The identifier of the particular destination of the selected type.

supplierRef

string

Supplier Reference

☐

The top part > Supplier ref. > The reference number of the supplier document related to this purchase order.

supplierVatZone_defaultTaxCategory_description

string

☐

Name of item/description

supplierVatZone_defaultTaxCategory_number

string

☐

Number of item

supplierVatZone_defaultVatCategory

string

☐

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

supplierVatZone_description

string

☐

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

supplierVatZone_errorInfo

string

☐

supplierVatZone_id

string

☐

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

supplierVatZone_metadata_maxPageSize

int64

☐

supplierVatZone_metadata_totalCount

int64

☐

taxTotal

double

Tax Total

☐

The Top part > VAT total > The total VAT amount for all lines added to the current purchase order. This value, also calculated by the system, is the sum of the VAT amounts for each line.

taxTotalInBaseCurrency

double

☐

The top part > View base > A button that recalculates the VAT total to your base currency if the amount on the purchase order is in another currency then base currency. When you click the button, the button toggles to View currency.

terms_description

string

Terms Description

☐

Click on the magnifier. > The description.

terms_id

string

Terms ID

☐

Click on the magnifier. > The identifier.

type

string

Type

☐

The table > Type > The type of discount applied to the document (Group or Document).

vatExemptTotal

double

VAT Exempt Total

☐

The Top part > VAT exempt total > The document total that is exempt from VAT. This total is calculated as the taxable amount for the VAT with the Include in VAT exempt total check box selected in the TX205000 window.

vatExemptTotalInBaseCurrency

double

☐

The top part > View base > A button that recalculates the VAT exempt total to your base currency if the amount on the purchase order is in another currency then base currency. When you click the button, the button toggles to View currency.

warehouse_description

string

Warehouse Description

☐

Click on the magnifier. > The description.

warehouse_id

string

Warehouse ID

☐

Click on the magnifier. > The identifier.

workgroupID

int32

☐

Other information tab > Work group ID > The work group to which the purchase order was assigned for processing.