invantive documentation
Invantive Support ForumsLog In / Sign Up

SupplierInvoiceLinesByTypeDocumentTypeInvoiceNumber: Visma.net Financials Supplier Invoice Lines by Type Document Type Invoice Number

read only REST

  • Catalog: VismaNet
  • Schema: SupplierInvoice
  • Label: Supplier Invoice Lines by Type Document Type Invoice Number

Get a specific Invoice, DebitAdj, CreditAdj or Prepayment Data for a single invoice. The response headers include an ETag after a successful GET operation.

Can only retrieve data.

Summary

Data for a single invoice.

The response headers include an ETag after a successful GET operation.

API Source

  • Endpoint: /v1/supplierInvoice/{documentType}/{invoiceNumber}
  • Operation: get /v1/supplierInvoice/{documentType}/{invoiceNumber}

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
documentType `` Identifies the Invoice
expandLandedCosts `` Expland landed costs information.
expandLinePrebookAccounts `` Expland line-level pre-booking account and sub-account information.
invoiceNumber `` Identifies the Invoice

Table Columns

The columns of the table SupplierInvoiceLinesByTypeDocumentTypeInvoiceNumber 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 writable, account.active
account_description varchar2 Account Description writable, account.description Name of item/description
account_externalCode1 varchar2 Account External Code 1 writable, account.externalCode1 Account class > The identifier of the account class.
account_externalCode2 varchar2 Account External Code 2 writable, account.externalCode2 Account class > The name of the account class.
account_number varchar2 Account Number writable, account.number Number of item
account_type varchar2 Account Type writable, account.type Account > The account number.
amount double Amount filters on the platform, writable, ::ancestor.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 varchar2 Approval Details Attachment ID filters on the platform, writable, ::ancestor.approvalDetails.attachmentID The Approval details tab > Default document > The default document that includes the payments requiring approval.
approvalDetails_comment varchar2 Approval Details Comment filters on the platform, writable, ::ancestor.approvalDetails.comment The Approval details tab > Comment > The comment connected with the approval of the payments.
approvalStatus varchar2 Approval Status filters on the platform, writable, ::ancestor.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, ::ancestor.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, ::ancestor.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 writable, branchNumber.name Click the magnifier. > The name.
branchNumber_name_2 varchar2 Branch Number Name 2 filters on the platform, writable, ::ancestor.branchNumber.name Click the magnifier. > The name.
branchNumber_number varchar2 Branch Number writable, branchNumber.number Click the magnifier. > The identifier.
branchNumber_number_2 varchar2 Branch Number 2 filters on the platform, writable, ::ancestor.branchNumber.number Click the magnifier. > The identifier.
buyerReference varchar2 Buyer Reference filters on the platform, writable, ::ancestor.buyerReference The Top part > Supplier ref. > The document's original reference number as assigned by the supplier (for informational purposes).
cashAccount varchar2 Cash Account filters on the platform, writable, ::ancestor.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, ::ancestor.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.
cashDiscountDate datetime Cash Discount Date filters on the platform, writable, ::ancestor.cashDiscountDate 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 filters on the platform, writable, ::ancestor.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, ::ancestor.closedFinancialPeriod Format YYYYMM.
cost double Cost writable, cost The table > Cost > The unit cost of the item or service received from the supplier.
costInCurrency double itgen_vnet_costincurrency writable, costInCurrency Background calculation giving you the Cost in the selected currency.This field is applicable if the amount is given in a another currency than your default.
createdDateTime datetime Created filters on the platform, writable, ::ancestor.createdDateTime
creditTerms_description varchar2 Credit Terms Description filters on the platform, writable, ::ancestor.creditTerms.description Click on the magnifier. > The description.
creditTerms_id varchar2 Credit Terms ID filters on the platform, writable, ::ancestor.creditTerms.id Click on the magnifier. > The identifier.
currencyId varchar2 Currency ID filters on the platform, writable, ::ancestor.currencyId The Top part > Currency > The currency of the document.
curyRetainageAmt double itgen_vnet_curyretainageamt writable, curyRetainageAmt
curyRetainageTotal double itgen_vnet_curyretainagetotal filters on the platform, writable, ::ancestor.curyRetainageTotal
curyRetainageUnreleasedAmt double itgen_vnet_curyretainageunreleasedamt filters on the platform, writable, ::ancestor.curyRetainageUnreleasedAmt
date datetime Date filters on the platform, writable, ::ancestor.date The Top part > Date* > The date of the original supplier ledger document; by default, it is the current date, which can be changed.
deferralCode varchar2 itgen_vnet_deferralcode writable, deferralCode The table > Deferral code > The deferral code assigned to the stock item or non-stock item specified in this document line.
deferralSchedule int32 itgen_vnet_deferralschedule writable, deferralSchedule The table > Original deferral schedule > A read-only column filled in by the system in the Debit adjustment documents created by the reversing process.It shows the ID of the deferral schedule associated with the original document (such as a purchase invoice).
deferralScheduleNbr varchar2 itgen_vnet_deferralschedulenbr writable, deferralScheduleNbr The public CD/Code of the deferral schedule visible to user
description varchar2 Description filters on the platform, writable, ::ancestor.description The Top part > Description > A user-provided description for this supplier ledger document.
detailTotal double Detail Total filters on the platform, writable, ::ancestor.detailTotal The Top part > Detail total > The document total as specified in the Document details tab.
detailTotalInCurrency double Detail Total in Currency filters on the platform, writable, ::ancestor.detailTotalInCurrency 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.
discountAmount double itgen_vnet_discountamount writable, discountAmount The table > Discount amount > The amount of the line-level discount that has been applied manually or automatically to this line.
discountAmountInCurrency double itgen_vnet_discountamountincurrency writable, discountAmountInCurrency Background calculation giving you the Discount amount in the selected currency.This field is applicable if the amount is given in a another currency than your default.
discountPercent double Discount Percent writable, discountPercent The table > Discount percent > The percent of the line-level discount that has been applied manually or automatically.
discountTotal double Discount Total filters on the platform, writable, ::ancestor.discountTotal The Top part > Discount total > The discount total calculated for the document. This total includes discounts of the Group and Document levels.
discountTotalInCurrency double Discount Total in Currency filters on the platform, writable, ::ancestor.discountTotalInCurrency 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.
discountUnitCost double itgen_vnet_discountunitcost writable, discountUnitCost Background calculation giving you the Discount unit cost in the default currency.
discountUnitCostInCurrency double itgen_vnet_discountunitcostincurrency writable, discountUnitCostInCurrency Background calculation giving you the Discount unit cost in the selected currency.This field is applicable if the amount is given in a another currency than your default.
documentType varchar2 Document Type filters on the platform, writable, ::ancestor.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.
documentVersionNumber int64 itgen_vnet_documentversionnumber filters on the platform, writable, ::ancestor.documentVersionNumber
dueDate datetime Due Date filters on the platform, writable, ::ancestor.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, ::ancestor.errorInfo
exchangeRate double Exchange Rate filters on the platform, writable, ::ancestor.exchangeRate The Top part > Currency > The currency of the document.
externalInventoryId varchar2 itgen_vnet_externalinventoryid writable, externalInventoryId The table > External inventory id > External inventory number
financialPeriod varchar2 Financial Period filters on the platform, writable, ::ancestor.financialPeriod The financial period to which the transactions recorded in the document should be posted. Format YYYYMM.
hold char Hold filters on the platform, writable, ::ancestor.hold The Top part > Hold > A check box that indicates that the status of the supplier ledger document is On hold.
holdForPayment char itgen_vnet_holdforpayment filters on the platform, writable, ::ancestor.holdForPayment The Financial details tab > The Payment information section > Hold for payment > When set to true indicates that the document is on hold for payment and cannot be applied to a supplier payment.
inventoryNumber varchar2 Inventory Number writable, inventoryNumber The table > Item ID > The unique ID of the particular item or service delivered by the supplier.
lastModifiedDateTime datetime Last Modified filters on the platform, writable, ::ancestor.lastModifiedDateTime
lineNumber int32 Line Number writable, lineNumber The table > Number at the left indicating the line number of the table.
location_countryId varchar2 Location Country ID filters on the platform, writable, ::ancestor.location.countryId Location*.
location_id varchar2 Location ID filters on the platform, writable, ::ancestor.location.id Click the magnifier > The identifier
location_name varchar2 Location Name filters on the platform, writable, ::ancestor.location.name Click the magnifier > The displayed name
manualDiscount char Manual Discount writable, manualDiscount The table > Manual discount > A check box that indicates (if selected) that the discount has been applied manually.
metadata_maxPageSize int64 Metadata Max Pagesize filters on the platform, writable, ::ancestor.metadata.maxPageSize
metadata_totalCount int64 Total Count filters on the platform, writable, ::ancestor.metadata.totalCount
note varchar2 Note writable, note The table > Icon Notes > Pop-up window for providing any user-defined text connected with to invoice.
note_2 varchar2 Note 2 filters on the platform, writable, ::ancestor.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, ::ancestor.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.
originalReferenceNumber varchar2 itgen_vnet_originalreferencenumber filters on the platform, writable, ::ancestor.originalReferenceNumber The original reference number of the document.
payDate datetime Pay Date filters on the platform, writable, ::ancestor.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.
paySelected char Pay Selected filters on the platform, writable, ::ancestor.paySelected The Financial details tab > The Payment information section > Approved for payment > When set to true indicates that the document is approved for payment.
paymentMessage varchar2 itgen_vnet_paymentmessage filters on the platform, writable, ::ancestor.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, ::ancestor.paymentMethod.description Click on the magnifier. > The description.
paymentMethod_id varchar2 Payment Method ID filters on the platform, writable, ::ancestor.paymentMethod.id Click on the magnifier. > The identifier.
paymentRefNo varchar2 Payment Reference Number filters on the platform, writable, ::ancestor.paymentRefNo The Top part > Payment ref.no > The payment reference number of the document.
poLineNr int32 itgen_vnet_polinenr writable, poLineNr The table > Purchase order line > The line number of the purchase order line linked to this line of the invoice.
poNumber varchar2 PO Number writable, poNumber The table > Purchase order number > The number of the purchase order linked to this line of the invoice.
poReceiptLineNbr int32 itgen_vnet_poreceiptlinenbr writable, poReceiptLineNbr The table > Purchase order receipt line > The line number of the purchase receipt's line that is linked to this line of the invoice.
poReceiptNbr varchar2 itgen_vnet_poreceiptnbr writable, poReceiptNbr The table > Purchase order receipt no. > The number of the purchase receipt linked to this line of the invoice.
postPeriod varchar2 Post Period filters on the platform, writable, ::ancestor.postPeriod The Top part > Post period* > The post period of the payment document. Format MMYYYY.
prebookAccount_active char itgen_vnet_prebookaccount_active writable, prebookAccount.active
prebookAccount_description varchar2 itgen_vnet_prebookaccount_description writable, prebookAccount.description Name of item/description
prebookAccount_externalCode1 varchar2 itgen_vnet_prebookaccount_externalcode1 writable, prebookAccount.externalCode1 Account class > The identifier of the account class.
prebookAccount_externalCode2 varchar2 itgen_vnet_prebookaccount_externalcode2 writable, prebookAccount.externalCode2 Account class > The name of the account class.
prebookAccount_number varchar2 itgen_vnet_prebookaccount_number writable, prebookAccount.number Number of item
prebookAccount_type varchar2 itgen_vnet_prebookaccount_type writable, prebookAccount.type Account > The account number.
prebookSubaccount_active char itgen_vnet_prebooksubaccount_active writable, prebookSubaccount.active Active > The status of the identifier.
prebookSubaccount_description varchar2 itgen_vnet_prebooksubaccount_description writable, prebookSubaccount.description Description > The description of the identifier.
prebookSubaccount_errorInfo varchar2 itgen_vnet_prebooksubaccount_errorinfo writable, prebookSubaccount.errorInfo
prebookSubaccount_lastModifiedDateTime datetime itgen_vnet_prebooksubaccount_lastmodifieddatetime writable, prebookSubaccount.lastModifiedDateTime System generated information.
prebookSubaccount_metadata_maxPageSize int64 itgen_vnet_prebooksubaccount_metadata_maxpagesize writable, prebookSubaccount.metadata.maxPageSize
prebookSubaccount_metadata_totalCount int64 itgen_vnet_prebooksubaccount_metadata_totalcount writable, prebookSubaccount.metadata.totalCount
prebookSubaccount_subaccountId int32 itgen_vnet_prebooksubaccount_subaccountid writable, prebookSubaccount.subaccountId SubID > The identifier of the subaccount.
prebookSubaccount_subaccountNumber varchar2 itgen_vnet_prebooksubaccount_subaccountnumber writable, prebookSubaccount.subaccountNumber Mandatory field: Subaccount* > The subaccount number. Format 9-XX.
prebookSubaccount_timeStamp blob itgen_vnet_prebooksubaccount_timestamp writable, prebookSubaccount.timeStamp The timestamp of the subaccount, used for concurrency control.
projectTask_description varchar2 Project Task Description writable, projectTask.description Click on the magnifier. > The description.
projectTask_id varchar2 Project Task ID writable, projectTask.id Click on the magnifier. > The identifier.
projectTask_internalId int32 itgen_vnet_projecttask_internalid writable, projectTask.internalId The internal identifier.
project_description varchar2 Project Description writable, project.description Click on the magnifier. > The description.
project_id varchar2 Project ID writable, project.id Click on the magnifier. > The identifier.
project_internalId int32 itgen_vnet_project_internalid writable, project.internalId The internal identifier.
quantity double Quantity writable, quantity The table > Quantity > The quantity of the item or service to be delivered by the supplier.
referenceNumber varchar2 Reference Number filters on the platform, writable, ::ancestor.referenceNumber
retainageApply char itgen_vnet_retainageapply filters on the platform, writable, ::ancestor.retainageApply The Top part > Apply retainage > A check box that indicates (if selected) that this invoice is an invoice with retainage.
retainagePct double Retainage Percentage writable, retainagePct
roundingDiff double Rounding Difference filters on the platform, writable, ::ancestor.roundingDiff 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 Rounding Difference in Currency filters on the platform, writable, ::ancestor.roundingDiffInCurrency 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.
splitHierarchy varchar2 itgen_vnet_splithierarchy writable, splitHierarchy The table > Split hierarchy > The number of the original row that has been split.
status varchar2 Status filters on the platform, writable, ::ancestor.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]
stockItem char Stock Item writable, stockItem Background information indicating whether the item is a stock item or not.
subaccount_active char Sub Account Active 2 writable, subaccount.active Active > The status of the identifier.
subaccount_description varchar2 Subaccount Description writable, subaccount.description Description > The description of the identifier.
subaccount_errorInfo varchar2 Sub Account Error Message writable, subaccount.errorInfo
subaccount_lastModifiedDateTime datetime Sub Account Last Modified writable, subaccount.lastModifiedDateTime System generated information.
subaccount_metadata_maxPageSize int64 Sub Account Metadata Max Pagesize writable, subaccount.metadata.maxPageSize
subaccount_metadata_totalCount int64 Sub Account Metadata Total Count writable, subaccount.metadata.totalCount
subaccount_subaccountId int32 Sub Account ID writable, subaccount.subaccountId SubID > The identifier of the subaccount.
subaccount_subaccountNumber varchar2 Sub Account Number writable, subaccount.subaccountNumber Mandatory field: Subaccount* > The subaccount number. Format 9-XX.
subaccount_timeStamp blob itgen_vnet_subaccount_timestamp writable, subaccount.timeStamp The timestamp of the subaccount, used for concurrency control.
supplierReference varchar2 itgen_vnet_supplierreference filters on the platform, writable, ::ancestor.supplierReference The Top part > Supplier ref. > The document's original reference number as assigned by the supplier (for informational purposes).
supplierTaxZone_defaultTaxCategory_description varchar2 itgen_vnet_suppliertaxzone_defaulttaxcategory_description filters on the platform, writable, ::ancestor.supplierTaxZone.defaultTaxCategory.description Name of item/description
supplierTaxZone_defaultTaxCategory_number varchar2 itgen_vnet_suppliertaxzone_defaulttaxcategory_number filters on the platform, writable, ::ancestor.supplierTaxZone.defaultTaxCategory.number Number of item
supplierTaxZone_defaultVatCategory varchar2 itgen_vnet_suppliertaxzone_defaultvatcategory filters on the platform, writable, ::ancestor.supplierTaxZone.defaultVatCategory Click the magnifier. The Default VAT category for the VAT zone of the supplier, which is specified in the AP303000 window.
supplierTaxZone_description varchar2 itgen_vnet_suppliertaxzone_description filters on the platform, writable, ::ancestor.supplierTaxZone.description Click the magnifier. The description for the VAT zone of the supplier, which is specified in the AP303000 window.
supplierTaxZone_errorInfo varchar2 itgen_vnet_suppliertaxzone_errorinfo filters on the platform, writable, ::ancestor.supplierTaxZone.errorInfo
supplierTaxZone_id varchar2 itgen_vnet_suppliertaxzone_id filters on the platform, writable, ::ancestor.supplierTaxZone.id Click the magnifier. The identifier for the VAT zone of the supplier, which is specified in the AP303000 window.
supplierTaxZone_metadata_maxPageSize int64 itgen_vnet_suppliertaxzone_metadata_maxpagesize filters on the platform, writable, ::ancestor.supplierTaxZone.metadata.maxPageSize
supplierTaxZone_metadata_totalCount int64 itgen_vnet_suppliertaxzone_metadata_totalcount filters on the platform, writable, ::ancestor.supplierTaxZone.metadata.totalCount
supplier_internalId int64 Supplier Internal ID filters on the platform, writable, ::ancestor.supplier.internalId The internal id of the supplier
supplier_name varchar2 Supplier Name filters on the platform, writable, ::ancestor.supplier.name Click the magnifier. > The name.
supplier_number varchar2 Supplier Number filters on the platform, writable, ::ancestor.supplier.number Click the magnifier. > The identifier.
taxCalculationMode varchar2 itgen_vnet_taxcalculationmode filters on the platform, writable, ::ancestor.taxCalculationMode 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)
termEndDate datetime Term End Date writable, termEndDate
termStartDate datetime Term Start Date writable, termStartDate
timeStamp blob Timestamp filters on the platform, writable, ::ancestor.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)
transactionDescription varchar2 itgen_vnet_transactiondescription writable, transactionDescription The table > Transaction descr. > Any description relevant to the transaction. An alphanumeric string of up to 30 characters may be used.
unitCost double Unit Cost writable, unitCost The table > Unit cost > The unit cost of the item.
unitCostInCurrency double itgen_vnet_unitcostincurrency writable, unitCostInCurrency Background calculation giving you the Unit cost in the selected currency.This field is applicable if the amount is given in a another currency than your default.
uom varchar2 Unit of Measure writable, uom The table > UoM > The unit of measure for the item.
vatAmount double VAT Amount filters on the platform, writable, ::ancestor.vatAmount 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.
vatCode_description varchar2 VAT Code Description writable, vatCode.description Click on the magnifier. > The description.
vatCode_id varchar2 VAT Code ID writable, vatCode.id Click on the magnifier. > The identifier.
vatExemptTotal double VAT Exempt Total filters on the platform, writable, ::ancestor.vatExemptTotal The Top part > VAT exempt total > The document total that is exempt from VAT.
vatExemptTotalInCurrency double VAT Exempt Total in Currency filters on the platform, writable, ::ancestor.vatExemptTotalInCurrency 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.
vatTaxableTotal double VAT Taxable Total filters on the platform, writable, ::ancestor.vatTaxableTotal The Top part > VAT taxable total > The document total that is subjected to VAT.
vatTaxableTotalInCurrency double VAT Taxable Total in Currency filters on the platform, writable, ::ancestor.vatTaxableTotalInCurrency 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 filters on the platform, writable, ::ancestor.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, ::ancestor.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.
withholdingTax double itgen_vnet_withholdingtax filters on the platform, writable, ::ancestor.withholdingTax The Top part > With. tax > The amount of withholding tax calculated for the document, if applicable.
withholdingTaxInCurrency double itgen_vnet_withholdingtaxincurrency filters on the platform, writable, ::ancestor.withholdingTaxInCurrency 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.

Release Notes

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