TAG LINE
SMALL TITLE

Account / Package

(API Version v3)


This object contains all the information associated with a Package that has been assigned to an Account.


What can you do with AccountPackage?


    Properties

    Property Details
    identity
    READ-ONLY
    "identity": "Hello World"
    Type: String
    This is the unique numeric identifier for the AccountPackage
    accountId
    "accountId": 12
    Type: Number
    Unique identifier for the associated Account object.
    accountName
    "accountName": "Sample Name"
    Type: String
    The name of the object associated with the accountId 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.
    nextBill
    READ-ONLY
    "nextBill": "2021-04-26T15:25:27.587Z"
    Type: Date
    The date in which this account will be billed next.

    Date and time values are specified in the ISO 8601 format.
    name
    "name": "Hello World"
    Type: String
    The name of the Account Package.
    lastStatusChanged
    "lastStatusChanged": "2021-04-26T15:25:27.587Z"
    Type: Date
    Date and time values are specified in the ISO 8601 format.
    effective
    "effective": "2021-04-26T15:25:27.587Z"
    Type: Date
    The start date on when this Account Package is to have its charge calculated.

    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.
    effectiveCancel
    "effectiveCancel": "2021-04-26T15:25:27.587Z"
    Type: Date
    The date in which this Account Package should be cancelled.

    Date and time values are specified in the ISO 8601 format.
    packageFrequencyId
    "packageFrequencyId": 6
    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.
    termId
    "termId": 7
    Type: Number
    Unique identifier for the associated Term object.
    termName
    "termName": "Sample Name"
    Type: String
    The name of the object associated with the termId property.
    createdByUserId
    READ-ONLY
    "createdByUserId": 19
    Type: Number
    Unique identifier for the associated User object.
    createdByUserName
    READ-ONLY
    "createdByUserName": "Sample Name"
    Type: String
    The name of the object associated with the createdByUserId property.
    billDay
    "billDay": 7
    Type: Number
    If this Account Package is to be billed on a different day than the account's bill day.
    updatedByUserId
    READ-ONLY
    "updatedByUserId": 11
    Type: Number
    Unique identifier for the associated User object.
    updatedByUserName
    READ-ONLY
    "updatedByUserName": "Sample Name"
    Type: String
    The name of the object associated with the updatedByUserId property.
    usageBillDay
    "usageBillDay": 7
    Type: Number
    If this Account Package is to have it's usage billed on a different day than the account's usage bill day.
    activation
    "activation": "2021-04-26T15:25:27.587Z"
    Type: Date
    Date and time values are specified in the ISO 8601 format.
    finalBill
    READ-ONLY
    "finalBill": "2021-04-26T15:25:27.587Z"
    Type: Date
    The date when this Account Package had it's final bill generated. Applies to Account Packages that have been cancelled.

    Date and time values are specified in the ISO 8601 format.
    lastBilled
    READ-ONLY
    "lastBilled": "2021-04-26T15:25:27.587Z"
    Type: Date
    The date when this Account Package was last billed.

    Date and time values are specified in the ISO 8601 format.
    accountSharePlanId
    "accountSharePlanId": 21
    Type: Number
    Unique identifier for the associated AccountSharePlan object.
    accountSharePlanName
    "accountSharePlanName": "Sample Name"
    Type: String
    The name of the object associated with the accountSharePlanId property.
    lastUsageBilled
    READ-ONLY
    "lastUsageBilled": "2021-04-26T15:25:27.587Z"
    Type: Date
    The date when this Account Package's usage was last billed.

    Date and time values are specified in the ISO 8601 format.
    accountProductCodeId
    "accountProductCodeId": 4
    Type: Number
    Unique identifier for the associated AccountProductCode object.
    accountProductCodeName
    "accountProductCodeName": "Sample Name"
    Type: String
    The name of the object associated with the accountProductCodeId property.
    packageCategoryId
    "packageCategoryId": 21
    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
    READ-ONLY
    "chargeRecurringIfUsage": true
    Type: Boolean
    This is an inherited field from the Package that has been added to the account.
    updatedByPortalUserId
    READ-ONLY
    "updatedByPortalUserId": 15
    Type: Number
    If this Account Package has been updated by the end customer in the LogiSense customer portal, then this ID represents that User.

    Unique identifier for the associated PortalUser object.
    updatedByPortalUserName
    READ-ONLY
    "updatedByPortalUserName": "Sample Name"
    Type: String
    The name of the object associated with the updatedByPortalUserId property.
    id
    "id": "Hello World"
    Type: String


    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
    • accountId
    • name
    • lastStatusChanged
    • effective
    • effectiveCancel
    • packageFrequencyId
    • termId
    • billDay
    • usageBillDay
    • finalBill
    • accountSharePlanId
    • accountProductCodeId
    • packageCategoryId
    • chargeRecurringIfUsage
    • updatedByPortalUserId

    End Points