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 207

Create many.

Requires scope purchaseorders:write.

Parameters
NameInTypeNotes
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.
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 201400

Create.

Requires scope purchaseorders:write.

Parameters
NameInTypeNotes
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
400invalid_requestA required field was missing.
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 '{
    "recsource": 1,
    "invpoid": 104,
    "receivedate": "2026-08-01T14:22:05Z",
    "itemid": 104,
    "item": "Example item",
    "vendorid": 104
}'
Response 201
{
    "recsource": 1,
    "invpoid": 104,
    "receivedate": "2026-08-01T14:22:05Z",
    "itemid": 104,
    "item": "Example item",
    "vendorid": 104
}
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.
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.
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
}