Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Operations.List_related_invoices

Description

Contains the different functions to run the operation list_related_invoices

Synopsis

list_related_invoices :: forall m. MonadHTTP m => Text -> ClientT m (Response List_related_invoicesResponse)
data List_related_invoicesResponse
list_related_invoicesWithConfiguration :: forall m. MonadHTTP m => Configuration -> Text -> m (Response List_related_invoicesResponse)
list_related_invoicesRaw :: forall m. MonadHTTP m => Text -> ClientT m (Response ByteString)
list_related_invoicesWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> Text -> m (Response ByteString)

Documentation

list_related_invoices 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 List_related_invoicesResponse)	Monadic computation which returns the result of the operation

GET /invoices/{invoice_id}/related_invoices

Related invoices provide a link between credit invoices and the charge invoices that they are refunding. For a charge invoice the related invoices will be credit invoices. For a credit invoice the related invoices will be charge invoices.

See the Pagination Guide to learn how to use pagination in the API and Client Libraries.

Represents a response of the operation list_related_invoices.

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

Constructors

List_related_invoicesResponseError String	Means either no matching case available or a parse error
List_related_invoicesResponse200 InvoiceList	A list of the credit or charge invoices associated with the invoice.
List_related_invoicesResponse404 Error	Incorrect site or invoice ID.
List_related_invoicesResponseDefault Error	Unexpected error.

Instances

Instances details

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

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 List_related_invoicesResponse)	Monadic computation which returns the result of the operation

GET /invoices/{invoice_id}/related_invoices

The same as list_related_invoices but accepts an explicit configuration.

list_related_invoicesRaw 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

GET /invoices/{invoice_id}/related_invoices

The same as list_related_invoices but returns the raw ByteString.

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

GET /invoices/{invoice_id}/related_invoices

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