Sign in
Receipts

Find a single receipt by its internal ID

Changed on
get/v1/receipts/getbyinternalid/{internalid}

Request

  • Base URL: https://api.altoviz.com
  • URL: https://api.altoviz.com/v1/receipts/getbyinternalid/{internalid}
  • Auth: none required

Path parameters

internalIdstring required

Receipt internal ID

Response

OK

amountnumber double

Amount

customerIdinteger nullable

Customer ID

customerInternalIdstring nullable

Customer number

customerNamestring nullable

Customer name

customerNumberstring nullable

Customer number

datestring date

Date

idinteger

ID

internalIdstring nullable

Internal ID

metadataobject nullable

Metadata: free-form key/value pairs carried with the receipt, for an integration to keep its own identifiers and flags against it.

Sent as a PATCH, not a replacement: keys you send are added or updated, keys you leave out keep whatever they held, and a key is removed only when you send it as null. Omitting the property entirely leaves the whole bag untouched, and "" stores an empty value rather than removing the key.

notesstring nullable

Notes

paymentMethod'Transfer' | 'Order' | 'Check' | 'Cash' | 'Card' | 'Bill' | 'Usec' | 'Other'
referencestring nullable

Reference

status'Success' | 'Pending' | 'Failed'

Receipt Status

Changes