Search docs

API Changelog

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

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

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

v8.13.0 - (2022-03-09)

  • Added Items and Orders POS mapping to Square

v8.12.1 - (2022-02-18)

Accounting API

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!