Invoice extends BusinessDocument uses InvoiceTrait

An invoice — the final billing document of the quote → purchase order → invoice cycle, issued once the goods or services have been delivered.

Tags

author

Marc Alcaraz (eKameleon)

since

1.3.0

Table of Contents

Constants

ACCOUNT_ID  : string = 'accountId'

ADJUSTMENTS  : string = 'adjustments'

ATTACHMENTS  : string = 'attachments'

AUTHOR  : string = 'author'

BILLING_ADDRESS  : string = 'billingAddress'

BILLING_PERIOD  : string = 'billingPeriod'

BROKER  : string = 'broker'

CATEGORY  : string = 'category'

CONFIRMATION_NUMBER  : string = 'confirmationNumber'

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'

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_DUE_DATE  : string = 'paymentDueDate'

PAYMENT_STATUS  : string = 'paymentStatus'

PAYMENT_TERMS  : string = 'paymentTerms'

POINT_OF_SALE  : string = 'pointOfSale'

PROVIDER  : string = 'provider'

REFERENCES  : string = 'references'

REFERENCES_ORDER  : string = 'referencesOrder'

SCHEDULED_PAYMENT_DATE  : string = 'scheduledPaymentDate'

SELLER  : string = 'seller'

STATUS  : string = 'status'

TAXES  : string = 'taxes'

TOTALS  : string = 'totals'

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.

$accountId  : string|null

The identifier for the account the payment will be applied to.

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

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

$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`.

$billingPeriod  : null|array<string|int, mixed>|Duration|int|float

The time interval used to compute the invoice.

$broker  : null|array<string|int, mixed>|Organization|Person

An entity that arranges for an exchange between a buyer and a seller.

$category  : null|array<string|int, mixed>|string|CategoryCode|Thing

A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.

$confirmationNumber  : string|int|null

A number that confirms the given order or payment has been received.

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

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

$paymentDueDate  : string|int|null

The date that payment is due.

$paymentStatus  : null|string|PaymentStatusType

The status of payment; whether the invoice has been paid or not.

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

$provider  : null|array<string|int, mixed>|Organization|Person

The service provider, service operator, or service performer; the goods producer.

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

The publisher of the resource.

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

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

$referencesOrder  : null|array<string|int, mixed>|PurchaseOrder

The purchase order(s) this invoice bills. One or more purchase orders may be combined into a single invoice.

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

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

$scheduledPaymentDate  : string|int|null

The date the invoice is scheduled to be paid.

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

$url  : int|string|null

URL of the item.

$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`.

$orderedKeys = self::JSON_PRIORITY_KEYS;

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