TaxesApi

All URIs are relative to https://api-v2.fattureincloud.it

Method	HTTP request	Description
createF24	POST /c/{company_id}/taxes	Create F24
deleteF24	DELETE /c/{company_id}/taxes/{document_id}	Delete F24
deleteF24Attachment	DELETE /c/{company_id}/taxes/{document_id}/attachment	Delete F24 Attachment
getF24	GET /c/{company_id}/taxes/{document_id}	Get F24
listF24	GET /c/{company_id}/taxes	List F24
modifyF24	PUT /c/{company_id}/taxes/{document_id}	Modify F24
uploadF24Attachment	POST /c/{company_id}/taxes/attachment	Upload F24 Attachment

createF24

CreateF24Response createF24(companyId, createF24Request)

Create F24

Creates a new F24.

Example

// Import classes:
import it.fattureincloud.sdk.ApiClient;
import it.fattureincloud.sdk.ApiException;
import it.fattureincloud.sdk.Configuration;
import it.fattureincloud.sdk.auth.*;
import it.fattureincloud.sdk.models.*;
import it.fattureincloud.sdk.api.TaxesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api-v2.fattureincloud.it");
    
    // Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
    OAuth OAuth2AuthenticationCodeFlow = (OAuth) defaultClient.getAuthentication("OAuth2AuthenticationCodeFlow");
    OAuth2AuthenticationCodeFlow.setAccessToken("YOUR ACCESS TOKEN");

    TaxesApi apiInstance = new TaxesApi(defaultClient);
    Integer companyId = 12345; // Integer | The ID of the company.
    CreateF24Request createF24Request = new CreateF24Request(); // CreateF24Request | The F24 to create
    try {
      CreateF24Response result = apiInstance.createF24(companyId, createF24Request);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling TaxesApi#createF24");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
companyId	Integer	The ID of the company.
createF24Request	CreateF24Request	The F24 to create	[optional]

Return type

CreateF24Response

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The created F24	-
401	Unauthorized	-
404	Not Found	-

deleteF24

deleteF24(companyId, documentId)

Delete F24

Removes the specified F24.

Example

// Import classes:
import it.fattureincloud.sdk.ApiClient;
import it.fattureincloud.sdk.ApiException;
import it.fattureincloud.sdk.Configuration;
import it.fattureincloud.sdk.auth.*;
import it.fattureincloud.sdk.models.*;
import it.fattureincloud.sdk.api.TaxesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api-v2.fattureincloud.it");
    
    // Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
    OAuth OAuth2AuthenticationCodeFlow = (OAuth) defaultClient.getAuthentication("OAuth2AuthenticationCodeFlow");
    OAuth2AuthenticationCodeFlow.setAccessToken("YOUR ACCESS TOKEN");

    TaxesApi apiInstance = new TaxesApi(defaultClient);
    Integer companyId = 12345; // Integer | The ID of the company.
    Integer documentId = 56; // Integer | The ID of the document.
    try {
      apiInstance.deleteF24(companyId, documentId);
    } catch (ApiException e) {
      System.err.println("Exception when calling TaxesApi#deleteF24");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
companyId	Integer	The ID of the company.
documentId	Integer	The ID of the document.

Return type

null (empty response body)

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Document removed.	-
401	Unauthorized	-
404	Not Found	-

deleteF24Attachment

deleteF24Attachment(companyId, documentId)

Delete F24 Attachment

Removes the attachment of the specified F24.

Example

// Import classes:
import it.fattureincloud.sdk.ApiClient;
import it.fattureincloud.sdk.ApiException;
import it.fattureincloud.sdk.Configuration;
import it.fattureincloud.sdk.auth.*;
import it.fattureincloud.sdk.models.*;
import it.fattureincloud.sdk.api.TaxesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api-v2.fattureincloud.it");
    
    // Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
    OAuth OAuth2AuthenticationCodeFlow = (OAuth) defaultClient.getAuthentication("OAuth2AuthenticationCodeFlow");
    OAuth2AuthenticationCodeFlow.setAccessToken("YOUR ACCESS TOKEN");

    TaxesApi apiInstance = new TaxesApi(defaultClient);
    Integer companyId = 12345; // Integer | The ID of the company.
    Integer documentId = 56; // Integer | The ID of the document.
    try {
      apiInstance.deleteF24Attachment(companyId, documentId);
    } catch (ApiException e) {
      System.err.println("Exception when calling TaxesApi#deleteF24Attachment");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
companyId	Integer	The ID of the company.
documentId	Integer	The ID of the document.

Return type

null (empty response body)

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	File Removed.	-
401	Unauthorized	-
404	Not Found	-

getF24

GetF24Response getF24(companyId, documentId, fields, fieldset)

Get F24

Gets the specified F24.

Example

// Import classes:
import it.fattureincloud.sdk.ApiClient;
import it.fattureincloud.sdk.ApiException;
import it.fattureincloud.sdk.Configuration;
import it.fattureincloud.sdk.auth.*;
import it.fattureincloud.sdk.models.*;
import it.fattureincloud.sdk.api.TaxesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api-v2.fattureincloud.it");
    
    // Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
    OAuth OAuth2AuthenticationCodeFlow = (OAuth) defaultClient.getAuthentication("OAuth2AuthenticationCodeFlow");
    OAuth2AuthenticationCodeFlow.setAccessToken("YOUR ACCESS TOKEN");

    TaxesApi apiInstance = new TaxesApi(defaultClient);
    Integer companyId = 12345; // Integer | The ID of the company.
    Integer documentId = 56; // Integer | The ID of the document.
    String fields = "fields_example"; // String | List of comma-separated fields.
    String fieldset = "basic"; // String | Name of the fieldset.
    try {
      GetF24Response result = apiInstance.getF24(companyId, documentId, fields, fieldset);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling TaxesApi#getF24");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
companyId	Integer	The ID of the company.
documentId	Integer	The ID of the document.
fields	String	List of comma-separated fields.	[optional]
fieldset	String	Name of the fieldset.	[optional] [enum: basic, detailed]

Return type

GetF24Response

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The F24	-
401	Unauthorized	-
404	Not Found	-

listF24

ListF24Response listF24(companyId, fields, fieldset, sort, page, perPage, q)

List F24

Lists the F24s.

Example

// Import classes:
import it.fattureincloud.sdk.ApiClient;
import it.fattureincloud.sdk.ApiException;
import it.fattureincloud.sdk.Configuration;
import it.fattureincloud.sdk.auth.*;
import it.fattureincloud.sdk.models.*;
import it.fattureincloud.sdk.api.TaxesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api-v2.fattureincloud.it");
    
    // Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
    OAuth OAuth2AuthenticationCodeFlow = (OAuth) defaultClient.getAuthentication("OAuth2AuthenticationCodeFlow");
    OAuth2AuthenticationCodeFlow.setAccessToken("YOUR ACCESS TOKEN");

    TaxesApi apiInstance = new TaxesApi(defaultClient);
    Integer companyId = 12345; // Integer | The ID of the company.
    String fields = "fields_example"; // String | List of comma-separated fields.
    String fieldset = "basic"; // String | Name of the fieldset.
    String sort = "sort_example"; // String | List of comma-separated fields for result sorting (minus for desc sorting).
    Integer page = 1; // Integer | The page to retrieve.
    Integer perPage = 5; // Integer | The size of the page.
    String q = "q_example"; // String | Query for filtering the results.
    try {
      ListF24Response result = apiInstance.listF24(companyId, fields, fieldset, sort, page, perPage, q);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling TaxesApi#listF24");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
companyId	Integer	The ID of the company.
fields	String	List of comma-separated fields.	[optional]
fieldset	String	Name of the fieldset.	[optional] [enum: basic, detailed]
sort	String	List of comma-separated fields for result sorting (minus for desc sorting).	[optional]
page	Integer	The page to retrieve.	[optional] [default to 1]
perPage	Integer	The size of the page.	[optional] [default to 5]
q	String	Query for filtering the results.	[optional]

Return type

ListF24Response

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Results list.	-
401	Unauthorized	-

modifyF24

ModifyF24Response modifyF24(companyId, documentId, modifyF24Request)

Modify F24

Modifies the specified F24.

Example

// Import classes:
import it.fattureincloud.sdk.ApiClient;
import it.fattureincloud.sdk.ApiException;
import it.fattureincloud.sdk.Configuration;
import it.fattureincloud.sdk.auth.*;
import it.fattureincloud.sdk.models.*;
import it.fattureincloud.sdk.api.TaxesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api-v2.fattureincloud.it");
    
    // Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
    OAuth OAuth2AuthenticationCodeFlow = (OAuth) defaultClient.getAuthentication("OAuth2AuthenticationCodeFlow");
    OAuth2AuthenticationCodeFlow.setAccessToken("YOUR ACCESS TOKEN");

    TaxesApi apiInstance = new TaxesApi(defaultClient);
    Integer companyId = 12345; // Integer | The ID of the company.
    Integer documentId = 56; // Integer | The ID of the document.
    ModifyF24Request modifyF24Request = new ModifyF24Request(); // ModifyF24Request | The F24
    try {
      ModifyF24Response result = apiInstance.modifyF24(companyId, documentId, modifyF24Request);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling TaxesApi#modifyF24");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
companyId	Integer	The ID of the company.
documentId	Integer	The ID of the document.
modifyF24Request	ModifyF24Request	The F24	[optional]

Return type

ModifyF24Response

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The modified F24	-
401	Unauthorized	-
404	Not Found	-

uploadF24Attachment

UploadF24AttachmentResponse uploadF24Attachment(companyId, filename, attachment)

Upload F24 Attachment

Uploads an attachment destined to a F24. The actual association between the document and the attachment must be implemented separately, using the returned token.

Example

// Import classes:
import it.fattureincloud.sdk.ApiClient;
import it.fattureincloud.sdk.ApiException;
import it.fattureincloud.sdk.Configuration;
import it.fattureincloud.sdk.auth.*;
import it.fattureincloud.sdk.models.*;
import it.fattureincloud.sdk.api.TaxesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api-v2.fattureincloud.it");
    
    // Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
    OAuth OAuth2AuthenticationCodeFlow = (OAuth) defaultClient.getAuthentication("OAuth2AuthenticationCodeFlow");
    OAuth2AuthenticationCodeFlow.setAccessToken("YOUR ACCESS TOKEN");

    TaxesApi apiInstance = new TaxesApi(defaultClient);
    Integer companyId = 12345; // Integer | The ID of the company.
    String filename = "filename_example"; // String | Attachment file name
    File attachment = new File("/path/to/file"); // File | Attachment file [.png, .jpg, .gif, .pdf, .zip, .xls, .xlsx, .doc, .docx]
    try {
      UploadF24AttachmentResponse result = apiInstance.uploadF24Attachment(companyId, filename, attachment);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling TaxesApi#uploadF24Attachment");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
companyId	Integer	The ID of the company.
filename	String	Attachment file name	[optional]
attachment	File	Attachment file [.png, .jpg, .gif, .pdf, .zip, .xls, .xlsx, .doc, .docx]	[optional]

Return type

UploadF24AttachmentResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Attachment Token.	-

Files

TaxesApi.md

Latest commit

History

TaxesApi.md

File metadata and controls

TaxesApi

createF24

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteF24

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteF24Attachment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getF24

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

listF24

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

modifyF24

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

uploadF24Attachment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details