Visma.net Financials API Data Model

closedFinancialPeriod

string

☐

The date of the closing of the financial period.

COMPANY_CODE

string

☐

Partition to retrieve data from.

createdDateTime

string

☐

Creation date and time.

createdDateTimeCondition

string

☐

System-retrieved information for state/condition

customerRefNumber

string

☐

The top part > External reference > The external reference used in AutoInvoice.

documentDueDate

datetime

☐

The date when payment for the document is due, in accordance with the credit terms.

documentType

string

☐

The field is deprecated for specific customer document endpoints. It will only be usable from customer document endpoint. (Values: Invoice, DebitNote, CreditNote, Payment, VoidPayment, Prepayment, Refund, FinCharge, SmallBalanceWo, SmallCreditWo, CashSale, CashReturn, Undefined, NoUpdate)

dunningLetterDateTime

string

☐

The date and time for when the document last released a dunning letter.

dunningLetterDateTimeCondition

string

☐

Set time/date as before (<), after (>), before and including (=<) OR after and including (=>) to filter on time frame.

dunningLevel

int32

☐

The dunning level of the document.

expandApplications

boolean

☐

True if you want to see all dunning information regarding this document.

expandAttachments

boolean

☐

True if you want to see all attachments regarding this document.

expandDunningInformation

boolean

☐

expandInvoiceAddress

boolean

☐

True if you want to see all information regarding the invoice address for this document.

expandTaxDetails

boolean

☐

True if you want to see all VAT details regarding this document.

externalReference

string

☐

The top part > External reference > The external reference used in AutoInvoice.

financialPeriod

string

☐

The financial period to which the transactions recorded in the document is posted. Format YYYYMM.

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.

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.

paymentReference

string

☐

The top part > Payment ref. > The reference number of the document, as automatically generated by the system in accordance with the number series assigned to cash sales in the Customer ledger preferences window..

project

string

☐

The project with which the document is associated.

released

int32

☐

Parameter for showing if invoice has been released or not.

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. Use the dropdown to select status. (Values: Hold, Balanced, Voided, Scheduled, Open, Closed, PendingPrint, PendingEmail, CreditHold, CcHold, Reserved)

account_description

string

Account Description

☐

Name of item/description

account_externalCode1

string

Account External Code 1

☐

Account class > The identifier of the account class.

account_externalCode2

string

Account External Code 2

☐

Account class > The name of the account class.

account_number

string

Account Number

☐

Number of item

account_type

string

Account Type

☐

Account > The account number.

amount

double

Amount

☐

The top part > Amount > The amount paid by the document. The value appears for new documents if the Validate document totals on entry check box is selected on the AR101000 window.If the check box is cleared, then the value appears when the document status is Open.

amountInCurrency

double

Amount in Currency

☐

Background calculation giving you the Amount in your default currency. This field is applicable if the amount is given in a another currency than your default.

balance

double

Balance

☐

The top part > Balance > For an open customer ledger document, the balance after any cash discount was taken. For a document used in the application process, this is the balance after the payments were applied.

balanceInCurrency

double

Balance in Currency

☐

Background calculation giving you the Balance in your default currency. This field is applicable if the amount is given in a another currency than your default.

branchNumber_name

string

Branch Name

☐

Click the magnifier. > The name.

branchNumber_number

string

Branch Number

☐

Click the magnifier. > The identifier.

cashAccount

string

Cash Account

☐

Financial details tab > The payment information section > Cash account > The cash account associated with the payment method.

cashDiscount

double

Cash Discount

☐

The top part > Cash discount > The cash discount amount that has been or will be taken on the document, which the system calculates based on the specified credit terms.

cashDiscountInCurrency

double

Cash Discount in Currency

☐

Background calculation giving you the Cash discount in your default currency. This field is applicable if the amount is given in another currency than your default.

closedFinancialPeriod

string

Closed Financial Period

☐

Format YYYYMM.

COMPANY_CODE

string(30)

Company Code

☑

Partition code, segmenting the data.

COMPANY_NAME

string(240)

Company Name

☑

Name of the partition.

createdDateTime

datetime

Created

☐

The Attachments tab > Creation time > The date the attachment was created.

currencyId

string

Currency ID

☐

The top part > Currency > The currency of the document. By default, it is the customer’s default currency,but it can be changed if the Allow Currency Override check box is selected in the AR303000 window.

customer_name

string

Customer Name

☐

Click the magnifier. > The name.

customer_number

string

Customer Number

☐

customerProject

string

☐

The top part > Customer project no. > The customer project no. used in AutoInvoice.

customerRefNumber

string

Custom Reference Number

☐

The top part > External reference > The external reference used in AutoInvoice.

customerVatZone_description

string

VAT Zone Description

☐

Click on the magnifier. > The description.

customerVatZone_id

string

VAT Zone ID

☐

Click on the magnifier. > The identifier.

documentDate

datetime

Document Date

☐

The top part > Date* > The date when the customer ledger document was created.By default, for a new document, it is the current business date, but you can change the date.

documentType

string

Document Type

☐

The top part > Type > The document type. The following types are available: invoice, debit note, credit note, overdue charge, credit write-off

errorInfo

string

Error Message

☐

financialPeriod

string

Financial Period

☐

The financial period to which the transactions recorded in the document should be posted. Format YYYYMM.

hold

boolean

Hold

☐

The top part > Hold > A check box that indicates if the document is a draft. A document with the On Hold status may be edited and cannot be released.

invoiceText

string

Invoice Text

☐

The top part > Invoice text > Any user-provided description of the customer ledger document.

lastModifiedDateTime

datetime

Last Modified

☐

System generated field for last modification date/time of 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

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.

origInvoiceDate

datetime

Original Invoice Date

☐

The top part > Orig invoice date > The date based on which the Due date and Cash discount date is calculated. Only used if setting "Use Orig Invoice Date" is active in AR Preferences.By default, for a new document, it is the current business date, but you can change the date.

paymentMethod_description

string

Payment Method Description

☐

Click on the magnifier. > The description.

paymentMethod_id

string

Payment Method ID

☐

Click on the magnifier. > The identifier.

postPeriod

string

Post Period

☐

The top part > Post period > The period to which the document should be posted. Format YYYYMM.

project_description

string

Project Description

☐

Click on the magnifier. > The description.

project_id

string

Project ID

☐

Click on the magnifier. > The identifier.

referenceNumber

string

Reference Number

☐

The Top part > Ref. no. > The reference number of the customer ledger document in the system.

roundingDiff

double

Rounding Difference

☐

The top part > Rounding diff. > The difference between the original amount and the rounded amount.

status

string

Status

☐

The top part > Status > The status of the document, which can be one of the following: Hold, Balanced, Voided, Scheduled, Open, Closed, Pending print, Pending email.

subaccount_active

boolean

☐

Active > The status of the identifier.

subaccount_description

string

Subaccount Description

☐

Description > The description of the identifier.

subaccount_errorInfo

string

Sub Account Error Message

☐

subaccount_lastModifiedDateTime

datetime

Sub Account Last Modified

☐

System generated information.

subaccount_metadata_maxPageSize

int64

☐

subaccount_metadata_totalCount

int64

☐

subaccount_subaccountId

int32

Sub Account ID

☐

SubID > The identifier of the subaccount.

subaccount_subaccountNumber

string

Sub Account Number

☐

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

vatTotal

double

VAT Total

☐

The top part > VAT total > The VAT amount of the document, as defined on the VAT details tab.

vatTotalInCurrency

double

VAT Total in Currency

☐

Background calculation giving you the VAT total in your default currency. This field is applicable if the amount is given in a another currency than your default.