invantive documentation
Invantive Support ForumsLog In / Sign Up

CustomerCreditWriteOffSubAccountSegments: Visma.net Financials Customer Credit Write-off Sub Account Segments

read only REST

  • Catalog: VismaNet
  • Schema: CustomerCreditWriteOff
  • Label: Customer Credit Write-off Sub Account Segments

Get a range of Customer Credit WriteOffs - ScreenId=AR301000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size Data for Customer Credit WriteOff

Can only retrieve data.

Summary

Data for Customer Credit WriteOff

API Source

  • Endpoint: /v1/customerCreditWriteOff
  • Operation: get /v1/customerCreditWriteOff

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
branch `` Filter by Branch
closedFinancialPeriod `` The date of the closing of the financial period.
createdDateTime `` This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present. Accepted format: * yyyy-MM-dd * yyyy-MM-dd HH:mm:ss * yyyy-MM-dd HH:mm:ss.FFF * yyyy-MM-ddTHH:mm:ss * yyyy-MM-ddTHH:mm:ss.FFF Note: CreatedDateTime and CreatedDateTimeCondition are mutually inclusive.
createdDateTimeCondition `` This value represents the condition to be applied when retrieving records. Accepted values (without the single quotes): * '>' for greater than * '<' for less than * '>=' for greater than or equal * '<=' for less than or equal Note: CreatedDateTime and CreatedDateTimeCondition are mutually inclusive.
customer `` Filter by Customer
customerRefNumber `` The top part > External reference > The external reference used in AutoInvoice.
documentDate `` This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future. Accepted format: * yyyy-MM-dd * yyyy-MM-dd * yyyy-MM-dd * yyyy-MM-dd * yyyy-MM-dd Note: DocumentDate and DocumentDateCondition are mutually inclusive.
documentDateCondition `` This value represents the condition to be applied to the Document Date when retrieving records. Accepted values (without the single quotes): * '>' for greater than * '<' for less than * '>=' for greater than or equal * '<=' for less than or equal Note: DocumentDate and DocumentDateCondition are mutually inclusive.
documentDueDate `` The date when payment for the document is due, in accordance with the credit terms.
documentDueDateCondition `` This value represents the condition to be applied to the Due Date when retrieving records. Accepted values (without the single quotes): * '>' for greater than * '<' for less than * '>=' for greater than or equal * '<=' for less than or equal
documentType `` The field is deprecated for specific customer document endpoints. It will only be usable from customer document endpoint. (Values: Invoice, DebitNote, CreditNote, Payment, VoidPayment, Prepayment, Refund, FinCharge, SmallBalanceWo, SmallCreditWo, CashSale, CashReturn, Undefined, NoUpdate)
dunningLetterDateTime `` The date and time for when the document last released a dunning letter.
dunningLetterDateTimeCondition `` Set time/date as before (<), after (>), before and including (=<) OR after and including (=>) to filter on time frame.
dunningLevel `` The dunning level of the document.
expandApplications `` True if you want to see all dunning information regarding this document.
expandAttachments `` True if you want to see all attachments regarding this document.
expandDunningInformation ``
expandInvoiceAddress `` True if you want to see all information regarding the invoice address for this document.
expandTaxDetails `` True if you want to see all VAT details regarding this document.
externalReference `` The top part > External reference > The external reference used in AutoInvoice.
financialPeriod `` The financial period to which the transactions recorded in the document is posted. Format YYYYMM.
greaterThanValue `` Greater than value. The item which is the object for this, varies from API to API.
lastModifiedDateTime `` This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present. Accepted format: * yyyy-MM-dd * yyyy-MM-dd HH:mm:ss * yyyy-MM-dd HH:mm:ss.FFF * yyyy-MM-ddTHH:mm:ss * yyyy-MM-ddTHH:mm:ss.FFF Note: LastModifiedDateTime and LastModifiedDateTimeCondition are mutually inclusive.
lastModifiedDateTimeCondition `` This value represents the condition to be applied when retrieving records. Accepted values (without the single quotes): * '>' for greater than * '<' for less than * '>=' for greater than or equal * '<=' for less than or equal Note: LastModifiedDateTime and LastModifiedDateTimeCondition are mutually inclusive.
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..
project `` The project with which the document is associated.
released `` Parameter for showing if invoice has been released or not.
status `` The status of the document. Use the dropdown to select status. (Values: Hold, Balanced, Voided, Scheduled, Open, Closed, PendingPrint, PendingEmail, CreditHold, CcHold, Reserved)

Table Columns

The columns of the table CustomerCreditWriteOffSubAccountSegments 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.::ancestor.account.active
account_description varchar2 Account Description filters on the platform, writable, ::ancestor.::ancestor.account.description Name of item/description
account_externalCode1 varchar2 Account External Code 1 filters on the platform, writable, ::ancestor.::ancestor.account.externalCode1 Account class > The identifier of the account class.
account_externalCode2 varchar2 Account External Code 2 filters on the platform, writable, ::ancestor.::ancestor.account.externalCode2 Account class > The name of the account class.
account_number varchar2 Account Number filters on the platform, writable, ::ancestor.::ancestor.account.number Number of item
account_type varchar2 Account Type filters on the platform, writable, ::ancestor.::ancestor.account.type Account > The account number.
active char Active writable, ::ancestor.active Active > The status of the identifier.
amount double Amount filters on the platform, writable, ::ancestor.::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.::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.
balance double Balance filters on the platform, writable, ::ancestor.::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.
balanceInCurrency double Balance in Currency filters on the platform, writable, ::ancestor.::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.
branchNumber_name varchar2 Branch Name filters on the platform, writable, ::ancestor.::ancestor.branchNumber.name Click the magnifier. > The name.
branchNumber_number varchar2 Branch Number filters on the platform, writable, ::ancestor.::ancestor.branchNumber.number Click the magnifier. > The identifier.
cashAccount varchar2 Cash Account filters on the platform, writable, ::ancestor.::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.::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.
cashDiscountInCurrency double Cash Discount in Currency filters on the platform, writable, ::ancestor.::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.::ancestor.closedFinancialPeriod Format YYYYMM.
createdDateTime datetime Created filters on the platform, writable, ::ancestor.::ancestor.createdDateTime The Attachments tab > Creation time > The date the attachment was created.
currencyId varchar2 Currency ID filters on the platform, writable, ::ancestor.::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.
customerProject varchar2 Customer Project filters on the platform, writable, ::ancestor.::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.::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.::ancestor.customerVatZone.description Click on the magnifier. > The description.
customerVatZone_id varchar2 VAT Zone ID filters on the platform, writable, ::ancestor.::ancestor.customerVatZone.id Click on the magnifier. > The identifier.
customer_name varchar2 Customer Name filters on the platform, writable, ::ancestor.::ancestor.customer.name Click the magnifier. > The name.
customer_number varchar2 Customer Number filters on the platform, writable, ::ancestor.::ancestor.customer.number
description varchar2 Description writable, ::ancestor.description Description > The description of the identifier.
documentDate datetime Document Date filters on the platform, writable, ::ancestor.::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.
documentType varchar2 Document Type filters on the platform, writable, ::ancestor.::ancestor.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 writable, ::ancestor.errorInfo
errorInfo_2 varchar2 Error Information 2 filters on the platform, writable, ::ancestor.::ancestor.errorInfo
financialPeriod varchar2 Financial Period filters on the platform, writable, ::ancestor.::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.::ancestor.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, ::ancestor.::ancestor.invoiceText The top part > Invoice text > Any user-provided description of the customer ledger document.
lastModifiedDateTime datetime Last Modified writable, ::ancestor.lastModifiedDateTime System generated information.
lastModifiedDateTime_2 datetime Last Modified Date/Time 2 filters on the platform, writable, ::ancestor.::ancestor.lastModifiedDateTime System generated field for last modification date/time of document.
location_countryId varchar2 Location Country ID filters on the platform, writable, ::ancestor.::ancestor.location.countryId Location*.
location_id varchar2 Location ID filters on the platform, writable, ::ancestor.::ancestor.location.id Click the magnifier > The identifier
location_name varchar2 Location Name filters on the platform, writable, ::ancestor.::ancestor.location.name Click the magnifier > The displayed name
metadata_maxPageSize int64 Metadata Max Pagesize writable, ::ancestor.metadata.maxPageSize
metadata_maxPageSize_2 int64 itgen_vnet_metadata_maxpagesize_2 filters on the platform, writable, ::ancestor.::ancestor.metadata.maxPageSize
metadata_totalCount int64 Total Count writable, ::ancestor.metadata.totalCount
metadata_totalCount_2 int64 itgen_vnet_metadata_totalcount_2 filters on the platform, writable, ::ancestor.::ancestor.metadata.totalCount
note varchar2 Note filters on the platform, writable, ::ancestor.::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.::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.::ancestor.paymentMethod.description Click on the magnifier. > The description.
paymentMethod_id varchar2 Payment Method ID filters on the platform, writable, ::ancestor.::ancestor.paymentMethod.id Click on the magnifier. > The identifier.
postPeriod varchar2 Post Period filters on the platform, writable, ::ancestor.::ancestor.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, ::ancestor.::ancestor.project.description Click on the magnifier. > The description.
project_id varchar2 Project ID filters on the platform, writable, ::ancestor.::ancestor.project.id Click on the magnifier. > The identifier.
project_internalId int32 itgen_vnet_project_internalid filters on the platform, writable, ::ancestor.::ancestor.project.internalId The internal identifier.
referenceNumber varchar2 Reference Number filters on the platform, writable, ::ancestor.::ancestor.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, ::ancestor.::ancestor.roundingDiff The top part > Rounding diff. > The difference between the original amount and the rounded amount.
segmentDescription varchar2 itgen_vnet_segmentdescription writable, segmentDescription The Segment values window > The Top part > The description of the segment.
segmentId int32 Segment ID writable, segmentId The Segment values window > The Top part > The ID of the segment.
segmentValue varchar2 Segment Value writable, segmentValue The Segment values window > The table > The value of the segment, alphanumeric.
segmentValueDescription varchar2 Segment Value Description writable, segmentValueDescription The Segment values window > The table > The description of the segment value.
status varchar2 Status filters on the platform, writable, ::ancestor.::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.
subaccountId int32 itgen_vnet_subaccountid writable, ::ancestor.subaccountId SubID > The identifier of the subaccount.
subaccountNumber varchar2 itgen_vnet_subaccountnumber writable, ::ancestor.subaccountNumber Mandatory field: Subaccount* > The subaccount number. Format 9-XX.
timeStamp blob Timestamp writable, ::ancestor.timeStamp The timestamp of the subaccount, used for concurrency control.
timeStamp_2 blob itgen_vnet_timestamp_2 filters on the platform, writable, ::ancestor.::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)
vatTotal double VAT Total filters on the platform, writable, ::ancestor.::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.::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.

Keys

Key Column Refers to Kind Description
CustomerCreditWriteOffSubAccountSegments_project_id_txt project_id Projects.projectID Textual The project, or the code for no project when the document is not associated with a project; that code has no row in Projects.

Release Notes

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