CreditSettlement

Attribute Details

• UIDGuid (36)
• Unique guid identifier created for a settled credit note.
• CreditFromInvoice
• The following set of information pulls through details for a sales credit invoice.
• • UIDGuid (36)
  • Foreign Key: Unique identifier for an invoice in the form of a guid.
  • Number String (8)
  • Sales invoice number
  • URIString
  • Uniform resource identifier associated with the invoice object.
• 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 credit refund.
  • NameString (30)
  • Name of the customer contact.
  • DisplayIDString (15)
  • Customer contact Card ID, can also be used as a unique customer contact identifier.
  • URIString
  • Uniform resource identifier associated with the customer object.
• Number String (13)
• Cheque credit number, optional on POST as will auto increment based upon last recorded if left blank.
• DateDateTime
• Transaction date, format YYYY-MM-DD HH:MM:SS { 'Date': '2013-12-17 15:33:02' }
• CreditAmountDecimal (13.2)
• Total credit amount to be applied, can only be less than or equal to CreditFromInvoice amount.
• MemoString (255)
• Memo text describing the settled credit.
• Lines []
• The following set of information pulls through line details for the credit settlement.
• • TypeString
  • Sale type which can consist of the following:
    Invoice
    Order
  • Sale
  • The following set of information pulls through details for a sales transaction.
  • • UIDGuid (36)
    • Foreign Key: Unique identifier for an sales transaction in the form of a guid.
    • Number String (8)
    • Sales transaction number.
    • URIString
    • Uniform resource identifier associated with the sales transaction object.
  • AmountAppliedDecimal (13.2)
  • Credit amount applied to sales transactions, amount must be greater than 0.
• 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
• Incrementing number that 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.