recurly-client-0.1.0.0: Client for Recurly subscription management
Safe HaskellSafe-Inferred
LanguageHaskell2010

RecurlyClient.Types.ItemCreate

Description

Contains the types generated from the schema ItemCreate

Synopsis

Documentation

data ItemCreate Source #

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

Constructors

ItemCreate 

Fields

  • itemCreateAccounting_code :: Maybe Text

    accounting_code: Accounting code for invoice line items.

    Constraints:

    • Maximum length of 20
    • Must match pattern '/^[a-z0-9_+-]+$/'
  • itemCreateAvalara_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
  • itemCreateAvalara_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
  • itemCreateCode :: Text

    code: Unique code to identify the item.

    Constraints:

    • Maximum length of 50
    • Must match pattern '/^[a-z0-9_+-]+$/'
  • itemCreateCurrencies :: Maybe [Pricing]

    currencies

  • itemCreateCustom_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.

  • itemCreateDescription :: Maybe Text

    description: Optional, description.

  • itemCreateExternal_sku :: Maybe Text

    external_sku: Optional, stock keeping unit to link the item to other inventory systems.

    Constraints:

    • Maximum length of 50
  • itemCreateLiability_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
  • itemCreateName :: 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
  • itemCreatePerformance_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
  • itemCreateRevenue_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
  • itemCreateRevenue_schedule_type :: Maybe ItemCreateRevenue_schedule_type

    revenue_schedule_type

  • itemCreateTax_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
  • itemCreateTax_exempt :: Maybe Bool

    tax_exempt: `true` exempts tax on the item, `false` applies tax on the item.

mkItemCreate Source #

Create a new ItemCreate with all required fields.

data ItemCreateRevenue_schedule_type Source #

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

Constructors

ItemCreateRevenue_schedule_typeOther Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

ItemCreateRevenue_schedule_typeTyped Text

This constructor can be used to send values to the server which are not present in the specification yet.

ItemCreateRevenue_schedule_typeEnumAt_range_end

Represents the JSON value "at_range_end"

ItemCreateRevenue_schedule_typeEnumAt_range_start

Represents the JSON value "at_range_start"

ItemCreateRevenue_schedule_typeEnumEvenly

Represents the JSON value "evenly"

ItemCreateRevenue_schedule_typeEnumNever

Represents the JSON value "never"