Versions Compared

Version Old Version 24 New Version 25
Changes made by

Greg Walsh

Greg Walsh

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

API versions v1 and v2 are deprecated as of these this release

  • Deprecated APIs:

    • v4/Credit/Note/{id}/Render (Get)

    • v4Account/SharePlan (Post)

    • API Endpoints removed:

      • v3/EventRegistrationAll (Get)

      • v3/EventRegistrationAll/{dtoTypeKey} (Get)

      • v3/EventRegistrationAll/GetInternal (Get)

      • v3/EventRegistrationAll/GetPagedInternal (Get)

      • v3/EventRegistrationAll/Paged (Get)

      • v3/DataType/ZipCode/{id} (Delete)

      • v3/DataType/ZipCode (Get)

      • v3/DataType/ZipCode/{id} (Get)

      • v3/DataType/ZipCode/Metadata (Get)

      • v3/DataType/ZipCode/Metadata/sql (Get)

      • v3/DataType/ZipCode/Paged (Get)

      • v3/DataType/ZipCode (Post)

      • v3/DataType/ZipCode/{id} (Put)

      • v3/Invoice/Item/ReverseCredit (Get)

      • v3/Invoice/Item/ReverseCredit/{id} (Get)

      • v3/Invoice/Item/ReverseCredit/Metadata (Get)

      • v3/Invoice/Item/ReverseCredit/Metadata/sql (Get)

      • v3/Invoice/Item/ReverseCredit/Paged (Get)

      • v3/Invoice/Item/ReverseCredit/{id} (Put)

      • v3/DataFlow/LogisenseBilling/Validate (Patch)

      • v3/Cache/LookupTable/ (Get)

      • v3/Cache/LookupTable/Paged (Get)

      • v3/Cache/LookupTable/Invalidate (Put)

      • v3/Usage/LocalCallPattern/{id} (Delete)

      • v3/Usage/LocalCallPattern (Get)

      • v3/Usage/LocalCallPattern/{id} (Get)

      • v3/Usage/LocalCallPattern/Metadata (Get)

      • v3/Usage/LocalCallPattern/Metadata/sql (Get)

      • v3/Usage/LocalCallPattern/Paged (Get)

      • v3/Usage/LocalCallPattern (Post)

      • v3/Usage/LocalCallPattern/{id} (Put)

      • v4/Usage/LocalCallPattern/{id} (Delete)

      • v4/Usage/LocalCallPattern (Get)

      • v4/Usage/LocalCallPattern/{id} (Get)

      • v4/Usage/LocalCallPattern/Paged (Get)

      • v4/Usage/LocalCallPattern (Post)

      • v4/Usage/LocalCallPattern/{id} (Put)

      • v3/Invoice/Item/ReverseCharge (Get)

      • v3/Invoice/Item/ReverseCharge/{id} (Get)

      • v3/Invoice/Item/ReverseCharge/Metadata (Get)

      • v3/Invoice/Item/ReverseCharge/Metadata/sql (Get)

      • v3/Invoice/Item/ReverseCharge/Paged (Get)

      • v3/Invoice/Item/ReverseCharge/{id} (Put)

      • v3/DataArchiveGroup/{id} (Delete)

      • v3/DataArchiveGroup (Get)

      • v3/DataArchiveGroup/{id} (Get)

      • v3/DataArchiveGroup/Metadata (Get)

      • v3/DataArchiveGroup/Metadata/sql (Get)

      • v3/DataArchiveGroup/Paged (Get)

      • v3/DataArchiveGroup (Post)

      • v3/DataArchiveGroup/{id} (Put)

      • v3/DataArchiveExportType (Get)

      • v3/DataArchiveExportType/{id} (Get)

      • v3/DataArchiveExportType/Metadata (Get)

      • v3/DataArchiveExportType/Metadata/sql (Get)

      • v3/DataArchiveExportType/Paged (Get)

      • v3/DataArchiveConfiguration/{id} (Delete)

      • v3/DataArchiveConfiguration (Get)

      • v3/DataArchiveConfiguration/{id} (Get)

      • v3/DataArchiveConfiguration/Metadata (Get)

      • v3/DataArchiveConfiguration/Metadata/sql (Get)

      • v3/DataArchiveConfiguration/Paged (Get)

      • v3/DataArchiveConfiguration (Post)

      • v3/DataArchiveConfiguration/{id} (Put)

      • v3/DataArchiveActionType (Get)

      • v3/DataArchiveActionType/{id} (Get)

      • v3/DataArchiveActionType/Metadata (Get)

      • v3/DataArchiveActionType/Metadata/sql (Get)

      • v3/DataArchiveActionType/Paged (Get)

  • Updated APIs:

    • v5/ReportDefinition/<id>/Render (Post): Added reportDelivery section

    • v5/Account/Package (Get): Added packageContract section

    • v5/Account/Package (Get, Post, Put, Patch): added PendingBillDay and PendingUsageBillDay to support new change bill day feature

    • v5/Account/Package (Get, Post, Put, Patch): added BillCancelOptionTypeId, BillCancelOptionTypeName
      and WaiveEarlyTerminationFee to support new account/package cancellation options

    • v5/Account/Package/FromCatalog (Post): added Effective to support setting package and service effective dates

    • v5/Account/PricePlan (Get, Post, Put, Patch): added IncludeChildAccounts and removed IsConsolidatedByInvoicer to support the new price plan sharing configuration

    • v5/Account/Package & v5/Account/Service (Get, Post, Put, Patch):

      • Added money and removed UsageRatePlanId and UsageRatePlanName to support new money buckets configuration

      • Added OverageUsageRatePlanId and OverageUsageRatePlanName to support overage rate plans on usage buckets

      • Added BillCancelOptionTypeId and BillCancelOptionTypeName to support new package and service cancelation options

    • v5/Account/SharePlan (Get, Put, Patch): changes to support participation configuration changes and money buckets

      • Removed ParticipatingLimit, ParticipatingUsageUnitId and ParticipatingUsageUnitName

      • Added DataParticipatingLimit, DataUsageUnitId, DataUsageUnitName, TimeParticipatingLimit, TimeUsageUnitId, TimeUsageUnitName, CountParticipatingLimit, CountUsageUnitId,
        MoneyParticipatingLimit, MoneyUsageUnitId, MoneyUsageUnitName

    • v5/Account (Get, Put, Patch): added PendingBillDay and PendingUsageBillDay to support new change bill day feature

    • v5/BillRun/Schedule/OneTime (Post): added OrderId and removed BillRunTypeId and BillRunTypeName

    • v5/BillGroup (Get, Update): removed BillRunTypeId and BillRunTypeName

    • v5/BillRun (Get, Post, Put, Patch): removed BillRunTypeId and BillRunTypeName

    • v5/Country (Get, Post, Put, Patch): removed DataTypePostalCodeIds and DataTypePostalCodeName

    • v5/Invoice/Item (Get with Detail): added Reversals

    • v5/Invoice/Item/ReverseCharge (Post): added InvoiceAmount

    • v5/Invoice/{id}/Download (Get): added Link to provide a url to the invoice location in S3 storage

    • v5/Invoice/Render (Get): added PdfStorageLocationId and PdfIdentifier

    • v5/Invoice/Item/Transaction/View (Get): added Reversals

    • v5/Order (Get, Post, Put, Patch): added Effective to support setting package and service effective dates

    • v5/Account/ProductCode/AvailableFor/Account/{accountId:int}/PackageFrequency/{packageFrequencyId:int}: added PackageFrequencyId, PackageFrequencyName, AccountPricePlanStart and AccountPricePlanEnd to support new price plan start and end dates

    • v5/Package and v5/Package/Frequency (Get): added Created and Updated to support Salesforce integration

    • v5/Package and v5/Package/Frequency (Get, Post, Put, Patch): added UsageBucketTiers,
      DefaultUsageBucketTiers, MoneyBucketTiers and DefaultMoneyBucketTiers to support new money bucket configuration

    • v5/Credential/ResetLink (Get, Post): added DomainURL to support new password management functionality

    • v5/Usage/Bucket/BaseUnit (Get): added IsBaseBucketEligible

    • v5/Usage/Bucket/SharePlan (Get): added MoneyCurrencyId, removed ParticipatingLimit, ParticipatingUsageUnitId and ParticipatingUsageUnitName

    • v5/Usage/Bucket/SharePlan (Get): added DataParticipatingLimit, DataUsageUnitId, DataUsageUnitName,
      TimeParticipatingLimit, TimeUsageUnitId, TimeUsageUnitName, CountParticipatingLimit, CountUsageUnitId, CountUsageUnitName, MoneyParticipatingLimit, MoneyUsageUnitId, MoneyUsageUnitName, MoneyCurrencyId and MoneyCurrencyName

    • v5/Usage/Bucket/SharePlan (Get, Post, Put): added SharePlanTypeId and SharePlanTypeName

    • v5/Usage/Bucket and v5/Package/Frequency (Get): Added PackageFrequencyId, PackageFrequencyName, PackageServiceId, CurrencyId, CurrencyName, Money and removed UsageRatePlanId and UsageRatePlanName

    • v5/Usage/Bucket (Get):

      • added usageBucketBase section

    • v5/Usage/Bucket (Get, Post, Put):

      • added OverageUsageRatePlanId and OverageUsageRatePlanName

      • added UsageBucketBaseUnitId and UsageBucketBaseUnitName

      • removed UsageBucketBaseId and UsageBucketBaseName

    • v5/Usage/Rate/Plan (Get): added Created and Updated

    • v5/Usage/Rate/Group (Get, Post, Put): added Created and Updated

    • v5/Usage/Rate (Get, Post, Put): added Created and Updated

    • v4/Account/Package (Post): Fixed an issue where a post request would fail if a usage bucket's Name was provided instead of its ID

    • v4/internal/account/package (Post): Fixed an issue which allowed an effective cancel date to be set on an account when active account-packages were present

  • New APIs:

    • v5/Account/<id>/Contact/<id>/Detail (Get): replaces older deprecated contact APIs

    • v5/Account/<id>/Contact/<id> (Delete): replaces older deprecated contact APIs

    • v5/Account/Package/<id>/CancelSetting (Post, Put, Delete): supports new package cancelation charge options

    • v5/Account/Package/<id>/HasBucketedUsage (Get): determines if bucketed usage exists on an account-package

    • v5/Account/Service/Usage/Bucket/Consumption/Paged (Get): returns paginated results detailing bucket consumption for buckets on the specified account-service

    • v5/BillCancelOptionType (Get): Returns a list of available cancellation options

    • v5/DataImport/CacheCategory/<id>/Key (Get): Retrieves the cache category value based on the supplied ID

    • v5/Credit/Note/<id>/Send (Post): Sends a credit note without the need to specify the CreditNoteRenderID (the most recently rendered credit note will be used)

    • v5/Credit/Note/{id}/Download (Get): Returns credit note details and a base64 encoded pdf credit note if the query string parameter linkOnly is false, and only details and a link to the pdf credit note in S3 storage if LinkOnly is set to true

    • v3,v4,v5/Service/TaxCategory/AvaTax (Get): returns a filtered list of configured service tax categories that are compatible with AvaTax

    • v5/EventSubscription/Email (Post, Put, Patch, Delete): allows email event subscriptions to be created, modified and deleted

    • v5/EventSubscription/Webhook (Post, Put, Patch, Delete): allows webhook event subscriptions to be created, modified and deleted

    • v5/SharePlanType (Get): indicates if the share plan is of type Money or Usage

...