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

COMPANY_CODE

string

☐

Partition to retrieve data from.

documentType

string

☑

Identifies the Invoice

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.

invoiceNumber

string

☑

Identifies the Invoice

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

☐

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_1

string

☐

Click the magnifier. > The name.

branchNumber_name

string

Branch Name

☐

Click the magnifier. > The name.

branchNumber_number_1

string

☐

Click the magnifier. > The identifier.

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.

cost

double

Cost

☐

The table > Cost > The unit cost of the item or service received from the supplier.

costInCurrency

double

☐

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

☐

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.

curyRetainageAmt

double

☐

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.

deferralCode

string

☐

The table > Deferral code > The deferral code assigned to the stock item or non-stock item specified in this document line.

deferralSchedule

int32

☐

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

string

☐

The public CD/Code of the deferral schedule visible to user

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.

discountAmount

double

☐

The table > Discount amount > The amount of the line-level discount that has been applied manually or automatically to this line.

discountAmountInCurrency

double

☐

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

☐

The table > Discount percent > The percent of the line-level discount that has been applied manually or automatically.

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.

discountUnitCost

double

☐

Background calculation giving you the Discount unit cost in the default currency.

discountUnitCostInCurrency

double

☐

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

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.

externalInventoryId

string

☐

The table > External inventory id > External inventory number

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.

inventoryNumber

string

Inventory Number

☐

The table > Item ID > The unique ID of the particular item or service delivered by the supplier.

lastModifiedDateTime

datetime

Last Modified

☐

lineNumber

int32

Line Number

☐

The table > Number at the left indicating the line number of the table.

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

manualDiscount

boolean

☐

The table > Manual discount > A check box that indicates (if selected) that the discount has been applied manually.

metadata_maxPageSize

int64

☐

metadata_totalCount

int64

Total Count

☐

note_1

string

☐

The table > Document details tab and Applications tab > Icon Notes > Pop-up window for providing any user-defined text connected with to invoice.

note

string

Note

☐

The table > 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.

poLineNr

int32

☐

The table > Purchase order line > The line number of the purchase order line linked to this line of the invoice.

poNumber

string

PO Number

☐

The table > Purchase order number > The number of the purchase order linked to this line of the invoice.

poReceiptLineNbr

int32

☐

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

string

☐

The table > Purchase order receipt no. > The number of the purchase receipt linked to this line of the invoice.

postPeriod

string

Post Period

☐

The Top part > Post period* > The post period of the payment document. Format MMYYYY.

project_description

string

Project Description

☐

Click on the magnifier. > The description.

project_id

string

Project ID

☐

Click on the magnifier. > The identifier.

projectTask_description

string

Project Task Description

☐

Click on the magnifier. > The description.

projectTask_id

string

Project Task ID

☐

Click on the magnifier. > The identifier.

quantity

double

Quantity

☐

The table > Quantity > The quantity of the item or service to be delivered by the supplier.

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.

retainagePct

double

☐

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.

splitHierarchy

string

☐

The table > Split hierarchy > The number of the original row that has been split.

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]

stockItem

boolean

Stock Item

☐

Background information indicating whether the item is a stock item or not.

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).

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

☐

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)

termEndDate

datetime

Term End Date

☐

termStartDate

datetime

Term Start Date

☐

transactionDescription

string

☐

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

☐

The table > Unit cost > The unit cost of the item.

unitCostInCurrency

double

☐

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

string

Unit of Measure

☐

The table > UoM > The unit of measure for the item.

vatAmount

double

VAT Amount

☐

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

string

VAT Code Description

☐

Click on the magnifier. > The description.

vatCode_id

string

VAT Code ID

☐

Click on the magnifier. > The identifier.

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.

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.