Navigation: Schema: SupplierDocument > Tables

SupplierDocuments: Visma.net Financials Supplier Documents

Gets a range of supplier documents - ScreenId=AP301000Get a range of Purchase Order - ScreenId=PO301000Request 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 sizeChange log:2020-May:Added forced pagination

Catalog: VismaNet

Schema: SupplierDocument

Label: Supplier Documents

The data in this table is partitioned per value of the COMPANY_CODE column.

This is a read-only table function. The Visma.net Financials API may not support changing the data or the Invantive SQL driver for Visma.net Financials does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Visma.net Financials API.

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function SupplierDocuments. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name	Data Type	Required	Documentation
COMPANY_CODE	string	☐	Partition to retrieve data from.
createdDateTime	string	☐	Creation date and time.
createdDateTimeCondition	string	☐	System-retrieved information for state/condition
documentType	string	☐	By type of document. (Waarden: Invoice, CreditAdj, DebitAdj, Prepayment)
erp-api-background	string	☐	If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.
expandApproval	boolean	☐	Set to true to include approval information.
expandNote	boolean	☐	Set to true to include description.
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.Please use a page size 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.
project	string	☐	Filter by 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 (Waarden: Hold, Balanced, Voided, Scheduled, Open, Closed, Printed, Prebooked, Reserved)

Columns of Table Function

The columns of the table function SupplierDocuments are shown below. Each column has an SQL data type.

Name	Data Type	Label	Required	Documentation
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	☐	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	string	Description	☐	The Top part > Description > A user-provided description for this supplier ledger document.
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	string	Error Message	☐
financialPeriod	string	Financial Period	☐	The financial period to which the transactions recorded in the document should be posted. Format YYYYMM.
lastModifiedDateTime	datetime	Last Modified	☐
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	☐	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		☐	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	☐
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]
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.
supplier_name	string	Supplier Name	☐	Click the magnifier. > The name.
supplier_number	string	Supplier Number	☐	Click the magnifier. > The identifier.
supplierReference	string		☐	The Top part > Supplier ref. > The document's original reference number as assigned by the supplier (for informational purposes).
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.

22-12-2022 21:03 Version 22.1.101-BETA+3681

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.

Please enable JavaScript to view this site.

Visma.net Financials API Data Model

SupplierDocuments: Visma.net Financials Supplier Documents

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information