---
title: "PublicApi"
url: "https://developer.retailexpress.com.au/apis/public-api-0/versions/d2454f6f-56f1-4fd6-9cd1-82871d94bd1c"
---

# PublicApi

OpenAPI specification document.

```json
{"openapi":"3.0.1","info":{"title":"PublicApi","description":"Please use the API Explorer to interact with our API resources without having to implement any logic. All you need is your API key to get started.\n","version":"0.1.0"},"servers":[{"url":"https://api.retailexpress.com.au/{basePath}","variables":{"basePath":{"default":"v1"}}}],"paths":{"/financialsummaries/purchaseorders":{"get":{"parameters":[{"name":"date_from","in":"query","schema":{"type":"string"}},{"name":"date_to","in":"query","schema":{"type":"string"}},{"name":"page_size","in":"query","schema":{"type":"string"}},{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"page_number","in":"query","schema":{"type":"string"}},{"name":"store_ids","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"200 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderListResponse"}}}},"400":{"description":"400 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}},"403":{"description":"403 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}},"429":{"description":"429 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}}},"security":[{"api_key":[]}]},"options":{"responses":{"200":{"description":"200 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Headers":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empty"}}}}}}},"/financialsummaries/supplierinvoices":{"get":{"parameters":[{"name":"date_from","in":"query","schema":{"type":"string"}},{"name":"date_to","in":"query","schema":{"type":"string"}},{"name":"page_size","in":"query","schema":{"type":"string"}},{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"page_number","in":"query","schema":{"type":"string"}},{"name":"supplier_invoice_date_to","in":"query","schema":{"type":"string"}},{"name":"supplier_invoice_date_from","in":"query","schema":{"type":"string"}},{"name":"store_ids","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"200 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierInvoiceListResponse"}}}},"400":{"description":"400 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}},"403":{"description":"403 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}},"429":{"description":"429 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}}},"security":[{"api_key":[]}]},"options":{"responses":{"200":{"description":"200 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Headers":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empty"}}}}}}},"/financialsummaries/stockadjustments":{"get":{"parameters":[{"name":"date_from","in":"query","schema":{"type":"string"}},{"name":"date_to","in":"query","schema":{"type":"string"}},{"name":"page_size","in":"query","schema":{"type":"string"}},{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"page_number","in":"query","schema":{"type":"string"}},{"name":"store_ids","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"200 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockAdjustmentSummaryResponse"}}}},"400":{"description":"400 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}},"403":{"description":"403 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}},"429":{"description":"429 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}}},"security":[{"api_key":[]}]},"options":{"responses":{"200":{"description":"200 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Headers":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empty"}}}}}}},"/suppliers":{"get":{"parameters":[{"name":"page_size","in":"query","schema":{"type":"string"}},{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"page_number","in":"query","schema":{"type":"string"}},{"name":"modified_since","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"200 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierListResponse"}}}},"400":{"description":"400 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}},"403":{"description":"403 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}},"429":{"description":"429 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}}},"security":[{"api_key":[]}]}},"/suppliers/{supplier_id}":{"get":{"parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"supplier_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Supplier"}}}},"400":{"description":"400 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}},"403":{"description":"403 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}},"429":{"description":"429 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}}},"security":[{"api_key":[]}]},"options":{"parameters":[{"name":"supplier_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Headers":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empty"}}}}}}},"/financialsummaries/stocktransfers":{"get":{"parameters":[{"name":"date_from","in":"query","schema":{"type":"string"}},{"name":"date_to","in":"query","schema":{"type":"string"}},{"name":"page_size","in":"query","schema":{"type":"string"}},{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"page_number","in":"query","schema":{"type":"string"}},{"name":"store_ids","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"200 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockTransferSummaryResponse"}}}},"400":{"description":"400 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}},"403":{"description":"403 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}},"429":{"description":"429 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}}},"security":[{"api_key":[]}]},"options":{"responses":{"200":{"description":"200 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Headers":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empty"}}}}}}},"/financialsummaries/sales":{"get":{"parameters":[{"name":"date_from","in":"query","schema":{"type":"string"}},{"name":"date_to","in":"query","schema":{"type":"string"}},{"name":"page_size","in":"query","schema":{"type":"string"}},{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"page_number","in":"query","schema":{"type":"string"}},{"name":"store_ids","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"200 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesSummaryResponse"}}}},"400":{"description":"400 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}},"403":{"description":"403 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}},"429":{"description":"429 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}}},"security":[{"api_key":[]}]},"options":{"responses":{"200":{"description":"200 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Headers":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empty"}}}}}}},"/financialsummaries/cashvariances":{"get":{"parameters":[{"name":"date_from","in":"query","schema":{"type":"string"}},{"name":"date_to","in":"query","schema":{"type":"string"}},{"name":"page_size","in":"query","schema":{"type":"string"}},{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"page_number","in":"query","schema":{"type":"string"}},{"name":"store_ids","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"200 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashVarianceSummaryResponse"}}}},"400":{"description":"400 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}},"403":{"description":"403 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}},"429":{"description":"429 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}}},"security":[{"api_key":[]}]},"options":{"responses":{"200":{"description":"200 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Headers":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empty"}}}}}}},"/financialsummaries/suppliercredits":{"get":{"parameters":[{"name":"date_from","in":"query","schema":{"type":"string"}},{"name":"supplier_credit_note_date_from","in":"query","schema":{"type":"string"}},{"name":"date_to","in":"query","schema":{"type":"string"}},{"name":"page_size","in":"query","schema":{"type":"string"}},{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"page_number","in":"query","schema":{"type":"string"}},{"name":"supplier_credit_note_date_to","in":"query","schema":{"type":"string"}},{"name":"store_ids","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"200 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierCreditListResponse"}}}},"400":{"description":"400 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}},"403":{"description":"403 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}},"429":{"description":"429 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}}},"security":[{"api_key":[]}]},"options":{"responses":{"200":{"description":"200 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Headers":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empty"}}}}}}},"/financialsummaries/payments":{"get":{"parameters":[{"name":"date_from","in":"query","schema":{"type":"string"}},{"name":"date_to","in":"query","schema":{"type":"string"}},{"name":"page_size","in":"query","schema":{"type":"string"}},{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"page_number","in":"query","schema":{"type":"string"}},{"name":"store_ids","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"200 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentSummaryResponse"}}}},"400":{"description":"400 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}},"403":{"description":"403 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}},"429":{"description":"429 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}}},"security":[{"api_key":[]}]},"options":{"responses":{"200":{"description":"200 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Headers":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empty"}}}}}}},"/stores":{"get":{"parameters":[{"name":"page_size","in":"query","schema":{"type":"string"}},{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"page_number","in":"query","schema":{"type":"string"}},{"name":"modified_since","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"200 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreListResponse"}}}},"400":{"description":"400 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}},"403":{"description":"403 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}},"429":{"description":"429 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}}},"security":[{"api_key":[]}]},"options":{"responses":{"200":{"description":"200 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Headers":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empty"}}}}}}},"/paymenttypes":{"get":{"parameters":[{"name":"page_size","in":"query","schema":{"type":"string"}},{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"page_number","in":"query","schema":{"type":"string"}},{"name":"modified_since","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"200 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentTypeListResponse"}}}},"400":{"description":"400 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}},"403":{"description":"403 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}},"429":{"description":"429 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}}},"security":[{"api_key":[]}]},"options":{"responses":{"200":{"description":"200 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Headers":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empty"}}}}}}},"/financialsummaries/pettycash":{"get":{"parameters":[{"name":"date_from","in":"query","schema":{"type":"string"}},{"name":"date_to","in":"query","schema":{"type":"string"}},{"name":"page_size","in":"query","schema":{"type":"string"}},{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"page_number","in":"query","schema":{"type":"string"}},{"name":"store_ids","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"200 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PettyCashSummaryResponse"}}}},"400":{"description":"400 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}},"403":{"description":"403 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}},"429":{"description":"429 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{}}},"security":[{"api_key":[]}]},"options":{"responses":{"200":{"description":"200 response","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Headers":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empty"}}}}}}}},"components":{"schemas":{"SupplierCredit":{"type":"object","properties":{"store_id":{"title":"Store ID","type":"string","description":"The ID of the store"},"date":{"title":"Date","type":"string","description":"The date the supplier credit was received"},"supplier_credit_note_date":{"title":"Supplier Credit Note Date","type":"string","description":"The supplier credit note date"},"credit_note_lines":{"type":"array","description":"A list of items in supplier credit","items":{"$ref":"#/components/schemas/CreditNoteLine"}},"credit_note_id":{"title":"Id","type":"string","description":"The id of the credit note"},"supplier_reference":{"title":"The supplier reference","type":"string","description":"The supplier reference"},"supplier_return_id":{"title":"Supplier Return Id","type":"integer","description":"The id of the supplier return"},"supplier_id":{"title":"Supplier Id","type":"string","description":"The ID of the supplier within this system"}},"description":"A supplier credit"},"PageSize":{"title":"Page Size","type":"integer","description":"The maximum number of records in a single page"},"CashVarianceSummary":{"title":"Cash Variance Summary","type":"object","properties":{"date":{"title":"Date","type":"string","description":"The date of the summary","format":"date"},"store_id":{"title":"Store ID","type":"string","description":"The ID of the store within this system"},"amount":{"title":"Amount","type":"number","description":"The value of cash variance","format":"double"},"payment_method_id":{"title":"Payment Method ID","type":"string","description":"The ID of the payment method within this system"},"transaction_type":{"title":"Transaction Type","type":"string","description":"The ID of the transaction type within this system"}},"description":"A summary of cash variances for a given store on a given date"},"StockAdjustmentSummary":{"title":"Stock Adjustment Summary","type":"object","properties":{"date":{"title":"Date","type":"string","description":"The date of the summary","format":"date"},"store_id":{"title":"Store ID","type":"string","description":"The ID of the store within this system"},"amount":{"title":"Amount","type":"number","description":"The cost of the stock adjustment","format":"double"},"transaction_type":{"title":"Transaction Type","type":"string","description":"The ID of the transaction type within this system"}},"description":"A summary of stock adjustments for a given store on a given date"},"Store":{"type":"object","properties":{"country":{"title":"Country","type":"string","description":"The country of the address"},"last_modified_on":{"$ref":"#/components/schemas/LastModifiedOn"},"email_address":{"title":"Email Address","type":"string","description":"The email address of the store"},"post_code":{"title":"Postcode","type":"string","description":"The postcode of the address"},"external_reference":{"title":"External Reference","type":"string","description":"An external reference given to the store for external systems"},"timezone_id":{"title":"Timezone Identifier","type":"string","description":"The timezone identifier for the store"},"address_line_1":{"title":"Address Line 1","type":"string","description":"The first line of the address"},"name":{"title":"Name","type":"string","description":"The name of the store"},"suburb":{"title":"Suburb","type":"string","description":"The suburb of the address"},"phone_number":{"title":"Phone Number","type":"string","description":"The phone number of the store"},"address_line_2":{"title":"Address Line 2","type":"string","description":"The second line of the address"},"state":{"title":"State","type":"string","description":"The state of the address"},"id":{"title":"ID","type":"string","description":"The ID of the store"}},"description":"A retail store/outlet"},"LastModifiedOn":{"title":"Last Modified On","type":"string","description":"The date and time the record was last modified","format":"date-time"},"PurchaseOrderLine":{"type":"object","properties":{"amount_tax":{"title":"Amount Tax","type":"number","description":"The tax chargeable on the cost of the purchase order"},"amount_inclusive":{"title":"Amount Inclusive","type":"number","description":"The cost of the purchase order, inclusive of tax"},"amount_exclusive":{"title":"Amount Exclusive","type":"number","description":"The cost of the purchase order, exclusive of tax"},"transaction_type":{"title":"Transaction Type","type":"string","description":"The type of purchase order"}},"description":"A purchase order"},"Empty":{"type":"object"},"SupplierInvoiceLine":{"type":"object","properties":{"amount_tax":{"title":"Amount Tax","type":"number","description":"The tax chargeable on the cost of the supplier invoice"},"amount_inclusive":{"title":"Amount Inclusive","type":"number","description":"The cost of the supplier invoice, inclusive of tax"},"amount_exclusive":{"title":"Amount Exclusive","type":"number","description":"The cost of the supplier invoice, exclusive of tax"},"transaction_type":{"title":"Transaction Type","type":"string","description":"The type of supplier invoice"}},"description":"A supplier invoice"},"PaymentSummary":{"title":"Payment Summary","type":"object","properties":{"store_id":{"title":"Store ID","type":"string","description":"The ID of the store within this system"},"reference":{"title":"Reference","type":"string","description":"the reference for the payment"},"date":{"title":"Date","type":"string","description":"The date of the summary","format":"date"},"amount":{"title":"Amount","type":"number","description":"The amount of the payment"},"payment_method_id":{"title":"Payment Method ID","type":"string","description":"The ID of the payment method within this system"},"id":{"title":"ID","type":"string","description":"The ID of the record"},"transaction_type":{"title":"Transaction Type","type":"string","description":"The ID of the transaction type within this system"},"payment_date":{"title":"Payment Date","type":"string","description":"The payment date of the payment","format":"date"}},"description":"A summary of payments"},"ContactDetails":{"title":"Contact Details","type":"object","properties":{"country":{"title":"Country","type":"string","description":"The address country"},"postcode":{"title":"Postcode","type":"string","description":"The address postcode"},"last_name":{"title":"Last Name","type":"string","description":"The last name of the contact"},"fax_number":{"title":"Fax number","type":"string","description":"The fax number of the contact"},"email_address":{"title":"Email Address","type":"string","description":"The email address of the contact"},"company_name":{"title":"Company Name","type":"string","description":"The company name of the contact"},"address_line_1":{"title":"Address Line 1","type":"string","description":"The first line of the address"},"suburb":{"title":"Suburb","type":"string","description":"The address suburb"},"phone_number":{"title":"Phone number","type":"string","description":"The phone number of the contact"},"address_line_3":{"title":"Address Line 3","type":"string","description":"The third line of the address"},"address_line_2":{"title":"Address Line 2","type":"string","description":"The second line of the address"},"state":{"title":"State","type":"string","description":"The address state"},"mobile_number":{"title":"Mobile number","type":"string","description":"The mobile number of the contact"},"first_name":{"title":"First Name","type":"string","description":"The first name of the contact"},"address_line_4":{"title":"Address Line 4","type":"string","description":"The fourth line of the address"}},"description":"Contact details for an entity"},"PageNumber":{"title":"Page Number","type":"integer","description":"The current page number"},"PaymentType":{"type":"object","properties":{"is_enabled":{"title":"IsEnabled","type":"boolean","description":"A flag indicating if the payment method is enabled"},"last_modified_on":{"title":"Last Modified On","type":"string","description":"The date the payment type was last modified","format":"date-time"},"summarised_for_accounting":{"title":"IsSummarised","type":"boolean","description":"A flag indicating if the payment method is summarised for accounting purposes"},"name":{"title":"Name","type":"string","description":"The name of the payment type"},"id":{"title":"ID","type":"string","description":"The ID of the payment type"}},"description":"A payment type"},"TotalRecords":{"title":"Total Record Count","type":"integer","description":"The total number of records in your query"},"Supplier":{"type":"object","properties":{"code":{"title":"Code","type":"string","description":"The reference for the supplier"},"order_email_address":{"title":"Order Email Address","type":"string","description":"The email address for purchase orders to be sent to"},"last_modified_on":{"$ref":"#/components/schemas/LastModifiedOn"},"name":{"title":"Name","type":"string","description":"The name of the supplier"},"contact_details":{"$ref":"#/components/schemas/ContactDetails"},"id":{"title":"ID","type":"string","description":"The id of the supplier"}},"description":"A supplier of merchandise"},"SupplierInvoice":{"type":"object","properties":{"supplier_invoice_lines":{"type":"array","description":"A list of items in supplier invoice","items":{"$ref":"#/components/schemas/SupplierInvoiceLine"}},"store_id":{"title":"Store ID","type":"string","description":"The ID of the store"},"date":{"title":"Date","type":"string","description":"The date the supplier invoice was received"},"supplier_invoice_id":{"title":"Id","type":"integer","description":"The id of the supplier invoice"},"purchase_order_id":{"title":"Purchase Order Id","type":"string","description":"The id of the purchase order"},"supplier_invoice_number":{"title":"Supplier Invoice Number","type":"string","description":"The supplier invoice number"},"supplier_id":{"title":"Supplier Id","type":"string","description":"The ID of the supplier within this system"},"supplier_invoice_date":{"title":"Supplier Invoice Date","type":"string","description":"The supplier invoice date"}},"description":"A supplier invoice"},"PaymentSummaryResponse":{"title":"Payment Summary Response","type":"object","properties":{"summary_lines":{"type":"array","description":"A list of payments summaries","items":{"$ref":"#/components/schemas/PaymentSummary"}},"page_number":{"$ref":"#/components/schemas/PageNumber"},"total_records":{"$ref":"#/components/schemas/TotalRecords"},"total_pages":{"$ref":"#/components/schemas/TotalPages"},"page_size":{"$ref":"#/components/schemas/PageSize"}}},"CashVarianceSummaryResponse":{"title":"Cash Variance Summary Response","type":"object","properties":{"summary_lines":{"type":"array","description":"A list of cash variance summary records","items":{"$ref":"#/components/schemas/CashVarianceSummary"}},"page_number":{"$ref":"#/components/schemas/PageNumber"},"total_records":{"$ref":"#/components/schemas/TotalRecords"},"total_pages":{"$ref":"#/components/schemas/TotalPages"},"page_size":{"$ref":"#/components/schemas/PageSize"}}},"PettyCashSummaryResponse":{"title":"Petty Cash Summary Response","type":"object","properties":{"summary_lines":{"type":"array","description":"A list of POS money in and out summary records","items":{"$ref":"#/components/schemas/PettyCashSummary"}},"page_number":{"$ref":"#/components/schemas/PageNumber"},"total_records":{"$ref":"#/components/schemas/TotalRecords"},"total_pages":{"$ref":"#/components/schemas/TotalPages"},"page_size":{"$ref":"#/components/schemas/PageSize"}}},"SalesSummaryResponse":{"title":"Sales Summary Response","type":"object","properties":{"summary_lines":{"type":"array","description":"A list of sales summaries","items":{"$ref":"#/components/schemas/SalesSummary"}},"page_number":{"$ref":"#/components/schemas/PageNumber"},"total_records":{"$ref":"#/components/schemas/TotalRecords"},"total_pages":{"$ref":"#/components/schemas/TotalPages"},"page_size":{"$ref":"#/components/schemas/PageSize"}}},"TotalPages":{"title":"Total Page Count","type":"integer","description":"The total number of pages in your query"},"PettyCashSummary":{"title":"Petty Cash Summary","type":"object","properties":{"date":{"title":"Date","type":"string","description":"The date of the summary","format":"date"},"store_id":{"title":"Store ID","type":"string","description":"The ID of the store within this system"},"amount":{"title":"Amount","type":"number","description":"The value of the petty cash (money in or out)","format":"double"},"transaction_type":{"title":"Transaction Type","type":"string","description":"The ID of the transaction type within this system"}},"description":"A summary of POS money in and out for a given store on a given date"},"StockAdjustmentSummaryResponse":{"title":"Stock Adjustment Summary Response","type":"object","properties":{"summary_lines":{"type":"array","description":"A list of stock adjustment summary records","items":{"$ref":"#/components/schemas/StockAdjustmentSummary"}},"page_number":{"$ref":"#/components/schemas/PageNumber"},"total_records":{"$ref":"#/components/schemas/TotalRecords"},"total_pages":{"$ref":"#/components/schemas/TotalPages"},"page_size":{"$ref":"#/components/schemas/PageSize"}}},"StockTransferSummary":{"title":"Stock Transfer Summary","type":"object","properties":{"date":{"title":"Date","type":"string","description":"The date of the summary","format":"date"},"store_id":{"title":"Store ID","type":"string","description":"The ID of the store within this system"},"amount_tax":{"title":"Amount Tax","type":"number","description":"The tax chargeable on the cost of goods being transferred"},"transfer_type_id":{"title":"Transfer Type","type":"string","description":"The type of transfer"},"amount_inclusive":{"title":"Amount Inclusive","type":"number","description":"The cost of goods being transferred, inclusive of tax"},"amount_exclusive":{"title":"Amount Exclusive","type":"number","description":"The cost of goods being transferred, exclusive of tax"},"transfer_id":{"title":"Transfer Id","type":"string","description":"Empty for summaries"},"transaction_type":{"title":"Transaction Type","type":"string","description":"The ID of the transaction type within this system"},"direction":{"title":"Transfer Direction","type":"string","description":"The direction of the transfer"}},"description":"A summary of stock transfers for a given store on a given date"},"SupplierListResponse":{"title":"Supplier List Response","type":"object","properties":{"page_number":{"$ref":"#/components/schemas/PageNumber"},"suppliers":{"type":"array","description":"A list of suppliers","items":{"$ref":"#/components/schemas/Supplier"}},"total_records":{"$ref":"#/components/schemas/TotalRecords"},"total_pages":{"$ref":"#/components/schemas/TotalPages"},"page_size":{"$ref":"#/components/schemas/PageSize"}}},"SupplierCreditListResponse":{"type":"object","properties":{"page_number":{"$ref":"#/components/schemas/PageNumber"},"total_records":{"$ref":"#/components/schemas/TotalRecords"},"total_pages":{"$ref":"#/components/schemas/TotalPages"},"supplier_credits":{"type":"array","description":"A list of supplier credits","items":{"$ref":"#/components/schemas/SupplierCredit"}},"page_size":{"$ref":"#/components/schemas/PageSize"}}},"PaymentTypeListResponse":{"type":"object","properties":{"page_number":{"$ref":"#/components/schemas/PageNumber"},"total_records":{"$ref":"#/components/schemas/TotalRecords"},"total_pages":{"$ref":"#/components/schemas/TotalPages"},"payment_types":{"type":"array","description":"A list of payment types","items":{"$ref":"#/components/schemas/PaymentType"}},"page_size":{"$ref":"#/components/schemas/PageSize"}}},"SalesSummary":{"title":"Sales Summary","type":"object","properties":{"store_id":{"title":"Store ID","type":"string","description":"The ID of the store within this system"},"date":{"title":"Date","type":"string","description":"The date of the summary","format":"date"},"tax_type_id":{"title":"Tax Type ID","type":"string","description":"The ID of the tax type within this system"},"amount_tax":{"title":"Amount Tax","type":"number","description":"The tax chargeable on the transaction"},"amount_inclusive":{"title":"Amount Inclusive","type":"number","description":"The value of the transaction, inclusive of tax"},"id":{"title":"ID","type":"string","description":"The ID of the sales summary record"},"amount_exclusive":{"title":"Amount Exclusive","type":"number","description":"The value of the transaction, exclusive of tax"},"transaction_type":{"title":"Transaction Type","type":"string","description":"The ID of the transaction type within this system"}},"description":"A summary of sales data for a given store on a given date"},"CreditNoteLine":{"type":"object","properties":{"amount_tax":{"title":"Amount Tax","type":"number","description":"The tax chargeable on the cost of the supplier credit"},"amount_inclusive":{"title":"Amount Inclusive","type":"number","description":"The cost of the supplier credit, inclusive of tax"},"amount_exclusive":{"title":"Amount Exclusive","type":"number","description":"The cost of the supplier credit, exclusive of tax"},"transaction_type":{"title":"Transaction Type","type":"string","description":"The type of supplier credit"}},"description":"A supplier credit"},"PurchaseOrderListResponse":{"type":"object","properties":{"page_number":{"$ref":"#/components/schemas/PageNumber"},"purchase_orders":{"type":"array","description":"A list of purchase orders","items":{"$ref":"#/components/schemas/PurchaseOrder"}},"total_records":{"$ref":"#/components/schemas/TotalRecords"},"total_pages":{"$ref":"#/components/schemas/TotalPages"},"page_size":{"$ref":"#/components/schemas/PageSize"}}},"PurchaseOrder":{"type":"object","properties":{"store_id":{"title":"Store ID","type":"string","description":"The ID of the store that the purchase order is for"},"date":{"title":"Date","type":"string","description":"The date the purchase order was received"},"purchase_order_id":{"title":"Id","type":"string","description":"The id of the purchase order"},"supplier_invoice_number":{"title":"Supplier Invoice Number","type":"string","description":"The supplier invoice reference"},"supplier_id":{"title":"Supplier Id","type":"string","description":"The ID of the supplier within this system"},"purchase_order_lines":{"type":"array","description":"A list of items in the purchase order","items":{"$ref":"#/components/schemas/PurchaseOrderLine"}}},"description":"A purchase order"},"StockTransferSummaryResponse":{"title":"Stock Transfer Summary Response","type":"object","properties":{"summary_lines":{"type":"array","description":"A list of stock transfer summary records","items":{"$ref":"#/components/schemas/StockTransferSummary"}},"page_number":{"$ref":"#/components/schemas/PageNumber"},"total_records":{"$ref":"#/components/schemas/TotalRecords"},"total_pages":{"$ref":"#/components/schemas/TotalPages"},"page_size":{"$ref":"#/components/schemas/PageSize"}}},"SupplierInvoiceListResponse":{"type":"object","properties":{"supplier_invoices":{"type":"array","description":"A list of supplier invoices","items":{"$ref":"#/components/schemas/SupplierInvoice"}},"page_number":{"$ref":"#/components/schemas/PageNumber"},"total_records":{"$ref":"#/components/schemas/TotalRecords"},"total_pages":{"$ref":"#/components/schemas/TotalPages"},"page_size":{"$ref":"#/components/schemas/PageSize"}}},"StoreListResponse":{"title":"Store List Response","type":"object","properties":{"page_number":{"$ref":"#/components/schemas/PageNumber"},"stores":{"type":"array","description":"A list of stores","items":{"$ref":"#/components/schemas/Store"}},"total_records":{"$ref":"#/components/schemas/TotalRecords"},"total_pages":{"$ref":"#/components/schemas/TotalPages"},"page_size":{"$ref":"#/components/schemas/PageSize"}}}},"securitySchemes":{"api_key":{"type":"apiKey","name":"x-api-key","in":"header","x-amazon-apigateway-authtype":"custom"}}},"x-amazon-apigateway-security-policy":"TLS_1_0"}
```