invantive documentation
Invantive Support ForumsLog In / Sign Up

SupplierDocuments: Visma.net Financials Supplier Documents

read only REST

  • Catalog: VismaNet
  • Schema: SupplierDocument
  • Label: Supplier Documents

Gets a range of supplier documents - ScreenId=AP301000 Get a range of Purchase Order - ScreenId=PO301000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size Change log: 2020-May:Added forced pagination

Can only retrieve data.

API Source

  • Endpoint: /v1/supplierdocument
  • Operation: get /v1/supplierdocument

Performance Characteristics

Characteristic Value
Average access latency (ms) 155
Full scan rows per minute 29,100
Point query rows per minute 387

The result can be cached on the client.

Parameters

Name Data Type Required Default Documentation
balance `` 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 `` 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 `` Filter by Branch
createdDateTime `` This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created 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: CreatedDateTime and CreatedDateTimeCondition are mutually inclusive.
createdDateTimeCondition `` 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: CreatedDateTime and CreatedDateTimeCondition are mutually inclusive.
docDate `` 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 `` 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 `` By type of document. (Values: Invoice, CreditAdj, DebitAdj, Prepayment, Refund, Payment)
dueDate `` 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 `` 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 `` Set to true to include approval information.
expandLinePrebookAccounts `` Expland line-level pre-booking account and sub-account information.
expandNote `` Set to true to include description.
financialPeriod `` Filter by Financial Period, format YYYYPP
greaterThanValue `` Greater than value. The item which is the object for this, varies from API to API.
item `` Filter by Item used into the document lines
lastModifiedDateTime `` 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 `` 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 `` Filter by the project with which the document is associated.
released `` Parameter for showing if invoice has been released or not.
status `` The status of the document (Values: Hold, Balanced, Voided, Scheduled, Open, Closed, Printed, Prebooked, Reserved)
supplier `` Filter by Supplier

Table Columns

The columns of the table SupplierDocuments are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name Data Type Label Required Marks Documentation
COMPANY_CODE varchar2(30) Company Code writable Partition code, segmenting the data.
COMPANY_NAME varchar2(240) Company Name writable Name of the partition.
account_active char Account Active filters on the platform, writable, account.active
account_description varchar2 Account Description filters on the platform, writable, account.description Name of item/description
account_externalCode1 varchar2 Account External Code 1 filters on the platform, writable, account.externalCode1 Account class > The identifier of the account class.
account_externalCode2 varchar2 Account External Code 2 filters on the platform, writable, account.externalCode2 Account class > The name of the account class.
account_number varchar2 Account Number filters on the platform, writable, account.number Number of item
account_type varchar2 Account Type filters on the platform, writable, account.type Account > The account number.
amount double Amount filters on the platform, writable, 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 filters on the platform, writable, amountInCurrency An automatic calculation of the amount with the currency set as default for supplier.
approvalStatus varchar2 Approval Status filters on the platform, writable, approvalStatus 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 filters on the platform, writable, 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 filters on the platform, writable, balanceInCurrency 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.
branchNumber_name varchar2 Branch Name filters on the platform, writable, branchNumber.name Click the magnifier. > The name.
branchNumber_number varchar2 Branch Number filters on the platform, writable, branchNumber.number Click the magnifier. > The identifier.
branch_name varchar2 Branch Name filters on the platform, writable, branch.name Click the magnifier. > The name.
branch_number varchar2 Branch Number filters on the platform, writable, branch.number Click the magnifier. > The identifier.
cashAccount varchar2 Cash Account filters on the platform, writable, cashAccount Financial details tab > The payment information section > Cash account > The cash account associated with the payment method.
cashDiscount double Cash Discount filters on the platform, writable, cashDiscount 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 filters on the platform, writable, cashDiscountInCurrency 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 varchar2 Closed Financial Period filters on the platform, writable, closedFinancialPeriod Format YYYYMM.
createdDateTime datetime Created filters on the platform, writable, createdDateTime
currencyId varchar2 Currency ID filters on the platform, writable, currencyId The Top part > Currency > The currency of the document.
date datetime Date filters on the platform, writable, 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 varchar2 Description filters on the platform, writable, description The Top part > Description > A user-provided description for this supplier ledger document.
documentType varchar2 Document Type filters on the platform, writable, documentType 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 filters on the platform, writable, dueDate The Top part > Due date* > The date when payment for the document is due in accordance with the supplier's credit terms.
errorInfo varchar2 Error Message filters on the platform, writable, errorInfo
financialPeriod varchar2 Financial Period filters on the platform, writable, financialPeriod The financial period to which the transactions recorded in the document should be posted. Format YYYYMM.
lastModifiedDateTime datetime Last Modified filters on the platform, writable, lastModifiedDateTime
location_countryId varchar2 Location Country ID filters on the platform, writable, location.countryId Location*.
location_id varchar2 Location ID filters on the platform, writable, location.id Click the magnifier > The identifier
location_name varchar2 Location Name filters on the platform, writable, location.name Click the magnifier > The displayed name
metadata_maxPageSize int64 Metadata Max Pagesize filters on the platform, writable, metadata.maxPageSize
metadata_totalCount int64 Total Count filters on the platform, writable, metadata.totalCount
note varchar2 Note filters on the platform, writable, 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 filters on the platform, writable, origInvoiceDate 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 filters on the platform, writable, payDate 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 varchar2 itgen_vnet_paymentmessage filters on the platform, writable, paymentMessage The Financial details tab > The Payment information section > Payment message > The message connected with the payment.
paymentMethod_description varchar2 Payment Method Description filters on the platform, writable, paymentMethod.description Click on the magnifier. > The description.
paymentMethod_id varchar2 Payment Method ID filters on the platform, writable, paymentMethod.id Click on the magnifier. > The identifier.
postPeriod varchar2 Post Period filters on the platform, writable, postPeriod The Top part > Post period* > The post period of the payment document. Format MMYYYY.
referenceNumber varchar2 Reference Number filters on the platform, writable, referenceNumber
status varchar2 Status filters on the platform, writable, 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]
subaccount_active char Sub Account Active 2 filters on the platform, writable, subaccount.active Active > The status of the identifier.
subaccount_description varchar2 Subaccount Description filters on the platform, writable, subaccount.description Description > The description of the identifier.
subaccount_errorInfo varchar2 Sub Account Error Message filters on the platform, writable, subaccount.errorInfo
subaccount_lastModifiedDateTime datetime Sub Account Last Modified filters on the platform, writable, subaccount.lastModifiedDateTime System generated information.
subaccount_metadata_maxPageSize int64 Sub Account Metadata Max Pagesize filters on the platform, writable, subaccount.metadata.maxPageSize
subaccount_metadata_totalCount int64 Sub Account Metadata Total Count filters on the platform, writable, subaccount.metadata.totalCount
subaccount_subaccountId int32 Sub Account ID filters on the platform, writable, subaccount.subaccountId SubID > The identifier of the subaccount.
subaccount_subaccountNumber varchar2 Sub Account Number filters on the platform, writable, subaccount.subaccountNumber Mandatory field: Subaccount* > The subaccount number. Format 9-XX.
subaccount_timeStamp blob itgen_vnet_subaccount_timestamp filters on the platform, writable, subaccount.timeStamp The timestamp of the subaccount, used for concurrency control.
supplierReference varchar2 itgen_vnet_supplierreference filters on the platform, writable, supplierReference The Top part > Supplier ref. > The document's original reference number as assigned by the supplier (for informational purposes).
supplier_internalId int64 Supplier Internal ID filters on the platform, writable, supplier.internalId The internal id of the supplier
supplier_name varchar2 Supplier Name filters on the platform, writable, supplier.name Click the magnifier. > The name.
supplier_number varchar2 Supplier Number filters on the platform, writable, supplier.number Click the magnifier. > The identifier.
timeStamp blob Timestamp filters on the platform, writable, 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 filters on the platform, writable, vatTotal The Top part > VAT total > The total amount of tax paid in the document.
vatTotalInCurrency double VAT Total in Currency filters on the platform, writable, vatTotalInCurrency 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.

Keys

Key Column Refers to Kind Description
SupplierDocuments_account_number_fk account_number Accounts.accountCD Key
SupplierDocuments_branchNumber_number_fk branchNumber_number Branches.number Key
SupplierDocuments_branch_number_fk branch_number Branches.number Key
SupplierDocuments_currencyId_fk currencyId Currencies.id Key
SupplierDocuments_location_countryId_fk location_countryId Countries.id Key
SupplierDocuments_paymentMethod_id_fk paymentMethod_id PaymentMethods.paymentMethodID Key
SupplierDocuments_supplier_internalId_fk supplier_internalId Suppliers.internalId Key
SupplierDocuments_supplier_number_fk supplier_number Suppliers.number Key

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: