Skip to content

PayoutReportsApi.md

Latest commit

 

History

History
692 lines (528 loc) · 22.3 KB

PayoutReportsApi.md

File metadata and controls

692 lines (528 loc) · 22.3 KB
Raw

Flipdish.Api.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
PayoutReport3ExportPayoutChargebacks GET /api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/export/chargebacks
PayoutReport3ExportPayoutOrders GET /api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/export/orders
PayoutReport3ExportPayoutPosSales GET /api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/export/possales
PayoutReport3ExportPayoutRefundedOrders GET /api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/export/refundedOrders
PayoutReport3ExportPayoutStores GET /api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/export/stores

GetPayoutReport3Details

RestApiResultPayoutReport3Details GetPayoutReport3Details (string appId, int? bankAccountId, int? payoutId, List<int?> storeIds = null)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetPayoutReport3DetailsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PayoutReportsApi();
            var appId = appId_example;  // string | 
            var bankAccountId = 56;  // int? | 
            var payoutId = 56;  // int? | 
            var storeIds = new List<int?>(); // List<int?> |  (optional) 

            try
            {
                RestApiResultPayoutReport3Details result = apiInstance.GetPayoutReport3Details(appId, bankAccountId, payoutId, storeIds);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PayoutReportsApi.GetPayoutReport3Details: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
bankAccountId int?
payoutId int?
storeIds List<int?> [optional]

Return type

RestApiResultPayoutReport3Details

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPayoutReport3Overview

RestApiResultPayoutReport3Overview GetPayoutReport3Overview (string appId, int? bankAccountId, int? payoutId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetPayoutReport3OverviewExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PayoutReportsApi();
            var appId = appId_example;  // string | 
            var bankAccountId = 56;  // int? | 
            var payoutId = 56;  // int? | 

            try
            {
                RestApiResultPayoutReport3Overview result = apiInstance.GetPayoutReport3Overview(appId, bankAccountId, payoutId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PayoutReportsApi.GetPayoutReport3Overview: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
bankAccountId int?
payoutId int?

Return type

RestApiResultPayoutReport3Overview

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPayoutReport3PropertyDetails

RestApiResultPayoutReport3PropertyDetails GetPayoutReport3PropertyDetails (string appId, int? bankAccountId, int? payoutId, List propertyIds = null, List<int?> storeIds = null)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetPayoutReport3PropertyDetailsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PayoutReportsApi();
            var appId = appId_example;  // string | 
            var bankAccountId = 56;  // int? | 
            var payoutId = 56;  // int? | 
            var propertyIds = new List<string>(); // List<string> |  (optional) 
            var storeIds = new List<int?>(); // List<int?> |  (optional) 

            try
            {
                RestApiResultPayoutReport3PropertyDetails result = apiInstance.GetPayoutReport3PropertyDetails(appId, bankAccountId, payoutId, propertyIds, storeIds);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PayoutReportsApi.GetPayoutReport3PropertyDetails: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
bankAccountId int?
payoutId int?
propertyIds List<string> [optional]
storeIds List<int?> [optional]

Return type

RestApiResultPayoutReport3PropertyDetails

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPayoutReport3RefundedOrders

RestApiPaginationResultPayoutReport3RefundedOrder GetPayoutReport3RefundedOrders (string appId, int? bankAccountId, int? payoutId, List<int?> storeIds = null, int? page = null, int? limit = null)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetPayoutReport3RefundedOrdersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PayoutReportsApi();
            var appId = appId_example;  // string | 
            var bankAccountId = 56;  // int? | 
            var payoutId = 56;  // int? | 
            var storeIds = new List<int?>(); // List<int?> |  (optional) 
            var page = 56;  // int? |  (optional) 
            var limit = 56;  // int? |  (optional) 

            try
            {
                RestApiPaginationResultPayoutReport3RefundedOrder result = apiInstance.GetPayoutReport3RefundedOrders(appId, bankAccountId, payoutId, storeIds, page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PayoutReportsApi.GetPayoutReport3RefundedOrders: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
bankAccountId int?
payoutId int?
storeIds List<int?> [optional]
page int? [optional]
limit int? [optional]

Return type

RestApiPaginationResultPayoutReport3RefundedOrder

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPayoutReport3Stores

RestApiResultPayoutReport3StorePayouts GetPayoutReport3Stores (string appId, int? bankAccountId, int? payoutId, List<int?> stores = null)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetPayoutReport3StoresExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PayoutReportsApi();
            var appId = appId_example;  // string | 
            var bankAccountId = 56;  // int? | 
            var payoutId = 56;  // int? | 
            var stores = new List<int?>(); // List<int?> |  (optional) 

            try
            {
                RestApiResultPayoutReport3StorePayouts result = apiInstance.GetPayoutReport3Stores(appId, bankAccountId, payoutId, stores);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PayoutReportsApi.GetPayoutReport3Stores: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
bankAccountId int?
payoutId int?
stores List<int?> [optional]

Return type

RestApiResultPayoutReport3StorePayouts

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PayoutReport3ExportPayoutChargebacks

RestApiResultFileCreationResult PayoutReport3ExportPayoutChargebacks (string appId, int? bankAccountId, int? payoutId, List<int?> stores = null)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class PayoutReport3ExportPayoutChargebacksExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PayoutReportsApi();
            var appId = appId_example;  // string | 
            var bankAccountId = 56;  // int? | 
            var payoutId = 56;  // int? | 
            var stores = new List<int?>(); // List<int?> |  (optional) 

            try
            {
                RestApiResultFileCreationResult result = apiInstance.PayoutReport3ExportPayoutChargebacks(appId, bankAccountId, payoutId, stores);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PayoutReportsApi.PayoutReport3ExportPayoutChargebacks: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
bankAccountId int?
payoutId int?
stores List<int?> [optional]

Return type

RestApiResultFileCreationResult

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PayoutReport3ExportPayoutOrders

RestApiResultFileCreationResult PayoutReport3ExportPayoutOrders (string appId, int? bankAccountId, int? payoutId, List<int?> stores = null)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class PayoutReport3ExportPayoutOrdersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PayoutReportsApi();
            var appId = appId_example;  // string | 
            var bankAccountId = 56;  // int? | 
            var payoutId = 56;  // int? | 
            var stores = new List<int?>(); // List<int?> |  (optional) 

            try
            {
                RestApiResultFileCreationResult result = apiInstance.PayoutReport3ExportPayoutOrders(appId, bankAccountId, payoutId, stores);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PayoutReportsApi.PayoutReport3ExportPayoutOrders: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
bankAccountId int?
payoutId int?
stores List<int?> [optional]

Return type

RestApiResultFileCreationResult

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PayoutReport3ExportPayoutPosSales

RestApiResultFileCreationResult PayoutReport3ExportPayoutPosSales (string appId, int? bankAccountId, int? payoutId, List<int?> stores = null)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class PayoutReport3ExportPayoutPosSalesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PayoutReportsApi();
            var appId = appId_example;  // string | 
            var bankAccountId = 56;  // int? | 
            var payoutId = 56;  // int? | 
            var stores = new List<int?>(); // List<int?> |  (optional) 

            try
            {
                RestApiResultFileCreationResult result = apiInstance.PayoutReport3ExportPayoutPosSales(appId, bankAccountId, payoutId, stores);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PayoutReportsApi.PayoutReport3ExportPayoutPosSales: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
bankAccountId int?
payoutId int?
stores List<int?> [optional]

Return type

RestApiResultFileCreationResult

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PayoutReport3ExportPayoutRefundedOrders

RestApiResultFileCreationResult PayoutReport3ExportPayoutRefundedOrders (string appId, int? bankAccountId, int? payoutId, List<int?> stores = null)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class PayoutReport3ExportPayoutRefundedOrdersExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PayoutReportsApi();
            var appId = appId_example;  // string | 
            var bankAccountId = 56;  // int? | 
            var payoutId = 56;  // int? | 
            var stores = new List<int?>(); // List<int?> |  (optional) 

            try
            {
                RestApiResultFileCreationResult result = apiInstance.PayoutReport3ExportPayoutRefundedOrders(appId, bankAccountId, payoutId, stores);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PayoutReportsApi.PayoutReport3ExportPayoutRefundedOrders: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
bankAccountId int?
payoutId int?
stores List<int?> [optional]

Return type

RestApiResultFileCreationResult

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PayoutReport3ExportPayoutStores

RestApiResultFileCreationResult PayoutReport3ExportPayoutStores (string appId, int? bankAccountId, int? payoutId, List<int?> stores = null)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class PayoutReport3ExportPayoutStoresExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PayoutReportsApi();
            var appId = appId_example;  // string | 
            var bankAccountId = 56;  // int? | 
            var payoutId = 56;  // int? | 
            var stores = new List<int?>(); // List<int?> |  (optional) 

            try
            {
                RestApiResultFileCreationResult result = apiInstance.PayoutReport3ExportPayoutStores(appId, bankAccountId, payoutId, stores);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PayoutReportsApi.PayoutReport3ExportPayoutStores: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
bankAccountId int?
payoutId int?
stores List<int?> [optional]

Return type

RestApiResultFileCreationResult

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]