Skip to content
/
Create a Staged Invoice v...

Fetch API (v3.0: 3.27.0.1)

For differences between versions, see Changelog.

REST API logo

Download OpenAPI description
api.json
api.yaml
Overview
API Support Group
api@yellowdogsoftware.com
License
proprietary
Languages
Servers
Production server
https://fetch.yellowdogsoftware.com/api/v3

Accounting

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

Operations

AttachedFiles

Items and Recipes are able to have 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

Create a Staged Invoice via a file upload

Request

Security
Auth API User Token
Bodymultipart/form-data
filestring(binary)
curl -i -X POST \
  https://fetch.yellowdogsoftware.com/api/v3/invoices/ocr \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F file=string

Responses

OK

Bodyapplication/json
idstring(uuid)
creationKeystring or null
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "creationKey": "string"
}

Creates new staged invoice lines for a given staged invoice.

Request

Security
Auth API User Token
Path
stagedInvoiceIdstring(uuid)required

The ID of the staged invoice.

Body

The request body containing the staged invoice line data.

linesArray of objects or null(Api.Models.Dto.StagedInvoicePostLine)non-empty

Gets the list of invoice lines.

curl -i -X POST \
  'https://fetch.yellowdogsoftware.com/api/v3/invoices/staged/{stagedInvoiceId}/lines' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "lines": [
      {
        "lineType": "string",
        "lineNumber": 0,
        "lineIdentifier": "string",
        "vendorPNMatch": "string",
        "reference": "string",
        "description": "string",
        "quantity": 0,
        "sizeMatch": "string",
        "beanAccountMatch": "string",
        "vendorPrice": 0,
        "expenseAmount": 0,
        "upc": "string",
        "packSize": "string"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
idstring(uuid)
creationKeystring or null
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "creationKey": "string"
}

Find the original document for a staged invoice with the specified ID.

Request

Security
Auth API User Token
Path
stagedInvoiceIdstring(uuid)required
curl -i -X GET \
  'https://fetch.yellowdogsoftware.com/api/v3/invoices/staged/{stagedInvoiceId}/original-document' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
attachedLinkIDstring(uuid)
ownerIDstring(uuid)
urlstring or null
Response
application/json
{
  "attachedLinkID": "97dca3aa-e4ac-4486-a9f4-9ded7745e652",
  "ownerID": "4d1ec274-d781-4778-8ffc-812e9ab43c0c",
  "url": "string"
}

Updates a staged invoice with the specified ID.

Request

This endpoint requires the user to be authenticated and have the Api.Helpers.YdPolicyName.atLeast377 policy. The updated staged invoice is returned in the response body if the operation is successful. If the staged invoice was not modified, a 304 Not Modified status code is returned. If a validation error occurs, a 422 Unprocessable Entity status code is returned. If the database schema version is not version 377 or greater, a 403 Forbidden status code is returned.

Security
Auth API User Token
Path
stagedInvoiceIdstring(uuid)required

The ID of the staged invoice to update.

Body

The updated staged invoice data.

statusstring or null

Sets the status of the invoice. The status can be one of the following values:

  • Initialized
  • New
  • InProcess
  • ConvertedOpen – ConvertedCommitted
  • Removed
  • Unknown
  • Failed
storeMatchstring or null

Sets the store match of the invoice. (what will be used to match to match to a yellow dog store)

vendorMatchstring or null

Sets the vendor match of the invoice. (what will be used to match to match to a yellow dog vendor)

codestring or null

Sets the code (AKA, Invoice Number) of the invoice.

descriptionstring or null

Sets the description of the invoice.

referencestring or null

Sets the reference of the invoice.

instructionsstring or null

Sets the instructions of the invoice.

notesstring or null

Sets the notes of the invoice.

receivedAtstring or null(date-time)

Sets when the invoice was received.

invoicedAtstring or null(date-time)

Sets when the invoice was invoiced.

dueAtstring or null(date-time)

Sets when the invoice is due.

totalAmountnumber(double)

Sets the total amount of the invoice.

customerNumberstring or null<= 256 characters

sets the customer number from the invoice

currencyCodestring or null^[A-Z]{3}$

Sets the currency Code

purchaseOrderNumberstring or null

Sets the purchase order number

curl -i -X PUT \
  'https://fetch.yellowdogsoftware.com/api/v3/invoices/staged/{stagedInvoiceId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "status": "string",
    "storeMatch": "string",
    "vendorMatch": "string",
    "code": "string",
    "description": "string",
    "reference": "string",
    "instructions": "string",
    "notes": "string",
    "receivedAt": "2019-08-24T14:15:22Z",
    "invoicedAt": "2019-08-24T14:15:22Z",
    "dueAt": "2019-08-24T14:15:22Z",
    "totalAmount": 0.1,
    "customerNumber": "string",
    "currencyCode": "string",
    "purchaseOrderNumber": "string"
  }'

Responses

OK

Bodyapplication/json
idstring(uuid)
creationKeystring or null
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "creationKey": "string"
}

Updates a staged invoice with the specified ID.

Request

Security
Auth API User Token
Path
stagedInvoiceIdstring(uuid)required

The ID of the staged invoice to update.

Body

The updated staged invoice data.

statusstring or null

Sets the status of the invoice. The status can be one of the following values:

  • Initialized
  • New
  • InProcess
  • ConvertedOpen – ConvertedCommitted
  • Removed
  • Unknown
  • Failed
storeMatchstring or null

Sets the store match of the invoice. (what will be used to match to match to a yellow dog store)

vendorMatchstring or null

Sets the vendor match of the invoice. (what will be used to match to match to a yellow dog vendor)

codestring or null

Sets the code (AKA, Invoice Number) of the invoice.

descriptionstring or null

Sets the description of the invoice.

referencestring or null

Sets the reference of the invoice.

instructionsstring or null

Sets the instructions of the invoice.

notesstring or null

Sets the notes of the invoice.

receivedAtstring or null(date-time)

Sets when the invoice was received.

invoicedAtstring or null(date-time)

Sets when the invoice was invoiced.

dueAtstring or null(date-time)

Sets when the invoice is due.

totalAmountnumber(double)

Sets the total amount of the invoice.

customerNumberstring or null<= 256 characters

sets the customer number from the invoice

currencyCodestring or null^[A-Z]{3}$

Sets the currency Code

purchaseOrderNumberstring or null

Sets the purchase order number

curl -i -X PATCH \
  'https://fetch.yellowdogsoftware.com/api/v3/invoices/staged/{stagedInvoiceId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "status": "string",
    "storeMatch": "string",
    "vendorMatch": "string",
    "code": "string",
    "description": "string",
    "reference": "string",
    "instructions": "string",
    "notes": "string",
    "receivedAt": "2019-08-24T14:15:22Z",
    "invoicedAt": "2019-08-24T14:15:22Z",
    "dueAt": "2019-08-24T14:15:22Z",
    "totalAmount": 0.1,
    "customerNumber": "string",
    "currencyCode": "string",
    "purchaseOrderNumber": "string"
  }'

Responses

OK

Bodyapplication/json
idstring(uuid)
creationKeystring or null
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "creationKey": "string"
}

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

ProductionGroups

Collections of production groups.

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

RecipeTypes

Collections of RecipeTypes.

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