| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.PostInvoicesInvoiceVoid
Description
Contains the different functions to run the operation postInvoicesInvoiceVoid
Synopsis
- postInvoicesInvoiceVoid :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostInvoicesInvoiceVoidRequestBody -> m (Either HttpException (Response PostInvoicesInvoiceVoidResponse))
- postInvoicesInvoiceVoidRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostInvoicesInvoiceVoidRequestBody -> m (Either HttpException (Response ByteString))
- postInvoicesInvoiceVoidM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostInvoicesInvoiceVoidRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostInvoicesInvoiceVoidResponse))
- postInvoicesInvoiceVoidRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostInvoicesInvoiceVoidRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data PostInvoicesInvoiceVoidRequestBody = PostInvoicesInvoiceVoidRequestBody {}
- data PostInvoicesInvoiceVoidResponse
Documentation
postInvoicesInvoiceVoid Source #
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> String | invoice | Constraints: Maximum length of 5000 |
| -> PostInvoicesInvoiceVoidRequestBody | The request body to send |
| -> m (Either HttpException (Response PostInvoicesInvoiceVoidResponse)) | Monad containing the result of the operation |
POST /v1/invoices/{invoice}/void<p>Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to <a href="#delete_invoice">deletion</a>, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.</p>
postInvoicesInvoiceVoidRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostInvoicesInvoiceVoidRequestBody -> m (Either HttpException (Response ByteString)) Source #
POST /v1/invoices/{invoice}/voidThe same as postInvoicesInvoiceVoid but returns the raw ByteString
postInvoicesInvoiceVoidM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostInvoicesInvoiceVoidRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostInvoicesInvoiceVoidResponse)) Source #
POST /v1/invoices/{invoice}/voidMonadic version of postInvoicesInvoiceVoid (use with runWithConfiguration)
postInvoicesInvoiceVoidRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostInvoicesInvoiceVoidRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
POST /v1/invoices/{invoice}/voidMonadic version of postInvoicesInvoiceVoidRaw (use with runWithConfiguration)
data PostInvoicesInvoiceVoidRequestBody Source #
Defines the data type for the schema postInvoicesInvoiceVoidRequestBody
Constructors
| PostInvoicesInvoiceVoidRequestBody | |
Fields
| |
Instances
data PostInvoicesInvoiceVoidResponse Source #
Represents a response of the operation postInvoicesInvoiceVoid.
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), PostInvoicesInvoiceVoidResponseError is used.
Constructors
| PostInvoicesInvoiceVoidResponseError String | Means either no matching case available or a parse error |
| PostInvoicesInvoiceVoidResponse200 Invoice | Successful response. |
| PostInvoicesInvoiceVoidResponseDefault Error | Error response. |