Name	Name	Last commit message	Last commit date
Latest commit Jonathan Wenger comment tests for now. Dec 20, 2024 9983679 · Dec 20, 2024 History 13 Commits
.github/workflows	.github/workflows	Update package pipeline	Mar 21, 2024
.openapi-generator	.openapi-generator	initial seed for php-sdk	Feb 16, 2024
.vscode	.vscode	initial seed for php-sdk	Feb 16, 2024
docs/EInvoicing	docs/EInvoicing	Updates for 24.12.10	Dec 20, 2024
lib	lib	Updates for 24.12.10	Dec 20, 2024
test/Integration	test/Integration	comment tests for now.	Dec 20, 2024
.gitignore	.gitignore	initial seed for php-sdk	Feb 16, 2024
.gitlab-ci.yml	.gitlab-ci.yml	Update app sec pipeline for gitlab	Feb 21, 2024
.openapi-generator-ignore	.openapi-generator-ignore	initial seed for php-sdk	Feb 16, 2024
.php_cs	.php_cs	initial seed for php-sdk	Feb 16, 2024
.travis.yml	.travis.yml	initial seed for php-sdk	Feb 16, 2024
README.md	README.md	Updates for 24.12.10	Dec 20, 2024
composer.json	composer.json	Remove version.	Dec 20, 2024
composer.lock	composer.lock	Fix security issues	Feb 22, 2024
git_push.sh	git_push.sh	initial seed for php-sdk	Feb 16, 2024
index.php	index.php	initial seed for php-sdk	Feb 16, 2024
openapitools.json	openapitools.json	initial seed for php-sdk	Feb 16, 2024
phpunit.xml.dist	phpunit.xml.dist	Fix unit tests and test in pipeline	Feb 22, 2024

OpenAPIClient-php

API for evaluating transactions against direct-to-consumer Beverage Alcohol shipping regulations.

This API is currently in beta.

Installation & Usage

Requirements

PHP 7.3 and later. Should also work with PHP 8.0 but has not been tested.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP OAUTH2 Access Token and other config options
$config = new \Avalara\SDK\Configuration();
$config->setBearerToken('YOUR_JWT_ACCESS_TOKEN');
$config->setAppName('YOUR_APP_NAME');
$config->setEnvironment('sandbox');
$config->setMachineName('YOUR_MACHINE_NAME');
$config->setAppVersion('YOUR_APP_VERSION');

$client = new \Avalara\SDK\ApiClient($config);

$apiInstance = new Avalara\\SDK\Api\AddressesApi($client);

$x_avalara_client = 'Swagger UI; 22.7.0; Custom; 1.0'; // string | Identifies the software you are using to call this API.  For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
$body = new \Avalara\\SDK\Model\\Avatax\AddressValidationInfo(); // \Avalara\\SDK\Model\\Avatax\AddressValidationInfo | The address to resolve

try {
    $result = $apiInstance->resolveAddressPost($x_avalara_client, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AddressesApi->resolveAddressPost: ', $e->getMessage(), PHP_EOL;
}

Documentation for Authorization

Authentication schemes defined for the API:

OAuth Client Credentials

Type: OAuth
Flow: client_credentials
Scopes:
- avatax_api: avatax_api scope.

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP OAUTH2 Client Credentials Flow and other config options
$config = new \Avalara\SDK\Configuration();
$config->setClientId('YOUR_CLIENT_ID');
$config->setClientSecret('YOUR_CLIENT_SECRET');
$config->setAppName('YOUR_APP_NAME');
$config->setEnvironment('sandbox');
$config->setMachineName('YOUR_MACHINE_NAME');
$config->setAppVersion('YOUR_APP_VERSION');

$client = new \Avalara\SDK\ApiClient($config);

$apiInstance = new Avalara\\SDK\Api\AddressesApi($client);

$x_avalara_client = 'Swagger UI; 22.7.0; Custom; 1.0'; // string | Identifies the software you are using to call this API.  For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
$body = new \Avalara\\SDK\Model\\Avatax\AddressValidationInfo(); // \Avalara\\SDK\Model\\Avatax\AddressValidationInfo | The address to resolve

try {
    $result = $apiInstance->resolveAddressPost($x_avalara_client, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AddressesApi->resolveAddressPost: ', $e->getMessage(), PHP_EOL;
}

OAuth Device Code

Type: OAuth
Flow: device_code
Scopes:
- avatax_api: avatax_api scope.

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP OAUTH2 Device Code Flow and other config options
$config = new \Avalara\SDK\Configuration();
$config->setClientId('YOUR_CLIENT_ID');
$config->setAppName('YOUR_APP_NAME');
$config->setEnvironment('sandbox');
$config->setMachineName('YOUR_MACHINE_NAME');
$config->setAppVersion('YOUR_APP_VERSION');

// Fetch Device Code 
$result = \Avalara\SDK\Auth\OAuthHelper::initiateDeviceAuthorizationFlow('avatax_api', $config);
// User Interaction needs to happen here - some polling logic is needed to wait for offline user to authenticate to verification_uri through browser
$tokenResult = \Avalara\SDK\Auth\OAuthHelper::getAccessTokenForDeviceFlow($result->deviceCode, $config);
// Once user authenticates, tokenResult will contain Bearer token.
$config->setBearerToken($tokenResult->accessToken);

$client = new \Avalara\SDK\ApiClient($config);

$apiInstance = new Avalara\\SDK\Api\AddressesApi($client);

$x_avalara_client = 'Swagger UI; 22.7.0; Custom; 1.0'; // string | Identifies the software you are using to call this API.  For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
$body = new \Avalara\\SDK\Model\\Avatax\AddressValidationInfo(); // \Avalara\\SDK\Model\\Avatax\AddressValidationInfo | The address to resolve

try {
    $result = $apiInstance->resolveAddressPost($x_avalara_client, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AddressesApi->resolveAddressPost: ', $e->getMessage(), PHP_EOL;
}

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Logging

All PSR-3 compatible loggers are supported by the SDK.

Usage

Declare whichever PSR-3 logger that you desire and pass it in via the configuration object. The example below uses Monolog

use Monolog\Logger;
use Monolog\Handler\StreamHandler;

$config = new \Avalara\SDK\Configuration();
// Configure logger
$logger = new Logger('AddressLogger');
$logger->pushHandler(new StreamHandler(__DIR__ . '/../../app.log', Logger::DEBUG));
// Setup log options , first parameter is logRequestAndResponseBody, which can be true|false. Second parameter is the PSR-3 compatible logger.
$logOptions = new \Avalara\SDK\Utils\LogOptions(true, $logger);
$config->setLogOptions($logOptions);
$client =  new \Avalara\SDK\ApiClient($config);

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: v2
- Package version: 2.5.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

Documentation for API Endpoints

EInvoicing V1 API Documentation

Class	Method	HTTP request	Description
DataInputFieldsApi	getDataInputFields	GET /data-input-fields	Returns the mandatory and conditional invoice or creditnote input fields for different country mandates
DocumentsApi	downloadDocument	GET /documents/{documentId}/$download	Returns a copy of the document
DocumentsApi	getDocumentList	GET /documents	Returns a summary of documents for a date range
DocumentsApi	getDocumentStatus	GET /documents/{documentId}/status	Checks the status of a document
DocumentsApi	submitDocument	POST /documents	Submits a document to Avalara E-Invoicing API
MandatesApi	getMandates	GET /mandates	List country mandates that are supported by the Avalara E-Invoicing platform

EInvoicing V1 API Documentation

Class	Method	HTTP request	Description
DataInputFieldsApi	getDataInputFields	GET /data-input-fields	Returns the optionality of document fields for different country mandates
DocumentsApi	downloadDocument	GET /documents/{documentId}/$download	Returns a copy of the document
DocumentsApi	fetchDocuments	POST /documents/$fetch	Fetch the inbound document from a tax authority
DocumentsApi	getDocumentList	GET /documents	Returns a summary of documents for a date range
DocumentsApi	getDocumentStatus	GET /documents/{documentId}/status	Checks the status of a document
DocumentsApi	submitDocument	POST /documents	Submits a document to Avalara E-Invoicing API
MandatesApi	getMandateDataInputFields	GET /mandates/{mandateId}/data-input-fields	Returns document field information for a country mandate, a selected document type, and its version
MandatesApi	getMandates	GET /mandates	List country mandates that are supported by the Avalara E-Invoicing platform

EInvoicing V1 API Documentation

Class	Method	HTTP request	Description
DataInputFieldsApi	getDataInputFields	GET /data-input-fields	Returns the optionality of document fields for different country mandates
DocumentsApi	downloadDocument	GET /documents/{documentId}/$download	Returns a copy of the document
DocumentsApi	fetchDocuments	POST /documents/$fetch	Fetch the inbound document from a tax authority
DocumentsApi	getDocumentList	GET /documents	Returns a summary of documents for a date range
DocumentsApi	getDocumentStatus	GET /documents/{documentId}/status	Checks the status of a document
DocumentsApi	submitDocument	POST /documents	Submits a document to Avalara E-Invoicing API
InteropApi	submitInteropDocument	POST /interop/documents	Submit a document
MandatesApi	getMandateDataInputFields	GET /mandates/{mandateId}/data-input-fields	Returns document field information for a country mandate, a selected document type, and its version
MandatesApi	getMandates	GET /mandates	List country mandates that are supported by the Avalara E-Invoicing platform
TradingPartnersApi	batchSearchParticipants	POST /trading-partners/batch-searches	Creates a batch search and performs a batch search in the directory for participants in the background.
TradingPartnersApi	downloadBatchSearchReport	GET /trading-partners/batch-searches/{id}/$download-results	Download batch search results in a csv file.
TradingPartnersApi	getBatchSearchDetail	GET /trading-partners/batch-searches/{id}	Get the batch search details for a given id.
TradingPartnersApi	listBatchSearches	GET /trading-partners/batch-searches	List all batch searches that were previously submitted.
TradingPartnersApi	searchParticipants	GET /trading-partners	Returns a list of participants matching the input query.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

OpenAPIClient-php

Installation & Usage

Requirements

Composer

Manual Installation

Getting Started

Documentation for Authorization

OAuth Client Credentials

OAuth Device Code

Tests

Logging

Usage

About this package

Documentation for API Endpoints

EInvoicing V1 API Documentation

EInvoicing V1 API Documentation

EInvoicing V1 API Documentation

Documentation for Models

EInvoicing V1 Model Documentation

EInvoicing V1 Model Documentation

EInvoicing V1 Model Documentation

About

Releases 4

Packages

Languages

avadev/Avalara-SDK-PHP

Folders and files

Latest commit

History

Repository files navigation

OpenAPIClient-php

Installation & Usage

Requirements

Composer

Manual Installation

Getting Started

Documentation for Authorization

OAuth Client Credentials

OAuth Device Code

Tests

Logging

Usage

About this package

Documentation for API Endpoints

EInvoicing V1 API Documentation

EInvoicing V1 API Documentation

EInvoicing V1 API Documentation

Documentation for Models

EInvoicing V1 Model Documentation

EInvoicing V1 Model Documentation

EInvoicing V1 Model Documentation

About

Resources

Stars

Watchers

Forks

Releases 4

Packages 0

Languages

Packages