| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.PostInvoicesInvoiceVoid
Description
Contains the different functions to run the operation postInvoicesInvoiceVoid
Synopsis
- postInvoicesInvoiceVoid :: forall m. MonadHTTP m => Text -> Maybe PostInvoicesInvoiceVoidRequestBody -> ClientT m (Response PostInvoicesInvoiceVoidResponse)
- data PostInvoicesInvoiceVoidRequestBody = PostInvoicesInvoiceVoidRequestBody {}
- mkPostInvoicesInvoiceVoidRequestBody :: PostInvoicesInvoiceVoidRequestBody
- data PostInvoicesInvoiceVoidResponse
Documentation
postInvoicesInvoiceVoid Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Text | invoice | Constraints: Maximum length of 5000 |
| -> Maybe PostInvoicesInvoiceVoidRequestBody | The request body to send |
| -> ClientT m (Response PostInvoicesInvoiceVoidResponse) | Monadic computation which returns 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>
data PostInvoicesInvoiceVoidRequestBody Source #
Defines the object schema located at paths./v1/invoices/{invoice}/void.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.
Constructors
| PostInvoicesInvoiceVoidRequestBody | |
Fields
| |
Instances
mkPostInvoicesInvoiceVoidRequestBody :: PostInvoicesInvoiceVoidRequestBody Source #
Create a new PostInvoicesInvoiceVoidRequestBody with all required fields.
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. |