Skip to content

Latest commit

 

History

History
255 lines (191 loc) · 8.42 KB

InvoicesApi.md

File metadata and controls

255 lines (191 loc) · 8.42 KB

InvoicesApi

All URIs are relative to https://api.flipdish.co

Method HTTP request Description
getInvoices GET /api/v1.0/{appId}/invoices
invoicePdf GET /api/v1.0/{appId}/invoices/InvoicePdf
listInvoices GET /api/v1.0/{appId}/invoices/ListInvoices
listSubscriptionInvoices GET /api/v1.0/{appId}/invoices/ListSubscriptionInvoices

getInvoices

RestApiFinanceSearchPaginationResultSubscriptionInvoice getInvoices(appId, subscriptionId, limit, pageId, excludeNotOwnedInvoices, dateFrom, dateTo, invoiceNumber, storeId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.InvoicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

InvoicesApi apiInstance = new InvoicesApi();
String appId = "appId_example"; // String | 
String subscriptionId = "subscriptionId_example"; // String | 
Integer limit = 56; // Integer | 
String pageId = "pageId_example"; // String | 
Boolean excludeNotOwnedInvoices = true; // Boolean | 
OffsetDateTime dateFrom = OffsetDateTime.now(); // OffsetDateTime | 
OffsetDateTime dateTo = OffsetDateTime.now(); // OffsetDateTime | 
String invoiceNumber = "invoiceNumber_example"; // String | 
List<Integer> storeId = Arrays.asList(56); // List<Integer> | 
try {
    RestApiFinanceSearchPaginationResultSubscriptionInvoice result = apiInstance.getInvoices(appId, subscriptionId, limit, pageId, excludeNotOwnedInvoices, dateFrom, dateTo, invoiceNumber, storeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling InvoicesApi#getInvoices");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
subscriptionId String [optional]
limit Integer [optional]
pageId String [optional]
excludeNotOwnedInvoices Boolean [optional]
dateFrom OffsetDateTime [optional]
dateTo OffsetDateTime [optional]
invoiceNumber String [optional]
storeId List<Integer> [optional]

Return type

RestApiFinanceSearchPaginationResultSubscriptionInvoice

Authorization

oauth2

HTTP request headers

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

invoicePdf

invoicePdf(invoiceNumber, appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.InvoicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

InvoicesApi apiInstance = new InvoicesApi();
String invoiceNumber = "invoiceNumber_example"; // String | 
String appId = "appId_example"; // String | 
try {
    apiInstance.invoicePdf(invoiceNumber, appId);
} catch (ApiException e) {
    System.err.println("Exception when calling InvoicesApi#invoicePdf");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
invoiceNumber String
appId String

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

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

listInvoices

RestApiFinanceSearchPaginationResultInvoice listInvoices(storeId, appId, limit, page)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.InvoicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

InvoicesApi apiInstance = new InvoicesApi();
Integer storeId = 56; // Integer | 
String appId = "appId_example"; // String | 
Integer limit = 56; // Integer | 
Integer page = 56; // Integer | 
try {
    RestApiFinanceSearchPaginationResultInvoice result = apiInstance.listInvoices(storeId, appId, limit, page);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling InvoicesApi#listInvoices");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
storeId Integer
appId String
limit Integer [optional]
page Integer [optional]

Return type

RestApiFinanceSearchPaginationResultInvoice

Authorization

oauth2

HTTP request headers

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

listSubscriptionInvoices

RestApiFinanceSearchPaginationResultSubscriptionInvoice listSubscriptionInvoices(appId, subscriptionId, limit, pageId, excludeNotOwnedInvoices, dateFrom, dateTo, invoiceNumber, storeId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.InvoicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

InvoicesApi apiInstance = new InvoicesApi();
String appId = "appId_example"; // String | 
String subscriptionId = "subscriptionId_example"; // String | 
Integer limit = 56; // Integer | 
String pageId = "pageId_example"; // String | 
Boolean excludeNotOwnedInvoices = true; // Boolean | 
OffsetDateTime dateFrom = OffsetDateTime.now(); // OffsetDateTime | 
OffsetDateTime dateTo = OffsetDateTime.now(); // OffsetDateTime | 
String invoiceNumber = "invoiceNumber_example"; // String | 
List<Integer> storeId = Arrays.asList(56); // List<Integer> | 
try {
    RestApiFinanceSearchPaginationResultSubscriptionInvoice result = apiInstance.listSubscriptionInvoices(appId, subscriptionId, limit, pageId, excludeNotOwnedInvoices, dateFrom, dateTo, invoiceNumber, storeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling InvoicesApi#listSubscriptionInvoices");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
subscriptionId String [optional]
limit Integer [optional]
pageId String [optional]
excludeNotOwnedInvoices Boolean [optional]
dateFrom OffsetDateTime [optional]
dateTo OffsetDateTime [optional]
invoiceNumber String [optional]
storeId List<Integer> [optional]

Return type

RestApiFinanceSearchPaginationResultSubscriptionInvoice

Authorization

oauth2

HTTP request headers

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