SupplierDocumentSubaccountSegmentsBySupplierNumber: Visma.net Financials Supplier Document Subaccount Segments by Supplier Number

balance

double

☐

This value represents balance of the payment remaining to be applied and released. Only released applications will count towards the balance._Note:_ __Balance__ and __BalanceCondition__ are __mutually inclusive__.

balanceCondition

string

☐

This value represents the condition to be applied to the Balance when retrieving records.Accepted values (without the single quotes):* '>' for greater than* '<' for less than* '>=' for greater than or equal* '<=' for less than or equal_Note:_ __Balance__ and __BalanceCondition__ are __mutually inclusive__.

branch

string

☐

Filter by Branch

createdDateTime

string

☐

Creation date and time.

createdDateTimeCondition

string

☐

System-retrieved information for state/condition

docDate

datetime

☐

This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.Accepted format:* ```yyyy-MM-dd```* ```yyyy-MM-dd```* ```yyyy-MM-dd```* ```yyyy-MM-dd```* ```yyyy-MM-dd```_Note:_ __Docate__ and __DocDateCondition__ are __mutually inclusive__.

docDateCondition

string

☐

This value represents the condition to be applied to the Document Date when retrieving records.Accepted values (without the single quotes):* '>' for greater than* '<' for less than* '>=' for greater than or equal* '<=' for less than or equal_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.

documentType

string

☐

By type of document. (Values: Invoice, CreditAdj, DebitAdj, Prepayment, Refund, Payment)

dueDate

datetime

☐

This value indicates the date the document is due for payment. Use it to retrieve all records that have the Due date since that time, up to the future.Accepted format:* ```yyyy-MM-dd```* ```yyyy-MM-dd```* ```yyyy-MM-dd```* ```yyyy-MM-dd```* ```yyyy-MM-dd```_Note:_ __DueDate__ and __DueDateConditionCondition__ are __mutually inclusive__.

dueDateCondition

string

☐

This value represents the condition to be applied to the Due Date when retrieving records.Accepted values (without the single quotes):* '>' for greater than* '<' for less than* '>=' for greater than or equal* '<=' for less than or equal_Note:_ __DueDate__ and __DueDateCondition__ are __mutually inclusive__.

expandApproval

boolean

☐

Set to true to include approval information.

expandLinePrebookAccounts

boolean

☐

Expland line-level pre-booking account and sub-account information.

expandNote

boolean

☐

Set to true to include description.

financialPeriod

string

☐

Filter by Financial Period, format YYYYPP

greaterThanValue

string

☐

Greater than value. The item which is the object for this, varies from API to API.

item

string

☐

Filter by Item used into the document lines

lastModifiedDateTime

string

☐

This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.Accepted format:* ```yyyy-MM-dd```* ```yyyy-MM-dd HH:mm:ss```* ```yyyy-MM-dd HH:mm:ss.FFF```* ```yyyy-MM-ddTHH:mm:ss```* ```yyyy-MM-ddTHH:mm:ss.FFF```_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.

lastModifiedDateTimeCondition

string

☐

This value represents the condition to be applied when retrieving records.Accepted values (without the single quotes):* '>' for greater than* '<' for less than* '>=' for greater than or equal* '<=' for less than or equal_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.

project

string

☐

Filter by the project with which the document is associated.

released

int32

☐

Parameter for showing if invoice has been released or not.

status

string

☐

The status of the document (Values: Hold, Balanced, Voided, Scheduled, Open, Closed, Printed, Prebooked, Reserved)

supplierNumber

string

☑

Identifies the supplier for which to return data

account_active

boolean

Account Active

☐

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.

active

boolean

Active

☐

Active > The status of the identifier.

amount

double

Amount

☐

Document details tab > Amount > Read-only. The total amount for the specified quantity of items or services of this type (after the discount has been taken).

amountInCurrency

double

Amount in Currency

☐

An automatic calculation of the amount with the currency set as default for supplier.

approvalStatus

string

Approval Status

☐

The Top part > Approval status > The status of the document in Visma.net Approval. [New, Canceled, SentToApproval, ReceivedByApproval, InProgressApproval, RejectedInApproval, ApprovedInApproval, ActiveWorkflowApproval.

balance

double

Balance

☐

The Top part > Balance > The balance of the supplier ledger document after VAT (if inclusive) and the discount as specified in the tabs below.

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 another currency than your default.

branch_name

string

Branch Name

☐

Click the magnifier. > The name.

branch_number

string

Branch Number

☐

Click the magnifier. > The identifier.

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 in the document, which the system calculates based in 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

☐

currencyId

string

Currency ID

☐

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

date

datetime

Date

☐

The Top part > Date* > The date of the original supplier ledger document; by default, it is the current date, which can be changed.

description_2

string

Description 2

☐

The Top part > Description > A user-provided description for this supplier ledger document.

description

string

Description

☐

Description > The description of the identifier.

documentType

string

Document Type

☐

The top part > Top part > Type > The type of the document. The following types are available: Purchase invoice, credit adjustment, purchase credit note, prepayment.

dueDate

datetime

Due Date

☐

The Top part > Due date* > The date when payment for the document is due in accordance with the supplier's credit terms.

errorInfo_2

string

Error Information 2

☐

errorInfo

string

Error Message

☐

financialPeriod

string

Financial Period

☐

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

lastModifiedDateTime_2

datetime

Last Modified Date/Time 2

☐

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_2

int64

{res:itgen_vnet_metadata_maxpagesize_2}

☐

metadata_maxPageSize

int64

Metadata Max Pagesize

☐

metadata_totalCount_2

int64

{res:itgen_vnet_metadata_totalcount_2}

☐

metadata_totalCount

int64

Total Count

☐

note

string

Note

☐

The table > Document details tab and Applications tab > Icon Notes > Pop-up window for providing any user-defined text connected with to invoice.

origInvoiceDate

datetime

Original Invoice Date

☐

The Top part > OrigInvoiceDate* > The original invoice date of the original supplier ledger document; by default, it is the current date, which can be changed.

payDate

datetime

Pay Date

☐

The Financial details tab > The Payment information section > Pay date* > The date when the invoice should be paid. The date is the difference between the document due date or discount date and the number of days specified in the Payment lead time field in AP303000.

paymentMessage

string

{res:itgen_vnet_paymentmessage}

☐

The Financial details tab > The Payment information section > Payment message > The message connected with the payment.

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 post period of the payment document. Format MMYYYY.

referenceNumber

string

Reference Number

☐

segmentDescription

string

{res:itgen_vnet_segmentdescription}

☐

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.

status

string

Status

☐

The Top part > Document status > A read-only field that shows the status of the supplier ledger document:[Hold, Balanced, Voided, Scheduled, Open, Closed, Printed, Prebooked, Reserved]

subaccountId

int32

{res:itgen_vnet_subaccountid}

☐

SubID > The identifier of the subaccount.

subaccountNumber

string

{res:itgen_vnet_subaccountnumber}

☐

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

supplier_internalId

int64

Supplier Internal ID

☐

The internal id of the supplier

supplier_name

string

Supplier Name

☐

Click the magnifier. > The name.

supplier_number

string

Supplier Number

☐

Click the magnifier. > The identifier.

supplierReference

string

{res:itgen_vnet_supplierreference}

☐

The Top part > Supplier ref. > The document's original reference number as assigned by the supplier (for informational purposes).

timeStamp

byte[]

Timestamp

☐

Identifier that represents a specific version of the resource.It helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)

vatTotal

double

VAT Total

☐

The Top part > VAT total > The total amount of tax paid in the document.

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 another currency than your default.