Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Operations.Mark_invoice_failed

Description

Contains the different functions to run the operation mark_invoice_failed

Synopsis

mark_invoice_failed :: forall m. MonadHTTP m => Text -> ClientT m (Response Mark_invoice_failedResponse)
data Mark_invoice_failedResponse
mark_invoice_failedWithConfiguration :: forall m. MonadHTTP m => Configuration -> Text -> m (Response Mark_invoice_failedResponse)
mark_invoice_failedRaw :: forall m. MonadHTTP m => Text -> ClientT m (Response ByteString)
mark_invoice_failedWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> Text -> m (Response ByteString)

Documentation

mark_invoice_failed Source #

Arguments

:: forall m. MonadHTTP m
=> Text	invoice_id: Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`.
-> ClientT m (Response Mark_invoice_failedResponse)	Monadic computation which returns the result of the operation

PUT /invoices/{invoice_id}/mark_failed

Indicates that the invoice was not successfully paid for and that collection attempts should stop. This functionality is mostly used to halt the dunning procedures for an invoice.

Only invoices with the `pending`, `processing` or `past_due` states can be marked as failed.

data Mark_invoice_failedResponse Source #

Represents a response of the operation mark_invoice_failed.

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

Constructors

Mark_invoice_failedResponseError String	Means either no matching case available or a parse error
Mark_invoice_failedResponse200 Invoice	The updated invoice.
Mark_invoice_failedResponse404 Error	Incorrect site or invoice ID.
Mark_invoice_failedResponse422 Error	Tried marking a closed (successful or failed) invoice as failed.
Mark_invoice_failedResponseDefault Error	Unexpected error.

Instances

Instances details

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

mark_invoice_failedWithConfiguration Source #

Arguments

:: forall m. MonadHTTP m
=> Configuration	The configuration to use in the request
-> Text	invoice_id: Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`.
-> m (Response Mark_invoice_failedResponse)	Monadic computation which returns the result of the operation

PUT /invoices/{invoice_id}/mark_failed

The same as mark_invoice_failed but accepts an explicit configuration.

mark_invoice_failedRaw Source #

Arguments

:: forall m. MonadHTTP m
=> Text	invoice_id: Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`.
-> ClientT m (Response ByteString)	Monadic computation which returns the result of the operation

PUT /invoices/{invoice_id}/mark_failed

The same as mark_invoice_failed but returns the raw ByteString.

mark_invoice_failedWithConfigurationRaw Source #

Arguments

:: forall m. MonadHTTP m
=> Configuration	The configuration to use in the request
-> Text	invoice_id: Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`.
-> m (Response ByteString)	Monadic computation which returns the result of the operation

PUT /invoices/{invoice_id}/mark_failed

The same as mark_invoice_failed but accepts an explicit configuration and returns the raw ByteString.