Skip to content

Latest commit

 

History

History
449 lines (360 loc) · 19.9 KB

README.md

File metadata and controls

449 lines (360 loc) · 19.9 KB
Raw

InvoiceItems

(accounting->invoiceItems)

Overview

Available Operations

  • create - Create Invoice Item
  • list - List Invoice Items
  • delete - Delete Invoice Item
  • get - Get Invoice Item
  • update - Update Invoice Item

create

Create Invoice Item

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Apideck\Unify;
use Apideck\Unify\Models\Components;
use Apideck\Unify\Models\Operations;
use Brick\DateTime\LocalDate;

$security = '<YOUR_BEARER_TOKEN_HERE>';

$sdk = Unify\Apideck::builder()
    ->setConsumerId('test-consumer')
    ->setAppId('dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX')
    ->setSecurity($security)->build();

$request = new Operations\AccountingInvoiceItemsAddRequest(
    invoiceItem: new Components\InvoiceItemInput(
        salesDetails: new Components\InvoiceItemSalesDetails(
            taxRate: new Components\LinkedTaxRateInput(
                id: '123456',
                rate: 10,
            ),
            unitPrice: 27500.5,
            unitOfMeasure: 'pc.',
            taxInclusive: true,
        ),
        purchaseDetails: new Components\InvoiceItemPurchaseDetails(
            taxRate: new Components\LinkedTaxRateInput(
                id: '123456',
                rate: 10,
            ),
            unitPrice: 27500.5,
            unitOfMeasure: 'pc.',
            taxInclusive: true,
        ),
        passThrough: [
            new Components\PassThroughBody(
                serviceId: '<id>',
                extendPaths: [
                    new Components\ExtendPaths(
                        path: '$.nested.property',
                        value: [
                            'TaxClassificationRef' => [
                                'value' => 'EUC-99990201-V1-00020000',
                            ],
                        ],
                    ),
                ],
            ),
        ],
        name: 'Model Y',
        description: 'Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.',
        code: '120-C',
        sold: true,
        purchased: true,
        tracked: true,
        taxable: true,
        inventoryDate: LocalDate::parse('2020-10-30'),
        type: Components\InvoiceItemTypeType::Inventory,
        quantity: 1,
        unitPrice: 27500.5,
        assetAccount: new Components\LinkedLedgerAccountInput(
            id: '123456',
            nominalCode: 'N091',
            code: '453',
        ),
        incomeAccount: new Components\LinkedLedgerAccountInput(
            id: '123456',
            nominalCode: 'N091',
            code: '453',
        ),
        expenseAccount: new Components\LinkedLedgerAccountInput(
            id: '123456',
            nominalCode: 'N091',
            code: '453',
        ),
        trackingCategories: [
            new Components\LinkedTrackingCategory(
                id: '123456',
                name: 'New York',
            ),
        ],
        active: true,
        rowVersion: '1-12345',
    ),
    serviceId: 'salesforce',
);

$response = $sdk->accounting->invoiceItems->create(
    request: $request
);

if ($response->createInvoiceItemResponse !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Operations\AccountingInvoiceItemsAddRequest ✔️ The request object to use for the request.

Response

?Operations\AccountingInvoiceItemsAddResponse

Errors

Error Type Status Code Content Type
Errors\BadRequestResponse 400 application/json
Errors\UnauthorizedResponse 401 application/json
Errors\PaymentRequiredResponse 402 application/json
Errors\NotFoundResponse 404 application/json
Errors\UnprocessableResponse 422 application/json
Errors\APIException 4XX, 5XX */*

list

List Invoice Items

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Apideck\Unify;
use Apideck\Unify\Models\Components;
use Apideck\Unify\Models\Operations;

$security = '<YOUR_BEARER_TOKEN_HERE>';

$sdk = Unify\Apideck::builder()
    ->setConsumerId('test-consumer')
    ->setAppId('dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX')
    ->setSecurity($security)->build();

$request = new Operations\AccountingInvoiceItemsAllRequest(
    serviceId: 'salesforce',
    filter: new Components\InvoiceItemsFilter(
        name: 'Widgets Large',
        type: Components\InvoiceItemType::Service,
    ),
    passThrough: [
        'search' => 'San Francisco',
    ],
    fields: 'id,updated_at',
);

$responses = $sdk->accounting->invoiceItems->list(
    request: $request
);


foreach ($responses as $response) {
    if ($response->httpMeta->response->getStatusCode() === 200) {
        // handle response
    }
}

Parameters

Parameter Type Required Description
$request Operations\AccountingInvoiceItemsAllRequest ✔️ The request object to use for the request.

Response

?Operations\AccountingInvoiceItemsAllResponse

Errors

Error Type Status Code Content Type
Errors\BadRequestResponse 400 application/json
Errors\UnauthorizedResponse 401 application/json
Errors\PaymentRequiredResponse 402 application/json
Errors\NotFoundResponse 404 application/json
Errors\UnprocessableResponse 422 application/json
Errors\APIException 4XX, 5XX */*

delete

Delete Invoice Item

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Apideck\Unify;
use Apideck\Unify\Models\Operations;

$security = '<YOUR_BEARER_TOKEN_HERE>';

$sdk = Unify\Apideck::builder()
    ->setConsumerId('test-consumer')
    ->setAppId('dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX')
    ->setSecurity($security)->build();

$request = new Operations\AccountingInvoiceItemsDeleteRequest(
    id: '<id>',
    serviceId: 'salesforce',
);

$response = $sdk->accounting->invoiceItems->delete(
    request: $request
);

if ($response->deleteTaxRateResponse !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Operations\AccountingInvoiceItemsDeleteRequest ✔️ The request object to use for the request.

Response

?Operations\AccountingInvoiceItemsDeleteResponse

Errors

Error Type Status Code Content Type
Errors\BadRequestResponse 400 application/json
Errors\UnauthorizedResponse 401 application/json
Errors\PaymentRequiredResponse 402 application/json
Errors\NotFoundResponse 404 application/json
Errors\UnprocessableResponse 422 application/json
Errors\APIException 4XX, 5XX */*

get

Get Invoice Item

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Apideck\Unify;
use Apideck\Unify\Models\Components;
use Apideck\Unify\Models\Operations;

$security = '<YOUR_BEARER_TOKEN_HERE>';

$sdk = Unify\Apideck::builder()
    ->setConsumerId('test-consumer')
    ->setAppId('dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX')
    ->setSecurity($security)->build();

$request = new Operations\AccountingInvoiceItemsOneRequest(
    id: '<id>',
    serviceId: 'salesforce',
    filter: new Components\InvoiceItemFilter(
        type: Components\InvoiceItemFilterInvoiceItemType::Service,
    ),
    fields: 'id,updated_at',
);

$response = $sdk->accounting->invoiceItems->get(
    request: $request
);

if ($response->getInvoiceItemResponse !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Operations\AccountingInvoiceItemsOneRequest ✔️ The request object to use for the request.

Response

?Operations\AccountingInvoiceItemsOneResponse

Errors

Error Type Status Code Content Type
Errors\BadRequestResponse 400 application/json
Errors\UnauthorizedResponse 401 application/json
Errors\PaymentRequiredResponse 402 application/json
Errors\NotFoundResponse 404 application/json
Errors\UnprocessableResponse 422 application/json
Errors\APIException 4XX, 5XX */*

update

Update Invoice Item

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Apideck\Unify;
use Apideck\Unify\Models\Components;
use Apideck\Unify\Models\Operations;
use Brick\DateTime\LocalDate;

$security = '<YOUR_BEARER_TOKEN_HERE>';

$sdk = Unify\Apideck::builder()
    ->setConsumerId('test-consumer')
    ->setAppId('dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX')
    ->setSecurity($security)->build();

$request = new Operations\AccountingInvoiceItemsUpdateRequest(
    id: '<id>',
    invoiceItem: new Components\InvoiceItemInput(
        salesDetails: new Components\InvoiceItemSalesDetails(
            taxRate: new Components\LinkedTaxRateInput(
                id: '123456',
                rate: 10,
            ),
            unitPrice: 27500.5,
            unitOfMeasure: 'pc.',
            taxInclusive: true,
        ),
        purchaseDetails: new Components\InvoiceItemPurchaseDetails(
            taxRate: new Components\LinkedTaxRateInput(
                id: '123456',
                rate: 10,
            ),
            unitPrice: 27500.5,
            unitOfMeasure: 'pc.',
            taxInclusive: true,
        ),
        passThrough: [
            new Components\PassThroughBody(
                serviceId: '<id>',
                extendPaths: [
                    new Components\ExtendPaths(
                        path: '$.nested.property',
                        value: [
                            'TaxClassificationRef' => [
                                'value' => 'EUC-99990201-V1-00020000',
                            ],
                        ],
                    ),
                ],
            ),
        ],
        name: 'Model Y',
        description: 'Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.',
        code: '120-C',
        sold: true,
        purchased: true,
        tracked: true,
        taxable: true,
        inventoryDate: LocalDate::parse('2020-10-30'),
        type: Components\InvoiceItemTypeType::Inventory,
        quantity: 1,
        unitPrice: 27500.5,
        assetAccount: new Components\LinkedLedgerAccountInput(
            id: '123456',
            nominalCode: 'N091',
            code: '453',
        ),
        incomeAccount: new Components\LinkedLedgerAccountInput(
            id: '123456',
            nominalCode: 'N091',
            code: '453',
        ),
        expenseAccount: new Components\LinkedLedgerAccountInput(
            id: '123456',
            nominalCode: 'N091',
            code: '453',
        ),
        trackingCategories: [
            new Components\LinkedTrackingCategory(
                id: '123456',
                name: 'New York',
            ),
        ],
        active: true,
        rowVersion: '1-12345',
    ),
    serviceId: 'salesforce',
);

$response = $sdk->accounting->invoiceItems->update(
    request: $request
);

if ($response->updateInvoiceItemsResponse !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Operations\AccountingInvoiceItemsUpdateRequest ✔️ The request object to use for the request.

Response

?Operations\AccountingInvoiceItemsUpdateResponse

Errors

Error Type Status Code Content Type
Errors\BadRequestResponse 400 application/json
Errors\UnauthorizedResponse 401 application/json
Errors\PaymentRequiredResponse 402 application/json
Errors\NotFoundResponse 404 application/json
Errors\UnprocessableResponse 422 application/json
Errors\APIException 4XX, 5XX */*