Currency
/
Getting Currency

Fetch API (v3.0: 3.22.2.4)

REST API logo


For differences between versions, see Changelog.

Download OpenAPI description
api.json
api.yaml
Overview
API Support Group api@yellowdogsoftware.com
Languages
Servers
Mock server
https://developer.yellowdogsoftware.com/_mock/fetch/api/

Accounting

Accounting Export Reports that can be consumed by 3rd Party accounting systems

Operations

AttachedFiles

Items, Recipes, and Purchasing Documents are able to have files of record or images associated to them.

Operations

CountSheets

A dynamic list of Items that are designed to aide with physical inventories. Countsheets are based on a static list of items, Levels, and Flags

Operations

Currency

Operations used to manage currency conversion for the database. These are used when multiple currencies are used in a database.

Operations

Getting Currency

Request

Query
FilterArray of strings

Filter Options:

  • currencyCode
  • date
  • exchangeRate
  • lastUpdated
OrderByArray of strings

Order By Options:

  • currencyCode
  • date
  • lastUpdated
PageNumberinteger(int32)

Page Number for the result set.

This is expected to be an integer value greater than 0. Defaults to 1 when not passed in.

For more information see the Getting Started Section for Pagination.

PageSizeinteger(int32)

Page Size

  • Default page size: 100
  • Max page size: 500

This is expected to be an integer value greater than 0. Defaults to 100 when not passed in.

For more information see the Getting Started Section for Pagination.

curl -i -X GET \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/currency?Filter=string&OrderBy=string&PageNumber=0&PageSize=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idstring(uuid)
currencyCodestring or null
datestring(date-time)
exchangeRatenumber(double)
lastUpdatedstring(date-time)
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "currencyCode": "string",
    "date": "2019-08-24T14:15:22Z",
    "exchangeRate": 0.1,
    "lastUpdated": "2019-08-24T14:15:22Z"
  }
]

Creating new Currency Exchange Rate

Request

Body
Array [
currencyCodestring[ 0 .. 256 ] charactersrequired
datestring(date-time)required
exchangeRatenumber(double)required
]
curl -i -X POST \
  https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/currency \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    {
      "currencyCode": "string",
      "date": "2019-08-24T14:15:22Z",
      "exchangeRate": 0.1
    }
  ]'

Responses

OK

Response
application/json
{
  "message": "string",
  "errors": [
    { … }
  ]
}

Updating existing Currency Exchange Rate

Request

Body
Array [
idstring(uuid)required
currencyCodestring[ 0 .. 256 ] charactersrequired
datestring(date-time)required
exchangeRatenumber(double)required
]
curl -i -X PUT \
  https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/currency \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "currencyCode": "string",
      "date": "2019-08-24T14:15:22Z",
      "exchangeRate": 0.1
    }
  ]'

Responses

OK

Response
application/json
{
  "message": "string",
  "errors": [
    { … }
  ]
}

Bulk delete Currency Exchange Rates

Request

Body

List of Currency IDs to be deleted

Array [
string(uuid)
]
curl -i -X DELETE \
  https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/currency \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]'

Responses

OK

Response
No response example

Getting Effective Exchange Rate

Request

Path
currencyCodestringrequired
Query
datestring(date-time)
curl -i -X GET \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/currency/effectiveExchangeRate/{currencyCode}?date=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
number(double)
Response
application/json
0.1

Getting Currency by Id

Request

Path
idstring(uuid)required
curl -i -X GET \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/currency/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
idstring(uuid)
currencyCodestring or null
datestring(date-time)
exchangeRatenumber(double)
lastUpdatedstring(date-time)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "currencyCode": "string",
  "date": "2019-08-24T14:15:22Z",
  "exchangeRate": 0.1,
  "lastUpdated": "2019-08-24T14:15:22Z"
}

Deleting a Currency Exchange Rate

Request

Path
idstring(uuid)required
curl -i -X DELETE \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/currency/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Response
No response example

Dimensions

Attributes that are available for assigning to an Item. Attributes can be like a Size or Color.

Operations

Flags

Flags allow you to indicate storage locations, making ordering and physical inventories easier.

Operations

Inventory

Item Inventory OnHand information.

Operations

Invoices

A Purchasing document

Operations

ItemAliases

UPCs or additional SKUs to for an Item.

Operations

Items

Product information that is tracked in Yellow Dog Inventory.

Operations

ManualAdjusts

A Manual Adjustment will affect an Item's OnHand.

Operations

MetaInfo

Database specific configuration information

Operations

PurchaseOrders

A Purchasing document

Operations

Receipts

A Receiving document

Operations

Recipes

Collections of items and recipes, with quantities, that are used to create other items.

Operations

Requests

A requisition for purchasing or transfering an item.

Operations

Sessions

Associate a count to an Item, these sessions can be used for Purchasing Documents or Physical Inventories.

Operations

Stores

Business Entities or locations of a single business entity that need to maintain their own inventory records.

Operations

ThirdPartyCodes

Additional configuration options that control item, store or level behavior with third-party integrations

Operations

ThirdParty

Third Party Mappings with Yellow Dog Inventory

Operations

ThirdPartySessions

Records that increment or decrement inventory based on customer interactions with a store

Operations

Transactions

Records that increment or decrement inventory based on customer interactions with a store

Operations

Transfers

A record of movement of Items from one Store to another.

Operations

Vendors

Vendors, Suppliers, Distributors, or Manufacturors that provide Items into the Inventory.

Operations