Receiving Receipt Line Item

List line items for a receipt on a purchase or sales order

Changed on
post/api/receiving/receipts/{receiptId}/line-items/list

Request

  • Base URL
    https://api.fulcrumpro.com
  • URL
    https://api.fulcrumpro.com/api/receiving/receipts/{receiptId}/line-items/list
  • Auth
    none declared

Path parameters

receiptIdstring required

Response

Line items for the given receipt

idstring required

Unique id associated to this entity.

lineItemIdstring required

Id of the purchase order line item corresponding to this update

fullyReceivedboolean required

Indicates whether the entire quantity of this line item have been received

rolledBackboolean required

Indicates whether this update is active.

quantityReceivednumber double nullable

Quantity of the associated item that has been received on this update in the specified unit of measure (non-cumulative)

unitOfMeasureMultipliernumber double

If the receipt has a different unit of measure than the item is stored in fulcrum, you would use this multiplier with the QuantityReceived to get the amount you received into Fulcrum.

convertedQuantityReceivednumber double

Quantity of the associated item that has been received in Fulcrum's unit of measure

externalReferencesobject nullable

Arbitrary key-value-pair like data that can be used to later on search for this line item.

unitPricenumber double nullable

Price of the purchase order line received against, per Fulcrum's unit of measure, so it multiplies directly with convertedQuantityReceived. Null means there is no price, not a price of zero. Supplied only by the receipts list endpoint.

lineItemType'part' | 'outsideProcessing' | 'tax' | 'discount' | 'fee' | 'vendorCredit'

Purchase order line item type

itemIdstring nullable

Id of the item on the purchase order line received against: the part for a part line, the item being processed for an outside processing line. Null on a fee line, on an outside processing line with no item, on a sales order receipt and on a line that no longer resolves. Supplied only by the receipts list endpoint.

unitCostnumber double nullable

Cost per unit in Fulcrum's unit of measure, in the primary currency, excluding tax and landed cost: the billed unit price when a billed subtotal is entered, otherwise the line's price after its own discount, at the PO's exchange rate. Together with unitTax and landedCost, the tax and landed cost Fulcrum applies when it revalues a receipt, the line is valued at convertedQuantityReceived × (unitCost + unitTax) + landedCost, or convertedQuantityReceived × unitCost + landedCost excluding tax. On an outside processing line this is the value job cost uses. On a part line the inventory transaction can differ: a receipt entered after the bill is valued at the purchase order price, a bill changed after the inventory adjustment cutoff does not revalue older receipts, on a discounted line with no billed subtotal inventory holds the price before the discount, and on a line that is not taxable but has an overridden tax rate receiving adds that tax until the receipt is revalued. Rolled-back lines are populated as well; skip them. Null on a fee line, on a sales order receipt and on a line that no longer resolves. Supplied only by the receipts list endpoint.

unitTaxnumber double nullable

Tax per unit in Fulcrum's unit of measure, in the primary currency, that Fulcrum applies to this line when it revalues a receipt; zero when the line is not taxed. See unitCost for how the three values combine. Null where unitCost is null. Supplied only by the receipts list endpoint.

landedCostnumber double nullable

Total landed cost allocated to this receipt line (not per unit), in the primary currency; zero when none is allocated. Null where unitCost is null. Supplied only by the receipts list endpoint.

Changes

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: application/problem+json)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: application/problem+json)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: application/problem+json)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: application/problem+json)