TAG LINE
SMALL TITLE

Package / Frequency / Package Currency

(API Version v3)


Represents a linking between a Package frequency and currency in which a Package can be sold.


What can you do with PackageFrequencyPackageCurrency?


Properties

Property Details
identity
READ-ONLY
"identity": 24
Type: Number
This is the unique numeric identifier for the PackageFrequencyPackageCurrency
isActive
"isActive": true
Type: Boolean
Whether or not this combination of Package Frequency and Currency is active.
packageFrequencyId
"packageFrequencyId": 8
Type: Number
Unique identifier for the associated PackageFrequency object.
packageFrequencyName
"packageFrequencyName": "Sample Name"
Type: String
The name of the object associated with the packageFrequencyId property.
packageCurrencyId
"packageCurrencyId": 19
Type: Number
Unique identifier for the associated PackageCurrency object.
packageCurrencyName
"packageCurrencyName": "Sample Name"
Type: String
The name of the object associated with the packageCurrencyId property.


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:

  • isActive
  • packageFrequencyId
  • packageCurrencyId

End Points

GETapi/v3/Package/Frequency/Currency/
Retrieve all of the PackageFrequencyPackageCurrency objects.
Retrieve all of the PackageFrequencyPackageCurrency objects.
GET api/v3/Package/Frequency/Currency/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "isActive": true,
            "packageFrequencyId": 2,
            "packageFrequencyName": "Sample Text Data",
            "packageCurrencyId": 2,
            "packageCurrencyName": "Sample Text Data"
        }
    ]
}
GETapi/v3/Package/Frequency/Currency/Paged
Retrieve all of the PackageFrequencyPackageCurrency 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 PackageFrequencyPackageCurrency objects in a paged fashion.
GET api/v3/Package/Frequency/Currency/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,
                "isActive": true,
                "packageFrequencyId": 9,
                "packageFrequencyName": "Sample Text Data",
                "packageCurrencyId": 8,
                "packageCurrencyName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v3/Package/Frequency/Currency/{id}
Retrieve an instance of the PackageFrequencyPackageCurrency object by its ID.
{id}Unique identifier for the PackageFrequencyPackageCurrency object.
Retrieve an instance of the PackageFrequencyPackageCurrency object by its ID.
GET api/v3/Package/Frequency/Currency/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "isActive": true,
        "packageFrequencyId": 9,
        "packageFrequencyName": "Sample Text Data",
        "packageCurrencyId": 6,
        "packageCurrencyName": "Sample Text Data"
    }
}