CustomerCreditWriteOffs: Visma.net Financials Customer Credit Write-offs
popular read only REST
- Catalog:
VismaNet - Schema:
CustomerCreditWriteOff - Label: Customer Credit Write-offs
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 | ||
closed |
`` | The date of the closing of the financial period. | ||
created |
`` | 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- * yyyy- * yyyy- * yyyy- * yyyy- Note: CreatedDateTime and CreatedDateTimeCondition are mutually inclusive. |
||
created |
`` | 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 | ||
customer |
`` | The top part > External reference > The external reference used in AutoInvoice. | ||
document |
`` | 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- * yyyy- * yyyy- * yyyy- * yyyy- Note: DocumentDate and DocumentDateCondition are mutually inclusive. |
||
document |
`` | 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. | ||
document |
`` | The date when payment for the document is due, in accordance with the credit terms. | ||
document |
`` | 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 | ||
document |
`` | 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) | ||
dunning |
`` | The date and time for when the document last released a dunning letter. | ||
dunning |
`` | Set time/date as before (<), after (>), before and including (=<) OR after and including (=>) to filter on time frame. | ||
dunning |
`` | The dunning level of the document. | ||
expand |
`` | True if you want to see all dunning information regarding this document. | ||
expand |
`` | True if you want to see all attachments regarding this document. | ||
expand |
`` | |||
expand |
`` | True if you want to see all information regarding the invoice address for this document. | ||
expand |
`` | True if you want to see all VAT details regarding this document. | ||
external |
`` | The top part > External reference > The external reference used in AutoInvoice. | ||
financial |
`` | The financial period to which the transactions recorded in the document is posted. Format YYYYMM. | ||
greater |
`` | Greater than value. The item which is the object for this, varies from API to API. | ||
last |
`` | 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- * yyyy- * yyyy- * yyyy- * yyyy- Note: LastModifiedDateTime and LastModifiedDateTimeCondition are mutually inclusive. |
||
last |
`` | 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. | ||
payment |
`` | 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 CustomerCreditWriteOffs 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. | |
account_ |
char |
Account Active | filters on the platform, writable, account. |
||
account_ |
varchar2 |
Account Description | filters on the platform, writable, account. |
Name of item/description | |
account_ |
varchar2 |
Account External Code 1 | filters on the platform, writable, account. |
Account class > The identifier of the account class. | |
account_ |
varchar2 |
Account External Code 2 | filters on the platform, writable, account. |
Account class > The name of the account class. | |
account_ |
varchar2 |
Account Number | filters on the platform, writable, account. |
Number of item | |
account_ |
varchar2 |
Account Type | filters on the platform, writable, account. |
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. | |
amount |
double |
Amount in Currency | filters on the platform, writable, amount |
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. | |
balance |
double |
Balance in Currency | filters on the platform, writable, balance |
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. | |
branch |
varchar2 |
Branch Name | filters on the platform, writable, branch |
Click the magnifier. > The name. | |
branch |
varchar2 |
Branch Number | filters on the platform, writable, branch |
Click the magnifier. > The identifier. | |
cash |
varchar2 |
Cash Account | filters on the platform, writable, cash |
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, cash |
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. | |
cash |
double |
Cash Discount in Currency | filters on the platform, writable, cash |
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, closed |
Format YYYYMM. | |
created |
datetime |
Created | filters on the platform, writable, created |
The Attachments tab > Creation time > The date the attachment was created. | |
currency |
varchar2 |
Currency ID | filters on the platform, writable, currency |
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. | |
customer |
varchar2 |
Customer Project | filters on the platform, writable, customer |
The top part > Customer project no. > The customer project no. used in AutoInvoice. | |
customer |
varchar2 |
Custom Reference Number | filters on the platform, writable, customer |
The top part > External reference > The external reference used in AutoInvoice. | |
customer |
varchar2 |
VAT Zone Description | filters on the platform, writable, customer |
Click on the magnifier. > The description. | |
customer |
varchar2 |
VAT Zone ID | filters on the platform, writable, customer |
Click on the magnifier. > The identifier. | |
customer_ |
varchar2 |
Customer Name | filters on the platform, writable, customer. |
Click the magnifier. > The name. | |
customer_ |
varchar2 |
Customer Number | filters on the platform, writable, customer. |
||
document |
datetime |
Document Date | filters on the platform, writable, document |
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. | |
document |
varchar2 |
Document Type | filters on the platform, writable, document |
The top part > Type > The document type. The following types are available: invoice, debit note, credit note, overdue charge, credit write-off | |
error |
varchar2 |
Error Message | filters on the platform, writable, error |
||
financial |
varchar2 |
Financial Period | filters on the platform, writable, financial |
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. | |
invoice |
varchar2 |
Invoice Text | filters on the platform, writable, invoice |
The top part > Invoice text > Any user-provided description of the customer ledger document. | |
last |
datetime |
Last Modified | filters on the platform, writable, last |
System generated field for last modification date/time of document. | |
location_ |
varchar2 |
Location Country ID | filters on the platform, writable, location. |
Location*. | |
location_ |
varchar2 |
Location ID | filters on the platform, writable, location. |
Click the magnifier > The identifier | |
location_ |
varchar2 |
Location Name | filters on the platform, writable, location. |
Click the magnifier > The displayed name | |
metadata_ |
int64 |
Metadata Max Pagesize | filters on the platform, writable, metadata. |
||
metadata_ |
int64 |
Total Count | filters on the platform, writable, metadata. |
||
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. | |
orig |
datetime |
Original Invoice Date | filters on the platform, writable, orig |
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. | |
payment |
varchar2 |
Payment Method Description | filters on the platform, writable, payment |
Click on the magnifier. > The description. | |
payment |
varchar2 |
Payment Method ID | filters on the platform, writable, payment |
Click on the magnifier. > The identifier. | |
post |
varchar2 |
Post Period | filters on the platform, writable, post |
The top part > Post period > The period to which the document should be posted. Format YYYYMM. | |
project_ |
varchar2 |
Project Description | filters on the platform, writable, project. |
Click on the magnifier. > The description. | |
project_ |
varchar2 |
Project ID | filters on the platform, writable, project. |
Click on the magnifier. > The identifier. | |
project_ |
int32 |
itgen_vnet_project_internalid | filters on the platform, writable, project. |
The internal identifier. | |
reference |
varchar2 |
Reference Number | filters on the platform, writable, reference |
The Top part > Ref. no. > The reference number of the customer ledger document in the system. | |
rounding |
double |
Rounding Difference | filters on the platform, writable, rounding |
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_ |
char |
Sub Account Active 2 | filters on the platform, writable, subaccount. |
Active > The status of the identifier. | |
subaccount_ |
varchar2 |
Subaccount Description | filters on the platform, writable, subaccount. |
Description > The description of the identifier. | |
subaccount_ |
varchar2 |
Sub Account Error Message | filters on the platform, writable, subaccount. |
||
subaccount_ |
datetime |
Sub Account Last Modified | filters on the platform, writable, subaccount. |
System generated information. | |
subaccount_ |
int64 |
Sub Account Metadata Max Pagesize | filters on the platform, writable, subaccount. |
||
subaccount_ |
int64 |
Sub Account Metadata Total Count | filters on the platform, writable, subaccount. |
||
subaccount_ |
int32 |
Sub Account ID | filters on the platform, writable, subaccount. |
SubID > The identifier of the subaccount. | |
subaccount_ |
varchar2 |
Sub Account Number | filters on the platform, writable, subaccount. |
Mandatory field: Subaccount* > The subaccount number. Format 9-XX. | |
subaccount_ |
blob |
itgen_vnet_subaccount_timestamp | filters on the platform, writable, subaccount. |
The timestamp of the subaccount, used for concurrency control. | |
time |
blob |
Timestamp | filters on the platform, writable, time |
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 Total | filters on the platform, writable, vat |
The top part > VAT total > The VAT amount of the document, as defined on the VAT details tab. | |
vat |
double |
VAT Total in Currency | filters on the platform, writable, vat |
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 |
|---|---|---|---|---|
Customer |
account_ |
Accounts. |
Key | |
Customer |
branch |
Branches. |
Key | |
Customer |
currency |
Currencies.id |
Key | |
Customer |
customer |
VatZones.id |
Key | |
Customer |
customer_ |
Customers. |
Key | |
Customer |
location_ |
Countries.id |
Key | |
Customer |
payment |
PaymentMethods. |
Key | |
Customer |
project_ |
Projects. |
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: