Skip to content

SuppliersApi.md

Latest commit

 

History

History
423 lines (329 loc) · 16.4 KB

SuppliersApi.md

File metadata and controls

423 lines (329 loc) · 16.4 KB

SuppliersApi

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

Method HTTP request Description
createSupplier POST /c/{company_id}/entities/suppliers Create Supplier
deleteSupplier DELETE /c/{company_id}/entities/suppliers/{supplier_id} Delete Supplier
getSupplier GET /c/{company_id}/entities/suppliers/{supplier_id} Get Supplier
listSuppliers GET /c/{company_id}/entities/suppliers List Suppliers
modifySupplier PUT /c/{company_id}/entities/suppliers/{supplier_id} Modify Supplier

createSupplier

CreateSupplierResponse createSupplier(companyId, createSupplierRequest)

Create Supplier

Creates a new supplier.

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.SuppliersApi;

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");

    SuppliersApi apiInstance = new SuppliersApi(defaultClient);
    Integer companyId = 12345; // Integer | The ID of the company.
    CreateSupplierRequest createSupplierRequest = new CreateSupplierRequest(); // CreateSupplierRequest | The supplier to create
    try {
      CreateSupplierResponse result = apiInstance.createSupplier(companyId, createSupplierRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SuppliersApi#createSupplier");
      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.
createSupplierRequest CreateSupplierRequest The supplier to create [optional]

Return type

CreateSupplierResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Example response * RateLimit-HourlyRemaining -
* RateLimit-HourlyLimit -
* RateLimit-MonthlyRemaining -
* RateLimit-MonthlyLimit -
400 ErrorResponse * Retry-After -
401 ErrorResponse * Retry-After -
403 ErrorResponse * Retry-After -
404 ErrorResponse * Retry-After -
405 ErrorResponse * Retry-After -
409 ErrorResponse * Retry-After -
422 ErrorResponse * Retry-After -
429 ErrorResponse * Retry-After -
500 ErrorResponse * Retry-After -

deleteSupplier

deleteSupplier(companyId, supplierId)

Delete Supplier

Deletes the specified supplier.

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.SuppliersApi;

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");

    SuppliersApi apiInstance = new SuppliersApi(defaultClient);
    Integer companyId = 12345; // Integer | The ID of the company.
    Integer supplierId = 56; // Integer | The ID of the supplier.
    try {
      apiInstance.deleteSupplier(companyId, supplierId);
    } catch (ApiException e) {
      System.err.println("Exception when calling SuppliersApi#deleteSupplier");
      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.
supplierId Integer The ID of the supplier.

Return type

null (empty response body)

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Entity Removed * RateLimit-HourlyRemaining -
* RateLimit-HourlyLimit -
* RateLimit-MonthlyRemaining -
* RateLimit-MonthlyLimit -
400 ErrorResponse * Retry-After -
401 ErrorResponse * Retry-After -
403 ErrorResponse * Retry-After -
404 ErrorResponse * Retry-After -
405 ErrorResponse * Retry-After -
409 ErrorResponse * Retry-After -
422 ErrorResponse * Retry-After -
429 ErrorResponse * Retry-After -
500 ErrorResponse * Retry-After -

getSupplier

GetSupplierResponse getSupplier(companyId, supplierId, fields, fieldset)

Get Supplier

Gets the specified supplier.

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.SuppliersApi;

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");

    SuppliersApi apiInstance = new SuppliersApi(defaultClient);
    Integer companyId = 12345; // Integer | The ID of the company.
    Integer supplierId = 56; // Integer | The ID of the supplier.
    String fields = "fields_example"; // String | List of comma-separated fields.
    String fieldset = "basic"; // String | Name of the fieldset.
    try {
      GetSupplierResponse result = apiInstance.getSupplier(companyId, supplierId, fields, fieldset);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SuppliersApi#getSupplier");
      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.
supplierId Integer The ID of the supplier.
fields String List of comma-separated fields. [optional]
fieldset String Name of the fieldset. [optional] [enum: basic, detailed, fic_view]

Return type

GetSupplierResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Example response * RateLimit-HourlyRemaining -
* RateLimit-HourlyLimit -
* RateLimit-MonthlyRemaining -
* RateLimit-MonthlyLimit -
400 ErrorResponse * Retry-After -
401 ErrorResponse * Retry-After -
403 ErrorResponse * Retry-After -
404 ErrorResponse * Retry-After -
405 ErrorResponse * Retry-After -
409 ErrorResponse * Retry-After -
422 ErrorResponse * Retry-After -
429 ErrorResponse * Retry-After -
500 ErrorResponse * Retry-After -

listSuppliers

ListSuppliersResponse listSuppliers(companyId, fields, fieldset, sort, page, perPage, q)

List Suppliers

Lists the suppliers.

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.SuppliersApi;

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");

    SuppliersApi apiInstance = new SuppliersApi(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 {
      ListSuppliersResponse result = apiInstance.listSuppliers(companyId, fields, fieldset, sort, page, perPage, q);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SuppliersApi#listSuppliers");
      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, fic_view]
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

ListSuppliersResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Example response * RateLimit-HourlyRemaining -
* RateLimit-HourlyLimit -
* RateLimit-MonthlyRemaining -
* RateLimit-MonthlyLimit -
400 ErrorResponse * Retry-After -
401 ErrorResponse * Retry-After -
403 ErrorResponse * Retry-After -
404 ErrorResponse * Retry-After -
405 ErrorResponse * Retry-After -
409 ErrorResponse * Retry-After -
422 ErrorResponse * Retry-After -
429 ErrorResponse * Retry-After -
500 ErrorResponse * Retry-After -

modifySupplier

ModifySupplierResponse modifySupplier(companyId, supplierId, modifySupplierRequest)

Modify Supplier

Modifies the specified supplier.

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.SuppliersApi;

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");

    SuppliersApi apiInstance = new SuppliersApi(defaultClient);
    Integer companyId = 12345; // Integer | The ID of the company.
    Integer supplierId = 56; // Integer | The ID of the supplier.
    ModifySupplierRequest modifySupplierRequest = new ModifySupplierRequest(); // ModifySupplierRequest | The modified Supplier. First level parameters are managed in delta mode.
    try {
      ModifySupplierResponse result = apiInstance.modifySupplier(companyId, supplierId, modifySupplierRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SuppliersApi#modifySupplier");
      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.
supplierId Integer The ID of the supplier.
modifySupplierRequest ModifySupplierRequest The modified Supplier. First level parameters are managed in delta mode. [optional]

Return type

ModifySupplierResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Example response * RateLimit-HourlyRemaining -
* RateLimit-HourlyLimit -
* RateLimit-MonthlyRemaining -
* RateLimit-MonthlyLimit -
400 ErrorResponse * Retry-After -
401 ErrorResponse * Retry-After -
403 ErrorResponse * Retry-After -
404 ErrorResponse * Retry-After -
405 ErrorResponse * Retry-After -
409 ErrorResponse * Retry-After -
422 ErrorResponse * Retry-After -
429 ErrorResponse * Retry-After -
500 ErrorResponse * Retry-After -