Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Types.Item

Description

Contains the types generated from the schema Item

Synopsis

data Item = Item {
- itemAccounting_code :: Maybe Text
- itemAvalara_service_type :: Maybe Int
- itemAvalara_transaction_type :: Maybe Int
- itemCode :: Maybe Text
- itemCreated_at :: Maybe JsonDateTime
- itemCurrencies :: Maybe [Pricing]
- itemCustom_fields :: Maybe CustomFields
- itemDeleted_at :: Maybe JsonDateTime
- itemDescription :: Maybe Text
- itemExternal_sku :: Maybe Text
- itemId :: Maybe Text
- itemLiability_gl_account_id :: Maybe Text
- itemName :: Maybe Text
- itemObject :: Maybe Text
- itemPerformance_obligation_id :: Maybe Text
- itemRevenue_gl_account_id :: Maybe Text
- itemRevenue_schedule_type :: Maybe ItemRevenue_schedule_type
- itemState :: Maybe ItemState
- itemTax_code :: Maybe Text
- itemTax_exempt :: Maybe Bool
- itemUpdated_at :: Maybe JsonDateTime
}
mkItem :: Item
data ItemRevenue_schedule_type
data ItemState

Documentation

data Item Source #

Defines the object schema located at components.schemas.Item in the specification.

Full item details.

Constructors

Item

Fields

itemAccounting_code :: Maybe Text
accounting_code: Accounting code for invoice line items.
Constraints:
- Maximum length of 20
- Must match pattern '/^[a-z0-9_+-]+$/'
itemAvalara_service_type :: Maybe Int
avalara_service_type: Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the item is taxed. Refer to the documentation for more available t/s types.
Constraints:
- Minimum of 0.0
itemAvalara_transaction_type :: Maybe Int
avalara_transaction_type: Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the item is taxed. Refer to the documentation for more available t/s types.
Constraints:
- Minimum of 0.0
itemCode :: Maybe Text
code: Unique code to identify the item.
Constraints:
- Maximum length of 50
- Must match pattern '/^[a-z0-9_+-]+$/'
itemCreated_at :: Maybe JsonDateTime
created_at
itemCurrencies :: Maybe [Pricing]
currencies
itemCustom_fields :: Maybe CustomFields
custom_fields: The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
itemDeleted_at :: Maybe JsonDateTime
deleted_at
itemDescription :: Maybe Text
description: Optional, description.
itemExternal_sku :: Maybe Text
external_sku: Optional, stock keeping unit to link the item to other inventory systems.
Constraints:
- Maximum length of 50
itemId :: Maybe Text
id
Constraints:
- Maximum length of 13
itemLiability_gl_account_id :: Maybe Text
liability_gl_account_id: The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
Constraints:
- Maximum length of 13
itemName :: Maybe Text
name: This name describes your item and will appear on the invoice when it's purchased on a one time basis.
Constraints:
- Maximum length of 255
itemObject :: Maybe Text
object
itemPerformance_obligation_id :: Maybe Text
performance_obligation_id: The ID of a performance obligation. Performance obligations are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
Constraints:
- Maximum length of 13
itemRevenue_gl_account_id :: Maybe Text
revenue_gl_account_id: The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
Constraints:
- Maximum length of 13
itemRevenue_schedule_type :: Maybe ItemRevenue_schedule_type
revenue_schedule_type
itemState :: Maybe ItemState
state: The current state of the item.
itemTax_code :: Maybe Text
tax_code: Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-Box tax offering you can also choose to instead use simple values of `unknown`, `physical`, or `digital` tax codes.
Constraints:
- Maximum length of 50
itemTax_exempt :: Maybe Bool
tax_exempt: `true` exempts tax on the item, `false` applies tax on the item.
itemUpdated_at :: Maybe JsonDateTime
updated_at

Instances

Instances details

FromJSON Item Source #
Instance details Defined in RecurlyClient.Types.Item Methods parseJSON :: Value -> Parser Item # parseJSONList :: Value -> Parser [Item] #
ToJSON Item Source #
Instance details Defined in RecurlyClient.Types.Item Methods toJSON :: Item -> Value # toEncoding :: Item -> Encoding # toJSONList :: [Item] -> Value # toEncodingList :: [Item] -> Encoding #
Show Item Source #
Instance details Defined in RecurlyClient.Types.Item Methods showsPrec :: Int -> Item -> ShowS # show :: Item -> String # showList :: [Item] -> ShowS #
Eq Item Source #
Instance details Defined in RecurlyClient.Types.Item Methods (==) :: Item -> Item -> Bool # (/=) :: Item -> Item -> Bool #

mkItem :: Item Source #

Create a new Item with all required fields.

data ItemRevenue_schedule_type Source #

Defines the enum schema located at components.schemas.Item.properties.revenue_schedule_type in the specification.

Constructors

ItemRevenue_schedule_typeOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
ItemRevenue_schedule_typeTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
ItemRevenue_schedule_typeEnumAt_range_end	Represents the JSON value `"at_range_end"`
ItemRevenue_schedule_typeEnumAt_range_start	Represents the JSON value `"at_range_start"`
ItemRevenue_schedule_typeEnumEvenly	Represents the JSON value `"evenly"`
ItemRevenue_schedule_typeEnumNever	Represents the JSON value `"never"`

Instances

Instances details

FromJSON ItemRevenue_schedule_type Source #
Instance details Defined in RecurlyClient.Types.Item Methods parseJSON :: Value -> Parser ItemRevenue_schedule_type # parseJSONList :: Value -> Parser [ItemRevenue_schedule_type] #
ToJSON ItemRevenue_schedule_type Source #
Instance details Defined in RecurlyClient.Types.Item Methods toJSON :: ItemRevenue_schedule_type -> Value # toEncoding :: ItemRevenue_schedule_type -> Encoding # toJSONList :: [ItemRevenue_schedule_type] -> Value # toEncodingList :: [ItemRevenue_schedule_type] -> Encoding #
Show ItemRevenue_schedule_type Source #
Instance details Defined in RecurlyClient.Types.Item Methods showsPrec :: Int -> ItemRevenue_schedule_type -> ShowS # show :: ItemRevenue_schedule_type -> String # showList :: [ItemRevenue_schedule_type] -> ShowS #
Eq ItemRevenue_schedule_type Source #
Instance details Defined in RecurlyClient.Types.Item Methods (==) :: ItemRevenue_schedule_type -> ItemRevenue_schedule_type -> Bool # (/=) :: ItemRevenue_schedule_type -> ItemRevenue_schedule_type -> Bool #

data ItemState Source #

Defines the enum schema located at components.schemas.Item.properties.state in the specification.

The current state of the item.

Constructors

ItemStateOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
ItemStateTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
ItemStateEnumActive	Represents the JSON value `"active"`
ItemStateEnumInactive	Represents the JSON value `"inactive"`

Instances

Instances details

FromJSON ItemState Source #
Instance details Defined in RecurlyClient.Types.Item Methods parseJSON :: Value -> Parser ItemState # parseJSONList :: Value -> Parser [ItemState] #
ToJSON ItemState Source #
Instance details Defined in RecurlyClient.Types.Item Methods toJSON :: ItemState -> Value # toEncoding :: ItemState -> Encoding # toJSONList :: [ItemState] -> Value # toEncodingList :: [ItemState] -> Encoding #
Show ItemState Source #
Instance details Defined in RecurlyClient.Types.Item Methods showsPrec :: Int -> ItemState -> ShowS # show :: ItemState -> String # showList :: [ItemState] -> ShowS #
Eq ItemState Source #
Instance details Defined in RecurlyClient.Types.Item Methods (==) :: ItemState -> ItemState -> Bool # (/=) :: ItemState -> ItemState -> Bool #