SupplierPayment

Attribute Details

• UIDGuid (36)
• Unique guid identifier created for a supplier payment.
• PayFromString
• If allocating a banking account for the payment specify Account
  If using electronic payments specify ElectronicPayments
  What are electronic payments?
• Account
• The following set of information pulls through details for the Account
• • UIDGuid (36)
  • Please note: Passing the Account UID is optional if you are assigning ElectronicPayments, if allocating a bank account the UID is required.
    
    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 1-1100{ 'DisplayID': '1-1100' }
  • URIString
  • Uniform resource identifier associated with the account object.
• Supplier
• The following set of information pulls through details for the Supplier contact
• • UIDGuid (36)
  • Foreign Key: Unique guid identifier belonging to the supplier assigned to the supplier payment.
  • NameString (30)
  • Name of the supplier.
  • DisplayIDString (15)
  • Supplier contact Card ID, can also be used as a unique supplier contact identifier.
  • URIString
  • Uniform resource identifier associated with the supplier object.
• PayeeAddressString (255)
• Payee name and address of the supplier contact.
• StatementParticularsString
• ONLY applicable for Electronic Payments.
  Particulars attached to electronic payment.
  What are electronic payments?
• StatementCodeString
• ONLY APPLICABLE FOR NZ REGION.
  Code attached to electronic payment.
• StatementReferenceString
• ONLY APPLICABLE FOR NZ REGION.
  Reference attached to electronic payment.
• PaymentNumber String (8)
• ID No of payment transaction
• DateDateTime
• Transaction date entry, format YYYY-MM-DD HH:MM:SS { 'Date': '2013-08-11 13:33:02' }
• AmountPaidDecimal (13.2)
• Total of all amounts paid to the purchase bill/bills.
• AmountPaidForeignDecimal (13.2)
• Total of all amounts paid to the purchase bill/bills in foreign currency.
• Memo String (255)
• Memo text of the supplier payment entry.
• Lines []
• An array of purchase bill/order line information
• • RowId Integer
  • Sequence of the entry within the supplier payment set.
  • TypeString
  • Purchase type, can consist of the following:
    Bill
    Order
  • Purchase
  • The following set of information pulls through details for the Purchase Bill or Order
  • • UIDGuid (36)
    • Foreign Key: Unique guid identifier belonging to the supplier purchase bill or order.
    • Number String (8)
    • Purchase bill/order number
    • URIString
    • Uniform resource identifier associated with the purchase bill/order object.
  • AmountAppliedDecimal (13.2)
  • Mandatory for a Local currency record : Amount applied to the purchase bill or order
  • AmountAppliedForeignDecimal (13.2)
  • Mandatory for a Foreign currency record : Amount applied to the purchase bill or order in foreign currency.
  • RowVersion String
  • Incrementing number that can be used for change control but does does not preserve a date or a time.
• DeliveryStatusString (20)
• Delivery status assigned to payment:
  Print = ToBePrinted
  Email = ToBeEmailed
  PrintAndEmail = ToBePrintedAndEmailed
  Nothing = AlreadyPrintedOrSent
  
• ForeignCurrency
• Foreign currency information in the transaction.
• • 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.
• CurrencyExchangeRateDecimal
• Currency exchange rate for the associated 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.