Skip to content

InvoicesApi.md

Latest commit

 

History

History
246 lines (174 loc) · 6.8 KB

InvoicesApi.md

File metadata and controls

246 lines (174 loc) · 6.8 KB
Raw

Flipdish.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, opts)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.InvoicesApi();
let appId = "appId_example"; // String | 
let opts = {
  'subscriptionId': "subscriptionId_example", // String | 
  'limit': 56, // Number | 
  'pageId': "pageId_example", // String | 
  'excludeNotOwnedInvoices': true, // Boolean | 
  'dateFrom': new Date("2013-10-20T19:20:30+01:00"), // Date | 
  'dateTo': new Date("2013-10-20T19:20:30+01:00"), // Date | 
  'invoiceNumber': "invoiceNumber_example", // String | 
  'storeId': [null] // [Number] | 
};
apiInstance.getInvoices(appId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
subscriptionId String [optional]
limit Number [optional]
pageId String [optional]
excludeNotOwnedInvoices Boolean [optional]
dateFrom Date [optional]
dateTo Date [optional]
invoiceNumber String [optional]
storeId [Number] [optional]

Return type

RestApiFinanceSearchPaginationResultSubscriptionInvoice

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, Data, Message, ErrorCode, StackTrace

invoicePdf

invoicePdf(invoiceNumber, appId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.InvoicesApi();
let invoiceNumber = "invoiceNumber_example"; // String | 
let appId = "appId_example"; // String | 
apiInstance.invoicePdf(invoiceNumber, appId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

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, opts)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.InvoicesApi();
let storeId = 56; // Number | 
let appId = "appId_example"; // String | 
let opts = {
  'limit': 56, // Number | 
  'page': 56 // Number | 
};
apiInstance.listInvoices(storeId, appId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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

Return type

RestApiFinanceSearchPaginationResultInvoice

Authorization

oauth2

HTTP request headers

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

listSubscriptionInvoices

RestApiFinanceSearchPaginationResultSubscriptionInvoice listSubscriptionInvoices(appId, opts)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.InvoicesApi();
let appId = "appId_example"; // String | 
let opts = {
  'subscriptionId': "subscriptionId_example", // String | 
  'limit': 56, // Number | 
  'pageId': "pageId_example", // String | 
  'excludeNotOwnedInvoices': true, // Boolean | 
  'dateFrom': new Date("2013-10-20T19:20:30+01:00"), // Date | 
  'dateTo': new Date("2013-10-20T19:20:30+01:00"), // Date | 
  'invoiceNumber': "invoiceNumber_example", // String | 
  'storeId': [null] // [Number] | 
};
apiInstance.listSubscriptionInvoices(appId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
subscriptionId String [optional]
limit Number [optional]
pageId String [optional]
excludeNotOwnedInvoices Boolean [optional]
dateFrom Date [optional]
dateTo Date [optional]
invoiceNumber String [optional]
storeId [Number] [optional]

Return type

RestApiFinanceSearchPaginationResultSubscriptionInvoice

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, Data, Message, ErrorCode, StackTrace