CustomsDeclaration
extends AbstractApiObject
in package
CustomsDeclaration class represents a declaration of customs related information.
Tags
Table of Contents
- $id : id
- $required : required
- $additional_fees : float
- Additional custom fees to be payed.
- $contents_explanation : string
- Description of contents. Mandatory if contents_type is 'commercial_goods.
- $contents_type : string
- Type of contents.
- $currency : string
- A valid ISO 4217 curreny code.
- $drop_off_location : string
- Location where the package will be dropped of with the carrier.
- $exporter_reference : string
- A note for the exporter.
- $importer_reference : string
- A note for the importer.
- $invoice_number : string
- Invoice number for the order.
- $items : array<string|int, mixed>
- Array of item objects.
- $posting_date : string
- Date of commital at carrier.
- $total_value_amount : float
- The overall value of the shipments' contents.
- __construct() : void
- CustomsDeclaration constructor.
- get_additional_fees() : float
- Getter method for additional_fees.
- get_contents_explanation() : string
- Getter method for contents_explanation.
- get_contents_type() : string
- Getter method for contents_type.
- get_currency() : string
- Getter method for currency.
- get_drop_off_location() : string
- Getter method for drop_off_location.
- get_exporter_reference() : string
- Getter method for exporter_reference.
- get_id() : string|null
- Getter method for id.
- get_importer_reference() : string
- Getter method for importer_reference.
- get_invoice_number() : string
- Getter method for invoice_number.
- get_items() : array<string|int, mixed>
- Getter method for items.
- get_posting_date() : string
- Getter method for posting_date.
- get_required_fields() : array<string|int, mixed>
- Getter method for id.
- get_total_value_amount() : float
- Getter method for total_value_amount.
- set_additional_fees() : void
- Setter method for additional_fees.
- set_contents_explanation() : void
- Setter method for contents_explanation.
- set_contents_type() : void
- Setter method for contents_type.
- set_currency() : void
- Setter method for currency.
- set_drop_off_location() : void
- Setter method for drop_off_location.
- set_exporter_reference() : void
- Setter method for exporter_reference.
- set_id() : void
- Setter method for id.
- set_importer_reference() : void
- Setter method for importer_reference.
- set_invoice_number() : void
- Setter method for invoice_number.
- set_items() : void
- Setter method for items.
- set_posting_date() : void
- Setter method for posting_date.
- set_total_value_amount() : void
- Setter method for total_value_amount.
- to_array() : array<string|int, mixed>
- Getter method for parameter array.
- to_string() : string
- Getter method for string representation.
Properties
$id
protected
id
$id
$required
protected
required
$required
$additional_fees
Additional custom fees to be payed.
private
float
$additional_fees
$contents_explanation
Description of contents. Mandatory if contents_type is 'commercial_goods.
private
string
$contents_explanation
Max 256 characters, when using DHL as your carrier'.
$contents_type
Type of contents.
private
string
$contents_type
$currency
A valid ISO 4217 curreny code.
private
string
$currency
$drop_off_location
Location where the package will be dropped of with the carrier.
private
string
$drop_off_location
$exporter_reference
A note for the exporter.
private
string
$exporter_reference
$importer_reference
A note for the importer.
private
string
$importer_reference
$invoice_number
Invoice number for the order.
private
string
$invoice_number
$items
Array of item objects.
private
array<string|int, mixed>
$items
$posting_date
Date of commital at carrier.
private
string
$posting_date
$total_value_amount
The overall value of the shipments' contents.
private
float
$total_value_amount
Methods
__construct()
CustomsDeclaration constructor.
public
__construct(string $contents_type, string $currency, float $total_value_amount, array<string|int, mixed> $items) : void
Parameters
- $contents_type : string
- $currency : string
- $total_value_amount : float
- $items : array<string|int, mixed>
Tags
Return values
void —get_additional_fees()
Getter method for additional_fees.
public
get_additional_fees() : float
Return values
float —The additional_fees.
get_contents_explanation()
Getter method for contents_explanation.
public
get_contents_explanation() : string
Return values
string —The contents_explanation.
get_contents_type()
Getter method for contents_type.
public
get_contents_type() : string
Return values
string —The contents_type.
get_currency()
Getter method for currency.
public
get_currency() : string
Return values
string —The currency.
get_drop_off_location()
Getter method for drop_off_location.
public
get_drop_off_location() : string
Return values
string —The drop_off_location.
get_exporter_reference()
Getter method for exporter_reference.
public
get_exporter_reference() : string
Return values
string —The exporter_reference.
get_id()
Getter method for id.
public
get_id() : string|null
Return values
string|null —The id.
get_importer_reference()
Getter method for importer_reference.
public
get_importer_reference() : string
Return values
string —The importer_reference.
get_invoice_number()
Getter method for invoice_number.
public
get_invoice_number() : string
Return values
string —The invoice_number.
get_items()
Getter method for items.
public
get_items() : array<string|int, mixed>
Return values
array<string|int, mixed> —The items.
get_posting_date()
Getter method for posting_date.
public
get_posting_date() : string
Return values
string —The posting_date.
get_required_fields()
Getter method for id.
public
get_required_fields() : array<string|int, mixed>
Return values
array<string|int, mixed> —The id.
get_total_value_amount()
Getter method for total_value_amount.
public
get_total_value_amount() : float
Return values
float —The total_value_amount.
set_additional_fees()
Setter method for additional_fees.
public
set_additional_fees(float $additional_fees) : void
Parameters
- $additional_fees : float
-
The additional_fees to set.
Return values
void —set_contents_explanation()
Setter method for contents_explanation.
public
set_contents_explanation(string $contents_explanation) : void
Parameters
- $contents_explanation : string
-
The contents_explanation to set.
Return values
void —set_contents_type()
Setter method for contents_type.
public
set_contents_type(string $contents_type) : void
Parameters
- $contents_type : string
-
The contents_type to set.
Tags
Return values
void —set_currency()
Setter method for currency.
public
set_currency(string $currency) : void
Parameters
- $currency : string
-
The currency to set.
Tags
Return values
void —set_drop_off_location()
Setter method for drop_off_location.
public
set_drop_off_location(string $drop_off_location) : void
Parameters
- $drop_off_location : string
-
The drop_off_location to set.
Return values
void —set_exporter_reference()
Setter method for exporter_reference.
public
set_exporter_reference(string $exporter_reference) : void
Parameters
- $exporter_reference : string
-
The exporter_reference to set.
Return values
void —set_id()
Setter method for id.
public
set_id(string $id) : void
Parameters
- $id : string
-
The id to set.
Return values
void —set_importer_reference()
Setter method for importer_reference.
public
set_importer_reference(string $importer_reference) : void
Parameters
- $importer_reference : string
-
The importer_reference to set.
Return values
void —set_invoice_number()
Setter method for invoice_number.
public
set_invoice_number(string $invoice_number) : void
Parameters
- $invoice_number : string
-
The invoice_number to set.
Return values
void —set_items()
Setter method for items.
public
set_items(array<string|int, mixed> $items) : void
Parameters
- $items : array<string|int, mixed>
-
The items to set.
Tags
Return values
void —set_posting_date()
Setter method for posting_date.
public
set_posting_date(string $posting_date) : void
Parameters
- $posting_date : string
-
The posting_date to set.
Return values
void —set_total_value_amount()
Setter method for total_value_amount.
public
set_total_value_amount(float $total_value_amount) : void
Parameters
- $total_value_amount : float
-
The total_value_amount to set (restriction minimum: 0, maximum: 1000).
Tags
Return values
void —to_array()
Getter method for parameter array.
public
to_array() : array<string|int, mixed>
Return values
array<string|int, mixed> —The class object as array.
to_string()
Getter method for string representation.
public
to_string() : string
Return values
string —The object as string representation.