IPPCurrency.php

Show:

inherited

Classes
- \IPPCurrency

Table of Contents

Package: Default

\IPPCurrency
jump to top

Package: Default

Parent(s): \IPPIntuitEntity
Inherited_from: \IPPIntuitEntity
IPPCurrency: \IPPCurrency
XmlDefinition: Describes the properties of currencies defined in QuickBooks. QuickBooks supports the world's common currencies.
XmlName: IPPCurrency
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: IntuitEntity

Properties

boolean $Active

Details

Type: boolean
Definition: Whether or not active inactive Currency may be hidden from most display purposes and may not be used on financial transactions. [b][i]QuickBooks Notes[/i][/b] [br /] Inactive Currencies are not used when downloading the exchange rates.
XmlMinOccurs: 0
XmlName: Active
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $AsOfDate

Details

Type: string
XmlMinOccurs: 0
XmlName: AsOfDate
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPAttachableRef $AttachableRef

Details

Type: \com\intuit\schema\finance\v3\IPPAttachableRef
Definition: Specifies entity name of the attachment from where the attachment was requested
XmlMaxOccurs: unbounded
XmlMinOccurs: 0
XmlName: AttachableRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPcurrencyCode $Code

Details

Type: \com\intuit\schema\finance\v3\IPPcurrencyCode
Definition: Currency universal 3-letter code, like USD, CAD, EUR, etc. [b][i]QuickBooks Notes[/i][/b] [br /] Required for the create operation. [br /] Max Length: 3
XmlMinOccurs: 0
XmlName: Code
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPIntuitAnyType $CurrencyEx

Details

Type: \com\intuit\schema\finance\v3\IPPIntuitAnyType
Definition: Internal use only: extension place holder for Currency
XmlMinOccurs: 0
XmlName: CurrencyEx
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPCustomField $CustomField

Details

Type: \com\intuit\schema\finance\v3\IPPCustomField
Definition: Product: QBW Description: Custom field (or data extension). Filterable: QBW
XmlMaxOccurs: unbounded
XmlMinOccurs: 0
XmlName: CustomField
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

integer $DecimalPlaces

Details

Type: integer
Definition: Specifies how many decimal places can be shown. Usually there will be 2, or 0 for currencies without "cents". [b][i]QuickBooks Notes[/i][/b] [br /] Max Length: 1
XmlMinOccurs: 0
XmlName: DecimalPlaces
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $DecimalSeparator

Details

Type: string
Definition: Used for display purpose, can be a comma or a period.
XmlMinOccurs: 0
XmlName: DecimalSeparator
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

float $ExchangeRate

Details

Type: float
XmlMinOccurs: 0
XmlName: ExchangeRate
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $Format

Details

Type: string
Definition: Specifies how to present the value, used for the display purpose for example, ##,###,### or #,##,##,### [b][i]QuickBooks Notes[/i][/b] [br /] Max Length: 32
XmlMinOccurs: 0
XmlName: Format
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPid $Id

Details

Type: \com\intuit\schema\finance\v3\IPPid
Definition: Product: ALL Description: Unique Identifier for an Intuit entity (object). [br /]Required for the update operation. Required: ALL Filterable: ALL
XmlMinOccurs: 0
XmlName: Id
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPModificationMetaData $MetaData

Details

Type: \com\intuit\schema\finance\v3\IPPModificationMetaData
Definition: Product: ALL Description: Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.
XmlMinOccurs: 0
XmlName: MetaData
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $Name

Details

Type: string
Definition: Currency name. Length Restriction: QBO: 15 QBW: 1024
XmlMinOccurs: 0
XmlName: Name
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $Separator

Details

Type: string
Definition: "Thousand separator" character, used for the display purpose. [b][i]QuickBooks Notes[/i][/b] [br /] Max Length: 1
XmlMinOccurs: 0
XmlName: Separator
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $Symbol

Details

Type: string
XmlMinOccurs: 0
XmlName: Symbol
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPSymbolPositionEnum $SymbolPosition

Details

Type: \com\intuit\schema\finance\v3\IPPSymbolPositionEnum
Definition: Used for display purpose to specify where to show the Currency Symbol.
XmlMinOccurs: 0
XmlName: SymbolPosition
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $SyncToken

Details

Type: string
Definition: Product: ALL Description: Version number of the entity. The SyncToken is used to lock the entity for use by one application at a time. As soon as an application modifies an entity, its SyncToken is incremented; another application's request to modify the entity with the same SyncToken will fail. Only the latest version of the entity is maintained by Data Services. An attempt to modify an entity specifying an older SyncToken will fail. [br /]Required for the update operation. Required: ALL
XmlMinOccurs: 0
XmlName: SyncToken
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

boolean $UserDefined

Details

Type: boolean
Definition: [b][i]QuickBooks Notes[/i][/b] [br /] QuickBooks predefines the most common world currencies, however it does allow the user to define the new one. The user-defined currency however cannot have the exchange rates downloaded.
XmlMinOccurs: 0
XmlName: UserDefined
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $domain

Details

Type: string
Definition: Product: ALL Description: Domain in which the entity belongs.
XmlName: domain
XmlType: attribute

boolean $sparse

Details

Type: boolean
Definition: Product: ALL Description: True if the entity representation has a partial set of elements. Output only field.
XmlName: sparse
XmlType: attribute

array<mixed,\EntityStatusEnum> $status

Details

Type: array<mixed,\EntityStatusEnum>
Definition: Product: ALL Description: System status of the entity. Output only field.[br /] Filterable: ALL
XmlName: status
XmlType: attribute

Methods

__construct(\dictionary $keyValInitializers = array(), boolean $verbose = FALSE) : void

Initializes this object, optionally with pre-defined property values

Initializes this object and it's property members, using the dictionary of key/value pairs passed as an optional argument.

Parameters

Name	Type	Description
$keyValInitializers	\dictionary	key/value pairs to be populated into object's properties
$verbose	boolean	specifies whether object should echo warnings

__construct(\dictionary $keyValInitializers = array(), boolean $verbose = FALSE) : void

inherited

Initializes this object, optionally with pre-defined property values

Inherited from:

Initializes this object and it's property members, using the dictionary of key/value pairs passed as an optional argument.

Parameters

Name	Type	Description
$keyValInitializers	\dictionary	key/value pairs to be populated into object's properties
$verbose	boolean	specifies whether object should echo warnings

IPPCurrency.php

\IPPCurrencyjump to top

Properties

Methods

\IPPCurrency
jump to top