Safe Haskell	None
Language	Haskell2010

StripeAPI.Types.CreditNoteLineItem

Description

Contains the types generated from the schema CreditNoteLineItem

Synopsis

data CreditNoteLineItem = CreditNoteLineItem {
}
mkCreditNoteLineItem :: Int -> Int -> [DiscountsResourceDiscountAmount] -> Text -> Bool -> [CreditNoteTaxAmount] -> [TaxRate] -> CreditNoteLineItemType' -> CreditNoteLineItem
data CreditNoteLineItemType'

Documentation

data CreditNoteLineItem Source #

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

Constructors

CreditNoteLineItem

Fields

creditNoteLineItemAmount :: Int
amount: The integer amount in %s representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.
creditNoteLineItemDescription :: Maybe Text
description: Description of the item being credited.
Constraints:
- Maximum length of 5000
creditNoteLineItemDiscountAmount :: Int
discount_amount: The integer amount in %s representing the discount being credited for this line item.
creditNoteLineItemDiscountAmounts :: [DiscountsResourceDiscountAmount]
discount_amounts: The amount of discount calculated per discount for this line item
creditNoteLineItemId :: Text
id: Unique identifier for the object.
Constraints:
- Maximum length of 5000
creditNoteLineItemInvoiceLineItem :: Maybe Text
invoice_line_item: ID of the invoice line item being credited
Constraints:
- Maximum length of 5000
creditNoteLineItemLivemode :: Bool
livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
creditNoteLineItemQuantity :: Maybe Int
quantity: The number of units of product being credited.
creditNoteLineItemTaxAmounts :: [CreditNoteTaxAmount]
tax_amounts: The amount of tax calculated per tax rate for this line item
creditNoteLineItemTaxRates :: [TaxRate]
tax_rates: The tax rates which apply to the line item.
creditNoteLineItemType :: CreditNoteLineItemType'
type: The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice.
creditNoteLineItemUnitAmount :: Maybe Int
unit_amount: The cost of each unit of product being credited.
creditNoteLineItemUnitAmountDecimal :: Maybe Text
unit_amount_decimal: Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.

Instances

Instances details

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

mkCreditNoteLineItem Source #

Arguments

:: Int	`creditNoteLineItemAmount`
-> Int	`creditNoteLineItemDiscountAmount`
-> [DiscountsResourceDiscountAmount]	`creditNoteLineItemDiscountAmounts`
-> Text	`creditNoteLineItemId`
-> Bool	`creditNoteLineItemLivemode`
-> [CreditNoteTaxAmount]	`creditNoteLineItemTaxAmounts`
-> [TaxRate]	`creditNoteLineItemTaxRates`
-> CreditNoteLineItemType'	`creditNoteLineItemType`
-> CreditNoteLineItem

Create a new CreditNoteLineItem with all required fields.

data CreditNoteLineItemType' Source #

Defines the enum schema located at components.schemas.credit_note_line_item.properties.type in the specification.

The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice.

Constructors

CreditNoteLineItemType'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
CreditNoteLineItemType'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
CreditNoteLineItemType'EnumCustomLineItem	Represents the JSON value `"custom_line_item"`
CreditNoteLineItemType'EnumInvoiceLineItem	Represents the JSON value `"invoice_line_item"`

Instances

Instances details

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