RecurlyClient.Types.BusinessEntity

Contains the types generated from the schema BusinessEntity

Documentation

data BusinessEntity

Defines the object schema located at components.schemas.BusinessEntity in the specification.

Business entity details

Constructors

BusinessEntity

Fields

• businessEntityCode :: Maybe Text

  code: The entity code of the business entity.

  Constraints:

  • Maximum length of 50
• businessEntityCreated_at :: Maybe JsonDateTime

  created_at

• businessEntityDefault_liability_gl_account_id :: Maybe Text

  default_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
• businessEntityDefault_registration_number :: Maybe Text

  default_registration_number: Registration number for the customer used on the invoice.

  Constraints:

  • Maximum length of 30
• businessEntityDefault_revenue_gl_account_id :: Maybe Text

  default_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
• businessEntityDefault_vat_number :: Maybe Text

  default_vat_number: VAT number for the customer used on the invoice.

  Constraints:

  • Maximum length of 20
• businessEntityDestination_tax_address_source :: Maybe BusinessEntityDestination_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".

• businessEntityId :: Maybe Text

  id

  Constraints:

  • Maximum length of 13
• businessEntityInvoice_display_address :: Maybe Address

  invoice_display_address

• businessEntityName :: Maybe Text

  name: This name describes your business entity and will appear on the invoice.

  Constraints:

  • Maximum length of 255
• businessEntityObject :: Maybe Text

  object

• businessEntityOrigin_tax_address_source :: Maybe BusinessEntityOrigin_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".

• businessEntitySubscriber_location_countries :: Maybe [Text]

  subscriber_location_countries: List of countries for which the business entity will be used.

• businessEntityTax_address :: Maybe Address

  tax_address

• businessEntityUpdated_at :: Maybe JsonDateTime

  updated_at

Instances

FromJSON BusinessEntity

Defined in RecurlyClient.Types.BusinessEntity

Methods

parseJSON :: Value -> Parser BusinessEntity

parseJSONList :: Value -> Parser [BusinessEntity]

ToJSON BusinessEntity

Defined in RecurlyClient.Types.BusinessEntity

Methods

toJSON :: BusinessEntity -> Value

toEncoding :: BusinessEntity -> Encoding

toJSONList :: [BusinessEntity] -> Value

toEncodingList :: [BusinessEntity] -> Encoding

Show BusinessEntity

Defined in RecurlyClient.Types.BusinessEntity

Methods

showsPrec :: Int -> BusinessEntity -> ShowS

show :: BusinessEntity -> String

showList :: [BusinessEntity] -> ShowS

Eq BusinessEntity

Defined in RecurlyClient.Types.BusinessEntity

Methods

(==) :: BusinessEntity -> BusinessEntity -> Bool

(/=) :: BusinessEntity -> BusinessEntity -> Bool

mkBusinessEntity :: BusinessEntity

Create a new BusinessEntity with all required fields.

data BusinessEntityDestination_tax_address_source

Defines the enum schema located at components.schemas.BusinessEntity.properties.destination_tax_address_source in the specification.

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".

Constructors

BusinessEntityDestination_tax_address_sourceOther Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

BusinessEntityDestination_tax_address_sourceTyped Text

This constructor can be used to send values to the server which are not present in the specification yet.

BusinessEntityDestination_tax_address_sourceEnumDestination

Represents the JSON value "destination"

BusinessEntityDestination_tax_address_sourceEnumOrigin

Represents the JSON value "origin"

Instances

FromJSON BusinessEntityDestination_tax_address_source

Defined in RecurlyClient.Types.BusinessEntity

Methods

parseJSON :: Value -> Parser BusinessEntityDestination_tax_address_source

parseJSONList :: Value -> Parser [BusinessEntityDestination_tax_address_source]

ToJSON BusinessEntityDestination_tax_address_source

Defined in RecurlyClient.Types.BusinessEntity

Methods

toJSON :: BusinessEntityDestination_tax_address_source -> Value

toEncoding :: BusinessEntityDestination_tax_address_source -> Encoding

toJSONList :: [BusinessEntityDestination_tax_address_source] -> Value

toEncodingList :: [BusinessEntityDestination_tax_address_source] -> Encoding

Show BusinessEntityDestination_tax_address_source

Defined in RecurlyClient.Types.BusinessEntity

Methods

showsPrec :: Int -> BusinessEntityDestination_tax_address_source -> ShowS

show :: BusinessEntityDestination_tax_address_source -> String

showList :: [BusinessEntityDestination_tax_address_source] -> ShowS

Eq BusinessEntityDestination_tax_address_source

Defined in RecurlyClient.Types.BusinessEntity

Methods

(==) :: BusinessEntityDestination_tax_address_source -> BusinessEntityDestination_tax_address_source -> Bool

(/=) :: BusinessEntityDestination_tax_address_source -> BusinessEntityDestination_tax_address_source -> Bool

data BusinessEntityOrigin_tax_address_source

Defines the enum schema located at components.schemas.BusinessEntity.properties.origin_tax_address_source in the specification.

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".

Constructors

BusinessEntityOrigin_tax_address_sourceOther Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

BusinessEntityOrigin_tax_address_sourceTyped Text

This constructor can be used to send values to the server which are not present in the specification yet.

BusinessEntityOrigin_tax_address_sourceEnumOrigin

Represents the JSON value "origin"

BusinessEntityOrigin_tax_address_sourceEnumDestination

Represents the JSON value "destination"

Instances

FromJSON BusinessEntityOrigin_tax_address_source

Defined in RecurlyClient.Types.BusinessEntity

Methods

parseJSON :: Value -> Parser BusinessEntityOrigin_tax_address_source

parseJSONList :: Value -> Parser [BusinessEntityOrigin_tax_address_source]

ToJSON BusinessEntityOrigin_tax_address_source

Defined in RecurlyClient.Types.BusinessEntity

Methods

toJSON :: BusinessEntityOrigin_tax_address_source -> Value

toEncoding :: BusinessEntityOrigin_tax_address_source -> Encoding

toJSONList :: [BusinessEntityOrigin_tax_address_source] -> Value

toEncodingList :: [BusinessEntityOrigin_tax_address_source] -> Encoding

Show BusinessEntityOrigin_tax_address_source

Defined in RecurlyClient.Types.BusinessEntity

Methods

showsPrec :: Int -> BusinessEntityOrigin_tax_address_source -> ShowS

show :: BusinessEntityOrigin_tax_address_source -> String

showList :: [BusinessEntityOrigin_tax_address_source] -> ShowS

Eq BusinessEntityOrigin_tax_address_source

Defined in RecurlyClient.Types.BusinessEntity

Methods

(==) :: BusinessEntityOrigin_tax_address_source -> BusinessEntityOrigin_tax_address_source -> Bool

(/=) :: BusinessEntityOrigin_tax_address_source -> BusinessEntityOrigin_tax_address_source -> Bool