Change Updates

Do not miss any PlannrCRM API changes, ever again

Subscribe to the PlannrCRM API changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Compare
1 structure change including:
1 Addition
Added 1
GET /api/v1/addons/seccl/{addon}/schema-products
16 structure changes including:
1 Addition
15 Modifications
Modified 15 Breaking
GET /api/v1/bank-statement
  • Query
  • filter[statement] query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • filter[statement_uuids] query parameter Added
GET /api/v1/bank-transaction
  • Query
  • filter[bank_statement], filter[statement] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • filter[statement_uuids], filter[bank_statement_uuids] query parameters Added
GET /api/v1/client/{client_uuid}/charges
  • Query
  • filter[client_uuids], filter[plan_uuids], filter[provider_uuids], filter[policy_number], filter[seller_uuids], filter[payment_origin], filter[type], filter[category], filter[recurring], filter[frequency], filter[start_date_after], filter[start_date_before], filter[end_date_after], filter[end_date_before], filter[next_expectation_date_after], filter[next_expectation_date_before], filter[amount_from], filter[amount_to], filter[percentage_from], filter[percentage_to], filter[tax_exempt], filter[exclude_from_rmar], filter[rmar_type], filter[advice_type], filter[service_type], per_page query parameters Added
GET /api/v1/client/{client_uuid}/expectations
  • Query
  • filter[statement], filter[date_from], filter[date_to], filter[client], filter[groups], filter[provider], filter[plan], filter[seller] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • filter[statement_uuids], filter[date_after], filter[date_before], filter[client_uuids], filter[group_uuids], filter[provider_uuids], filter[plan_uuids], filter[seller_uuids] query parameters Added
GET /api/v1/expectation
  • Query
  • filter[statement], filter[date_from], filter[date_to], filter[client], filter[groups], filter[provider], filter[plan], filter[seller] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • filter[statement_uuids], filter[date_after], filter[date_before], filter[client_uuids], filter[group_uuids], filter[provider_uuids], filter[plan_uuids], filter[seller_uuids] query parameters Added
GET /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • notes_count property Added
GET /api/v1/plans/{plan_uuid}/charges
  • Query
  • filter[client_uuids], filter[plan_uuids], filter[provider_uuids], filter[policy_number], filter[seller_uuids], filter[payment_origin], filter[type], filter[category], filter[recurring], filter[frequency], filter[start_date_after], filter[start_date_before], filter[end_date_after], filter[end_date_before], filter[next_expectation_date_after], filter[next_expectation_date_before], filter[amount_from], filter[amount_to], filter[percentage_from], filter[percentage_to], filter[tax_exempt], filter[exclude_from_rmar], filter[rmar_type], filter[advice_type], filter[service_type], per_page query parameters Added
GET /api/v1/plans/{plan_uuid}/expectations
  • Query
  • filter[statement], filter[date_from], filter[date_to], filter[client], filter[groups], filter[provider], filter[plan], filter[seller] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • filter[statement_uuids], filter[date_after], filter[date_before], filter[client_uuids], filter[group_uuids], filter[provider_uuids], filter[plan_uuids], filter[seller_uuids] query parameters Added
GET /api/v1/provider-statement
  • Query
  • filter[statement], filter[provider] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • filter[statement_uuids], filter[provider_uuids] query parameters Added
GET /api/v1/statement-transaction
  • Query
  • filter[statement], filter[provider_statement], filter[provider] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • filter[statement_uuids], filter[provider_statement_uuids], filter[provider_uuids] query parameters Added
POST /api/v1/charge
  • Body
  • application/json content type Modified
    • frequency property Modified
      • Property is no longer required
    • percentage_frequency, tax, premium_uuid properties Added
POST /api/v1/expectation/reconcile
  • Response
  • 200 response Modified
    • application/json content type Modified
      • notes_count property Added
POST /api/v1/firm/{firm_uuid}/settings
  • Body
  • application/json content type Modified
    • charge_identifier property Added
PUT /api/v1/charge/{uuid}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
    • percentage_frequency, tax properties Added
PUT /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • notes_count property Added
Added 1
GET /api/v1/charge
5 structure changes including:
5 Modifications
Modified 5 Breaking
DELETE /api/v1/time-entry/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • trackable property Modified
        • Type went from string to object
          Breaking
      • is_active property Modified
        • Type went from string to boolean
          Breaking
      • created_at, updated_at, description, trackable_type, total_time_in_minutes, computed_time_elapsed_in_seconds, account properties Added
GET /api/v1/time-entry/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • trackable property Modified
        • Type went from string to object
          Breaking
      • is_active property Modified
        • Type went from string to boolean
          Breaking
      • created_at, updated_at, description, trackable_type, total_time_in_minutes, computed_time_elapsed_in_seconds, account properties Added
POST /api/v1/time-entry
  • Body
  • application/json content type Modified
    • description property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • trackable property Modified
        • Type went from string to object
          Breaking
      • is_active property Modified
        • Type went from string to boolean
          Breaking
      • created_at, updated_at, description, trackable_type, total_time_in_minutes, computed_time_elapsed_in_seconds, account properties Added
POST /api/v1/time-entry/{timeEntry_uuid}/stop
  • Response
  • 200 response Modified
    • application/json content type Modified
      • trackable property Modified
        • Type went from string to object
          Breaking
      • is_active property Modified
        • Type went from string to boolean
          Breaking
      • created_at, updated_at, description, trackable_type, total_time_in_minutes, computed_time_elapsed_in_seconds, account properties Added
PUT /api/v1/time-entry/{id}
  • Body
  • application/json content type Modified
    • description property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • trackable property Modified
        • Type went from string to object
          Breaking
      • is_active property Modified
        • Type went from string to boolean
          Breaking
      • created_at, updated_at, description, trackable_type, total_time_in_minutes, computed_time_elapsed_in_seconds, account properties Added
1 structure change including:
1 Addition
Added 1
GET /api/v1/platform/{uuid}