invantive documentation
Invantive Support ForumsLog In / Sign Up

CustomerCreditWriteOffByCreditWriteOffNumber: Visma.net Financials Customer Credit Write-off by Credit Write-off Number

read only REST

  • Catalog: VismaNet
  • Schema: CustomerCreditWriteOff
  • Label: Customer Credit Write-off by Credit Write-off Number

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

Can only retrieve data.

Summary

Data for Customer Credit WriteOff

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

API Source

  • Endpoint: /v1/customerCreditWriteOff/{creditWriteOffNumber}
  • Operation: get /v1/customerCreditWriteOff/{creditWriteOffNumber}

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
creditWriteOffNumber `` Identifies the Customer Credit WriteOff

Table Columns

The columns of the table CustomerCreditWriteOffByCreditWriteOffNumber 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, account.active
account_description varchar2 Account Description filters on the platform, writable, account.description Name of item/description
account_externalCode1 varchar2 Account External Code 1 filters on the platform, writable, account.externalCode1 Account class > The identifier of the account class.
account_externalCode2 varchar2 Account External Code 2 filters on the platform, writable, account.externalCode2 Account class > The name of the account class.
account_number varchar2 Account Number filters on the platform, writable, account.number Number of item
account_type varchar2 Account Type filters on the platform, writable, account.type Account > The account number.
amount double Amount filters on the platform, writable, 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, 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.
balance double Balance filters on the platform, writable, 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.
balanceInCurrency double Balance in Currency filters on the platform, writable, 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.
branchNumber_name varchar2 Branch Name filters on the platform, writable, branchNumber.name Click the magnifier. > The name.
branchNumber_number varchar2 Branch Number filters on the platform, writable, branchNumber.number Click the magnifier. > The identifier.
cashAccount varchar2 Cash Account filters on the platform, writable, 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, 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.
cashDiscountInCurrency double Cash Discount in Currency filters on the platform, writable, 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, closedFinancialPeriod Format YYYYMM.
createdDateTime datetime Created filters on the platform, writable, createdDateTime The Attachments tab > Creation time > The date the attachment was created.
currencyId varchar2 Currency ID filters on the platform, writable, 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.
customerProject varchar2 Customer Project filters on the platform, writable, customerProject The top part > Customer project no. > The customer project no. used in AutoInvoice.
customerRefNumber varchar2 Custom Reference Number filters on the platform, writable, customerRefNumber The top part > External reference > The external reference used in AutoInvoice.
customerVatZone_description varchar2 VAT Zone Description filters on the platform, writable, customerVatZone.description Click on the magnifier. > The description.
customerVatZone_id varchar2 VAT Zone ID filters on the platform, writable, customerVatZone.id Click on the magnifier. > The identifier.
customer_name varchar2 Customer Name filters on the platform, writable, customer.name Click the magnifier. > The name.
customer_number varchar2 Customer Number filters on the platform, writable, customer.number
documentDate datetime Document Date filters on the platform, writable, 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.
documentType varchar2 Document Type filters on the platform, writable, documentType The top part > Type > The document type. The following types are available: invoice, debit note, credit note, overdue charge, credit write-off
errorInfo varchar2 Error Message filters on the platform, writable, errorInfo
financialPeriod varchar2 Financial Period filters on the platform, writable, 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, hold The top part > Hold > A check box that indicates if the document is a draft. A document with the On Hold status may be edited and cannot be released.
invoiceText varchar2 Invoice Text filters on the platform, writable, invoiceText The top part > Invoice text > Any user-provided description of the customer ledger document.
lastModifiedDateTime datetime Last Modified filters on the platform, writable, lastModifiedDateTime System generated field for last modification date/time of document.
location_countryId varchar2 Location Country ID filters on the platform, writable, location.countryId Location*.
location_id varchar2 Location ID filters on the platform, writable, location.id Click the magnifier > The identifier
location_name varchar2 Location Name filters on the platform, writable, location.name Click the magnifier > The displayed name
metadata_maxPageSize int64 Metadata Max Pagesize filters on the platform, writable, metadata.maxPageSize
metadata_totalCount int64 Total Count filters on the platform, writable, metadata.totalCount
note varchar2 Note filters on the platform, writable, 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, 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, paymentMethod.description Click on the magnifier. > The description.
paymentMethod_id varchar2 Payment Method ID filters on the platform, writable, paymentMethod.id Click on the magnifier. > The identifier.
postPeriod varchar2 Post Period filters on the platform, writable, postPeriod The top part > Post period > The period to which the document should be posted. Format YYYYMM.
project_description varchar2 Project Description filters on the platform, writable, project.description Click on the magnifier. > The description.
project_id varchar2 Project ID filters on the platform, writable, project.id Click on the magnifier. > The identifier.
project_internalId int32 itgen_vnet_project_internalid filters on the platform, writable, project.internalId The internal identifier.
referenceNumber varchar2 Reference Number filters on the platform, writable, referenceNumber The Top part > Ref. no. > The reference number of the customer ledger document in the system.
roundingDiff double Rounding Difference filters on the platform, writable, roundingDiff The top part > Rounding diff. > The difference between the original amount and the rounded amount.
status varchar2 Status filters on the platform, writable, 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, subaccount.active Active > The status of the identifier.
subaccount_description varchar2 Subaccount Description filters on the platform, writable, subaccount.description Description > The description of the identifier.
subaccount_errorInfo varchar2 Sub Account Error Message filters on the platform, writable, subaccount.errorInfo
subaccount_lastModifiedDateTime datetime Sub Account Last Modified filters on the platform, writable, subaccount.lastModifiedDateTime System generated information.
subaccount_metadata_maxPageSize int64 Sub Account Metadata Max Pagesize filters on the platform, writable, subaccount.metadata.maxPageSize
subaccount_metadata_totalCount int64 Sub Account Metadata Total Count filters on the platform, writable, subaccount.metadata.totalCount
subaccount_subaccountId int32 Sub Account ID filters on the platform, writable, subaccount.subaccountId SubID > The identifier of the subaccount.
subaccount_subaccountNumber varchar2 Sub Account Number filters on the platform, writable, subaccount.subaccountNumber Mandatory field: Subaccount* > The subaccount number. Format 9-XX.
subaccount_timeStamp blob itgen_vnet_subaccount_timestamp filters on the platform, writable, subaccount.timeStamp The timestamp of the subaccount, used for concurrency control.
timeStamp blob Timestamp filters on the platform, writable, 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)
vatTotal double VAT Total filters on the platform, writable, 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, 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.

Release Notes

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