invantive documentation
Invantive Support ForumsLog In / Sign Up

Contacts: Bouw7 Contacts

popular read only REST

  • Catalog: Bouw7
  • Schema: Contact
  • Label: Contacts

Returns a list of contacts associated with the organization. Returns a list of contacts associated with the organization.

Can only retrieve data.

Summary

Returns a list of contacts associated with the organization.

API Source

  • Endpoint: /list/contacts
  • Operation: get /list/contacts

Performance Characteristics

Characteristic Value
Average access latency (ms) 151
Full scan rows per minute 712,000
Point query rows per minute 666

The result can be cached on the client.

Parameters

Name Data Type Required Default Documentation
q `` A Heimdall Query Language string.

Table Columns

The columns of the table Contacts 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
address varchar2 Address filters on the platform, writable, address The address.
agreedHourlyRate varchar2 Agreed Hourly Rate filters on the platform, writable, agreedHourlyRate The agreed hourly rate.
associatedPropertyAssetNames varchar2 This field is dynamically hydrated by the 'addVirtualFields'-method in the schema factory. filters on the platform, writable, associatedPropertyAssetNames All property asset names related to this contact.
caCaContactTekstgebied varchar2 CA Contact Tekstgebied filters on the platform, writable, caCaContactTekstgebied
city varchar2(256) City filters on the platform, writable, city The city name.
cocNumber varchar2(256) Chamber of Commerce Number filters on the platform, writable, cocNumber The chamber of commerce number.
contactPersonName varchar2 Contact Person Name filters on the platform, writable, contactPersonName The name of the financial contact person, Primarily used for invoicing purposes.
countryCode varchar2 Country Code filters on the platform, writable, countryCode An ISO 3166-2 representation of the country.
createdAt datetime Created at filters on the platform, writable, createdAt The creation date of the object in ATOM/ISO-8601 format
createdBy_id int64 Created by ID filters on the platform, writable, createdBy.id The ID of the user.
createdBy_username varchar2 Created by User Name filters on the platform, writable, createdBy.username The username of the user.
debtorNumber varchar2(256) Debtor Number filters on the platform, writable, debtorNumber The debtor number. Only used if the organization has no divisions.
debtorNumbers varchar2 This field is dynamically hydrated by the 'addVirtualFields'-method in the schema factory. filters on the platform, writable, debtorNumbers The deptor numbers for each contact division associated with the contact. Only available if the organization has divisions.
emailAddress varchar2(256) Email Address filters on the platform, writable, emailAddress The email address.
expirationReminder int64 Expiration Reminder filters on the platform, writable, expirationReminder The expiration reminder days.
gAccountPercentage varchar2 G-Account Percentage filters on the platform, writable, gAccountPercentage G-account percentage.
gAccountText varchar2(255) G-Account Text filters on the platform, writable, gAccountText G-account text.
glnNumber varchar2(13) GLN Number filters on the platform, writable, glnNumber The Global Location Number.
hasAccountingSoftware char This field is dynamically hydrated by the 'addVirtualFields'-method in the schema factory. filters on the platform, writable, hasAccountingSoftware Whether the contact has either Exact or Twinfield accounting software. Not applicable if the organization has divisions.
hourlyRate varchar2 Hourly Rate filters on the platform, writable, hourlyRate The hourly rate.
houseNumber varchar2 House Number filters on the platform, writable, houseNumber The house number (incl. additions).
iban varchar2(256) IBAN filters on the platform, writable, iban The IBAN account number.
id int64 ID filters on the platform, writable, id The ID of contact.
information varchar2 Information filters on the platform, writable, information Additional information about the contact.
invoiceMail varchar2 Invoice Mail filters on the platform, writable, invoiceMail The invoice email address.
invoiceSubject varchar2 Invoice Subject filters on the platform, writable, invoiceSubject The invoice subject.
invoiceUblVersion varchar2 Invoice UBL Version filters on the platform, writable, invoiceUblVersion The invoice ubl version.
isVatShifted char Is VAT Shifted filters on the platform, writable, isVatShifted True if VAT is shifted from the invoice.
mobilePhoneNumber varchar2(256) Mobile Phone Number filters on the platform, writable, mobilePhoneNumber The mobile phone number.
nAccountText varchar2(255) N-Account Text filters on the platform, writable, nAccountText N-account text.
name varchar2(256) Name filters on the platform, writable, name The contact name.
phoneNumber varchar2(256) Phone Number filters on the platform, writable, phoneNumber The phone number.
planningText varchar2 Planning Text filters on the platform, writable, planningText The planning text.
reminderMail varchar2 Reminder Mail filters on the platform, writable, reminderMail The reminder email address.
sellingHourlyRate varchar2 Selling Hourly Rate filters on the platform, writable, sellingHourlyRate The selling hourly rate.
streetName varchar2 Street Name filters on the platform, writable, streetName The street name of contact.
type_id int64 Type ID filters on the platform, writable, type.id The ID of the contact type.
type_name varchar2 Type Name filters on the platform, writable, type.name The internal name of contact type.
updatedAt datetime Updated At filters on the platform, writable, updatedAt The creation date of the object in ATOM/ISO-8601 format
updatedBy_id int64 Updated by ID filters on the platform, writable, updatedBy.id The ID of the user.
updatedBy_username varchar2 Updated by User Name filters on the platform, writable, updatedBy.username The username of the user.
vatNumber varchar2(256) VAT Number filters on the platform, writable, vatNumber The value added tax number.
wageComponentPercentage varchar2 Wage Component Percentage filters on the platform, writable, wageComponentPercentage Wage component percentage.
zipCode varchar2(20) ZIP Code filters on the platform, writable, zipCode The zip-code.

Sample Queries

--
-- Retrieve list of all Bouw7 companies.
--
-- Table documentation: https://documentation.invantive.eu/2017R2/bouw7-data-model/webhelp/bouw7-connector-contact-contacts.html
--
select *
from   Bouw7.Contact.Contacts@bow
limit  100

Release Notes

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