Changelog
Back to All
improved

INGENIOUS 2.0

12 months ago

We are excited to announce the release of INGENIOUS 2.0, packed with a multitude of cleanups and improvements aimed at enhancing the overall performance and user experience. This version introduces several significant changes that impact our API, ensuring a more streamlined and efficient workflow for developers. Here’s a detailed breakdown of the updates.

Our Focus

  • Standardized naming conventions and responses across the API for consistency and clarity.
  • Relationship data is no longer embedded in responses. To retrieve related data, use the appropriate endpoints with the provided identifiers. For example, to get project data of an invoice, use the project_id field in the invoice response to query the projects endpoint.
  • Reduced the amount of data returned in responses to focus on the most important information and minimize distraction.

V1 - End of Life

Migration to V2 Endpoints:

  • All V1 endpoints will be deprecated and moved to V2 to enhance performance, improve consistency, and align with Ingenious 2.0.

Removal Date:

  • V1 endpoints will be removed on 1st September. This change is necessary to streamline our API offerings and ensure all users benefit from the latest updates and improvements.

Action Required:

  • Please update your applications to use V2 endpoints before 1st September to avoid any disruption in service.

Projects

🚧

Changed

  • Response field contract_type will always return null, due to contract flow changes.
  • Response field employees object now only provides manager_id and executive_id.
  • Response field _id name in custom_attributes changed to id.
  • Response field client_company name changed to client_company_id.
  • Response field external_id name changed to custom_id.
  • Response field project_description name changed to description.
  • Response field project_health name changed to health.
  • Response field project_name name changed to name.
  • Response field project_phase name changed to phase.
  • Response field project_risk name changed to risk.
  • Response field project_status_id name changed to status_id.
  • Response field project_status_name name changed to status_name.
  • Response field project_type name changed to type.
  • Query parameter with_custom_attributes type was changed to boolean.
  • Query parameter show_archived type was changed to boolean.
  • Query parameter update_date name was changed to updated_at.
  • Query parameter project_client name was changed to client.
  • Query parameter project_status name was changed to status.
  • Query parameter status now supports stringified values.
  • Description of types was updated along with examples.

❗️

Removed

  • Response field project_mongo_id_local.
  • Response field project_mongo_id.
  • Response field formatted_id.
  • Response field address1.
  • Response field address2.
  • Response field city.
  • Response field state.
  • Response field country.
  • Response field budget_allocated.
  • Response field budget_committed.
  • Response field contract_type.
  • Response field contract_business_unit.
  • Response field deleted_at.
  • Response field formatted_id.
  • Response field project_number.
  • Response field portfolio.

Contacts

πŸ‘

Added

  • Response field company_id.
  • Query parameter company_id.

🚧

Changed

  • Description of types was updated along with examples.

❗️

Removed

  • Response field contact_person_id.

Companies

πŸ‘

Added

  • Response field custom_id was added to GET endpoints.

🚧

Changed

  • Query parameter external_id name changed to custom_id.
  • Query parameter update_date name changed to updated_at.
  • Query parameter show_archived type changed to boolean.
  • Response field company_name changed to name.
  • Response field office_locations now provides list of ids.
  • Description of types was updated along with examples.

❗️

Removed

  • Create endpoint.
  • Update endpoint.

Employees

🚧

Changed

  • Response field assigned_office_location name changed to assigned_office_location_id.
  • Query parameter external_id name changed to custom_id.
  • Query parameter show_archived type changed to boolean.

❗️

Removed

  • Response field address1.
  • Response field address2.
  • Response field city.
  • Response field state.
  • Response field country.
  • Response field is_hidden.

Contract Changes (Change Orders)

🚧

Changed

  • /change-orders endpoints changed to /contract-changes.
  • Query parameter co_status name changed to status.
  • Query parameter co_type name changed to type.
  • Response field phases name and structure was changed.
  • Response field status_id changed to status.
  • Response field status now supports stringified values.

❗️

Removed

  • Response field approval_date.
  • Response field invoice_amount.
  • Response field project_client.
  • Response field project_country_code.
  • Response field project_local_id.
  • Response field project_name.

Contracts

πŸ‘

Added

  • Query parameter custom_id.
  • Response field custom_id.
  • Response field vendor_company_id.
  • Response field vendor_contact_id.
  • Response field client_contact_id.

🚧

Changed

  • Query parameter update_date name changed to updated_after.
  • Response field phases name and structure was changed.
  • Response field contract_id changed to id.
  • Response field status_id changed to status.
  • Response field status_sov_id changed to sov_status.
  • Response field status now supports stringified values.
  • Response field value changed to total_value.

❗️

Removed

  • Response field show_archived.
  • Response field agreement_type.
  • Response field approval_status.
  • Response field client_company_name.
  • Response field client_company_type.
  • Response field client_contact_name.
  • Response field company_id.
  • Response field company_name.
  • Response field contract_holder.
  • Response field contract_item_count.
  • Response field contract_item_name.
  • Response field contract_item_type.
  • Response field country_code.
  • Response field currency.
  • Response field currency_code.
  • Response field is_main.
  • Response field project_local_id.
  • Response field project_name.
  • Response field status_loi.
  • Response field status_name.
  • Response field status_sov_name.

Invoices

πŸ‘

Added

  • Response field gross_value.
  • Response field net_value.
  • Response field paid_value.

🚧

Changed

  • update_date name changed to updated_at.
  • status_id changed to status.
  • Response field status now supports stringified values.

❗️

Removed

  • Response field project_client filter.
  • Response field status filter.
  • Response field approved_date.
  • Response field attention_from.
  • Response field attention_to.
  • Response field billing_period_end_date.
  • Response field billing_period_id.
  • Response field billing_period_start_date.
  • Response field category_id.
  • Response field category_name.
  • Response field client_information.
  • Response field currency_code.
  • Response field is_sender_created.
  • Response field original_amount.
  • Response field phases.
  • Response field project_client.
  • Response field project_local_id.
  • Response field project_name.
  • Response field provider_invoice_id.
  • Response field receiver_invoice_id.
  • Response field start_date.
  • Response field vendor_id.
  • Response field vendor_invoice_id_display.
  • Response field vendor_name.

Project Journal Entries

🚧

Changed

  • Response field id now returns string from GET endpoints.
  • Response field project_id now returns string from GET endpoints.
  • Description of types was updated along with examples.