Skip to content

Status project

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

Creates a Project resource.

id
required
string

Project identifier

The new Project resource

object
id
required
string format: uuid
status
required
string
Allowed values: prj.o prj.x prj.c

Project resource created

object
status
string
default: prj.o
Allowed values: prj.o prj.x prj.c
collaborators

The members of the team who work on the project.

Array<string>
startDate

The optional date the project starts.

string | null format: date-time
deadline

The optional date the project must be done.

string | null format: date-time
salesOrders
Array<string>
purchaseOrders
Array<string>
name
string
archivedAt
string | null format: date-time
attachments
Array<string>
createdAt
string format: date-time
updatedAt
string | null format: date-time
id

More information

string format: uuid
uid
string
notes
Array<string>
statusValue
string
totalSalesOrders
integer
totalPurchaseOrders
integer
totalSalesOrderValue

The sales orders in the currency of the workspace. An order without an exchange rate is not in it, see getMissingExchangeRates().

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
totalPurchaseOrderValue

The purchase orders in the currency of the workspace. An order without an exchange rate is not in it, see getMissingExchangeRates().

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
estimatedProfit

The margins of the sales orders: their line totals minus the cost of the products when each line was made. The purchase orders are not in it, because their goods can go to stock or to other orders. Null when no sales order has a margin, see CustomerBillingRecord::getMargin().

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
profitMarginPercentage

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

number | null
linesWithoutCost

The number of sales order lines without a cost. They are not in the profit, so the page warns about them.

integer
totalInvoices
integer
totalInvoicedValue

The invoices in the currency of the workspace. An invoice without an exchange rate is not in it, see getMissingExchangeRates().

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
missingExchangeRates

The number of orders and invoices without an exchange rate. The totals of the project leave them out, so the page warns about them.

integer
totalShipments
integer
archived
boolean

Example

{
"status": "prj.o",
"collaborators": [
"https://example.com/"
],
"salesOrders": [
"https://example.com/"
],
"purchaseOrders": [
"https://example.com/"
],
"attachments": [
"https://example.com/"
],
"notes": [
"https://example.com/"
]
}

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
}