Visma.net Financials API Data Model
SupplierInvoiceTaxDetailLinesByApprovalDocumentId: Visma.net Financials Supplier Invoice Tax Detail Lines by Approval Document ID |
Get an invoice based on the systemId. SystemID is used for approving supplier invoices
Catalog: VismaNet
Schema: SupplierInvoice
Label: Supplier Invoice Tax Detail Lines by Approval Document ID
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 SupplierInvoiceTaxDetailLinesByApprovalDocumentId. 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 |
Default Value |
Documentation |
|---|---|---|---|---|
COMPANY_CODE |
string |
☐ |
|
Partition to retrieve data from. |
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. |
systemId |
string |
☑ |
|
SystemID referes to the approval document id created when the document is sent to approval |
Columns of Table Function
The columns of the table function SupplierInvoiceTaxDetailLinesByApprovalDocumentId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
amount |
double |
Amount |
☐ |
The Top part > Amount > The amount to be paid for the document. Equal to the amount (or to the sum of amounts) shown in the Amount column of the Document details tab. |
approvalDetails_attachmentID |
string |
|
☐ |
The Approval details tab > Default document > The default document that includes the payments requiring approval. |
approvalDetails_comment |
string |
|
☐ |
The Approval details tab > Comment > The comment connected with the approval of the payments. |
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. |
branchNumber_name |
string |
Branch Name |
☐ |
Click the magnifier. > The name. |
branchNumber_number |
string |
Branch Number |
☐ |
Click the magnifier. > The identifier. |
buyerReference |
string |
Buyer Reference |
☐ |
The Top part > Supplier ref. > The document's original reference number as assigned by the supplier (for informational purposes). |
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. |
cashDiscountDate |
datetime |
Cash Discount Date |
☐ |
The Top part > Cash discount date > The end date of the cash discount period, which the system calculates by using the supplier's 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 |
☐ |
|
creditTerms_description |
string |
Credit Terms Description |
☐ |
Click on the magnifier. > The description. |
creditTerms_id |
string |
Credit Terms ID |
☐ |
Click on the magnifier. > The identifier. |
currencyId |
string |
Currency ID |
☐ |
The Top part > Currency > The currency of the document. |
curyRetainageTotal |
double |
|
☐ |
|
curyRetainageUnreleasedAmt |
double |
|
☐ |
|
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. |
detailTotal |
double |
Detail Total |
☐ |
The Top part > Detail total > The document total as specified in the Document details tab. |
detailTotalInCurrency |
double |
Detail Total in Currency |
☐ |
Background calculation giving you the Detail total in your default currency. This field is applicable if the amount is given in another currency than your default. |
discountTotal |
double |
Discount Total |
☐ |
The Top part > Discount total > The discount total calculated for the document. This total includes discounts of the Group and Document levels. |
discountTotalInCurrency |
double |
|
☐ |
Background calculation giving you the Discount total in your default currency. This field is applicable if the amount is given in another currency than your default. |
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. |
documentVersionNumber |
int64 |
|
☐ |
|
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 |
☐ |
|
exchangeRate |
double |
Exchange Rate |
☐ |
The Top part > Currency > The currency of the document. |
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 that the status of the supplier ledger document is On hold. |
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. |
paymentRefNo |
string |
Payment Reference Number |
☐ |
The Top part > Payment ref.no > The payment reference number of the document. |
paySelected |
boolean |
|
☐ |
The Financial details tab > The Payment information section > Approved for payment > When set to true indicates that the document is approved for payment. |
postPeriod |
string |
Post Period |
☐ |
The Top part > Post period* > The post period of the payment document. Format MMYYYY. |
recordId |
int32 |
Record ID |
☐ |
The id as stored in the database. It can be used when we want to update a VAT record. |
referenceNumber |
string |
Reference Number |
☐ |
|
retainageApply |
boolean |
|
☐ |
The Top part > Apply retainage > A check box that indicates (if selected) that this invoice is an invoice with retainage. |
roundingDiff |
double |
Rounding Difference |
☐ |
The Top part > Rounding diff. > The difference between the original invoice amount (including the VAT amount calculated by the system) and rounded invoice amount (including the VAT amount modified by a user for VAT-inclusive items). |
roundingDiffInCurrency |
double |
|
☐ |
Background calculation giving you the Rounding diff. in your default currency. This field is applicable if the amount is given in another currency than your default. |
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] |
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). |
supplierTaxZone_defaultTaxCategory_description |
string |
|
☐ |
Name of item/description |
supplierTaxZone_defaultTaxCategory_number |
string |
|
☐ |
Number of item |
supplierTaxZone_defaultVatCategory |
string |
|
☐ |
Click the magnifier. The Default VAT category for the VAT zone of the supplier, which is specified in the AP303000 window. |
supplierTaxZone_description |
string |
|
☐ |
Click the magnifier. The description for the VAT zone of the supplier, which is specified in the AP303000 window. |
supplierTaxZone_errorInfo |
string |
|
☐ |
|
supplierTaxZone_id |
string |
|
☐ |
Click the magnifier. The identifier for the VAT zone of the supplier, which is specified in the AP303000 window. |
supplierTaxZone_metadata_maxPageSize |
int64 |
|
☐ |
|
supplierTaxZone_metadata_totalCount |
int64 |
|
☐ |
|
taxableAmount |
double |
Taxable Amount |
☐ |
Taxable amount > The taxable amount for the VAT, which is calculated at the document level. |
taxCalculationMode |
string |
|
☐ |
The Financial details tab > The VAT section > VAT calculation mode > The VAT calculation mode, which defines which amounts (VAT-inclusive or VAT-exclusive) should be entered in the detail lines of a document (TaxSetting, Gross, Net) |
taxId |
string |
Tax ID |
☐ |
Mandatory field: VAT ID* > The ID of the VAT applied to the document. |
vatAmount_1 |
double |
|
☐ |
The Top part > VAT amount > The VAT amount to be paid for the document. Enter this amount manually according to the VAT amount specified in the original document. |
vatAmount |
double |
VAT Amount |
☐ |
VAT > The VAT amount for the specific VAT, which is calculated at the document level. |
vatExemptTotal |
double |
VAT Exempt Total |
☐ |
The Top part > VAT exempt total > The document total that is exempt from VAT. |
vatExemptTotalInCurrency |
double |
VAT Exempt Total in Currency |
☐ |
Background calculation giving you the VAT exempt total in your default currency. This field is applicable if the amount is given in another currency than your default. |
vatId_description |
string |
|
☐ |
Name of item/description |
vatId_number |
string |
|
☐ |
Number of item |
vatRate |
double |
|
☐ |
VAT rate > The rate of the VAT. |
vatTaxableTotal |
double |
VAT Taxable Total |
☐ |
The Top part > VAT taxable total > The document total that is subjected to VAT. |
vatTaxableTotalInCurrency |
double |
VAT Taxable Total in Currency |
☐ |
Background calculation giving you the VAT taxable total in your default currency. This field is applicable if the amount is given in another currency than your default. |
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. |
withholdingTax |
double |
|
☐ |
The Top part > With. tax > The amount of withholding tax calculated for the document, if applicable. |
withholdingTaxInCurrency |
double |
|
☐ |
Background calculation giving you the With. tax 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
