Oihana PHP System

Invoice extends Intangible

A statement of the money due for goods or services; a bill.

Tags
see
https://schema.org/Invoice

Table of Contents

Constants

CONTEXT  = 'https://schema.org'
JSON-LD @context declaration for Schema.org.

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 active flag.
$additionalType  : array<string|int, mixed>|string|null|object
An additionalType for the item.
$alternateName  : string|object|null
An alias for the item.
$billingPeriod  : Duration|int|float|null
The time interval used to compute the invoice.
$broker  : Organization|Person|null
An entity that arranges for an exchange between a buyer and a seller.
$category  : null|string|CategoryCode|Thing
A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.
$confirmationNumber  : string|null
A number that confirms the given order or payment has been received.
$created  : null|string|DateTime
Date of creation of the resource.
$customer  : Organization|Person|null
A number that confirms the given order or payment has been received.
$description  : string|null
A short description of the item.
$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.
$hasPart  : string|Thing|array<string|int, mixed>|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|object|null
The image reference of this resource.
$isPartOf  : string|Thing|array<string|int, mixed>|null
Indicates an item that this item is part of.
$license  : string|object|null
A legal document giving official permission to do something with the resource.
$minimumPaymentDue  : MonetaryAmount|PriceSpecification|null
The minimum payment required at this time.
$modified  : null|string|DateTime
Date on which the resource was changed.
$name  : int|string|null
The name of the item.
$paymentDueDate  : string|DateTimeInterface|null
The date that payment is due.
$paymentMethod  : null|string|PaymentMethod
The name of the credit card or other method of payment for the order.
$paymentMethodId  : string|null
An identifier for the method of payment used (e.g. the last 4 digits of the credit card).
$paymentStatus  : string|null|PaymentStatusType
The status of payment; whether the invoice has been paid or not.
$provider  : array<string|int, mixed>|Organization|Person|null
The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider.
$publisher  : string|array<string|int, mixed>|Person|Organization|null
The publisher of the resource.
$referencesOrder  : Order|null
The Order(s) related to this Invoice.
$scheduledPaymentDate  : DateTimeInterface|string|null
The date the invoice is scheduled to be paid.
$totalPaymentDue  : MonetaryAmount|PriceSpecification|null
The total amount due.
$url  : int|string|null
URL of the item.
$atContext  : string|null
The JSON-LD `@context` value.
$atType  : string|null
The JSON-LD `@type` value.

Methods

__construct()  : mixed
Constructor to hydrate public properties from an array or stdClass.
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`.

Constants

CONTEXT

JSON-LD @context declaration for Schema.org.

public mixed CONTEXT = 'https://schema.org'

Properties

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

$accountId

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

public string|null $accountId

$active

The active flag.

public bool|null $active

$additionalType

An additionalType for the item.

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

$alternateName

An alias for the item.

public string|object|null $alternateName

$billingPeriod

The time interval used to compute the invoice.

public Duration|int|float|null $billingPeriod

$broker

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

public Organization|Person|null $broker

In most cases a broker never acquires or releases ownership of a product or service involved in an exchange. If it is not clear whether an entity is a broker, seller, or buyer, the latter two terms are preferred.

$category

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

public null|string|CategoryCode|Thing $category
Tags
see

null|string|CategoryCode|Thing

$confirmationNumber

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

public string|null $confirmationNumber

$created

Date of creation of the resource.

public null|string|DateTime $created

$description

A short description of the item.

public string|null $description

$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

$hasPart

Indicates an item that this part of this item.

public string|Thing|array<string|int, mixed>|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|object|null $image

$isPartOf

Indicates an item that this item is part of.

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

$license

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

public string|object|null $license

$modified

Date on which the resource was changed.

public null|string|DateTime $modified

$name

The name of the item.

public int|string|null $name

$paymentDueDate

The date that payment is due.

public string|DateTimeInterface|null $paymentDueDate

$paymentMethod

The name of the credit card or other method of payment for the order.

public null|string|PaymentMethod $paymentMethod

$paymentMethodId

An identifier for the method of payment used (e.g. the last 4 digits of the credit card).

public string|null $paymentMethodId

$paymentStatus

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

public string|null|PaymentStatusType $paymentStatus

$provider

The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider.

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

A provider may also serve as the seller.

$referencesOrder

The Order(s) related to this Invoice.

public Order|null $referencesOrder

One or more Orders may be combined into a single Invoice.

$scheduledPaymentDate

The date the invoice is scheduled to be paid.

public DateTimeInterface|string|null $scheduledPaymentDate

$url

URL of the item.

public int|string|null $url

$atContext

The JSON-LD `@context` value.

private string|null $atContext = null

Default is https://schema.org.

$atType

The JSON-LD `@type` value.

private string|null $atType = null

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

Methods

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

Tags
throws
ReflectionException
example 
use org\schema\Person;
use org\schema\constants\Prop;

$person = new Person
([
    Prop::NAME => 'Jane Doe',
    Prop::URL  => 'https://example.com/janedoe'
]);

echo $person->name; // Outputs: Jane Doe

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.

Tags
throws
ReflectionException

If reflection fails when accessing properties.

example 
use org\schema\Person;
use org\schema\constants\Prop;

$person = new Person
([
    Prop::NAME => 'John Smith',
    Prop::ID   => 'jsmith-001'
]);

echo json_encode($person, JSON_PRETTY_PRINT);

Output:

{
   "@type": "Person",
   "@context": "https://schema.org",
   "id": "jsmith-001",
   "name": "John Smith"
}
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
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
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 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results