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?

GET api/v3/Package/Frequency/Currency/
Retrieve all of the PackageFrequencyPackageCurrency objects.
GET api/v3/Package/Frequency/Currency/Paged
Retrieve all of the PackageFrequencyPackageCurrency objects in a paged fashion.
GET api/v3/Package/Frequency/Currency/{id}
Retrieve an instance of the PackageFrequencyPackageCurrency object by its ID.

Properties

Property Details

identity READ-ONLY	"identity": 22 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": 15 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": 5 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.
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.
updated	"updated": "2021-04-26T15:25:27.587Z" Type: Date Date and time values are specified in the ISO 8601 format.

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

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": 11,
            "packageFrequencyName": "Sample Text Data",
            "packageCurrencyId": 4,
            "packageCurrencyName": "Sample Text Data",
            "created": "2021-04-26T15:25:27.587Z",
            "updated": "2021-04-26T15:25:27.587Z"
        }
    ]
}

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": 21,
                "packageFrequencyName": "Sample Text Data",
                "packageCurrencyId": 7,
                "packageCurrencyName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}

GET	api/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": 25, "packageFrequencyName": "Sample Text Data", "packageCurrencyId": 25, "packageCurrencyName": "Sample Text Data", "created": "2021-04-26T15:25:27.587Z", "updated": "2021-04-26T15:25:27.587Z" } }