Skip to content

StockReceiptsApi.md

Latest commit

 

History

History
622 lines (422 loc) · 21.8 KB

StockReceiptsApi.md

File metadata and controls

622 lines (422 loc) · 21.8 KB

KoronacloudApiV3.StockReceiptsApi

All URIs are relative to https://www.koronacloud.com/web/api/v3

Method HTTP request Description
addStockReceiptItems POST /accounts/{koronaAccountId}/stockReceipts/{stockReceiptIdOrNumber}/items adds stock-receipt items
addStockReceipts POST /accounts/{koronaAccountId}/stockReceipts adds stock-receipts
deleteStockReceiptItem DELETE /accounts/{koronaAccountId}/stockReceipts/{stockReceiptIdOrNumber}/items/{productIdOrNumber} deletes the single stock-receipt item
getStockReceipt GET /accounts/{koronaAccountId}/stockReceipts/{stockReceiptIdOrNumber} returns the single stock-receipt
getStockReceiptItem GET /accounts/{koronaAccountId}/stockReceipts/{stockReceiptIdOrNumber}/items/{productIdOrNumber} returns the single stock-receipt item
getStockReceiptItems GET /accounts/{koronaAccountId}/stockReceipts/{stockReceiptIdOrNumber}/items lists all stock-receipt items
getStockReceipts GET /accounts/{koronaAccountId}/stockReceipts lists all stock-receipts
updateStockReceipt PATCH /accounts/{koronaAccountId}/stockReceipts/{stockReceiptIdOrNumber} updates the single stock-receipt
updateStockReceiptItem PATCH /accounts/{koronaAccountId}/stockReceipts/{stockReceiptIdOrNumber}/items/{productIdOrNumber} updates the single stock-receipt item
updateStockReceiptItems PATCH /accounts/{koronaAccountId}/stockReceipts/{stockReceiptIdOrNumber}/items updates stock-receipt items

addStockReceiptItems

[AddOrUpdateResult] addStockReceiptItems(stockReceiptIdOrNumber, body, koronaAccountId)

adds stock-receipt items

Example

var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new KoronacloudApiV3.StockReceiptsApi();

var stockReceiptIdOrNumber = "stockReceiptIdOrNumber_example"; // String | id of the related object (important: id should match the uuid-format)

var body = [new KoronacloudApiV3.StockReceiptItem()]; // [StockReceiptItem] | data to add

var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.addStockReceiptItems(stockReceiptIdOrNumber, body, koronaAccountId, callback);

Parameters

Name Type Description Notes
stockReceiptIdOrNumber String id of the related object (important: id should match the uuid-format)
body [StockReceiptItem] data to add
koronaAccountId String account id of the korona.cloud account

Return type

[AddOrUpdateResult]

Authorization

basicAuth

HTTP request headers

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

addStockReceipts

[AddOrUpdateResult] addStockReceipts(body, koronaAccountId)

adds stock-receipts

Example

var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new KoronacloudApiV3.StockReceiptsApi();

var body = [new KoronacloudApiV3.StockReceipt()]; // [StockReceipt] | data to add

var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.addStockReceipts(body, koronaAccountId, callback);

Parameters

Name Type Description Notes
body [StockReceipt] data to add
koronaAccountId String account id of the korona.cloud account

Return type

[AddOrUpdateResult]

Authorization

basicAuth

HTTP request headers

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

deleteStockReceiptItem

deleteStockReceiptItem(stockReceiptIdOrNumber, productIdOrNumber, koronaAccountId)

deletes the single stock-receipt item

Example

var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new KoronacloudApiV3.StockReceiptsApi();

var stockReceiptIdOrNumber = "stockReceiptIdOrNumber_example"; // String | id of the related object (important: id should match the uuid-format)

var productIdOrNumber = "productIdOrNumber_example"; // String | id of the related object (important: id should match the uuid-format)

var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteStockReceiptItem(stockReceiptIdOrNumber, productIdOrNumber, koronaAccountId, callback);

Parameters

Name Type Description Notes
stockReceiptIdOrNumber String id of the related object (important: id should match the uuid-format)
productIdOrNumber String id of the related object (important: id should match the uuid-format)
koronaAccountId String account id of the korona.cloud account

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

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

getStockReceipt

StockReceipt getStockReceipt(stockReceiptIdOrNumber, koronaAccountId)

returns the single stock-receipt

Example

var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new KoronacloudApiV3.StockReceiptsApi();

var stockReceiptIdOrNumber = "stockReceiptIdOrNumber_example"; // String | id of the related object (important: id should match the uuid-format)

var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getStockReceipt(stockReceiptIdOrNumber, koronaAccountId, callback);

Parameters

Name Type Description Notes
stockReceiptIdOrNumber String id of the related object (important: id should match the uuid-format)
koronaAccountId String account id of the korona.cloud account

Return type

StockReceipt

Authorization

basicAuth

HTTP request headers

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

getStockReceiptItem

StockReceiptItem getStockReceiptItem(stockReceiptIdOrNumber, productIdOrNumber, koronaAccountId)

returns the single stock-receipt item

Example

var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new KoronacloudApiV3.StockReceiptsApi();

var stockReceiptIdOrNumber = "stockReceiptIdOrNumber_example"; // String | id of the related object (important: id should match the uuid-format)

var productIdOrNumber = "productIdOrNumber_example"; // String | id of the related object (important: id should match the uuid-format)

var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getStockReceiptItem(stockReceiptIdOrNumber, productIdOrNumber, koronaAccountId, callback);

Parameters

Name Type Description Notes
stockReceiptIdOrNumber String id of the related object (important: id should match the uuid-format)
productIdOrNumber String id of the related object (important: id should match the uuid-format)
koronaAccountId String account id of the korona.cloud account

Return type

StockReceiptItem

Authorization

basicAuth

HTTP request headers

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

getStockReceiptItems

ResultListStockReceiptItem getStockReceiptItems(stockReceiptIdOrNumber, koronaAccountId, opts)

lists all stock-receipt items

Example

var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new KoronacloudApiV3.StockReceiptsApi();

var stockReceiptIdOrNumber = "stockReceiptIdOrNumber_example"; // String | id of the related object (important: id should match the uuid-format)

var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account

var opts = { 
  'page': 56, // Number | number of the page to fetch
  'size': 56, // Number | amount of objects to return per page
  'sort': "sort_example", // String | attribute to sort by (multiple separated by comma; max. 5)
  'revision': 789 // Number | last revision number, objects with a greater revision than this will be returned
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getStockReceiptItems(stockReceiptIdOrNumber, koronaAccountId, opts, callback);

Parameters

Name Type Description Notes
stockReceiptIdOrNumber String id of the related object (important: id should match the uuid-format)
koronaAccountId String account id of the korona.cloud account
page Number number of the page to fetch [optional]
size Number amount of objects to return per page [optional]
sort String attribute to sort by (multiple separated by comma; max. 5) [optional]
revision Number last revision number, objects with a greater revision than this will be returned [optional]

Return type

ResultListStockReceiptItem

Authorization

basicAuth

HTTP request headers

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

getStockReceipts

ResultListStockReceipt getStockReceipts(koronaAccountId, opts)

lists all stock-receipts

Example

var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new KoronacloudApiV3.StockReceiptsApi();

var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account

var opts = { 
  'page': 56, // Number | number of the page to fetch
  'size': 56, // Number | amount of objects to return per page
  'sort': "sort_example", // String | attribute to sort by (multiple separated by comma; max. 5)
  'revision': 789, // Number | last revision number, objects with a greater revision than this will be returned
  'includeDeleted': true, // Boolean | indicates deleted objects should be loaded or not (default: false)
  'minCreateTime': new Date("2013-10-20T19:20:30+01:00"), // Date | min (inclusive) create time of the receipt (ISO 8601; date, time and timezone)
  'maxCreateTime': new Date("2013-10-20T19:20:30+01:00"), // Date | max (inclusive) create time of the receipt (ISO 8601; date, time and timezone)
  'minBookingTime': new Date("2013-10-20T19:20:30+01:00"), // Date | min (inclusive) booking time of the receipt (ISO 8601; date, time and timezone)
  'maxBookingTime': new Date("2013-10-20T19:20:30+01:00"), // Date | max (inclusive) booking time of the receipt (ISO 8601; date, time and timezone)
  'organizationalUnit': "organizationalUnit_example", // String | organizational unit
  'sourceOrganizationalUnit': "sourceOrganizationalUnit_example", // String | source organizational unit
  'bookingStatus': "bookingStatus_example" // String | booking status (possible values: BOOKED, IN_PROGRESS)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getStockReceipts(koronaAccountId, opts, callback);

Parameters

Name Type Description Notes
koronaAccountId String account id of the korona.cloud account
page Number number of the page to fetch [optional]
size Number amount of objects to return per page [optional]
sort String attribute to sort by (multiple separated by comma; max. 5) [optional]
revision Number last revision number, objects with a greater revision than this will be returned [optional]
includeDeleted Boolean indicates deleted objects should be loaded or not (default: false) [optional]
minCreateTime Date min (inclusive) create time of the receipt (ISO 8601; date, time and timezone) [optional]
maxCreateTime Date max (inclusive) create time of the receipt (ISO 8601; date, time and timezone) [optional]
minBookingTime Date min (inclusive) booking time of the receipt (ISO 8601; date, time and timezone) [optional]
maxBookingTime Date max (inclusive) booking time of the receipt (ISO 8601; date, time and timezone) [optional]
organizationalUnit String organizational unit [optional]
sourceOrganizationalUnit String source organizational unit [optional]
bookingStatus String booking status (possible values: BOOKED, IN_PROGRESS) [optional]

Return type

ResultListStockReceipt

Authorization

basicAuth

HTTP request headers

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

updateStockReceipt

updateStockReceipt(stockReceiptIdOrNumber, body, koronaAccountId)

updates the single stock-receipt

Example

var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new KoronacloudApiV3.StockReceiptsApi();

var stockReceiptIdOrNumber = "stockReceiptIdOrNumber_example"; // String | id of the related object (important: id should match the uuid-format)

var body = new KoronacloudApiV3.StockReceipt(); // StockReceipt | data to update

var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.updateStockReceipt(stockReceiptIdOrNumber, body, koronaAccountId, callback);

Parameters

Name Type Description Notes
stockReceiptIdOrNumber String id of the related object (important: id should match the uuid-format)
body StockReceipt data to update
koronaAccountId String account id of the korona.cloud account

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

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

updateStockReceiptItem

updateStockReceiptItem(stockReceiptIdOrNumber, productIdOrNumber, body, koronaAccountId)

updates the single stock-receipt item

Example

var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new KoronacloudApiV3.StockReceiptsApi();

var stockReceiptIdOrNumber = "stockReceiptIdOrNumber_example"; // String | id of the related object (important: id should match the uuid-format)

var productIdOrNumber = "productIdOrNumber_example"; // String | id of the related object (important: id should match the uuid-format)

var body = new KoronacloudApiV3.StockReceiptItem(); // StockReceiptItem | data to update

var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.updateStockReceiptItem(stockReceiptIdOrNumber, productIdOrNumber, body, koronaAccountId, callback);

Parameters

Name Type Description Notes
stockReceiptIdOrNumber String id of the related object (important: id should match the uuid-format)
productIdOrNumber String id of the related object (important: id should match the uuid-format)
body StockReceiptItem data to update
koronaAccountId String account id of the korona.cloud account

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

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

updateStockReceiptItems

[AddOrUpdateResult] updateStockReceiptItems(stockReceiptIdOrNumber, body, koronaAccountId)

updates stock-receipt items

Example

var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new KoronacloudApiV3.StockReceiptsApi();

var stockReceiptIdOrNumber = "stockReceiptIdOrNumber_example"; // String | id of the related object (important: id should match the uuid-format)

var body = [new KoronacloudApiV3.StockReceiptItem()]; // [StockReceiptItem] | data to update

var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updateStockReceiptItems(stockReceiptIdOrNumber, body, koronaAccountId, callback);

Parameters

Name Type Description Notes
stockReceiptIdOrNumber String id of the related object (important: id should match the uuid-format)
body [StockReceiptItem] data to update
koronaAccountId String account id of the korona.cloud account

Return type

[AddOrUpdateResult]

Authorization

basicAuth

HTTP request headers

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