Receipts

Gets a Receipt by its Id.

get/receipts/{receiptId}

Request

  • Base URL: https://api.alto.zoopladev.co.uk
  • URL: https://api.alto.zoopladev.co.uk/receipts/{receiptId}
  • Auth: appAuth (a scheme the document does not define)

Path parameters

receiptIdinteger required

Id of the receipt

Headers

AgencyRefstring required

A GUID required in the header of all API requests that grants access to an agent's data

Response

Success

idstring nullable
branchIdstring nullable
receiptReferencestring nullable
totalReceivednumber double
currencyCodestring nullable
receiptDatestring date-time
documentStatusstring nullable
contactIdstring nullable
tenancyIdstring nullable
isReversalboolean

True when this receipt is itself a reversal of another.

originalReceiptIdstring nullable

The receipt this one reverses, from accounts.ReceiptReversalAudit.

isReversedboolean

True when this receipt has been reversed.

reversalReceiptIdstring nullable

The receipt that reversed this one, from accounts.ReceiptReversalAudit.

receiptDocumentIdstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.