invantive documentation
Invantive Support ForumsLog In / Sign Up

CustomerCreditNoteApplicationsByCreditNoteNumber: Visma.net Financials Customer Credit Note Applications by Credit Note Number

read only REST

  • Catalog: VismaNet
  • Schema: CustomerCreditNote
  • Label: Customer Credit Note Applications by Credit Note Number

Get a specific Customer Credit Note Data for Customer Credit Note The response headers include an ETag after a successful GET operation.

Can only retrieve data.

Summary

Data for Customer Credit Note

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

API Source

  • Endpoint: /v1/customerCreditNote/{creditNoteNumber}
  • Operation: get /v1/customerCreditNote/{creditNoteNumber}

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
creditNoteNumber `` Identifies the Customer Credit Note

Table Columns

The columns of the table CustomerCreditNoteApplicationsByCreditNoteNumber 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 filters on the platform, writable, ::ancestor.account.active
account_description varchar2 Account Description filters on the platform, writable, ::ancestor.account.description Name of item/description
account_externalCode1 varchar2 Account External Code 1 filters on the platform, writable, ::ancestor.account.externalCode1 Account class > The identifier of the account class.
account_externalCode2 varchar2 Account External Code 2 filters on the platform, writable, ::ancestor.account.externalCode2 Account class > The name of the account class.
account_number varchar2 Account Number filters on the platform, writable, ::ancestor.account.number Number of item
account_type varchar2 Account Type filters on the platform, writable, ::ancestor.account.type Account > The account number.
amount double Amount filters on the platform, writable, ::ancestor.amount The top part > Amount > The amount paid by the document. The value appears for new documents if the Validate document totals on entry check box is selected on the AR101000 window. If the check box is cleared, then the value appears when the document status is Open.
amountInCurrency double Amount in Currency filters on the platform, writable, ::ancestor.amountInCurrency Background calculation giving you the Amount in your default currency. This field is applicable if the amount is given in a another currency than your default.
amountPaid double Amount Paid writable, amountPaid
applicationDate datetime Application Date writable, applicationDate
applicationPeriod varchar2 Application Period writable, applicationPeriod
balance double Balance writable, balance
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 a another currency than your default.
balance_2 double itgen_vnet_balance_2 filters on the platform, writable, ::ancestor.balance The top part > Balance > For an open customer ledger document, the balance after any cash discount was taken. For a document used in the application process, this is the balance after the payments were applied.
branchNumber_name varchar2 Branch Name filters on the platform, writable, ::ancestor.branchNumber.name Click the magnifier. > The name.
branchNumber_number varchar2 Branch Number filters on the platform, writable, ::ancestor.branchNumber.number Click the magnifier. > The identifier.
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 on the document, which the system calculates based on 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 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.
cashDiscountTaken double itgen_vnet_cashdiscounttaken writable, cashDiscountTaken
childRecord_name varchar2 itgen_vnet_childrecord_name filters on the platform, writable, ::ancestor.childRecord.name Click the magnifier. > The name.
childRecord_number varchar2 itgen_vnet_childrecord_number filters on the platform, writable, ::ancestor.childRecord.number Click the magnifier. > The identifier.
closedFinancialPeriod varchar2 Closed Financial Period filters on the platform, writable, ::ancestor.closedFinancialPeriod Format YYYYMM.
contact_id int32 Contact ID filters on the platform, writable, ::ancestor.contact.id Click the magnifier > The identifier
contact_name varchar2 Contact Name filters on the platform, writable, ::ancestor.contact.name Click the magnifier > The displayed name
createdDateTime datetime Created filters on the platform, writable, ::ancestor.createdDateTime The Attachments tab > Creation time > The date the attachment was created.
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. By default, it is the customer’s default currency,but it can be changed if the Allow Currency Override check box is selected in the AR303000 window.
customerCD varchar2 itgen_vnet_customercd writable, customerCD
customerProject varchar2 Customer Project filters on the platform, writable, ::ancestor.customerProject The top part > Customer project no. > The customer project no. used in AutoInvoice.
customerRefNumber varchar2 Custom Reference Number filters on the platform, writable, ::ancestor.customerRefNumber The top part > External reference > The external reference used in AutoInvoice.
customerVatZone_description varchar2 VAT Zone Description filters on the platform, writable, ::ancestor.customerVatZone.description Click on the magnifier. > The description.
customerVatZone_id varchar2 VAT Zone ID filters on the platform, writable, ::ancestor.customerVatZone.id Click on the magnifier. > The identifier.
customer_name varchar2 Customer Name filters on the platform, writable, ::ancestor.customer.name Click the magnifier. > The name.
customer_number varchar2 Customer Number filters on the platform, writable, ::ancestor.customer.number
detailTotal double Detail Total filters on the platform, writable, ::ancestor.detailTotal The top part > Detail total > The document total, which the system calculates for all line items 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 a another currency than your default.
discountTotal double Discount Total filters on the platform, writable, ::ancestor.discountTotal The top part > Discount total > The document discount total.
discountTotalInCurrency double Discount Total in Currency filters on the platform, writable, ::ancestor.discountTotalInCurrency The top part > Discount total > The document discount total in your default currency. This field is applicable if the amount is given in a another currency than your default.
docType varchar2 Document Type writable, docType
documentDate datetime Document Date filters on the platform, writable, ::ancestor.documentDate The top part > Date* > The date when the customer ledger document was created. By default, for a new document, it is the current business date, but you can change the date.
documentDueDate datetime Document Due Date filters on the platform, writable, ::ancestor.documentDueDate The top part > Due date* > The date when payment for the document is due, in accordance with the credit terms.
documentType varchar2 Document Type filters on the platform, writable, ::ancestor.documentType The top part > Type > The document type. The following types are available: invoice, debit note, credit note, overdue charge, credit write-off
dontEmail char Don't Email filters on the platform, writable, ::ancestor.dontEmail
dontPrint char Don't Print filters on the platform, writable, ::ancestor.dontPrint
dunningLetterDate datetime Dunning Letter Date filters on the platform, writable, ::ancestor.dunningLetterDate The Financial details tab > The Dunning information section > Dunning letter date > The date of the last released dunning letter in which the document was listed.
dunningLetterLevel int32 Dunning Letter Level filters on the platform, writable, ::ancestor.dunningLetterLevel The Financial details tab > The Dunning information section > Dunning level > The dunning level of the document.
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 middle field, click the down arrow > Exchange rate - To change the currency rate, click the arrow by the rate to invoke the Rate selection dialog box.
externalReference varchar2 External Reference filters on the platform, writable, ::ancestor.externalReference The top part > External reference > The external reference used in AutoInvoice.
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 writable, hold
hold_2 char itgen_vnet_hold_2 filters on the platform, writable, ::ancestor.hold The top part > Hold > A check box that indicates (if selected) that the document is a draft. A document with the On Hold status may be edited and cannot be released.
invoiceAddress_addressId int32 Invoice Address ID filters on the platform, writable, ::ancestor.invoiceAddress.addressId
invoiceAddress_addressLine1 varchar2 Invoice Address Line 1 filters on the platform, writable, ::ancestor.invoiceAddress.addressLine1 Address 1 > The first line of the customer's contact address.
invoiceAddress_addressLine2 varchar2 Invoice Address Line 2 filters on the platform, writable, ::ancestor.invoiceAddress.addressLine2 Address 2 > The second line of the address.
invoiceAddress_addressLine3 varchar2 Invoice Address Line 3 filters on the platform, writable, ::ancestor.invoiceAddress.addressLine3 Address 3 > The third line of the address.
invoiceAddress_city varchar2 Invoice Address City filters on the platform, writable, ::ancestor.invoiceAddress.city City > The city.
invoiceAddress_country_errorInfo varchar2 Invoice Address Country Error Information filters on the platform, writable, ::ancestor.invoiceAddress.country.errorInfo
invoiceAddress_country_id varchar2 Invoice Address Country ID filters on the platform, writable, ::ancestor.invoiceAddress.country.id Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166.
invoiceAddress_country_metadata_maxPageSize int64 itgen_vnet_invoiceaddress_country_metadata_maxpagesize filters on the platform, writable, ::ancestor.invoiceAddress.country.metadata.maxPageSize
invoiceAddress_country_metadata_totalCount int64 itgen_vnet_invoiceaddress_country_metadata_totalcount filters on the platform, writable, ::ancestor.invoiceAddress.country.metadata.totalCount
invoiceAddress_country_name varchar2 Invoice Address Country Name filters on the platform, writable, ::ancestor.invoiceAddress.country.name Mandatory field: Country name* > The complete name of the country.
invoiceAddress_county_id varchar2 Invoice Address County ID filters on the platform, writable, ::ancestor.invoiceAddress.county.id Click the magnifier > The identifier
invoiceAddress_county_name varchar2 Invoice Address County Name filters on the platform, writable, ::ancestor.invoiceAddress.county.name Click the magnifier > The displayed name
invoiceAddress_overrideAddress char itgen_vnet_invoiceaddress_overrideaddress filters on the platform, writable, ::ancestor.invoiceAddress.overrideAddress Override address > A check box that indicates (if selected) that the invoice address is not the default invoice address of the customer.
invoiceAddress_postalCode varchar2 Invoice Address Postal Code filters on the platform, writable, ::ancestor.invoiceAddress.postalCode Postcode > The postcode.
invoiceContact_attention varchar2 Invoice Contact Attention filters on the platform, writable, ::ancestor.invoiceContact.attention
invoiceContact_businessName varchar2 itgen_vnet_invoicecontact_businessname filters on the platform, writable, ::ancestor.invoiceContact.businessName
invoiceContact_contactId int32 Invoice Contact ID filters on the platform, writable, ::ancestor.invoiceContact.contactId
invoiceContact_email varchar2 Invoice Contact Email Address filters on the platform, writable, ::ancestor.invoiceContact.email
invoiceContact_overrideContact char itgen_vnet_invoicecontact_overridecontact filters on the platform, writable, ::ancestor.invoiceContact.overrideContact
invoiceContact_phone1 varchar2 Invoice Contact Phone 1 filters on the platform, writable, ::ancestor.invoiceContact.phone1
invoiceText varchar2 Invoice Text writable, invoiceText
invoiceText_2 varchar2 itgen_vnet_invoicetext_2 filters on the platform, writable, ::ancestor.invoiceText The top part > Invoice text > Any user-provided description of the customer ledger document.
isRotRutDeductible char itgen_vnet_isrotrutdeductible filters on the platform, writable, ::ancestor.isRotRutDeductible The top part > Domestic services deductible document > A check box indicating if the document is Rot/rut deductible (applicable for the Swedish markets)
lastModifiedDateTime datetime Last Modified filters on the platform, writable, ::ancestor.lastModifiedDateTime System generated field for last modification date/time of document.
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
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 filters on the platform, writable, ::ancestor.note Icon Notes on top of the window > Pop-up window for providing any user-defined text connected to the document.
origInvoiceDate datetime Original Invoice Date filters on the platform, writable, ::ancestor.origInvoiceDate The top part > Orig invoice date > The date based on which the Due date and Cash discount date is calculated. Only used if setting "Use Orig Invoice Date" is active in AR Preferences. By default, for a new document, it is the current business date, but you can change the date.
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.
paymentRef varchar2 Payment Reference writable, paymentRef
paymentReference varchar2 Payment Reference filters on the platform, writable, ::ancestor.paymentReference ///The top part > Payment ref. > The reference number of the document, as automatically generated by the system in accordance with the number series assigned to cash sales in the Customer ledger preferences window..
pendingPPD char itgen_vnet_pendingppd writable, pendingPPD
postPeriod varchar2 Post Period filters on the platform, writable, ::ancestor.postPeriod The top part > Post period > The period to which the document should be posted. Format YYYYMM.
ppdCrMemoRefNbr varchar2 itgen_vnet_ppdcrmemorefnbr writable, ppdCrMemoRefNbr
project_description varchar2 Project Description filters on the platform, writable, ::ancestor.project.description Click on the magnifier. > The description.
project_id varchar2 Project ID filters on the platform, writable, ::ancestor.project.id Click on the magnifier. > The identifier.
project_internalId int32 itgen_vnet_project_internalid filters on the platform, writable, ::ancestor.project.internalId The internal identifier.
refNbr varchar2 Reference Number writable, refNbr
referenceNumber varchar2 Reference Number filters on the platform, writable, ::ancestor.referenceNumber The Top part > Ref. no. > The reference number of the customer ledger document in the system.
released char Released writable, released
revoked char Revoke filters on the platform, writable, ::ancestor.revoked
roundingDiff double Rounding Difference filters on the platform, writable, ::ancestor.roundingDiff The top part > Rounding diff. > The difference between the original amount and the rounded amount.
salesPersonDescr varchar2 Sales Person Name filters on the platform, writable, ::ancestor.salesPersonDescr The field is deprecated for customer document endpoints, please use SalesPerson instead
salesPersonID int32 Sales Person ID filters on the platform, writable, ::ancestor.salesPersonID The field is deprecated for customer document endpoints, please use SalesPerson instead
salesPerson_description varchar2 Sales Person Description filters on the platform, writable, ::ancestor.salesPerson.description Click on the magnifier. > The description.
salesPerson_id varchar2 Sales Person ID filters on the platform, writable, ::ancestor.salesPerson.id Click on the magnifier. > The identifier.
sendToAutoInvoice char Send to Auto-invoice filters on the platform, writable, ::ancestor.sendToAutoInvoice The Attachment tab > Send the file to AutoInvoice > The selected files will be attached to the invoice.
status varchar2 Status writable, status
status_2 varchar2 itgen_vnet_status_2 filters on the platform, writable, ::ancestor.status The top part > Status > The status of the document, which can be one of the following: Hold, Balanced, Voided, Scheduled, Open, Closed, Pending print, Pending email.
subaccount_active char Sub Account Active 2 filters on the platform, writable, ::ancestor.subaccount.active Active > The status of the identifier.
subaccount_description varchar2 Subaccount Description filters on the platform, writable, ::ancestor.subaccount.description Description > The description of the identifier.
subaccount_errorInfo varchar2 Sub Account Error Message filters on the platform, writable, ::ancestor.subaccount.errorInfo
subaccount_lastModifiedDateTime datetime Sub Account Last Modified filters on the platform, writable, ::ancestor.subaccount.lastModifiedDateTime System generated information.
subaccount_metadata_maxPageSize int64 Sub Account Metadata Max Pagesize filters on the platform, writable, ::ancestor.subaccount.metadata.maxPageSize
subaccount_metadata_totalCount int64 Sub Account Metadata Total Count filters on the platform, writable, ::ancestor.subaccount.metadata.totalCount
subaccount_subaccountId int32 Sub Account ID filters on the platform, writable, ::ancestor.subaccount.subaccountId SubID > The identifier of the subaccount.
subaccount_subaccountNumber varchar2 Sub Account Number filters on the platform, writable, ::ancestor.subaccount.subaccountNumber Mandatory field: Subaccount* > The subaccount number. Format 9-XX.
subaccount_timeStamp blob itgen_vnet_subaccount_timestamp filters on the platform, writable, ::ancestor.subaccount.timeStamp The timestamp of the subaccount, used for concurrency control.
timeStamp blob Timestamp filters on the platform, writable, ::ancestor.timeStamp
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. This total is calculated as the taxable amount for the tax with the Include in VAT Exempt Total check box selected on the Taxes form.This box is available only if the VAT Reporting feature is enabled in your system.
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 a 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 a another currency than your default.
vatTotal double VAT Total filters on the platform, writable, ::ancestor.vatTotal The top part > VAT total > The VAT amount of the document, as defined on the VAT details tab.
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 a another currency than your default.
voided char itgen_vnet_voided writable, voided

Release Notes

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