PublicApi

Payment Summary

object

A summary of payments

store_idstring

The ID of the store within this system

referencestring

the reference for the payment

datestring(date)

The date of the summary

amountnumber

The amount of the payment

payment_method_idstring

The ID of the payment method within this system

idstring

The ID of the record

transaction_typestring

The ID of the transaction type within this system

payment_datestring(date)

The payment date of the payment

Example

Contact Details

object

Contact details for an entity

countrystring

The address country

postcodestring

The address postcode

last_namestring

The last name of the contact

fax_numberstring

The fax number of the contact

email_addressstring

The email address of the contact

company_namestring

The company name of the contact

address_line_1string

The first line of the address

suburbstring

The address suburb

phone_numberstring

The phone number of the contact

address_line_3string

The third line of the address

address_line_2string

The second line of the address

statestring

The address state

mobile_numberstring

The mobile number of the contact

first_namestring

The first name of the contact

address_line_4string

The fourth line of the address

Example

Page Number

integer

The current page number

PaymentType

object

A payment type

is_enabledboolean

A flag indicating if the payment method is enabled

last_modified_onstring(date-time)

The date the payment type was last modified

summarised_for_accountingboolean

A flag indicating if the payment method is summarised for accounting purposes

namestring

The name of the payment type

idstring

The ID of the payment type

Example

Total Record Count

integer

The total number of records in your query