README

easybill REST API 的第一个版本。 变更日志 ## 认证 您可以选择两种可用方法： 基本认证 或 Bearer Token。在每个 HTTP 请求中，需要以下 HTTP 头中的一个：# Basic Auth Authorization: Basic base64_encode('<email>:<api_key>') # Bearer Token Authorization: Bearer <api_key> ## 限制 ### 请求限制 * PLUS：每分钟 10 个请求 * BUSINESS：每分钟 60 个请求 如果超过限制，您将收到 HTTP 错误： 429 Too Many Requests ### 结果限制 所有结果列表默认限制为 100。此限制可以通过查询参数 limit 增加到最多 1000。 ## 查询过滤器 许多列表资源可以进行过滤。在 /documents 中，例如，可以通过 /documents?number=111028654 按编号过滤。如果想要过滤多个编号，可以输入以逗号分隔的编号 /documents?number=111028654,222006895 或作为数组 /documents?number[]=111028654&number[]=222006895。 警告：HTTP 请求行最大字节数为 4094。如果超过此限制，您将收到 HTTP 错误： 414 Request-URI Too Large ### 查询中的逗号转义 如果在请求中包含 X-Easybill-Escape: true 头，则可以在查询中转义逗号 name=Patrick\\, Peter。 ## 属性 login_id 这是您的管理员或员工账户的登录名。 ## 日期和日期时间格式 请使用时区 Europe/Berlin。 * date = Y-m-d = 2016-12-31 * date-time = Y-m-d H:i:s = 2016-12-31 03:13:37 日期或日期时间可以是 null，因为属性是后来添加的，条目较旧。

此 PHP 包由 Swagger Codegen 项目自动生成

• API 版本：1.70.1
• 构建包：io.swagger.codegen.v3.generators.php.PhpClientCodegen

要求

PHP 5.5 及更高版本

安装与使用

Composer

要通过 Composer 安装绑定，请将以下内容添加到 composer.json

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

然后运行 composer install

手动安装

下载文件并包含 autoload.php

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

测试

要运行单元测试

composer install
./vendor/bin/phpunit

入门指南

请遵循 安装过程，然后运行以下操作

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

// Configure API key authorization: Bearer
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Swagger\Client\Api\AttachmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$limit = 56; // int | Limited the result. Default is 100. Maximum can be 1000.
$page = 56; // int | Set current Page. Default is 1.

try {
    $result = $apiInstance->attachmentsGet($limit, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AttachmentApi->attachmentsGet: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: Bearer
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Swagger\Client\Api\AttachmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 789; // int | ID of attachment

try {
    $result = $apiInstance->attachmentsIdContentGet($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AttachmentApi->attachmentsIdContentGet: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: Bearer
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Swagger\Client\Api\AttachmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 789; // int | ID of attachment

try {
    $apiInstance->attachmentsIdDelete($id);
} catch (Exception $e) {
    echo 'Exception when calling AttachmentApi->attachmentsIdDelete: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: Bearer
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Swagger\Client\Api\AttachmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 789; // int | ID of attachment

try {
    $result = $apiInstance->attachmentsIdGet($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AttachmentApi->attachmentsIdGet: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: Bearer
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Swagger\Client\Api\AttachmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Swagger\Client\Model\Attachment(); // \Swagger\Client\Model\Attachment | 
$id = 789; // int | ID of attachment

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

// Configure API key authorization: Bearer
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Swagger\Client\Api\AttachmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$file = "file_example"; // string | 

try {
    $result = $apiInstance->attachmentsPost($file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AttachmentApi->attachmentsPost: ', $e->getMessage(), PHP_EOL;
}
?>

API 端点文档

所有 URI 都相对于 https://api.easybill.de/rest/v1

模型文档

• 附件
• 附件
• 附件体
• 联系
• 联系人
• 客户
• 客户组
• 客户组
• 客户快照
• 客户
• 折扣
• 折扣位置
• 折扣位置组
• 折扣位置组
• 折扣位置
• 文档
• 文档地址
• 文档支付
• 文档支付
• 文档位置
• 文档周期性
• 文档
• 登录
• 登录安全
• 登录
• 模型列表
• PDF 模板
• PDF 模板
• 位置
• 位置导出标识扩展
• 位置组
• 位置组集合
• 位置列表
• 邮政信箱
• 邮政信箱请求
• 邮政信箱集合
• 项目
• 项目列表
• SEPA支付
• SEPA支付列表
• 序列号
• 序列号列表
• 服务日期
• 库存
• 库存列表
• 任务
• 任务列表
• 文本模板
• 文本模板列表
• 时间跟踪
• 时间跟踪列表
• WebHook
• WebHook最后响应
• WebHook集合

授权文档

Bearer

• 类型: API密钥
• API密钥参数名: 授权
• 位置: HTTP头

基本认证

• 类型: HTTP基本认证

作者