Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostInvoicesInvoiceMarkUncollectible

Description

Contains the different functions to run the operation postInvoicesInvoiceMarkUncollectible

Synopsis

postInvoicesInvoiceMarkUncollectible :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostInvoicesInvoiceMarkUncollectibleRequestBody -> m (Either HttpException (Response PostInvoicesInvoiceMarkUncollectibleResponse))
postInvoicesInvoiceMarkUncollectibleRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostInvoicesInvoiceMarkUncollectibleRequestBody -> m (Either HttpException (Response ByteString))
postInvoicesInvoiceMarkUncollectibleM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostInvoicesInvoiceMarkUncollectibleRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostInvoicesInvoiceMarkUncollectibleResponse))
postInvoicesInvoiceMarkUncollectibleRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostInvoicesInvoiceMarkUncollectibleRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostInvoicesInvoiceMarkUncollectibleRequestBody = PostInvoicesInvoiceMarkUncollectibleRequestBody {
- postInvoicesInvoiceMarkUncollectibleRequestBodyExpand :: Maybe ([] Text)
}
data PostInvoicesInvoiceMarkUncollectibleResponse

Documentation

postInvoicesInvoiceMarkUncollectible Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Text	invoice \| Constraints: Maximum length of 5000
-> Maybe PostInvoicesInvoiceMarkUncollectibleRequestBody	The request body to send
-> m (Either HttpException (Response PostInvoicesInvoiceMarkUncollectibleResponse))	Monad containing the result of the operation

POST /v1/invoices/{invoice}/mark_uncollectible

<p>Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.</p>

postInvoicesInvoiceMarkUncollectibleRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostInvoicesInvoiceMarkUncollectibleRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/invoices/{invoice}/mark_uncollectible

The same as postInvoicesInvoiceMarkUncollectible but returns the raw ByteString

postInvoicesInvoiceMarkUncollectibleM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostInvoicesInvoiceMarkUncollectibleRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostInvoicesInvoiceMarkUncollectibleResponse)) Source #

POST /v1/invoices/{invoice}/mark_uncollectible

Monadic version of postInvoicesInvoiceMarkUncollectible (use with runWithConfiguration)

postInvoicesInvoiceMarkUncollectibleRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostInvoicesInvoiceMarkUncollectibleRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

POST /v1/invoices/{invoice}/mark_uncollectible

Monadic version of postInvoicesInvoiceMarkUncollectibleRaw (use with runWithConfiguration)

data PostInvoicesInvoiceMarkUncollectibleRequestBody Source #

Defines the data type for the schema postInvoicesInvoiceMarkUncollectibleRequestBody

Constructors

PostInvoicesInvoiceMarkUncollectibleRequestBody
Fields postInvoicesInvoiceMarkUncollectibleRequestBodyExpand :: Maybe ([] Text) expand: Specifies which fields in the response should be expanded.

Instances

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

data PostInvoicesInvoiceMarkUncollectibleResponse Source #

Represents a response of the operation postInvoicesInvoiceMarkUncollectible.

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), PostInvoicesInvoiceMarkUncollectibleResponseError is used.

Constructors

PostInvoicesInvoiceMarkUncollectibleResponseError String	Means either no matching case available or a parse error
PostInvoicesInvoiceMarkUncollectibleResponse200 Invoice	Successful response.
PostInvoicesInvoiceMarkUncollectibleResponseDefault Error	Error response.

Instances

Eq PostInvoicesInvoiceMarkUncollectibleResponse Source #
Instance details Defined in StripeAPI.Operations.PostInvoicesInvoiceMarkUncollectible Methods (==) :: PostInvoicesInvoiceMarkUncollectibleResponse -> PostInvoicesInvoiceMarkUncollectibleResponse -> Bool # (/=) :: PostInvoicesInvoiceMarkUncollectibleResponse -> PostInvoicesInvoiceMarkUncollectibleResponse -> Bool #
Show PostInvoicesInvoiceMarkUncollectibleResponse Source #
Instance details Defined in StripeAPI.Operations.PostInvoicesInvoiceMarkUncollectible Methods showsPrec :: Int -> PostInvoicesInvoiceMarkUncollectibleResponse -> ShowS # show :: PostInvoicesInvoiceMarkUncollectibleResponse -> String # showList :: [PostInvoicesInvoiceMarkUncollectibleResponse] -> ShowS #