SupplierInvoiceAttachmentsByTypeByDocumentTypeInvoiceNumber: Visma.net Financials Supplier Invoice Attachmentsby Type Document Type Invoice Number
read only REST
- Catalog:
VismaNet - Schema:
SupplierInvoice - Label: Supplier Invoice Attachmentsby 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 |
|---|---|---|---|---|
document |
`` | Identifies the Invoice | ||
expand |
`` | Expland landed costs information. | ||
expand |
`` | Expland line-level pre-booking account and sub-account information. | ||
invoice |
`` | Identifies the Invoice |
Table Columns
The columns of the table SupplierInvoiceAttachmentsByTypeByDocumentTypeInvoiceNumber 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. | |
amount |
double |
Amount | filters on the platform, writable, ::ancestor. |
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. | |
approval |
varchar2 |
Approval Details Attachment ID | filters on the platform, writable, ::ancestor. |
The Approval details tab > Default document > The default document that includes the payments requiring approval. | |
approval |
varchar2 |
Approval Details Comment | filters on the platform, writable, ::ancestor. |
The Approval details tab > Comment > The comment connected with the approval of the payments. | |
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. | |
buyer |
varchar2 |
Buyer Reference | 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). | |
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 |
datetime |
Cash Discount Date | filters on the platform, writable, ::ancestor. |
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. | |
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. |
||
credit |
varchar2 |
Credit Terms Description | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The description. | |
credit |
varchar2 |
Credit Terms ID | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The identifier. | |
currency |
varchar2 |
Currency ID | filters on the platform, writable, ::ancestor. |
The Top part > Currency > The currency of the document. | |
cury |
double |
itgen_vnet_curyretainagetotal | filters on the platform, writable, ::ancestor. |
||
cury |
double |
itgen_vnet_curyretainageunreleasedamt | filters on the platform, writable, ::ancestor. |
||
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 | filters on the platform, writable, ::ancestor. |
The Top part > Description > A user-provided description for this supplier ledger document. | |
detail |
double |
Detail Total | filters on the platform, writable, ::ancestor. |
The Top part > Detail total > The document total as specified in the Document details tab. | |
detail |
double |
Detail Total in Currency | filters on the platform, writable, ::ancestor. |
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. | |
discount |
double |
Discount Total | filters on the platform, writable, ::ancestor. |
The Top part > Discount total > The discount total calculated for the document. This total includes discounts of the Group and Document levels. | |
discount |
double |
Discount Total in Currency | filters on the platform, writable, ::ancestor. |
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. | |
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. | |
document |
int64 |
itgen_vnet_documentversionnumber | filters on the platform, writable, ::ancestor. |
||
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 | filters on the platform, writable, ::ancestor. |
||
exchange |
double |
Exchange Rate | filters on the platform, writable, ::ancestor. |
The Top part > Currency > The currency of the document. | |
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. | |
hold |
char |
Hold | filters on the platform, writable, ::ancestor. |
The Top part > Hold > A check box that indicates that the status of the supplier ledger document is On hold. | |
hold |
char |
itgen_vnet_holdforpayment | filters on the platform, writable, ::ancestor. |
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. | |
id |
guid |
ID | writable, id |
The ID of the attachment | |
last |
datetime |
Last Modified | 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 | filters on the platform, writable, ::ancestor. |
||
metadata_ |
int64 |
Total Count | filters on the platform, writable, ::ancestor. |
||
name |
varchar2 |
Name | writable, name |
The name of the attachment. | |
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. | |
original |
varchar2 |
itgen_vnet_originalreferencenumber | filters on the platform, writable, ::ancestor. |
The original reference number of the document. | |
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. | |
pay |
char |
Pay Selected | filters on the platform, writable, ::ancestor. |
The Financial details tab > The Payment information section > Approved for payment > When set to true indicates that the document is approved for payment. | |
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. | |
payment |
varchar2 |
Payment Reference Number | filters on the platform, writable, ::ancestor. |
The Top part > Payment ref.no > The payment reference number of the document. | |
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. |
||
retainage |
char |
itgen_vnet_retainageapply | filters on the platform, writable, ::ancestor. |
The Top part > Apply retainage > A check box that indicates (if selected) that this invoice is an invoice with retainage. | |
revision |
int32 |
Revision | writable, revision |
The version of the attachment. | |
rounding |
double |
Rounding Difference | filters on the platform, writable, ::ancestor. |
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). | |
rounding |
double |
Rounding Difference in Currency | filters on the platform, writable, ::ancestor. |
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 |
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] | |
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 |
varchar2 |
itgen_vnet_suppliertaxzone_defaulttaxcategory_description | filters on the platform, writable, ::ancestor. |
Name of item/description | |
supplier |
varchar2 |
itgen_vnet_suppliertaxzone_defaulttaxcategory_number | filters on the platform, writable, ::ancestor. |
Number of item | |
supplier |
varchar2 |
itgen_vnet_suppliertaxzone_defaultvatcategory | filters on the platform, writable, ::ancestor. |
Click the magnifier. The Default VAT category for the VAT zone of the supplier, which is specified in the AP303000 window. | |
supplier |
varchar2 |
itgen_vnet_suppliertaxzone_description | filters on the platform, writable, ::ancestor. |
Click the magnifier. The description for the VAT zone of the supplier, which is specified in the AP303000 window. | |
supplier |
varchar2 |
itgen_vnet_suppliertaxzone_errorinfo | filters on the platform, writable, ::ancestor. |
||
supplier |
varchar2 |
itgen_vnet_suppliertaxzone_id | filters on the platform, writable, ::ancestor. |
Click the magnifier. The identifier for the VAT zone of the supplier, which is specified in the AP303000 window. | |
supplier |
int64 |
itgen_vnet_suppliertaxzone_metadata_maxpagesize | filters on the platform, writable, ::ancestor. |
||
supplier |
int64 |
itgen_vnet_suppliertaxzone_metadata_totalcount | filters on the platform, writable, ::ancestor. |
||
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. | |
tax |
varchar2 |
itgen_vnet_taxcalculationmode | filters on the platform, writable, ::ancestor. |
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) | |
time |
blob |
Timestamp | 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 Amount | filters on the platform, writable, ::ancestor. |
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. | |
vat |
double |
VAT Exempt Total | filters on the platform, writable, ::ancestor. |
The Top part > VAT exempt total > The document total that is exempt from VAT. | |
vat |
double |
VAT Exempt Total in Currency | filters on the platform, writable, ::ancestor. |
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. | |
vat |
double |
VAT Taxable Total | filters on the platform, writable, ::ancestor. |
The Top part > VAT taxable total > The document total that is subjected to VAT. | |
vat |
double |
VAT Taxable Total in Currency | filters on the platform, writable, ::ancestor. |
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. | |
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. | |
withholding |
double |
itgen_vnet_withholdingtax | filters on the platform, writable, ::ancestor. |
The Top part > With. tax > The amount of withholding tax calculated for the document, if applicable. | |
withholding |
double |
itgen_vnet_withholdingtaxincurrency | filters on the platform, writable, ::ancestor. |
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: