Package / Currency

(API Version v3)

Represents a linking of the different currencies in which a Package can be sold.

What can you do with PackageCurrency?

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

Properties

Property Details

identity READ-ONLY	"identity": 24 Type: Number This is the unique numeric identifier for the PackageCurrency
packageId	"packageId": 2 Type: Number Unique identifier for the associated Package object.
packageName	"packageName": "Sample Name" Type: String The name of the object associated with the packageId property.
currencyId	"currencyId": 16 Type: Number Unique identifier for the associated Currency object.
currencyName	"currencyName": "Sample Name" Type: String The name of the object associated with the currencyId 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:

identity
packageId
currencyId
currencyCode

End Points

Retrieve all of the PackageCurrency objects.

GET api/v3/Package/Currency/

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "packageId": 21,
            "packageName": "Sample Text Data",
            "currencyId": 6,
            "currencyName": "Sample Text Data"
        }
    ]
}

GET	api/v3/Package/Currency/Paged
Retrieve all of the PackageCurrency 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 PackageCurrency objects in a paged fashion. GET api/v3/Package/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, "packageId": 7, "packageName": "Sample Text Data", "currencyId": 5, "currencyName": "Sample Text Data" } ] } }

GET	api/v3/Package/Currency/{id}
Retrieve an instance of the PackageCurrency object by its ID.
{id}	Unique identifier for the PackageCurrency object.
Retrieve an instance of the PackageCurrency object by its ID. GET api/v3/Package/Currency/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "packageId": 23, "packageName": "Sample Text Data", "currencyId": 26, "currencyName": "Sample Text Data" } }