Skip to content

Feature Items #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 26, 2025
Merged

Feature Items #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2dec8f7
REST API Items
StanBarrows Nov 26, 2025
8bbb806
Fixed CI Tests
StanBarrows Nov 26, 2025
7d3cd79
Updated DTO and tested it with real API for creating fixtures
StanBarrows Nov 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions .gitbook.yaml
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion .phpunit.cache/test-results
View file
Open in desktop

Large diffs are not rendered by default.

79 changes: 79 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ This package was developed to give you a quick start to the Bexio API.
- [Files](#files)
- [Iban Payments](#iban-payments)
- [Invoices](#invoices)
- [Items](#items)
- [Languages](#languages)
- [Manual Entries](#manual-entries)
- [Notes](#notes)
Expand Down Expand Up @@ -682,6 +683,7 @@ We provide enums for the following values:
| ContactSectors: OrderByEnum | ID(), ID_ASC(), ID_DESC(), NAME(), NAME_ASC(), NAME_DESC() |
| IbanPayments: AllowanceTypeEnum | FEE_PAID_BY_SENDER(), FEE_PAID_BY_RECIPIENT(), FEE_SPLIT(), NO_FEE() |
| IbanPayments: StatusEnum | OPEN(), TRANSFERRED(), DOWNLOADED(), ERROR(), CANCELLED() |
| Items: OrderByEnum | ID(), ID_ASC(), ID_DESC(), INTERN_NAME(), INTERN_NAME_ASC(), INTERN_NAME_DESC() |
| ManualEntries: TypeEnum | MANUAL_SINGLE_ENTRY(), MANUAL_GROUP_ENTRY(), MANUAL_COMPOUND_ENTRY() |
| QrPayments: AllowanceTypeEnum | FEE_PAID_BY_SENDER(), FEE_PAID_BY_RECIPIENT(), FEE_SPLIT(), NO_FEE() |
| QrPayments: StatusEnum | OPEN(), TRANSFERRED(), DOWNLOADED(), ERROR(), CANCELLED() |
Expand Down Expand Up @@ -725,6 +727,8 @@ We provide DTOs for the following:
| InvoiceDTO |
| InvoicePositionDTO |
| InvoiceTaxDTO |
| ItemDTO |
| CreateEditItemDTO |
| PdfDTO |
| LanguageDTO |
| AddFileDTO |
Expand Down Expand Up @@ -2003,6 +2007,81 @@ $title = $connector->send(new DeleteATitleRequest(
));
```

### Items
```php
/**
* Fetch A List Of Items
*/
$items = $connector->send(new FetchAListOfItemsRequest())->dto();
```

```php
/**
* Fetch An Item
*/
$item = $connector->send(new FetchAnItemRequest(
article_id: 1
))->dto();
```

```php
/**
* Search Items
*/
$items = $connector->send(new SearchItemsRequest(
searchField: 'intern_name',
searchTerm: 'Something'
))->dto();
```

```php
/**
* Create Item
*/
$item = $connector->send(new CreateItemRequest(
data: new CreateEditItemDTO(
user_id: 1,
article_type_id: 1,
intern_code: 'ITEM-001',
intern_name: 'Test Item',
intern_description: 'Item Description',
sale_price: '20.00',
purchase_price: '10.00',
currency_id: 1,
tax_income_id: 14,
tax_expense_id: 21,
unit_id: 1,
)
))->dto();
```

```php
/**
* Edit Item
*/
$item = $connector->send(new EditAnItemRequest(
article_id: 1,
data: new CreateEditItemDTO(
user_id: 1,
article_type_id: 1,
intern_code: 'ITEM-001',
intern_name: 'Updated Item Name',
intern_description: 'Updated Description',
sale_price: '25.00',
purchase_price: '15.00',
)
))->dto();
```

```php
/**
* Delete Item
*/
$response = $connector->send(new DeleteAnItemRequest(
article_id: 1
));
```

### VAT Periods
```php
/**
Expand Down
1 change: 1 addition & 0 deletions phpunit.xml.dist
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
<php>
<env name="APP_KEY" value="base64:F+mHMDBbavrsp/I3WYA5lDSwDJJI/0wQG4eM3csq/lo="/>
<env name="BEXIO_API_TOKEN" value=""/>
<env name="RESET_FIXTURES" value="false"/>
</php>
<source>
<include>
Expand Down
99 changes: 99 additions & 0 deletions src/Dto/Items/CreateEditItemDTO.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
<?php

namespace CodebarAg\Bexio\Dto\Items;

use Exception;
use Illuminate\Support\Arr;
use Saloon\Http\Response;
use Spatie\LaravelData\Data;

class CreateEditItemDTO extends Data
{
public function __construct(
public ?int $user_id,
public int $article_type_id,
public ?int $contact_id,
public ?string $deliverer_code,
public ?string $deliverer_name,
public ?string $deliverer_description,
Comment on lines +13 to +18
Copy link

Copilot AI Nov 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The nullable parameters without default values ($user_id, $contact_id, $deliverer_code, $deliverer_name, $deliverer_description) must be provided when instantiating this DTO, making them effectively required. This is confusing for API consumers. These parameters should either have = null defaults to make them truly optional, or be marked as non-nullable if they're required. The current signature creates ambiguity about which parameters are actually optional.

Suggested change
public ?int $user_id,
public int $article_type_id,
public ?int $contact_id,
public ?string $deliverer_code,
public ?string $deliverer_name,
public ?string $deliverer_description,
public ?int $user_id = null,
public int $article_type_id,
public ?int $contact_id = null,
public ?string $deliverer_code = null,
public ?string $deliverer_name = null,
public ?string $deliverer_description = null,

Copilot uses AI. Check for mistakes.
public string $intern_code,
public string $intern_name,
public ?string $intern_description = null,
public ?string $purchase_price = null,
public ?string $sale_price = null,
public ?float $purchase_total = null,
public ?float $sale_total = null,
public ?int $currency_id = null,
public ?int $tax_income_id = null,
public ?int $tax_expense_id = null,
public ?int $unit_id = null,
public bool $is_stock = false,
public ?int $stock_id = null,
public ?int $stock_place_id = null,
public int $stock_nr = 0,
public int $stock_min_nr = 0,
public ?int $width = null,
public ?int $height = null,
public ?int $weight = null,
public ?int $volume = null,
public ?string $html_text = null, // Deprecated
public ?string $remarks = null,
public ?float $delivery_price = null,
public ?int $article_group_id = null,
public ?int $account_id = null,
public ?int $expense_account_id = null,
) {}

public static function fromResponse(Response $response): self
{
if ($response->failed()) {
throw new \Exception('Failed to create DTO from Response');
}

$data = $response->json();

return self::fromArray($data);
}

public static function fromArray(array $data): self
{
if (! $data) {
throw new Exception('Unable to create DTO. Data missing from response.');
}

return new self(
user_id: Arr::get($data, 'user_id'),
article_type_id: Arr::get($data, 'article_type_id'),
contact_id: Arr::get($data, 'contact_id'),
deliverer_code: Arr::get($data, 'deliverer_code'),
deliverer_name: Arr::get($data, 'deliverer_name'),
deliverer_description: Arr::get($data, 'deliverer_description'),
intern_code: Arr::get($data, 'intern_code'),
intern_name: Arr::get($data, 'intern_name'),
intern_description: Arr::get($data, 'intern_description'),
purchase_price: Arr::get($data, 'purchase_price'),
sale_price: Arr::get($data, 'sale_price'),
purchase_total: Arr::get($data, 'purchase_total'),
sale_total: Arr::get($data, 'sale_total'),
currency_id: Arr::get($data, 'currency_id'),
tax_income_id: Arr::get($data, 'tax_income_id'),
tax_expense_id: Arr::get($data, 'tax_expense_id'),
unit_id: Arr::get($data, 'unit_id'),
is_stock: Arr::get($data, 'is_stock', false),
stock_id: Arr::get($data, 'stock_id'),
stock_place_id: Arr::get($data, 'stock_place_id'),
stock_nr: Arr::get($data, 'stock_nr', 0),
stock_min_nr: Arr::get($data, 'stock_min_nr', 0),
width: Arr::get($data, 'width'),
height: Arr::get($data, 'height'),
weight: Arr::get($data, 'weight'),
volume: Arr::get($data, 'volume'),
html_text: Arr::get($data, 'html_text'),
remarks: Arr::get($data, 'remarks'),
delivery_price: Arr::get($data, 'delivery_price'),
article_group_id: Arr::get($data, 'article_group_id'),
account_id: Arr::get($data, 'account_id'),
expense_account_id: Arr::get($data, 'expense_account_id'),
);
}
}
115 changes: 115 additions & 0 deletions src/Dto/Items/ItemDTO.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
<?php

namespace CodebarAg\Bexio\Dto\Items;

use Exception;
use Illuminate\Support\Arr;
use Saloon\Http\Response;
use Spatie\LaravelData\Data;

class ItemDTO extends Data
{
public function __construct(
public int $id,
public int $user_id,
public int $article_type_id,
public ?int $contact_id,
public ?int $master_id,
public ?string $deliverer_code,
public ?string $deliverer_name,
public ?string $deliverer_description,
public string $intern_code,
public string $intern_name,
public ?string $intern_description,
public ?string $purchase_price,
public ?string $sale_price,
public ?float $purchase_total,
public ?float $sale_total,
public ?int $currency_id,
public ?int $tax_income_id,
public ?int $tax_id,
public ?int $tax_expense_id,
public ?int $unit_id,
public bool $is_stock,
public ?int $stock_id,
public ?int $stock_place_id,
public int $stock_nr,
public int $stock_min_nr,
public int $stock_reserved_nr,
public int $stock_available_nr,
public int $stock_picked_nr,
public int $stock_disposed_nr,
public int $stock_ordered_nr,
public ?int $width,
public ?int $height,
public ?int $weight,
public ?int $volume,
public ?string $html_text, // Deprecated
public ?string $remarks,
public ?float $delivery_price,
public ?int $article_group_id,
public ?int $account_id,
public ?int $expense_account_id,
) {}

public static function fromResponse(Response $response): self
{
if ($response->failed()) {
throw new \Exception('Failed to create DTO from Response');
}

$data = $response->json();

return self::fromArray($data);
}

public static function fromArray(array $data): self
{
if (! $data) {
throw new Exception('Unable to create DTO. Data missing from response.');
}

return new self(
id: Arr::get($data, 'id'),
user_id: Arr::get($data, 'user_id'),
article_type_id: Arr::get($data, 'article_type_id'),
contact_id: Arr::get($data, 'contact_id'),
master_id: Arr::get($data, 'master_id'),
deliverer_code: Arr::get($data, 'deliverer_code'),
deliverer_name: Arr::get($data, 'deliverer_name'),
deliverer_description: Arr::get($data, 'deliverer_description'),
intern_code: Arr::get($data, 'intern_code'),
intern_name: Arr::get($data, 'intern_name'),
intern_description: Arr::get($data, 'intern_description'),
purchase_price: Arr::get($data, 'purchase_price'),
sale_price: Arr::get($data, 'sale_price'),
purchase_total: Arr::get($data, 'purchase_total'),
sale_total: Arr::get($data, 'sale_total'),
currency_id: Arr::get($data, 'currency_id'),
tax_income_id: Arr::get($data, 'tax_income_id'),
tax_id: Arr::get($data, 'tax_id'),
tax_expense_id: Arr::get($data, 'tax_expense_id'),
unit_id: Arr::get($data, 'unit_id'),
is_stock: Arr::get($data, 'is_stock', false),
stock_id: Arr::get($data, 'stock_id'),
stock_place_id: Arr::get($data, 'stock_place_id'),
stock_nr: Arr::get($data, 'stock_nr', 0),
stock_min_nr: Arr::get($data, 'stock_min_nr', 0),
stock_reserved_nr: Arr::get($data, 'stock_reserved_nr', 0),
stock_available_nr: Arr::get($data, 'stock_available_nr', 0),
stock_picked_nr: Arr::get($data, 'stock_picked_nr', 0),
stock_disposed_nr: Arr::get($data, 'stock_disposed_nr', 0),
stock_ordered_nr: Arr::get($data, 'stock_ordered_nr', 0),
width: Arr::get($data, 'width'),
height: Arr::get($data, 'height'),
weight: Arr::get($data, 'weight'),
volume: Arr::get($data, 'volume'),
html_text: Arr::get($data, 'html_text'),
remarks: Arr::get($data, 'remarks'),
delivery_price: Arr::get($data, 'delivery_price'),
article_group_id: Arr::get($data, 'article_group_id'),
account_id: Arr::get($data, 'account_id'),
expense_account_id: Arr::get($data, 'expense_account_id'),
);
}
}
40 changes: 40 additions & 0 deletions src/Enums/Items/OrderByEnum.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<?php

namespace CodebarAg\Bexio\Enums\Items;

use Spatie\Enum\Laravel\Enum;

/**
* @method static self ID()
* @method static self ID_ASC()
* @method static self ID_DESC()
* @method static self INTERN_NAME()
* @method static self INTERN_NAME_ASC()
* @method static self INTERN_NAME_DESC()
*/
final class OrderByEnum extends Enum
{
protected static function values(): array
{
return [
'ID' => 'id',
'ID_ASC' => 'id_asc',
'ID_DESC' => 'id_desc',
'INTERN_NAME' => 'intern_name',
'INTERN_NAME_ASC' => 'intern_name_asc',
'INTERN_NAME_DESC' => 'intern_name_desc',
];
}

protected static function labels(): array
{
return [
'ID' => 'Id',
'ID_ASC' => 'Id Ascending',
'ID_DESC' => 'Id Descending',
'INTERN_NAME' => 'Intern Name',
'INTERN_NAME_ASC' => 'Intern Name Ascending',
'INTERN_NAME_DESC' => 'Intern Name Descending',
];
}
}
Loading