Data Dictionary
Invoices and Credit Notes for products and services sold to your customers. Combines sales invoices (revenue earned on dispatched goods) and credit notes (customer returns or charge adjustments).Useful for analyzing revenue by customer, product, or date; tracking payment outstanding; and identifying patterns in returns — e.g., which products are most frequently returned or which customers have pending credits.
Field | Type | Notes |
Average Landed Price At Time Of Sale | Number | API: Credit Lines.AverageLandedPriceAtTimeOfSale |
Batch Numbers | JSON | API: Array of Credit Lines.BatchNumbers | Invoice Lines.BatchNumbers |
Comment | Text | API: Credit Note.Comments |
Connection ID | Integer | The Connectorly Connection ID. If you group Connectorly's together, then you will see a Connection ID for each one. Organisations has the corresponding Connection Name for each Connection ID. |
Created | Datetime | Derived from datetime with timezone conversion of Created |
Created By | Text | The email of the user that created the record, API: Credit Note.CreatedBy |
Credit Date | Date | Derived from date conversion of Credit Date |
Credit Line GUID | Text | API: Credit Lines.Guid |
Credit Note GUID | Text | API: Credit Note.Guid |
Credit Note Number | Text | API: Credit Note.CreditNoteNumber |
Credit Note Tax Rate | Number | API: Credit Note.TaxRate |
Credit Price | Number | API: Credit Lines.CreditPrice |
Credit Price (BC) | Number | Derived from dividing Credit Price and Currency Rate |
Credit Quantity | Number | API: Credit Lines.CreditQuantity |
Credit Status | Text | API: Credit Note.Status |
Credit Type | Text | API: Credit Note.CreditType |
Credited Net Amount | Number | The net value of the goods credited (in the transaction currency?)., Derived from multiplying Credit Quantity and Credit Price |
Currency | Text | The ISO Currency Code, API: Currency.CurrencyCode |
Currency Rate | Number | API: Credit Note.ExchangeRate |
Customer GUID | Text | Unique ID for a Customer, API: Customer.Guid |
Customer Name | Text | Derived from cleaning Customer.CustomerName |
Data current as of | Datetime | Gives the date and time that this record was taken from Unleashed. |
Delivery Address City | Text | API: Addresses.City |
Delivery Address Country | Text | API: Addresses.Country |
Delivery Address Instruction | Text | API: Addresses.DeliveryInstruction |
Delivery Address Name | Text | API: Addresses.AddressName |
Delivery Address Post Code | Text | API: Addresses.PostalCode |
Delivery Address Region | Text | API: Addresses.Region |
Delivery Address Suburb | Text | API: Addresses.Suburb |
Delivery Street Address | Text | API: Addresses.StreetAddress |
Delivery Street Address 2 | Text | API: Addresses.StreetAddress2 |
Disassemble | Boolean | API: Credit Lines.Disassemble |
Discount Rate | Number | API: Invoice Lines.DiscountRate |
Due Date | Date | Derived from date conversion of Due Date |
Gross Amount | Number | Derived from adding Credit Lines.LineTotal and Credit Lines.LineTax |
Gross Amount (BC) | Number | Derived from dividing Gross Amount and Currency Rate |
Header Tax Rate | Number | API: Credit Note.TaxRate |
Invoice Date | Date | The Invoice Date for the Invoice for this Credit Note; Invoice Date, Derived from date conversion of Invoice Date |
Invoice Number | Text | The Invoice Number associated with a Credit Note, API: Credit Note.InvoiceNumber |
Invoice Quantity | Number | API: Invoice Lines.InvoiceQuantity |
Invoice Status | Text | API: Sales Invoice.InvoiceStatus |
Line Comment | Text | API: Credit Lines.Comments |
Line Number | Integer | API: Credit Lines.LineNumber |
Line Type | Text | API: Credit Lines.LineType |
Line Updated | Datetime | Derived from datetime with timezone conversion of Line Updated |
Net Amount | Number | API: Credit Lines.LineTotal |
Net Amount (BC) | Number | Derived from dividing Net Amount and Currency Rate |
Order Number | Text | API: Sales Invoice.OrderNumber | Sales Order.OrderNumber |
Order Quantity | Number | API: Credit Lines.OrderQuantity |
Payment Received | Boolean | API: Sales Invoice.PaymentReceived |
Payment Term | Text | API: Sales Invoice.PaymentTerm |
Pending Batch Numbers | JSON | API: Array of Credit Lines.PendingBatchNumbers |
Pending Serial Numbers | JSON | API: Array of Credit Lines.PendingSerialNumbers |
Postal Address City | Text | API: Postal Address.City |
Postal Address Country | Text | API: Postal Address.Country |
Postal Address Instruction | Text | API: Postal Address.DeliveryInstruction |
Postal Address Name | Text | API: Postal Address.AddressName |
Postal Address Postal Code | Text | API: Postal Address.PostalCode |
Postal Address Region | Text | API: Postal Address.Region |
Postal Address Suburb | Text | API: Postal Address.Suburb |
Postal Street Address | Text | API: Postal Address.StreetAddress |
Postal Street Address 2 | Text | API: Postal Address.StreetAddress2 |
Product Description | Text | Derived from cleaning Product Description |
Product GUID | Text | The Unique ID of a Product, API: Product.Guid |
Quote Number | Text | API: Sales Invoice.QuoteNumber |
Reason | Text | API: Credit Lines.Reason |
Reference | Text | API: Credit Note.Reference |
Reference Number | Text | API: Credit Note.ReferenceNumber |
Required Delivery Date | Date | Derived from date conversion of Required Delivery Date |
Return To Stock | Boolean | API: Credit Lines.ReturnToStock |
Serial Numbers | JSON | API: Array of Credit Lines.SerialNumbers | Invoice Lines.SerialNumbers |
Sub Total | Number | API: Credit Note.SubTotal |
Tax Amount | Number | API: Credit Lines.LineTax |
Tax Amount (BC) | Number | Derived from dividing Tax Amount and Currency Rate |
Tax Code | Text | API: Credit Lines.XeroTaxCode | Invoice Lines.LineTaxCode |
Tax Rate | Number | API: Credit Lines.TaxRate | Invoice Lines.TaxRate |
Tax Total | Number | API: Credit Note.TaxTotal |
Total | Number | API: Credit Note.Total |
Unit Price | Number | API: Invoice Lines.UnitPrice |
Unit Price (BC) | Number | Unit Price (Base Currency), API: Invoice Lines.BCUnitPrice |
Updated | Datetime | Derived from datetime with timezone conversion of Updated |
Updated By | Text | API: Credit Note.LastModifiedBy |
Warehouse GUID | Text | The Unique ID of the Warehouse, API: Warehouse.Guid |
Warehouse Name | Text | API: Warehouse.WarehouseName |
Xero Sales Account | Text | API: Credit Lines.XeroSalesAccount |
