Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the different functions to run the operation getCreditNotesPreviewLines
Synopsis
- getCreditNotesPreviewLines :: forall m. MonadHTTP m => GetCreditNotesPreviewLinesParameters -> StripeT m (Response GetCreditNotesPreviewLinesResponse)
- data GetCreditNotesPreviewLinesParameters = GetCreditNotesPreviewLinesParameters {
- getCreditNotesPreviewLinesParametersQueryAmount :: Maybe Int
- getCreditNotesPreviewLinesParametersQueryCreditAmount :: Maybe Int
- getCreditNotesPreviewLinesParametersQueryEndingBefore :: Maybe Text
- getCreditNotesPreviewLinesParametersQueryExpand :: Maybe [Text]
- getCreditNotesPreviewLinesParametersQueryInvoice :: Text
- getCreditNotesPreviewLinesParametersQueryLimit :: Maybe Int
- getCreditNotesPreviewLinesParametersQueryLines :: Maybe [GetCreditNotesPreviewLinesParametersQueryLines']
- getCreditNotesPreviewLinesParametersQueryMemo :: Maybe Text
- getCreditNotesPreviewLinesParametersQueryMetadata :: Maybe Object
- getCreditNotesPreviewLinesParametersQueryOutOfBandAmount :: Maybe Int
- getCreditNotesPreviewLinesParametersQueryReason :: Maybe GetCreditNotesPreviewLinesParametersQueryReason'
- getCreditNotesPreviewLinesParametersQueryRefund :: Maybe Text
- getCreditNotesPreviewLinesParametersQueryRefundAmount :: Maybe Int
- getCreditNotesPreviewLinesParametersQueryStartingAfter :: Maybe Text
- mkGetCreditNotesPreviewLinesParameters :: Text -> GetCreditNotesPreviewLinesParameters
- data GetCreditNotesPreviewLinesParametersQueryLines' = GetCreditNotesPreviewLinesParametersQueryLines' {
- getCreditNotesPreviewLinesParametersQueryLines'Amount :: Maybe Int
- getCreditNotesPreviewLinesParametersQueryLines'Description :: Maybe Text
- getCreditNotesPreviewLinesParametersQueryLines'InvoiceLineItem :: Maybe Text
- getCreditNotesPreviewLinesParametersQueryLines'Quantity :: Maybe Int
- getCreditNotesPreviewLinesParametersQueryLines'TaxRates :: Maybe GetCreditNotesPreviewLinesParametersQueryLines'TaxRates'Variants
- getCreditNotesPreviewLinesParametersQueryLines'Type :: GetCreditNotesPreviewLinesParametersQueryLines'Type'
- getCreditNotesPreviewLinesParametersQueryLines'UnitAmount :: Maybe Int
- getCreditNotesPreviewLinesParametersQueryLines'UnitAmountDecimal :: Maybe Text
- mkGetCreditNotesPreviewLinesParametersQueryLines' :: GetCreditNotesPreviewLinesParametersQueryLines'Type' -> GetCreditNotesPreviewLinesParametersQueryLines'
- data GetCreditNotesPreviewLinesParametersQueryLines'TaxRates'Variants
- data GetCreditNotesPreviewLinesParametersQueryLines'Type'
- data GetCreditNotesPreviewLinesParametersQueryReason'
- = GetCreditNotesPreviewLinesParametersQueryReason'Other Value
- | GetCreditNotesPreviewLinesParametersQueryReason'Typed Text
- | GetCreditNotesPreviewLinesParametersQueryReason'EnumDuplicate
- | GetCreditNotesPreviewLinesParametersQueryReason'EnumFraudulent
- | GetCreditNotesPreviewLinesParametersQueryReason'EnumOrderChange
- | GetCreditNotesPreviewLinesParametersQueryReason'EnumProductUnsatisfactory
- data GetCreditNotesPreviewLinesResponse
- data GetCreditNotesPreviewLinesResponseBody200 = GetCreditNotesPreviewLinesResponseBody200 {}
- mkGetCreditNotesPreviewLinesResponseBody200 :: [CreditNoteLineItem] -> Bool -> Text -> GetCreditNotesPreviewLinesResponseBody200
Documentation
getCreditNotesPreviewLines Source #
:: forall m. MonadHTTP m | |
=> GetCreditNotesPreviewLinesParameters | Contains all available parameters of this operation (query and path parameters) |
-> StripeT m (Response GetCreditNotesPreviewLinesResponse) | Monadic computation which returns the result of the operation |
GET /v1/credit_notes/preview/lines
<p>When retrieving a credit note preview, you’ll get a <strong>lines</strong> property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.</p>
data GetCreditNotesPreviewLinesParameters Source #
Defines the object schema located at paths./v1/credit_notes/preview/lines.GET.parameters
in the specification.
GetCreditNotesPreviewLinesParameters | |
|
mkGetCreditNotesPreviewLinesParameters Source #
Create a new GetCreditNotesPreviewLinesParameters
with all required fields.
data GetCreditNotesPreviewLinesParametersQueryLines' Source #
Defines the object schema located at paths./v1/credit_notes/preview/lines.GET.parameters.properties.queryLines.items
in the specification.
GetCreditNotesPreviewLinesParametersQueryLines' | |
|
mkGetCreditNotesPreviewLinesParametersQueryLines' Source #
:: GetCreditNotesPreviewLinesParametersQueryLines'Type' | |
-> GetCreditNotesPreviewLinesParametersQueryLines' |
Create a new GetCreditNotesPreviewLinesParametersQueryLines'
with all required fields.
data GetCreditNotesPreviewLinesParametersQueryLines'TaxRates'Variants Source #
Defines the oneOf schema located at paths./v1/credit_notes/preview/lines.GET.parameters.properties.queryLines.items.properties.tax_rates.anyOf
in the specification.
GetCreditNotesPreviewLinesParametersQueryLines'TaxRates'EmptyString | Represents the JSON value |
GetCreditNotesPreviewLinesParametersQueryLines'TaxRates'ListTText [Text] |
Instances
data GetCreditNotesPreviewLinesParametersQueryLines'Type' Source #
Defines the enum schema located at paths./v1/credit_notes/preview/lines.GET.parameters.properties.queryLines.items.properties.type
in the specification.
GetCreditNotesPreviewLinesParametersQueryLines'Type'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
GetCreditNotesPreviewLinesParametersQueryLines'Type'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
GetCreditNotesPreviewLinesParametersQueryLines'Type'EnumCustomLineItem | Represents the JSON value |
GetCreditNotesPreviewLinesParametersQueryLines'Type'EnumInvoiceLineItem | Represents the JSON value |
Instances
data GetCreditNotesPreviewLinesParametersQueryReason' Source #
Defines the enum schema located at paths./v1/credit_notes/preview/lines.GET.parameters.properties.queryReason
in the specification.
Represents the parameter named 'reason'
Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
GetCreditNotesPreviewLinesParametersQueryReason'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
GetCreditNotesPreviewLinesParametersQueryReason'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
GetCreditNotesPreviewLinesParametersQueryReason'EnumDuplicate | Represents the JSON value |
GetCreditNotesPreviewLinesParametersQueryReason'EnumFraudulent | Represents the JSON value |
GetCreditNotesPreviewLinesParametersQueryReason'EnumOrderChange | Represents the JSON value |
GetCreditNotesPreviewLinesParametersQueryReason'EnumProductUnsatisfactory | Represents the JSON value |
Instances
data GetCreditNotesPreviewLinesResponse Source #
Represents a response of the operation getCreditNotesPreviewLines
.
The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), GetCreditNotesPreviewLinesResponseError
is used.
GetCreditNotesPreviewLinesResponseError String | Means either no matching case available or a parse error |
GetCreditNotesPreviewLinesResponse200 GetCreditNotesPreviewLinesResponseBody200 | Successful response. |
GetCreditNotesPreviewLinesResponseDefault Error | Error response. |
data GetCreditNotesPreviewLinesResponseBody200 Source #
Defines the object schema located at paths./v1/credit_notes/preview/lines.GET.responses.200.content.application/json.schema
in the specification.
GetCreditNotesPreviewLinesResponseBody200 | |
|
mkGetCreditNotesPreviewLinesResponseBody200 Source #
Create a new GetCreditNotesPreviewLinesResponseBody200
with all required fields.