Skip to content

ReusFiscauxApi.md

Latest commit

 

History

History
224 lines (152 loc) · 9.16 KB

ReusFiscauxApi.md

File metadata and controls

224 lines (152 loc) · 9.16 KB

HelloAssoApi.ReusFiscauxApi

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

Method HTTP request Description
organizationsOrganizationSlugTaxReceiptConfigurationGet GET /organizations/{organizationSlug}/tax-receipt/configuration Obtenir la configuration des reçus fiscaux
organizationsOrganizationSlugTaxReceiptConfigurationPut PUT /organizations/{organizationSlug}/tax-receipt/configuration Mettre à jour la configuration des reçus fiscaux
organizationsOrganizationSlugTaxReceiptFiscalReceiptTransmitterPut PUT /organizations/{organizationSlug}/tax-receipt/fiscal-receipt-transmitter Mettre à jour l'émetteur des reçus fiscaux
organizationsOrganizationSlugTaxReceiptPreviewPost POST /organizations/{organizationSlug}/tax-receipt/preview Prévisualiser les reçus fiscaux

organizationsOrganizationSlugTaxReceiptConfigurationGet

HelloAssoCoreAccountsTaxReceiptsOrganizationFiscalReceiptOptionsConfiguration organizationsOrganizationSlugTaxReceiptConfigurationGet(organizationSlug)

Obtenir la configuration des reçus fiscaux

<br/><br/><b>Votre token doit avoir l'un de ces rôles : </b><br/>OrganizationAdmin<br/>FormAdmin<br/><br/>Si vous êtes une <b>association</b>, vous pouvez obtenir ces rôles avec votre client.<br/>Si vous êtes un <b>partenaire</b>, vous pouvez obtenir ces rôles par le flux d'autorisation.<br/><br/><b>Votre clientId doit être autorisé à tous ces privilèges : </b> <br/> RefundManagement<br/><br/>

Example

import HelloAssoApi from 'hello_asso_api';
let defaultClient = HelloAssoApi.ApiClient.instance;
// Configure OAuth2 access token for authorization: OAuth2
let OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new HelloAssoApi.ReusFiscauxApi();
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

HelloAssoCoreAccountsTaxReceiptsOrganizationFiscalReceiptOptionsConfiguration

Authorization

OAuth2

HTTP request headers

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

organizationsOrganizationSlugTaxReceiptConfigurationPut

organizationsOrganizationSlugTaxReceiptConfigurationPut(organizationSlug, file, opts)

Mettre à jour la configuration des reçus fiscaux

<br/><br/><b>Votre token doit avoir l'un de ces rôles : </b><br/>OrganizationAdmin<br/>FormAdmin<br/><br/>Si vous êtes une <b>association</b>, vous pouvez obtenir ces rôles avec votre client.<br/>Si vous êtes un <b>partenaire</b>, vous pouvez obtenir ces rôles par le flux d'autorisation.<br/><br/><b>Votre clientId doit être autorisé à tous ces privilèges : </b> <br/> RefundManagement<br/><br/>

Example

import HelloAssoApi from 'hello_asso_api';
let defaultClient = HelloAssoApi.ApiClient.instance;
// Configure OAuth2 access token for authorization: OAuth2
let OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new HelloAssoApi.ReusFiscauxApi();
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

OAuth2

HTTP request headers

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

organizationsOrganizationSlugTaxReceiptFiscalReceiptTransmitterPut

organizationsOrganizationSlugTaxReceiptFiscalReceiptTransmitterPut(organizationSlug, opts)

Mettre à jour l'émetteur des reçus fiscaux

<br/><br/><b>Votre token doit avoir l'un de ces rôles : </b><br/>OrganizationAdmin<br/>FormAdmin<br/><br/>Si vous êtes une <b>association</b>, vous pouvez obtenir ces rôles avec votre client.<br/>Si vous êtes un <b>partenaire</b>, vous pouvez obtenir ces rôles par le flux d'autorisation.<br/><br/><b>Votre clientId doit être autorisé à tous ces privilèges : </b> <br/> RefundManagement<br/><br/>

Example

import HelloAssoApi from 'hello_asso_api';
let defaultClient = HelloAssoApi.ApiClient.instance;
// Configure OAuth2 access token for authorization: OAuth2
let OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new HelloAssoApi.ReusFiscauxApi();
let organizationSlug = "organizationSlug_example"; // String | 
let opts = {
  'helloAssoApiV5ModelsOrganizationLegalInformationsUpdateOrganizationFiscalReceiptTransmitterBody': new HelloAssoApi.HelloAssoApiV5ModelsOrganizationLegalInformationsUpdateOrganizationFiscalReceiptTransmitterBody() // HelloAssoApiV5ModelsOrganizationLegalInformationsUpdateOrganizationFiscalReceiptTransmitterBody | 
};
apiInstance.organizationsOrganizationSlugTaxReceiptFiscalReceiptTransmitterPut(organizationSlug, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
organizationSlug String
helloAssoApiV5ModelsOrganizationLegalInformationsUpdateOrganizationFiscalReceiptTransmitterBody HelloAssoApiV5ModelsOrganizationLegalInformationsUpdateOrganizationFiscalReceiptTransmitterBody [optional]

Return type

null (empty response body)

Authorization

OAuth2

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/*+json
  • Accept: Not defined

organizationsOrganizationSlugTaxReceiptPreviewPost

organizationsOrganizationSlugTaxReceiptPreviewPost(organizationSlug, file, opts)

Prévisualiser les reçus fiscaux

<br/><br/><b>Votre token doit avoir l'un de ces rôles : </b><br/>OrganizationAdmin<br/>FormAdmin<br/><br/>Si vous êtes une <b>association</b>, vous pouvez obtenir ces rôles avec votre client.<br/>Si vous êtes un <b>partenaire</b>, vous pouvez obtenir ces rôles par le flux d'autorisation.<br/><br/><b>Votre clientId doit être autorisé à tous ces privilèges : </b> <br/> RefundManagement<br/><br/>

Example

import HelloAssoApi from 'hello_asso_api';
let defaultClient = HelloAssoApi.ApiClient.instance;
// Configure OAuth2 access token for authorization: OAuth2
let OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new HelloAssoApi.ReusFiscauxApi();
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

OAuth2

HTTP request headers

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