All URIs are relative to https://api-v2.fattureincloud.it
| Method | HTTP request | Description |
|---|---|---|
| createIssuedDocument | POST /c/{company_id}/issued_documents | Create Issued Document |
| deleteBinIssuedDocument | DELETE /c/{company_id}/bin/issued_documents/{document_id} | Delete Bin Issued Document |
| deleteIssuedDocument | DELETE /c/{company_id}/issued_documents/{document_id} | Delete Issued Document |
| deleteIssuedDocumentAttachment | DELETE /c/{company_id}/issued_documents/{document_id}/attachment | Delete Issued Document Attachment |
| getBinIssuedDocument | GET /c/{company_id}/bin/issued_documents/{document_id} | Get Bin Issued Documents List |
| getEmailData | GET /c/{company_id}/issued_documents/{document_id}/email | Get Email Data |
| getExistingIssuedDocumentTotals | POST /c/{company_id}/issued_documents/{document_id}/totals | Get Existing Issued Document Totals |
| getIssuedDocument | GET /c/{company_id}/issued_documents/{document_id} | Get Issued Document |
| getIssuedDocumentPreCreateInfo | GET /c/{company_id}/issued_documents/info | Get Issued Document Pre-Create Info |
| getNewIssuedDocumentTotals | POST /c/{company_id}/issued_documents/totals | Get New Issued Document Totals |
| joinIssuedDocuments | GET /c/{company_id}/issued_documents/join | Join Issued Documents |
| listBinIssuedDocuments | GET /c/{company_id}/bin/issued_documents | Get Bin Issued Documents List |
| listIssuedDocuments | GET /c/{company_id}/issued_documents | List Issued Documents |
| modifyIssuedDocument | PUT /c/{company_id}/issued_documents/{document_id} | Modify Issued Document |
| recoverBinIssuedDocument | POST /c/{company_id}/bin/issued_documents/{document_id}/recover | Recover Issued Document From The Bin |
| scheduleEmail | POST /c/{company_id}/issued_documents/{document_id}/email | Schedule Email |
| transformIssuedDocument | GET /c/{company_id}/issued_documents/transform | Transform Issued Document |
| uploadIssuedDocumentAttachment | POST /c/{company_id}/issued_documents/attachment | Upload Issued Document Attachment |
CreateIssuedDocumentResponse createIssuedDocument(companyId, createIssuedDocumentRequest)
Create Issued Document
Creates a new document.
// 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.IssuedDocumentsApi;
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");
IssuedDocumentsApi apiInstance = new IssuedDocumentsApi(defaultClient);
Integer companyId = 12345; // Integer | The ID of the company.
CreateIssuedDocumentRequest createIssuedDocumentRequest = new CreateIssuedDocumentRequest(); // CreateIssuedDocumentRequest | The Issued Document
try {
CreateIssuedDocumentResponse result = apiInstance.createIssuedDocument(companyId, createIssuedDocumentRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IssuedDocumentsApi#createIssuedDocument");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| companyId | Integer | The ID of the company. | |
| createIssuedDocumentRequest | CreateIssuedDocumentRequest | The Issued Document | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Document created. | * RateLimit-HourlyRemaining - * RateLimit-HourlyLimit - * RateLimit-MonthlyRemaining - * RateLimit-MonthlyLimit - |
| 401 | Unauthorized | - |
| 403 | Forbidden - Rate limit exceeded | * Retry-After - |
| 429 | Too Many Requests | * Retry-After - |
deleteBinIssuedDocument(companyId, documentId)
Delete Bin Issued Document
Delete Bin Issued Document
// 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.IssuedDocumentsApi;
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");
IssuedDocumentsApi apiInstance = new IssuedDocumentsApi(defaultClient);
Integer companyId = 12345; // Integer | The ID of the company.
Integer documentId = 56; // Integer | The ID of the document.
try {
apiInstance.deleteBinIssuedDocument(companyId, documentId);
} catch (ApiException e) {
System.err.println("Exception when calling IssuedDocumentsApi#deleteBinIssuedDocument");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| companyId | Integer | The ID of the company. | |
| documentId | Integer | The ID of the document. |
null (empty response body)
- Content-Type: Not defined
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | * RateLimit-HourlyRemaining - * RateLimit-HourlyLimit - * RateLimit-MonthlyRemaining - * RateLimit-MonthlyLimit - |
| 403 | Forbidden - Rate limit exceeded | * Retry-After - |
| 429 | Too Many Requests | * Retry-After - |
deleteIssuedDocument(companyId, documentId)
Delete Issued Document
Deletes the specified document.
// 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.IssuedDocumentsApi;
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");
IssuedDocumentsApi apiInstance = new IssuedDocumentsApi(defaultClient);
Integer companyId = 12345; // Integer | The ID of the company.
Integer documentId = 56; // Integer | The ID of the document.
try {
apiInstance.deleteIssuedDocument(companyId, documentId);
} catch (ApiException e) {
System.err.println("Exception when calling IssuedDocumentsApi#deleteIssuedDocument");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| companyId | Integer | The ID of the company. | |
| documentId | Integer | The ID of the document. |
null (empty response body)
- Content-Type: Not defined
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 200 | Document removed | * RateLimit-HourlyRemaining - * RateLimit-HourlyLimit - * RateLimit-MonthlyRemaining - * RateLimit-MonthlyLimit - |
| 401 | Unauthorized | - |
| 403 | Forbidden - Rate limit exceeded | * Retry-After - |
| 404 | Not Found | - |
| 429 | Too Many Requests | * Retry-After - |
deleteIssuedDocumentAttachment(companyId, documentId)
Delete Issued Document Attachment
Removes the attachment of the specified document.
// 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.IssuedDocumentsApi;
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");
IssuedDocumentsApi apiInstance = new IssuedDocumentsApi(defaultClient);
Integer companyId = 12345; // Integer | The ID of the company.
Integer documentId = 56; // Integer | The ID of the document.
try {
apiInstance.deleteIssuedDocumentAttachment(companyId, documentId);
} catch (ApiException e) {
System.err.println("Exception when calling IssuedDocumentsApi#deleteIssuedDocumentAttachment");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| companyId | Integer | The ID of the company. | |
| documentId | Integer | The ID of the document. |
null (empty response body)
- Content-Type: Not defined
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 200 | File removed. | * RateLimit-HourlyRemaining - * RateLimit-HourlyLimit - * RateLimit-MonthlyRemaining - * RateLimit-MonthlyLimit - |
| 401 | Unauthorized | - |
| 403 | Forbidden - Rate limit exceeded | * Retry-After - |
| 404 | Not Found | - |
| 429 | Too Many Requests | * Retry-After - |
GetBinIssuedDocumentResponse getBinIssuedDocument(companyId, documentId)
Get Bin Issued Documents List
Get bin issued documents detail
// 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.IssuedDocumentsApi;
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");
IssuedDocumentsApi apiInstance = new IssuedDocumentsApi(defaultClient);
Integer companyId = 12345; // Integer | The ID of the company.
Integer documentId = 56; // Integer | The ID of the document.
try {
GetBinIssuedDocumentResponse result = apiInstance.getBinIssuedDocument(companyId, documentId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IssuedDocumentsApi#getBinIssuedDocument");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| companyId | Integer | The ID of the company. | |
| documentId | Integer | The ID of the document. |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Bin issued document details | * RateLimit-HourlyRemaining - * RateLimit-HourlyLimit - * RateLimit-MonthlyRemaining - * RateLimit-MonthlyLimit - |
| 403 | Forbidden - Rate limit exceeded | * Retry-After - |
| 429 | Too Many Requests | * Retry-After - |
GetEmailDataResponse getEmailData(companyId, documentId)
Get Email Data
Gets the pre-compiled email details.
// 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.IssuedDocumentsApi;
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");
IssuedDocumentsApi apiInstance = new IssuedDocumentsApi(defaultClient);
Integer companyId = 12345; // Integer | The ID of the company.
Integer documentId = 56; // Integer | The ID of the document.
try {
GetEmailDataResponse result = apiInstance.getEmailData(companyId, documentId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IssuedDocumentsApi#getEmailData");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| companyId | Integer | The ID of the company. | |
| documentId | Integer | The ID of the document. |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | EmailData | * RateLimit-HourlyRemaining - * RateLimit-HourlyLimit - * RateLimit-MonthlyRemaining - * RateLimit-MonthlyLimit - |
| 403 | Forbidden - Rate limit exceeded | * Retry-After - |
| 429 | Too Many Requests | * Retry-After - |
GetExistingIssuedDocumentTotalsResponse getExistingIssuedDocumentTotals(companyId, documentId, getExistingIssuedDocumentTotalsRequest)
Get Existing Issued Document Totals
Returns the totals for a specified document.
// 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.IssuedDocumentsApi;
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");
IssuedDocumentsApi apiInstance = new IssuedDocumentsApi(defaultClient);
Integer companyId = 12345; // Integer | The ID of the company.
Integer documentId = 56; // Integer | The ID of the document.
GetExistingIssuedDocumentTotalsRequest getExistingIssuedDocumentTotalsRequest = new GetExistingIssuedDocumentTotalsRequest(); // GetExistingIssuedDocumentTotalsRequest |
try {
GetExistingIssuedDocumentTotalsResponse result = apiInstance.getExistingIssuedDocumentTotals(companyId, documentId, getExistingIssuedDocumentTotalsRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IssuedDocumentsApi#getExistingIssuedDocumentTotals");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| companyId | Integer | The ID of the company. | |
| documentId | Integer | The ID of the document. | |
| getExistingIssuedDocumentTotalsRequest | GetExistingIssuedDocumentTotalsRequest | [optional] |
GetExistingIssuedDocumentTotalsResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Totals. | * RateLimit-HourlyRemaining - * RateLimit-HourlyLimit - * RateLimit-MonthlyRemaining - * RateLimit-MonthlyLimit - |
| 401 | Unauthorized | - |
| 403 | Forbidden - Rate limit exceeded | * Retry-After - |
| 404 | Not Found | - |
| 429 | Too Many Requests | * Retry-After - |
GetIssuedDocumentResponse getIssuedDocument(companyId, documentId, fields, fieldset)
Get Issued Document
Gets the specified document.
// 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.IssuedDocumentsApi;
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");
IssuedDocumentsApi apiInstance = new IssuedDocumentsApi(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 {
GetIssuedDocumentResponse result = apiInstance.getIssuedDocument(companyId, documentId, fields, fieldset);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IssuedDocumentsApi#getIssuedDocument");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| 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] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Document Details. | * RateLimit-HourlyRemaining - * RateLimit-HourlyLimit - * RateLimit-MonthlyRemaining - * RateLimit-MonthlyLimit - |
| 401 | Unauthorized | - |
| 403 | Forbidden - Rate limit exceeded | * Retry-After - |
| 404 | Not Found | - |
| 429 | Too Many Requests | * Retry-After - |
GetIssuedDocumentPreCreateInfoResponse getIssuedDocumentPreCreateInfo(companyId, type)
Get Issued Document Pre-Create Info
Retrieves the information useful while creating a new document.
// 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.IssuedDocumentsApi;
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");
IssuedDocumentsApi apiInstance = new IssuedDocumentsApi(defaultClient);
Integer companyId = 12345; // Integer | The ID of the company.
String type = "invoice"; // String | The type of the issued document.
try {
GetIssuedDocumentPreCreateInfoResponse result = apiInstance.getIssuedDocumentPreCreateInfo(companyId, type);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IssuedDocumentsApi#getIssuedDocumentPreCreateInfo");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| companyId | Integer | The ID of the company. | |
| type | String | The type of the issued document. | [enum: invoice, quote, proforma, receipt, delivery_note, credit_note, order, work_report, supplier_order, self_own_invoice, self_supplier_invoice] |
GetIssuedDocumentPreCreateInfoResponse
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Pre-create info. | * RateLimit-HourlyRemaining - * RateLimit-HourlyLimit - * RateLimit-MonthlyRemaining - * RateLimit-MonthlyLimit - |
| 403 | Forbidden - Rate limit exceeded | * Retry-After - |
| 429 | Too Many Requests | * Retry-After - |
GetNewIssuedDocumentTotalsResponse getNewIssuedDocumentTotals(companyId, getNewIssuedDocumentTotalsRequest)
Get New Issued Document Totals
Returns the totals for a new document.
// 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.IssuedDocumentsApi;
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");
IssuedDocumentsApi apiInstance = new IssuedDocumentsApi(defaultClient);
Integer companyId = 12345; // Integer | The ID of the company.
GetNewIssuedDocumentTotalsRequest getNewIssuedDocumentTotalsRequest = new GetNewIssuedDocumentTotalsRequest(); // GetNewIssuedDocumentTotalsRequest |
try {
GetNewIssuedDocumentTotalsResponse result = apiInstance.getNewIssuedDocumentTotals(companyId, getNewIssuedDocumentTotalsRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IssuedDocumentsApi#getNewIssuedDocumentTotals");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| companyId | Integer | The ID of the company. | |
| getNewIssuedDocumentTotalsRequest | GetNewIssuedDocumentTotalsRequest | [optional] |
GetNewIssuedDocumentTotalsResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Totals. | * RateLimit-HourlyRemaining - * RateLimit-HourlyLimit - * RateLimit-MonthlyRemaining - * RateLimit-MonthlyLimit - |
| 401 | Unauthorized | - |
| 403 | Forbidden - Rate limit exceeded | * Retry-After - |
| 429 | Too Many Requests | * Retry-After - |
JoinIssuedDocumentsResponse joinIssuedDocuments(companyId, ids, group, type)
Join Issued Documents
Joins issued documents.
// 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.IssuedDocumentsApi;
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");
IssuedDocumentsApi apiInstance = new IssuedDocumentsApi(defaultClient);
Integer companyId = 12345; // Integer | The ID of the company.
String ids = "1,2,3,4"; // String | Ids of the documents.
Integer group = 0; // Integer | Group items.
String type = "delivery_notes"; // String | Type of the documents to be joined
try {
JoinIssuedDocumentsResponse result = apiInstance.joinIssuedDocuments(companyId, ids, group, type);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IssuedDocumentsApi#joinIssuedDocuments");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| companyId | Integer | The ID of the company. | |
| ids | String | Ids of the documents. | |
| group | Integer | Group items. | [optional] [enum: 0, 1] |
| type | String | Type of the documents to be joined | [optional] [enum: delivery_notes, orders, quotes, work_reports] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Example response | * RateLimit-HourlyRemaining - * RateLimit-HourlyLimit - * RateLimit-MonthlyRemaining - * RateLimit-MonthlyLimit - |
| 403 | Forbidden - Rate limit exceeded | * Retry-After - |
| 429 | Too Many Requests | * Retry-After - |
ListBinIssuedDocuments listBinIssuedDocuments(companyId)
Get Bin Issued Documents List
Get bin issued documents list
// 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.IssuedDocumentsApi;
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");
IssuedDocumentsApi apiInstance = new IssuedDocumentsApi(defaultClient);
Integer companyId = 12345; // Integer | The ID of the company.
try {
ListBinIssuedDocuments result = apiInstance.listBinIssuedDocuments(companyId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IssuedDocumentsApi#listBinIssuedDocuments");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| companyId | Integer | The ID of the company. |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Bin Issued Documents List | * RateLimit-HourlyRemaining - * RateLimit-HourlyLimit - * RateLimit-MonthlyRemaining - * RateLimit-MonthlyLimit - |
| 403 | Forbidden - Rate limit exceeded | * Retry-After - |
| 429 | Too Many Requests | * Retry-After - |
ListIssuedDocumentsResponse listIssuedDocuments(companyId, type, fields, fieldset, sort, page, perPage, q, inclusive)
List Issued Documents
Lists the issued documents.
// 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.IssuedDocumentsApi;
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");
IssuedDocumentsApi apiInstance = new IssuedDocumentsApi(defaultClient);
Integer companyId = 12345; // Integer | The ID of the company.
String type = "invoice"; // String | The type of the issued document.
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.
Integer inclusive = 0; // Integer | (Only for type = delivery_notes) Include invoices delivery notes.
try {
ListIssuedDocumentsResponse result = apiInstance.listIssuedDocuments(companyId, type, fields, fieldset, sort, page, perPage, q, inclusive);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IssuedDocumentsApi#listIssuedDocuments");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| companyId | Integer | The ID of the company. | |
| type | String | The type of the issued document. | [enum: invoice, quote, proforma, receipt, delivery_note, credit_note, order, work_report, supplier_order, self_own_invoice, self_supplier_invoice] |
| 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] |
| inclusive | Integer | (Only for type = delivery_notes) Include invoices delivery notes. | [optional] [enum: 0, 1] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Results list. | * RateLimit-HourlyRemaining - * RateLimit-HourlyLimit - * RateLimit-MonthlyRemaining - * RateLimit-MonthlyLimit - |
| 401 | Unauthorized | - |
| 403 | Forbidden - Rate limit exceeded | * Retry-After - |
| 404 | Not Found | - |
| 429 | Too Many Requests | * Retry-After - |
ModifyIssuedDocumentResponse modifyIssuedDocument(companyId, documentId, modifyIssuedDocumentRequest)
Modify Issued Document
Modifies the specified document.
// 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.IssuedDocumentsApi;
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");
IssuedDocumentsApi apiInstance = new IssuedDocumentsApi(defaultClient);
Integer companyId = 12345; // Integer | The ID of the company.
Integer documentId = 56; // Integer | The ID of the document.
ModifyIssuedDocumentRequest modifyIssuedDocumentRequest = new ModifyIssuedDocumentRequest(); // ModifyIssuedDocumentRequest | The modified document
try {
ModifyIssuedDocumentResponse result = apiInstance.modifyIssuedDocument(companyId, documentId, modifyIssuedDocumentRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IssuedDocumentsApi#modifyIssuedDocument");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| companyId | Integer | The ID of the company. | |
| documentId | Integer | The ID of the document. | |
| modifyIssuedDocumentRequest | ModifyIssuedDocumentRequest | The modified document | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Document edited | * RateLimit-HourlyRemaining - * RateLimit-HourlyLimit - * RateLimit-MonthlyRemaining - * RateLimit-MonthlyLimit - |
| 401 | Unauthorized | - |
| 403 | Forbidden - Rate limit exceeded | * Retry-After - |
| 404 | Not Found | - |
| 429 | Too Many Requests | * Retry-After - |
recoverBinIssuedDocument(companyId, documentId)
Recover Issued Document From The Bin
Recover Issued Document From The Bin
// 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.IssuedDocumentsApi;
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");
IssuedDocumentsApi apiInstance = new IssuedDocumentsApi(defaultClient);
Integer companyId = 12345; // Integer | The ID of the company.
Integer documentId = 56; // Integer | The ID of the document.
try {
apiInstance.recoverBinIssuedDocument(companyId, documentId);
} catch (ApiException e) {
System.err.println("Exception when calling IssuedDocumentsApi#recoverBinIssuedDocument");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| companyId | Integer | The ID of the company. | |
| documentId | Integer | The ID of the document. |
null (empty response body)
- Content-Type: Not defined
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | * RateLimit-HourlyRemaining - * RateLimit-HourlyLimit - * RateLimit-MonthlyRemaining - * RateLimit-MonthlyLimit - |
| 403 | Forbidden - Rate limit exceeded | * Retry-After - |
| 429 | Too Many Requests | * Retry-After - |
scheduleEmail(companyId, documentId, scheduleEmailRequest)
Schedule Email
Schedules the sending of a document by email.
// 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.IssuedDocumentsApi;
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");
IssuedDocumentsApi apiInstance = new IssuedDocumentsApi(defaultClient);
Integer companyId = 12345; // Integer | The ID of the company.
Integer documentId = 56; // Integer | The ID of the document.
ScheduleEmailRequest scheduleEmailRequest = new ScheduleEmailRequest(); // ScheduleEmailRequest | Email Schedule
try {
apiInstance.scheduleEmail(companyId, documentId, scheduleEmailRequest);
} catch (ApiException e) {
System.err.println("Exception when calling IssuedDocumentsApi#scheduleEmail");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| companyId | Integer | The ID of the company. | |
| documentId | Integer | The ID of the document. | |
| scheduleEmailRequest | ScheduleEmailRequest | Email Schedule | [optional] |
null (empty response body)
- Content-Type: application/json
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | * RateLimit-HourlyRemaining - * RateLimit-HourlyLimit - * RateLimit-MonthlyRemaining - * RateLimit-MonthlyLimit - |
| 401 | Unauthorized | - |
| 403 | Forbidden - Rate limit exceeded | * Retry-After - |
| 404 | Not Found | - |
| 429 | Too Many Requests | * Retry-After - |
TransformIssuedDocumentResponse transformIssuedDocument(companyId, originalDocumentId, newType, type, eInvoice, transformKeepCopy)
Transform Issued Document
Transforms the document.
// 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.IssuedDocumentsApi;
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");
IssuedDocumentsApi apiInstance = new IssuedDocumentsApi(defaultClient);
Integer companyId = 12345; // Integer | The ID of the company.
Integer originalDocumentId = 56; // Integer | Original document id.
String newType = "newType_example"; // String | New document type.
String type = "type_example"; // String | Current document type.
Integer eInvoice = 0; // Integer | New document e_invoice.
Integer transformKeepCopy = 0; // Integer | Keep the old document.
try {
TransformIssuedDocumentResponse result = apiInstance.transformIssuedDocument(companyId, originalDocumentId, newType, type, eInvoice, transformKeepCopy);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IssuedDocumentsApi#transformIssuedDocument");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| companyId | Integer | The ID of the company. | |
| originalDocumentId | Integer | Original document id. | |
| newType | String | New document type. | |
| type | String | Current document type. | [optional] |
| eInvoice | Integer | New document e_invoice. | [optional] [enum: 0, 1] |
| transformKeepCopy | Integer | Keep the old document. | [optional] [enum: 0, 1] |
TransformIssuedDocumentResponse
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Example response | * RateLimit-HourlyRemaining - * RateLimit-HourlyLimit - * RateLimit-MonthlyRemaining - * RateLimit-MonthlyLimit - |
| 403 | Forbidden - Rate limit exceeded | * Retry-After - |
| 429 | Too Many Requests | * Retry-After - |
UploadIssuedDocumentAttachmentResponse uploadIssuedDocumentAttachment(companyId, filename, attachment)
Upload Issued Document Attachment
Uploads an attachment destined to an issued document. The actual association between the document and the attachment must be implemented separately, using the returned token.
// 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.IssuedDocumentsApi;
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");
IssuedDocumentsApi apiInstance = new IssuedDocumentsApi(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 {
UploadIssuedDocumentAttachmentResponse result = apiInstance.uploadIssuedDocumentAttachment(companyId, filename, attachment);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IssuedDocumentsApi#uploadIssuedDocumentAttachment");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| 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] |
UploadIssuedDocumentAttachmentResponse
- Content-Type: multipart/form-data
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Attachment Token. | * RateLimit-HourlyRemaining - * RateLimit-HourlyLimit - * RateLimit-MonthlyRemaining - * RateLimit-MonthlyLimit - |
| 401 | Unauthorized | - |
| 403 | Forbidden - Rate limit exceeded | * Retry-After - |
| 429 | Too Many Requests | * Retry-After - |