Documentation

Fields

• lineItemCreateAccounting_code :: Maybe Text

  accounting_code: Accounting Code for the `LineItem`. If `item_code`/`item_id` is part of the request then `accounting_code` must be absent.

  Constraints:

  • Maximum length of 20
  • Must match pattern '/^[a-z0-9_+-]+$/'
• lineItemCreateAvalara_service_type :: Maybe Int

  avalara_service_type: Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the line item is taxed. Refer to the documentation for more available t/s types. If an `Item` is associated to the `LineItem`, then the `avalara_service_type` must be absent.

  Constraints:

  • Minimum of 0.0
• lineItemCreateAvalara_transaction_type :: Maybe Int

  avalara_transaction_type: Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the line item is taxed. Refer to the documentation for more available t/s types. If an `Item` is associated to the `LineItem`, then the `avalara_transaction_type` must be absent.

  Constraints:

  • Minimum of 0.0
• lineItemCreateCredit_reason_code :: Maybe LineItemCreateCredit_reason_code

  credit_reason_code: The reason the credit was given when line item is `type=credit`. When the Credit Invoices feature is enabled, the value can be set and will default to `general`. When the Credit Invoices feature is not enabled, the value will always be `null`.

• lineItemCreateCurrency :: Text

  currency: 3-letter ISO 4217 currency code. If `item_code`/`item_id` is part of the request then `currency` is optional, if the site has a single default currency. `currency` is required if `item_code`/`item_id` is present, and there are multiple currencies defined on the site. If `item_code`/`item_id` is not present `currency` is required.

  Constraints:

  • Maximum length of 3
• lineItemCreateCustom_fields :: Maybe CustomFields

  custom_fields: The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.

• lineItemCreateDescription :: Maybe Text

  description: Description that appears on the invoice. If `item_code`/`item_id` is part of the request then `description` must be absent.

  Constraints:

  • Maximum length of 255
• lineItemCreateDestination_tax_address_source :: Maybe LineItemCreateDestination_tax_address_source

  destination_tax_address_source: The source of the address that will be used as the destinaion in determining taxes. Available only when the site is on an Elite plan. A value of "destination" refers to the "Customer tax address". A value of "origin" refers to the "Business entity tax address".

• lineItemCreateEnd_date :: Maybe JsonDateTime

  end_date: If this date is provided, it indicates the end of a time range.

• lineItemCreateItem_code :: Maybe Text

  item_code: Unique code to identify an item. Available when the Credit Invoices feature is enabled.

  Constraints:

  • Maximum length of 50
  • Must match pattern '/^[a-z0-9_+-]+$/'
• lineItemCreateItem_id :: Maybe Text

  item_id: System-generated unique identifier for an item. Available when the Credit Invoices feature is enabled.

  Constraints:

  • Maximum length of 13
• lineItemCreateLiability_gl_account_id :: Maybe Text

  liability_gl_account_id: The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.

  Constraints:

  • Maximum length of 13
• lineItemCreateOrigin :: Maybe LineItemCreateOrigin

  origin: Origin `external_gift_card` is allowed if the Gift Cards feature is enabled on your site and `type` is `credit`. Set this value in order to track gift card credits from external gift cards (like InComm). It also skips billing information requirements. Origin `prepayment` is only allowed if `type` is `charge` and `tax_exempt` is left blank or set to true. This origin creates a charge and opposite credit on the account to be used for future invoices.

• lineItemCreateOrigin_tax_address_source :: Maybe LineItemCreateOrigin_tax_address_source

  origin_tax_address_source: The source of the address that will be used as the origin in determining taxes. Available only when the site is on an Elite plan. A value of "origin" refers to the "Business entity tax address". A value of "destination" refers to the "Customer tax address".

• lineItemCreatePerformance_obligation_id :: Maybe Text

  performance_obligation_id: The ID of a performance obligation. Performance obligations are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.

  Constraints:

  • Maximum length of 13
• lineItemCreateProduct_code :: Maybe Text

  product_code: Optional field to track a product code or SKU for the line item. This can be used to later reporting on product purchases. For Vertex tax calculations, this field will be used as the Vertex `product` field. If `item_code`/`item_id` is part of the request then `product_code` must be absent.

  Constraints:

  • Maximum length of 50
• lineItemCreateQuantity :: Maybe Int

  quantity: This number will be multiplied by the unit amount to compute the subtotal before any discounts or taxes.

• lineItemCreateRevenue_gl_account_id :: Maybe Text

  revenue_gl_account_id: The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.

  Constraints:

  • Maximum length of 13
• lineItemCreateRevenue_schedule_type :: Maybe LineItemCreateRevenue_schedule_type

  revenue_schedule_type

• lineItemCreateStart_date :: Maybe JsonDateTime

  start_date: If an end date is present, this is value indicates the beginning of a billing time range. If no end date is present it indicates billing for a specific date. Defaults to the current date-time.

• lineItemCreateTax_code :: Maybe Text

  tax_code: Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-Box tax offering you can also choose to instead use simple values of `unknown`, `physical`, or `digital` tax codes.

  Constraints:

  • Maximum length of 50
• lineItemCreateTax_exempt :: Maybe Bool

  tax_exempt: `true` exempts tax on charges, `false` applies tax on charges. If not defined, then defaults to the Plan and Site settings. This attribute does not work for credits (negative line items). Credits are always applied post-tax. Pre-tax discounts should use the Coupons feature.

• lineItemCreateTax_inclusive :: Maybe Bool

  tax_inclusive: Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.

• lineItemCreateType :: LineItemCreateType

  type: Line item type. If `item_code`/`item_id` is present then `type` should not be present. If `item_code`/`item_id` is not present then `type` is required.

• lineItemCreateUnit_amount :: Float

  unit_amount: A positive or negative amount with `type=charge` will result in a positive `unit_amount`. A positive or negative amount with `type=credit` will result in a negative `unit_amount`. If `item_code`/`item_id` is present, `unit_amount` can be passed in, to override the `Item`'s `unit_amount`. If `item_code`/`item_id` is not present then `unit_amount` is required.