Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Operations.List_general_ledger_accounts

Description

Contains the different functions to run the operation list_general_ledger_accounts

Synopsis

list_general_ledger_accounts :: forall m. MonadHTTP m => List_general_ledger_accountsParameters -> ClientT m (Response List_general_ledger_accountsResponse)
data List_general_ledger_accountsParameters = List_general_ledger_accountsParameters {
}
mkList_general_ledger_accountsParameters :: List_general_ledger_accountsParameters
data List_general_ledger_accountsParametersQueryAccount_type
data List_general_ledger_accountsParametersQueryOrder
data List_general_ledger_accountsParametersQuerySort
data List_general_ledger_accountsResponse
list_general_ledger_accountsWithConfiguration :: forall m. MonadHTTP m => Configuration -> List_general_ledger_accountsParameters -> m (Response List_general_ledger_accountsResponse)
list_general_ledger_accountsRaw :: forall m. MonadHTTP m => List_general_ledger_accountsParameters -> ClientT m (Response ByteString)
list_general_ledger_accountsWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> List_general_ledger_accountsParameters -> m (Response ByteString)

Documentation

list_general_ledger_accounts Source #

Arguments

:: forall m. MonadHTTP m
=> List_general_ledger_accountsParameters	Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response List_general_ledger_accountsResponse)	Monadic computation which returns the result of the operation

GET /general_ledger_accounts

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

data List_general_ledger_accountsParameters Source #

Defines the object schema located at paths./general_ledger_accounts.GET.parameters in the specification.

Constructors

List_general_ledger_accountsParameters

Fields

list_general_ledger_accountsParametersQueryAccount_type :: Maybe List_general_ledger_accountsParametersQueryAccount_type
queryAccount_type: Represents the parameter named 'account_type'
General Ledger Account type by which to filter the response.
list_general_ledger_accountsParametersQueryIds :: Maybe [Text]
queryIds: Represents the parameter named 'ids'
Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`.
- *Important notes:**
- The `ids` parameter cannot be used with any other ordering or filtering parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
- Invalid or unknown IDs will be ignored, so you should check that the results correspond to your request.
- Records are returned in an arbitrary order. Since results are all returned at once you can sort the records yourself.
list_general_ledger_accountsParametersQueryLimit :: Maybe Int
queryLimit: Represents the parameter named 'limit'
Limit number of records 1-200.
Constraints:
- Maxium of 200.0
- Minimum of 1.0
list_general_ledger_accountsParametersQueryOrder :: Maybe List_general_ledger_accountsParametersQueryOrder
queryOrder: Represents the parameter named 'order'
Sort order.
list_general_ledger_accountsParametersQuerySort :: Maybe List_general_ledger_accountsParametersQuerySort
querySort: Represents the parameter named 'sort'
Sort field. You *really* only want to sort by `updated_at` in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.

Instances

Instances details

FromJSON List_general_ledger_accountsParameters Source #
Instance details Defined in RecurlyClient.Operations.List_general_ledger_accounts Methods parseJSON :: Value -> Parser List_general_ledger_accountsParameters # parseJSONList :: Value -> Parser [List_general_ledger_accountsParameters] #
ToJSON List_general_ledger_accountsParameters Source #
Instance details Defined in RecurlyClient.Operations.List_general_ledger_accounts Methods toJSON :: List_general_ledger_accountsParameters -> Value # toEncoding :: List_general_ledger_accountsParameters -> Encoding # toJSONList :: [List_general_ledger_accountsParameters] -> Value # toEncodingList :: [List_general_ledger_accountsParameters] -> Encoding #
Show List_general_ledger_accountsParameters Source #
Instance details Defined in RecurlyClient.Operations.List_general_ledger_accounts Methods showsPrec :: Int -> List_general_ledger_accountsParameters -> ShowS # show :: List_general_ledger_accountsParameters -> String # showList :: [List_general_ledger_accountsParameters] -> ShowS #
Eq List_general_ledger_accountsParameters Source #
Instance details Defined in RecurlyClient.Operations.List_general_ledger_accounts Methods (==) :: List_general_ledger_accountsParameters -> List_general_ledger_accountsParameters -> Bool # (/=) :: List_general_ledger_accountsParameters -> List_general_ledger_accountsParameters -> Bool #

mkList_general_ledger_accountsParameters :: List_general_ledger_accountsParameters Source #

Create a new List_general_ledger_accountsParameters with all required fields.

data List_general_ledger_accountsParametersQueryAccount_type Source #

Defines the enum schema located at paths./general_ledger_accounts.GET.parameters.properties.queryAccount_type in the specification.

Represents the parameter named 'account_type'

General Ledger Account type by which to filter the response.

Constructors

List_general_ledger_accountsParametersQueryAccount_typeOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
List_general_ledger_accountsParametersQueryAccount_typeTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
List_general_ledger_accountsParametersQueryAccount_typeEnumLiability	Represents the JSON value `"liability"`
List_general_ledger_accountsParametersQueryAccount_typeEnumRevenue	Represents the JSON value `"revenue"`

Instances

Instances details

FromJSON List_general_ledger_accountsParametersQueryAccount_type Source #
Instance details Defined in RecurlyClient.Operations.List_general_ledger_accounts Methods parseJSON :: Value -> Parser List_general_ledger_accountsParametersQueryAccount_type # parseJSONList :: Value -> Parser [List_general_ledger_accountsParametersQueryAccount_type] #
ToJSON List_general_ledger_accountsParametersQueryAccount_type Source #
Instance details Defined in RecurlyClient.Operations.List_general_ledger_accounts Methods toJSON :: List_general_ledger_accountsParametersQueryAccount_type -> Value # toEncoding :: List_general_ledger_accountsParametersQueryAccount_type -> Encoding # toJSONList :: [List_general_ledger_accountsParametersQueryAccount_type] -> Value # toEncodingList :: [List_general_ledger_accountsParametersQueryAccount_type] -> Encoding #
Show List_general_ledger_accountsParametersQueryAccount_type Source #
Instance details Defined in RecurlyClient.Operations.List_general_ledger_accounts Methods showsPrec :: Int -> List_general_ledger_accountsParametersQueryAccount_type -> ShowS # show :: List_general_ledger_accountsParametersQueryAccount_type -> String # showList :: [List_general_ledger_accountsParametersQueryAccount_type] -> ShowS #
Eq List_general_ledger_accountsParametersQueryAccount_type Source #
Instance details Defined in RecurlyClient.Operations.List_general_ledger_accounts Methods (==) :: List_general_ledger_accountsParametersQueryAccount_type -> List_general_ledger_accountsParametersQueryAccount_type -> Bool # (/=) :: List_general_ledger_accountsParametersQueryAccount_type -> List_general_ledger_accountsParametersQueryAccount_type -> Bool #

data List_general_ledger_accountsParametersQueryOrder Source #

Defines the enum schema located at paths./general_ledger_accounts.GET.parameters.properties.queryOrder in the specification.

Represents the parameter named 'order'

Sort order.

Constructors

List_general_ledger_accountsParametersQueryOrderOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
List_general_ledger_accountsParametersQueryOrderTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
List_general_ledger_accountsParametersQueryOrderEnumAsc	Represents the JSON value `"asc"`
List_general_ledger_accountsParametersQueryOrderEnumDesc	Represents the JSON value `"desc"`

Instances

Instances details

FromJSON List_general_ledger_accountsParametersQueryOrder Source #
Instance details Defined in RecurlyClient.Operations.List_general_ledger_accounts Methods parseJSON :: Value -> Parser List_general_ledger_accountsParametersQueryOrder # parseJSONList :: Value -> Parser [List_general_ledger_accountsParametersQueryOrder] #
ToJSON List_general_ledger_accountsParametersQueryOrder Source #
Instance details Defined in RecurlyClient.Operations.List_general_ledger_accounts Methods toJSON :: List_general_ledger_accountsParametersQueryOrder -> Value # toEncoding :: List_general_ledger_accountsParametersQueryOrder -> Encoding # toJSONList :: [List_general_ledger_accountsParametersQueryOrder] -> Value # toEncodingList :: [List_general_ledger_accountsParametersQueryOrder] -> Encoding #
Show List_general_ledger_accountsParametersQueryOrder Source #
Instance details Defined in RecurlyClient.Operations.List_general_ledger_accounts Methods showsPrec :: Int -> List_general_ledger_accountsParametersQueryOrder -> ShowS # show :: List_general_ledger_accountsParametersQueryOrder -> String # showList :: [List_general_ledger_accountsParametersQueryOrder] -> ShowS #
Eq List_general_ledger_accountsParametersQueryOrder Source #
Instance details Defined in RecurlyClient.Operations.List_general_ledger_accounts Methods (==) :: List_general_ledger_accountsParametersQueryOrder -> List_general_ledger_accountsParametersQueryOrder -> Bool # (/=) :: List_general_ledger_accountsParametersQueryOrder -> List_general_ledger_accountsParametersQueryOrder -> Bool #

data List_general_ledger_accountsParametersQuerySort Source #

Defines the enum schema located at paths./general_ledger_accounts.GET.parameters.properties.querySort in the specification.

Represents the parameter named 'sort'

Sort field. You *really* only want to sort by `updated_at` in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.

Constructors

List_general_ledger_accountsParametersQuerySortOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
List_general_ledger_accountsParametersQuerySortTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
List_general_ledger_accountsParametersQuerySortEnumCreated_at	Represents the JSON value `"created_at"`
List_general_ledger_accountsParametersQuerySortEnumUpdated_at	Represents the JSON value `"updated_at"`

Instances

Instances details

FromJSON List_general_ledger_accountsParametersQuerySort Source #
Instance details Defined in RecurlyClient.Operations.List_general_ledger_accounts Methods parseJSON :: Value -> Parser List_general_ledger_accountsParametersQuerySort # parseJSONList :: Value -> Parser [List_general_ledger_accountsParametersQuerySort] #
ToJSON List_general_ledger_accountsParametersQuerySort Source #
Instance details Defined in RecurlyClient.Operations.List_general_ledger_accounts Methods toJSON :: List_general_ledger_accountsParametersQuerySort -> Value # toEncoding :: List_general_ledger_accountsParametersQuerySort -> Encoding # toJSONList :: [List_general_ledger_accountsParametersQuerySort] -> Value # toEncodingList :: [List_general_ledger_accountsParametersQuerySort] -> Encoding #
Show List_general_ledger_accountsParametersQuerySort Source #
Instance details Defined in RecurlyClient.Operations.List_general_ledger_accounts Methods showsPrec :: Int -> List_general_ledger_accountsParametersQuerySort -> ShowS # show :: List_general_ledger_accountsParametersQuerySort -> String # showList :: [List_general_ledger_accountsParametersQuerySort] -> ShowS #
Eq List_general_ledger_accountsParametersQuerySort Source #
Instance details Defined in RecurlyClient.Operations.List_general_ledger_accounts Methods (==) :: List_general_ledger_accountsParametersQuerySort -> List_general_ledger_accountsParametersQuerySort -> Bool # (/=) :: List_general_ledger_accountsParametersQuerySort -> List_general_ledger_accountsParametersQuerySort -> Bool #

data List_general_ledger_accountsResponse Source #

Represents a response of the operation list_general_ledger_accounts.

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_general_ledger_accountsResponseError is used.

Constructors

List_general_ledger_accountsResponseError String	Means either no matching case available or a parse error
List_general_ledger_accountsResponse200 GeneralLedgerAccountList	A list of the site's general ledger accounts.
List_general_ledger_accountsResponse404 Error	Incorrect site ID.

Instances

Instances details

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

list_general_ledger_accountsWithConfiguration Source #

Arguments

:: forall m. MonadHTTP m
=> Configuration	The configuration to use in the request
-> List_general_ledger_accountsParameters	Contains all available parameters of this operation (query and path parameters)
-> m (Response List_general_ledger_accountsResponse)	Monadic computation which returns the result of the operation

GET /general_ledger_accounts

The same as list_general_ledger_accounts but accepts an explicit configuration.

list_general_ledger_accountsRaw Source #

Arguments

:: forall m. MonadHTTP m
=> List_general_ledger_accountsParameters	Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response ByteString)	Monadic computation which returns the result of the operation

GET /general_ledger_accounts

The same as list_general_ledger_accounts but returns the raw ByteString.

list_general_ledger_accountsWithConfigurationRaw Source #

Arguments

:: forall m. MonadHTTP m
=> Configuration	The configuration to use in the request
-> List_general_ledger_accountsParameters	Contains all available parameters of this operation (query and path parameters)
-> m (Response ByteString)	Monadic computation which returns the result of the operation

GET /general_ledger_accounts

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