TransactionSearchResponse
Transaction that matches the search criteria. This resource contains only fields that are indexed for a Transaction, not all the fields that would be found on the Invoice resource.
| Name | Description | Type | Additional information |
|---|---|---|---|
| EntityType | The type of entity transacted. Supported types are: Sale, Purchase, Payroll, Journal. | string |
None. |
| Id | The Unique Id/key for the Transaction. | integer |
None. |
| TransactionDate | The transaction date. | date |
None. |
| DueDate | Date that payment is due for a Transaction. Applies to Sale and Purchase transactions. | date |
None. |
| Summary | Summary/description for a Transaction. | string |
None. |
| ContactId | Identifier for the Contact associated with the Transaction. | integer |
None. |
| ContactName | Full name of the contact. | string |
None. |
| CustomerContactId | Is used as an Account or Contact reference for this person if they are a supplier or customer. This is your reference or their reference depending on how you prefer to use this field. | string |
None. |
| ContactEmail | Email address for the contact associated with the Transaction. | string |
None. |
| Company | The Organisation or Company that employs the Contact. | string |
None. |
| TradingName | Trading name of the Organisation or Company that employs the Contact. | string |
None. |
| Type | The transaction type of the invoice. Supported types are: 'S' = sale, 'P' = purchase, 'PE' = payroll, 'J' = journal. | string |
None. |
| TotalAmountIncTax | Total amount of the invoice. | string |
None. |
| Currency | The currrency code of the amounts. Eg. AUD. | string |
None. |
| Tags | List of tags associated with this Transaction. | string |
None. |
| Notes | User supplied notes about the Transaction. | string |
None. |
| ExternalNotes | Textual notes set by the user. | string |
None. |
| Reference | Customer's reference for the Transaction. Supported on Journal and Payroll transactions. | string |
None. |
| InvoiceNumber | Invoice number for a Sale or Purchase transaction. | string |
None. |
| InvoiceType | Invoice type description. Few examples are: "Pre-Quote Opportunity", "Quote" , "Purchase Order", "Sale Order", "Tax Invoice", "Adjustment Note", "RCT Invoice", "Money In (Income)", "Money Out (Expense)". | string |
None. |
| PurchaseOrderNumber | The Purchase Order Number on a Sale or Purchase transaction. | string |
None. |
| Paid | Indicates whether a Sale or Purchase transaction is fully paid. | boolean |
None. |
| _links | Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server. | Collection of Link |
None. |