PO receipts

What was received against a purchase order.

The object#

FieldTypeDescription
idread-onlyintegerNolaPro id.
recsourceintegerWhere the receipt came from: 0 = received without a PO (direct item receipt), 1 = received against a purchase order.
invpoidintegerInvpoid. Id only.
receivedatestringDate the goods were received.
itemidintegerReference to items, by id. Write either this or item.
itemstring(255)The sku of the referenced items, instead of the id. Send this or itemid, not both unless they agree.
vendoridintegerReference to vendors, by id. Write either this or vendor.
vendorstring(30)Code for the referenced vendor, instead of the id.
locationidintegerInventory location to receive into.
locationstring(20)The locationcode of the referenced inventorylocations, instead of the id. Send this or locationid, not both unless they agree.
itemqtyqtystring(6dp)Quantity, 6 decimal places, as a string. Stored as decimal(6dp).
itempricemoneystring(6dp)Stored as decimal(19,6).
itemqtyusedqtystring(6dp)Quantity, 6 decimal places, as a string. Stored as decimal(6dp).
itemqtydamagedqtystring(6dp)Quantity, 6 decimal places, as a string. Stored as decimal(6dp).
conversionnumberstring(6dp)Numeric string, 6 decimal places. Not money - do not apply currency rounding.
trackstring(30)Carrier tracking number on the receipt.
receiveunitnameidintegerReference to unitnames, by id. Write either this or receiveunitname.
receiveunitnamestring(50)The unitname of the referenced unitnames, instead of the id. Send this or receiveunitnameid, not both unless they agree.
passtoapinteger1 once the receipt is passed to AP for billing.
apbillidintegerApbillid. Id only.
cancelbooleanCancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydatestringWhen the record was created.
lastchangedateread-onlystringLast modification. Drives modifiedsince.
invpodetailidintegerInvpodetailid. Id only.
statusintegerReceipt status; 0 = open.
initialsstring(255)Initials of the person who received the goods.
recnotestextRecnotes. Stored as text, no practical length limit.
itempriceqtyqtystring(6dp)Quantity, 6 decimal places, as a string. Stored as decimal(6dp).
jobidintegerJobid. Id only.
costcodeidintegerCost code.
costcodestring(20)Code for the referenced costcode, instead of the id.
glcategoryidintegerGlcategoryid. Id only.
glcategorystring(20)The code of the referenced glcategories, instead of the id. Send this or glcategoryid, not both unless they agree.
currencystring(10)Currency the received cost is stated in.
curratenumberstring(10dp)Numeric string, 10 decimal places. Not money - do not apply currency rounding.
voucheridintegerVoucherid. Id only.
voucherstring(50)The voucher of the referenced gltransactions, instead of the id. Send this or voucherid, not both unless they agree.
invreceivemainidintegerInvreceivemainid. Id only.
accruedvoucheridintegerAccruedvoucherid. Id only.
accruedvoucherstring(50)The voucher of the referenced gltransactions, instead of the id. Send this or accruedvoucherid, not both unless they agree.
invpodetailinvglacctintegerInventory GL account copied from the PO line being received.
invpodetaillinetypeintegerLine type copied from the PO line being received; 0 = standard product line.
externalidstring(100)Your own key. Scoped to your company.

Endpoints#

POST/invreceives/batch 207409422422a422b422c400a400b

Create many.

Requires scope purchaseorders:write.

Parameters
NameInTypeNotes
Idempotency-KeyheaderstringMakes the write safely retryable. Any unique string per logical operation; a UUID is fine. The failure this prevents is specific: the request succeeds, the response is lost to a timeout, you retry, and the customer is billed twice. With a key, the retry returns the original response - same status, same body, same id - and creates nothing. The body is part of the key's identity. Reusing a key with a different body is a bug on your side, not a retry, and answers 409 idempotency_replay rather than silently handing back the old response. Keys are remembered for 24 hours.
Body array
FieldTypeDescription
idread-onlyintegerNolaPro id.
recsourceintegerWhere the receipt came from: 0 = received without a PO (direct item receipt), 1 = received against a purchase order.
invpoidintegerInvpoid. Id only.
receivedatestringDate the goods were received.
itemidintegerReference to items, by id. Write either this or item.
itemstring(255)The sku of the referenced items, instead of the id. Send this or itemid, not both unless they agree.
vendoridintegerReference to vendors, by id. Write either this or vendor.
vendorstring(30)Code for the referenced vendor, instead of the id.
locationidintegerInventory location to receive into.
locationstring(20)The locationcode of the referenced inventorylocations, instead of the id. Send this or locationid, not both unless they agree.
itemqtyqtystring(6dp)Quantity, 6 decimal places, as a string. Stored as decimal(6dp).
itempricemoneystring(6dp)Stored as decimal(19,6).
itemqtyusedqtystring(6dp)Quantity, 6 decimal places, as a string. Stored as decimal(6dp).
itemqtydamagedqtystring(6dp)Quantity, 6 decimal places, as a string. Stored as decimal(6dp).
conversionnumberstring(6dp)Numeric string, 6 decimal places. Not money - do not apply currency rounding.
trackstring(30)Carrier tracking number on the receipt.
receiveunitnameidintegerReference to unitnames, by id. Write either this or receiveunitname.
receiveunitnamestring(50)The unitname of the referenced unitnames, instead of the id. Send this or receiveunitnameid, not both unless they agree.
passtoapinteger1 once the receipt is passed to AP for billing.
apbillidintegerApbillid. Id only.
cancelbooleanCancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydatestringWhen the record was created.
lastchangedateread-onlystringLast modification. Drives modifiedsince.
invpodetailidintegerInvpodetailid. Id only.
statusintegerReceipt status; 0 = open.
initialsstring(255)Initials of the person who received the goods.
recnotestextRecnotes. Stored as text, no practical length limit.
itempriceqtyqtystring(6dp)Quantity, 6 decimal places, as a string. Stored as decimal(6dp).
jobidintegerJobid. Id only.
costcodeidintegerCost code.
costcodestring(20)Code for the referenced costcode, instead of the id.
glcategoryidintegerGlcategoryid. Id only.
glcategorystring(20)The code of the referenced glcategories, instead of the id. Send this or glcategoryid, not both unless they agree.
currencystring(10)Currency the received cost is stated in.
curratenumberstring(10dp)Numeric string, 10 decimal places. Not money - do not apply currency rounding.
voucheridintegerVoucherid. Id only.
voucherstring(50)The voucher of the referenced gltransactions, instead of the id. Send this or voucherid, not both unless they agree.
invreceivemainidintegerInvreceivemainid. Id only.
accruedvoucheridintegerAccruedvoucherid. Id only.
accruedvoucherstring(50)The voucher of the referenced gltransactions, instead of the id. Send this or accruedvoucherid, not both unless they agree.
invpodetailinvglacctintegerInventory GL account copied from the PO line being received.
invpodetaillinetypeintegerLine type copied from the PO line being received; 0 = standard product line.
externalidstring(100)Your own key. Scoped to your company.
When it fails
StatusCodeMeaning
409po_completeThe purchase order is already complete.
422unknown_valueNo such purchase order or line in this company.
422aover_receiptMore than the outstanding quantity.
422breceipt_refusedNolaPro refused the receipt.
422cnot_supported_hereA field this endpoint cannot record was sent.
400ainvalid_typeA quantity was sent as a JSON number.
400binvalid_precisionMore decimal places than a quantity holds.
curl -X POST \
  'https://acme.nolapro.com/!/api/v2/invreceives/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "recsource": 1,
        "invpoid": 104,
        "receivedate": "2026-08-01T14:22:05Z",
        "itemid": 104,
        "item": "Example item",
        "vendorid": 104
    }
]'
GET/invreceives 200403

List po receipts.

Requires scope purchaseorders:read.

Parameters
NameInTypeNotes
statusquerystringRestrict to one status.
vendoridquerystringRestrict to one vendorid.
itemidquerystringRestrict to one itemid.
locationidquerystringRestrict to one locationid.
jobidquerystringRestrict to one jobid.
invpoidquerystringRestrict to one invpoid.
cancelquerystringDefaults to false. Pass true or any.
modifiedsincequerystringRFC 3339 UTC timestamp. Returns only records changed since then, including cancelled ones - so cancel defaults to any rather than false when this is used. The response carries _meta.synced_through; store it and send it back next time.
externalidquerystringExact match on your own key.
includequerystringComma-separated extras to embed. Only custom_fields is available: the extra fields this install has defined on the record. Off by default, and an unrecognised value is refused rather than ignored. See Conventions.
When it fails
StatusCodeMeaning
403insufficient_scopeToken lacks read scope.
curl \
  'https://acme.nolapro.com/!/api/v2/invreceives' \
  -H 'Authorization: Bearer $NP_TOKEN'
POST/invreceives 201400400a400b409422422a422b422c

Receive against a purchase order.

Receiving moves stock, revalues the item and, on installs that post GL at receipt, writes a voucher. It runs through NolaPro's own Invpo_model::receive(), so a receipt made here is the same receipt the application makes. Quantities only. Damaged quantities, asset creation, serial and lot capture and prepaid handling are not available here - the model behind this endpoint does not implement them. Those fields are REFUSED rather than ignored, so nothing is ever recorded differently from what you sent. Use the Receiving screen for a receipt that needs them. voucherid is null on an install that does not post GL at receipt, which is a company setting, not an error.

Requires scope purchaseorders:write.

Parameters
NameInTypeNotes
Idempotency-KeyheaderstringMakes the write safely retryable. Any unique string per logical operation; a UUID is fine. The failure this prevents is specific: the request succeeds, the response is lost to a timeout, you retry, and the customer is billed twice. With a key, the retry returns the original response - same status, same body, same id - and creates nothing. The body is part of the key's identity. Reusing a key with a different body is a bug on your side, not a retry, and answers 409 idempotency_replay rather than silently handing back the old response. Keys are remembered for 24 hours.
Body
FieldTypeDescription
invpoidrequiredintegerThe purchase order being received against. It must not already be marked complete.
completebooleanMark the purchase order complete afterwards. Never inferred from the quantities: a short shipment that happens to be the last one would otherwise close the PO for good.
linesrequiredarray of objectOne entry per PO line. A line may appear only once; send the total quantity for it.
When it fails
StatusCodeMeaning
400invalid_requestMissing or malformed field.
400ainvalid_typeA quantity was sent as a JSON number.
400binvalid_precisionMore decimal places than a quantity holds.
409po_completeThe purchase order is already complete.
422unknown_valueNo such purchase order or line in this company.
422aover_receiptMore than the outstanding quantity.
422breceipt_refusedNolaPro refused the receipt; the message is its reason.
422cnot_supported_hereA field this endpoint cannot record was sent.
curl -X POST \
  'https://acme.nolapro.com/!/api/v2/invreceives' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "invpoid": 104,
    "lines": [
        {
            "invpodetailid": 104,
            "quantity": "Example quantity"
        }
    ]
}'
GET/invreceives/{id} 200404

Retrieve one record.

Requires scope purchaseorders:read.

Parameters
NameInTypeNotes
idrequiredpathintegerThe record id.
includequerystringComma-separated extras to embed. Only custom_fields is available: the extra fields this install has defined on the record. Off by default, and an unrecognised value is refused rather than ignored. See Conventions.
When it fails
StatusCodeMeaning
404not_foundNo record with that id.
curl \
  'https://acme.nolapro.com/!/api/v2/invreceives/104' \
  -H 'Authorization: Bearer $NP_TOKEN'
Response 200
{
    "recsource": 1,
    "invpoid": 104,
    "receivedate": "2026-08-01T14:22:05Z",
    "itemid": 104,
    "item": "Example item",
    "vendorid": 104
}
PATCH/invreceives/{id} 200404

Update.

Requires scope purchaseorders:write.

Parameters
NameInTypeNotes
idrequiredpathintegerThe record id.
Idempotency-KeyheaderstringMakes the write safely retryable. Any unique string per logical operation; a UUID is fine. The failure this prevents is specific: the request succeeds, the response is lost to a timeout, you retry, and the customer is billed twice. With a key, the retry returns the original response - same status, same body, same id - and creates nothing. The body is part of the key's identity. Reusing a key with a different body is a bug on your side, not a retry, and answers 409 idempotency_replay rather than silently handing back the old response. Keys are remembered for 24 hours.
Body
FieldTypeDescription
idread-onlyintegerNolaPro id.
recsourceintegerWhere the receipt came from: 0 = received without a PO (direct item receipt), 1 = received against a purchase order.
invpoidintegerInvpoid. Id only.
receivedatestringDate the goods were received.
itemidintegerReference to items, by id. Write either this or item.
itemstring(255)The sku of the referenced items, instead of the id. Send this or itemid, not both unless they agree.
vendoridintegerReference to vendors, by id. Write either this or vendor.
vendorstring(30)Code for the referenced vendor, instead of the id.
locationidintegerInventory location to receive into.
locationstring(20)The locationcode of the referenced inventorylocations, instead of the id. Send this or locationid, not both unless they agree.
itemqtyqtystring(6dp)Quantity, 6 decimal places, as a string. Stored as decimal(6dp).
itempricemoneystring(6dp)Stored as decimal(19,6).
itemqtyusedqtystring(6dp)Quantity, 6 decimal places, as a string. Stored as decimal(6dp).
itemqtydamagedqtystring(6dp)Quantity, 6 decimal places, as a string. Stored as decimal(6dp).
conversionnumberstring(6dp)Numeric string, 6 decimal places. Not money - do not apply currency rounding.
trackstring(30)Carrier tracking number on the receipt.
receiveunitnameidintegerReference to unitnames, by id. Write either this or receiveunitname.
receiveunitnamestring(50)The unitname of the referenced unitnames, instead of the id. Send this or receiveunitnameid, not both unless they agree.
passtoapinteger1 once the receipt is passed to AP for billing.
apbillidintegerApbillid. Id only.
cancelbooleanCancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydatestringWhen the record was created.
lastchangedateread-onlystringLast modification. Drives modifiedsince.
invpodetailidintegerInvpodetailid. Id only.
statusintegerReceipt status; 0 = open.
initialsstring(255)Initials of the person who received the goods.
recnotestextRecnotes. Stored as text, no practical length limit.
itempriceqtyqtystring(6dp)Quantity, 6 decimal places, as a string. Stored as decimal(6dp).
jobidintegerJobid. Id only.
costcodeidintegerCost code.
costcodestring(20)Code for the referenced costcode, instead of the id.
glcategoryidintegerGlcategoryid. Id only.
glcategorystring(20)The code of the referenced glcategories, instead of the id. Send this or glcategoryid, not both unless they agree.
currencystring(10)Currency the received cost is stated in.
curratenumberstring(10dp)Numeric string, 10 decimal places. Not money - do not apply currency rounding.
voucheridintegerVoucherid. Id only.
voucherstring(50)The voucher of the referenced gltransactions, instead of the id. Send this or voucherid, not both unless they agree.
invreceivemainidintegerInvreceivemainid. Id only.
accruedvoucheridintegerAccruedvoucherid. Id only.
accruedvoucherstring(50)The voucher of the referenced gltransactions, instead of the id. Send this or accruedvoucherid, not both unless they agree.
invpodetailinvglacctintegerInventory GL account copied from the PO line being received.
invpodetaillinetypeintegerLine type copied from the PO line being received; 0 = standard product line.
externalidstring(100)Your own key. Scoped to your company.
When it fails
StatusCodeMeaning
404not_foundNo record with that id.
curl -X PATCH \
  'https://acme.nolapro.com/!/api/v2/invreceives/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "recsource": 1,
    "invpoid": 104,
    "receivedate": "2026-08-01T14:22:05Z",
    "itemid": 104,
    "item": "Example item",
    "vendorid": 104
}'
Response 200
{
    "recsource": 1,
    "invpoid": 104,
    "receivedate": "2026-08-01T14:22:05Z",
    "itemid": 104,
    "item": "Example item",
    "vendorid": 104
}
DELETE/invreceives/{id} 200404

Cancel.

Requires scope purchaseorders:cancel.

Parameters
NameInTypeNotes
idrequiredpathintegerThe record id.
Idempotency-KeyheaderstringMakes the write safely retryable. Any unique string per logical operation; a UUID is fine. The failure this prevents is specific: the request succeeds, the response is lost to a timeout, you retry, and the customer is billed twice. With a key, the retry returns the original response - same status, same body, same id - and creates nothing. The body is part of the key's identity. Reusing a key with a different body is a bug on your side, not a retry, and answers 409 idempotency_replay rather than silently handing back the old response. Keys are remembered for 24 hours.
When it fails
StatusCodeMeaning
404not_foundNo record with that id.
curl -X DELETE \
  'https://acme.nolapro.com/!/api/v2/invreceives/104' \
  -H 'Authorization: Bearer $NP_TOKEN'
Response 200
{
    "recsource": 1,
    "invpoid": 104,
    "receivedate": "2026-08-01T14:22:05Z",
    "itemid": 104,
    "item": "Example item",
    "vendorid": 104
}