TAG LINE
SMALL TITLE

Package

(API Version v3)


Represents a product available for sale.


What can you do with Package?


Properties

Property Details
identity
READ-ONLY
"identity": 1
Type: Number
This is the unique numeric identifier for the Package
name
"name": "Gold Service Plan"
Type: String
User defined name for the Package.
ownerId
READ-ONLY
"ownerId": 3
Type: Number
Unique identifier for the associated Owner object.
ownerName
READ-ONLY
"ownerName": "Sample Name"
Type: String
The name of the object associated with the ownerId property.
created
READ-ONLY
"created": "2021-04-26T15:25:27.587Z"
Type: Date
This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format.
start
"start": "2021-04-26T15:25:27.587Z"
Type: Date
Date Time for when this Package is available for purchase.

Date and time values are specified in the ISO 8601 format.
expiry
"expiry": "2021-04-26T15:25:27.587Z"
Type: Date
Date Time for when this Package is no longer available for purchase.

Date and time values are specified in the ISO 8601 format.
fullPeriod
"fullPeriod": true
Type: Boolean
Whether or not when this package charges the full period and does not prorate.
invoiceDetail
"invoiceDetail": "Hello World"
Type: String
postPaid
"postPaid": true
Type: Boolean
Whether or not this package is post-paid.
syncToBillDay
READ-ONLY
"syncToBillDay": true
Type: Boolean
Unused
defaultAccountPackageStatusTypeId
"defaultAccountPackageStatusTypeId": 17
Type: Number
Unique identifier for the associated AccountPackageStatusType object.
defaultAccountPackageStatusTypeName
"defaultAccountPackageStatusTypeName": "Sample Name"
Type: String
The name of the object associated with the defaultAccountPackageStatusTypeId property.
packageCategoryId
"packageCategoryId": 10
Type: Number
Unique identifier for the associated PackageCategory object.
packageCategoryName
"packageCategoryName": "Sample Name"
Type: String
The name of the object associated with the packageCategoryId property.
chargeRecurringIfUsage
"chargeRecurringIfUsage": true
Type: Boolean
Whether or not to only charge recurring fees if there are usage charges for this period.
isGlobalAddOnEligible
"isGlobalAddOnEligible": true
Type: Boolean
Whether or not this package is eligible to have Global Add-ons attached to it.
description
"description": "The best service plan available"
Type: String
A user defined description for this Package
id
"id": 8
Type: Number


Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • description
  • start
  • expiry
  • fullPeriod
  • invoiceDetail
  • chargeRecurringIfUsage
  • postPaid
  • syncToBillDay
  • defaultAccountPackageStatusTypeId
  • isGlobalAddOnEligible

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the Package object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v3/Package/{id}
Delete an instance of the Package object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system.
{id}Unique identifier for the Package object.
Delete an instance of the Package object.
DELETE api/v3/Package/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "delete",
    "results": {
        "totalCount": 4,
        "items": [
            {
                "identity": 1,
                "action": "deleted",
                "dtoTypeKey": "package"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v3/Package/
Retrieve all of the Package objects.
Retrieve all of the Package objects.
GET api/v3/Package/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Gold Service Plan",
            "ownerId": 23,
            "ownerName": "Sample Text Data",
            "created": "2021-04-26T15:25:27.587Z",
            "start": "2021-04-26T15:25:27.587Z",
            "expiry": "2021-04-26T15:25:27.587Z",
            "fullPeriod": true,
            "invoiceDetail": "Sample Text Data",
            "postPaid": true,
            "syncToBillDay": true,
            "defaultAccountPackageStatusTypeId": 6,
            "defaultAccountPackageStatusTypeName": "Sample Text Data",
            "packageCategoryId": 12,
            "packageCategoryName": "Sample Text Data",
            "chargeRecurringIfUsage": true,
            "isGlobalAddOnEligible": true,
            "description": "The best service plan available",
            "id": 21
        }
    ]
}
GETapi/v3/Package/AvailableFor/Currency/{id}
Retrieve Package objects that are avaialable for the specified Currency.
{id}Unique identifier for the Currency object.
Retrieve Package objects that are avaialable for the specified Currency.
GET api/v3/Package/AvailableFor/Currency/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "a09f1146-6e20-46b6-ba73-35755561f273",
    "totalCount": 1,
    "items": [
        {
            "identity": 2,
            "name": "DialUp Package",
            "created": "2005-02-11T11:23:11",
            "fullPeriod": false,
            "postPaid": false,
            "syncToBillDay": true,
            "defaultAccountPackageStatusTypeId": 99,
            "defaultAccountPackageStatusTypeName": "Enable",
            "packageCategoryId": 2,
            "packageCategoryName": "Default"
        }
    ]
}
GETapi/v3/Package/AvailableFor/SharePlan/Participation
Internal endpoint that is not currently used.
GETapi/v3/Package/Paged
Retrieve all of the Package objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.
Retrieve all of the Package objects in a paged fashion.
GET api/v3/Package/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Gold Service Plan",
                "ownerId": 25,
                "ownerName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "start": "2021-04-26T15:25:27.587Z",
                "expiry": "2021-04-26T15:25:27.587Z",
                "fullPeriod": true,
                "invoiceDetail": "Sample Text Data",
                "postPaid": true,
                "syncToBillDay": true,
                "defaultAccountPackageStatusTypeId": 10,
                "defaultAccountPackageStatusTypeName": "Sample Text Data",
                "packageCategoryId": 16,
                "packageCategoryName": "Sample Text Data",
                "chargeRecurringIfUsage": true,
                "isGlobalAddOnEligible": true,
                "description": "The best service plan available",
                "id": 19
            }
        ]
    }
}
GETapi/v3/Package/Paged/Detail
Retrieve all of the Package objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
Retrieve all of the Package objects in a paged fashion with all object details.
GET api/v3/Package/Paged/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Gold Service Plan",
                "ownerId": 27,
                "ownerName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "start": "2021-04-26T15:25:27.587Z",
                "expiry": "2021-04-26T15:25:27.587Z",
                "fullPeriod": true,
                "invoiceDetail": "Sample Text Data",
                "postPaid": true,
                "syncToBillDay": true,
                "defaultAccountPackageStatusTypeId": 4,
                "defaultAccountPackageStatusTypeName": "Sample Text Data",
                "packageCategoryId": 17,
                "packageCategoryName": "Sample Text Data",
                "chargeRecurringIfUsage": true,
                "isGlobalAddOnEligible": true,
                "description": "The best service plan available",
                "id": 13,
                "details": {
                    "sampleSingleObject": {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    },
                    "sampleMultipleObjects": {
                        "totalCount": 1,
                        "items": [
                            {
                                "identity": 2,
                                "property1": "Sample Text",
                                "property2": "2021-04-26T15:25:29.117Z",
                                "property3": 2
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETapi/v3/Package/{id}
Retrieve an instance of the Package object by its ID.
{id}Unique identifier for the Package object.
Retrieve an instance of the Package object by its ID.
GET api/v3/Package/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Gold Service Plan",
        "ownerId": 5,
        "ownerName": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z",
        "start": "2021-04-26T15:25:27.587Z",
        "expiry": "2021-04-26T15:25:27.587Z",
        "fullPeriod": true,
        "invoiceDetail": "Sample Text Data",
        "postPaid": true,
        "syncToBillDay": true,
        "defaultAccountPackageStatusTypeId": 24,
        "defaultAccountPackageStatusTypeName": "Sample Text Data",
        "packageCategoryId": 22,
        "packageCategoryName": "Sample Text Data",
        "chargeRecurringIfUsage": true,
        "isGlobalAddOnEligible": true,
        "description": "The best service plan available",
        "id": 18
    }
}
GETapi/v3/Package/{id}/Detail
Retrieve deep detail of the Package object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
{id}Unique identifier for the Package object.
Retrieve deep detail of the Package object by its ID.
GET api/v3/Package/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Gold Service Plan",
        "ownerId": 1,
        "ownerName": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z",
        "start": "2021-04-26T15:25:27.587Z",
        "expiry": "2021-04-26T15:25:27.587Z",
        "fullPeriod": true,
        "invoiceDetail": "Sample Text Data",
        "postPaid": true,
        "syncToBillDay": true,
        "defaultAccountPackageStatusTypeId": 8,
        "defaultAccountPackageStatusTypeName": "Sample Text Data",
        "packageCategoryId": 13,
        "packageCategoryName": "Sample Text Data",
        "chargeRecurringIfUsage": true,
        "isGlobalAddOnEligible": true,
        "description": "The best service plan available",
        "id": 7,
        "details": {
            "sampleSingleObject": {
                "identity": 2,
                "property1": "Sample Text",
                "property2": "2021-04-26T15:25:29.117Z",
                "property3": 2
            },
            "sampleMultipleObjects": {
                "totalCount": 1,
                "items": [
                    {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    }
                ]
            }
        }
    }
}
PATCHapi/v3/Package/{id}
Update or Add the Package object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.
{id}Unique identifier for the Package object.
Update or Add the Package object and optionally make changes to any child objects.
PATCH api/v3/Package/{id}

{
    "details": {},
    "packages": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "name": "Gold Service Plan",
                "start": "2021-04-26T15:25:27.587Z",
                "expiry": "2021-04-26T15:25:27.587Z",
                "fullPeriod": true,
                "invoiceDetail": "Sample Text Data",
                "postPaid": true,
                "defaultAccountPackageStatusTypeId": 10,
                "packageCategoryId": 14,
                "chargeRecurringIfUsage": true,
                "isGlobalAddOnEligible": true,
                "description": "The best service plan available",
                "id": 24
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "patch",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "action": "created",
                "dtoTypeKey": "package",
                "instance": {
                    "identity": 1,
                    "name": "Gold Service Plan",
                    "ownerId": 14,
                    "ownerName": "Sample Text Data",
                    "created": "2021-04-26T15:25:27.587Z",
                    "start": "2021-04-26T15:25:27.587Z",
                    "expiry": "2021-04-26T15:25:27.587Z",
                    "fullPeriod": true,
                    "invoiceDetail": "Sample Text Data",
                    "postPaid": true,
                    "syncToBillDay": true,
                    "defaultAccountPackageStatusTypeId": 23,
                    "defaultAccountPackageStatusTypeName": "Sample Text Data",
                    "packageCategoryId": 7,
                    "packageCategoryName": "Sample Text Data",
                    "chargeRecurringIfUsage": true,
                    "isGlobalAddOnEligible": true,
                    "description": "The best service plan available",
                    "id": 13
                }
            }
        ]
    }
}
POSTapi/v3/Package/
Create a new instance of the Package object.
Create a new instance of the Package object.
POST api/v3/Package/

{
    "name": "Gold Service Plan",
    "start": "2021-04-26T15:25:27.587Z",
    "expiry": "2021-04-26T15:25:27.587Z",
    "fullPeriod": true,
    "invoiceDetail": "Sample Text Data",
    "postPaid": true,
    "defaultAccountPackageStatusTypeId": 4,
    "packageCategoryId": 1,
    "chargeRecurringIfUsage": true,
    "isGlobalAddOnEligible": true,
    "description": "The best service plan available",
    "id": 1
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Gold Service Plan",
                "ownerId": 19,
                "ownerName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "start": "2021-04-26T15:25:27.587Z",
                "expiry": "2021-04-26T15:25:27.587Z",
                "fullPeriod": true,
                "invoiceDetail": "Sample Text Data",
                "postPaid": true,
                "syncToBillDay": true,
                "defaultAccountPackageStatusTypeId": 8,
                "defaultAccountPackageStatusTypeName": "Sample Text Data",
                "packageCategoryId": 7,
                "packageCategoryName": "Sample Text Data",
                "chargeRecurringIfUsage": true,
                "isGlobalAddOnEligible": true,
                "description": "The best service plan available",
                "id": 11
            }
        ]
    }
}
PUTapi/v3/Package/{id}
Update an existing instance of the Package object.
Update an existing instance of the Package object.
PUT api/v3/Package/{id}

{
    "identity": 1,
    "name": "Gold Service Plan",
    "start": "2021-04-26T15:25:27.587Z",
    "expiry": "2021-04-26T15:25:27.587Z",
    "fullPeriod": true,
    "invoiceDetail": "Sample Text Data",
    "postPaid": true,
    "defaultAccountPackageStatusTypeId": 17,
    "packageCategoryId": 23,
    "chargeRecurringIfUsage": true,
    "isGlobalAddOnEligible": true,
    "description": "The best service plan available",
    "id": 11
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Gold Service Plan",
                "ownerId": 24,
                "ownerName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "start": "2021-04-26T15:25:27.587Z",
                "expiry": "2021-04-26T15:25:27.587Z",
                "fullPeriod": true,
                "invoiceDetail": "Sample Text Data",
                "postPaid": true,
                "syncToBillDay": true,
                "defaultAccountPackageStatusTypeId": 18,
                "defaultAccountPackageStatusTypeName": "Sample Text Data",
                "packageCategoryId": 24,
                "packageCategoryName": "Sample Text Data",
                "chargeRecurringIfUsage": true,
                "isGlobalAddOnEligible": true,
                "description": "The best service plan available",
                "id": 20
            }
        ]
    }
}