Card purchases

Read-only. Card purchase records.

The object#

FieldTypeDescription
idread-onlyintegerNolaPro id.
ccvendoridintegerCcvendorid. Id only.
purchasedatestringDate of the credit-card purchase.
whostring(100)Who made the purchase.
amountmoneystring(5dp)Stored as decimal(19,5).
purposestring(250)What the purchase was for.
apbillidintegerApbillid. Id only.
cancelbooleanCancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
purchasefromstring(100)Merchant the purchase was made from.
invpoidintegerInvpoid. Id only.
jobidintegerJobid. Id only.
costcodeidintegerCost code.
costcodestring(20)Code for the referenced costcode, instead of the id.
glcategoryidintegerGlcategoryid. Id only.
currencystring(10)Currency of the purchase.
curratenumberstring(10dp)Numeric string, 10 decimal places. Not money - do not apply currency rounding.
entrydatestringWhen the record was created.

Endpoints#

GET/ccpurchases 200403

List card purchases.

Requires scope banking:read.

Parameters
NameInTypeNotes
jobidquerystringRestrict to one jobid.
invpoidquerystringRestrict to one invpoid.
cancelquerystringDefaults to false. Pass true or any.
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/ccpurchases' \
  -H 'Authorization: Bearer $NP_TOKEN'
GET/ccpurchases/{id} 200404

Retrieve one record.

Requires scope banking: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/ccpurchases/104' \
  -H 'Authorization: Bearer $NP_TOKEN'
Response 200
{
    "ccvendorid": 104,
    "purchasedate": "2026-08-01",
    "who": "Example who",
    "amount": "125.0000",
    "purpose": "Example purpose",
    "apbillid": 104
}