Gets a listing of accounts and their code data

Fetch API (v3.0: 3.21.3.0)

Download OpenAPI description

api.json

api.yaml

Overview

API Support Group api@yellowdogsoftware.com

Servers

Mock server

https://developer.yellowdogsoftware.com/_mock/fetch/api/

Accounting

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

Operations

Gets a listing of Return to Vendors based on Store

Request

Path

storeIdstring(uuid)required

Id of the Yellow Dog Store that is being fetched. The Store ID can be found from the Get All Stores Endpoint as the id Property of the Store Model.

datestring(date-time)required

Date String in the local time of the Store

Example: 2020-05-24

curl -i -X GET \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/accounting/{storeId}/{date}/returnToVendors' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

idstring(uuid)

docNumberstring or null

datestring(date-time)

paidboolean

prepaidboolean

paymentDuestring or null(date-time)

billedstring or null(date-time)

committedstring(date-time)

createdstring(date-time)

lastUpdatedstring(date-time)

referencestring or null

descriptionstring or null

instructionsstring or null

notesstring or null

totalAmountnumber(double)

currencyCodestring or null

committedByUserobject(Api.Models.Dto.AccountingUser)

createdByUserobject(Api.Models.Dto.AccountingUser)

vendorobject(Api.Models.Dto.AccountingVendor)

storeobject(Api.Models.Dto.AccountingStore)

linesArray of objects or null(Api.Models.Dto.AccountingLine)

Response

application/json

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "docNumber": "string",
  "date": "2019-08-24T14:15:22Z",
  "paid": true,
  "prepaid": true,
  "paymentDue": "2019-08-24T14:15:22Z",
  "billed": "2019-08-24T14:15:22Z",
  "committed": "2019-08-24T14:15:22Z",
  "created": "2019-08-24T14:15:22Z",
  "lastUpdated": "2019-08-24T14:15:22Z",
  "reference": "string",
  "description": "string",
  "instructions": "string",
  "notes": "string",
  "totalAmount": 0.1,
  "currencyCode": "string",
  "committedByUser": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "employeeNumber": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string"
  },
  "createdByUser": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "employeeNumber": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string"
  },
  "vendor": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "code": "string",
    "description": "string",
    "accountingId": "string",
    "reference": "string"
  },
  "store": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "code": "string",
    "description": "string",
    "accountingId": "string"
  },
  "lines": [
    { … }
  ]
}

Gets a listing of invoices of a store on a given date

Request

Path

storeIdstring(uuid)required

Id of the Yellow Dog Store that is being fetched. The Store ID can be found from the Get All Stores Endpoint as the id Property of the Store Model.

datestring(date-time)required

Date String in the local time of the store (YYYY-MM-DD) is recommended

Example: 2020-05-24

Query

nonPrepaidOnlyboolean

set to only respond with non-prepaid invoices

Default false

includeReceiptsboolean

includeReceipts adds the variance between invoice total and receipt total, otherwise returns the invoice total in the debit field

Default false

curl -i -X GET \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/accounting/{storeId}/{date}/invoices?includeReceipts=false&nonPrepaidOnly=false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json

idstring(uuid)

docNumberstring or null

datestring(date-time)

paidboolean

prepaidboolean

paymentDuestring or null(date-time)

billedstring or null(date-time)

committedstring(date-time)

createdstring(date-time)

lastUpdatedstring(date-time)

referencestring or null

descriptionstring or null

instructionsstring or null

notesstring or null

totalAmountnumber(double)

currencyCodestring or null

committedByUserobject(Api.Models.Dto.AccountingUser)

createdByUserobject(Api.Models.Dto.AccountingUser)

vendorobject(Api.Models.Dto.AccountingVendor)

storeobject(Api.Models.Dto.AccountingStore)

linesArray of objects or null(Api.Models.Dto.AccountingLine)

Response

application/json

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "docNumber": "string",
  "date": "2019-08-24T14:15:22Z",
  "paid": true,
  "prepaid": true,
  "paymentDue": "2019-08-24T14:15:22Z",
  "billed": "2019-08-24T14:15:22Z",
  "committed": "2019-08-24T14:15:22Z",
  "created": "2019-08-24T14:15:22Z",
  "lastUpdated": "2019-08-24T14:15:22Z",
  "reference": "string",
  "description": "string",
  "instructions": "string",
  "notes": "string",
  "totalAmount": 0.1,
  "currencyCode": "string",
  "committedByUser": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "employeeNumber": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string"
  },
  "createdByUser": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "employeeNumber": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string"
  },
  "vendor": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "code": "string",
    "description": "string",
    "accountingId": "string",
    "reference": "string"
  },
  "store": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "code": "string",
    "description": "string",
    "accountingId": "string"
  },
  "lines": [
    { … }
  ]
}

Gets revenue of a store on a given date

Request

Gets revenue of a store on a given date, summarized by GL Account.

Path

storeIdstring(uuid)required

Id of the Yellow Dog Store that is being fetched. The Store ID can be found from the Get All Stores Endpoint as the id Property of the Store Model.

datestring(date-time)required

Date String in the local time of the store (YYYY-MM-DD) is recommended

Example: 2020-05-24

Query

typesArray of strings

Choose one or more of the following Journal Entry types (Sale, Tax, Tender)

curl -i -X GET \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/accounting/{storeId}/{date}/revenue?types=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json

datestring(date-time)

storeobject(Api.Models.Dto.AccountingStore)

linesArray of objects or null(Api.Models.Dto.AccountingLine)

Response

application/json

{
  "date": "2019-08-24T14:15:22Z",
  "store": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "code": "string",
    "description": "string",
    "accountingId": "string"
  },
  "lines": [
    { … }
  ]
}

Journal Entries for a store

Request

Gets a listing of journal entries of a store on a given date, summarized by GL Account.

Path

storeIdstring(uuid)required

Id of the Yellow Dog Store that is being fetched. The Store ID can be found from the Get All Stores Endpoint as the id Property of the Store Model.

datestring(date-time)required

Date String in the local time of the store (YYYY-MM-DD) is recommended

Example: 2020-05-24

Query

typesArray of strings

Choose one or more of the following Journal Entry types (PhysicalInventory, ManualAdjustment, CostOfGoodsSold, Transfer, Receipt, Restock)

curl -i -X GET \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/accounting/{storeId}/{date}/journalEntry?types=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json

datestring(date-time)

storeobject(Api.Models.Dto.AccountingStore)

linesArray of objects or null(Api.Models.Dto.AccountingLine)

Response

application/json

{
  "date": "2019-08-24T14:15:22Z",
  "store": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "code": "string",
    "description": "string",
    "accountingId": "string"
  },
  "lines": [
    { … }
  ]
}

Gets a listing of accounts and their code data

Request

Path

storeIdstring(uuid)required

Id of the Yellow Dog Store that is being fetched. The Store ID can be found from the Get All Stores Endpoint as the id Property of the Store Model.

codeTypestringrequired

Type of account (only use ManualAdjust as the codeType)

Example: ManualAdjust

curl -i -X GET \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/accounting/{storeId}/codes/{codeType}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json

idstring(uuid)

descriptionstring or null

typestring or null

placementinteger(int32)

storeobject(Api.Models.Dto.AccountingCodeStore)

Response

application/json

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "description": "string",
  "type": "string",
  "placement": 0,
  "store": {
    "accountGLCode": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "code": "string",
    "description": "string",
    "accountingId": "string"
  }
}

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

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.

ThirdPartyCodes

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

ThirdParty

Third Party Mappings with Yellow Dog Inventory

ThirdPartySessions

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

Transactions

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

Transfers

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

Vendors

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

Fetch API (v3.0: 3.21.3.0)

Accounting

Gets a listing of Return to Vendors based on Store

Request

Responses

Was this page helpful?

Gets a listing of invoices of a store on a given date

Request

Responses

Was this page helpful?

Gets revenue of a store on a given date

Request

Responses

Was this page helpful?

Journal Entries for a store

Request

Responses

Was this page helpful?

Gets a listing of accounts and their code data

Request

Responses

Was this page helpful?

AttachedFiles

CountSheets

Currency

Dimensions

Flags

Inventory

Invoices

ItemAliases

Items

ManualAdjusts

MetaInfo

PurchaseOrders

Receipts

Recipes

Requests

Sessions

Stores

ThirdPartyCodes

ThirdParty

ThirdPartySessions

Transactions

Transfers

Vendors