Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the different functions to run the operation postInvoiceitemsInvoiceitem
Synopsis
- postInvoiceitemsInvoiceitem :: forall m. MonadHTTP m => Text -> Maybe PostInvoiceitemsInvoiceitemRequestBody -> ClientT m (Response PostInvoiceitemsInvoiceitemResponse)
- data PostInvoiceitemsInvoiceitemRequestBody = PostInvoiceitemsInvoiceitemRequestBody {
- postInvoiceitemsInvoiceitemRequestBodyAmount :: Maybe Int
- postInvoiceitemsInvoiceitemRequestBodyDescription :: Maybe Text
- postInvoiceitemsInvoiceitemRequestBodyDiscountable :: Maybe Bool
- postInvoiceitemsInvoiceitemRequestBodyDiscounts :: Maybe PostInvoiceitemsInvoiceitemRequestBodyDiscounts'Variants
- postInvoiceitemsInvoiceitemRequestBodyExpand :: Maybe [Text]
- postInvoiceitemsInvoiceitemRequestBodyMetadata :: Maybe PostInvoiceitemsInvoiceitemRequestBodyMetadata'Variants
- postInvoiceitemsInvoiceitemRequestBodyPeriod :: Maybe PostInvoiceitemsInvoiceitemRequestBodyPeriod'
- postInvoiceitemsInvoiceitemRequestBodyPrice :: Maybe Text
- postInvoiceitemsInvoiceitemRequestBodyPriceData :: Maybe PostInvoiceitemsInvoiceitemRequestBodyPriceData'
- postInvoiceitemsInvoiceitemRequestBodyQuantity :: Maybe Int
- postInvoiceitemsInvoiceitemRequestBodyTaxRates :: Maybe PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants
- postInvoiceitemsInvoiceitemRequestBodyUnitAmount :: Maybe Int
- postInvoiceitemsInvoiceitemRequestBodyUnitAmountDecimal :: Maybe Text
- mkPostInvoiceitemsInvoiceitemRequestBody :: PostInvoiceitemsInvoiceitemRequestBody
- data PostInvoiceitemsInvoiceitemRequestBodyDiscounts'OneOf1 = PostInvoiceitemsInvoiceitemRequestBodyDiscounts'OneOf1 {}
- mkPostInvoiceitemsInvoiceitemRequestBodyDiscounts'OneOf1 :: PostInvoiceitemsInvoiceitemRequestBodyDiscounts'OneOf1
- data PostInvoiceitemsInvoiceitemRequestBodyDiscounts'Variants
- data PostInvoiceitemsInvoiceitemRequestBodyMetadata'Variants
- data PostInvoiceitemsInvoiceitemRequestBodyPeriod' = PostInvoiceitemsInvoiceitemRequestBodyPeriod' {}
- mkPostInvoiceitemsInvoiceitemRequestBodyPeriod' :: Int -> Int -> PostInvoiceitemsInvoiceitemRequestBodyPeriod'
- data PostInvoiceitemsInvoiceitemRequestBodyPriceData' = PostInvoiceitemsInvoiceitemRequestBodyPriceData' {
- postInvoiceitemsInvoiceitemRequestBodyPriceData'Currency :: Text
- postInvoiceitemsInvoiceitemRequestBodyPriceData'Product :: Text
- postInvoiceitemsInvoiceitemRequestBodyPriceData'TaxBehavior :: Maybe PostInvoiceitemsInvoiceitemRequestBodyPriceData'TaxBehavior'
- postInvoiceitemsInvoiceitemRequestBodyPriceData'UnitAmount :: Maybe Int
- postInvoiceitemsInvoiceitemRequestBodyPriceData'UnitAmountDecimal :: Maybe Text
- mkPostInvoiceitemsInvoiceitemRequestBodyPriceData' :: Text -> Text -> PostInvoiceitemsInvoiceitemRequestBodyPriceData'
- data PostInvoiceitemsInvoiceitemRequestBodyPriceData'TaxBehavior'
- = PostInvoiceitemsInvoiceitemRequestBodyPriceData'TaxBehavior'Other Value
- | PostInvoiceitemsInvoiceitemRequestBodyPriceData'TaxBehavior'Typed Text
- | PostInvoiceitemsInvoiceitemRequestBodyPriceData'TaxBehavior'EnumExclusive
- | PostInvoiceitemsInvoiceitemRequestBodyPriceData'TaxBehavior'EnumInclusive
- | PostInvoiceitemsInvoiceitemRequestBodyPriceData'TaxBehavior'EnumUnspecified
- data PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants
- data PostInvoiceitemsInvoiceitemResponse
Documentation
postInvoiceitemsInvoiceitem Source #
:: forall m. MonadHTTP m | |
=> Text | invoiceitem | Constraints: Maximum length of 5000 |
-> Maybe PostInvoiceitemsInvoiceitemRequestBody | The request body to send |
-> ClientT m (Response PostInvoiceitemsInvoiceitemResponse) | Monadic computation which returns the result of the operation |
POST /v1/invoiceitems/{invoiceitem}
<p>Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed.</p>
data PostInvoiceitemsInvoiceitemRequestBody Source #
Defines the object schema located at paths./v1/invoiceitems/{invoiceitem}.POST.requestBody.content.application/x-www-form-urlencoded.schema
in the specification.
PostInvoiceitemsInvoiceitemRequestBody | |
|
mkPostInvoiceitemsInvoiceitemRequestBody :: PostInvoiceitemsInvoiceitemRequestBody Source #
Create a new PostInvoiceitemsInvoiceitemRequestBody
with all required fields.
data PostInvoiceitemsInvoiceitemRequestBodyDiscounts'OneOf1 Source #
Defines the object schema located at paths./v1/invoiceitems/{invoiceitem}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.discounts.anyOf.items
in the specification.
PostInvoiceitemsInvoiceitemRequestBodyDiscounts'OneOf1 | |
|
Instances
mkPostInvoiceitemsInvoiceitemRequestBodyDiscounts'OneOf1 :: PostInvoiceitemsInvoiceitemRequestBodyDiscounts'OneOf1 Source #
Create a new PostInvoiceitemsInvoiceitemRequestBodyDiscounts'OneOf1
with all required fields.
data PostInvoiceitemsInvoiceitemRequestBodyDiscounts'Variants Source #
Defines the oneOf schema located at paths./v1/invoiceitems/{invoiceitem}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.discounts.anyOf
in the specification.
The coupons & existing discounts which apply to the invoice item or invoice line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.
Instances
data PostInvoiceitemsInvoiceitemRequestBodyMetadata'Variants Source #
Defines the oneOf schema located at paths./v1/invoiceitems/{invoiceitem}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.metadata.anyOf
in the specification.
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`.
PostInvoiceitemsInvoiceitemRequestBodyMetadata'EmptyString | Represents the JSON value |
PostInvoiceitemsInvoiceitemRequestBodyMetadata'Object Object |
Instances
data PostInvoiceitemsInvoiceitemRequestBodyPeriod' Source #
Defines the object schema located at paths./v1/invoiceitems/{invoiceitem}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.period
in the specification.
The period associated with this invoice item.
mkPostInvoiceitemsInvoiceitemRequestBodyPeriod' Source #
Create a new PostInvoiceitemsInvoiceitemRequestBodyPeriod'
with all required fields.
data PostInvoiceitemsInvoiceitemRequestBodyPriceData' Source #
Defines the object schema located at paths./v1/invoiceitems/{invoiceitem}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.price_data
in the specification.
Data used to generate a new Price object inline.
PostInvoiceitemsInvoiceitemRequestBodyPriceData' | |
|
Instances
mkPostInvoiceitemsInvoiceitemRequestBodyPriceData' Source #
Create a new PostInvoiceitemsInvoiceitemRequestBodyPriceData'
with all required fields.
data PostInvoiceitemsInvoiceitemRequestBodyPriceData'TaxBehavior' Source #
Defines the enum schema located at paths./v1/invoiceitems/{invoiceitem}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.price_data.properties.tax_behavior
in the specification.
PostInvoiceitemsInvoiceitemRequestBodyPriceData'TaxBehavior'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PostInvoiceitemsInvoiceitemRequestBodyPriceData'TaxBehavior'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostInvoiceitemsInvoiceitemRequestBodyPriceData'TaxBehavior'EnumExclusive | Represents the JSON value |
PostInvoiceitemsInvoiceitemRequestBodyPriceData'TaxBehavior'EnumInclusive | Represents the JSON value |
PostInvoiceitemsInvoiceitemRequestBodyPriceData'TaxBehavior'EnumUnspecified | Represents the JSON value |
Instances
data PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants Source #
Defines the oneOf schema located at paths./v1/invoiceitems/{invoiceitem}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.tax_rates.anyOf
in the specification.
The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item. Pass an empty string to remove previously-defined tax rates.
PostInvoiceitemsInvoiceitemRequestBodyTaxRates'EmptyString | Represents the JSON value |
PostInvoiceitemsInvoiceitemRequestBodyTaxRates'ListTText [Text] |
Instances
data PostInvoiceitemsInvoiceitemResponse Source #
Represents a response of the operation postInvoiceitemsInvoiceitem
.
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), PostInvoiceitemsInvoiceitemResponseError
is used.
PostInvoiceitemsInvoiceitemResponseError String | Means either no matching case available or a parse error |
PostInvoiceitemsInvoiceitemResponse200 Invoiceitem | Successful response. |
PostInvoiceitemsInvoiceitemResponseDefault Error | Error response. |