Skip to content

Fulfillment status sales order

POST
/rest/billing/salesOrders/{id}/fulfillment-status
curl --request POST \
--url https://api.shypr.app/rest/billing/salesOrders/example/fulfillment-status \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <X-API-KEY>' \
--data '{ "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "status": "example" }'

Creates a SalesOrder resource.

id
required
string

SalesOrder identifier

The new SalesOrder resource

object
id
required

More information

string format: uuid
status
required
string
<= 25 characters

Example generated

{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"status": "example"
}

SalesOrder resource created

object
isFulfilled
boolean | null
status
string
default: dft
Allowed values: o.p o.d o.c o.pc dft
invoices
Array<string>
packinglists
Array<string>
complaints
Array<string>
shipments
Array<string>
quote
string format: iri-reference
scheduledShipDate
string format: date-time
purchaseOrderDate
string format: date-time
purchaseOrderNumber
string
shipTo

The address as it was on the day of the document.

object
countryName
string
countryISOAlpha3
string
name
string
street
string
city
string
zip
string
streetNo
string | null
state
string | null
attention
string | null
fullAddress
string
lines

The lines of the address on a PDF: the street, the zip with the city and the state, the country.

Array<string>
country
object
name
string
alpha2Code
string
alpha3Code
string
region
string
taxRate
number
europeanRegion
boolean
europeanUnion
boolean
cancellationReason
string | null
cancellationDate
string | null format: date-time
cancelledBy
string | null format: iri-reference
notes
Array<string>
project
string | null format: iri-reference
shipToSourceId
string | null format: uuid
customerName
string
customerRef
string
customerId
string
customer
string format: iri-reference
subTotal

The net total, in minor units with 2 decimals, so 100000 is 1000.00.

object
amount

The amount.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart

Returns the fractional part of this decimal number.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart
object recursive
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
currency

The currency.

object
currencyCode

The currency code. For ISO currencies this will be the 3-letter uppercase ISO 4217 currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes.

string
numericCode

The numeric currency code. For ISO currencies this will be the ISO 4217 numeric currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes. Set to null if the currency does not have a numeric code.

integer | null
name

The currency name. For ISO currencies this will be the official English name of the currency. For non-ISO currencies no constraints are defined.

string
defaultFractionDigits

The default number of fraction digits (typical scale) used with this currency. For example, the default number of fraction digits for the Euro is 2, while for the Japanese Yen it is 0. This cannot be a negative number.

integer
currencyType

The type of the currency. For ISO currencies, this indicates whether the currency is currently in use (IsoCurrent) or has been withdrawn (IsoHistorical). For non-ISO currencies defined by the application, the type is Custom.

object
name
string
context

The context that defines the capability of this Money.

object
step

Returns the step used by this context.

integer
fixedScale

Returns whether this context produces a deterministic scale regardless of the input value.

boolean
minorAmount

Returns the amount of this Money in minor units (cents) for the currency.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart

Returns the fractional part of this decimal number.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart
object recursive
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
monies

This method satisfies the Monetary interface.

Array
sign

Returns the sign of this money.

integer
zero

Returns whether this money has zero value.

boolean
negative

Returns whether this money has a negative value.

boolean
negativeOrZero

Returns whether this money has a negative or zero value.

boolean
positive

Returns whether this money has a positive value.

boolean
positiveOrZero

Returns whether this money has a positive or zero value.

boolean
grandTotal

The total to pay, in minor units with 2 decimals, so 100000 is 1000.00.

object
amount

The amount.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart

Returns the fractional part of this decimal number.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart
object recursive
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
currency

The currency.

object
currencyCode

The currency code. For ISO currencies this will be the 3-letter uppercase ISO 4217 currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes.

string
numericCode

The numeric currency code. For ISO currencies this will be the ISO 4217 numeric currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes. Set to null if the currency does not have a numeric code.

integer | null
name

The currency name. For ISO currencies this will be the official English name of the currency. For non-ISO currencies no constraints are defined.

string
defaultFractionDigits

The default number of fraction digits (typical scale) used with this currency. For example, the default number of fraction digits for the Euro is 2, while for the Japanese Yen it is 0. This cannot be a negative number.

integer
currencyType

The type of the currency. For ISO currencies, this indicates whether the currency is currently in use (IsoCurrent) or has been withdrawn (IsoHistorical). For non-ISO currencies defined by the application, the type is Custom.

object
name
string
context

The context that defines the capability of this Money.

object
step

Returns the step used by this context.

integer
fixedScale

Returns whether this context produces a deterministic scale regardless of the input value.

boolean
minorAmount

Returns the amount of this Money in minor units (cents) for the currency.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart

Returns the fractional part of this decimal number.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart
object recursive
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
monies

This method satisfies the Monetary interface.

Array
sign

Returns the sign of this money.

integer
zero

Returns whether this money has zero value.

boolean
negative

Returns whether this money has a negative value.

boolean
negativeOrZero

Returns whether this money has a negative or zero value.

boolean
positive

Returns whether this money has a positive value.

boolean
positiveOrZero

Returns whether this money has a positive or zero value.

boolean
taxRate

The standard VAT rate of the record in percent, 21 for 21%, and 0 for a record without VAT.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart

Returns the fractional part of this decimal number.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart
object recursive
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
vatNote

Why a sale has no VAT at all (reverse charge or export), for the note on the PDF. Null for a record with VAT, a purchase, and a workspace outside the EU.

string | null
Allowed values: reverse_charge export
revision
integer | null
vatNumber
string | null
isFinalized
boolean
exchangeRate

The value of 1 of the document currency in the currency of the workspace, or null when no rate is known. A draft takes the ECB rate of getExchangeRateDate(), a finalized record keeps it. See docs/exchange-rates.md.

Any of:
object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart

Returns the fractional part of this decimal number.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart
object recursive
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
exchangeRateDate

The document date that the ECB rate is for, or null for a rate that a user typed. On a weekend or a holiday the rate is the one of the last working day before it.

string format: date-time
exchangeRateManual

True when a user typed the rate. The ECB rate does not replace it then.

boolean
products
Array<string>
displaySequenceId

The number of the system that a data import took the record from comes first.

string
totalsFrozen

The totals came from the file of a data import, so BillingRecordCalculatorListener does not compute them again: the record keeps the totals of the system that it came from. A new revision computes them again.

boolean
currency
object
currencyCode

The currency code. For ISO currencies this will be the 3-letter uppercase ISO 4217 currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes.

string
numericCode

The numeric currency code. For ISO currencies this will be the ISO 4217 numeric currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes. Set to null if the currency does not have a numeric code.

integer | null
name

The currency name. For ISO currencies this will be the official English name of the currency. For non-ISO currencies no constraints are defined.

string
defaultFractionDigits

The default number of fraction digits (typical scale) used with this currency. For example, the default number of fraction digits for the Euro is 2, while for the Japanese Yen it is 0. This cannot be a negative number.

integer
currencyType

The type of the currency. For ISO currencies, this indicates whether the currency is currently in use (IsoCurrent) or has been withdrawn (IsoHistorical). For non-ISO currencies defined by the application, the type is Custom.

object
name
string
contact

The contact as it was on the day of the document.

object
name
string
email
string | null
phoneNumber
string | null
faxNumber
string | null
mobileNumber
string | null
billTo

The address as it was on the day of the document.

object
countryName
string
countryISOAlpha3
string
name
string
street
string
city
string
zip
string
streetNo
string | null
state
string | null
attention
string | null
fullAddress
string
lines

The lines of the address on a PDF: the street, the zip with the city and the state, the country.

Array<string>
country
object
name
string
alpha2Code
string
alpha3Code
string
region
string
taxRate
number
europeanRegion
boolean
europeanUnion
boolean
billToSourceId

The address of the company that the bill-to copy came from. The form selects it again. No foreign key: a removed address does not break the document, and the PDF and the VAT read the copy. See docs/rolodex.md.

string | null format: uuid
contactSourceId

The contact of the company that the contact copy came from, as $billToSourceId.

string | null format: uuid
creator
string format: iri-reference
createdAt
string format: date-time
updatedAt
string | null format: date-time
file
string | null format: iri-reference
id

More information

string format: uuid
uid
string
legacyNumber
string | null
importedAt

When a data import made the record. Null: a user made it. An import updates only a record that an import made.

string | null format: date-time
sequenceId
integer
hasServiceProducts
boolean
statusType
string
Allowed values: o.p o.d o.c o.pc dft
statusTypeValue
string
onlyServiceLines

Nothing of this order ships: each line that is not fully cancelled is a service.

boolean
fulfilled
boolean
totalInvoices
integer
editable
boolean
cancelled
boolean
costTotal

The cost of the lines with a cost, in the currency of the workspace. Null when no line has a cost.

Any of:
object
amount

The amount.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart

Returns the fractional part of this decimal number.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart
object recursive
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
currency

The currency.

object
currencyCode

The currency code. For ISO currencies this will be the 3-letter uppercase ISO 4217 currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes.

string
numericCode

The numeric currency code. For ISO currencies this will be the ISO 4217 numeric currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes. Set to null if the currency does not have a numeric code.

integer | null
name

The currency name. For ISO currencies this will be the official English name of the currency. For non-ISO currencies no constraints are defined.

string
defaultFractionDigits

The default number of fraction digits (typical scale) used with this currency. For example, the default number of fraction digits for the Euro is 2, while for the Japanese Yen it is 0. This cannot be a negative number.

integer
currencyType

The type of the currency. For ISO currencies, this indicates whether the currency is currently in use (IsoCurrent) or has been withdrawn (IsoHistorical). For non-ISO currencies defined by the application, the type is Custom.

object
name
string
context

The context that defines the capability of this Money.

object
step

Returns the step used by this context.

integer
fixedScale

Returns whether this context produces a deterministic scale regardless of the input value.

boolean
minorAmount

Returns the amount of this Money in minor units (cents) for the currency.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart

Returns the fractional part of this decimal number.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart
object recursive
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
monies

This method satisfies the Monetary interface.

Array
sign

Returns the sign of this money.

integer
zero

Returns whether this money has zero value.

boolean
negative

Returns whether this money has a negative value.

boolean
negativeOrZero

Returns whether this money has a negative or zero value.

boolean
positive

Returns whether this money has a positive value.

boolean
positiveOrZero

Returns whether this money has a positive or zero value.

boolean
margin

The line totals minus their cost, in the currency of the workspace. Only the lines with a cost count, see getLinesWithoutCost(). Shipping and fees are not in it. Null without an exchange rate or without a line with a cost.

Any of:
object
amount

The amount.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart

Returns the fractional part of this decimal number.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart
object recursive
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
currency

The currency.

object
currencyCode

The currency code. For ISO currencies this will be the 3-letter uppercase ISO 4217 currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes.

string
numericCode

The numeric currency code. For ISO currencies this will be the ISO 4217 numeric currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes. Set to null if the currency does not have a numeric code.

integer | null
name

The currency name. For ISO currencies this will be the official English name of the currency. For non-ISO currencies no constraints are defined.

string
defaultFractionDigits

The default number of fraction digits (typical scale) used with this currency. For example, the default number of fraction digits for the Euro is 2, while for the Japanese Yen it is 0. This cannot be a negative number.

integer
currencyType

The type of the currency. For ISO currencies, this indicates whether the currency is currently in use (IsoCurrent) or has been withdrawn (IsoHistorical). For non-ISO currencies defined by the application, the type is Custom.

object
name
string
context

The context that defines the capability of this Money.

object
step

Returns the step used by this context.

integer
fixedScale

Returns whether this context produces a deterministic scale regardless of the input value.

boolean
minorAmount

Returns the amount of this Money in minor units (cents) for the currency.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart

Returns the fractional part of this decimal number.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart
object recursive
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
monies

This method satisfies the Monetary interface.

Array
sign

Returns the sign of this money.

integer
zero

Returns whether this money has zero value.

boolean
negative

Returns whether this money has a negative value.

boolean
negativeOrZero

Returns whether this money has a negative or zero value.

boolean
positive

Returns whether this money has a positive value.

boolean
positiveOrZero

Returns whether this money has a positive or zero value.

boolean
marginPercentage

The margin as a percentage of the line totals with a cost.

number | null
linesWithoutCost

The number of lines without a cost. They are not in the margin, so a margin with such lines is too high.

integer
shippingCost
object
amount

The amount.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart

Returns the fractional part of this decimal number.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart
object recursive
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
currency

The currency.

object
currencyCode

The currency code. For ISO currencies this will be the 3-letter uppercase ISO 4217 currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes.

string
numericCode

The numeric currency code. For ISO currencies this will be the ISO 4217 numeric currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes. Set to null if the currency does not have a numeric code.

integer | null
name

The currency name. For ISO currencies this will be the official English name of the currency. For non-ISO currencies no constraints are defined.

string
defaultFractionDigits

The default number of fraction digits (typical scale) used with this currency. For example, the default number of fraction digits for the Euro is 2, while for the Japanese Yen it is 0. This cannot be a negative number.

integer
currencyType

The type of the currency. For ISO currencies, this indicates whether the currency is currently in use (IsoCurrent) or has been withdrawn (IsoHistorical). For non-ISO currencies defined by the application, the type is Custom.

object
name
string
context

The context that defines the capability of this Money.

object
step

Returns the step used by this context.

integer
fixedScale

Returns whether this context produces a deterministic scale regardless of the input value.

boolean
minorAmount

Returns the amount of this Money in minor units (cents) for the currency.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart

Returns the fractional part of this decimal number.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart
object recursive
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
monies

This method satisfies the Monetary interface.

Array
sign

Returns the sign of this money.

integer
zero

Returns whether this money has zero value.

boolean
negative

Returns whether this money has a negative value.

boolean
negativeOrZero

Returns whether this money has a negative or zero value.

boolean
positive

Returns whether this money has a positive value.

boolean
positiveOrZero

Returns whether this money has a positive or zero value.

boolean
baseGrandTotal

The grand total in the currency of the workspace, or null when no rate is known.

Any of:
object
amount

The amount.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart

Returns the fractional part of this decimal number.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart
object recursive
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
currency

The currency.

object
currencyCode

The currency code. For ISO currencies this will be the 3-letter uppercase ISO 4217 currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes.

string
numericCode

The numeric currency code. For ISO currencies this will be the ISO 4217 numeric currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes. Set to null if the currency does not have a numeric code.

integer | null
name

The currency name. For ISO currencies this will be the official English name of the currency. For non-ISO currencies no constraints are defined.

string
defaultFractionDigits

The default number of fraction digits (typical scale) used with this currency. For example, the default number of fraction digits for the Euro is 2, while for the Japanese Yen it is 0. This cannot be a negative number.

integer
currencyType

The type of the currency. For ISO currencies, this indicates whether the currency is currently in use (IsoCurrent) or has been withdrawn (IsoHistorical). For non-ISO currencies defined by the application, the type is Custom.

object
name
string
context

The context that defines the capability of this Money.

object
step

Returns the step used by this context.

integer
fixedScale

Returns whether this context produces a deterministic scale regardless of the input value.

boolean
minorAmount

Returns the amount of this Money in minor units (cents) for the currency.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart

Returns the fractional part of this decimal number.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart
object recursive
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
monies

This method satisfies the Monetary interface.

Array
sign

Returns the sign of this money.

integer
zero

Returns whether this money has zero value.

boolean
negative

Returns whether this money has a negative value.

boolean
negativeOrZero

Returns whether this money has a negative or zero value.

boolean
positive

Returns whether this money has a positive value.

boolean
positiveOrZero

Returns whether this money has a positive or zero value.

boolean
version
integer
default: 1
taxTotal
object
amount

The amount.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart

Returns the fractional part of this decimal number.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart
object recursive
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
currency

The currency.

object
currencyCode

The currency code. For ISO currencies this will be the 3-letter uppercase ISO 4217 currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes.

string
numericCode

The numeric currency code. For ISO currencies this will be the ISO 4217 numeric currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes. Set to null if the currency does not have a numeric code.

integer | null
name

The currency name. For ISO currencies this will be the official English name of the currency. For non-ISO currencies no constraints are defined.

string
defaultFractionDigits

The default number of fraction digits (typical scale) used with this currency. For example, the default number of fraction digits for the Euro is 2, while for the Japanese Yen it is 0. This cannot be a negative number.

integer
currencyType

The type of the currency. For ISO currencies, this indicates whether the currency is currently in use (IsoCurrent) or has been withdrawn (IsoHistorical). For non-ISO currencies defined by the application, the type is Custom.

object
name
string
context

The context that defines the capability of this Money.

object
step

Returns the step used by this context.

integer
fixedScale

Returns whether this context produces a deterministic scale regardless of the input value.

boolean
minorAmount

Returns the amount of this Money in minor units (cents) for the currency.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart

Returns the fractional part of this decimal number.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart
object recursive
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
monies

This method satisfies the Monetary interface.

Array
sign

Returns the sign of this money.

integer
zero

Returns whether this money has zero value.

boolean
negative

Returns whether this money has a negative value.

boolean
negativeOrZero

Returns whether this money has a negative or zero value.

boolean
positive

Returns whether this money has a positive value.

boolean
positiveOrZero

Returns whether this money has a positive or zero value.

boolean
vatBreakdown

The VAT for each pair of category and rate, from the rates that the lines keep. TaxCalculator gives the lines their rates, and the tax total is the sum of these groups. See docs/vat.md.

Array<object>
object
key
additional properties
unknown_type
vatNotes

The texts under the totals of the PDF: the reason of each exemption and the note of a record without VAT.

Array<string>
imported
boolean

Example

{
"status": "o.p",
"invoices": [
"https://example.com/"
],
"packinglists": [
"https://example.com/"
],
"complaints": [
"https://example.com/"
],
"shipments": [
"https://example.com/"
],
"quote": "https://example.com/",
"cancelledBy": "https://example.com/",
"notes": [
"https://example.com/"
],
"project": "https://example.com/",
"customer": "https://example.com/",
"vatNote": "reverse_charge",
"isFinalized": false,
"exchangeRateManual": false,
"products": [
"https://example.com/"
],
"totalsFrozen": false,
"creator": "https://example.com/",
"file": "https://example.com/",
"statusType": "o.p",
"version": 1
}

Invalid input

A representation of common errors.

object
title

A short, human-readable summary of the problem.

string | null
detail

A human-readable explanation specific to this occurrence of the problem.

string | null
status
integer | null
default: 400
instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

string | null
type

A URI reference that identifies the problem type

string

Example

{
"status": 400
}

Forbidden

A representation of common errors.

object
title

A short, human-readable summary of the problem.

string | null
detail

A human-readable explanation specific to this occurrence of the problem.

string | null
status
integer | null
default: 400
instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

string | null
type

A URI reference that identifies the problem type

string

Example

{
"status": 400
}

An error occurred

Unprocessable entity

object
status
integer
default: 422
violations
Array<object>
object
propertyPath
required

The property path of the violation

string
message
required

The message associated with the violation

string
code

The code of the violation

string
hint

An extra hint to understand the violation

string
payload

The serialized payload of the violation

object
key
additional properties
any
detail
string
type
string
title
string | null
instance
string | null

Example

{
"status": 422
}