Order

The elements list below details information for Invoice. To view the descriptions for the elements you can either hover any attribute to reveal details or click here to show all details inline.

Items shown with are required when posting or puting data
Items shown with are read-only elements

Attribute Details

• UIDGuid (36)
• Unique guid identifier created for a sale order.
• Number String (13)
• Sales order number
• DateDateTime
• Transaction date entry, format YYYY-MM-DD HH:MM:SS { 'Date': '2014-05-01 00:00:00' }
• CustomerPurchaseOrderNumberString (255)
• Customer PO number.
• Customer
• The following set of information pulls through details for the Customer contact
• • UIDGuid (36)
  • Foreign Key: Unique guid identifier belonging to the customer assigned to the sale order.
  • NameString (50)
  • Name of the customer.
  • DisplayIDString (15)
  • Customer contact Card ID.
  • URIString
  • Uniform resource identifier associated with the customer object.
• Terms
• The following set of information pulls through customer payment terms.
• • PaymentIsDueString
  • Default Terms of Payment definitions:
    CashOnDelivery
    PrePaid
    InAGivenNumberOfDays
    OnADayOfTheMonth
    NumberOfDaysAfterEOM
    DayOfMonthAfterEOM
    
  • DiscountDate Integer
  • If PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber or NumberOfDaysAfterEOM then set the number of days within which the customer must pay to receive discounts.
    
    If PaymentIsDue = OnADayOfTheMonth or DayOfMonthAfterEOM then set the day of the month within which the payment must be made to receive discounts.
  • BalanceDueDate Integer
  • If PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber or NumberOfDaysAfterEOM then set the number of days within which the customer has to pay invoices.
    
    If PaymentIsDue = OnADayOfTheMonth or DayOfMonthAfterEOM then set the day of the month within which the payment must be made to pay invoices.
  • DiscountForEarlyPayment Double (99.99%)
  • % discount for early payment.
  • MonthlyChargeForLatePayment Double (99.99%)
  • % monthly charge for late payment.
  • DiscountExpiryDateDateTime
  • Date in which payment must be paid in full in order to receive discount, format YYYY-MM-DD HH:MM:SS { 'Date': '2014-09-10 00:00:00' }
  • DiscountDecimal (13.2)
  • Discount amount that will apply if payment is made in full by the discount date.
  • DueDateDateTime
  • Date in which payment is due, format YYYY-MM-DD HH:MM:SS { 'Date': '2014-09-10 00:00:00' }
  • FinanceChargeDecimal (13.2)
  • Late payment fee to be charged if payment is not made in full by the due date.
• IsTaxInclusiveBoolean
• True indicates the transaction is set to tax inclusive.
  False indicates the transaction is not tax inclusive.
• SubtotalDecimal (13.2)
• If IsTaxInclusive = false then sum of all tax exclusive line amounts.
  If IsTaxInclusive = true then sum of all tax inclusive line amounts.
• FreightDecimal (13.2)
• Tax inclusive freight amount applicable to the sale order.
• FreightTaxCode
• The following set of information pulls through the details for freight Tax Codes
• • UID GUID (36)
  • Foreign Key: Unique freight tax code identifier in the form of a guid
  • Code String (3)
  • 3 digit code assigned to the freight tax code.
  • URI String
  • Uniform resource identifier associated with the freight tax code object.
• TotalTaxDecimal (13.2)
• Total of all tax amounts applicable to the sale order.
• TotalAmountDecimal (13.2)
• Total amount of the sale order.
• Category
• The following outlines category information for the sale order.
• • UID GUID (36)
  • Foreign Key: Unique guid identifier belonging to the category assigned to the sale order
  • Name String (30)
  • Name of the category
  • DisplayID String (15)
  • Display id for the category
  • URI String
  • Uniform resource identifier associated with the category object
• Salesperson
• The following set of information pulls through details for the an employee contact.
• • UIDGuid (36)
  • Foreign Key: Unique employee contact identifier in the form of a guid.
  • NameString (30)
  • Selected employee contact name.
  • DisplayIDString (15)
  • Employee contact Card ID.
  • URIString
  • Uniform resource identifier associated with the employee contact object.
• JournalMemoString (255)
• Journal memo text describing the sale.
• ReferralSourceString (20)
• Referral Source selected on the sale order.
• AppliedToDateDecimal (13.2)
• Payment amount already applied to sale order.
• BalanceDueAmountDecimal (13.2)
• Amount still payable on the sale order.
• StatusString
• Order status can consist of the following:
  Open
  ConvertedToInvoice
  
• LastPaymentDateDateTime
• Date last payment was received against transaction, format YYYY-MM-DD HH:MM:SS { 'LastPaymentDate': '2014-05-01 00:00:00' }
• OrderTypeOrderType
• Order layout type:
  Item
  Service
  Professional
  TimeBilling
  Miscellaneous
• ForeignCurrency
• Null if no foreign currency is set.
• • UIDGuid (36)
  • Foreign Key: Unique identifier for the currency in the form of a guid.
  • CodeString (3)
  • The currency code.
  • CurrencyNameString
  • The full name of the currency
  • URIString
  • Uniform resource identifier associated with the currency object.
• URIString
• Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
• RowVersionString
• Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.

Paging: default page size is set to 400 with a maximum of 1000 results.