Extracting Employee Data with the BambooHR API - Practical Examples.

Apideck Documentation Page

API Changelog

This represents a log of all changes to the Apideck APIs.

v10.8.1 - (2024-11-12)

HRIS API

  • Added status field to jobs for Employee schema.

v10.8.0 - (2024-10-30)

Vault API

  • Added createCallbackState endpoint to Create Callback State to create a short-lived state for callback requests.

v10.7.7 - (2024-10-22)

Accounting API

  • Added new field subsidiaries to Ledger Accounts, including support for Netsuite and Sage Intacct connectors.

v10.7.6 - (2024-09-26)

Vault API

  • Added /vault/connections/:unified_api/:service_id/:resource/custom-mappings endpoint to retrieve all custom mappings for a connection.
  • Added /vault/custom-mappings/:unified_api/:service_id endpoint to retrieve all custom mappings for a service.

v10.7.5 - (2024-09-24)

Lead API

  • Removed min length for the field name on Unify Lead

HRIS API

  • Early-access release of the Keka connector with support for the Employee resource

v10.7.4 - (2024-09-23)

Accounting API

v10.7.3 - (2024-09-17)

Accounting API

v10.7.2 - (2024-09-03)

Accounting API

v10.7.1 - (2024-08-28)

CRM API

HRIS API

  • Added pass_through property to HRIS API.
  • Added id as optional field in Employee schema.

Accounting API

v10.7.0 - (2024-07-16)

Accounting API

v10.6.3 - (2024-07-11)

Vault API

v10.6.2 - (2024-06-25)

Accounting API

v10.6.1 - (2024-06-24)

Accounting API

v10.6.0 - (2024-06-19)

HRIS and ATS API

v10.5.0 - (2024-06-19)

Unify

v10.4.2 - (2024-05-10)

Ecommerce API

  • Added updated_since and created_since filter support for Orders.

Accounting API

  • Added created_since filter support for Invoices.

v10.4.1 - (2024-05-06)

Accounting API

  • Added opportunity_ids field to Contacts
  • Updated Balance Sheet schema.

v10.4.0 - (2024-03-26)

Accounting API

  • Add endpoints for Attachments (all, one, delete, download, upload)
  • Add support for attachments to Quickbooks
  • Add support for attachments to Xero

v10.3.6 - (2024-03-07)

Vault API

  • Remove required refresh_token when calling Import Connection operation. This allows import of ApiKey based connections as well as those with long lived tokens, or tokens that are obtained via client credentials.

v10.3.5 - (2024-03-01)

HRIS

  • Employee job is_manager field is now supported for Hibob

v10.3.4 - (2024-02-26)

Proxy

  • Schema description for Proxy request bodies [POST, PUT, PATCH] extended to allow for object, string or array.

v10.3.3 - (2024-02-23)

Vault

  • Including the connectionsToken in SDK supported operations.
  • Only connections with auth_type oauth2 and grant_type authorization_code will have the authorize_url and revoke_url in the response.

v10.3.2 - (2024-02-21)

Accounting API

Ecommerce API

  • Added sorting orders support for Wix connector

v10.3.1 - (2024-02-20)

Unify

  • When a ConnectorExecutionError occurs, we attempt to proxy as much detail from downstream as we can. An update to the UnauthorizedError Schema now correctly reflects that the downstream error can be provided as a string OR an object.

v10.3.0 - (2024-01-31)

Accounting API

  • Added all, one, create, update and delete Departments and Locations endpoint
  • Release Departments and Locations endpoint for Netsuite

v10.2.2 - (2024-01-19)

Accounting API

  • Added create, update and delete Subsidiaries endpoint
  • Release Subsidiaries endpoint for Netsuite

v10.2.1 - (2024-01-18)

Proxy API

  • Added 2 new static IPs

v10.2.0 - (2024-01-05)

Accounting API

  • Added get and list Subsidiaries endpoint
  • Release Subsidiaries endpoint for Sage Intacct

HRIS API

Issue tracking

  • Added Shortcut as an auth-only connector

CRM API

  • Updated filtering & sorting for Activities for Salesforce
  • Updated filtering & sorting for Opportunities for Salesforce
  • Added filtering for Activities for Pipedrive

Ecommerce API

v10.1.3 - (2023-12-18)

HRIS API

  • Release of the Holded connector with support for the Employee resources
  • Added manager info for an employee for AFAS
  • Improved employee mapping for BambooHR
  • Improved employee mapping for NMBRS

Issue tracking

  • Added Basecamp as an auth-only connector

Connector API

v10.1.2 - (2023-12-12)

Accounting API

  • Improved the write Journal Entry mapping for Netsuite
  • Added company_id to the Journal Entry model
  • Added the option to enter Sender ID & Password in Vault for Sage Intacct

CRM API

v10.1.1 - (2023-12-06)

HRIS API

  • Overall improvements of the coverage for department properties for integrations: Gusto, Cascade HR

CRM API

  • Added sorting capabilities for the Unify Activities
  • Added filtering by company_id, owner_id, contact_id for the Unify resource Activity
  • Added filtering by owner_id, primary_contact_id for the Unify resource Opportunity
  • Added sorting & filtering for Opportunities and Activities for Microsoft Dynamics CRM
  • Added mapping for reading/writing Notes for Microsoft Dynamics CRM
  • Added mapping for reading/writing Notes for Close
  • Removed minLength for a Unify Contact

Accounting API

  • Added the option to write Journal Entries for Netsuite
  • Added the option to write Journal Entries for Sage Intacct
  • Improved the Xero mapping for Bills

v10.1.0 - (2023-12-04)

Ecommerce API

  • Added customer_id filter to E-Commerce: Orders

HRIS API

Accounting API

  • Added write support for Journal Entries for Exact Online
  • Added filtering & sorting options for Netsuite

Proxy API

  • Added automatic HMAC authentication for Netsuite

Ecommerce API

ATS API

  • Added support for writing Job applications for Teamtailor

CRM API

  • Added Attio as auth-only integration

v10.0.1 - (2023-10-31)

Accounting API

  • remove custom_mappings from InvoiceLineItem as only belongs on root of resources

HRIS API

Filestorage API

v10.0.0 - (2023-10-24)

Unify

  • Introduction of the custom_mappings property as part of the Custom Mapping field feature

v9.9.3 - (2023-10-23)

Accounting API

HRIS API

  • Release of the CatalystOne connector with support for the resources: Employee, Department
  • Improvement of the employment status for People HR
  • Extended Rippling mapping with custom_fields and company information
  • Added custom_fields mapping for Lucca HR
  • Added custom_fields mapping for Google Workspace

File Storage API

  • Fix for the search operation for the Dropbox connector

v9.9.2 - (2023-09-29)

HRIS API

  • Corrected employees model for GetEmployeesResponse, which impacted the SDKs

v9.9.1 - (2023-09-25)

HRIS API

Accounting API

  • Added option to write journal entries and improved pagination for journal entries for Xero
  • Improved bills, tax rate, company & suppliers mapping for Quickbooks
  • Improved bill_number mapping for Sage Business Cloud
  • Improved bill_number mapping for Sage Intacct
  • Added the option to create and update invoices for Sage Business Cloud

CRM API

  • Added filter contacts by Company ID for Salesforce
  • Improved custom fields logic for companies, contacts/leads for Hubspot
  • Improved address mapping for companies for Pipedrive

ATS API

  • Added custom job board URL setting for Greenhouse

Issue tracking API

  • Added Zendesk as auth-only integration
  • Added Linear as auth-only integration
  • Added ClickUp as auth-only integration
  • Added Asana as auth-only integration
  • Added Intercom as auth-only integration
  • Added Monday as auth-only integration

v9.9.0 - (2023-08-21)

HRIS API

  • Release of the Paycheck connector with support for the resources: Employee, Department, Company

  • Early-access release of the Silae connector with support for the Employee resource

  • Early-access release of the Cegid talentsoft connector with support for the Employee resource

  • Early-access release of the Justworks connector with support for the Employee resource

  • Early-access release of the Trinet connector with support for the Employee resource

  • Enhanced additional employee resource properties with null support

  • Improved employee_status logic for Personio

  • Improved country field mapping for SD Worx

  • Extended mapping of Workday with custom fields and locations

  • Added employee_status mapping for Paylocity

  • Added custom field support for Sage HR

Issue Tracking API

  • Improved handling of null values for the Issue Tracking API

CRM API

  • Improved handling of null values for the Issue Tracking API

File Storage API

  • Improved calculation of the downloadable detection
  • Improved handling of null values for the File Storage API

E-commerce API

  • Improved handling of null values for the Ecommerce API

ATS API

  • Added the job description field to the Job resource for Greenhouse

Accounting API

  • Added category tracking support and improved the supplier mapping for Quickbooks

v9.8.1 - (2023-08-02)

ACCOUNTING API

  • Released Netsuite with additional resources: Invoices, Customers, Payments, Suppliers, Journal Entries, Ledger Accounts, Bills, Products, Credit notes, Purchase Orders

HRIS API

  • Released People HR connector with support for Employees

  • Released Deel connector with support for Employees

  • Released Employment Hero connector with support for Employees

  • Overall improvements of the coverage for employee properties for integrations: ADP Run, ADP Workforce Now, Afas, Alexis HR, BambooHr, BeatheHr, Cascade HR, Ceridian Dayforce, Deel, Employment hero, Factorial HR, Freshteam, Google Workspace, Gusto, Hibob, Humaans, Lokket, Lucca HR, Namely, Nmbrs, Officient, Payfit, Paylocity, People-hr, Personio, Rippling, Sage-hr, Sap-successfactors, Sapling, SD Worx, UKG Pro, Workday, Zenefits, Zoho-people

  • Extended employee resource properties with nullable

  • Improved employees SAP SuccessFactors mapping

  • Enhanced employees Workday mapping

  • Performance & employee mapping improvements + updated the connection guide for HiBob

  • Introduced write (create,update, delete) support for HiBob

  • Extended Breathe HR mapping for employees

  • Implemented native webhook events for Okta

Ecommmerce API

  • Changed the authentication for Shopify from OAuth to API key

CRM

  • Improved updating leads & contacts for Salesforce

v9.8.0 - (2023-07-19)

File Storage API

  • Added Export File endpoint. This endpoint lets you convert files into other formats and download them. Handy for working with Google Docs, Slides, and Sheets. Right now, it's only supported for Google Drive.

v9.7.6 - (2023-07-10)

  • Add bank_accounts support to the Employee resource.

v9.7.5 - (2023-07-05)

  • Add the payment_frequency field on the Employee compensations resource.

v9.7.4 - (2023-06-06)

  • Adding properties object to PassThroughQuery as it is required for OpenAPI Generator.

v9.7.3 - (2023-06-06)

Vault API

  • New webhook event vault.connection.revoked is now available to subscribe to. Event is broadcast when a call to revoke an access token down stream is successful.

v9.7.2 - (2023-06-05)

  • Fix webhook schema object names to align across APIs

v9.7.1 - (2023-06-03)

ACCOUNTING API

v9.7.0 - (2023-05-31)

Accounting API

Resources

Connectors

  • Added new Procountor connector
  • Added new Netvisor connector
  • Updated Quickbooks connector with Purchase Order support
  • Updated Xero connector with Purchase Order support

ATS API

Connectors

v9.6.0 - (2023-05-25)

HRIS API

  • Add the probation_period field on the Employee resource.

v9.5.0 - (2023-05-15)

Accounting API

HRIS API

v9.4.0 - (2023-05-09)

ATS API

v9.3.1 - (2023-05-07)

ATS API

v9.3.0 - (2023-04-18)

Vault API

  • Added new invalid state and new validation_support field on Connections to support connection validation.
  • Added prefix and suffix to form_fields on Connections

v9.2.0 - (2023-04-17)

HRIS API

  • Deprecate the department field in favor of the dedicated department_id and department_name field on the Employee resource.

v9.1.5 - (2023-04-17)

HRIS API

  • Improved Sage-HR mapping

Unify

  • Updated Unify specs by referencing the PassThrough query parameter required for the Unify SDKs

v9.1.4 - (2023-04-14)

Accounting API

v9.1.3 - (2023-04-13)

  • Unify shared field representing currency enum extended to include ETH

v9.1.2 - (2023-03-24)

Accounting API

  • pass_through parameter is now available on all list endpoints.
  • added terms to Credit Notes resource.
  • added rate to Tax Rates resource.

v9.1.1 - (2023-03-13)

Accounting API

  • Added discount_amount to Invoices resource and it's Line Items.

v9.1.0 - (2023-02-28)

v9.0.0 - (2023-02-24)

Connector API

  • Removed resource property in supported_events of a Connector.
  • Added resources and entity_type property in supported_events of a Connector.

v8.93.0 - (2023-02-23)

Issue Tracking API

Added the Issue Tracking API.

Resources

Webhooks

Connectors

v8.92.0 - (2023-02-22)

File Storage API

v8.91.1 - (2023-02-22)

Ecommerce API

  • Product inventory property is now a string instead of number.

Connectors

v8.91.0 - (2023-02-15)

  • Added parent and project fields to the Customer schema on Accounting.

v8.90.0 - (2023-02-15)

Ecommerce API

Added the Ecommerce API.

Resources

Connectors

v8.89.0 - (2023-02-07)

Accounting API

v8.88.0 - (2023-02-07)

CRM API

v8.87.0 - (2023-01-24)

CRM API

v8.86.0 - (2023-01-11)

Vault API

v8.85.1 - (2022-12-19)

Webhooks API

  • Added disabled_reason to Webhook to reflect when a webhook has been automatically disabled.

v8.85.0 - (2022-11-15)

Connector API

  • Added free_trial_available, signup_url and webhook_support to Connector

CRM API

v8.84.0 - (2022-11-12)

ATS API

v8.83.0 - (2022-11-10)

v8.82.0 - (2022-11-09)

v8.81.0 - (2022-11-09)

HRIS API

ATS API

v8.80.0 - (2022-11-07)

ATS API

v8.79.0 - (2022-11-07)

Procurement API

  • Added Portt auth-only connector

Expense management API

  • Moved the Web Expenses auth-only settings to connection level

Connector API

v8.78.0 - (2022-11-07)

  • Added webhooksResolve operation to the Webhooks API to provide a shorter route.

v8.77.0 - (2022-11-03)

  • Updated Orders Clover on POS with additional modifier fields on line items.

v8.76.0 - (2022-10-31)

  • Added Connection Hooks
  • Added support cor Connection based Webhooks
  • Added Connection webhook support FactorialHR

Vault API

v8.75.0 - (2022-10-28)

ACCOUNTING API

  • Added credit-notes resource to Sage Intacct.
  • Added create, update and delete operations to payments resource in Sage Intacct.
  • Added workflows to separate between receivable payments and payable payments in Sage Intacct.
  • Expanded invoices resource mapping in Sage Intacct.
  • Expanded fields to Bill, BillLineItem, CreditNote, InvoiceLineItem and Payment schemas.
  • Updated workflow client to support unified_metadata.

v8.74.0 - (2022-10-27)

Connector API

v8.73.0 - (2022-10-27)

v8.72.1 - (2022-10-24)

Accounting API

  • Updated Ledger accounts, invoice items, payments, suppliers to use [QuickBooks] SyncToken

v8.72.0 - (2022-10-18)

Accounting API

  • Added bill, resource for Sage Intacct.
  • Improved array mappings for xml cases.
  • Added new fields to the Bill schema.

v8.71.0 - (2022-10-17)

Connector API

v8.70.2 - (2022-10-14)

Vault API

v8.70.1 - (2022-10-13)

Accounting API

  • Added discount_percentage to root of Invoice object. Quickbooks has limited support for LineItem discounts, so this is a workaround to support discounts on invoices.

v8.70.0 - (2022-10-11)

HRIS API

  • Reworked Workday auth + mapping to use SOAP API

Expense management API

v8.69.0 - (2022-10-07)

HRIS API

v8.68.0 - (2022-10-06)

  • Added create, update and delete operations to credit-notes resource for [QuickBooks].

v8.67.1 - (2022-09-30)

Connector API

  • extended connector API to return nested filed level coverage

v8.67.0 - (2022-09-29)

Accounting API

  • Added display_id, created_by and updated_by fields to the Payment schema.

v8.66.0 - (2022-09-28)

  • Added filter support for employees in Loket connector.
  • Added support to filter employees by employee number.
  • Added Lucca HR connector

v8.65.0 - (2022-09-28)

HRIS API

  • Added SDWorx as an auth-only connector.

v8.64.0 - (2022-09-28)

Accounting API

  • Added NetSuite as an auth-only connector.

v8.63.0 - (2022-09-27)

  • Added the Project Management API for auth-only connectors.
  • Added JIRA as an auth-only connector.

v8.62.0 - (2022-09-27)

HRIS API

v8.61.0 - (2022-09-26)

HRIS API

v8.60.0 - (2022-09-23)

HRIS API

v8.59.0 - (2022-09-22)

Team Messaging API

v8.58.0 - (2022-09-19)

Connector API

v8.57.0 - (2022-09-13)

HRIS API

v8.56.0 - (2022-09-12)

HRIS API

  • Added Okta connector

v8.55.0 - (2022-09-12)

HRIS API

v8.54.0 - (2022-09-12)

HRIS API

v8.53.0 - (2022-09-09)

HRIS API

v8.52.1 - (2022-09-09)

  • Generalize example detail for Unprocessable Entity Error to prevent confusing when using the Mock API (sunsetted).

v8.52.0 - (2022-09-07)

v8.51.0 - (2022-09-06)

  • Expanded support for Employees for the UKG Pro connector

v8.50.0 - (2022-09-06)

v8.49.0 - (2022-09-05)

ACTION REQUIRED

Beta users should note the following breaking changes that may affect existing integrations implementing the POS API:

  • The schema description for a bank_account on the Payments object has been defined as PosBankAccount to avoid confusion with the BankAccount object in other APIs.
  • This change is backwards compatible, but we recommend updating your integrations to use the new name if you are using typed definitions.
  • Note: the properties on the PosBankAccount object have not changed. PosPayments

v8.48.0 - (2022-09-05)

v8.47.0 - (2022-09-05)

v8.46.0 - (2022-09-02)

HRIS API

v8.45.0 - (2022-09-02)

HRIS API

v8.44.0 - (2022-09-01)

HRIS API

v8.43.0 - (2022-08-30)

HRIS API

v8.42.0 - (2022-08-24)

Accounting API

  • Added sorting support to Invoices. To sort results, use the sort[by] and sort[direction] query parameters. First available sort[by] value is updated_at. Supported for Xero and Quickbooks.

v8.41.1 - (2022-08-24)

Accounting API

  • Make invoice_date and due_date nullable on Invoices

v8.41.0 - (2022-08-17)

Accounting API

v8.40.1 - (2022-08-16)

Accounting API

  • Added filter[start_date], filter[end_date] to Customers

v8.40.0 - (2022-08-15)

  • Added Mock API and SDKs to documentation for all APIs.

v8.39.1 - (2022-08-10)

Accounting API

v8.39.0 - (2022-08-09)

Connector API

v8.38.0 - (2022-08-03)

  • Added Drives resource on the File Storage API.
  • Added Drive Groups resource on the File Storage API.

v8.37.1 - (2022-07-25)

  • Mapped price_amount property on variations to Items on the POS API for the Square connector.

v8.37.0 - (2022-07-20)

  • Added modifier_groups property to Items on the POS API.

v8.36.0 - (2022-07-20)

  • Added status property to Company info on the Accounting API and for the MYOB connector.

v8.35.1 - (2022-07-20)

v8.35.0 - (2022-07-20)

v8.34.0 - (2022-07-06)

  • Added Jobs on the HRIS API

v8.33.0 - (2022-07-02)

v8.32.6 - (2022-06-24)

  • Fix faulty examples

v8.32.5 - (2022-06-21)

  • Updated Orders and Payments for the Clover connector

v8.32.4 - (2022-06-16)

  • Added filter[first_name] and filter[display_name] to to Customers
  • Added automated_sales_tax to CompanyInfo

v8.32.3 - (2022-06-15)

  • Added country, sales_tax_enabled and default_sales_tax to CompanyInfo

v8.32.2 - (2022-06-15)

Accounting API

  • Added filter[company_name], filter[last_name], filter[email] to Customers

v8.32.1 - (2022-06-08)

ATS API

  • Extended department properties on Jobs

v8.32.0 - (2022-06-03)

HRIS API

v8.31.3 - (2022-06-02)

Accounting API

v8.31.2 - (2022-06-01)

v8.31.1 - (2022-05-31)

Accounting API

ACTION REQUIRED

Beta users should note the following breaking changes that may affect existing integrations implementing the Accounting API:

  • LedgerAccount nominal_code has been deprecated in favour of code.

v8.31.0 - (2022-05-26)

CRM API

v8.30.1 - (2022-05-24)

Accounting API

v8.30.0 - (2022-05-23)

ATS API

v8.29.5 - (2022-05-19)

Accounting API

v8.29.4 - (2022-05-16)

  • Made is_primary optional for Employee jobs of HRIS API.

v8.29.3 - (2022-05-10)

  • Extended Bills with paid_date, deposit, sub_total, and total_tax. If these properties are available in downstream connector response, they will be mapped returned.

v8.29.2 - (2022-05-10)

v8.29.1 - (2022-05-06)

Accounting API

v8.29.0 - (2022-05-05)

Accounting API

v8.28.2 - (2022-05-05)

Accounting API

  • Added optional tax_code to Invoice

v8.28.1 - (2022-05-03)

POS API

v8.28.0 - (2022-05-03)

HRIS API

v8.27.2 - (2022-04-29)

HRIS API

v8.27.1 - (2022-04-27)

Vault API

  • Added docs for authorize_url and revoke_url to Connections

v8.27.0 - (2022-04-27)

v8.26.1 - (2022-04-26)

Vault API

  • Include connectionsImport when running sdk generation.

v8.26.0 - (2022-04-25)

HRIS API

v8.25.0 - (2022-04-22)

ATS API

v8.24.1 - (2022-04-21)

Accounting API

  • Updated TaxRates components.id to be string

v8.24.0 - (2022-04-20)

v8.23.0 - (2022-04-19)

v8.22.0 - (2022-04-17)

  • Added Order Types and Modifier Groups to Clover connector

v8.21.0 - (2022-04-14)

  • Added Orders to Clover connector

v8.20.0 - (2022-04-12)

Connector API

v8.19.3 - (2022-04-11)

Vault API

  • Added TokenRefreshFailed to Vault spec to include in docs

v8.19.2 - (2022-04-08)

  • Bump version to initialize PHP SDK

v8.19.1 - (2022-04-08)

  • Removed minLength: 1 limitation because responses can contain empty strings.
  • Set default value of raw parameter to false, it was true.

v8.19.0 - (2022-04-04)

Vault API

v8.18.0 - (2022-04-04)

Connector API

  • Added docs to Connector
  • Added endpoint to get the content of a Connector Doc
  • Added events, to API

v8.17.0 - (2022-03-24)

Connector API

  • Added oauth_grant_type, oauth_credentials_source and has_sandbox_credentials to Connector

v8.16.0 - (2022-03-24)

HRIS API

  • Added Departments to HRIS
  • Fixed Nmbrs birthday date format on Employees

v8.15.0 - (2022-03-23)

v8.14.0 - (2022-03-18)

Accounting API

  • Added Sage Intacct connector
  • LedgerAccounts
    • LedgerAccount.type enum extended to include balancesheet
    • Added categories property
  • AccountingCustomer
    • AccountingCustomer.status enum extended to include inactive
  • Payment
    • Payment extended with optional payment_method string

Vault API

  • Extended Connections auth_type enum to include custom.

v8.13.0 - (2022-03-09)

  • Added Items and Orders POS mapping to Square

v8.12.1 - (2022-02-18)

Accounting API

  • Added taxRatesFilter filter to TaxRates

v8.12.0 - (2022-02-16)

Vault API

  • Added oauth_grant_type property to Connections.
  • Added Token endpoint to support the client_credentials OAuth flow.

HRIS API

v8.11.1 - (2022-02-09)

Accounting API

  • optional report_tax_type property added to TaxRates

v8.11.0 - (2022-01-15)

POS API

v8.10.2 - (2022-01-12)

HRIS API

  • Moved compensations out of jobs array on Employees

v8.10.1 - (2021-12-14)

Accounting API

  • Shared Schema Address extended with optional line3 and line4 properties

  • LedgerAccounts

    • LedgerAccount.type enum extended to include other_income

  • AccountingCustomer

    • AccountingCustomer extended with websites, title, display_name, middle_name, last_name, and suffix properties

  • Invoice

    • Invoice extended with optional terms string

  • Payment

    • Payment extended with optional note string

v8.10.0 - (2021-12-05)

File Storage API

HRIS API

v8.9.0 - (2021-12-03)

ATS API

v8.8.1 - (2021-11-24)

Accounting API

  • Payments
    • Payment.reconciled added to reflect reconciliation state
    • Payment.status enum added to reflect payment state [authorised, paid, voided, deleted]
    • Payment.type enum added [ accounts_receivable, accounts_payable, accounts_receivable_credit, accounts_payable_credit, accounts_receivable_overpayment, accounts_payable_overpayment, accounts_receivable_prepayment, accounts_payable_prepayment ]

ACTION REQUIRED

Accounting API

Beta users should note the following breaking changes that may affect existing integrations implementing the Accounting API:

  • Payments accounts_receivable_account_type and accounts_receivable_account_id have been deprecated in favour of a single account object.

v8.8.0 - (2021-11-18)

File Storage API

v8.7.1 - (2021-11-16)

Accounting API

  • added BankAccount.account_type and BankAccount.currency. Account type is an enum [bank_account, credit_card, other]

  • LedgerAccounts

    • LedgerAccount.type enum extended to include fixed_asset and revenue
    • LedgerAccount.status added to reflect downstream provider who allow different states (soft delete) [active, inactive, archived]

  • InvoiceItems

    • InvoiceItem.purchase_details added to reflect purchase cost detail on an item
    • InvoiceItem.tracked added to indicate whether or not the item is tracked via inventory
    • InvoiceItem.asset_account added to reflect the asset account that this item should be related to.
    • InvoiceItem.purchased boolean added to indicate whether or not the item is available for purchase transactions

v8.7.0 - (2021-11-15)

File Storage API

v8.6.0 - (2021-11-11)

ACTION REQUIRED

Accounting API

Beta users should note the following breaking changes that may affect existing integrations implementing the Accounting API:

  • Type of TaxRates tax_type has been deprecated to facilitate migrating from an enum to string using new TaxRate.type. Values sent via TaxRate.type should be aligned with any downstream connector requirements.

v8.5.0 - (2021-11-09)

File Storage API

v8.4.1 - (2021-11-08)

File Storage API

  • Added sorting support to Files. To sort results, use the sort[by] and sort[direction] query parameters. Available sort[by] values are name and updated_at.

v8.4.0 - (2021-11-04)

v8.3.2 - (2021-11-03)

Accounting API

  • Extend InvoiceItems to include income_account and expense_account.

v8.3.1 - (2021-11-02)

Accounting API

  • Ensure Customer is shared model between Invoice and Payment

v8.3.0 - (2021-11-02)

Accounting API

  • Added Payments
  • Added downstream_id to Invoices allowing for single endpoint fanning out to multiple downstream endpoints for Invoices.

v8.2.0 - (2021-11-01)

SMS API

v8.1.0 - (2021-10-26)

SMS API

v8.0.0 - (2021-10-25)

v7.2.0 - (2021-10-23)

CRM API

v7.1.0 - (2021-10-22)

Webhook API

  • Rename url to delivery_url.

v7.0.0 - (2021-10-19)

Customer Support API

CRM & Lead API

v6.0.0 - (2021-10-14)

Webhook API

v5.12.1 - (2021-10-13)

Vault API

  • Connection.form_fields is readOnly. The values should be sent via Connection.settings when mutating a connection.

v5.12.0 - (2021-09-16)

  • Extended phone number resource with country_code, area_code, and new direct-dial-in type

Accounting API

File Storage API

v5.11.0 - (2021-09-15)

File Storage API

v5.10.0 - (2021-09-13)

File Storage API

  • Renamed folderId filter to folder_id
  • Add shared filter to the Files resource

v5.9.1 - (2021-09-08)

File Storage API

  • Added filter on folderId to the Files resource.

v5.8.1 - (2021-09-08)

Proxy API

  • Added support for responses larger than 6MB. For more information, see the Proxy API docs.

v5.8.0 - (2021-09-08)

File Storage API

v5.7.0 - (2021-09-06)

v5.6.0 - (2021-09-06)

Accounting API

v5.5.1 - (2021-08-29)

Accounting API

  • Rename general_ledger_account to ledger_account read-only on Invoices.

v5.4.1 - (2021-08-27)

Accounting, CRM, Lead & Vault API

  • normlized the naming of definitions
  • fixed response descriptions to match shared definitions and avoid duplicates

v5.4.0 - (2021-08-25)

CRM API

v5.3.0 - (2021-08-19)

Vault API

  • Add custom_consumer_settings to create session. Allow wildcard objects to be passed through the metadata field on a connection.

v5.2.0 - (2021-08-15)

CRM API

  • Add contact_id, company_id, opportunity_id, lead_id, and active to Notes.

v5.1.0 - (2021-08-13)

Accounting API

Supported resources:

  • Ledger Accounts
  • Tax Rates
  • Invoices
  • Contacts
  • Companies

v5.0.1 - (2021-08-11)

CRM, Lead & Vault API

  • For all error responses, typeName was renamed to type_name for consistency.

v5.0.0 - (2021-08-01)

CRM & Lead API

  • expected_revenue, type, last_activity_at, lead_source, and stage_last_changed_at added to Opportunity resource
  • annual_revenue, number_of_employees, industry, last_activity_at, ownership, and parent_id added to Company resource
  • Renamed image_url to image on the Company resource
  • Remove tax on the Company resource, since it's already present in phone_numbers
  • image, last_activity_at, first_email_at, and first_call_at added to Contact resource

v4.3.3 - (2021-07-29)

Vault API

  • vault/callback: Added code parameter

v4.3.2 - (2021-07-23)

Vault API

  • Connection.json#updated_at is nullable
  • vault/logs filter for exclude_unified_apis has been refactored to be comma separated string

v4.3.1 - (2021-07-15)

Vault API

  • Added ability to filter log results in vault.

v4.3.0 - (2021-07-14)

Vault API

  • New /vault/logs endpoint released to enable fetching paginated list of request logs scoped to application and consumer.

v4.2.0 - (2021-07-07)

Vault API

  • Added a services array to list all active services when listing all consumers.

v4.1.1 - (2021-07-05)

CRM API & Lead API & Vault API

  • extend examples for fields that allow anyOf (in this case errors that allow strings or objects)

v4.1.0 - (2021-07-02)

CRM API

  • Added sorting support to Leads, Companies and Opportunities. To sort results, use the sort[by] and sort[direction] query parameters.
    • Leads: available sort[by] values are name, first_name, last_name, email, created_at and updated_at.
    • Companies: available sort[by] values are name, created_at and updated_at.
    • Opportunities: available sort[by] values are title, status, monetary_amount, win_probability,created_at and updated_at.

v4.0.0 - (2021-07-01)

CRM API

  • Added note and task as allowed values for type on the activity resource
  • activity_datetime and duration_seconds are no longer required on the activity resource

ACTION REQUIRED

CRM API

Beta users should note the following breaking changes that may affect existing integrations implementing the CRM API:

  • On the activity resource, following fields were removed:
    • recurrence_activity_id
    • recurrence_start_datetime
    • recurrence_end_date
    • recurrence_timezone
    • recurrence_interval
    • recurrence_day_of_week_mask
    • recurrence_day_of_month
    • recurrence_instance
    • recurrence_month_of_year
    • recurrence_end_date_only
    • recurrence_type

v3.0.3 - (2021-07-01)

CRM API & Lead API & Vault API

  • detail property on all errors can be a string or and object

v3.0.2 - (2021-06-29)

CRM API & Lead API & Vault API

  • all required fields are validated with minLength: 1

v3.0.1 - (2021-06-28)

CRM API & Lead API

  • lead_source and language added to Lead resource
  • account_id and duration_in_minutes added to Activity resource

v3.0.0 - (2021-06-18)

ACTION REQUIRED

Vault API

Beta users should note the following breaking changes that may affect existing integrations implementing the Vault API:

  • Moved api_key field from the root in the request body to the settings object when creating/updating connections.

v2.4.0 - (2021-06-08)

CRM API

  • Added sorting support to Contacts. To sort Contacts, use the sort[by] and sort[direction] query parameters. Available sort[by] values are name, first_name, last_name, email, created_at and updated_at.

v2.3.0 - (2021-06-07)

CRM API & Lead API

  • Remove connectors table

v2.2.0 - (2021-06-07)

Proxy API

  • Documented static IP and limitations

v2.1.0 - (2021-05-31)

Vault API

  • Undocumented connectionsAdd added
  • Normalized reponses for connectionsGetSettings and connectionsUpdateSettings

v2.0.0 - (2021-05-28)

Vault/Proxy API

v1.10.0 - (2021-05-28)

CRM API

  • Added filter query parameter for opportunity

v1.9.0 - (2021-05-26)

CRM API

  • Added filter query parameter for lead

v1.8.0 - (2021-05-24)

CRM API

v1.7.0 - (2021-05-21)

CRM API

v1.6.0 - (2021-05-20)

CRM API

  • Added Notes resource

v1.5.0 - (2021-05-19)

  • Configuration options per resource extended to fetch dynamic options when configuring settings.

Vault API

  • Added filter-type to FormField.type that allows configuration options to be filtered by the value of a separate setting.
  • FormFieldOptionGroup schema added to define grouping of options within a FormField
1.4.0

v1.4.0 - (2021-05-18)

Added configuration options per resource.

1.4.0

Vault API

v1.3.0 - (2021-05-13)

Apideck APIs now use a single semver version for clarity.

1.3.0

CRM API & Lead API

v1.2.0 - (2021-05-12)

New consumer endpoints added to the Vault API providing a list and aggregate data on the type of requests consumers are making.

Vault 1.2.0

v1.1.1 - (2021-05-10)

Initial spec of new Vault Consumers API drafted for upcoming release.

Vault 1.1.1

v1.1.0 - (2021-04-23)

We switched to a dynamic way of using filters instead of fixed query parameters.

ACTION REQUIRED

CRM 1.1.0

Beta users should note the following breaking changes that may affect existing integrations implementing the CRM API:

  • Filtering on contacts has now a dedicated filter query parameter instead of seperated query parameters per field

  • Filtering on opportunities has now a dedicated filter query parameter instead of seperated query parameters per field

v1.0.0 - (2021-04-21)

Moving towards widespread public release, we're updating our specs to version 1.0.0 across the board. This acts as a starting point to officially implement semantic versioning across all of our specs.

From here on in, we'll be tracking, documenting and broadcasting implemented or upcoming API changes within this document.

ACTION REQUIRED

CRM 1.0.0 Lead 1.0.0

Beta users should note the following breaking changes that may affect existing integrations implementing either Lead or CRM API:

  • Address.type enum updated to ["primary", "secondary", "home", "office", "shipping", "billing", "other"]

  • Website.category has been renamed to Website.type and is now an enum. Now accepts: ["primary", "secondary", "work", "personal", "other"]

  • Email.type migrated from string to enum. Now accepts: ["primary", "secondary", "work", "personal", "billing", "other"]

  • PhoneNumber.phone_type changed to PhoneNumber.type and enum now accepts: ["primary", "secondary", "home", "office", "mobile", "assistant", "fax", "other"].

Note: All enums that previously accepted default now expect primary!