Inttegro PHP SDK

LineItem extends DomainValue
in package

FinalYes

Line Item details associated with refund.

This immutable value hydrates decoded API snake_case data into typed camelCase properties. Use fromArray() for wire data; toArray(), array access, and JSON serialization expose the API wire representation. Nullable properties correspond to optional API fields.

Tags
see
DomainValue

Table of Contents

Properties

$id  : string
Server-generated refund line-item identifier.
$orderLineItem  : ProductOrderLineItem|FeeOrderLineItem|ShippingOrderLineItem|null
Immutable display snapshot of the refunded order line.
$orderLineItemId  : string
Identifier of the related order line item.
$originalAmountPaid  : Amount
Original Amount Paid value for this line item.
$reason  : GenericValue|null
Reason value for this line item.
$reasonDetails  : string|null
Reason Details value for this line item.
$refundAmount  : Amount
Refund Amount value for this line item.

Methods

__construct()  : mixed
Hydrates a LineItem from decoded Inttegro API data.
fromArray()  : static
Creates a LineItem from its decoded API wire representation.
jsonSerialize()  : array<string, mixed>
Returns the same API wire object as `toArray()` for `json_encode()`.
offsetExists()  : bool
Reports whether a non-null property exists for a PHP or API field name.
offsetGet()  : mixed
Reads a typed property through PHP `ArrayAccess`.
offsetSet()  : void
Rejects mutation because domain values are immutable.
offsetUnset()  : void
Rejects unsetting because domain values are immutable.
toArray()  : array<string, mixed>
Converts typed properties back to the API's wire representation.

Properties

$id read-only

Server-generated refund line-item identifier.

public string $id

Required response field. PHP type: string; wire field: id (string).

$orderLineItem read-only

Immutable display snapshot of the refunded order line.

public ProductOrderLineItem|FeeOrderLineItem|ShippingOrderLineItem|null $orderLineItem

Optional response field. PHP type: ProductOrderLineItem|FeeOrderLineItem|ShippingOrderLineItem|null; wire field: order_line_item (object). Omitted for legacy records whose order cannot be resolved.

$orderLineItemId read-only

Identifier of the related order line item.

Use $orderLineItem->id when the snapshot is present.

public string $orderLineItemId

Required response field. PHP type: string; wire field: order_line_item_id (string).

$originalAmountPaid read-only

Original Amount Paid value for this line item.

public Amount $originalAmountPaid

Required response field. PHP type: Amount; wire field: original_amount_paid (object).

$reason read-only

Reason value for this line item.

public GenericValue|null $reason

Optional response field. PHP type: \Inttegro\GenericValue|null; wire field: reason (string). Compare against Reason cases by using their ->value strings.

$reasonDetails read-only

Reason Details value for this line item.

public string|null $reasonDetails

Optional response field. PHP type: string|null; wire field: reason_details (string).

$refundAmount read-only

Refund Amount value for this line item.

public Amount $refundAmount

Required response field. PHP type: Amount; wire field: refund_amount (object).

Methods

__construct()

Hydrates a LineItem from decoded Inttegro API data.

public __construct(array<string, mixed> $data) : mixed
Parameters
$data : array<string, mixed>

Wire object keyed by snake_case API field names.

fromArray()

Creates a LineItem from its decoded API wire representation.

public static fromArray(array<string, mixed> $data) : static
Parameters
$data : array<string, mixed>

Wire object keyed by snake_case API field names.

Return values
static —

A typed, immutable LineItem value.

jsonSerialize()

Returns the same API wire object as `toArray()` for `json_encode()`.

public jsonSerialize() : array<string, mixed>
Return values
array<string, mixed>

offsetExists()

Reports whether a non-null property exists for a PHP or API field name.

public offsetExists(mixed $offset) : bool

Both paymentId and payment_id address the same typed property.

Parameters
$offset : mixed

PHP camelCase or wire snake_case field name.

Return values
bool

offsetGet()

Reads a typed property through PHP `ArrayAccess`.

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed

PHP camelCase or wire snake_case field name.

Return values
mixed —

The PHP-native property value.

offsetSet()

Rejects mutation because domain values are immutable.

public offsetSet(mixed $offset, mixed $value) : void
Parameters
$offset : mixed

Ignored field name.

$value : mixed

Ignored replacement value.

Tags
throws
LogicException

Always.

offsetUnset()

Rejects unsetting because domain values are immutable.

public offsetUnset(mixed $offset) : void
Parameters
$offset : mixed

Ignored field name.

Tags
throws
LogicException

Always.

toArray()

Converts typed properties back to the API's wire representation.

public toArray() : array<string, mixed>

Property names become snake_case. Nested values, arrays, backed enums, and timestamps are normalized recursively so the result is safe to pass to json_encode().

Return values
array<string, mixed> —

The recursively normalized API object.

On this page

Search results