包简介

API for evaluating transactions against direct-to-consumer Beverage Alcohol shipping regulations. This API is currently in beta.

README 文档

README

Unified SDK consists of services on top of which the Avalara Compliance Cloud platform is built. These services are foundational and provide functionality such as einvoicing.

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/avadev/Avalara-SDK-PHP.git"
    }
  ],
  "require": {
    "avalara/avalara_sdk": "24.12.1"
  }
}

Then run composer install

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\EInvoicing\V1\MandatesApi($client);

$request_options = new \Avalara\SDK\API\EInvoicing\V1\GetMandatesRequest();
$request_options->setXAvalaraClient('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/) .
try {
    $result = $apiInstance->getMandates($request_options);
    print_r("Result: ". $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);

Documentation for API Endpoints

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.

Documentation for Models

EInvoicing V1 Model Documentation

Documentation for API Endpoints

EInvoicing V1 API Documentation

Class	Method	HTTP request	Description
CodeListsApi	getCodeList	GET /codelists/{codelistId}	Retrieves a code list by ID for a specific country
CodeListsApi	getCodeListList	GET /codelists	Returns a list of code lists for a specific country
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
ReportsApi	downloadReport	GET /reports/{reportId}/$download	Returns a pre-signed download URL for a report
ReportsApi	getReportById	GET /reports/{reportId}/status	Retrieves a report by its unique ID
ReportsApi	getReports	GET /reports	Returns a list of reports
SubscriptionsApi	createWebhookSubscription	POST /webhooks/subscriptions	Create a subscription to events
SubscriptionsApi	deleteWebhookSubscription	DELETE /webhooks/subscriptions/{subscriptionId}	Unsubscribe from events
SubscriptionsApi	getWebhookSubscription	GET /webhooks/subscriptions/{subscriptionId}	Get details of a subscription
SubscriptionsApi	listWebhookSubscriptions	GET /webhooks/subscriptions	List all subscriptions
TaxIdentifiersApi	taxIdentifierSchemaByCountry	GET /tax-identifiers/schema	Returns the tax identifier request and response schema for a specific country.
TaxIdentifiersApi	validateTaxIdentifier	POST /tax-identifiers/validate	Validates a tax identifier.
TradingPartnersApi	batchSearchParticipants	POST /trading-partners/batch-searches	Handles batch search requests by uploading a file containing search parameters.
TradingPartnersApi	createTradingPartner	POST /trading-partners	Creates a new trading partner.
TradingPartnersApi	createTradingPartnersBatch	POST /trading-partners/batch	Creates a batch of multiple trading partners.
TradingPartnersApi	deleteTradingPartner	DELETE /trading-partners/{id}	Deletes a trading partner using ID.
TradingPartnersApi	downloadBatchSearchReport	GET /trading-partners/batch-searches/{id}/$download-results	Downloads batch search results in a csv file.
TradingPartnersApi	getBatchSearchDetail	GET /trading-partners/batch-searches/{id}	Returns the batch search details using ID.
TradingPartnersApi	listBatchSearches	GET /trading-partners/batch-searches	Lists all batch searches that were previously submitted.
TradingPartnersApi	searchParticipants	GET /trading-partners	Returns a list of participants matching the input query.
TradingPartnersApi	updateTradingPartner	PUT /trading-partners/{id}	Updates a trading partner using ID.

A1099 V2 API Documentation

Class	Method	HTTP request	Description
CompaniesW9Api	createCompany	POST /w9/companies	Create a company
CompaniesW9Api	deleteCompany	DELETE /w9/companies/{id}	Delete a company
CompaniesW9Api	getCompanies	GET /w9/companies	List companies
CompaniesW9Api	getCompany	GET /w9/companies/{id}	Retrieve a company
CompaniesW9Api	updateCompany	PUT /w9/companies/{id}	Update a company
Forms1099Api	bulkUpsert1099Forms	POST /1099/forms/$bulk-upsert	Create or update multiple 1099/1095/W2/1042S forms
Forms1099Api	create1099Form	POST /1099/forms	Create a 1099/1095/W2/1042S form
Forms1099Api	delete1099Form	DELETE /1099/forms/{id}	Delete a 1099/1095/W2/1042S form
Forms1099Api	get1099Form	GET /1099/forms/{id}	Retrieve a 1099/1095/W2/1042S form
Forms1099Api	get1099FormPdf	GET /1099/forms/{id}/pdf	Retrieve the PDF file for a 1099/1095/W2/1042S form
Forms1099Api	list1099Forms	GET /1099/forms	List 1099/1095/W2/1042S forms
Forms1099Api	update1099Form	PUT /1099/forms/{id}	Update a 1099/1095/W2/1042S form
FormsW9Api	createAndSendW9FormEmail	POST /w9/forms/$create-and-send-email	Create a minimal W9/W4/W8 form and sends the e-mail request
FormsW9Api	createW9Form	POST /w9/forms	Create a W9/W4/W8 form
FormsW9Api	deleteW9Form	DELETE /w9/forms/{id}	Delete a W9/W4/W8 form
FormsW9Api	getW9Form	GET /w9/forms/{id}	Retrieve a W9/W4/W8 form
FormsW9Api	getW9FormPdf	GET /w9/forms/{id}/pdf	Download the PDF for a W9/W4/W8 form.
FormsW9Api	listW9Forms	GET /w9/forms	List W9/W4/W8 forms
FormsW9Api	sendW9FormEmail	POST /w9/forms/{id}/$send-email	Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form
FormsW9Api	updateW9Form	PUT /w9/forms/{id}	Update a W9/W4/W8 form
FormsW9Api	uploadW9Files	POST /w9/forms/{id}/attachment	Replace the PDF file for a W9/W4/W8 form
Issuers1099Api	createIssuer	POST /1099/issuers	Create an issuer
Issuers1099Api	deleteIssuer	DELETE /1099/issuers/{id}	Delete an issuer
Issuers1099Api	getIssuer	GET /1099/issuers/{id}	Retrieve an issuer
Issuers1099Api	getIssuers	GET /1099/issuers	List issuers
Issuers1099Api	updateIssuer	PUT /1099/issuers/{id}	Update an issuer
JobsApi	getJob	GET /jobs/{id}	Retrieves information about the job

Documentation for Models

EInvoicing V1 Model Documentation

A1099 V2 Model Documentation

avalara/avalara_sdk 适用场景与选型建议

avalara/avalara_sdk 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 96 次下载、GitHub Stars 达 1，最近一次更新时间为 2024 年 03 月 21 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「php」「rest」「api」「sdk」「openapi」「openapitools」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 avalara/avalara_sdk 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 avalara/avalara_sdk 我们能提供哪些服务？

定制开发 / 二次开发

基于 avalara/avalara_sdk 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 avalara/avalara_sdk 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

theodorejb/phaster 6

A PSR-7 compatible library for making CRUD API endpoints

braune-digital/api-base-bundle 0

Api bundle

foxtes/alfabank-rest 1

Alfabank REST API integration

intahwebz/flickrguzzle 4

A Flickr wrapper to allow you to call the Flickr api with Guzzle as the backend.Goal is to have 100% Flickr api coverage rather than just upload/display photos (currently at 23%).

gego-soft/php-client 0

BlockCypher's PHP SDK for REST API

wellrested/cookies 0

Helper classes for creating cookie headers

avalara/avalara_sdk

包简介

关键字：

README 文档

README

Installation & Usage

Requirements

Composer

Getting Started

Tests

Logging

Usage

Documentation for API Endpoints

EInvoicing V1 API Documentation

Documentation for Models

EInvoicing V1 Model Documentation

Documentation for API Endpoints

EInvoicing V1 API Documentation

A1099 V2 API Documentation

Documentation for Models

EInvoicing V1 Model Documentation

A1099 V2 Model Documentation

avalara/avalara_sdk 适用场景与选型建议

与 avalara/avalara_sdk 相关的其它包

统计信息

GitHub 信息

其他信息