PurchaseOrderItemReceiving

This entity describes a transaction where a specified quantity of a purchaseOrderItem is 'received,' that is, debited from the Quantity value of the associated purchaseOrderItem and added to the quantityOnHand value of the associated inventoryItem entity.

NOTE  You can refer to the Online Help to find root and child access URLs of the entity you wish to query. Refer to Finding resource and child access URLs of REST API entities for more information.

Entity details

Entity Name: PurchaseOrderItemReceiving

Entity Path:

/atservicesrest/v1.0/PurchaseOrderItemReceiving
Parent Entity: PurchaseOrderItems
Can Create:
Can Update:  
Can Query:
Can Delete:  
Can Have UDFs:  

Conditions and requirements

  • In Autotask, Inventory Receive Items permission is required to create or update the receipt of a purchase order item.

  • A purchaseOrderReceive transaction can debit all or part of the purchaseOrderItem.Quanity value and tracks the quantity previously received and the quantity back ordered (quantityBackOrdered = purchaseOrderItem.Quantity - quantityPreviouslyReceived + quantityNowReceiving).

  • The inventoryItem must share the same inventoryLocationID and productID as the Purchase Order Item.

  • A vendor invoice number is required on Create if the Require Vendor Invoice Number on received purchase order items and when manually adding stocked items to inventory system setting is enabled.

  • When a purchase order has been received in full, you can still use the purchaseOrderItemReceive call.

  • If a purchase order is associated with a charge, and purchaseOrderItemRecieving is used to receive a value greater than the quantity on the charge, another purchaseOrderItem associated with the same location as the previous one will be generated with the correct count of left over items.

  • The Status of the orderID associated with the purchaseOrderItemID must = "Submitted" or "Received Partial."

NOTE  The Autotask Inventory module interface allows Quantity = 0; the API does not.

  • The sum of quantityNowReceiving + quantityPreviouslyReceived must be <= the Quantity for the associated Purchase Order Item (purchaseOrderItemID).
  • For unserialized products, quantityNowReceiving must be > 0.
  • For serialized products, the following requirements apply:
    • quantityNowReceiving must = 1.
    • serialNumber is required.
    • serialNumber must be unique.

Special field attributes

Field Conditions and Requirements
purchaseOrderItemID This value must be valid.
serialNumber When receiving products, the entity will clear the serialNumber field if the product is not serialized.

Field definitions

The following table describes the standard Autotask fields for this entity. Refer to the following articles for more information about working with these fields:

To learn how to query picklist endpoints, refer to Understanding picklists.

Notes

  • For string datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.
  • If this entity has child collections, they will appear in a Child collection access URLs or an Entity URLs and relationships drop-down in the Entity details section of this article.
  • You can call the /query/count/ endpoint of a resource to determine how many records a collection holds.
Field Name Datatype Read-Only Is Required Reference Name Picklist
id long    
purchaseOrderItemID long PurchaseOrderItems  
quantityBackOrdered integer      
quantityNowReceiving integer    
quantityPreviouslyReceived integer      
receiveDate datetime      
receivedByResourceID integer   Resources  
serialNumber string (50)      

Additional resources