CreditRefund

Attribute Details

• UIDGuid (36)
• Unique guid identifier created for a credit note refund.
• Account
• The following set of information pulls through details for an Account
• • UIDGuid (36)
  • Foreign Key: Unique identifier for the account in the form of a guid.
  • NameString (30)
  • Account name belonging to the account record.
  • DisplayIDString (6)
  • Account code format includes separator ie 4-1100{ 'DisplayID': '4-1100' }
  • URIString
  • Uniform resource identifier associated with the account object.
• Invoice
• The following set of information pulls through details for a sale 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.
• PayeeString (255)
• Payee address on the credit note belonging to the customer contact.
• DateDateTime
• Transaction date, format YYYY-MM-DD HH:MM:SS { 'Date': '2013-11-30 16:35:02' }
• AmountDecimal (13.2)
• Total credit amount to be refunded, can be equal to or less than the invoice amount.
• MemoString (255)
• Memo text describing the credit refund.
• ChequePrintedBoolean
• True indicates the credit refund has been already printed.
  False indicates the credit refund has not been printed.
• DeliveryStatusString (20)
• Remittance advise delivery status assigned to credit note:
  Print = ToBePrinted
  Email = ToBeEmailed
  PrintAndEmail = ToBePrintedAndEmailed
  Nothing = AlreadyPrintedOrSent
  
• 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.