Oihana Php Schema

RemittanceAdvice extends BusinessDocument uses RemittanceAdviceTrait

A remittance advice — the document a *payer* sends to the payee to detail a payment being (or about to be) made : which invoices it settles and the total amount remitted.

The payer-side counterpart of Receipt (which is the payee's proof that a payment was received). The two deliberately coexist : they capture the same event from opposite ends of the transaction — a buyer issues a remittance advice, a seller issues a receipt — so a system acting for either party can model its own side without overloading the other's type. Defined in UBL as RemittanceAdvice.

Constants

ADJUSTMENTS : string = 'adjustments'
AMOUNT_REMITTED : string = 'amountRemitted'
ASSIGNED_SELLER : string = 'assignedSeller'
ATTACHMENTS : string = 'attachments'
AUTHOR : string = 'author'
AUTHORITY : string = 'authority'
BILLING_ADDRESS : string = 'billingAddress'
CONTACT : string = 'contact'
CONTEXT : string = \xyz\oihana\schema\constants\Oihana::SCHEMA: The @context of the json-ld representation of the thing.
CURRENCY : string = 'currency'
CUSTOMER : string = 'customer'
DATE_PUBLISHED : string = 'datePublished'
DIRECTION : string = 'direction'
DOCUMENT_LINES : string = 'documentLines'
ISSUE_DATE : string = 'issueDate'
JSON_PRIORITY_KEYS : array<string|int, mixed> = [\org\schema\constants\Schema::AT_TYPE, \org\sc...: Defines the priority order of keys when serializing the object to JSON-LD.
ORDER_DELIVERY : string = 'orderDelivery'
PAYMENT_TERMS : string = 'paymentTerms'
POINT_OF_SALE : string = 'pointOfSale'
REFERENCES : string = 'references'
REFERENCES_INVOICE : string = 'referencesInvoice'
SELLER : string = 'seller'
STATUS : string = 'status'
TAXES : string = 'taxes'
TOTALS : string = 'totals'
TOTALS_ACCURACY : string = 'totalsAccuracy'
VOLUME : string = 'volume'
WEIGHT : string = 'weight'

Properties

$_from : string|null: The metadata to indicates the edge 'from' identifier.
$_id : null|string: The metadata identifier of the item.
$_key : null|string: The metadata unique key identifier of the thing.
$_rev : null|string: The metadata revision value of the thing.
$_to : string|null: The metadata to indicates the edge 'to' identifier.
$active : bool|null: The visibility flag.
$additionalType : array<string|int, mixed>|string|null|object: An additionalType for the item.
$adjustments : null|array<string|int, mixed>|Adjustment: The document-level adjustments (discounts, surcharges, shipping fees, packaging...) applying to the whole document, as opposed to a specific line's {@see BusinessDocumentLine::$adjustments}.
$alternateName : string|object|array<string|int, mixed>|null: An alias for the item.
$amountRemitted : MonetaryAmount|array<string|int, mixed>|null: The total amount remitted by this advice.
$assignedSeller : string|int|array<string|int, mixed>|Person|null: The seller(s) the document is assigned to — the salesperson who carries the deal, not the party issuing it.
$attachments : null|array<string|int, mixed>|string|MediaObject: Files attached to the document (e.g. a signed PDF, supporting documents).
$author : null|Organization|Person|array<string|int, mixed>: The author of the document — the party (organization or person) who authored it. Reuses the Schema.org `author` name.
$authority : null|string|BusinessDocumentAuthority: Which system holds the truth about this document — ours, or the one it was harvested from.
$billingAddress : null|array<string|int, mixed>|PostalAddress: The address the document is billed to — stored as a frozen copy so the document stays self-contained even if the party's address book changes later. Reuses the Schema.org `billingAddress` name from `Order`.
$contact : null|array<string|int, mixed>|Person: The individual to deal with about the document (the interlocutor on the customer's side) — distinct from the {@see BusinessDocument::$customer} party the document is addressed to. Absent from Schema.org's commercial documents, hence added here.
$created : null|string: Date of creation of the resource.
$currency : string|null: The currency the document's amounts are expressed in (ISO 4217, e.g. "EUR").
$customer : null|array<string|int, mixed>|Organization|Person: The party the document is addressed to.
$datePublished : string|null: The date the document left draft and reached the outside world — the moment it stopped being ours alone to change.
$description : string|object|array<string|int, mixed>|null: A short description of the item.
$direction : null|string|BusinessDocumentDirection: The commercial direction of the document (sale / purchase), from the operator's point of view — which of {@see self::$seller} / {@see self::$customer} is the operator's own organization.
$disambiguatingDescription : string|null: A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
$documentLines : null|array<string|int, mixed>|BusinessDocumentLine: The lines of the document.
$hasPart : string|Thing|array<string|int, Thing>|null: Indicates an item that this part of this item.
$id : null|int|string: The unique identifier of the item.
$identifier : string|null: The identifier of the item.
$image : string|ImageObject|array<string|int, ImageObject|string>|null: The image reference of this resource.
$isPartOf : string|Thing|array<string|int, Thing>|null: Indicates an item that this item is part of.
$issueDate : string|int|null: The date the document was issued.
$license : string|object|null: A legal document giving official permission to do something with the resource.
$mainEntityOfPage : string|null: Indicates a page (or other CreativeWork) for which this thing is the main entity being described.
$modified : null|string: Date on which the resource was changed.
$name : int|string|null: The name of the item.
$orderDelivery : null|array<string|int, mixed>|ParcelDelivery: The delivery attached to the document: the shipping address (a frozen copy), the delivery method and the requested date. Reuses the name already used by {@see DeliveryNote::$orderDelivery} for internal consistency.
$owner : null|string|Thing: The owner of this Thing.
$paymentTerms : null|string|array<string|int, mixed>|PaymentSchedule: The payment terms — free text, or a structured {@see PaymentSchedule}.
$pointOfSale : null|array<string|int, mixed>|Place: The point of sale (store, outlet, warehouse) the document is bound to — the outlet that carries it and drives its pricing. A frozen copy, like the other header references.
$potentialAction : array<string|int, mixed>|Action|null: Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
$publisher : string|array<string|int, string|Person|Organization>|Person|Organization|null: The company that issues the document and will invoice it.
$references : null|array<string|int, mixed>|string: References to other related documents (e.g. a purchase order number quoted on an invoice).
$referencesInvoice : null|array<string|int, mixed>|Invoice: The invoice(s) this remittance advice settles. A single payment may cover more than one invoice.
$sameAs : string|array<string|int, mixed>|null: URL of a reference Web page that unambiguously indicates the item's identity.
$seller : null|array<string|int, mixed>|Organization|Person: The party issuing the document.
$status : null|string|BusinessDocumentStatus: The lifecycle status of the document.
$subjectOf : null|string|array<string|int, mixed>|CreativeWork|Event: A CreativeWork or Event about this Thing.
$taxes : null|array<string|int, mixed>|TaxDetail: The document-level taxes (as opposed to a specific line's taxes).
$totals : null|array<string|int, mixed>|DocumentTotals: The document's monetary summary.
$totalsAccuracy : null|string|DocumentTotalsAccuracy: How {@see BusinessDocument::$totals} is to be read — as the exact amounts, or as a floor the final ones will exceed.
$url : int|string|null: URL of the item.
$volume : null|array<string|int, mixed>|int|float|QuantitativeValue: The space the goods the document covers take up.
$weight : null|array<string|int, mixed>|int|float|QuantitativeValue|Mass: What the goods the document covers weigh — the figure printed on a delivery note or a quote, and the one a carrier is quoted from.
$atContext : string|null: The JSON-LD `@context` value.
$atType : string|null: The JSON-LD `@type` value.
$DEFAULT_JSON_SERIALIZE_OPTIONS : array<string|int, mixed>: The default static jsonSerialize options (class-level configuration).
$schemaTypeCache : array<string, string>: Internal cache for resolved schema types.

Methods

__construct() : mixed: Constructor to hydrate public properties from an array or stdClass.
getJsonSerializeOptions() : array<string|int, mixed>: Returns the default JSON serialization options.
getSchemaType() : string: Returns the fully qualified URI of the schema type.
jsonSerialize() : array<string|int, mixed>: Serializes the current object into a JSON-LD array.
withAtContext() : $this: Sets the internal JSON-LD `@context` attribute.
withAtType() : $this: Sets the internal JSON-LD `@type` attribute.
withJSONLDMeta() : $this: Initializes both JSON-LD metadata: `@type` and `@context`.

ADJUSTMENTS


    public
        string
    ADJUSTMENTS
    = 'adjustments'

AMOUNT_REMITTED


    public
        string
    AMOUNT_REMITTED
    = 'amountRemitted'

ASSIGNED_SELLER


    public
        string
    ASSIGNED_SELLER
    = 'assignedSeller'

ATTACHMENTS


    public
        string
    ATTACHMENTS
    = 'attachments'

AUTHOR


    public
        string
    AUTHOR
    = 'author'

AUTHORITY


    public
        string
    AUTHORITY
    = 'authority'

BILLING_ADDRESS


    public
        string
    BILLING_ADDRESS
    = 'billingAddress'

CONTACT


    public
        string
    CONTACT
    = 'contact'

CONTEXT

The @context of the json-ld representation of the thing.


    public
        string
    CONTEXT
    = \xyz\oihana\schema\constants\Oihana::SCHEMA

CURRENCY


    public
        string
    CURRENCY
    = 'currency'

CUSTOMER


    public
        string
    CUSTOMER
    = 'customer'

DATE_PUBLISHED


    public
        string
    DATE_PUBLISHED
    = 'datePublished'

DIRECTION


    public
        string
    DIRECTION
    = 'direction'

DOCUMENT_LINES


    public
        string
    DOCUMENT_LINES
    = 'documentLines'

ISSUE_DATE


    public
        string
    ISSUE_DATE
    = 'issueDate'

JSON_PRIORITY_KEYS

Defines the priority order of keys when serializing the object to JSON-LD.


    public
        array<string|int, mixed>
    JSON_PRIORITY_KEYS
    = [\org\schema\constants\Schema::AT_TYPE, \org\schema\constants\Schema::AT_CONTEXT, \org\schema\constants\Schema::_KEY, \org\schema\constants\Schema::_FROM, \org\schema\constants\Schema::_TO, \org\schema\constants\Schema::ID, \org\schema\constants\Schema::NAME, \org\schema\constants\Schema::URL, \org\schema\constants\Schema::CREATED, \org\schema\constants\Schema::MODIFIED]

Keys listed here will always appear first in the serialized array, in the order specified. All remaining public properties will be sorted alphabetically after these priority keys.

This ensures that important JSON-LD metadata and system fields (like @type, @context, _key, id, url, created, modified, etc.) appear at the top of the output for consistency and readability.

Usage:

$orderedKeys = self::JSON_PRIORITY_KEYS;

Notes:

Can be overridden in a subclass by redefining the constant.
Late static binding (static::JSON_PRIORITY_KEYS) allows child classes to modify the serialization order.

List of JSON-LD keys in priority order.

ORDER_DELIVERY


    public
        string
    ORDER_DELIVERY
    = 'orderDelivery'

PAYMENT_TERMS


    public
        string
    PAYMENT_TERMS
    = 'paymentTerms'

POINT_OF_SALE


    public
        string
    POINT_OF_SALE
    = 'pointOfSale'

REFERENCES


    public
        string
    REFERENCES
    = 'references'

REFERENCES_INVOICE


    public
        string
    REFERENCES_INVOICE
    = 'referencesInvoice'

SELLER


    public
        string
    SELLER
    = 'seller'

STATUS


    public
        string
    STATUS
    = 'status'

TAXES


    public
        string
    TAXES
    = 'taxes'

TOTALS


    public
        string
    TOTALS
    = 'totals'

TOTALS_ACCURACY


    public
        string
    TOTALS_ACCURACY
    = 'totalsAccuracy'

VOLUME


    public
        string
    VOLUME
    = 'volume'

WEIGHT


    public
        string
    WEIGHT
    = 'weight'

$_from

The metadata to indicates the edge 'from' identifier.


        public
            string|null
    $_from

$_id

The metadata identifier of the item.


        public
            null|string
    $_id

$_key

The metadata unique key identifier of the thing.


        public
            null|string
    $_key

$_rev

The metadata revision value of the thing.


        public
            null|string
    $_rev

$_to

The metadata to indicates the edge 'to' identifier.


        public
            string|null
    $_to

$active

The visibility flag.


        public
            bool|null
    $active

$additionalType

An additionalType for the item.


        public
            array<string|int, mixed>|string|null|object
    $additionalType

$adjustments

The document-level adjustments (discounts, surcharges, shipping fees, packaging...) applying to the whole document, as opposed to a specific line's {@see BusinessDocumentLine::$adjustments}.


        public
            null|array<string|int, mixed>|Adjustment
    $adjustments

#[HydrateWith]: \xyz\oihana\schema\business\documents\Adjustment::class

$alternateName

An alias for the item.


        public
            string|object|array<string|int, mixed>|null
    $alternateName

$amountRemitted

The total amount remitted by this advice.


        public
            MonetaryAmount|array<string|int, mixed>|null
    $amountRemitted

#[HydrateAs]: \org\schema\MonetaryAmount::class

$assignedSeller

The seller(s) the document is assigned to — the salesperson who carries the deal, not the party issuing it.


        public
            string|int|array<string|int, mixed>|Person|null
    $assignedSeller

Distinct from BusinessDocument::$seller, the organization (or person) the document is issued by : one seller issues every document of a sales cycle, while the person answering for a given one is the pivot a salesperson's own resources are scoped by (see sellerKey()). Reuses the name, the shape and the meaning Customer::$assignedSeller already carries for the seller a customer is attached to — a document commonly gets its own from there and then keeps it : a customer reassigned later must not rewrite who took the order.

Holds the raw seller reference as read from the source (a key, or the joined row), or the resolved Seller : a bare key is left as read, a joined row — and each entry of a joined list — is read back as the class the attribute names.

$attachments

Files attached to the document (e.g. a signed PDF, supporting documents).


        public
            null|array<string|int, mixed>|string|MediaObject
    $attachments

$author

The author of the document — the party (organization or person) who authored it. Reuses the Schema.org `author` name.


        public
            null|Organization|Person|array<string|int, mixed>
    $author

#[HydrateWith]: \xyz\oihana\schema\people\Seller::class; \org\schema\Organization::class; \org\schema\Person::class

$authority

Which system holds the truth about this document — ours, or the one it was harvested from.


        public
            null|string|BusinessDocumentAuthority
    $authority
     = null

🔑 Its absence means the document is ours. Only what comes from elsewhere states it, so nothing stored before this property existed changes meaning.

Answers a question no other property does : the class says what the document is, direction says which side of the trade we stand on, status says where it stands in its lifecycle — none of them says who may change it. The distinction matters as soon as documents of both origins share a collection : editing a mirrored one is a correction the next refresh erases without a word.

⚠️ Carrying the fact is not enforcing it — refusing the write belongs to whoever exposes the document.

$billingAddress

The address the document is billed to — stored as a frozen copy so the document stays self-contained even if the party's address book changes later. Reuses the Schema.org `billingAddress` name from `Order`.


        public
            null|array<string|int, mixed>|PostalAddress
    $billingAddress

#[HydrateAs]: \org\schema\PostalAddress::class

$contact

The individual to deal with about the document (the interlocutor on the customer's side) — distinct from the {@see BusinessDocument::$customer} party the document is addressed to. Absent from Schema.org's commercial documents, hence added here.


        public
            null|array<string|int, mixed>|Person
    $contact

#[HydrateWith]: \xyz\oihana\schema\people\CustomerEmployee::class; \org\schema\Person::class

$created

Date of creation of the resource.


        public
            null|string
    $created

$currency

The currency the document's amounts are expressed in (ISO 4217, e.g. "EUR").


        public
            string|null
    $currency

$customer

The party the document is addressed to.


        public
            null|array<string|int, mixed>|Organization|Person
    $customer

🔑 Customer is named first among the candidates, so a stored row carrying the type is read back with the properties only a customer has — its salesperson, its point of sale, its credit status, its price segment. A class that is not named cannot be chosen, and what it alone declares is dropped without a word.

#[HydrateWith]: \xyz\oihana\schema\organizations\Customer::class; \org\schema\Organization::class; \org\schema\Person::class

$datePublished

The date the document left draft and reached the outside world — the moment it stopped being ours alone to change.


        public
            string|null
    $datePublished

Reuses https://schema.org/datePublished, whose own definition (« date of first broadcast/publication ») already names exactly this : a document is drafted, corrected, drafted again, and then, once, published.

🔑 Not self::$issueDate. issueDate is the date printed on the document — the one a reader sees, chosen when the document is created and free to be edited like any other header field of a draft. datePublished is a system fact : when this copy first left the draft state, set once, by whatever publishes it, never by a caller. The two usually fall close together and are never the same property — a document back-dated to match a paper original still publishes today.

$description

A short description of the item.


        public
            string|object|array<string|int, mixed>|null
    $description

$direction

The commercial direction of the document (sale / purchase), from the operator's point of view — which of {@see self::$seller} / {@see self::$customer} is the operator's own organization.


        public
            null|string|BusinessDocumentDirection
    $direction

$disambiguatingDescription

A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.


        public
            string|null
    $disambiguatingDescription

$documentLines

The lines of the document.


        public
            null|array<string|int, mixed>|BusinessDocumentLine
    $documentLines

#[HydrateWith]: \xyz\oihana\schema\business\documents\BusinessDocumentLine::class

$hasPart

Indicates an item that this part of this item.


        public
            string|Thing|array<string|int, Thing>|null
    $hasPart

$id

The unique identifier of the item.


        public
            null|int|string
    $id

$identifier

The identifier of the item.


        public
            string|null
    $identifier

$image

The image reference of this resource.


        public
            string|ImageObject|array<string|int, ImageObject|string>|null
    $image

$isPartOf

Indicates an item that this item is part of.


        public
            string|Thing|array<string|int, Thing>|null
    $isPartOf

$issueDate

The date the document was issued.


        public
            string|int|null
    $issueDate

$license

A legal document giving official permission to do something with the resource.


        public
            string|object|null
    $license

$mainEntityOfPage

Indicates a page (or other CreativeWork) for which this thing is the main entity being described.


        public
            string|null
    $mainEntityOfPage

$modified

Date on which the resource was changed.


        public
            null|string
    $modified

$name

The name of the item.


        public
            int|string|null
    $name

$orderDelivery

The delivery attached to the document: the shipping address (a frozen copy), the delivery method and the requested date. Reuses the name already used by {@see DeliveryNote::$orderDelivery} for internal consistency.


        public
            null|array<string|int, mixed>|ParcelDelivery
    $orderDelivery

#[HydrateAs]: \org\schema\ParcelDelivery::class

$owner

The owner of this Thing.


        public
            null|string|Thing
    $owner

Represents any entity (person, organization, system, or other object) that can be considered the possessor of this Thing.

$paymentTerms

The payment terms — free text, or a structured {@see PaymentSchedule}.


        public
            null|string|array<string|int, mixed>|PaymentSchedule
    $paymentTerms

#[HydrateAs]: \xyz\oihana\schema\business\documents\PaymentSchedule::class

$pointOfSale

The point of sale (store, outlet, warehouse) the document is bound to — the outlet that carries it and drives its pricing. A frozen copy, like the other header references.


        public
            null|array<string|int, mixed>|Place
    $pointOfSale

#[HydrateWith]: \xyz\oihana\schema\places\Warehouse::class; \org\schema\Place::class

$potentialAction

Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.


        public
            array<string|int, mixed>|Action|null
    $potentialAction

$publisher

The company that issues the document and will invoice it.


        public
            string|array<string|int, string|Person|Organization>|Person|Organization|null
    $publisher

Redeclares Thing::$publisher with the same union, to name the subject : a stored row is read back as a Subsidiary, which is what the issuing party is here.

#[HydrateWith]: \xyz\oihana\schema\organizations\Subsidiary::class; \org\schema\Organization::class; \org\schema\Person::class

$references

References to other related documents (e.g. a purchase order number quoted on an invoice).


        public
            null|array<string|int, mixed>|string
    $references

$referencesInvoice

The invoice(s) this remittance advice settles. A single payment may cover more than one invoice.


        public
            null|array<string|int, mixed>|Invoice
    $referencesInvoice

#[HydrateWith]: \xyz\oihana\schema\business\documents\Invoice::class

$sameAs

URL of a reference Web page that unambiguously indicates the item's identity.


        public
            string|array<string|int, mixed>|null
    $sameAs

E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.

$seller

The party issuing the document.


        public
            null|array<string|int, mixed>|Organization|Person
    $seller

#[HydrateWith]: \xyz\oihana\schema\organizations\Subsidiary::class; \org\schema\Organization::class; \org\schema\Person::class

$status

The lifecycle status of the document.


        public
            null|string|BusinessDocumentStatus
    $status

$subjectOf

A CreativeWork or Event about this Thing.


        public
            null|string|array<string|int, mixed>|CreativeWork|Event
    $subjectOf

$taxes

The document-level taxes (as opposed to a specific line's taxes).


        public
            null|array<string|int, mixed>|TaxDetail
    $taxes

#[HydrateWith]: \xyz\oihana\schema\business\documents\TaxDetail::class

$totals

The document's monetary summary.


        public
            null|array<string|int, mixed>|DocumentTotals
    $totals

#[HydrateAs]: \xyz\oihana\schema\business\documents\DocumentTotals::class

$totalsAccuracy

How {@see BusinessDocument::$totals} is to be read — as the exact amounts, or as a floor the final ones will exceed.


        public
            null|string|DocumentTotalsAccuracy
    $totalsAccuracy
     = null

A document is not always able to price everything it carries : a line no price list covers, a regulatory fee no rate covers, a carriage whose term names no rate. Each of them is owed and none of them can be quantified, so the amounts add nothing for them — a zero would claim that nothing is due — and what comes out is true but short. MINIMUM says so ; EXACT says everything could be priced.

🔑 The reasons stay where they happened — on the adjustment carrying no amount, on the line carrying no subtotal. This property carries only the consequence, which is what a reader holding the summary alone can act on : a list, a total bar, a printed recap, none of which has the lines at hand.

🔑 The accuracy answers to the same authority as the amounts (BusinessDocument::$authority) : a mirrored document states what its source billed, and its source priced everything it charged, so its reading is EXACT — stated, never recomputed from a catalogue that is not the one the amounts came from.

⚠️ An absent value states nothing, and must not be read as EXACT. Unlike authority, its immediate neighbour, whose absence carries the safe meaning, silence here is only silence.

⚠️ A floor is stated here rather than inside the amounts, though MonetaryAmount offers minValue and though that is exactly how BusinessDocument::$weight states its own floor. A mass is read ; an amount is also filtered, sorted and bounded on — and a store doing so on value would have dropped, silently, the very documents whose amounts stopped being final. The amounts stay whole ; this property qualifies them.

$url

URL of the item.


        public
            int|string|null
    $url

$volume

The space the goods the document covers take up.


        public
            null|array<string|int, mixed>|int|float|QuantitativeValue
    $volume

The twin of BusinessDocument::$weight, and read the same way : a plain number when the unit is implicit, a QuantitativeValue when it is stated ({ value: 3.412, unitCode: "MTQ" }) ; an array is hydrated as the latter and sits there until it is.

⚠️ Not part of BusinessDocument::$totals, for the same reason the weight is not : that class is the monetary summary and every one of its properties is a MonetaryAmount.

The header's side of HasPhysicalMeasures::$volume, which the lines carry : usually the sum of theirs.

$weight

What the goods the document covers weigh — the figure printed on a delivery note or a quote, and the one a carrier is quoted from.


        public
            null|array<string|int, mixed>|int|float|QuantitativeValue|Mass
    $weight

Usually the sum, over the lines, of the quantity by the weight of the unit it is expressed in. A plain number carries it when the unit is implicit, a QuantitativeValue when the unit is stated ({ value: 326.5456, unitCode: "KGM" }) ; an array is hydrated as the latter. The union of OfferShippingDetails::$weight widened with array, so a weight reads the same wherever it is met and a raw row can still sit here until hydration replaces it — the mirror's union predates that convention.

⚠️ Not part of BusinessDocument::$totals despite the pull of the name : that class is the monetary summary and every one of its properties is a MonetaryAmount. A mass sitting among them would blur what it is.

Deliberately neutral about gross and net. Should the distinction ever be needed, it belongs to the additionalType of a QuantitativeValue, never to a second property — two weights held in parallel eventually disagree.

The header's side of HasPhysicalMeasures::$weight, which the lines carry. Declared here rather than taken from that trait : the ⚠️ above is an argument about totals, a header-level property a line does not have, and a trait absorbing it would either impose the discussion on every line or lose it.

$atContext

The JSON-LD `@context` value.


        protected
            string|null
    $atContext
     = null

Default is https://schema.org.

$atType

The JSON-LD `@type` value.


        protected
            string|null
    $atType
     = null

This can be manually set or automatically inferred from the class name.

$DEFAULT_JSON_SERIALIZE_OPTIONS

The default static jsonSerialize options (class-level configuration).


        protected
        static    array<string|int, mixed>
    $DEFAULT_JSON_SERIALIZE_OPTIONS
     = []

$schemaTypeCache

Internal cache for resolved schema types.


        private
        static    array<string, string>
    $schemaTypeCache
     = []

__construct()

Constructor to hydrate public properties from an array or stdClass.


    public
                    __construct([array<string|int, mixed>|object|null $init = null ]) : mixed

This allows objects to be quickly populated with associative data without manually setting each property.

Parameters

$init : array<string|int, mixed>|object|null = null: A data array or object used to initialize the instance. Keys must match public property names.

getJsonSerializeOptions()

Returns the default JSON serialization options.


    public
                    getJsonSerializeOptions() : array<string|int, mixed>

This method determines how the jsonSerialize() output is reduced or compressed, etc. It can be overridden in child classes to customize serialization behavior.

Return values

array<string|int, mixed> —

Returns the reduction/compression options for JSON serialization.

getSchemaType()

Returns the fully qualified URI of the schema type.


    public
            static        getSchemaType() : string

This method combines the class's CONTEXT constant with its short name to produce a globally unique identifier for the entity type.

It uses Late Static Binding to ensure the correct context is retrieved even when called from an inherited class (e.g., Corporation vs. Affiliate).
Performance Optimization: Results are stored in a static cache ($schemaTypeCache) to avoid redundant Reflection calls during the same execution lifecycle.

Return values

string —

The absolute URI of the type (e.g., "https://schema.org/Thing"). ** @example

echo Thing::getSchemaType();      // https://schema.org/Thing
echo Affiliate::getSchemaType();  // https://schema.oihana.xyz/Pagination

jsonSerialize()

Serializes the current object into a JSON-LD array.


    public
                    jsonSerialize() : array<string|int, mixed>

Includes public properties, the JSON-LD @context and @type. Null values are automatically removed.

Return values

array<string|int, mixed> —

JSON-LD representation of the object.

withAtContext()

Sets the internal JSON-LD `@context` attribute.


    public
                    withAtContext(string $context) : $this

Useful if you need a custom JSON-LD context.

Parameters

$context : string: Optional JSON-LD context.

Return values

$this

withAtType()

Sets the internal JSON-LD `@type` attribute.


    public
                    withAtType(string $type) : $this

Allows overriding the default type inferred from the class.

Parameters

$type : string: Optional JSON-LD type

Return values

$this

withJSONLDMeta()

Initializes both JSON-LD metadata: `@type` and `@context`.


    public
                    withJSONLDMeta([string|null $atType = null ][, string|null $atContext = null ]) : $this

Can be called from constructor or later to override default values.

Parameters

$atType : string|null = null: Optional JSON-LD type
$atContext : string|null = null: Optional JSON-LD context

Return values

$this

RemittanceAdvice extends BusinessDocument uses RemittanceAdviceTrait

Tags

Table of Contents

Constants

Properties

Methods

Constants

ADJUSTMENTS

AMOUNT_REMITTED

ASSIGNED_SELLER

ATTACHMENTS

AUTHOR

AUTHORITY

BILLING_ADDRESS

CONTACT

CONTEXT

CURRENCY

CUSTOMER

DATE_PUBLISHED

DIRECTION

DOCUMENT_LINES

ISSUE_DATE

JSON_PRIORITY_KEYS

ORDER_DELIVERY

PAYMENT_TERMS

POINT_OF_SALE

REFERENCES

REFERENCES_INVOICE

SELLER

STATUS

TAXES

TOTALS

TOTALS_ACCURACY

VOLUME

WEIGHT

Properties

$_from

$_id

$_key

$_rev

$_to

$active

$additionalType

$adjustments

Attributes

$alternateName

$amountRemitted

Attributes

$assignedSeller

Tags

Attributes

$attachments

$author

Attributes

$authority

Tags

$billingAddress

Attributes

$contact

Attributes

$created

$currency

$customer

Attributes

$datePublished

Tags

$description

$direction

$disambiguatingDescription

$documentLines

Attributes

$hasPart

$id

$identifier

$image

$isPartOf

$issueDate

$license

$mainEntityOfPage

$modified