invantive documentation
Invantive Support ForumsLog In / Sign Up

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_note_date_after date This date is inclusive.
credit_note_date_before date This date is exclusive.
department_id `` The ID of the department you wish to filter on.
invoice_id ``
project_id ``
updated_since 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_at datetime Created at filters on the platform, writable
credit_note_date datetime Credit Note Date filters on the platform, writable
credit_note_number varchar2 Credit Note Number filters on the platform, writable
department_id varchar2 Department ID filters on the platform, writable, department.id
department_type varchar2 Department Type filters on the platform, writable, department.type
id varchar2 ID filters on the platform, writable
invoice_id varchar2 Invoice ID filters on the platform, writable, invoice.id
invoice_type varchar2 Invoice Type filters on the platform, writable, invoice.type
invoicee_customer_id varchar2 Invoicee Customer ID filters on the platform, writable, invoicee.customer.id
invoicee_customer_type varchar2 Invoicee Customer Type filters on the platform, writable, invoicee.customer.type
invoicee_name varchar2 Invoicee Name filters on the platform, writable, invoicee.name
invoicee_vat_number varchar2 Invoicee VAT Number filters on the platform, writable, invoicee.vat_number
paid char Paid filters on the platform, writable
paid_at datetime Paid at filters on the platform, writable
project_id varchar2 Project ID filters on the platform, writable, project.id
status varchar2 Status filters on the platform, writable
total_payable_amount decimal Total Payable Amount filters on the platform, writable, total.payable.amount
total_payable_currency varchar2 Currency of Total Payable Amount filters on the platform, writable, total.payable.currency
total_tax_exclusive_amount decimal Total Amount excluding Taxes filters on the platform, writable, total.tax_exclusive.amount
total_tax_exclusive_currency varchar2 Currency of Total Amount excluding Taxes filters on the platform, writable, total.tax_exclusive.currency
total_tax_inclusive_amount decimal Total Amount including Taxes filters on the platform, writable, total.tax_inclusive.amount
total_tax_inclusive_currency varchar2 Currency of Total Amount including Taxes filters on the platform, writable, total.tax_inclusive.currency
updated_at datetime Updated At filters on the platform, writable

Keys

Key Column Refers to Kind Description
CreditNotes_department_id_fk department_id Departments.id Key
CreditNotes_invoice_id_fk invoice_id Invoices.id Key
CreditNotes_invoicee_customer_id_Companies_txt invoicee_customer_id Companies.id Textual The id of a row of Companies, when invoicee_customer_type is 'company'.
CreditNotes_invoicee_customer_id_Contacts_txt invoicee_customer_id Contacts.id Textual The id of a row of Contacts, when invoicee_customer_type is 'contact'.

Referenced By

Release Notes

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