Skip to content

Latest commit

 

History

History
184 lines (121 loc) · 6.66 KB

TaxReceiptApi.md

File metadata and controls

184 lines (121 loc) · 6.66 KB

OpenAPI\Client\TaxReceiptApi

All URIs are relative to https://api.helloasso.com/v5, except if the operation defines another base path.

Method HTTP request Description
organizationsOrganizationSlugTaxReceiptConfigurationGet() GET /organizations/{organizationSlug}/tax-receipt/configuration
organizationsOrganizationSlugTaxReceiptConfigurationPut() PUT /organizations/{organizationSlug}/tax-receipt/configuration
organizationsOrganizationSlugTaxReceiptPreviewPost() POST /organizations/{organizationSlug}/tax-receipt/preview

organizationsOrganizationSlugTaxReceiptConfigurationGet()

organizationsOrganizationSlugTaxReceiptConfigurationGet($organization_slug): \OpenAPI\Client\Model\HelloAssoModelsAccountsOrganizationLegalInformationsOrganizationFiscalReceiptOptionsConfiguration



Your token must have one of these roles :
OrganizationAdmin

If you are an association, you can obtain these roles with your client.
If you are a partner, you can obtain these roles by the authorize flow.

Your clientId must be allowed all of those privileges :
OrganizationAdministration

Example

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



$apiInstance = new OpenAPI\Client\Api\TaxReceiptApi(
    // 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()
);
$organization_slug = 'organization_slug_example'; // string

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

Parameters

Name Type Description Notes
organization_slug string

Return type

\OpenAPI\Client\Model\HelloAssoModelsAccountsOrganizationLegalInformationsOrganizationFiscalReceiptOptionsConfiguration

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

organizationsOrganizationSlugTaxReceiptConfigurationPut()

organizationsOrganizationSlugTaxReceiptConfigurationPut($organization_slug, $file, $config)



Your token must have one of these roles :
OrganizationAdmin

If you are an association, you can obtain these roles with your client.
If you are a partner, you can obtain these roles by the authorize flow.

Your clientId must be allowed all of those privileges :
OrganizationAdministration

Example

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



$apiInstance = new OpenAPI\Client\Api\TaxReceiptApi(
    // 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()
);
$organization_slug = 'organization_slug_example'; // string
$file = '/path/to/file.txt'; // \SplFileObject | Upload File
$config = 'config_example'; // string | config

try {
    $apiInstance->organizationsOrganizationSlugTaxReceiptConfigurationPut($organization_slug, $file, $config);
} catch (Exception $e) {
    echo 'Exception when calling TaxReceiptApi->organizationsOrganizationSlugTaxReceiptConfigurationPut: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
organization_slug string
file \SplFileObject**\SplFileObject** Upload File
config string config [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

organizationsOrganizationSlugTaxReceiptPreviewPost()

organizationsOrganizationSlugTaxReceiptPreviewPost($organization_slug, $file, $config)



Your token must have one of these roles :
OrganizationAdmin

If you are an association, you can obtain these roles with your client.
If you are a partner, you can obtain these roles by the authorize flow.

Your clientId must be allowed all of those privileges :
OrganizationAdministration

Example

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



$apiInstance = new OpenAPI\Client\Api\TaxReceiptApi(
    // 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()
);
$organization_slug = 'organization_slug_example'; // string
$file = '/path/to/file.txt'; // \SplFileObject | Upload File
$config = 'config_example'; // string | config

try {
    $apiInstance->organizationsOrganizationSlugTaxReceiptPreviewPost($organization_slug, $file, $config);
} catch (Exception $e) {
    echo 'Exception when calling TaxReceiptApi->organizationsOrganizationSlugTaxReceiptPreviewPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
organization_slug string
file \SplFileObject**\SplFileObject** Upload File
config string config [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]