# Updates an existing Transfer

Endpoint: PATCH /transfers/{id}
Version: v3.0: 3.26.2.2
Security: Auth API User Token

## Path parameters:

  - `id` (string, required)
    CommDoc Id of Transfer

## Request fields (application/json-patch+json):

  - `commit` (boolean)

  - `reference` (string,null)

  - `description` (string,null)

  - `instructions` (string,null)

  - `notes` (string,null)

  - `due` (string,null)

## Response 200 fields (text/plain):

  - `id` (string)
    Yellow Dog's unique ID of the Commdoc; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

  - `thirdPartyID` (string,null)

  - `docNumber` (string,null)
    The document number of the Transfer.

  - `reference` (string,null)
    Reference is used to store a secondary code for the Transfer such the supplier's document number.

  - `description` (string,null)
    This is an arbitrary description of the Transfer.

  - `instructions` (string,null)
    Instructions can be printed on the document printout.

  - `commit` (boolean)
    Indicates whether the Transfer is committed or not.

  - `committed` (string,null)
    DateTime when the Transfer was issued in Yellow Dog, in ISO 8601 format.

  - `committed2` (string,null)
    DateTime when the Transfer was accepted in Yellow Dog, in ISO 8601 format.

  - `notes` (string,null)
    Note is used to store other information about the Transfer.

  - `needBy` (string)
    DateTime when the Transfer is needed by, in ISO 8601 format

  - `expectedArrival` (string,null)
    DateTime when the arrival of the transfer is expected, in ISO 8601 format

  - `created` (string)
    DateTime when the Transfer was created in Yellow Dog, in ISO 8601 format

  - `lastUpdated` (string)
    DateTime when the Transfer was last updated in Yellow Dog, in ISO 8601 format

  - `store` (string,null)
    Unique ID of the Yellow Dog Store; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)
The store that issued the Transfer.

  - `store2` (string,null)
    Unique ID of the Yellow Dog Store; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)
The store that accepted the Transfer.

  - `createdByUser` (string,null)
    Unique ID of the user who created the Transfer

  - `committedByUser` (string,null)
    Unique ID of the user who issued the Transfer

  - `committed2ByUser` (string,null)
    Unique ID of the user who accepted the Transfer

  - `totalAmountIssued` (number)
    Total Amount Issued
TotalAmountShortage can be calculated by subtracting TotalAmountAccepted from TotalAmountIssued.

  - `totalAmountAccepted` (number)
    Total Amount Accepted
TotalAmountShortage can be calculated by subtracting TotalAmountAccepted from TotalAmountIssued.

  - `status` (string,null)
    Status of the Transfer.

  - `lines` (array,null)
    List of Commdoc Lines which belongs to the Transfer.

  - `lines.commdocLineID` (string)
    Yellow Dog's unique ID of the CommdocLine; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

  - `lines.storeID` (string)
    Yellow Dog's unique ID of the Store; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

  - `lines.commdocID` (string)
    Yellow Dog's unique ID of the Transfer; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9) 
In DB, Commodc is the group of Transfer, Recipe, and PurchaseOrder.

  - `lines.thirdPartyLineID` (string,null)
    Reference field used by third party integrators or storing a unique CommdocLineID.

  - `lines.lineNumber` (integer)
    Line number of the CommdocLine.

  - `lines.vendorPrice` (number,null)
    Vendor Price of the Commdoc Line Item.

  - `lines.quantityIssued` (number,null)
    Quantity Issued
Quantity shortage can be calculated by subtracting QuantityAccepted from QuantityIssued.

  - `lines.quantityAccepted` (number,null)
    Quantity Accepted
Quantity shortage can be calculated by subtracting QuantityAccepted from QuantityIssued.

  - `lines.notes` (string,null)
    Notes are used to store other information about the Transfer.

  - `lines.backLinkID` (string,null)
    Unique ID of the back-linked Purchasing document.

  - `lines.backLinkType` (string,null)
    Type of Purchasing document that the BackLinkId References

  - `lines.backLinkDocNumber` (string,null)
    Document Number of the back linked Purchase Order for the CommdocLine.

  - `lines.backLinkLineID` (string,null)
    Unique ID of the back linked CommdocLine for the CommdocLine.

  - `lines.backLinkLineNumber` (string,null)
    Line number of the back linked Purchase Order for the CommdocLine.

  - `lines.itemID` (string)
    Yellow Dog's unique ID of the Item; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

  - `lines.item` (object)

  - `lines.item.id` (string,null)

  - `lines.item.sku` (string,null)

  - `lines.item.description` (string,null)

  - `lines.item.parLevel` (number)

  - `lines.item.reorderPoint` (number)

  - `lines.item.retail` (number)

  - `lines.item.onHand` (number)

  - `lines.item.levels` (array,null)

  - `lines.item.levels.code` (string,null)

  - `lines.item.levels.position` (integer)

  - `lines.item.dimensions` (array,null)

  - `lines.item.dimensions.id` (string)
    DimensionID is the unique identifier for the Dimension; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

  - `lines.item.dimensions.type` (string,null)
    Determines which Dimension type is being used. There are up to 10 user-defined "Types" available.

  - `lines.item.dimensions.description` (string,null)
    Description of the Dimension

  - `lines.item.vendorSKU` (string,null)

  - `due` (string,null)
    DateTime when the Transfer is needed by, in ISO 8601 format

  - `vendor` (string,null)
    Unique ID of the Yellow Dog Store; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

## Response 400 fields (text/plain):

  - `message` (string,null)

  - `errors` (array,null)

  - `errors.extensions` (string,null)

## Response 500 fields (text/plain):

  - `message` (string,null)

  - `errors` (array,null)

  - `errors.extensions` (string,null)


## Response 403 fields

## Response 429 fields