MYOB Endpoint: SalesAllInvoicesTable

From OdataLink
Jump to navigation Jump to search

Overview

The MYOB SalesAllInvoicesTable endpoint allows you to get access to all sales invoices regardless of type (Item, Miscellaneous, Professional, Service, Time-Billing) within MYOB.

Note this endpoint is an alternate format of the SalesAllInvoices endpoint. It provides a format that can more easily integrate with Tableau, SSIS and Azure Data Factory.


Fields

The following fields are available for the SalesAllInvoicesTable endpoint.

DataFileID
A guid field that provides the id of the data file as setup in OdataLink.
DataFileName
A text field that provides the name of the data file as setup in OdataLink.
DataFileCode
A text field that provides the code of the data file as setup in OdataLink.
UID
A GUID field representing the internal id of this record. This field can be used to link to other endpoints.
Number
A text field that provides the invoice number.
Date
A date field that indicates the date of the transaction.
CustomerPurchaseOrderNumber
A text field that provides the customer purchase order number.
CustomerUID
A GUID field that provides the internal id of the customer. This field can be used to link to other endpoints.
CustomerName
A text field that provides the full name of the customer.
CustomerDisplayID
A text field that provides the Card ID of the customer.
PromisedDate
A date field that provides the promised date of the transaction.
BalanceDueAmount
A decimal field that provides the outstanding balance of this transaction.
BalanceDueAmountForeign
A decimal field that provides the outstanding balance of this transaction for foreign currency transactions.
Status
A text field that provides the status of this transaction.
Possible values are:
  • Open: Indicates the invoice has an outstanding amount owing.
  • Closed: Indicates the invoice is paid in full.
  • Credit: Indicates the invoice is negative or overpaid and not settled or refunded.
ShipToAddress
A text field that provides the complete address.
TermsPaymentIsDue
A text field that represents the due date.
Possible values are:
  • CashOnDelivery
  • PrePaid
  • InAGivenNumberOfDays
  • OnADayOfTheMonth
  • NumberOfDaysAfterEOM
  • DayOfMonthAfterEOM
TermsDiscountDate
A integer field used to represent either a specific day or a specific number of days in order to receive a discount.
TermsBalanceDueDate
A integer field used to represent either a specific day or a specific number of days in order to pay on time.
TermsDiscountForEarlyPayment
A decimal field used to represent the percentage discount for early payment.
TermsMonthlyChargeForLatePayment
A decimal field used to represent the charge for late payments.
TermsDiscountExpiryDate
A datefield that provides the date when the discount expires.
TermsDiscount
A decimal field used to represent the dollar discount.
TermsDiscountForeign
A decimal field used to represent the dollar discount for foreign currency transactions.
TermsDueDate
A datefield that provides the date when payment is due.
TermsFinanceCharge
A decimal field used to represent the finance charge if any.
TermsFinanceChargeForeign
A decimal field used to represent the finance charge if any for foreign currency transactions.
IsTaxInclusive
A true/false field that indicates if the amounts are tax inclusive or not.
Subtotal
A decimal field that provides the total of all the lines.
SubtotalForeign
A decimal field that provides the total of all the lines for foreign currency transactions.
Freight
A decimal field that provides the freight amount for this transaction.
FreightForeign
A decimal field that provides the freight amount for this transaction for foreign currency transactions.
FreightTaxCodeUID
A guid field that provides the id of the tax code for freeight.
FreightTaxCode
A text field that provides the tax code for freight (e.g. GST or FRE).
TotalTax
A decimal field that provides the total tax amount.
TotalTaxForeign
A decimal field that provides the total tax amount for foreign currency transactions.
TotalAmount
A decimal field that provides the total amount of this transaction.
TotalAmountForeign
A decimal field that provides the total amount of this transaction for foreign currency transactions.
CategoryUID
A GUID field that provides the internal id of a category. This field can be used to link to other endpoints.
CategoryName
A text field that provides the category name.
CategoryDisplayID
A text field that provides the category number.
SalespersonUID
A GUID field that provides the internal id of the sales person. This field can be used to link to other endpoints.
SalespersonName
A text field that provides the full name of the sales person.
SalespersonDisplayID
A text field that provides the Card ID of the sales person.
Comment
A text field that provides the comment for the transaction.
ShippingMethod
A text field that provides the shipping method for the transaction.
JournalMemo
A text field that provides the memo for the transaction.
ReferralSource
A text field that provides the referral source for the transaction.
InvoiceDeliveryStatus
A text field that provides the delivery status of this transaction.
Possible values are:
  • Email
  • Print
  • PrintAndEmail
  • Nothing
LastPaymentDate
A date field that provides the last payment date applied to the transaction.
InvoiceType
A text field that indicates the type of invoice.
Possible values are:
  • Item
  • Miscellaneous
  • Professional
  • Service
  • TimeBilling
OrderUID
A GUID field that provides the internal id of the order. This field can be used to link to other endpoints.
OrderNumber
A text field that provides the order number for the originating order (if applicable).
OnlinePaymentMethod
A text field that provides the method of payment used for online payments.
ForeignCurrencyUID
A GUID field that provides the internal id of the currency linked to this transaction. This field can be used to link to other endpoints.
ForeignCurrencyCode
A text field that provides the currency ISO code.
ForeignCurrencyName
A text field that provides the currency name.
CurrencyExchangeRate
A decimal field that provides exchange rate for foreign currency transactions.
LastModified
A date time field that indicates the date and time it was last modified.
RowVersion
A row version field.


MYOB API

For a detailed run through of the endpoint, you can see the MYOB API.


Related Endpoints

JournalTransactions
SalesAllInvoices
SalesAllOrders
SalesAllQuotes


Related Topics

MYOB Models
MYOB Endpoints