| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.PostInvoicesInvoice
Description
Contains the different functions to run the operation postInvoicesInvoice
Synopsis
- postInvoicesInvoice :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostInvoicesInvoiceRequestBody -> m (Either HttpException (Response PostInvoicesInvoiceResponse))
- postInvoicesInvoiceRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostInvoicesInvoiceRequestBody -> m (Either HttpException (Response ByteString))
- postInvoicesInvoiceM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostInvoicesInvoiceRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostInvoicesInvoiceResponse))
- postInvoicesInvoiceRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostInvoicesInvoiceRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data PostInvoicesInvoiceRequestBody = PostInvoicesInvoiceRequestBody {
- postInvoicesInvoiceRequestBodyApplicationFeeAmount :: Maybe Integer
- postInvoicesInvoiceRequestBodyAutoAdvance :: Maybe Bool
- postInvoicesInvoiceRequestBodyCollectionMethod :: Maybe PostInvoicesInvoiceRequestBodyCollectionMethod'
- postInvoicesInvoiceRequestBodyCustomFields :: Maybe PostInvoicesInvoiceRequestBodyCustomFields'Variants
- postInvoicesInvoiceRequestBodyDaysUntilDue :: Maybe Integer
- postInvoicesInvoiceRequestBodyDefaultPaymentMethod :: Maybe Text
- postInvoicesInvoiceRequestBodyDefaultSource :: Maybe Text
- postInvoicesInvoiceRequestBodyDefaultTaxRates :: Maybe PostInvoicesInvoiceRequestBodyDefaultTaxRates'Variants
- postInvoicesInvoiceRequestBodyDescription :: Maybe Text
- postInvoicesInvoiceRequestBodyDueDate :: Maybe Integer
- postInvoicesInvoiceRequestBodyExpand :: Maybe ([] Text)
- postInvoicesInvoiceRequestBodyFooter :: Maybe Text
- postInvoicesInvoiceRequestBodyMetadata :: Maybe PostInvoicesInvoiceRequestBodyMetadata'
- postInvoicesInvoiceRequestBodyStatementDescriptor :: Maybe Text
- postInvoicesInvoiceRequestBodyTaxPercent :: Maybe PostInvoicesInvoiceRequestBodyTaxPercent'Variants
- data PostInvoicesInvoiceRequestBodyCollectionMethod'
- data PostInvoicesInvoiceRequestBodyCustomFields'OneOf1
- data PostInvoicesInvoiceRequestBodyCustomFields'OneOf2 = PostInvoicesInvoiceRequestBodyCustomFields'OneOf2 {}
- data PostInvoicesInvoiceRequestBodyCustomFields'Variants
- data PostInvoicesInvoiceRequestBodyDefaultTaxRates'OneOf1
- data PostInvoicesInvoiceRequestBodyDefaultTaxRates'Variants
- data PostInvoicesInvoiceRequestBodyMetadata' = PostInvoicesInvoiceRequestBodyMetadata' {
- data PostInvoicesInvoiceRequestBodyTaxPercent'OneOf1
- data PostInvoicesInvoiceRequestBodyTaxPercent'Variants
- data PostInvoicesInvoiceResponse
Documentation
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> Text | invoice | Constraints: Maximum length of 5000 |
| -> Maybe PostInvoicesInvoiceRequestBody | The request body to send |
| -> m (Either HttpException (Response PostInvoicesInvoiceResponse)) | Monad containing the result of the operation |
POST /v1/invoices/{invoice}<p>Draft invoices are fully editable. Once an invoice is <a href="/docs/billing/invoices/workflow#finalized">finalized</a>, monetary values, as well as <code>collection_method</code>, become uneditable.</p>
<p>If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on, sending reminders for, or <a href="/docs/billing/invoices/reconciliation">automatically reconciling</a> invoices, pass <code>auto_advance=false</code>.</p>
postInvoicesInvoiceRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostInvoicesInvoiceRequestBody -> m (Either HttpException (Response ByteString)) Source #
POST /v1/invoices/{invoice}The same as postInvoicesInvoice but returns the raw ByteString
postInvoicesInvoiceM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostInvoicesInvoiceRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostInvoicesInvoiceResponse)) Source #
POST /v1/invoices/{invoice}Monadic version of postInvoicesInvoice (use with runWithConfiguration)
postInvoicesInvoiceRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostInvoicesInvoiceRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
POST /v1/invoices/{invoice}Monadic version of postInvoicesInvoiceRaw (use with runWithConfiguration)
data PostInvoicesInvoiceRequestBody Source #
Defines the data type for the schema postInvoicesInvoiceRequestBody
Constructors
| PostInvoicesInvoiceRequestBody | |
Fields
| |
Instances
data PostInvoicesInvoiceRequestBodyCollectionMethod' Source #
Defines the enum schema postInvoicesInvoiceRequestBodyCollection_method'
Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices.
Constructors
Instances
data PostInvoicesInvoiceRequestBodyCustomFields'OneOf1 Source #
Defines the enum schema postInvoicesInvoiceRequestBodyCustom_fields'OneOf1
Constructors
| PostInvoicesInvoiceRequestBodyCustomFields'OneOf1EnumOther Value | |
| PostInvoicesInvoiceRequestBodyCustomFields'OneOf1EnumTyped Text | |
| PostInvoicesInvoiceRequestBodyCustomFields'OneOf1EnumString_ |
Instances
data PostInvoicesInvoiceRequestBodyCustomFields'OneOf2 Source #
Defines the data type for the schema postInvoicesInvoiceRequestBodyCustom_fields'OneOf2
Constructors
| PostInvoicesInvoiceRequestBodyCustomFields'OneOf2 | |
Fields
| |
Instances
data PostInvoicesInvoiceRequestBodyCustomFields'Variants Source #
Define the one-of schema postInvoicesInvoiceRequestBodyCustom_fields'
A list of up to 4 custom fields to be displayed on the invoice. If a value for `custom_fields` is specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields.
Constructors
Instances
data PostInvoicesInvoiceRequestBodyDefaultTaxRates'OneOf1 Source #
Defines the enum schema postInvoicesInvoiceRequestBodyDefault_tax_rates'OneOf1
Constructors
| PostInvoicesInvoiceRequestBodyDefaultTaxRates'OneOf1EnumOther Value | |
| PostInvoicesInvoiceRequestBodyDefaultTaxRates'OneOf1EnumTyped Text | |
| PostInvoicesInvoiceRequestBodyDefaultTaxRates'OneOf1EnumString_ |
Instances
data PostInvoicesInvoiceRequestBodyDefaultTaxRates'Variants Source #
Define the one-of schema postInvoicesInvoiceRequestBodyDefault_tax_rates'
The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an empty string to remove previously-defined tax rates.
Constructors
Instances
data PostInvoicesInvoiceRequestBodyMetadata' Source #
Defines the data type for the schema postInvoicesInvoiceRequestBodyMetadata'
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
Constructors
| PostInvoicesInvoiceRequestBodyMetadata' | |
Instances
data PostInvoicesInvoiceRequestBodyTaxPercent'OneOf1 Source #
Defines the enum schema postInvoicesInvoiceRequestBodyTax_percent'OneOf1
Constructors
| PostInvoicesInvoiceRequestBodyTaxPercent'OneOf1EnumOther Value | |
| PostInvoicesInvoiceRequestBodyTaxPercent'OneOf1EnumTyped Text | |
| PostInvoicesInvoiceRequestBodyTaxPercent'OneOf1EnumString_ |
Instances
data PostInvoicesInvoiceRequestBodyTaxPercent'Variants Source #
Define the one-of schema postInvoicesInvoiceRequestBodyTax_percent'
The percent tax rate applied to the invoice, represented as a non-negative decimal number (with at most four decimal places) between 0 and 100. To unset a previously-set value, pass an empty string. This field can be updated only on `draft` invoices. This field has been deprecated and will be removed in a future API version, for further information view the migration docs for `tax_rates`.
Constructors
| PostInvoicesInvoiceRequestBodyTaxPercent'PostInvoicesInvoiceRequestBodyTaxPercent'OneOf1 PostInvoicesInvoiceRequestBodyTaxPercent'OneOf1 | |
| PostInvoicesInvoiceRequestBodyTaxPercent'Double Double |
Instances
data PostInvoicesInvoiceResponse Source #
Represents a response of the operation postInvoicesInvoice.
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), PostInvoicesInvoiceResponseError is used.
Constructors
| PostInvoicesInvoiceResponseError String | Means either no matching case available or a parse error |
| PostInvoicesInvoiceResponse200 Invoice | Successful response. |
| PostInvoicesInvoiceResponseDefault Error | Error response. |
Instances
| Eq PostInvoicesInvoiceResponse Source # | |
Defined in StripeAPI.Operations.PostInvoicesInvoice Methods (==) :: PostInvoicesInvoiceResponse -> PostInvoicesInvoiceResponse -> Bool # (/=) :: PostInvoicesInvoiceResponse -> PostInvoicesInvoiceResponse -> Bool # | |
| Show PostInvoicesInvoiceResponse Source # | |
Defined in StripeAPI.Operations.PostInvoicesInvoice Methods showsPrec :: Int -> PostInvoicesInvoiceResponse -> ShowS # show :: PostInvoicesInvoiceResponse -> String # showList :: [PostInvoicesInvoiceResponse] -> ShowS # | |