SupplierDocumentSubaccountSegments: Visma.net Financials Supplier Document Subaccount Segments
read only REST
- Catalog:
VismaNet - Schema:
SupplierDocument - Label: Supplier Document Subaccount Segments
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. | ||
balance |
`` | 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 | ||
created |
`` | 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- * yyyy- * yyyy- * yyyy- * yyyy- Note: CreatedDateTime and CreatedDateTimeCondition are mutually inclusive. |
||
created |
`` | 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. | ||
doc |
`` | 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- * yyyy- * yyyy- * yyyy- * yyyy- Note: Docate and DocDateCondition are mutually inclusive. |
||
doc |
`` | 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. | ||
document |
`` | By type of document. (Values: Invoice, CreditAdj, DebitAdj, Prepayment, Refund, Payment) | ||
due |
`` | 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- * yyyy- * yyyy- * yyyy- * yyyy- Note: DueDate and DueDateConditionCondition are mutually inclusive. |
||
due |
`` | 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. | ||
expand |
`` | Set to true to include approval information. | ||
expand |
`` | Expland line-level pre-booking account and sub-account information. | ||
expand |
`` | Set to true to include description. | ||
financial |
`` | Filter by Financial Period, format YYYYPP | ||
greater |
`` | 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 | ||
last |
`` | 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- * yyyy- * yyyy- * yyyy- * yyyy- Note: LastModifiedDateTime and LastModifiedDateTimeCondition are mutually inclusive. |
||
last |
`` | 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 SupplierDocumentSubaccountSegments 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_ |
varchar2 |
Company Code | writable | Partition code, segmenting the data. | |
COMPANY_ |
varchar2 |
Company Name | writable | Name of the partition. | |
account_ |
char |
Account Active | filters on the platform, writable, ::ancestor. |
||
account_ |
varchar2 |
Account Description | filters on the platform, writable, ::ancestor. |
Name of item/description | |
account_ |
varchar2 |
Account External Code 1 | filters on the platform, writable, ::ancestor. |
Account class > The identifier of the account class. | |
account_ |
varchar2 |
Account External Code 2 | filters on the platform, writable, ::ancestor. |
Account class > The name of the account class. | |
account_ |
varchar2 |
Account Number | filters on the platform, writable, ::ancestor. |
Number of item | |
account_ |
varchar2 |
Account Type | filters on the platform, writable, ::ancestor. |
Account > The account number. | |
active |
char |
Active | writable, ::ancestor. |
Active > The status of the identifier. | |
amount |
double |
Amount | filters on the platform, writable, ::ancestor. |
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). | |
amount |
double |
Amount in Currency | filters on the platform, writable, ::ancestor. |
An automatic calculation of the amount with the currency set as default for supplier. | |
approval |
varchar2 |
Approval Status | filters on the platform, writable, ::ancestor. |
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, ::ancestor. |
The Top part > Balance > The balance of the supplier ledger document after VAT (if inclusive) and the discount as specified in the tabs below. | |
balance |
double |
Balance in Currency | filters on the platform, writable, ::ancestor. |
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 |
varchar2 |
Branch Name | filters on the platform, writable, ::ancestor. |
Click the magnifier. > The name. | |
branch |
varchar2 |
Branch Number | filters on the platform, writable, ::ancestor. |
Click the magnifier. > The identifier. | |
branch_ |
varchar2 |
Branch Name | filters on the platform, writable, ::ancestor. |
Click the magnifier. > The name. | |
branch_ |
varchar2 |
Branch Number | filters on the platform, writable, ::ancestor. |
Click the magnifier. > The identifier. | |
cash |
varchar2 |
Cash Account | filters on the platform, writable, ::ancestor. |
Financial details tab > The payment information section > Cash account > The cash account associated with the payment method. | |
cash |
double |
Cash Discount | filters on the platform, writable, ::ancestor. |
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. | |
cash |
double |
Cash Discount in Currency | filters on the platform, writable, ::ancestor. |
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. | |
closed |
varchar2 |
Closed Financial Period | filters on the platform, writable, ::ancestor. |
Format YYYYMM. | |
created |
datetime |
Created | filters on the platform, writable, ::ancestor. |
||
currency |
varchar2 |
Currency ID | filters on the platform, writable, ::ancestor. |
The Top part > Currency > The currency of the document. | |
date |
datetime |
Date | filters on the platform, writable, ::ancestor. |
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 | writable, ::ancestor. |
Description > The description of the identifier. | |
description_ |
varchar2 |
Description 2 | filters on the platform, writable, ::ancestor. |
The Top part > Description > A user-provided description for this supplier ledger document. | |
document |
varchar2 |
Document Type | filters on the platform, writable, ::ancestor. |
The top part > Top part > Type > The type of the document. The following types are available: Purchase invoice, credit adjustment, purchase credit note, prepayment. | |
due |
datetime |
Due Date | filters on the platform, writable, ::ancestor. |
The Top part > Due date* > The date when payment for the document is due in accordance with the supplier's credit terms. | |
error |
varchar2 |
Error Message | writable, ::ancestor. |
||
error |
varchar2 |
Error Information 2 | filters on the platform, writable, ::ancestor. |
||
financial |
varchar2 |
Financial Period | filters on the platform, writable, ::ancestor. |
The financial period to which the transactions recorded in the document should be posted. Format YYYYMM. | |
last |
datetime |
Last Modified | writable, ::ancestor. |
System generated information. | |
last |
datetime |
Last Modified Date/Time 2 | filters on the platform, writable, ::ancestor. |
||
location_ |
varchar2 |
Location Country ID | filters on the platform, writable, ::ancestor. |
Location*. | |
location_ |
varchar2 |
Location ID | filters on the platform, writable, ::ancestor. |
Click the magnifier > The identifier | |
location_ |
varchar2 |
Location Name | filters on the platform, writable, ::ancestor. |
Click the magnifier > The displayed name | |
metadata_ |
int64 |
Metadata Max Pagesize | writable, ::ancestor. |
||
metadata_ |
int64 |
itgen_vnet_metadata_maxpagesize_2 | filters on the platform, writable, ::ancestor. |
||
metadata_ |
int64 |
Total Count | writable, ::ancestor. |
||
metadata_ |
int64 |
itgen_vnet_metadata_totalcount_2 | filters on the platform, writable, ::ancestor. |
||
note |
varchar2 |
Note | filters on the platform, writable, ::ancestor. |
The table > Document details tab and Applications tab > Icon Notes > Pop-up window for providing any user-defined text connected with to invoice. | |
orig |
datetime |
Original Invoice Date | filters on the platform, writable, ::ancestor. |
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. | |
pay |
datetime |
Pay Date | filters on the platform, writable, ::ancestor. |
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. | |
payment |
varchar2 |
itgen_vnet_paymentmessage | filters on the platform, writable, ::ancestor. |
The Financial details tab > The Payment information section > Payment message > The message connected with the payment. | |
payment |
varchar2 |
Payment Method Description | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The description. | |
payment |
varchar2 |
Payment Method ID | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The identifier. | |
post |
varchar2 |
Post Period | filters on the platform, writable, ::ancestor. |
The Top part > Post period* > The post period of the payment document. Format MMYYYY. | |
reference |
varchar2 |
Reference Number | filters on the platform, writable, ::ancestor. |
||
segment |
varchar2 |
itgen_vnet_segmentdescription | writable, segment |
The Segment values window > The Top part > The description of the segment. | |
segment |
int32 |
Segment ID | writable, segment |
The Segment values window > The Top part > The ID of the segment. | |
segment |
varchar2 |
Segment Value | writable, segment |
The Segment values window > The table > The value of the segment, alphanumeric. | |
segment |
varchar2 |
Segment Value Description | writable, segment |
The Segment values window > The table > The description of the segment value. | |
status |
varchar2 |
Status | filters on the platform, writable, ::ancestor. |
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 |
int32 |
itgen_vnet_subaccountid | writable, ::ancestor. |
SubID > The identifier of the subaccount. | |
subaccount |
varchar2 |
itgen_vnet_subaccountnumber | writable, ::ancestor. |
Mandatory field: Subaccount* > The subaccount number. Format 9-XX. | |
supplier |
varchar2 |
itgen_vnet_supplierreference | filters on the platform, writable, ::ancestor. |
The Top part > Supplier ref. > The document's original reference number as assigned by the supplier (for informational purposes). | |
supplier_ |
int64 |
Supplier Internal ID | filters on the platform, writable, ::ancestor. |
The internal id of the supplier | |
supplier_ |
varchar2 |
Supplier Name | filters on the platform, writable, ::ancestor. |
Click the magnifier. > The name. | |
supplier_ |
varchar2 |
Supplier Number | filters on the platform, writable, ::ancestor. |
Click the magnifier. > The identifier. | |
time |
blob |
Timestamp | writable, ::ancestor. |
The timestamp of the subaccount, used for concurrency control. | |
time |
blob |
itgen_vnet_timestamp_2 | filters on the platform, writable, ::ancestor. |
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) | |
vat |
double |
VAT Total | filters on the platform, writable, ::ancestor. |
The Top part > VAT total > The total amount of tax paid in the document. | |
vat |
double |
VAT Total in Currency | filters on the platform, writable, ::ancestor. |
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. |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: