Skip to content

PayoutReportsApi.md

Latest commit

 

History

History
290 lines (201 loc) · 8.35 KB

PayoutReportsApi.md

File metadata and controls

290 lines (201 loc) · 8.35 KB
Raw

Flipdish.PayoutReportsApi

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

Method HTTP request Description
getPayoutReport3Details GET /api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/details
getPayoutReport3Overview GET /api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/overview
getPayoutReport3PropertyDetails GET /api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/properties
getPayoutReport3RefundedOrders GET /api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/refundedOrders
getPayoutReport3Stores GET /api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/stores

getPayoutReport3Details

RestApiResultPayoutReport3Details getPayoutReport3Details(appId, bankAccountId, payoutId, 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.PayoutReportsApi();
let appId = "appId_example"; // String | 
let bankAccountId = 56; // Number | 
let payoutId = 56; // Number | 
let opts = {
  'storeIds': [null] // [Number] | 
};
apiInstance.getPayoutReport3Details(appId, bankAccountId, payoutId, 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
bankAccountId Number
payoutId Number
storeIds [Number] [optional]

Return type

RestApiResultPayoutReport3Details

Authorization

oauth2

HTTP request headers

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

getPayoutReport3Overview

RestApiResultPayoutReport3Overview getPayoutReport3Overview(appId, bankAccountId, payoutId)

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.PayoutReportsApi();
let appId = "appId_example"; // String | 
let bankAccountId = 56; // Number | 
let payoutId = 56; // Number | 
apiInstance.getPayoutReport3Overview(appId, bankAccountId, payoutId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
bankAccountId Number
payoutId Number

Return type

RestApiResultPayoutReport3Overview

Authorization

oauth2

HTTP request headers

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

getPayoutReport3PropertyDetails

RestApiResultPayoutReport3PropertyDetails getPayoutReport3PropertyDetails(appId, bankAccountId, payoutId, 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.PayoutReportsApi();
let appId = "appId_example"; // String | 
let bankAccountId = 56; // Number | 
let payoutId = 56; // Number | 
let opts = {
  'propertyIds': ["null"], // [String] | 
  'storeIds': [null] // [Number] | 
};
apiInstance.getPayoutReport3PropertyDetails(appId, bankAccountId, payoutId, 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
bankAccountId Number
payoutId Number
propertyIds [String] [optional]
storeIds [Number] [optional]

Return type

RestApiResultPayoutReport3PropertyDetails

Authorization

oauth2

HTTP request headers

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

getPayoutReport3RefundedOrders

RestApiPaginationResultPayoutReport3RefundedOrder getPayoutReport3RefundedOrders(appId, bankAccountId, payoutId, 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.PayoutReportsApi();
let appId = "appId_example"; // String | 
let bankAccountId = 56; // Number | 
let payoutId = 56; // Number | 
let opts = {
  'storeIds': [null], // [Number] | 
  'page': 56, // Number | 
  'limit': 56 // Number | 
};
apiInstance.getPayoutReport3RefundedOrders(appId, bankAccountId, payoutId, 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
bankAccountId Number
payoutId Number
storeIds [Number] [optional]
page Number [optional]
limit Number [optional]

Return type

RestApiPaginationResultPayoutReport3RefundedOrder

Authorization

oauth2

HTTP request headers

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

getPayoutReport3Stores

RestApiResultPayoutReport3StorePayouts getPayoutReport3Stores(appId, bankAccountId, payoutId, 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.PayoutReportsApi();
let appId = "appId_example"; // String | 
let bankAccountId = 56; // Number | 
let payoutId = 56; // Number | 
let opts = {
  'stores': [null] // [Number] | 
};
apiInstance.getPayoutReport3Stores(appId, bankAccountId, payoutId, 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
bankAccountId Number
payoutId Number
stores [Number] [optional]

Return type

RestApiResultPayoutReport3StorePayouts

Authorization

oauth2

HTTP request headers

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