CreditNotes: Teamleader Focus Credit Notes
read only REST
- Catalog:
Teamleader - Schema:
V2 - Primary Keys:
id - Label: Credit Notes
Can only retrieve data.
API Source
- Endpoint:
creditNotes.list
Performance Characteristics
| Characteristic | Value |
|---|---|
| Average access latency (ms) | 39 |
The result can be cached on the client.
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
credit_ |
date |
This date is inclusive. | ||
credit_ |
date |
This date is exclusive. | ||
department_ |
`` | The ID of the department you wish to filter on. | ||
invoice_ |
`` | |||
project_ |
`` | |||
updated_ |
date |
Table Columns
The columns of the table CreditNotes 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 |
|---|---|---|---|---|---|
created_ |
datetime |
Created at | filters on the platform, writable | ||
credit_ |
datetime |
Credit Note Date | filters on the platform, writable | ||
credit_ |
varchar2 |
Credit Note Number | filters on the platform, writable | ||
department_ |
varchar2 |
Department ID | filters on the platform, writable, department. |
||
department_ |
varchar2 |
Department Type | filters on the platform, writable, department. |
||
id |
varchar2 |
ID | filters on the platform, writable | ||
invoice_ |
varchar2 |
Invoice ID | filters on the platform, writable, invoice. |
||
invoice_ |
varchar2 |
Invoice Type | filters on the platform, writable, invoice. |
||
invoicee_ |
varchar2 |
Invoicee Customer ID | filters on the platform, writable, invoicee. |
||
invoicee_ |
varchar2 |
Invoicee Customer Type | filters on the platform, writable, invoicee. |
||
invoicee_ |
varchar2 |
Invoicee Name | filters on the platform, writable, invoicee. |
||
invoicee_ |
varchar2 |
Invoicee VAT Number | filters on the platform, writable, invoicee. |
||
paid |
char |
Paid | filters on the platform, writable | ||
paid_ |
datetime |
Paid at | filters on the platform, writable | ||
project_ |
varchar2 |
Project ID | filters on the platform, writable, project. |
||
status |
varchar2 |
Status | filters on the platform, writable | ||
total_ |
decimal |
Total Payable Amount | filters on the platform, writable, total. |
||
total_ |
varchar2 |
Currency of Total Payable Amount | filters on the platform, writable, total. |
||
total_ |
decimal |
Total Amount excluding Taxes | filters on the platform, writable, total. |
||
total_ |
varchar2 |
Currency of Total Amount excluding Taxes | filters on the platform, writable, total. |
||
total_ |
decimal |
Total Amount including Taxes | filters on the platform, writable, total. |
||
total_ |
varchar2 |
Currency of Total Amount including Taxes | filters on the platform, writable, total. |
||
updated_ |
datetime |
Updated At | filters on the platform, writable |
Keys
| Key | Column | Refers to | Kind | Description |
|---|---|---|---|---|
Credit |
department_ |
Departments.id |
Key | |
Credit |
invoice_ |
Invoices.id |
Key | |
Credit |
invoicee_ |
Companies.id |
Textual | The id of a row of Companies, when invoicee_customer_type is 'company'. |
Credit |
invoicee_ |
Contacts.id |
Textual | The id of a row of Contacts, when invoicee_customer_type is 'contact'. |
Referenced By
- CreditNoteTaxes
credit_note_id(Key)
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: