Skip to content

Latest commit

 

History

History
158 lines (100 loc) · 5.52 KB

TaxReceiptApi.md

File metadata and controls

158 lines (100 loc) · 5.52 KB

HelloAssoApi.TaxReceiptApi

All URIs are relative to https://api.helloasso.com/v5

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

HelloAssoModelsAccountsOrganizationLegalInformationsOrganizationFiscalReceiptOptionsConfiguration organizationsOrganizationSlugTaxReceiptConfigurationGet(organizationSlug)

<br/><br/><b>Your token must have one of these roles : </b><br/>OrganizationAdmin<br/><br/>If you are an <b>association</b>, you can obtain these roles with your client.<br/>If you are a <b>partner</b>, you can obtain these roles by the authorize flow.<br/><br/><b>Your clientId must be allowed all of those privileges : </b> <br/> OrganizationAdministration<br/><br/>

Example

import HelloAssoApi from 'hello_asso_api';

let apiInstance = new HelloAssoApi.TaxReceiptApi();
let organizationSlug = "organizationSlug_example"; // String | 
apiInstance.organizationsOrganizationSlugTaxReceiptConfigurationGet(organizationSlug, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
organizationSlug String

Return type

HelloAssoModelsAccountsOrganizationLegalInformationsOrganizationFiscalReceiptOptionsConfiguration

Authorization

No authorization required

HTTP request headers

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

organizationsOrganizationSlugTaxReceiptConfigurationPut

organizationsOrganizationSlugTaxReceiptConfigurationPut(organizationSlug, file, opts)

<br/><br/><b>Your token must have one of these roles : </b><br/>OrganizationAdmin<br/><br/>If you are an <b>association</b>, you can obtain these roles with your client.<br/>If you are a <b>partner</b>, you can obtain these roles by the authorize flow.<br/><br/><b>Your clientId must be allowed all of those privileges : </b> <br/> OrganizationAdministration<br/><br/>

Example

import HelloAssoApi from 'hello_asso_api';

let apiInstance = new HelloAssoApi.TaxReceiptApi();
let organizationSlug = "organizationSlug_example"; // String | 
let file = "/path/to/file"; // File | Upload File
let opts = {
  'config': "config_example" // String | config
};
apiInstance.organizationsOrganizationSlugTaxReceiptConfigurationPut(organizationSlug, file, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
organizationSlug String
file File Upload File
config String config [optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

organizationsOrganizationSlugTaxReceiptPreviewPost

organizationsOrganizationSlugTaxReceiptPreviewPost(organizationSlug, file, opts)

<br/><br/><b>Your token must have one of these roles : </b><br/>OrganizationAdmin<br/><br/>If you are an <b>association</b>, you can obtain these roles with your client.<br/>If you are a <b>partner</b>, you can obtain these roles by the authorize flow.<br/><br/><b>Your clientId must be allowed all of those privileges : </b> <br/> OrganizationAdministration<br/><br/>

Example

import HelloAssoApi from 'hello_asso_api';

let apiInstance = new HelloAssoApi.TaxReceiptApi();
let organizationSlug = "organizationSlug_example"; // String | 
let file = "/path/to/file"; // File | Upload File
let opts = {
  'config': "config_example" // String | config
};
apiInstance.organizationsOrganizationSlugTaxReceiptPreviewPost(organizationSlug, file, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
organizationSlug String
file File Upload File
config String config [optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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