openapi: 3.0.1 info: title: Reckon One API v1 description: 'A new generation, modular cloud accounting solution that scales with your business – perfect for startups.' version: '1.0' servers: - url: https://api.reckon.com/R1 paths: '/{cashbookId}/contacts/{contactId}/activate': post: tags: - core module - contacts summary: 02 Core > Contacts > Activate description: Activate an inactive contact. operationId: 5637e0e3fad2430fe08166c6 parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: contactId in: path description: '' required: true schema: type: string requestBody: description: The id of the contact from the Reckon One Book. content: application/json: example: f55efdf1-b77c-4624-94b0-07a026bbb2da responses: '200': description: You will get this response when the contact is successfully activated. '400': description: 'You will get this response if the JSON is not formed correctly, the data cannot be parsed by the existing contact or if you attempt to send a HTTP API call instead of HTTPS.' '401': description: You will get this response when the user does not have the ability to activate a contact '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookId}/contacts': post: tags: - contacts - core module summary: 02 Core > Contacts description: 'Create a contact. Note a contact in Reckon One can be a customer, supplier, employee or super fund. You mark it by choosing "true" for the contact type and a contact can be of multiple types' operationId: 5637e174fad2430fe08166c7 parameters: - name: cashbookId in: path description: '' required: true schema: type: string requestBody: description: This is the body to add a new contact to a Reckon One book. content: application/json: example: "{\nDescription:'Desc_47AE3208-87F5-4BBA-BE40-AA4130AB4768',\nSurnameBusinessName:'Name_Business',\nIsCustomer:true,\nIsSupplier:true,\nAddresses:\n[\n{AddressType:'Business',Line1:'addr1_bus',IsInternational:false},{AddressType:'Postal',Line1:'addr1_pos',IsInternational:true}\n]\n}" responses: '200': description: This is the response you will get if the contact was added to the book successfully. The GUID represents the id of the new contact within the Reckon One book. content: application/json: example: 2d8584cc-2e1e-44a3-89a1-3a76380023b9 '400': description: 'You will get this response if the JSON is not formed correctly, the data cannot be parsed by the existing payment or if you attempt to send a HTTP API call instead of HTTPS.' '401': description: You will get this response if the user does not have access to add contacts to the Reckon One book. '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues put: tags: - core module - contacts summary: 02 Core > Contacts description: Replace an existing contact. operationId: 5637e352fad2430fe08166cc parameters: - name: cashbookId in: path description: '' required: true schema: type: string requestBody: description: 'This is the body you send when updating a contact within the Reckon One book. ' content: application/json: example: "{\nContactId:'9AB5BA87-B4C0-43D0-A046-DB753C2B6FB7',\nDescription:'Desc_20150310_update',\nSurnameBusinessName:'Name_20150310_update',\nIsCustomer:true,\nIsSupplier:true,\nAddresses:[{AddressType:'Business',Line1:'addr1_bus_update',IsInternational:false},{AddressType:'Postal',Line1:'addr1_pos_update',IsInternational:true}]}" responses: '200': description: This is the response you get when the contact is succesfully updated. '400': description: 'This response will be given when the JSON is not correct, the data cannot be parsed correctly for the existing contact and when you try to send a HTTP request instead of HTTPS.' '401': description: This response occurs when the user is not authorised to edit the contact '500': description: This response is returned when a error occurs on our end. If this continues to occur please email reckonapi@reckon.com get: tags: - contacts - core module summary: 02 Core > Contacts description: 'Retrieve information about a contact. Note a contact in Reckon One can be a customer, supplier, employee or super fund' operationId: 5637e645fad2430fe08166d3 parameters: - name: cashbookId in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the request to retrieve the contacts list was successful content: application/json: example: ContactId: 01344311-de36-41af-98c9-4e70ab6f19e0 CashbookId: c1b3da90-e9df-4d57-8cfb-71a1d7bfe401 PaymentTermId: CustomerCreditLimit: Description: Brendon Green FirstNameBranchName: Brendo SurnameBusinessName: Gree IsCustomer: true IsSupplier: true IsActive: false IsPerson: true Email: test@test.com Website: http://www.google.com BusinessNumber1: '123456789' Notes: test AreaCode: PhoneNumber: FaxCode: FaxNumber: '123456789' IsBusinessAddressDifferent: false IsEmployee: false Addresses: - AddressId: f01d1e4d-34c5-4e0c-90a5-44ce8999d4a8 Line1: 7 The Glen123 Line2: Town: Suburb: Bordrton123 State: ACT Postcode: '1234' Country: AddressType: Business IsInternational: false - AddressId: 8f82e484-7583-40cd-a93d-22de5f23e1ac Line1: 7 The Glen Line2: Line3: '' Town: Suburb: Borderton State: SA Postcode: Country: AddressType: Postal IsInternational: true LastModifiedDate: '2018-09-25T11:11:16.9130000+00:00' '400': description: You will get this response when you send a HTTP instead of HTTPS request '401': description: You will get this error when the user is not authorised to see the contacst list '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookId}/journals': post: tags: - core module - journals summary: 02 Core > Journals description: Create a journal. operationId: 5637e1d9fad2430fe08166c8 parameters: - name: cashbookId in: path description: '' required: true schema: type: string requestBody: description: ' ' content: application/json: example: "{AmountTaxStatus: 1,\nJournalStatus:2,\nJournalNumber:'668',\nSummary:'API_Test',\nJournalDate:'08/31/2018',\nTransactions: [{AccountingCategoryId:'843e9b3f-40ab-48c3-a9eb-290861de1f81',Debit:10.00},{AccountingCategoryId:'843e9b3f-40ab-48c3-a9eb-290861de1f81',Credit:10.00}\n]\n}" responses: '200': description: You will get this response when the journal is added to the book successfully content: application/json: example: eab3b12e-bbe3-4d87-8d6b-b410a4a171fa '400': description: 'You will get this response if the JSON is not formed correctly, the data cannot be parsed or if you attempt to send a HTTP API call instead of HTTPS.' '401': description: You will get this response if the user is not authorised to add a journal '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues put: tags: - core module - journals summary: 02 Core > Journals description: Update an existing journal. operationId: 5637e3a8fad2430fe08166cd parameters: - name: cashbookId in: path description: '' required: true schema: type: string requestBody: description: The journal edited request body content: application/json: example: "{\nJournalId:'E26E5FB6-6C78-4615-8DCA-4FEFF2B15E41',\nAmountTaxStatus: 2,\nJournalStatus: 2,\nJournalNumber:'004',\nSummary:'Simon_Test_update',\nJournalDate:'11/03/2015',\nTransactions: [{AccountingCategoryId:'66AB5A2E-4BB5-41F9-AE90-F27911A3B7CD',Debit:0.00},{AccountingCategoryId:'66AB5A2E-4BB5-41F9-AE90-F27911A3B7CD',Debit:0.00}]\n}" responses: '200': description: You will get this response if the Journal was successfully updated. '400': description: 'You will get this response if the JSON is not formed correctly, the data cannot be parsed by the existing journal or if you attempt to send a HTTP API call instead of HTTPS' '401': description: You will get this response if not authorised to edit the requested journal '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues get: tags: - core module - journals summary: 02 Core > Journals description: Retrieve the list of journals. operationId: 5637e69afad2430fe08166d5 parameters: - name: cashbookId in: path description: '' required: true schema: type: string responses: '200': description: "You will get this response when the retrieval of journals is successful. To translate the data in the response such as accounts, you will need to retrieve the GUIDs of those items from other endpoints first.\n" content: application/json: example: AdjustingJournal: false AmountTaxStatus: 1 CashbookId: b610be5f-0d47-4f76-b2f9-042eaec26356 FullDescription: JournalDate: '2015-11-03T00:00:00.0000000+00:00' JournalId: 292ed2fc-0210-45fd-b4e6-e2edb99c4bdd JournalNumber: '00006' JournalStatus: 2 JournalType: 0 JournalTypeRefId: 00000000-0000-0000-0000-000000000000 ReversedJournalId: 00000000-0000-0000-0000-000000000000 Summary: Simon_Test Transactions: - AccountingCategoryId: 66ab5a2e-4bb5-41f9-ae90-f27911a3b7cd Billable: false ContactId: 00000000-0000-0000-0000-000000000000 Credit: Debit: 0 IsReconciled: false JournalEntryId: 405bde34-c3fe-456c-bca3-2718e942d392 JournalId: 292ed2fc-0210-45fd-b4e6-e2edb99c4bdd Narration: ProjectId: 00000000-0000-0000-0000-000000000000 TaxAmount: TaxGroupId: 00000000-0000-0000-0000-000000000000 TaxModified: false TransType: 0 - AccountingCategoryId: 66ab5a2e-4bb5-41f9-ae90-f27911a3b7cd Billable: false ContactId: 00000000-0000-0000-0000-000000000000 Credit: Debit: 0 IsReconciled: false JournalEntryId: 886c89e6-73dc-4f59-964f-a858dc3992b7 JournalId: 292ed2fc-0210-45fd-b4e6-e2edb99c4bdd Narration: ProjectId: 00000000-0000-0000-0000-000000000000 TaxAmount: TaxGroupId: 00000000-0000-0000-0000-000000000000 TaxModified: false TransType: 0 '400': description: 'You will get this response if the JSON is not formed correctly, the data cannot be parsed by the existing payment or if you attempt to send a HTTP API call instead of HTTPS.' '401': description: You will get this response if the user is not authorised to view journals '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookId}/contacts/{contactId}/deactivate': post: tags: - core module - contacts summary: 02 Core > Contacts > Deactivate description: Deactivate an active contact. operationId: 5637e238fad2430fe08166c9 parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: contactId in: path description: '' required: true schema: type: string requestBody: description: The body of this call requires the GUID of the contact you wish to deactivate. content: application/json: example: d967dca7-6c9a-4652-a9d2-04bd736b30ba responses: '200': description: You will get this response if the contact was successfully deactivated '400': description: 'You will get this response if you send the API call to HTTP instead of HTTPS or if the JSON is not structured correctly. ' '401': description: You will get this response if the user is not authorised to deactivate the contact '500': description: You will get this response if an error occurs on our end. '/{cashbookId}/contacts/{contactId}': delete: tags: - contacts - core module summary: 02 Core > Contacts description: Delete a contact. operationId: 5637e2d3fad2430fe08166ca parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: contactId in: path description: '' required: true schema: type: string requestBody: description: The GUID in the body is the id of the contact you wish to delete content: application/json: example: f55efdf1-b77c-4624-94b0-07a026bbb2da responses: '200': description: This is the response you will get when the contact was deleted successfully. '400': description: 'This is the response you will get when the JSON is structured incorrectly, the data cannot be parsed or you send a HTTP instead of HTTPS request.' '401': description: This is the response you will get if the user is not authorised to delete a contact. '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues get: tags: - core module - contacts summary: 02 Core > Contacts By ID description: 'Retrieve information about a contact. Note a contact in Reckon One can be a customer, supplier, employee or super fund.' operationId: 5637e3eefad2430fe08166ce parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: contactId in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the contact was added successfully to the book content: application/json: example: 9AB5BA87-B4C0-43D0-A046-DB753C2B6FB7 '401': description: You will get this response if the user is not authorised to see the contacts list '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookId}/journals/{journalId}': delete: tags: - core module - journals summary: 02 Core > Journals description: Delete a specific journal. operationId: 5637e30bfad2430fe08166cb parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: journalId in: path description: '' required: true schema: type: string requestBody: description: The GUID in the body is the id of the journal transaction you wish to delete. For this to be successful the GUID must be a journal transaction and not any other type. content: application/json: example: d72be57a-5319-4cec-bba5-da6786d7bd39 responses: '200': description: You will get this response if the journal is successfully deleted '400': description: You will get this error if the JSON is not formed correctly or you attempt to send a HTTP not HTTPS request. '401': description: You will get this error if the user is not authorised to delete journals. '500': description: You will get this error if an error occurs on our end. If this continues please email reckonapi@reckon.com get: tags: - core module - journals summary: 02 Core > Journals By ID description: Retrieve a specific journal using its unique ID. operationId: 5637e446fad2430fe08166cf parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: journalId in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the journal is retrieved successfully content: application/json: example: AdjustingJournal: false AmountTaxStatus: 1 CashbookId: b610be5f-0d47-4f76-b2f9-042eaec26356 FullDescription: JournalDate: '2015-11-03T00:00:00.0000000+00:00' JournalId: 292ed2fc-0210-45fdb4e6-e2edb99c4bdd JournalNumber: '00006' JournalStatus: 2 JournalType: 0 JournalTypeRefId: 00000000-0000-0000-0000-000000000000 ReversedJournalId: 00000000-0000-0000-0000-000000000000 Summary: Simon_Test Transactions: - AccountingCategoryId: 66ab5a2e-4bb5-41f9-ae90-f27911a3b7cd Billable: false ContactId: 00000000-0000-0000-0000-000000000000 Credit: Debit: 0 IsReconciled: false JournalEntryId: 405bde34-c3fe-456c-bca3-2718e942d392 JournalId: 292ed2fc-0210-45fd-b4e6-e2edb99c4bdd Narration: ProjectId: 00000000-0000-0000-0000-000000000000 TaxAmount: TaxGroupId: 00000000-0000-0000-0000-000000000000 TaxModified: false TransType: 0 - AccountingCategoryId: 66ab5a2e-4bb5-41f9-ae90-f27911a3b7cd Billable: false ContactId: 00000000-0000-0000-0000-000000000000 Credit: Debit: 0 IsReconciled: false JournalEntryId: 886c89e6-73dc-4f59-964f-a858dc3992b7 JournalId: 292ed2fc-0210-45fd-b4e6-e2edb99c4bdd Narration: ProjectId: 00000000-0000-0000-0000-000000000000 TaxAmount: TaxGroupId: 00000000-0000-0000-0000-000000000000 TaxModified: false TransType: 0 '400': description: 'You will get this response if the JSON is not formed correctly, the data cannot be parsed by the existing payment or if you attempt to send a HTTP API call instead of HTTPS.' '401': description: You will get this response if the user is unauthorised to view the journal request. '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookId}/accounts': get: tags: - core module - chart of accounts summary: 02 Core > Accounts description: Retrieve the chart of accounts (aka general ledger) list. operationId: 5637e500fad2430fe08166d0 parameters: - name: cashbookId in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the accounts list is successfully retrieved content: application/json: example: Id: 01786fe1-ab30-4f12-b59a-706124ce041e Name: Bank Fees Description: Descrption of the account AccountType: 1 AccountStatus: 1 AccountCode: DefaultTaxCode: GST ParentAccountingCategoryId: 00000000-0000-0000-0000-000000000000 ExportCode: EC_20180222_143952 LastModifiedDate: '2018-02-22T14:39:05.0400000+00:00' '400': description: You will get this response if you send a HTTP instead of HTTPS request. '401': description: You will get this response if the user is not authorised to see the accounts list '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues post: tags: - chart of accounts - core module summary: 02 Core > Accounts description: "Create a general ledger account in the book's chart of accounts.\n\n" operationId: 56720b9ec500762c3cab1121 parameters: - name: cashbookId in: path description: '' required: true schema: type: string requestBody: description: The body that you send for the addition of an account to the book. content: application/json: example: " {\n AccountType:1,\n AccountName :'Income From Business',\n Hint :'This is my business account',\n Status:1, \n SortOrder :1,\n AccountCode: '1-1173',\n ParentAccountingCategoryID:'\n138b21e9-0738-4bc3-a462-47d092fcbeee'\n\t\t }" responses: '200': description: You will get this response when the account was successfully added. The guid in the response is the guid of the account just added. content: application/json: example: af593806-3245-4d5c-83d9-89f0dc0b054f '401': description: 'You will get this when the user is not authorised for either the book, or the ability to add accounts to the book.' '500': description: You will get this response if there is a error on our end. Please email apisupport@reckon.com if this continues put: tags: - core module - chart of accounts summary: 02 Core > Accounts description: Replace a general ledger account from the book's chart of accounts operationId: 56721157c500762c3cab1126 parameters: - name: cashbookId in: path description: '' required: true schema: type: string requestBody: description: 'This is a sample body for editing an existing chart of accounts ' content: application/json: example: "{ \n\t\t Id:'ad786ea5-a123-4889-bd49-01d2fd0d532d',\n AccountType:1,\n AccountName :'test_AccountName_peter_C2FE7DF0-EB8A-40F3-A237-5383DFD965F4',\n Hint :'test_Hint',\n Status:1, \n TaxGroupId :'D56763CA-EA2F-484A-B475-002779134965',\n SortOrder :1,\n AccountCode:'1-1162'\n\t\t }" responses: '200': description: You will get this response if the account was edited successfully '400': description: 'You will get this response if the JSON structure was incorrect, the data could not be parsed or you send a HTTP instead of HTTPS request.' '401': description: You will get this response if the user is not authorised to edit accounts '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookId}/invoices/{invoiceId}': get: tags: - invoices summary: 03 Invoices > Invoices by ID description: Retrieve an invoice by its unique ID. More information is returned to you when you search for an invoice by ID. operationId: 5637e542fad2430fe08166d1 parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: invoiceId in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the invoice is sucessfully retrieved by id content: application/json: example: "{\"AccountsReceivableCategoryId\":\"4139ec89-1ddd-4cd7-a530-76a4ff6eacab\",\n\"Allocations\":[],\n\"AmountTaxStatus\":3,\n\"InvoiceDiscountAmount\":null,\n\"InvoiceDiscountPercentage\":null,\n\"InvoiceTax\":211.1800,\n\"LineItems\":[{\"InvoiceId\":\"0c24e413-8171-4270-9f2c-3afbe7959e12\",\n\"ParentInvoiceLineItemId\":null,\n\"BillableId\":null,\n\"DiscountAmountExTax\":null,\n\"DiscountAmountTax\":null,\n\"DiscountAccuracy\":null,\n\"DiscountPercent\":null,\n\"Amount\":2111.82,\n\"AmountAccuracy\":null,\n\"InvoiceDiscountedAmountExTax\":2111.8200,\n\"InvoiceDiscountedTaxAmount\":211.1800,\n\"HasDataForPosting\":true,\n\"IsSubTotal\":false,\n\"IsParent\":false,\n\"IsHidden\":false,\n\"AccountId\":\"00000000-0000-0000-0000-000000000000\",\n\"PrintGroupAsSingleLine\":false,\n\"Id\":\"3dc737ad-1d5d-4ec0-a63d-7cca0449e85c\",\n\"ChargeableItemId\":\"1196aac4-8815-4ed1-ae65-b5d52f99348d\",\n\"LineNo\":1,\n\"Description\":null,\n\"Quantity\":null,\n\"ProjectId\":\"00000000-0000-0000-0000-000000000000\",\n\"UnitPriceExTax\":2111.8181818182,\n\"UnitPriceTax\":0.0,\n\"UnitPricePrecision\":2.0,\n\"UnitPriceIsTaxInclusive\":false,\n\"TaxGroupId\":\"416f8b10-78e2-4723-b73d-af4c96aced08\",\n\"TaxIsModified\":false,\n\"TaxAmount\":211.1800,\n\"AmountExTax\":2111.8182}],\n\"SendDate\":null,\"StatusId\":0,\n\"TemplateId\":\"e1dc388f-2525-4618-bd84-e5f8d5592d6a\",\n\"TermID\":\"00000000-0000-0000-0000-000000000000\",\n\"Address\":{\"AddressID\":\"00000000-0000-0000-0000-000000000000\",\n\"EntryNo\":0,\n\"Address1\": '123 Smith street',\n\"Address2\":null,\n\"Address3\":null,\n\"Suburb\": 'Sydney',\n\"State\": 'NSW\",\n\"Postcode\": 2077,\n\"Country\":null,\n\"IsInternational\":false,\n\"Town\":null}\n,\"PaymentDetails\":null,\n\"TaxSummaryText\":null,\n\"Id\":\"0c24e413-8171-4270-9f2c-3afbe7959e12\",\n\"CashbookID\":\"b610be5f-0d47-4f76-b2f9-042eaec26356\",\n\"InvoiceNumber\":\"INV0025\",\n\"InvoiceOrder\":0,\n\"Balance\":0.0,\n\"CustomerID\":\"715995b3-d1ea-487f-877c-eecb5c05cd62\",\n\"CustomerName\":\"Customer 1 Pty Ltd \",\n\"InvoiceAmount\":2323.0000,\n\"InvoiceDate\":\"2015-12-07T00:00:00+00:00\",\n\"DueDate\":\"2016-01-10T00:00:00+00:00\",\n\"Status\":2,\n\"Reference\": Invoice for oranges,\n\"Notes\":\"testing notes\",\n\"IsOverdue\":true}" '400': description: 'You will get this error if the JSON structure is incorrect, the data cannot be parsed or you send a HTTP instead of HTTPS request' '401': description: You will get this error if the user is not authorised to view the invoice '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues delete: tags: - invoices - invoices module summary: 03 Invoices > Invoices description: 'Delete a [customer] invoice by its unique ID.' operationId: 576b37eec5007610d8caff0a parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: invoiceId in: path description: '' required: true schema: type: string responses: '200': description: /cashbooks: get: tags: - global summary: 00 Cashbooks description: Retrieve a list of cashbook IDs that a user (username) can access. The cashbook ID is required in all API call URLs (excluding heartbeat). There is no body required as the user will be matched with their allowed books via our identity server. operationId: 5637e578fad2430fe08166d2 responses: '200': description: 'You will get this response if the request to retrieve the books list is correct ' content: application/json: example: BookId: b610be5f-0d47-4f76-b2f9-042eaec26356 BookName: 20160120 Report acceptance test Bookstatus: 3 Country: AU '400': description: You will get this error if you send a HTTP instead of HTTPS request '401': description: You will get this response if the user is not authorised to view a list of books. '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookId}/invoices': get: tags: - invoices summary: 03 Invoices > Invoices description: 'Retrieve the list of [customer] invoices.' operationId: 5637e67bfad2430fe08166d4 parameters: - name: cashbookId in: path description: '' required: true schema: type: string responses: '200': description: You will get this response when you successfully retrieve the invoices list content: application/json: example: "{\"Id\":\"0049290c-0482-428f-acc2-7d5d2b84f6cf\",\n\"CashbookID\":\"e17417ac-fc79-4d4d-9ee8-1780b3bc326f\",\n\"InvoiceNumber\":\"INV0319\",\n\"InvoiceOrder\":9,\n\"Balance\":2.0000,\n\"CustomerID\":\"9b4b615f-2815-4f9c-a765-d7f8517cea6a\",\n\"CustomerName\":\"Batman\",\n\"InvoiceAmount\":2.0000,\n\"InvoiceDate\":\"2015-09-17T00:00:00+00:00\",\n\"DueDate\":null,\n\"Status\":2,\n\"Reference\":null\n\"Notes\":null,\n\"IsOverdue\":false}" '400': description: You will get this response when you send a HTTP instead of HTTPS request. '401': description: You will get this response when the user is not authorised to see the invoices list '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues post: tags: - invoices - invoices module summary: 03 Invoices > Invoices description: 'Create a [customer] invoice.' operationId: 56f3356decc05f0c7498a37c parameters: - name: cashbookId in: path description: '' required: true schema: type: string requestBody: content: application/json: example: CustomerId: 9b4b615f-2815-4f9c-a765-d7f8517cea6a AmountTaxStatus: 2 InvoiceAmount: 2 InvoiceDiscountAmount: InvoiceDiscountPercentage: InvoiceTax: 0.18 Notes: PaymentDetails: Reference: TemplateId: 3edc5b6f-37aa-4516-8c1e-3cf268bf51e6 InvoiceDate: '2016-03-07T00:00:00.0000000+00:00' SendDate: DueDate: Address: TaxSummaryText: LineItems: - InvoiceId: 00000000-0000-0000-0000-000000000000 ParentInvoiceLineItemId: BillableId: DiscountAmountExTax: DiscountAmountTax: DiscountAccuracy: DiscountPercent: Amount: 2 AmountAccuracy: InvoiceDiscountedAmountExTax: 1.82 InvoiceDiscountedTaxAmount: 0.18 HasDataForPosting: true IsSubTotal: false IsParent: false IsHidden: false AccountId: 00000000-0000-0000-0000-000000000000 PrintGroupAsSingleLine: false ChargeableItemId: 8cd53f00-f6b9-4d6c-891d-83cc6a348e40 LineNo: 1 Description: SD Quantity: ProjectId: 00000000-0000-0000-0000-000000000000 UnitPriceExTax: 1.8181818182 UnitPriceTax: 0.1818181818 UnitPricePrecision: 2 UnitPriceIsTaxInclusive: false TaxGroupId: e6015088-28f5-4bfe-8085-ff9fc2564efa TaxIsModified: false TaxAmount: 0.18 AmountExTax: 1.8182 responses: '200': description: This is the response you will get when the invoice is posted successfully '400': description: 'This is the response you will get when there is a problem with the JSON structure, the data cannot be parsed or you send HTTP instead of HTTPS' '401': description: You will get this response when the user is not authorised to post a invoice '500': description: 'You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues ' '/{cashbookId}/projects': get: tags: - projects - projects module summary: 06 Projects > Projects description: Retrieve the list of projects. operationId: 5637e6e5fad2430fe08166d6 parameters: - name: cashbookId in: path description: '' required: true schema: type: string responses: '200': description: You will get this response when the request to get the projects list is successful content: application/json: example: ID: 0599ddc4-5f78-4d91-91bb-ecad0ece5530 Name: multi contact project Status: 0 '400': description: You will get this response if you send a HTTP call instead of HTTPS '401': description: You will get this response if the user is not authorised to see the projects list '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookId}/taxgroups/{effectiveDate}': get: tags: - tax - core module summary: 01 Core > Tax Groups description: "Read the list of tax groups from a book. Tax groups are required for endpoints such as accounts and item.\nEffective date is required as Reckon One has the ability to change the tax rate based on legislative changes without changing the tax code name. " operationId: 5637e721fad2430fe08166d7 parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: effectiveDate in: path description: '' required: true schema: type: string responses: '200': description: You will get this response when the request to retrieve the tax groups is successful content: application/json: example: "{\n \"ID\": \"7823bc0d-797f-4e2a-ae65-bcb7cd11d2c2\",\n \"Name\": \"FRE\",\n \"Rate\": 0,\n \"IsActive\": true,\n \"Description\": \"GST free sales\",\n \"TaxCodes\": [\n {\n \"UseCodeOnPurchases\": false,\n \"UseCodeOnSales\": true\n }\n ],\n \"UseOnPurchases\": false,\n \"UseOnSales\": true,\n \"TaxReportingLocations\": \"G1, G1, G3, G3\"\n },\n {\n \"ID\": \"8022e64c-1035-40d0-9e65-82b983dc490c\",\n \"Name\": \"GST\",\n \"Rate\": 10,\n \"IsActive\": true,\n \"Description\": \"GST on sales\",\n \"TaxCodes\": [\n {\n \"UseCodeOnPurchases\": false,\n \"UseCodeOnSales\": true\n }\n ],\n \"UseOnPurchases\": false,\n \"UseOnSales\": true,\n \"TaxReportingLocations\": \"1A, G1, G1\"\n}" '400': description: You will get this response when you send HTTP instead of HTTPS or you have not included a date within the API call. (eg 2015-10-21) '401': description: You will get this error if the user is not authorised to see the tax groups list '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues /heartbeat: get: tags: - global summary: 00 Heartbeat description: Ping this endpoint to determine if the service is available. No cashbook ID is required operationId: 5637e749fad2430fe08166d8 responses: '200': description: You will get this response if the service is available '404': description: You will get this response if the service is down '500': description: "You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues\n" '/{cashbookId}/payments': get: tags: - core module - payments summary: 02 Core > Payments description: Retrieve a list of payments (money out). operationId: 56720c1fc500762c3cab1122 parameters: - name: cashbookId in: path description: '' required: true schema: type: string responses: '200': description: You will get this response when the request to retrieve the payments list was successful. content: application/json: example: - Id: 1d0e4370-2783-42eb-9502-d9292dcd01f8 CashbookId: b610be5f-0d47-4f76-b2f9-042eaec26356 BankAccountId: e2616398-7c13-470b-90ff-1cf02efeed74 Amount: 1 ContactName: Customer 1 Details: abc PaymentMethodType: 1 PaymentMethodName: Cash IsReconciled: false Reference: def TransDate: '2016-10-10T00:00:00.0000000+00:00' '400': description: You will get this response if you send a HTTP instead of a HTTPS request. '401': description: You will get this response if the user is not authorised to see the payments list '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues post: tags: - payments - core module summary: 02 Core > Payments description: Create a payment (money out). operationId: 5677301fecc05f357c32dd20 parameters: - name: cashbookId in: path description: '' required: true schema: type: string requestBody: content: application/json: example: "\n\t {\n\t\t 'TransDate': '10/10/2015',\n\t\t 'BankAccountId': '5b3a4f48-beb0-4e23-bf2f-2d7127239a00',\n\t\t 'Amount': 100,\n\t\t 'ContactId': '519403ea-bd33-4b7c-b71a-cd32b8fbe2c8',\n\t\t 'AllocateFullAmount': false,\n\t\t 'PaymentMethodId': '057ecf9c-b966-4fe5-93e5-edc8812344b3',\n\t\t 'Details': 'abc',\n\t\t 'Reference': 'def',\n\t\t 'IsReconciled': false,\n\t\t 'Narration': 'qqq',\n\t\t 'Allocations': [],\n\t\t 'AllocationSplit':[\n\t\t\t{\n\t\t\t\t'ProjectId': '24879c21-8e1f-4f50-b1a0-bb01d3447b7b',\n\t\t\t\t'ChargeableItemId': 'af848ea8-cfdb-4768-a6f9-c916a873985f',\n\t\t\t\t'LineNo': 1,\n\t\t\t\t'Description': null,\n\t\t\t\t'Quantity': 0,\n\t\t\t\t'UnitPriceExTax': 10,\n\t\t\t\t'UnitPriceTax': 1,\n\t\t\t\t'UnitPricePrecision': 2,\n\t\t\t\t'DiscountAmountExTax': null,\n\t\t\t\t'DiscountAmountTax': null,\n\t\t\t\t'DiscountAccuracy': null,\n\t\t\t\t'DiscountPercent': null,\n\t\t\t\t'TaxGroupId': 'fae4ba18-20db-4b35-a944-711f7c3273bb',\n\t\t\t\t'TaxIsModified': false,\n\t\t\t\t'AmountExTax': 10,\n\t\t\t\t'Amount': 0,\n\t\t\t\t'TaxAmount': 1,\n\t\t\t\t'AmountAccuracy': null,\n\t\t\t\t'InvoiceDiscountedAmountExTax': null,\n\t\t\t\t'InvoiceDiscountedTaxAmount': null,\n\t\t\t\t'HasDataForPosting': false,\n\t\t\t\t'IsSubTotal': false,\n\t\t\t\t'IsParent': false,\n\t\t\t\t'AccountId': '00000000-0000-0000-0000-000000000000'\n\t\t\t}\n\t\t ]\n }" responses: '200': description: You will get this response if you successfully post a payment. The GUID in the response is the unique id of the payment in the book content: application/json: example: cf2e701f-3e56-4bdf-b3f1-fed7852fcc08 '400': description: 'You will get this response if the JSON structure is incorrect, the data cannot be parsed or you send HTTP instead of HTTPS' '401': description: You will get this response if the user is not authorised to post a payment '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues put: tags: - core module - payments summary: 02 Core > Payments description: Update an existing payment (money out). operationId: 56773467c500760744fccda3 parameters: - name: cashbookId in: path description: '' required: true schema: type: string requestBody: description: 'This is an example of the body you send when editing an existing payment. To get the GUIDs of the information required, use the other end points first. For example if you need to know the GUID of an account, use the accounts endpoint to get that information.' content: application/json: example: "\n\t {\n\t\t 'Id':'f998eabe-550f-449b-87ec-278c7dc044ae',\n\t\t 'TransDate': '10/10/2015',\n\t\t 'BankAccountId': '5b3a4f48-beb0-4e23-bf2f-2d7127239a00',\n\t\t 'Amount': 100,\n\t\t 'ContactId': '519403ea-bd33-4b7c-b71a-cd32b8fbe2c8',\n\t\t 'AllocateFullAmount': false,\n\t\t 'PaymentMethodId': '057ecf9c-b966-4fe5-93e5-edc8812344b3',\n\t\t 'Details': 'azp_test_abc',\n\t\t 'Reference': 'azp_test_def',\n\t\t 'IsReconciled': false,\n\t\t 'Narration': 'azp_test',\n\t\t 'Allocations': [],\n\t\t 'AllocationSplit':[\n\t\t\t{\n\t\t\t\t'ProjectId': '24879c21-8e1f-4f50-b1a0-bb01d3447b7b',\n\t\t\t\t'ChargeableItemId': 'af848ea8-cfdb-4768-a6f9-c916a873985f',\n\t\t\t\t'LineNo': 1,\n\t\t\t\t'Description': null,\n\t\t\t\t'Quantity': 0,\n\t\t\t\t'UnitPriceExTax': 10,\n\t\t\t\t'UnitPriceTax': 1,\n\t\t\t\t'UnitPricePrecision': 2,\n\t\t\t\t'DiscountAmountExTax': null,\n\t\t\t\t'DiscountAmountTax': null,\n\t\t\t\t'DiscountAccuracy': null,\n\t\t\t\t'DiscountPercent': null,\n\t\t\t\t'TaxGroupId': 'fae4ba18-20db-4b35-a944-711f7c3273bb',\n\t\t\t\t'TaxIsModified': false,\n\t\t\t\t'AmountExTax': 10,\n\t\t\t\t'Amount': 0,\n\t\t\t\t'TaxAmount': 1,\n\t\t\t\t'AmountAccuracy': null,\n\t\t\t\t'InvoiceDiscountedAmountExTax': null,\n\t\t\t\t'InvoiceDiscountedTaxAmount': null,\n\t\t\t\t'HasDataForPosting': false,\n\t\t\t\t'IsSubTotal': false,\n\t\t\t\t'IsParent': false,\n\t\t\t\t'AccountId': '00000000-0000-0000-0000-000000000000'\n\t\t\t}\n\t\t ]\n }" responses: '200': description: You will get this response if the payment was edited successfully. '401': description: You will get this response if the user is not authorised to edit payments '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '400': description: 'You will get this response if the JSON is not formed correctly, the data cannot be parsed by the existing payment or if you attempt to send a HTTP API call instead of HTTPS.' '/{cashbookId}/bankaccounts': get: tags: - core module - bank accounts summary: 02 Core > Bank Accounts description: Retrieve the list of bank accounts as per the chart of accounts UI. operationId: 56721249c500762c3cab1127 parameters: - name: cashbookId in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the request to get the bank account list was successful content: application/json: example: - BankAccountID: e2616398-7c13-470b-90ff-1cf02efeed74 Description: Cash IsBankAccountOpened: true IsCash: true '400': description: You will get this response if the JSON is not structured correctly or if you send a HTTP instead of a HTTPS request. '401': description: You will get this response if the user is not authorised to see the bank account list '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues post: tags: - core module - bank accounts - banking module summary: 02 Core > Bank Accounts description: This endpoint allows you to add a bank account to the Reckon One book specified in the API call operationId: 582b88bfecc05f118c0045cd parameters: - name: cashbookId in: path description: '' required: true schema: type: string requestBody: description: This is a sample JSON payload to add a bank account to the Reckon One book. content: application/json: example: AccountType: 1 BankAccountStatus: 1 Description: Bank Account IsBankAccountOpened: true IsCash: false LockOffDate: '0001-01-01T00:00:00.0000000+00:00' OpeningBalance: 100 EFT: AccountName: Account 1 EFT1: '123456' EFT2: '200' responses: '200': description: You'll get this response when the bank account is created successfully. The response will include the id of the bank account content: application/json: example: 1cef875a-b3f3-49c8-9ca8-8370efb6e148 '400': description: You will get this response if you send a HTTP instead of HTTPS request or there was something wrong in the payload that you posted '401': description: You will get this response if the user is not authorised or does not have access to the requested resource '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues put: tags: - bank accounts - core module - banking module summary: 02 Core > Bank Accounts operationId: 599531d2c5007613b8d16328 parameters: - name: cashbookId in: path description: '' required: true schema: type: string responses: '200': description: '/{cashbookid}/items/': get: tags: - items - core module summary: 02 Core > Items description: Retrieve the list of items. operationId: 56a0423ec500761654e3e3d7 parameters: - name: cashbookid in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the request to get the item list is successful content: application/json: example: Id: 026cedf5-7f0e-4cf2-889b-dd51bf760b78 Name: '4444' SalePrice: 4040 SalePriceTaxInclusive: true SaleTaxId: c01c1a45-60d6-4a36-85ac-222530fc7b3c SaleDescription: PurchasePrice: PurchasePriceTaxInclusive: true PurchaseTaxId: 00000000-0000-0000-0000-000000000000 PurchaseDescription: IsActive: true IsPurchased: false IsSold: true ItemCode: '4444' ParentChargeableItemID: 00000000-0000-0000-0000-000000000000 '400': description: You will get this response if you send HTTP instead of HTTPS '401': description: 'You will get this response if the user is not authorised ' '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookid}/items': post: tags: - core module - items summary: 02 Core > Items description: Create an item. operationId: 56a14e1becc05f08b04c1b0e parameters: - name: cashbookid in: path description: '' required: true schema: type: string requestBody: content: application/json: example: "{'ItemType':1,\n'Name':'Chocolate Nutella,\n'SalePrice':5,\n'SalePriceTaxInclusive':false,\n'SaleDescription':null,\n'PurchasePrice':null,\n'PurchasePriceTaxInclusive':false,\n'PurchaseTaxId':null,\n'PurchaseDescription':null,\n'FullName':null,\n'ProjectRateApplied':false,\n'IsActive':false,\n'IsPurchased':false,\n'IsSold':false,\n'SoldOrPurchased':1,\n'ItemCode':null,'ItemStatus':1,\n'SaleCategoryId':'7696ebf4-39d1-4a55-9ffe-0ebe135dc4b5',\n'IsTaxInclusive':false}" responses: '200': description: You will get this response if the Item has been added to the book successfully. The GUID is the unique id of the item in the book content: application/json: example: cf2e701f-3e56-4bdf-b2f1-fed7852fcc09 '400': description: 'You will get this response when the JSON structure is incorrect, the data cannot be parsed or you send HTTP instead of HTTPS' '401': description: You will get this error when the user does not have access to post a item '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues put: tags: - core module - items summary: 02 Core > Items description: Update an existing item. operationId: 56a151d4c500761654e3e3db parameters: - name: cashbookid in: path description: '' required: true schema: type: string responses: '200': description: This response is returned when the item has been updated successfully. '401': description: This response is returned when the user is not authorised to update the item. '400': description: 'This response is returned when the JSON is not structured correctly, the data cannot be parsed against the existing item or you attempt to send a HTTP command instead of HTTPS to this endpoint.' '500': description: This error is returned when there is a problem on our end. If this continues please email reckonapi@reckon.com '/{cashbookid}/projects': post: tags: - projects - projects module summary: 06 Projects > Projects description: Create a project. operationId: 56a14ea1c500761654e3e3d8 parameters: - name: cashbookid in: path description: '' required: true schema: type: string requestBody: content: application/json: example: Name: ’Building_2015’ StartDate: '2015-01-01' EndDate: '2015-02-01' Status: 0 Description: Shopping Centre ProjectItems: [ ] Contacts: [ ] ParentId: e52687e1-d598-4a32-b9ba-0f0370f5e94e responses: '200': description: You will get this response when a project is added to the book successfully. The GUID is the unique id of the project in the book. content: application/json: example: cf2e701f-3e56-4bdf-b2f1-fed7852fcc08 '400': description: 'You will get this response if the JSON structure is incorrect, the data cannot be parsed or you send HTTP instead of HTTPS' '401': description: You will get this response if the user is not authorised to post a project '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookid}/terms': get: tags: - terms - invoices module summary: 03 Invoices > Terms description: Retrieve the list of customer payments terms. operationId: 56a14ed4c500761654e3e3d9 parameters: - name: cashbookid in: path description: '' required: true schema: type: string responses: '200': description: You will get this response when the request to see the terms list is successful content: application/json: example: Id: 231e67f4-0862-4f3d-aa68-ea7cd6cf3ec9 Name: Day 20 of next month Description: 20th of the following month Type: 0 '400': description: You will get this response if you send HTTP instead of HTTPS '401': description: You will get this response if the user does not have access to the terms list '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookid}/receipts': get: tags: - receipts - core module summary: 02 Core > Receipts description: Retrieve a list of receipts (money in). operationId: 56a14fd5c500761654e3e3da parameters: - name: cashbookid in: path description: '' required: true schema: type: string responses: '200': description: You will get this response when the request to retrieve receipts is successful content: application/json: example: Id: 00b75d2f-cd16-4575-9610-c2d6dbcb90c8 CashbookId: e17417ac-fc79-4d4d-9ee8-1780b3bc326f BankAccountId: d6a8342d-b03d-4642-b73e-4e1c31526862 Amount: 220 ContactName: Batman Details: PaymentMethodType: 0 PaymentMethodName: IsReconciled: false Reference: TransDate: '2015-10-08T00:00:00.0000000+00:00' '400': description: You will get this response when you send HTTP instead of HTTPS '401': description: You will get this response when the user is not authorised to see the receipts list '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues post: tags: - receipts - core module summary: 02 Core > Receipts description: Create a receipt (money in). operationId: 56a1521fc500761654e3e3dd parameters: - name: cashbookid in: path description: '' required: true schema: type: string requestBody: content: application/json: example: "\n\t {\n\t\t 'TransDate': '10/10/2015',\n\t\t 'BankAccountId': '5b3a4f48-beb0-4e23-bf2f-2d7127239a00',\n\t\t 'Amount': 100,\n\t\t 'ContactId': '519403ea-bd33-4b7c-b71a-cd32b8fbe2c8',\n\t\t 'AllocateFullAmount': false,\n\t\t 'PaymentMethodId': '057ecf9c-b966-4fe5-93e5-edc8812344b3',\n\t\t 'Details': 'abc',\n\t\t 'Reference': 'def',\n\t\t 'IsReconciled': true,\n\t\t 'Narration': 'qqq',\n\t\t 'Allocations': [],\n\t\t 'AllocationSplit':[\n\t\t\t{\n\t\t\t\t'ProjectId': '24879c21-8e1f-4f50-b1a0-bb01d3447b7b',\n\t\t\t\t'ChargeableItemId': 'af848ea8-cfdb-4768-a6f9-c916a873985f',\n\t\t\t\t'LineNo': 1,\n\t\t\t\t'Description': null,\n\t\t\t\t'Quantity': 0,\n\t\t\t\t'UnitPriceExTax': 10,\n\t\t\t\t'UnitPriceTax': 1,\n\t\t\t\t'UnitPricePrecision': 2,\n\t\t\t\t'DiscountAmountExTax': null,\n\t\t\t\t'DiscountAmountTax': null,\n\t\t\t\t'DiscountAccuracy': null,\n\t\t\t\t'DiscountPercent': null,\n\t\t\t\t'TaxGroupId': 'fae4ba18-20db-4b35-a944-711f7c3273bb',\n\t\t\t\t'TaxIsModified': false,\n\t\t\t\t'AmountExTax': 10,\n\t\t\t\t'Amount': 0,\n\t\t\t\t'TaxAmount': 1,\n\t\t\t\t'AmountAccuracy': null,\n\t\t\t\t'InvoiceDiscountedAmountExTax': null,\n\t\t\t\t'InvoiceDiscountedTaxAmount': null,\n\t\t\t\t'HasDataForPosting': false,\n\t\t\t\t'IsSubTotal': false,\n\t\t\t\t'IsParent': false,\n\t\t\t\t'AccountId': '00000000-0000-0000-0000-000000000000'\n\t\t\t}\n\t\t ]\n }" responses: '200': description: You will get this response if the receipt is posted successfully to the book. The GUID is the unique id of the receipt in the book. content: application/json: example: cf2e701f-3e56-4bdf-b2f1-fed7852fcc08 '400': description: 'You will get this response if the JSON structure is incorrect, the data cannot be parsed or you send HTTP instead of HTTPS' '401': description: You will get this response if the user is not authorised to post a receipt '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues put: tags: - core module - receipts summary: 02 Core > Receipts operationId: 5a1ce19b6bc515375d1dd4ce parameters: - name: cashbookid in: path required: true schema: type: '' responses: '200': description: You will get this response if the requested API call was successful. '400': description: 'You will get this response if the JSON is not formed correctly, there''s something wrong with the request or if you attempt to send a HTTP API call instead of HTTPS.' '401': description: You will get this response if the user is not authorised to perform this request '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookId}/bills': get: tags: - invoices - bills summary: 03 Invoices>Bills description: 'Retrieve the list of the [supplier] bills.' operationId: 56f33510ecc05f0c7498a37a parameters: - name: cashbookId in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the bills list is succesfully retreived content: application/json: example: BillID: 318ee2e4-80f2-4c10-99ec-40cab080a46f AccountsPayableCategoryID: 5c2bcc7a-5da6-49e5-b6fa-a098856574a5 Balance: 0 BillAmount: 0 BillDate: '2016-01-13T00:00:00.0000000+00:00' BillNumber: BIL0035 CustomerID: 715995b3-d1ea-487f-877c-eecb5c05cd62 CustomerName: Customer 1 Notes: Reference: Status: 2 IsOverdue: false '400': description: You will get this error if you send a HTTP instead of HTTPS request '401': description: You will get this response if the user is not authorised to see the bills list '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues post: tags: - invoices module - bills summary: 03 Invoices > Bills description: 'Create a [supplier] bill.' operationId: 56f351e8ecc05f0c7498a37d parameters: - name: cashbookId in: path description: '' required: true schema: type: string requestBody: content: application/json: example: AccountsPayableAccountingCategoryId: 744d3fe1-fa28-4dab-8ad7-8577af04ed6f Address: AmountTaxStatus: 3 BillAmount: 0 BillDate: '2016-03-13T00:00:00.0000000+00:00' BillDiscount: BillDiscountAmount: BillDiscountPercentage: BillSourceId: 00000000-0000-0000-0000-000000000000 BillTax: 0 DueDate: LineItems: - AccountId: AccountingCategoryId: 744d3fe1-fa28-4dab-8ad7-8577af04ed6f Amount: 0 AmountExTax: 0 ChargeableItemId: 026cedf5-7f0e-4cf2-889b-dd51bf760b78 Description: DiscountAmountExTax: DiscountAmountTax: DiscountPercent: HasDataForPosting: true InvoiceDiscountedAmountExTax: 0 InvoiceDiscountedTaxAmount: IsHidden: false IsParent: false IsSubTotal: false LineNo: 1 PrintGroupAsSingleLine: false ProjectId: e52687e1-d598-4a32-b9ba-0f0370f5e94e Quantity: TaxAmount: TaxGroupId: TaxIsModified: false UnitPriceExTax: 0 UnitPricePrecision: 2 UnitPriceTax: 0 Notes: Reference: SendDate: Status: 1 SupplierId: 00bb3e7f-bf7d-4533-bb1c-57cfd3917817 TemplateId: 8d1717e4-cf39-46e3-b631-8edfeaf8da78 responses: '200': description: You will get this response if the bill was posted to the book successfully. The GUID in the response if this unique id of the transaction in the Reckon One book. content: application/json: example: 2095c169-cfb0-4a1a-936a-8a23b753420d '400': description: 'You will get this response if the JSON is not structured correctly, the data cannot be parsed or you send HTTP instead of HTTPS' '401': description: You will get this response if the user is not authorised to post a bill '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookId}/templates/{templateType}': get: tags: - core module - templates summary: 01 Core > Templates description: "Retrieve the template list.\nNote: The template type is either invoice or bill" operationId: 56f3353eecc05f0c7498a37b parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: templateType in: path description: '' required: true schema: enum: - invoice - bill type: string responses: '200': description: You will get this response when the template list is succesfully retrieved content: application/json: example: TemplateId: 850f82e3-a04b-4316-80a4-a914dbe734ec TemplateName: Products and Services Invoice TemplateNameDisplay: Description: Template containing products and services layout LogoName: 002maccas.jpg Options: 4294967295 Template: Type: 1 '400': description: You will get this error when you send a HTTP instead of HTTPS request or do not define the template type in the API call '401': description: You will get this response if the user does not have access to the templates list '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookId}/bills/{billId}': get: tags: - bills - invoices summary: 03 Invoices > Bills > Bills By ID description: Allows you to retrieve a single bill by its unique ID. operationId: 56fb08f7c500760af8df2b41 parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: billId in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the bill was successfully retrieved content: application/json: example: BillID: 318ee2e4-80f2-4c10-99ec-40cab080a46f AccountsPayableCategoryID: 5c2bcc7a-5da6-49e5-b6fa-a098856574a5 Balance: 0 BillAmount: 0 BillDate: '2016-01-13T00:00:00.0000000+00:00' BillNumber: BIL0035 CustomerID: 715995b3-d1ea-487f-877c-eecb5c05cd62 CustomerName: Customer 1 Notes: Reference: Status: 2 IsOverdue: false '400': description: You will get this response if you send a HTTP instead of HTTPS request. '401': description: You will get this response if the user is not authorised to see the bill '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues delete: tags: - bills - invoices module summary: 03 Invoices > Bills description: Deleting a bill id operationId: 03 Invoices Bills DELETE parameters: - name: cashbookId in: path description: Id of the cashbook required: true schema: type: GUID - name: billId in: path description: Id of the bill required: true schema: type: GUID responses: '200': description: '/{cashbookId}/reports/accountenquiry/false': post: tags: - reports summary: 80 Reports > Account Enquiry description: Retrieve all transactions from the book based on the parameters specified in the POST request. operationId: 5750efa2ecc05f12dcafe46e parameters: - name: cashbookId in: path description: '' required: true schema: type: string responses: '200': description: '/{cashbookId}/timesheets/summary': get: tags: - time & expenses module - timesheets summary: 07 Time and Expenses > Timesheets > Summary description: Retrieve a summary of the timesheets within the book. The intention is to retrieve the ID of the timesheet to then be able to use that to gather further information via the /timesheetId service. operationId: 577076faecc05f29a40a143c parameters: - name: cashbookId in: path description: '' required: true schema: type: string responses: '200': description: 'You will get this response when the list is successfully retrieved. If there is no data to be returned, a blank array will be the response.' content: application/json: example: '{"EntryId":"043aa1cf-1ce9-4133-8fc3-3887b8d50a12","Date":"2016-04-30T00:00:00+00:00","EmployeeId":"0663b11c-6a23-4e5c-89f9-b9100c4a1e21","CustomerName":"Cust 1","ChargeableItemName":"ItemSB1","ProjectName":null,"Note":"peter test api","Length":61,"Status":1,"Billable":false},{"EntryId":"1cb6bb89-b0e9-4dd9-bb59-9cd871b73608","Date":"2016-04-25T00:00:00+00:00","EmployeeId":"0663b11c-6a23-4e5c-89f9-b9100c4a1e21","CustomerName":"Cust 1","ChargeableItemName":"ItemSB1","ProjectName":null,"Note":null,"Length":60,"Status":1,"Billable":false}' '/{cashbookId}/timesheets/week/{employeeId}/{startDate}': get: tags: - timesheets - time & expenses module summary: 07 Time and Expenses > Timesheets > Timesheet by Employee ID and Start Date description: Retrieve a timesheet list for a specific employee ID with a specific starting date. operationId: 5770786bc500762e7420e2fd parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: employeeId in: path description: '' required: true schema: type: string - name: startDate in: path description: '' required: true schema: type: string responses: '200': description: '' '/{cashbookId}/timesheets/entry/{timesheetEntryId}': get: tags: - time & expenses module - timesheets summary: 07 Time and Expenses > Timesheets > Timesheet by ID description: Retrieve a specific timesheet by its ID. operationId: 577078e0c500762e7420e2fe parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: timesheetEntryId in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the timesheet is successfully retrieved. content: application/json: example: TimesheetEntryId: 043aa1cf-1ce9-4133-8fc3-3887b8d50a12 Date: '2016-04-30T00:00:00.0000000+00:00' ProjectId: 00000000-0000-0000-0000-000000000000 CustomerId: 3de468aa-becf-47e0-a769-d4300b74d93f ItemId: 3938d51f-e885-4e21-abb3-04cce93f1d3d Notes: peter test api Billable: false Status: 1 EmployeeId: 0663b11c-6a23-4e5c-89f9-b9100c4a1e21 CashbookId: 3e2cd4ab-9817-4e27-9e22-937c630ee8c9 EntryNo: 2118 ProjectName: CustomerName: Cust 1 ItemName: ItemSB1 EmployeeName: Employee 1 long text Employee 1 long text Employee 1 long text Employee 1 long text Employee 1 long Time: '2024-03-19' '/{cashbookId}/timesheets/summary/{employeeId}': get: tags: - timesheets - time & expenses module summary: 07 Time and Expenses > Timesheets > Summary by employee ID description: Retrieve the an employees timesheets by employee ID. operationId: 57707974c500762e7420e2ff parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: employeeId in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the list is retrieved successfully. content: application/json: example: '{"EntryId":"043aa1cf-1ce9-4133-8fc3-3887b8d50a12","Date":"2016-04-30T00:00:00+00:00","EmployeeId":"0663b11c-6a23-4e5c-89f9-b9100c4a1e21","CustomerName":"Cust 1","ChargeableItemName":"ItemSB1","ProjectName":null,"Note":"peter test api","Length":61,"Status":1,"Billable":false},{"EntryId":"1cb6bb89-b0e9-4dd9-bb59-9cd871b73608","Date":"2016-04-25T00:00:00+00:00","EmployeeId":"0663b11c-6a23-4e5c-89f9-b9100c4a1e21","CustomerName":"Cust 1","ChargeableItemName":"ItemSB1","ProjectName":null,"Note":null,"Length":60,"Status":1,"Billable":false}' '/{cashbookId}/timesheets/employee': get: tags: - time & expenses module - timesheets summary: 07 Time and Expenses > Timesheets > Employee description: Retrieve a list of the employees who have timesheets. operationId: 577079f2c500762e7420e300 parameters: - name: cashbookId in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the list is retrieved successfully content: application/json: example: - ID: 0663b11c-6a23-4e5c-89f9-b9100c4a1e21 Name: Employee 1 long text Employee 1 long text Employee 1 long text Employee 1 long text Employee 1 long - ID: 4dba3df8-6761-4669-97d4-f4c99171dfdf Name: Emp5 - ID: 9f07c5f2-41d8-4775-8dc2-725913d51f60 Name: Emp1 - ID: b65c776b-590e-4622-bec5-f4fb48e3ba8a Name: Emp3 - ID: e8cf644d-d774-4846-a2db-7cddd7d8c070 Name: Emp2 '/{cashbookId}/timesheets/entry': get: tags: - timesheets - time & expenses module summary: 07 Time and Expenses > Timesheets > Entry description: Retrieve the timesheets list within the book with more details than the summary endpoint. operationId: 57707b92c500762e7420e301 parameters: - name: cashbookId in: path description: '' required: true schema: type: string responses: '200': description: You will receive this response if the list is succesfully retrieved content: application/json: example: TimesheetEntryId: 043aa1cf-1ce9-4133-8fc3-3887b8d50a12 Date: '2016-04-30T00:00:00.0000000+00:00' ProjectId: 00000000-0000-0000-0000-000000000000 CustomerId: 3de468aa-becf-47e0-a769-d4300b74d93f ItemId: 3938d51f-e885-4e21-abb3-04cce93f1d3d Notes: peter test api Billable: false Status: 1 EmployeeId: 0663b11c-6a23-4e5c-89f9-b9100c4a1e21 CashbookId: 3e2cd4ab-9817-4e27-9e22-937c630ee8c9 EntryNo: 2118 ProjectName: CustomerName: Cust 1 ItemName: ItemSB1 EmployeeName: Employee 1 long text Employee 1 long text Employee 1 long text Employee 1 long text Employee 1 long Time: '2024-03-19' '/{cashbookId}/timesheets/week': post: tags: - time & expenses module - timesheets summary: 07 Time and Expenses > Timesheets (Weekly) description: Create a timesheet for a week. operationId: 57707c29c500762e7420e302 parameters: - name: cashbookId in: path description: '' required: true schema: type: string requestBody: content: application/json: example: EmployeeId: 91b66246-7ca1-410c-b44f-16c77ee8c9e1 StartDate: '2016-04-25' Timesheets: - ProjectId: 6f05c231-40f7-4e33-a065-d2e4e872ba00 CustomerId: 3de468aa-becf-47e0-a769-d4300b74d93f ItemId: 3938d51f-e885-4e21-abb3-04cce93f1d3d Billable: false Day1: '2024-03-19' Day2: '2024-03-19' Day3: '2024-03-19' Day4: '2024-03-19' Day5: '2024-03-19' Day6: Day7: responses: '200': description: 'You will get this response if the timesheets are posted successfully. You will receive an entry for each day of the week as this is a weekly view, even if that day had a null entry.' content: application/json: example: - DayOfWeek: Monday TimesheetId: fa87d473-9b0d-4ca2-8938-f8446f06320b - DayOfWeek: Tuesday TimesheetId: fac0280c-02da-49b3-8c09-c54ddc311c43 - DayOfWeek: Wednesday TimesheetId: 7a7a95f1-cca7-4578-9f76-3f271fb7c5bf - DayOfWeek: Thursday TimesheetId: e2463c23-0fde-428c-8e9e-d6cc62ec5579 - DayOfWeek: Friday TimesheetId: 80b5d656-dff8-40c4-9f05-edd7345f6e10 - DayOfWeek: Saturday TimesheetId: 00000000-0000-0000-0000-000000000000 - DayOfWeek: Sunday TimesheetId: 00000000-0000-0000-0000-000000000000 '/{cashbookId}/timesheets': post: tags: - timesheets - time & expenses module summary: 07 Time and Expenses > Timesheets > Timesheet (Single Day) description: Create a timesheet for a single day. operationId: 57707d07c500762e7420e303 parameters: - name: cashbookId in: path description: '' required: true schema: type: string requestBody: content: application/json: example: EmployeeId: f9b50bea-5f92-46a0-be02-2ba541f1860e Date: '2016-04-30' Entries: - TimesheetEntryId: 00000000-0000-0000-0000-000000000000 Date: '2016-04-30T00:00:00.0000000+00:00' ProjectId: 6f05c231-40f7-4e33-a065-d2e4e872ba00 CustomerId: 3de468aa-becf-47e0-a769-d4300b74d93f ItemId: 3938d51f-e885-4e21-abb3-04cce93f1d3d Notes: peter test api Time: '2024-03-19' Billable: false Status: 1 EmployeeId: f9b50bea-5f92-46a0-be02-2ba541f1860e CashbookId: 35ab8405-cf6f-4dc4-b703-1ccf40c5c234 EntryNo: 0 ProjectName: Proj 1 CustomerName: Cust 1 ItemName: ItemSB1 EmployeeName: William Tang - TimesheetEntryId: 00000000-0000-0000-0000-000000000000 Date: '2016-04-30T00:00:00.0000000+00:00' ProjectId: 6f05c231-40f7-4e33-a065-d2e4e872ba00 CustomerId: ffe17202-a350-42da-a054-8bb21afcc14f ItemId: 04883cea-874f-4f42-ab0e-d2736d87a503 Notes: peter test api Time: '2024-03-19' Billable: false Status: 1 EmployeeId: f9b50bea-5f92-46a0-be02-2ba541f1860e CashbookId: 35ab8405-cf6f-4dc4-b703-1ccf40c5c234 EntryNo: 0 ProjectName: Proj 1 CustomerName: CustSupplier 5 ItemName: ItemSB2 EmployeeName: William Tang responses: '200': description: You will get this resposne if the timesheets were posted successfully. The response is returned in a array and within the array a GUID is returned for each posted timesheet. They are in sequential order so the first GUID that appears in the array is for the first entry in the JSON post. content: application/json: example: - 1cb81ff5-0f24-46cd-bd84-267c4f75c1cc - bcbdcef7-5ff5-4f77-91a4-26417c496692 put: tags: - timesheets - time & expenses module summary: 07 Time and Expenses > Timesheets description: Replace an existing timesheet entry. operationId: 57707f36c500762e7420e305 parameters: - name: cashbookId in: path description: '' required: true schema: type: string requestBody: description: The timesheet data that should be edited is included in the body content: application/json: example: EmployeeId: f9b50bea-5f92-46a0-be02-2ba541f1860e Date: '2016-04-27' Entries: - TimesheetEntryId: c69be273-19eb-444a-9ed3-05afc725e8ad Date: '2016-04-27' ProjectId: 6f05c231-40f7-4e33-a065-d2e4e872ba00 CustomerId: ffe17202-a350-42da-a054-8bb21afcc14f ItemId: 9459cea5-0394-47a3-b9f5-9c2d9671dcac Notes: AZP TEST API UPDATE TS 2016-05-03 Time: '2024-03-19' Billable: false Status: 1 EmployeeId: f9b50bea-5f92-46a0-be02-2ba541f1860e CashbookId: 35ab8405-cf6f-4dc4-b703-1ccf40c5c234 EntryNo: 1845 ProjectName: Proj 1 CustomerName: CustSupplier 5 ItemName: sale only service EmployeeName: William Tang - TimesheetEntryId: 2133b62d-5dfb-4007-b3db-80ff31653f9e Date: '2016-04-27' ProjectId: 6f05c231-40f7-4e33-a065-d2e4e872ba00 CustomerId: 3de468aa-becf-47e0-a769-d4300b74d93f ItemId: 04883cea-874f-4f42-ab0e-d2736d87a503 Notes: Time: '2024-03-19' Billable: false Status: 1 EmployeeId: f9b50bea-5f92-46a0-be02-2ba541f1860e CashbookId: 35ab8405-cf6f-4dc4-b703-1ccf40c5c234 EntryNo: 1885 ProjectName: Proj 1 CustomerName: Cust 1 ItemName: ItemSB2 EmployeeName: William Tang responses: '200': description: You will get this response if the timesheet entires were successfully edited. '/{cashbookId}/timesheets/{timesheetId}': delete: tags: - time & expenses module - timesheets summary: 07 Time and Expenses > Timesheet by ID description: Delete a timesheet using a unique timesheet ID. operationId: 57707e79c500762e7420e304 parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: timesheetId in: path description: '' required: true schema: type: string requestBody: description: You post the id as part of the body for the timesheet that is to be deleted. content: application/json: example: 106ac0ab-12d1-4557-9e3c-035971eeb3e7 responses: '200': description: You will get this response if the timesheet was sucessfully deleted. There will be no response in the body. '400': description: You will get this response if the timesheet requested to be deleted is not found. content: application/json: example: Message: "No valid timesheet information found.\r\n" '/{cashbookId}/creditnotes': get: tags: - invoices - customer credit notes summary: 03 Invoices > Credit Notes description: Retrieve the credit notes (invoice adjustments) listing. operationId: 5770811cc500762e7420e306 parameters: - name: cashbookId in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the Credit notes list was retrieved successfully. content: application/json: example: Id: 1ba5cc26-8b9f-4f12-b4b5-9a2a2c5e6558 CashbookId: 0da93f9e-acb7-4bb0-b66d-a124e02dbe39 AccountsReceivableCategoryId: 9b3d07e5-0726-4bef-a12a-250315e36e95 Balance: 550 CreditNoteAmount: 550 CreditNoteDate: '2013-11-12T00:00:00.0000000+00:00' CreditNoteNumber: CAN0000 CustomerId: 58d15887-86e6-4aa7-b58c-998be4e22520 CustomerName: John Citizen Notes: Reference: Status: 2 '/{cashbookId}/creditnotes/{creditNoteId}': get: tags: - customer credit notes - invoices summary: 03 Invoices > Credit Notes by ID description: Retrieve customer credit notes (invoice adjustments) by their unique ID. operationId: 577081a6ecc05f29a40a143d parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: creditNoteId in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the credit note is successfully retrieved. '/{cashbookId}/bills/{billId}/approve': post: tags: - invoices module - bills summary: 03 Invoices > Bills > Approve description: Approve a draft bill by its unique ID. operationId: 5796b73eecc05f127c96cd97 parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: billId in: path description: '' required: true schema: type: string responses: '200': description: '/{cashbookid}/companyinfo': get: tags: - core module summary: 01 Core > Company Info description: This endpoint allows you to retrieve the Company Information of the Book you have requested API data from. operationId: 57a7c4d0ecc05f0dd8222619 parameters: - name: cashbookid in: path description: '' required: true schema: type: string responses: '200': description: This is the response you'll get once the request is successful. content: application/json: example: BranchNumber: '003' CashbookId: e673d490-4571-4a45-895m-8e0cbf11r8799 CompanyId: 4adef29c-7531-4bcd-8cf5-8677d000z9853 CompanyName: Wyee Point Marina CompanyReference: ContactEmail: admin@wyeeppointmarina.com.au ContactName: Peter Peters FaxCode: '01' FaxNumber: '43591802' LegalAddress: AddressId: 33678678-d09c-4370-a540-2a8694c9d1d3 Line1: PO Box 695 Line2: Line3: Town: Suburb: BELMONT State: NSW Postcode: '2280' Country: AddressType: IsInternational: LegalName: PP & MJ Peters T/As MobileCode: MobileNumber: PhoneCode: '01' PhoneNumber: '43591800' PhysicalAddress: AddressId: cbbd0138-44d5-4286-ad73-7f5aa0866c83 Line1: Unit 17 Line2: 77 Rutleys Rd Line3: Town: Suburb: WYEE POINT State: NSW Postcode: '2259' Country: AddressType: IsInternational: TaxNumber: '17569956631' Website: www.wyeepointmarina.com.au '400': description: You will get this error if you send a HTTP instead of HTTPS request or there was something wrong in the payload that you posted '401': description: You will get this response if the user is not authorised to access the resource. '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues put: tags: - core module summary: 01 Core > Company Info description: This endpoint allows you to update the Company Information of the Book you have requested API data from. operationId: 5dae7b31d8b99bdb48db4f4d parameters: - name: cashbookid in: path description: '' required: true schema: type: string requestBody: content: application/json: example: BranchNumber: '001' CompanyName: My Company CompanyReference: ContactEmail: myemail@address.com ContactName: Ifti Chowdhury FaxCode: '02' FaxNumber: '95123456' LegalAddress: Line1: 100 Pacific Highway Line2: Line3: Town: Suburb: North Sydney State: NSW Postcode: '2060' Country: AddressType: IsInternational: false LegalName: Ifti Pty Ltd MobileCode: MobileNumber: PhoneCode: '02' PhoneNumber: '95123456' PhysicalAddress: Line1: 100 Pacific Highway Line2: Line3: Town: Suburb: North Sydney State: NSW Postcode: '2060' Country: '' AddressType: IsInternational: false TaxNumber: 99 999 999 999 Website: www.reckon.com responses: '200': description: This is the response you'll get once the request is successful. content: application/json: { } '400': description: You will get this error if you send a HTTP instead of HTTPS request or there was something wrong in the payload that you posted '401': description: You will get this response if the user is not authorised to access the resource. '500': description: You will get this response if there is a error on our end. Please email apisupport@reckon.com if this continues. '/{cashbookId}/invoices/{invoiceid}/approve': post: tags: - invoices - invoices module summary: 03 Invoices > Invoices > Approve description: 'Approve a draft [customer] invoice in a book by its unique ID. Only required if the invoices module level is ''medium''.' operationId: 57bbf2e4ecc05f0deca543fe parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: invoiceid in: path description: '' required: true schema: type: string responses: '200': description: '/{cashbookId}/activitystatements': get: tags: - activity statements - core module summary: 02 Core > Activity Statements description: Retrieve a list of the Activity Statements. operationId: 57c4c2cfecc05f0fdc578f12 parameters: - name: cashbookId in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the request was successful. A empty array will be returned if no Activity Statements are present within the book. To get the detailed information from a activity statement use the GetByID endpoint for Activity Statements. content: application/json: example: - GSTReportID: 17444bf7-9aab-4dfe-967e-d5ac2dac9ea9 CashbookID: 00000000-0000-0000-0000-000000000000 DocumentID: Description: Annual report 2013/2014 with all options (PAYG1) nnnnn ReceiptNumber: DueDate: LodgeDate: StartDate: '2013-07-01T00:00:00.0000000+12:00' EndDate: '2014-06-30T00:00:00.0000000+12:00' GSTReportTemplateID: 00000000-0000-0000-0000-000000000000 IsAmendment: false Status: 1 PeriodInDays: 0 - GSTReportID: 1949b5fc-9aa7-4d7f-9fd4-2240606f63f5 CashbookID: 00000000-0000-0000-0000-000000000000 DocumentID: Description: Monthly report May2014 ReceiptNumber: DueDate: LodgeDate: '2016-04-13T00:00:00.0000000+12:00' StartDate: '2014-05-01T00:00:00.0000000+12:00' EndDate: '2014-05-31T00:00:00.0000000+12:00' '400': description: You will get this response if you send a HTTP instead of HTTPS request or there was something wrong in the payload that you posted '401': description: You will get this response if the user is not authorised '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookId}/activitystatements/{gstReportId}': get: tags: - activity statements summary: 02 Core > Activity Statements by ID description: "This endpoint allows you to retrieve detailed information from a single Activity Statement by sending its ID to the API endpoint.\n" operationId: 57c4c2fcecc05f0fdc578f13 parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: gstReportId in: path description: '' required: true schema: type: string responses: '200': description: You will get this detailed response if the Activity Statement is retrieved successfully. content: application/json: example: BASPreferences: AmountTaxstatus: 2 CashbookID: 00000000-0000-0000-0000-000000000000 IncludeFBT: true IncludeFTC: true IncludeLCT: true IncludePAYGIOption1: true IncludePAYGIOption2: false IncludePAYGW: true IncludeWET: true ReportingPeriodType: ee46dd06-3bde-4009-abac-ed0a78f927fa CashbookId: 35ab8405-cf6f-4dc4-b703-1ccf40c5c234 CompanyName: ABC Company Data: - Error: Label: W5 Value: Xbrl: - Error: Label: 5A Value: Xbrl: - Error: Label: W3 Value: Xbrl: - Error: Label: 7C Value: Xbrl: - Error: Label: T9 Value: Xbrl: - Error: Label: 9b Value: Xbrl: - Error: Label: W2 Value: '0' Xbrl: - Error: Label: 1F Value: Xbrl: - Error: Label: 7D Value: Xbrl: - Error: Label: W1 Value: '0' Xbrl: - Error: Label: 1C Value: '390' Xbrl: - Error: Label: T8 Value: Xbrl: - Error: Label: G11 Value: '450' Xbrl: - Error: Label: '9' Value: '1345' Xbrl: - Error: Label: F2 Value: Xbrl: - Error: Label: 1B Value: '101' Xbrl: - Error: Label: W4 Value: Xbrl: - Error: Label: 1D Value: Xbrl: - Error: Label: 6B Value: Xbrl: - Error: Label: 8B Value: '101' Xbrl: - Error: Label: '7' Value: Xbrl: - Error: Label: T4 Value: Xbrl: - Error: Label: G1 Value: '12049' Xbrl: - Error: Label: 8A Value: '1446' Xbrl: - Error: Label: G10 Value: '619' Xbrl: - Error: Label: F4 Value: Xbrl: - Error: Label: G2 Value: Xbrl: - Error: Label: 5B Value: Xbrl: - Error: Label: 1E Value: Xbrl: - Error: Label: F1 Value: Xbrl: - Error: Label: T7 Value: Xbrl: - Error: Label: 9a Value: '1345' Xbrl: - Error: Label: 1A Value: '1056' Xbrl: - Error: Label: G3 Value: '2140' Xbrl: - Error: Label: F3 Value: Xbrl: - Error: Label: 6A Value: Xbrl: - Error: Label: '4' Value: Xbrl: GSTReportId: 17444bf7-9aab-4dfe-967e-d5ac2dac9ea9 LegalName: ABC Company Lodgement: CashbookId: 35ab8405-cf6f-4dc4-b703-1ccf40c5c234 Description: Annual report 2013/2014 with all options (PAYG1) nnnnn DocumentId: DueDate: EndDate: '2014-06-30T00:00:00.0000000+00:00' GSTReportId: 17444bf7-9aab-4dfe-967e-d5ac2dac9ea9 IsAmendment: false LodgeDate: LodgementStatus: 1 LodgementType: 0 PeriodInDays: 0 ReceiptNumber: StartDate: '2013-07-01T00:00:00.0000000+00:00' ReportType: 1 Template: Option: 1 TemplateRowDataList: - DataType: 1 Label: Rules: RuleLabels: Dependency: Description: ABC Company Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 2 Label: Rules: RuleLabels: Dependency: Description: Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 3 Label: Rules: RuleLabels: Dependency: Description: Supplies and Acquisitions Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 4 Label: Rules: RuleLabels: Dependency: Description: 'Goods and Services Tax (GST): Option 1' Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 14 Label: G1 Rules: RuleLabels: Dependency: Description: Total Sales and Income & other Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 24 Label: Rules: RuleLabels: Dependency: Description: Amounts include GST? Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 14 Label: G2 Rules: RuleLabels: Dependency: Description: Exports Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 14 Label: G3 Rules: RuleLabels: Dependency: Description: Other GST free supplies Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 14 Label: G10 Rules: RuleLabels: Dependency: Description: Capital Acquisition Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 14 Label: G11 Rules: RuleLabels: Dependency: Description: Other Acquisition Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 3 Label: Rules: RuleLabels: Dependency: Description: Taxes and Amounts Withheld Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 4 Label: Rules: RuleLabels: Dependency: Description: PAYG tax withheld Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 15 Label: W1 Rules: RuleLabels: Dependency: Description: 'Total salary, wages and other payments' Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 15 Label: W2 Rules: RuleLabels: Dependency: Description: Amount withheld from payments shown at W1 Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 15 Label: W4 Rules: RuleLabels: Dependency: Description: Amount withheld where no ABN is quoted Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 15 Label: W3 Rules: RuleLabels: Dependency: Description: Other amounts withheld (excluding any amount shown at W2 or W4) Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 14 Label: W5 Rules: W2 + W4 + W3 RuleLabels: - W2 - W4 - W3 Dependency: Description: Total amounts withheld (W2 + W4 + W3) Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 4 Label: Rules: RuleLabels: Dependency: Description: 'Option 1: Pay a PAYG instalment amount quarterly' Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 15 Label: T7 Rules: RuleLabels: Dependency: Description: ATO calculated PAYG instalment Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 5 Label: Rules: RuleLabels: Dependency: Description: 'If you are varying your amount, complete T8, T9, T4' Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 15 Label: T8 Rules: RuleLabels: Dependency: Description: Estimated tax for the year Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 16 Label: T9 Rules: RuleLabels: Dependency: T4 Description: Varied amount payable for the quarter Error: '* T4 is required' SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 17 Label: T4 Rules: RuleLabels: Dependency: T9 Description: Reason for variation Error: '* T9 is required' SelectionList: - Display: '' Value: '' - Display: 21 Change in investments Value: '21' - Display: 22 Current business structure not continuing Value: '22' - Display: 23 Significant change in trading conditions Value: '23' - Display: 24 Internal business restructure Value: '24' - Display: 25 Change in legislation or product mix Value: '25' - Display: 26 Financial market changes Value: '26' - Display: 27 Use of income tax losses Value: '27' - Display: 33 Consolidations Value: '33' IsEditable: true IsVisible: true - DataType: 4 Label: Rules: RuleLabels: Dependency: Description: Fringe Benefits Tax Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 15 Label: F1 Rules: RuleLabels: Dependency: Description: ATO calculated fringe benefits tax instalment Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 5 Label: Rules: RuleLabels: Dependency: Description: 'If you are varying your amount, complete F2, F3, F4' Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 15 Label: F2 Rules: RuleLabels: Dependency: Description: Estimated total fringe benefits tax Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 16 Label: F3 Rules: RuleLabels: Dependency: F4 Description: Varied fringe benefits tax instalment Error: '* F4 is required' SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 17 Label: F4 Rules: RuleLabels: Dependency: F3 Description: Reason for fringe benefits tax Error: '* F3 is required' SelectionList: - Display: '' Value: '' - Display: 22 Current business structure not continuing Value: '22' - Display: 30 Change in fringe benefits for employees Value: '30' - Display: 31 Change in employees with fringe benefits Value: '31' - Display: 32 Fringe benefits rebate now claimed Value: '32' IsEditable: true IsVisible: true - DataType: 3 Label: Rules: RuleLabels: Dependency: Description: Debits and Credits Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 4 Label: Rules: RuleLabels: Dependency: Description: Amounts you owe the ATO Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 6 Label: 1A Rules: RuleLabels: Dependency: Description: Goods and services tax payable Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 6 Label: 1C Rules: RuleLabels: Dependency: Description: Wine equalisation tax payable Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 7 Label: 1E Rules: RuleLabels: Dependency: Description: Luxury car tax payable Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 6 Label: '4' Rules: W5 RuleLabels: - W5 Dependency: Description: PAYG tax withheld Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 7 Label: 5A Rules: T9 >= 0 || T9 * 0 || T7 || T11 RuleLabels: - T9 - T7 - T11 Dependency: Description: PAYG income tax instalment Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 6 Label: 6A Rules: F3 >= 0 || F3 * 0 || F1 RuleLabels: - F3 - F1 Dependency: Description: Fringe benefits tax instalment Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 7 Label: '7' Rules: RuleLabels: Dependency: Description: Deferred company/fund instalment Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 7 Label: 7C Rules: RuleLabels: Dependency: Description: Fuel tax credit over claim (Don't claim in litres) Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 14 Label: 8A Rules: 1A + 1C + 1E + 4 + 5A + 6A + 7 + 7C RuleLabels: - 1A - 1C - 1E - '4' - 5A - 6A - '7' - 7C Dependency: Description: Calculated as 1A + 1C + 1E + 4 + 5A + 6A + 7 + 7C Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 12 Label: Rules: RuleLabels: Dependency: Description: Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 4 Label: Rules: RuleLabels: Dependency: Description: Amounts the ATO owes you Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 6 Label: 1B Rules: RuleLabels: Dependency: Description: Credit for goods and services tax paid Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 7 Label: 1D Rules: RuleLabels: Dependency: Description: Wine equalisation tax refundable Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 7 Label: 1F Rules: RuleLabels: Dependency: Description: Luxury car tax refundable Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 7 Label: 5B Rules: T9 < 0 RuleLabels: - T9 Dependency: Description: Credit from PAYG income tax instalment variation Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 6 Label: 6B Rules: F3 < 0 RuleLabels: - F3 Dependency: Description: Credit arising from reduced fringe Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 7 Label: 7D Rules: RuleLabels: Dependency: Description: Fuel tax credit (Don't claim in litres) Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 14 Label: 8B Rules: 1B + 1D + 1F + 5B + 6B + 7D RuleLabels: - 1B - 1D - 1F - 5B - 6B - 7D Dependency: Description: Calculated as 1B + 1D + 1F + 5B + 6B + 7D Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 12 Label: Rules: RuleLabels: Dependency: Description: Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 4 Label: Rules: RuleLabels: Dependency: Description: Payment or Refund Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 6 Label: '9' Rules: '[ 8A - 8B ]' RuleLabels: - 8A - 8B Dependency: Description: Your payment or refund amount Error: SelectionList: [ ] IsEditable: true IsVisible: false - DataType: 19 Label: 9a Rules: 9 >= 0 RuleLabels: - '9' Dependency: Description: Your payable amount Error: SelectionList: [ ] IsEditable: true IsVisible: true - DataType: 20 Label: 9b Rules: 9 < 0 RuleLabels: - '9' Dependency: Description: Your refund amount Error: SelectionList: [ ] IsEditable: true IsVisible: true TemplateId: 4d3b0436-0837-4d1b-bb88-e3249428e4a2 Total: 1345 '400': description: You will get this response if you send a HTTP instead of HTTPS request or there was something wrong in the payload that you posted '401': description: You will get this response if the user is not authorised '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookId}/reports/profitloss/false': post: tags: - reports summary: 80 Reports > Profit and Loss description: "Retrieve the profit and loss report from the book based on the parameters specified in the POST request.\n" operationId: 57c4c343ecc05f0fdc578f14 parameters: - name: cashbookId in: path description: '' required: true schema: type: string requestBody: description: 'This is where you set the dates for the report, the orientation of the report response and the reporting type' content: application/json: example: Orientation: Portrait ReportingBasis: AccrualsBasis PeriodFilter: PeriodType: ThisMonth responses: '200': description: You will get this response if the report is successfully retrieved content: application/json: example: ReportData: Income: [ ] OtherIncome: [ ] COGS: [ ] Expenses: - ID: ceebf5e0-5754-4125-8484-9458f471d646 Name: Client Support Services Code: '0110-06-01' ExportCode: TaxCode: ParentID: 00000000-0000-0000-0000-000000000000 Period1Amount: 211.87 Period1Total: 211.87 OtherExpenses: [ ] TotalIncome: Period1Amount: TotalOtherIncome: Period1Amount: TotalCOGS: Period1Amount: TotalExpenses: Period1Amount: 211.87 TotalOtherExpenses: Period1Amount: NetProfit: Period1Amount: BookName: William Cashbook AUS Full DateGenerated: '2016-09-15T16:07:59.3530000+12:00' ReportName: Profit and loss '/{cashbookid}/creditnotes': post: tags: - customer credit notes - invoices module summary: 03 Invoices > Credit Notes description: Create credit notes (invoice adjustments). operationId: 57c4c90fc5007612542f0355 parameters: - name: cashbookid in: path description: '' required: true schema: type: string requestBody: description: The body of the POST is where you include the JSON payload to be processed by the API. content: application/json: example: CreditNoteNumber: CustomerId: c41b819e-ac67-46eb-abe6-bba8559f2fe7 CashbookId: 35ab8405-cf6f-4dc4-b703-1ccf40c5c234 AmountTaxStatus: 2 Amount: 130.88 DiscountAmount: DiscountPercentage: Tax: 30.88 Notes: Note 123345434543 Reference: 1234WEDWQEQWEQW TemplateId: 6e8025ce-f822-4fd1-9e3b-3adbca571488 CreditNoteDate: '2016-07-28T00:00:00.0000000+00:00' LineItems: - DiscountAmountExTax: DiscountAmountTax: DiscountAccuracy: DiscountPercent: Amount: 130.88 AmountAccuracy: InvoiceDiscountedAmountExTax: 100 InvoiceDiscountedTaxAmount: 30.88 HasDataForPosting: true IsSubTotal: false IsParent: false IsHidden: false AccountId: PrintGroupAsSingleLine: false ChargeableItemId: fc342bc0-3fc0-49b5-8e94-04c6b43861f6 LineNo: 1 Description: Quantity: ProjectId: 14945bb1-bbaa-4495-9634-20da9de6a890 UnitPriceExTax: 100.001 UnitPriceTax: 30.87478874 UnitPricePrecision: 3 UnitPriceIsTaxInclusive: false TaxGroupId: 52b79b23-b498-4758-83cd-a29715c0bb7e TaxIsModified: false TaxAmount: 30.88 AmountExTax: 100.001 Address: responses: '200': description: If the data is posted successfully you will get the following response. It is the GUID of the transaction which was added to the book. content: application/json: example: a54d10e9-7cb2-4e0a-a3dc-16ad7142f992 '/{cashbookId}/accounts/{accountId}': delete: tags: - core module - chart of accounts summary: 02 Core > Accounts description: 'Delete a general ledger account in the book''s chart of accounts . If the account is used in any transactions in the Reckon One Book, the account will not be able to be deleted until those transactions have been removed, or the accounts used on them changed.' operationId: 57e1c84decc05f17cccb7c0a parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: accountId in: path description: '' required: true schema: type: string responses: '200': description: You'll receive this response when the account deletion request is successful. '400': description: You will get this response if you send a HTTP instead of HTTPS request or there was something wrong in the payload that you posted '401': description: You will get this response if the user is not authorised '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookid}/items/{itemId}': delete: tags: - core module - items summary: 02 Core > Items description: 'Delete items. If the item is used on a transaction, those transactions will need to be deleted before you can delete the item.' operationId: 57e1cb48ecc05f17cccb7c0b parameters: - name: cashbookid in: path description: '' required: true schema: type: string - name: itemId in: path description: '' required: true schema: type: string responses: '200': description: You'll get this response when the item deletion is successful. '400': description: You will get this response if you send a HTTP instead of HTTPS request or there was something wrong in the payload that you posted '401': description: You will get this response if the user is not authorised or does not have access to the requested resource '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookid}/allocations/applycredit': post: tags: - invoices module - customer credit notes summary: 03 Invoices > Credit Notes > Apply description: Apply a customer credit note to an existing customer invoice. operationId: 57e86025ecc05f1478c45b2e parameters: - name: cashbookid in: path description: '' required: true schema: type: string responses: '200': description: '/{cashbookid}/suppliercreditnotes': get: tags: - invoices module - supplier credit notes summary: 03 Invoices > Supplier Credit Notes description: This endpoint allows you to retrieve the a list of Supplier Credit Notes operationId: 5800410eecc05f15040ea3c7 parameters: - name: cashbookid in: path description: '' required: true schema: type: string responses: '200': description: You will get this response when the supplier credit list is successfully returned content: application/json: example: - Id: 11daf446-250e-4b16-ad4d-c2ee2db80693 AccountsPayableCategoryID: 4ba37c05-eca4-4c02-a4d7-e72b3e9d4247 Balance: 10 BillAmount: 10 BillDate: '2015-06-03T00:00:00.0000000+00:00' BillNumber: SAN0005 Notes: Reference: Status: 2 SupplierID: b09da867-1e2c-48e3-a9db-dd21b427a6bb SupplierName: City Rail '401': description: You will get this resposne when the token attached to the request is invalid or expired. post: tags: - supplier credit notes - invoices module summary: 03 Invoices > Supplier Credit Notes description: This endpoint allows you to post a supplier credit note to a Reckon One book. operationId: 58004145ecc05f15040ea3c8 parameters: - name: cashbookid in: path description: '' required: true schema: type: string requestBody: description: This is the body you need to post to add a Supplier Credit Note. content: application/json: example: SupplierCreditNoteNumber: SupplierId: e38db1f9-cbe6-4b4a-a1b6-fc4c7f1ac41c CashbookId: 35ab8405-cf6f-4dc4-b703-1ccf40c5c234 AmountTaxStatus: 2 Amount: 1 DiscountAmount: DiscountPercentage: Tax: 0.09 Notes: azp_test Reference: '110' TemplateId: a70ea585-8288-47ea-b813-d105d201caeb SupplierCreditNoteDate: '2016-08-22T00:00:00.0000000+00:00' LineItems: - AccountingCategoryId: 0d995c57-3d53-40c5-a6a5-79c213af087a DiscountAmountExTax: DiscountAmountTax: DiscountAccuracy: DiscountPercent: Amount: 1 AmountAccuracy: InvoiceDiscountedAmountExTax: 0.91 InvoiceDiscountedTaxAmount: 0.09 HasDataForPosting: true IsSubTotal: false IsParent: false IsHidden: false AccountId: PrintGroupAsSingleLine: false ChargeableItemId: fa2137a5-0860-4fdb-97e7-95d0a26368d2 LineNo: 1 Description: Quantity: ProjectId: 3f638981-e363-4c1c-be28-3850f4f643da UnitPriceExTax: 0.9090909091 UnitPriceTax: 0.0909090909 UnitPricePrecision: 2 UnitPriceIsTaxInclusive: false TaxGroupId: a23b1b14-40e1-4cd2-a60a-0d6fa995c1e1 TaxIsModified: false TaxAmount: 0.09 AmountExTax: 0.9091 SupplierCreditNoteSourceId: 00000000-0000-0000-0000-000000000000 responses: '200': description: You will get this response if the supplier credit note is posted successfully to the Reckon One book. The GUID represents the unique transaction id in the Reckon One book. content: application/json: example: 11daf446-250e-4b16-ad4d-c2ee2db80693: '' '400': description: 'You will get this error for numerous reasons, the description of the response will explain what has occured. For example if you try to post to a contact id that does not exist, you will get this response.' '500': description: You will get this response if there is a problem with the JSON that you are sending to the server. '/{cashbookid}/suppliercreditnotes/{suppliercreditnoteid}': delete: tags: - invoices module - supplier credit notes summary: 03 Invoices > Supplier Credit Note description: Delete a supplier credit notes by their known ID operationId: 58004194ecc05f15040ea3c9 parameters: - name: cashbookid in: path description: '' required: true schema: type: string - name: suppliercreditnoteid in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the delete request was successful '401': description: You will get this response if the user is not authorised to delete the transaction or the security token has expired '500': description: You will get this error if there is a problem with the GUID you have provided for deleting the transaction '/{cashbookid}/estimates': get: tags: - invoices - estimates summary: 03 Invoices > Estimates description: This endpoint allows you to retrieve the list of estimates in the book operationId: 580d771aecc05f1f2c6c3a95 parameters: - name: cashbookid in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the request to get the esimates list is successful content: application/json: example: Id: ea3435fd-841e-4f0a-8555-a5dc79bde281 CashbookId: 0da93f9e-acb7-4bb0-b66d-a124e02dbe39 CustomerId: fec28ebc-f916-4544-8257-017649d45211 CustomerName: Aportis Amount: 220 Date: '2016-06-15T00:00:00.0000000+00:00' ExpiryDate: '2016-06-30T00:00:00.0000000+00:00' Number: EST0002 Reference: '1234' Status: 3 '401': description: You will get this repsonse if the user does not have access to this module or the token sent with the request has expired or is invalid. post: tags: - estimates - invoices module summary: 03 Invoices > Estimates description: This endpoint allows you to post a estimate to the Reckon One book. operationId: 580d7961ecc05f1f2c6c3a96 parameters: - name: cashbookid in: path description: '' required: true schema: type: string requestBody: description: The estimate data is to be sent in a JSON payload. content: application/json: example: CustomerId: 3ceba0fa-6063-4972-aeef-453303e612d4 EstimateDate: '2016-09-06T00:00:00.0000000+00:00' EstimateAmount: 91 AmountTaxStatus: 2 Notes: asdfg Reference: TemplateId: d10a7d19-fe53-4e16-853e-a05a8edb5b75 ExpiryDate: '2016-12-15T00:00:00.0000000+00:00' SendDate: EstimateTax: 0 Address: TaxSummaryText: TermID: TermsAndConditions: PaymentNotes: LineItems: - MarkupPercentage: MarkupAmountExTax: MarkupAmountTax: ItemTotal: 0 DiscountAmountExTax: DiscountAmountTax: DiscountAccuracy: DiscountPercent: Amount: 91 AmountAccuracy: InvoiceDiscountedAmountExTax: InvoiceDiscountedTaxAmount: HasDataForPosting: false IsSubTotal: false IsParent: false IsHidden: false AccountId: PrintGroupAsSingleLine: false ChargeableItemId: fc342bc0-3fc0-49b5-8e94-04c6b43861f6 LineNo: 1 Description: Quantity: ProjectId: e3dbab49-50f2-4c12-8a30-d30227165d04 UnitPriceExTax: 91 UnitPriceTax: 0 UnitPricePrecision: 2 UnitPriceIsTaxInclusive: false TaxGroupId: TaxIsModified: false TaxAmount: AmountExTax: 91 responses: '200': description: You will get this response if the estimate is succesfully posted to the Reckon One book. The GUID is the unique transaction id of the estimate in the Reckon One book. content: application/json: example: 3ceba0fa-6063-4972-aeef-453303e612d4: '' '401': description: You will get this response if the user is not authorised to post estimates or the token being sent with the request is invalid or expired. '500': description: You will get this resposne if there is a problem with the structure of the JSON payload put: tags: - estimates summary: 03 Invoices > Estimates operationId: 5d072bb340c9e8f8cd67ed20 parameters: - name: cashbookid in: path description: '' required: true schema: type: string responses: '200': description: You will get this response when your request was processed successfully. '401': description: You will get this response when you don't have access to the Book or if the Invoice module isn't enabled. '500': description: You will get this error if there were something wrong in your call or something went wrong at Reckon's end. Please check your payload and let us know if you don't find any issue at your end. '/{cashbookid}/estimates/{estimateId}': get: tags: - estimates - invoices summary: 03 Invoices > Estimates by ID description: This endpoint allows you to request a specific estimate transaction via its unique GUID operationId: 580d7b5fc500760d0403338f parameters: - name: cashbookid in: path description: '' required: true schema: type: string - name: estimateId in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the request to get the single estimate is successful content: application/json: example: CompanyName: One Energy Pty Ltd ContactName: Aportis LegalName: One Energy Pty Ltd LineItems: - EstimateId: ea3435fd-841e-4f0a-8555-a5dc79bde281 ItemTotal: 0 MarkupAmountExTax: MarkupAmountTax: MarkupPercentage: DiscountAmountExTax: DiscountAmountTax: DiscountAccuracy: DiscountPercent: Amount: 200 AmountAccuracy: InvoiceDiscountedAmountExTax: InvoiceDiscountedTaxAmount: HasDataForPosting: false IsSubTotal: false IsParent: false IsHidden: false AccountId: PrintGroupAsSingleLine: false Id: 98cf929b-8131-40c3-818b-aa617c46f508 ChargeableItemId: 142d973c-8771-45cc-8d61-47a57d517b80 LineNo: 1 Description: Consulting Quantity: 2 ProjectId: 00000000-0000-0000-0000-000000000000 UnitPriceExTax: 100 UnitPriceTax: 0 UnitPricePrecision: 2 UnitPriceIsTaxInclusive: false TaxGroupId: 01c9831e-5ffa-4de6-87f4-840a1bcc84f3 TaxIsModified: false TaxAmount: 20 AmountExTax: 200 LinkedInvoiceId: LinkedInvoiceNumber: Notes: PaymentNotes: SendDate: Status: 3 TaxSummaryText: TermDiscountAmount: TermDiscountPercentage: TermId: 00000000-0000-0000-0000-000000000000 TermsAndConditions: TermSurchargeAmount: TermSurchargePercentage: TermText: AmountTaxStatus: 3 Tax: 20 TemplateId: 8385f405-2e7d-44bc-8bb9-5fb31b3704d8 AddressId: 00000000-0000-0000-0000-000000000000 Address: Id: ea3435fd-841e-4f0a-8555-a5dc79bde281 CashbookId: 0da93f9e-acb7-4bb0-b66d-a124e02dbe39 Number: EST0002 CustomerId: fec28ebc-f916-4544-8257-017649d45211 CustomerName: 'Aportis ' Amount: 220 Date: '2016-06-15T00:00:00.0000000+00:00' Reference: '1234' ExpiryDate: '2016-06-30T00:00:00.0000000+00:00' '401': description: You will get this response if the user is not authorised to get the estimate transaction or the token sent with the request has expired or is invalid. '500': description: You will get this response if there is a problem with the GUID that is sent with the request. delete: tags: - estimates - invoices module summary: 03 Invoices > Estimates description: This endpoint is used to delete a estimate from a Reckon One book operationId: 580d7bebc500760d04033390 parameters: - name: cashbookid in: path description: '' required: true schema: type: string - name: estimateId in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the transaction is successfully deleted '401': description: You will get this response if the user is not authorised to delete the transaction or the token used with the request has expired or is invalid. '500': description: You will get this response if there is a problem with the GUID provided as part of the request '/{cashbookid}/suppliercreditnotes/{supplierCreditNoteId}': get: tags: - supplier credit notes - invoices summary: 03 Invoices > Supplier Credit Note By ID description: 'This endpoint allows you to retrieve individual supplier credit notes via their unique id ' operationId: 5812938decc05f035067d4f3 parameters: - name: cashbookid in: path description: '' required: true schema: type: string - name: supplierCreditNoteId in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the transaction is successfully retrieved content: application/json: example: AccountsPayableAccountingCategoryID: 4ba37c05-eca4-4c02-a4d7-e72b3e9d4247 Address: AddressId: 00000000-0000-0000-0000-000000000000 Line1: Line2: Line3: Town: Suburb: State: Postcode: Country: AddressType: IsInternational: Allocations: [ ] AmountTaxStatus: 2 CashbookId: e17417ac-fc79-4d4d-9ee8-1780b3bc326f ContactName: City Rail Corp Id: 11daf446-250e-4b16-ad4d-c2ee2db80693 LineItems: - AccountingCategoryId: 00000000-0000-0000-0000-000000000000 SupplierCreditNoteId: 11daf446-250e-4b16-ad4d-c2ee2db80693 DiscountAmountExTax: DiscountAmountTax: DiscountAccuracy: DiscountPercent: Amount: 10 AmountAccuracy: InvoiceDiscountedAmountExTax: 10 InvoiceDiscountedTaxAmount: HasDataForPosting: true IsSubTotal: false IsParent: false IsHidden: false AccountId: 72df99c8-df36-487c-86b2-2e4efa373f3d PrintGroupAsSingleLine: false Id: 4d9c977a-514a-46d2-ad5e-4ba392e887bb ChargeableItemId: 00000000-0000-0000-0000-000000000000 LineNo: 1 Description: D Expense Description Quantity: ProjectId: 00000000-0000-0000-0000-000000000000 UnitPriceExTax: 0 UnitPriceTax: 0 UnitPricePrecision: 2 UnitPriceIsTaxInclusive: false TaxGroupId: 00000000-0000-0000-0000-000000000000 TaxIsModified: false TaxAmount: AmountExTax: 10 Notes: Reference: Status: 2 Supplier: ContactId: b09da867-1e2c-48e3-a9db-dd21b427a6bb CashbookId: e17417ac-fc79-4d4d-9ee8-1780b3bc326f PaymentTermId: CustomerCreditLimit: Description: City Rail FirstNameBranchName: Sydney SurnameBusinessName: City Rail Corp IsCustomer: false IsSupplier: true IsActive: true IsPerson: false IsTpar: true Email: scott.montgomerie@reckon.com Website: www.reckon.com BusinessNumber1: '14003348730' Notes: Test notes for City Rail Corp AreaCode: '02' PhoneNumber: '12345678' FaxCode: '02' FaxNumber: '87654321' MobileCode: MobileNumber: IsBusinessAddressDifferent: true IsEmployee: false Addresses: - AddressId: aba3aaa9-3d21-4536-84cc-6c95a3cf48b0 Line1: Level 12 Line2: 3 Main Rd Line3: '' Town: Suburb: Sydney State: SA Postcode: '2001' Country: AddressType: Business IsInternational: false - AddressId: 953e1fda-e770-4360-a299-07ee5a54e53a Line1: Ground Floor Line2: 1 Test St Line3: '' Town: Suburb: Test State: SA Postcode: '2000' Country: AddressType: Postal IsInternational: false SupplierCreditNoteAmount: 10 SupplierCreditNoteDate: '2015-06-03T00:00:00.0000000+00:00' SupplierCreditNoteNumber: SAN0005 SupplierCreditNoteSourceId: 00000000-0000-0000-0000-000000000000 SupplierId: b09da867-1e2c-48e3-a9db-dd21b427a6bb SupplierName: City Rail Tax: 0 TemplateId: 7984e6da-6f60-40a6-a667-70f0e645acc1 '400': description: You will get this response if the transaction id that you are requesting is invalid '401': description: 'You will get this response if you the user is not authorised to get the transaction they are requesting, or the token you are sending is expired' '/{cashbookId}/reports/trialbalance/{isFavourite}': post: tags: - reports summary: 80 Reports > Trial Balance description: Get Trial Balance Report with POST operationId: 5851f420c500760ff84ea036 parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: isFavourite in: path description: '' required: true schema: type: string responses: '200': description: '/{cashbookid}/invoices': put: tags: - invoices module - invoices summary: 03 Invoices > Invoices operationId: 585322bdc5007613cc81cc9f parameters: - name: cashbookid in: path description: '' required: true schema: type: string responses: '200': description: '/{cashbookId}/expenseclaims': get: tags: - time & expenses module - expenses summary: 07 Time and Expenses > Get Expenses List operationId: 5859e7ddecc05f1cd85549a4 parameters: - name: cashbookId in: path description: '' required: true schema: type: string responses: '200': description: post: tags: - time & expenses module - expenses summary: 07 Time and Expenses > Post an Expense Claim operationId: 587566bec5007613a4bfc876 parameters: - name: cashbookId in: path description: '' required: true schema: type: string responses: '200': description: '/{cashbookId}/expenseclaims/{expenseclaimId}': get: tags: - expenses - time & expenses module summary: 07 Time and Expenses > Get Expense Claim by ID operationId: 5875652fecc05f0bac880ff2 parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: expenseclaimId in: path description: '' required: true schema: type: string responses: '200': description: '/{cashbookId}/reports/balancesheet/false': post: tags: - reports summary: 80 Reports > Balance Sheet description: This is the endpoint to get the balance sheet report from the Reckon One book operationId: 58756866ecc05f0bac880ff3 parameters: - name: cashbookId in: path description: '' required: true schema: type: string requestBody: description: You need to set some information in the body of the POST such as the period for the report content: application/json: example: Orientation: Portrait ReportingBasis: AccrualsBasis PeriodFilter: PeriodType: ThisYear responses: '200': description: You will get this response if the data was successfully retrieved content: application/json: example: ReportData: Sections: - Type: Current assets Accounts: - ID: 47a0edaf-e5d1-4442-88c2-1bccb300ae3a Name: Bank - Test1 Code: ExportCode: '680' Period1Amount: 100 Period1Total: 100 Period2Amount: 0 Period2Total: 0 - ID: 09f0d5ad-ed36-4f81-b2de-ec65ed4ec207 Name: Bank - SImonT456456estBankAccount Code: ExportCode: '680' Period1Amount: 100 Period1Total: 100 Period2Amount: 0 Period2Total: 0 - ID: dfde19b1-b0a1-4daa-a564-a0e105b315a9 Name: Bank - SImo97nTestBankAccount Code: ExportCode: '680' Period1Amount: 100 Period1Total: 100 Period2Amount: 0 Period2Total: 0 - ID: edb44f29-af85-4845-863e-c8531ffd7f08 Name: Bank - SImonTestB3352345ankAccount Code: ExportCode: '680' Period1Amount: 100 Period1Total: 100 Period2Amount: 0 Period2Total: 0 - ID: 3790d4e5-193b-40bf-8e99-a7accd1aeb78 Name: Bank - SImonTestB345ankAccount Code: ExportCode: '680' Period1Amount: 100 Period1Total: 100 Period2Amount: 0 Period2Total: 0 - ID: 5f7c4fe2-0fbb-4cb4-8e22-b3251dc2ce44 Name: Bank - SImonTest8978BankAccount Code: ExportCode: '680' Period1Amount: 100 Period1Total: 100 Period2Amount: 0 Period2Total: 0 - ID: d7ca4612-ada1-4612-abd7-1645d25cb953 Name: Bank - SImonTest78BankAccount Code: ExportCode: '680' Period1Amount: 100 Period1Total: 100 Period2Amount: 0 Period2Total: 0 - ID: 8210ab02-6c9d-44c1-98d3-54eab8e784ab Name: Bank - SImonTest7982BankAccount Code: ExportCode: '680' Period1Amount: 100 Period1Total: 100 Period2Amount: 0 Period2Total: 0 - ID: 15be26c1-ec65-4389-b9ec-5ceb2e9d1750 Name: Bank - SImonTest782BankAccount Code: ExportCode: '680' Period1Amount: 100 Period1Total: 100 Period2Amount: 0 Period2Total: 0 - ID: 4f09f2c0-1a72-4882-b585-cdb0f5fd11ea Name: Bank - SImonTest72BankAccount Code: ExportCode: '680' Period1Amount: 100 Period1Total: 100 Period2Amount: 0 Period2Total: 0 - ID: ee119147-a938-407b-83a1-5d42aa585e72 Name: Bank - SImonTest2BankAccount Code: ExportCode: '680' Period1Amount: 100 Period1Total: 100 Period2Amount: 0 Period2Total: 0 - ID: ebf2803d-61b8-41c8-b613-53cccdae361d Name: Bank - SImonTestBankAccount Code: ExportCode: '680' Period1Amount: 100 Period1Total: 100 Period2Amount: 0 Period2Total: 0 - ID: ba6e5956-5004-40c8-82ae-a2d1c75dfb0f Name: Bank - Bank 1013 Code: ExportCode: '680' Period1Amount: 340.01 Period1Total: 340.01 Period2Amount: 0 Period2Total: 0 - ID: d5d4d06b-f18f-41b2-a9c6-644e384a74c5 Name: Bank - Aaaaaaaaa bank Code: ExportCode: '680' Period1Amount: 1000 Period1Total: 1000 Period2Amount: 0 Period2Total: 0 - ID: c0f0d7ef-167e-4bfa-b01c-421983eb5555 Name: Bank - PayPal account Code: ExportCode: '680' Period1Amount: 1.16 Period1Total: 1.16 Period2Amount: 0 Period2Total: 0 - ID: 3be1e445-be15-47e3-aa80-59c5f3c9d755 Name: Bank - Bank Number 2 Code: ExportCode: '680' Period1Amount: 50 Period1Total: 50 Period2Amount: 0 Period2Total: 0 - ID: 91c8318d-60e4-4932-bc4b-cb1751c805e2 Name: Bank - Bank Number 1 Code: ExportCode: '680' Period1Amount: -50 Period1Total: -50 Period2Amount: 0 Period2Total: 0 - ID: ca77855d-d76f-4c86-9a7d-761a05f1e9f9 Name: Bank - a2a2 Code: ExportCode: '680' Period1Amount: 555 Period1Total: 555 Period2Amount: 0 Period2Total: 0 - ID: afbc6e49-b3b7-4e34-88d8-cf9360312b42 Name: Bank - Green Bank Code: ExportCode: '680' Period1Amount: 105.5 Period1Total: 105.5 Period2Amount: 0 Period2Total: 0 - ID: 31231689-1107-489e-9599-4a97ca8537d6 Name: Bank - _____98 Code: ExportCode: '680' Period1Amount: 5309.78 Period1Total: 5309.78 Period2Amount: 0 Period2Total: 0 - ID: 2d37f23e-d96a-45c0-a688-bc38c9c4450b Name: Bank - ___0 Code: ExportCode: '680' Period1Amount: 500 Period1Total: 500 Period2Amount: 0 Period2Total: 0 - ID: 9c50266e-8fdc-4648-8506-2cef3eaccaa6 Name: Bank - Zero Bank Code: ExportCode: '680' Period1Amount: 700 Period1Total: 700 Period2Amount: 0 Period2Total: 0 - ID: 60d608c6-6b86-4674-be14-d4fffd3aab19 Name: Bank - H Bank Code: ExportCode: '680' Period1Amount: 1 Period1Total: 1 Period2Amount: 0 Period2Total: 0 - ID: 9395713a-a63b-487c-92c7-7f95f21d4d22 Name: Bank - Chocolate Bank Code: ExportCode: '680' Period1Amount: -899 Period1Total: -899 Period2Amount: 0 Period2Total: 0 - ID: ffc7a8d8-d5c7-4b66-8de4-538658044bb2 Name: Bank - 000-Idris-Test Code: ExportCode: '680' Period1Amount: 9999.04 Period1Total: 9999.04 Period2Amount: 0 Period2Total: 0 - ID: b5f432c2-2cdc-42d0-ac57-42c86eef2e5d Name: Bank - 0 Bank1 Code: ExportCode: '680' Period1Amount: -6357.29 Period1Total: -6357.29 Period2Amount: 0 Period2Total: 0 - ID: dd1e43bd-f4b4-48da-b49e-a63936612c0a Name: Bank - 123 Bank Code: ExportCode: '680' Period1Amount: 418.74 Period1Total: 418.74 Period2Amount: 0 Period2Total: 0 - ID: dc6dde7c-2c4b-400a-bc9c-09a57a5940d7 Name: Bank - 0000000 CC Code: ExportCode: '680' Period1Amount: -139 Period1Total: -139 Period2Amount: 0 Period2Total: 0 - ID: 27674b49-13e1-4fcc-ab93-81b70d3564aa Name: Bank - Business Bank Code: ExportCode: '680' Period1Amount: 424.88 Period1Total: 424.88 Period2Amount: 0 Period2Total: 0 - ID: 0279a01f-e777-42b9-9a18-f5661e6f70d5 Name: Bank - Bank 33 Code: ExportCode: '680' Period1Amount: -4975.42 Period1Total: -4975.42 Period2Amount: 0 Period2Total: 0 - ID: 6ee27109-d1bb-4b25-b2a0-ba4b786b3aa2 Name: Bank - Star Bank Code: ExportCode: '680' Period1Amount: -1384.31 Period1Total: -1384.31 Period2Amount: 0 Period2Total: 0 - ID: b9fe391a-0d0f-4b90-8fb8-ac0b0cfdd1e8 Name: Bank - new bank 24 Code: ExportCode: '680' Period1Amount: 10 Period1Total: 10 Period2Amount: 0 Period2Total: 0 - ID: c24717ee-e6b7-484b-bf45-3cbb529b53e3 Name: Bank - Idris Bank Code: ExportCode: '680' Period1Amount: -50 Period1Total: -50 Period2Amount: 0 Period2Total: 0 - ID: 45d71769-b483-469e-939a-d2b92e4145b1 Name: Bank - A1 Bank Code: ExportCode: '680' Period1Amount: -99270.75 Period1Total: -99270.75 Period2Amount: 0 Period2Total: 0 - ID: 93750988-c39f-45c9-8a61-4cb07ee89fa6 Name: Bank - Tab Bank Code: ExportCode: '680' Period1Amount: 225.55 Period1Total: 225.55 Period2Amount: 0 Period2Total: 0 - ID: 01e349a1-41c1-4ae6-a30e-4334e812c099 Name: Bank - Boost Bank Code: ExportCode: '680' Period1Amount: -11.25 Period1Total: -11.25 Period2Amount: 0 Period2Total: 0 - ID: decb9dc5-1b49-4cda-b642-600c37759e31 Name: Bank - 01 Bank Code: ExportCode: '680' Period1Amount: 388.83 Period1Total: 388.83 Period2Amount: 0 Period2Total: 0 - ID: 168318a7-e3b1-4bc8-9619-8ec832cb6131 Name: Bank - AA Bank Code: ExportCode: '680' Period1Amount: -1225.53 Period1Total: -1225.53 Period2Amount: 0 Period2Total: 0 - ID: 09032565-9e7e-4c01-91a9-1d293f3b553e Name: Bank - Bank 01 Code: ExportCode: '680' Period1Amount: -455.52 Period1Total: -455.52 Period2Amount: 0 Period2Total: 0 - ID: 542c03ac-dfe4-4261-aa4f-4d21cd11be58 Name: Bank - QA Bank Code: ExportCode: '680' Period1Amount: 105.05 Period1Total: 105.05 Period2Amount: 0 Period2Total: 0 - ID: 59247544-7d45-479e-817d-216e0e701d46 Name: Bank - New Bank 11 Code: ExportCode: '680' Period1Amount: 123456 Period1Total: 123456 Period2Amount: 0 Period2Total: 0 - ID: 9d9e164c-96aa-4509-b998-116f9121fecc Name: Bank - Jon Bank Code: ExportCode: '680' Period1Amount: 181 Period1Total: 181 Period2Amount: 0 Period2Total: 0 - ID: 748c0ad6-a347-4ba5-8519-329399416976 Name: Bank - Tracy Bank Code: ExportCode: '680' Period1Amount: 81 Period1Total: 81 Period2Amount: 0 Period2Total: 0 - ID: dad277bb-455c-447b-8462-d202f9008a49 Name: Bank - ABCDE Bank Code: ExportCode: '680' Period1Amount: 181 Period1Total: 181 Period2Amount: 0 Period2Total: 0 - ID: df55017a-a44b-445b-b5ef-84bb78779815 Name: Bank - Scott NAB Code: ExportCode: '680' Period1Amount: -26549.72 Period1Total: -26549.72 Period2Amount: 0 Period2Total: 0 - ID: 799bc3e5-4a17-4e52-ab42-27b3dcba2216 Name: Bank - Test ABC Bank Code: ExportCode: '680' Period1Amount: 100 Period1Total: 100 Period2Amount: 0 Period2Total: 0 - ID: 11c9e89d-d22c-469e-b845-794442277ba4 Name: Bank - Qwerty 123 Bank Code: ExportCode: '680' Period1Amount: -1100 Period1Total: -1100 Period2Amount: 0 Period2Total: 0 - ID: 416e6b50-7a15-4dfd-815c-a9998798425c Name: Bank - Ubank Code: ExportCode: '680' Period1Amount: -3394.84 Period1Total: -3394.84 Period2Amount: 0 Period2Total: 0 - ID: e67d276f-a31c-4254-b876-7a5d9081e87c Name: Bank - Test Bank Code: ExportCode: '680' Period1Amount: 1934 Period1Total: 1934 Period2Amount: 0 Period2Total: 0 - ID: 122a5ad3-3d6b-4b2a-8255-83b43a1b8c63 Name: Bank - New bank 3 Code: ExportCode: '680' Period1Amount: -99.99 Period1Total: -99.99 Period2Amount: 0 Period2Total: 0 - ID: 7370b07e-8f3d-4472-92f6-06abade9ba29 Name: Bank - New Bank 2 Code: ExportCode: '680' Period1Amount: 20 Period1Total: 20 Period2Amount: 0 Period2Total: 0 - ID: 855851fd-17f9-4fb3-aeb7-be80b5ab1bf3 Name: Bank - New bank Code: ExportCode: '680' Period1Amount: 142363.4 Period1Total: 142363.4 Period2Amount: 0 Period2Total: 0 - ID: 8c3d9e5f-ef3c-43c6-92f6-9874d675cda9 Name: Bank - Closed Bank 20141201 Code: ExportCode: '680' Period1Amount: 51 Period1Total: 51 Period2Amount: 0 Period2Total: 0 - ID: f95dd6ea-87b5-43b2-a8bf-84929c93f647 Name: Bank - y Bank Code: ExportCode: '680' Period1Amount: 15 Period1Total: 15 Period2Amount: 0 Period2Total: 0 - ID: 38a7b28a-e5fd-43f0-a291-5826429803f4 Name: Bank - Bank 2 Code: ExportCode: '680' Period1Amount: 644.8 Period1Total: 644.8 Period2Amount: 0 Period2Total: 0 - ID: d4ea5d53-afd2-4afb-96f0-fb8d388ea146 Name: Bank - Bank 1 Code: ExportCode: '680' Period1Amount: 13998047.96 Period1Total: 13998047.96 Period2Amount: 0 Period2Total: 0 - ID: aa38042b-2ee1-40c8-b066-323a129d3b64 Name: Bank - Qwerty Code: ExportCode: '680' Period1Amount: 1216.3 Period1Total: 1216.3 Period2Amount: 0 Period2Total: 0 - ID: 196af764-bcb8-448a-923c-c105d2260c5a Name: Bank - AAA Bank Code: ExportCode: '680' Period1Amount: 112325 Period1Total: 112325 Period2Amount: 0 Period2Total: 0 - ID: d1e25303-669d-4e5d-a1fe-cea8cd633ac5 Name: Bank - Scott's Bank Code: ExportCode: '680' Period1Amount: 1668.7 Period1Total: 1668.7 Period2Amount: 0 Period2Total: 0 - ID: ba233955-d1d7-4026-ace5-970b00641e51 Name: Bank - Inactive Bank Code: ExportCode: '680' Period1Amount: 1.2 Period1Total: 1.2 Period2Amount: 0 Period2Total: 0 - ID: 55cc794c-cb5a-4625-9c8d-30b4c0e33d9e Name: Bank - Cash Code: ExportCode: '680' Period1Amount: 93190.31 Period1Total: 93190.31 Period2Amount: 0 Period2Total: 0 - ID: a0d498f1-8927-4751-8943-a26e8e60f7a5 Name: Accounts Receivable Code: '1210-01-01' ExportCode: '662' Period1Amount: 2265285.1 Period1Total: 2265285.1 Period2Amount: 0 Period2Total: 0 - ID: d8a1f0fc-7585-4513-a2c2-ea9544d1d311 Name: PayPal Income Code: ExportCode: Period1Amount: 145 Period1Total: 145 Period2Amount: 0 Period2Total: 0 - ID: a925cfe4-fbe6-46f6-913d-d9079c510e23 Name: Parent CA Code: ExportCode: Period1Amount: 0 Period1Total: 100000 Period2Amount: 0 Period2Total: 0 - ID: 4c1369ce-8c32-4cdd-9b54-b42f57f7dcef Name: Test Asset 1 Code: ExportCode: Period1Amount: -410 Period1Total: -410 Period2Amount: 0 Period2Total: 0 - ID: ceddd3f1-7373-4a49-b315-c325da8f3744 Name: Test CA Code: ExportCode: Period1Amount: 2.25 Period1Total: 2.25 Period2Amount: 0 Period2Total: 0 - Type: Non-current assets Accounts: - ID: 2df35ec9-81f6-43c0-aa09-85629e08f5cf Name: Test FA Code: ExportCode: Period1Amount: 140000 Period1Total: 140000 Period2Amount: 0 Period2Total: 0 - Type: Current liabilities Accounts: - ID: e41a6564-cdbe-49d6-88c9-7b3a4f5d1225 Name: Payroll Liabilities Code: ExportCode: Period1Amount: 0 Period1Total: 4334 Period2Amount: 0 Period2Total: 0 - ID: cf97084c-251c-40e1-9ccb-584b28f0fb56 Name: Bank - _____________________test cc Code: ExportCode: Period1Amount: 96.87 Period1Total: 96.87 Period2Amount: 0 Period2Total: 0 - ID: 2454d203-54b2-4c0a-bc56-597f0f2386b0 Name: Bank - AAAA CC Code: ExportCode: Period1Amount: 500 Period1Total: 500 Period2Amount: 0 Period2Total: 0 - ID: 5eac0ff7-6edd-4106-9045-c36b0683ca5f Name: Bank - _0909CC Code: ExportCode: Period1Amount: -8669.91 Period1Total: -8669.91 Period2Amount: 0 Period2Total: 0 - ID: 5b824df0-1fe6-4477-b476-7b6690cfd477 Name: Bank - aaa cc Code: ExportCode: Period1Amount: -10.1 Period1Total: -10.1 Period2Amount: 0 Period2Total: 0 - ID: 1cefa62c-bfb9-4509-827d-5d5351cffec5 Name: Bank - 0 CC1 Code: ExportCode: Period1Amount: -13090.74 Period1Total: -13090.74 Period2Amount: 0 Period2Total: 0 - ID: e7598ce3-96cd-42d9-b1ce-de18e15cb878 Name: Bank - 000CC Code: ExportCode: Period1Amount: -4274.03 Period1Total: -4274.03 Period2Amount: 0 Period2Total: 0 - ID: a5599a6f-8f5e-42e6-bb58-5c16226cafb4 Name: Bank - 00q Code: ExportCode: Period1Amount: -257.58 Period1Total: -257.58 Period2Amount: 0 Period2Total: 0 - ID: 413e267d-1256-4076-8bcc-fac565c12df9 Name: Bank - scott cc Code: ExportCode: Period1Amount: 82.34 Period1Total: 82.34 Period2Amount: 0 Period2Total: 0 - ID: 3868d890-3c75-4154-adda-5b4c70934e65 Name: Bank - X CC Code: ExportCode: Period1Amount: 1 Period1Total: 1 Period2Amount: 0 Period2Total: 0 - ID: b538fdf5-057e-4367-bc56-8ac5ddf68cc0 Name: Bank - Hello CC Code: ExportCode: Period1Amount: -90003 Period1Total: -90003 Period2Amount: 0 Period2Total: 0 - ID: 0df9398a-1ab8-4d07-aa71-8b3c9bc187d8 Name: Bank - Red CC Code: ExportCode: Period1Amount: -445.63 Period1Total: -445.63 Period2Amount: 0 Period2Total: 0 - ID: d086e482-767c-49ad-8230-41f1bc239de5 Name: Bank - A1 Credit Card Code: ExportCode: Period1Amount: -1793.97 Period1Total: -1793.97 Period2Amount: 0 Period2Total: 0 - ID: 40c5a3b6-455e-44d1-9d53-37543b91a017 Name: Bank - Boost CC Code: ExportCode: Period1Amount: -333.84 Period1Total: -333.84 Period2Amount: 0 Period2Total: 0 - ID: 2c925da5-a6d3-4ffc-bdbe-43bfeb62e1f8 Name: Bank - Scott Credit Card Code: ExportCode: Period1Amount: -500 Period1Total: -500 Period2Amount: 0 Period2Total: 0 - ID: f0ca8f2e-26d5-495c-9f22-fa787657143e Name: Bank - uvw CC Code: ExportCode: Period1Amount: -55 Period1Total: -55 Period2Amount: 0 Period2Total: 0 - ID: de8b6f15-6c35-4d88-bf62-7f0e782575d2 Name: Bank - XYZ CC Code: ExportCode: Period1Amount: 853.66 Period1Total: 853.66 Period2Amount: 0 Period2Total: 0 - ID: d1d9c990-1482-4532-8a95-c3a1e0cb82f5 Name: Bank - Qwerty CC Code: ExportCode: Period1Amount: -6511.65 Period1Total: -6511.65 Period2Amount: 0 Period2Total: 0 - ID: c109c127-ef3c-496f-9cd8-fe33424d6b20 Name: Bank - Business Mastercard Code: ExportCode: Period1Amount: -7795.52 Period1Total: -7795.52 Period2Amount: 0 Period2Total: 0 - ID: 96377d02-6127-4b74-975e-9ecb378c0db4 Name: Bank - Scott's Credit Card Code: ExportCode: Period1Amount: 308.13 Period1Total: 308.13 Period2Amount: 0 Period2Total: 0 - ID: 68dddf8a-37b9-4120-9268-0ab71bfc4d88 Name: Bank - Nab MasterCard Code: ExportCode: Period1Amount: -318.42 Period1Total: -318.42 Period2Amount: 0 Period2Total: 0 - ID: 4ba37c05-eca4-4c02-a4d7-e72b3e9d4247 Name: Accounts Payable Code: '1100-02-01' ExportCode: '883' Period1Amount: 63800.461 Period1Total: 63800.461 Period2Amount: 0 Period2Total: 0 - ID: 36f8fa0b-692d-45fa-ae38-516162730972 Name: Super Payable Code: ExportCode: Period1Amount: 1543.76 Period1Total: 1543.76 Period2Amount: 0 Period2Total: 0 - ID: 6ca31f73-8ee0-4b42-bf86-f8090633507d Name: GST Payable Code: '1150-02-01' ExportCode: '895' Period1Amount: 0 Period1Total: 119059.39 Period2Amount: 0 Period2Total: 0 - ID: 0913c173-be42-4d27-9998-b55edb799b40 Name: Test OCL Code: ExportCode: Period1Amount: -12 Period1Total: -12 Period2Amount: 0 Period2Total: 0 - Type: Non-current liabilities Accounts: - ID: 179f4aeb-92a5-4ecf-a445-fb1ca563bc11 Name: Test NCL Code: ExportCode: Period1Amount: -22469 Period1Total: -22469 Period2Amount: 0 Period2Total: 0 - Type: Equity Accounts: - ID: cdd92fed-d712-45e2-b3bf-ded29552cbd7 Name: Opening Balance Equity Code: '0100-03-01' ExportCode: '30000' Period1Amount: 124694.89 Period1Total: 124694.89 Period2Amount: 0 Period2Total: 0 - ID: ffffffff-ffff-ffff-ffff-ffffffffffff Name: Current year earnings Code: ExportCode: Period1Amount: 1338365.87 Period1Total: 1338365.87 Period2Amount: 0 Period2Total: 0 - ID: 80f68f35-4962-436e-9726-edf8f494c44e Name: Retained Earnings Surplus/(Accumulated Losses) Code: '1000-03-01' ExportCode: '638' Period1Amount: 15335113.239 Period1Total: 15335113.239 Period2Amount: 0 Period2Total: 0 - ID: cac68cd1-90c3-45d2-9311-cec90bf60ac6 Name: Test Equity Code: ExportCode: Period1Amount: 18907.72 Period1Total: 18907.72 Period2Amount: 0 Period2Total: 0 Totals: TotalAssets: Period1Amount: 16855870.94 Period2Amount: 0 TotalLiabilities: Period1Amount: 34039.221 Period2Amount: 0 TotalEquity: Period1Amount: 16817081.719 Period2Amount: 0 BookName: Scotts Production Book DO NOT DELETE DateGenerated: '2017-01-11T00:49:18.8190000+00:00' ReportName: Balance sheet '401': description: You will get this response if you are not authorised with the Reckon API identity server or the user does not have acccess to the balance sheet report in the book '/{cashbookId}/budgets': get: tags: - budgets - core module summary: 02 Core > Budgets description: This endpoint allows you to retrieve a list of budgets associated with the Reckon One book specified in the https call. operationId: 588551f1ecc05f169c12a0be parameters: - name: cashbookId in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the request is successful content: application/json: example: Id: 1d1cb575-3449-476e-9654-c52f54539a26 BudgetName: 2016_Scott TaxYear: 2017 '400': description: You will get this response if you send a HTTP instead of HTTPS request or there was something wrong in the payload that you posted '401': description: You will get this response if the user is not authorised or does not have access to the requested resource '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues post: tags: - budgets - core module summary: 02 Core > Budgets description: This endpoint is used to add a new budget to the Reckon One book operationId: 588553edecc05f169c12a0bf parameters: - name: cashbookId in: path description: '' required: true schema: type: string requestBody: content: application/json: example: BudgetName: API_test_budget CreationType: 0 TaxYear: 2018 responses: '200': description: You'll get this response when the budget is created successfully and the response will include the id of the budget content: application/json: example: 91c2db76-5f70-4cbe-960f-c73097e08f96 '400': description: You will get this response if you send a HTTP instead of HTTPS request or there was something wrong in the payload that you posted '401': description: You will get this response if the user is not authorised or does not have access to the requested resource '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookId}/budgets/{budgetId}': get: tags: - core module - budgets summary: 02 Core > Budgets By ID description: "This endpoint allows you to retrieve additional data for a specific budget by specifying an ID in the https call.\n\n" operationId: 588552bdc5007618a8883d0c parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: budgetId in: path description: '' required: true schema: type: string responses: '200': description: This is the response you will get if the call is successful content: application/json: example: - Id: 01dc34ed-f926-48ba-8b3f-4b0a14e2d390 AccountName: My income 2 AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: My income 2 Total: 0 - Id: 04fce194-8106-4f50-b3b5-9a04b74cfc55 AccountName: test_APCccountName_peter_C2FE7DF0-EB8A-40F3-A237-5383DFD965F4 AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: test_APCccountName_peter_C2FE7DF0-EB8A-40F3-A237-5383DFD965F4 Total: 0 - Id: 05e5a747-3b37-4422-a747-343783fe90ec AccountName: Miscellaneous Shopping AccountType: 2 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: Miscellaneous Shopping Total: 0 - Id: 0747887e-0a26-4009-9cac-e21e1e00d126 AccountName: Consulting AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: 'Consulting ' Total: 0 - Id: 07616331-13e5-4976-a422-71314a63d47d AccountName: B Income:A Income:Test Income 03 AccountType: 1 Ancestors: 'B Income:A Income:' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: Test Income 03 Total: 0 - Id: 078c02c9-6e3e-453c-9147-701b6b1841e9 AccountName: Payroll Expenses:Super Expense AccountType: 2 Ancestors: 'Payroll Expenses:' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: Super Expense Total: 0 - Id: 0861ff44-623b-4aae-adaf-5cbeac1343fb AccountName: new income account 7 AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: new income account 7 Total: 0 - Id: 0910ffcc-5160-42dc-891b-55a5803800d9 AccountName: test_AccountName_hendrik_2209BC23-850043E66-42C9-A47C-F4C3A56961E8 AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: test_AccountName_hendrik_2209BC23-850043E66-42C9-A47C-F4C3A56961E8 Total: 0 - Id: 0936a208-32b3-4941-add3-ae610fb3e335 AccountName: Dinning Out AccountType: 2 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: Dinning Out Total: 0 - Id: 09b5e151-6c10-4dec-9e5b-cc407d69e1d2 AccountName: Scott's Income AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: Scott's Income Total: 0 - Id: 0a9357ed-f36c-447e-ad9b-1f4553d9d29a AccountName: test_AcparentcountName_hendrik_2209BC23-3E66-42C9-A47C-F4C3A56961E8 AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: test_AcparentcountName_hendrik_2209BC23-3E66-42C9-A47C-F4C3A56961E8 Total: 0 - Id: 0b258e61-2fc5-4a74-8fd7-723f31877dfa AccountName: test_AccountName_700hendrik_2209BC23-3E66-42C9-A47C-F4C3A56961E8 AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: test_AccountName_700hendrik_2209BC23-3E66-42C9-A47C-F4C3A56961E8 Total: 0 - Id: 0c46c2fc-5a72-47a0-9a33-ea456b0a618d AccountName: test_AccountNam58009e_hendrik_2209BC23-3E66-42C9-A47C-F4C3A56961E8 AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: test_AccountNam58009e_hendrik_2209BC23-3E66-42C9-A47C-F4C3A56961E8 Total: 0 - Id: 0d96729e-83af-4088-9679-21db467b7258 AccountName: OI Parent:OI Child AccountType: 6 Ancestors: 'OI Parent:' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: OI Child Total: 0 - Id: 11c92368-9cb4-4024-9f78-92aaf6abe940 AccountName: Bank Fees AccountType: 2 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: Bank Fees Total: 0 - Id: 124ab163-78b9-4a4c-a4c6-0e796ddae553 AccountName: Income Parent Account:Income Sub Account AccountType: 1 Ancestors: 'Income Parent Account:' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: Income Sub Account Total: 0 - Id: 15dd280f-1d5d-472e-837f-f2ef2e52137a AccountName: Texta income AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: Texta income Total: 0 - Id: 16300aca-83c6-498f-bfc3-955270c16be0 AccountName: Test9 AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: Test9 Total: 0 - Id: 171dbbff-a5c1-44b7-a855-581579ddf767 AccountName: X Expense CAG AccountType: 2 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: X Expense CAG Total: 0 - Id: 17c5ac65-fcbc-4a6d-874f-536ca097e0e1 AccountName: Mobile Phone AccountType: 2 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: 'Mobile Phone ' Total: 0 - Id: 1a4213b2-e670-4638-9f77-c2ec78155b19 AccountName: PayPal AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: PayPal Total: 0 - Id: 1ab4f7c3-a977-4b39-b5ff-34feb11606f1 AccountName: Expense Three AccountType: 2 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: Expense Three Total: 0 - Id: 1dd85460-4fb1-47f8-a918-87e9f52f323b AccountName: Advertising AccountType: 2 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: Advertising Total: 0 - Id: 1eebd4b2-804d-41e9-a65f-4ac6c8e048c3 AccountName: Black income AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: Black income Total: 0 - Id: 1f1abdcf-59a5-4a3a-9aaf-a8155bb671e4 AccountName: OI Parent AccountType: 6 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: OI Parent Total: 0 - Id: 1f3f0723-2098-4199-ac63-c2d1f455a866 AccountName: ABC Income AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: ABC Income Total: 0 - Id: 20c91f8b-ed9d-4f71-b235-73be9803e73f AccountName: test_AccountName728799809BC23-3E66-42C9-A47C-F4C3A56961E8 AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: test_AccountName728799809BC23-3E66-42C9-A47C-F4C3A56961E8 Total: 0 - Id: 226c97e7-95ad-4e9f-afdc-3ef8cdfe18b1 AccountName: TestingAPIOUT AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: TestingAPIOUT Total: 0 - Id: 22b8428c-39a8-4963-aa1b-5b6f488935d2 AccountName: Rounding expense AccountType: 2 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: Rounding expense Total: 0 - Id: 22f1b228-c28c-4401-8c84-265141320f3a AccountName: X Income AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: X Income Total: 0 - Id: 23519371-cdfb-490d-b622-d14f284302cf AccountName: Income AJS AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: Income AJS Total: 0 - Id: 2541ae56-bbee-4d06-a4ef-de75e6846788 AccountName: test_AccountName_hendrik_2897209BC23-3E66-42C9-A47C-F4C3A56961E8 AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: test_AccountName_hendrik_2897209BC23-3E66-42C9-A47C-F4C3A56961E8 Total: 0 - Id: 2581dd22-19ff-4be5-99c2-618bf8df6ad2 AccountName: test_AccountName_hendrik_28900209BC23-3E66-42C9-A47C-F4C3A56961E8 AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: test_AccountName_hendrik_28900209BC23-3E66-42C9-A47C-F4C3A56961E8 Total: 0 - Id: 262cd29b-bf3d-4e5f-b588-4bfc1810fc9f AccountName: B Income:A Income:Test Income 03:test_AccountName_h8500789endrik_2209BC23-3E66-42C9-A47C-F4C3A56961E8 AccountType: 1 Ancestors: 'B Income:A Income:Test Income 03:' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: test_AccountName_h8500789endrik_2209BC23-3E66-42C9-A47C-F4C3A56961E8 Total: 0 - Id: 277048ff-5afb-40bf-a6ea-23b0301b7f90 AccountName: Project Management:PM 2 AccountType: 1 Ancestors: 'Project Management:' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: PM 2 Total: 0 - Id: 27dc10e4-cc7e-4099-9a50-0d1d8bc2dcf6 AccountName: Misc Wages AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: Misc Wages Total: 0 - Id: 289cd8fc-4641-4032-ab17-8d53c4fa9a96 AccountName: Test14 AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: Test14 Total: 0 - Id: 29b54a84-a4d3-40a4-ad4c-a54f02d5e518 AccountName: Inactive Income AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: Inactive Income Total: 0 - Id: 2d3fbd56-ce48-4704-a056-e2cf26bbe24e AccountName: Sales AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: Sales Total: 0 - Id: 2e788af9-bc59-4541-883b-e21e854b2ca3 AccountName: Cakes:XYZ Income AccountType: 1 Ancestors: 'Cakes:' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: XYZ Income Total: 0 - Id: 2e9a0fc4-bca5-433d-b575-35c46f42ee19 AccountName: Cakes AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: Cakes Total: 0 - Id: 2f930221-8ff0-4a44-b720-e68fcc47b199 AccountName: Z Other Expense AccountType: 7 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: Z Other Expense Total: 0 - Id: 3034da80-b405-46be-b6eb-f7c2dfadd082 AccountName: Random Income FRE AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: Random Income FRE Total: 0 - Id: 3178bd1a-5075-4d36-9f4b-e23afb17a436 AccountName: Income From Business AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: Income From Business Total: 0 - Id: 34d2af9e-87af-4db9-a9b7-b48f1f50f32c AccountName: Expense Two AccountType: 2 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: Expense Two Total: 0 - Id: 3562943b-95a1-4d5d-8d02-64c4a6102600 AccountName: Expense NCG AccountType: 2 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: Expense NCG Total: 0 - Id: 36533363-045b-416a-b370-93466fc2a4c4 AccountName: test_AccountName_hendrik_220990BC23-3E66-42C9-A47C-F4C3A56961E8 AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: test_AccountName_hendrik_220990BC23-3E66-42C9-A47C-F4C3A56961E8 Total: 0 - Id: 3877416e-8bd4-48fc-9ac4-27aeb67c9af0 AccountName: Test11 AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: Test11 Total: 0 - Id: 39921494-f2de-46aa-8ee0-8f1db89927b0 AccountName: R Expense AccountType: 2 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: R Expense Total: 0 - Id: 3a97ddcb-4894-4567-8c26-a95b8539fb61 AccountName: test_AccountNam235235e_hendrik_2209BC23-3E66-42C9-A47C-F4C3A56961E8 AccountType: 1 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: test_AccountNam235235e_hendrik_2209BC23-3E66-42C9-A47C-F4C3A56961E8 Total: 0 '401': description: You will get this response if the user is not authorised to view the budget '500': description: You will get this response if there is a problem with the data you are sending '503': description: You will get this response if the endpoint is under maintenance '/{cashbookId}/budgets/saveas': post: tags: - core module - budgets summary: 02 Core > Update a Budget description: This endpoint is used to add data to a newly posted budget operationId: 58855460ecc05f169c12a0c0 parameters: - name: cashbookId in: path description: '' required: true schema: type: string requestBody: content: application/json: example: BudgetAmounts: - Id: 09316ac0-cd82-473a-b9a3-6c4275d8a324 AccountName: Cost of Goods Sold AccountType: 8 Ancestors: '' Month1: 0 Month10: 0 Month11: 0 Month12: 0 Month2: 0 Month3: 0 Month4: 0 Month5: 0 Month6: 0 Month7: 0 Month8: 0 Month9: 0 Name: Cost of Goods Sold Total: 0 BudgetId: 0b1c5245-cc6f-4515-9684-1b63bb984d98 IsSaveAs: 1 BudgetName: New Budget_R1API responses: '200': description: You will get this response if the requested API call was successful. '400': description: 'You will get this response if the JSON is not formed correctly, there''s something wrong with the request or if you attempt to send a HTTP API call instead of HTTPS.' '401': description: You will get this response if the user is not authorised to perform this request '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookId}/classifications': get: tags: - classifications - core module summary: 01 Core > Classifications description: This endpoint allows you to retrieve the Classifications that the user has setup in their book to be able to use on transactions such as invoices and bills. operationId: 58a187aaecc05f11982a18c0 parameters: - name: cashbookId in: path description: '' required: true schema: type: string responses: '200': description: You'll get this response when your request to get the classification list is successful. content: application/json: example: - CashbookId: 624fee50-ba4c-4d5b-a5af-d6d6f995b1d6 ClassificationId: 1c88f7b5-320b-4d1e-8d99-41b0005e2a59 Description: IsDefault: false Name: North Sydney Status: 1 '400': description: 'You will get this response if the JSON is not formed correctly, there''s something wrong with the request or if you attempt to send a HTTP API call instead of HTTPS.' '401': description: You will get this response if the user is not authorised to perform this request '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookId}/accounts/{pagesize}': get: tags: - core module - chart of accounts summary: 02 Core > Accounts with Page Size operationId: 58e1de5b03beced2b452266b parameters: - name: cashbookId in: path required: true schema: type: '' - name: pagesize in: path required: true schema: type: '' responses: '200': description: You'll get this response when the request was successful. content: application/json: example: Items: - Id: 00012ec2-56d5-44d9-a8ea-efbd91b1db1e Name: Hire Purchase Liability Description: Hire Purchase Liability AccountType: 16 AccountStatus: 1 AccountCode: '2210-02-01' DefaultTaxCode: '' ParentAccountingCategoryId: 00000000-0000-0000-0000-000000000000 ExportCode: '874' NextPageLink: https://api.reckon.com/r1/624fee50-ba4c-4d5b-a5af-d6d6f995b1d6/accounts/1?$skip=1 Count: '400': description: You will get this response if you send a HTTP instead of HTTPS request or there was something wrong in the payload that you posted '401': description: You will get this response if the user is not authorised '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookid}/invoices/{invoiceId}/approve/true': post: tags: - invoices - invoices module summary: 03 Invoices > Approve an Invoice (header) operationId: 58f84a02ecc05f1be85ab430 parameters: - name: cashbookid in: path description: '' required: true schema: type: string - name: invoiceId in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the requested API call was successful. '/{cashbookid}/items/{pagesize}': get: tags: - items - core module summary: 02 Core > Items with page size description: This endpoint is used for those who wish to determine how much data to retrieve in any single call. The pagesize variable is used to determine the number of responses the API will deliver back. operationId: 59276d01c5007610ecccdfb0 parameters: - name: cashbookid in: path description: '' required: true schema: type: string - name: pagesize in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the API call is successful content: application/json: example: Items: - CashbookId: e17417ac-fc79-4d4d-9ee8-1780b3bc326f FullName: Lego GrossPurchasePrice: 5 GrossSalePrice: 30.95 Id: 026cedf5-7f0e-4cf2-889b-dd51bf760b78 IsTaxInclusive: true ItemCode: '4444' ItemHierarchy: ItemStatus: 1 ItemType: 1 ParentChargeableItemID: 00000000-0000-0000-0000-000000000000 PurchaseAccountName: D Expense PurchaseCategoryId: 72df99c8-df36-487c-86b2-2e4efa373f3d PurchasePrice: 4.5454545455 PurchasePriceAccuracy: 0 PurchasePriceTaxInclusive: true PurchaseTaxId: 540cc034-18f1-4ff8-a32e-2d9417cf01f7 SaleAccountName: Income Parent SaleCategoryId: 6b14ec97-e229-4d96-934c-33ea17129a06 SalePrice: 28.1363636364 SalePriceAccuracy: 2 SalePriceTaxInclusive: true SaleTaxId: e6015088-28f5-4bfe-8085-ff9fc2564efa SaleDescription: SD - Lego SoldOrPurchased: 3 NextPageLink: http://api.reckonone.com:80/e17417ac-fc79-4d4d-9ee8-1780b3bc326f/items/1?subscription-key=<>&$skip=1 Count: '400': description: You will get this response if you send a HTTP instead of HTTPS request or there was something wrong in the payload that you posted '401': description: You will get this response if the user is not authorised or does not have access to the requested resource '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookid}/activitystatements/{pagesize}': get: tags: - core module - activity statements summary: 02 Core > Activity Statements with Page Size description: You will get this response if the user is not authorised or does not have access to the requested resource operationId: 59276d3cc5007610ecccdfb1 parameters: - name: cashbookid in: path description: '' required: true schema: type: string - name: pagesize in: path description: 'Example: 20' required: true schema: type: string responses: '200': description: You will get this response with a successful API call content: application/json: example: Items: - GSTReportID: 079a0e94-507d-447a-86db-1ad785d10bd0 CashbookID: e17417ac-fc79-4d4d-9ee8-1780b3bc326f DocumentID: Description: ReceiptNumber: DueDate: LodgeDate: StartDate: '2016-03-01T00:00:00.0000000+00:00' EndDate: '2016-03-31T00:00:00.0000000+00:00' GSTReportTemplateID: 9116156c-a621-4788-93c9-c418fb98166d IsAmendment: false Status: 1 PeriodInDays: 0 NextPageLink: http://api.reckonone.com:80/e17417ac-fc79-4d4d-9ee8-1780b3bc326f/activitystatements/1?subscription-key=a020f3a98dda4e0387d881720b0fd8c4&$skip=1 Count: '400': description: You will get this response if you send a HTTP instead of HTTPS request or there was something wrong in the payload that you posted '401': description: '' '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookid}/bankaccounts/{pagesize}': get: tags: - bank accounts - core module - banking module summary: 02 Core > Bank Accounts with Page Size description: This endpoint is used for those who wish to determine how much data to retrieve in any single call. The pagesize variable is used to determine the number of responses the API will deliver back. operationId: 59276d5cc5007610ecccdfb2 parameters: - name: cashbookid in: path description: '' required: true schema: type: string - name: pagesize in: path description: '' required: true schema: type: string responses: '200': description: You will get this response when the API call is successful content: application/json: example: Items: - BankAccountID: 00feb5c9-6da3-4603-87d8-d1ee7d6de894 Description: New bank IsBankAccountOpened: true IsCash: false NextPageLink: http://api.reckonone.com:80/e17417ac-fc79-4d4d-9ee8-1780b3bc326f/bankaccounts/1?subscription-key=<>&$skip=1 Count: '400': description: You will get this response if you send a HTTP instead of HTTPS request or there was something wrong in the payload that you posted '401': description: You will get this response if the user is not authorised or does not have access to the requested resource '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookid}/bills/{pagesize}': get: tags: - invoices module - bills summary: 03 Invoices > Bills with Page Size description: This endpoint is used for those who wish to determine how much data to retrieve in any single call. The pagesize variable is used to determine the number of responses the API will deliver back. operationId: 59276da1c5007610ecccdfb3 parameters: - name: cashbookid in: path description: '' required: true schema: type: string - name: pagesize in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the API call is successful content: application/json: example: Items: - BillID: 00567935-af53-4ddb-9927-8fef1e127f71 AccountsPayableCategoryID: c806a197-4fb0-400e-8f93-513a2386bcf6 Balance: 0 BillAmount: 0 BillDate: '2016-03-13T00:00:00.0000000+00:00' BillNumber: BIL4355 CustomerID: 00bb3e7f-bf7d-4533-bb1c-57cfd3917817 CustomerName: AAMI Notes: Reference: Status: 1 IsOverdue: false NextPageLink: http://api.reckonone.com:80/e17417ac-fc79-4d4d-9ee8-1780b3bc326f/bills/1?subscription-key=<>$skip=1 Count: '/{cashbookid}/contacts/{pagesize}': get: tags: - core module - contacts summary: 02 Core > Contacts with Page Size description: This endpoint is used for those who wish to determine how much data to retrieve in any single call. The pagesize variable is used to determine the number of responses the API will deliver back. operationId: 59276db6c5007610ecccdfb4 parameters: - name: cashbookid in: path description: '' required: true schema: type: string - name: pagesize in: path description: '' required: true schema: type: string responses: '200': description: You will get this response when the API call is successful content: application/json: example: Items: - ContactId: 00bb3e7f-bf7d-4533-bb1c-57cfd3917817 CashbookId: e17417ac-fc79-4d4d-9ee8-1780b3bc326f PaymentTermId: CustomerCreditLimit: Description: AAMI FirstNameBranchName: SurnameBusinessName: AAMI Pty Ltd IsCustomer: false IsSupplier: true IsActive: true IsPerson: false IsTpar: false Email: Website: BusinessNumber1: Notes: AreaCode: PhoneNumber: FaxCode: FaxNumber: MobileCode: MobileNumber: IsBusinessAddressDifferent: false IsEmployee: false Addresses: - - NextPageLink: http://api.reckonone.com:80/e17417ac-fc79-4d4d-9ee8-1780b3bc326f/contacts/1?subscription-key=<>&$skip=1 Count: '/{cashbookid}/creditnotes/{pagesize}': get: tags: - invoices summary: 03 Invoices > Credit Notes with Page Size description: This endpoint is used for those who wish to determine how much data to retrieve in any single call. The pagesize variable is used to determine the number of responses the API will deliver back. operationId: 59276df9c5007610ecccdfb5 parameters: - name: cashbookid in: path description: '' required: true schema: type: string - name: pagesize in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the API call is successful content: application/json: example: Items: - Id: 00cec5ee-849c-4bc5-a452-fcb45802b8a2 CashbookId: e17417ac-fc79-4d4d-9ee8-1780b3bc326f AccountsReceivableCategoryId: a0d498f1-8927-4751-8943-a26e8e60f7a5 Balance: 540 CreditNoteAmount: 550 CreditNoteDate: '2016-09-26T00:00:00.0000000+00:00' CreditNoteNumber: CAN0064 CustomerId: 2c2ecc56-6cb0-4811-8616-7c74b3d5ed83 CustomerName: '456' Notes: Reference: Status: 2 NextPageLink: http://api.reckonone.com:80/e17417ac-fc79-4d4d-9ee8-1780b3bc326f/creditnotes/1?subscription-key=<>&$skip=1 Count: '/{cashbookid}/estimates/{pagesize}': get: tags: - invoices - estimates summary: 03 Invoices > Estimates by Page Size description: This endpoint is used for those who wish to determine how much data to retrieve in any single call. The pagesize variable is used to determine the number of responses the API will deliver back. operationId: 59276e13c5007610ecccdfb6 parameters: - name: cashbookid in: path description: '' required: true schema: type: string - name: pagesize in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the API call is successful content: application/json: example: Items: - Id: 001a0e66-6485-4b99-8ae8-1d31d729491b CashbookId: e17417ac-fc79-4d4d-9ee8-1780b3bc326f CustomerId: 1701fda5-a817-4fae-824d-024c38817292 CustomerName: Automation Customer 1 Amount: 45 Date: '2016-11-30T00:00:00.0000000+00:00' ExpiryDate: '2016-12-10T00:00:00.0000000+00:00' Number: EST0051 Reference: Status: 6 NextPageLink: http://api.reckonone.com:80/e17417ac-fc79-4d4d-9ee8-1780b3bc326f/estimates/1?subscription-key=<>&$skip=1 Count: '/{cashbookid}/expenseclaims/{pagesize}': get: tags: - time & expenses module - expenses summary: 07 Time and Expenses > Expenses List by Page Size description: This endpoint is used for those who wish to determine how much data to retrieve in any single call. The pagesize variable is used to determine the number of responses the API will deliver back. operationId: 59276e40c5007610ecccdfb7 parameters: - name: cashbookid in: path description: '' required: true schema: type: string - name: pagesize in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the API call is successful content: application/json: example: Items: - CashbookID: e17417ac-fc79-4d4d-9ee8-1780b3bc326f Id: 0e9a8bac-dd82-4efb-be17-446e81a3ddf3 ClaimAmount: 89.7 ClaimDate: '2016-08-17T00:00:00.0000000+00:00' ClaimNumber: EXP0097 ClaimOrder: 40 CustomerID: CustomerName: EmployeeContactID: 7a900a85-fac7-4f05-bbb4-a16edd8894c0 EmployeeName: Steve Jobs Balance: 0 IsSubProject: false ProjectID: ProjectName: ProjectPath: Status: 1 Unbilled: 0 UserID: NextPageLink: http://api.reckonone.com:80/e17417ac-fc79-4d4d-9ee8-1780b3bc326f/expenseclaims/1?subscription-key=<> Count: '/{cashbookid}/journals/{pagesize}': get: tags: - journals - core module summary: 02 Core > Journals by Page Size description: This endpoint is used for those who wish to determine how much data to retrieve in any single call. The pagesize variable is used to determine the number of responses the API will deliver back. operationId: 59276e6cc5007610ecccdfb9 parameters: - name: cashbookid in: path description: '' required: true schema: type: string - name: pagesize in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the API call is successful content: application/json: example: Items: - AdjustingJournal: false AmountTaxStatus: 3 CashbookId: e17417ac-fc79-4d4d-9ee8-1780b3bc326f FullDescription: JournalDate: '2016-11-28T00:00:00.0000000+00:00' JournalId: 007cad27-abac-4d6c-8cb7-d1863d3d2442 JournalNumber: '00525' JournalStatus: 2 JournalType: 0 JournalTypeRefId: 00000000-0000-0000-0000-000000000000 ReversedJournalId: 00000000-0000-0000-0000-000000000000 Summary: Customer Q opening balance Transactions: - AccountingCategoryId: a0d498f1-8927-4751-8943-a26e8e60f7a5 Billable: false ContactId: 3f93b41b-fa45-40a4-b2ee-867d01de600d Credit: Debit: 89.89 IsReconciled: false JournalEntryId: 0b05211f-151d-4df9-b4d3-f64619843496 JournalId: 007cad27-abac-4d6c-8cb7-d1863d3d2442 Narration: ProjectId: 00000000-0000-0000-0000-000000000000 TaxAmount: TaxGroupId: 00000000-0000-0000-0000-000000000000 TaxModified: false TransType: 1 - AccountingCategoryId: cdd92fed-d712-45e2-b3bf-ded29552cbd7 Billable: false ContactId: 00000000-0000-0000-0000-000000000000 Credit: 89.89 Debit: IsReconciled: false JournalEntryId: 61b5fe75-9a68-4991-98e8-928fb51f6881 JournalId: 007cad27-abac-4d6c-8cb7-d1863d3d2442 Narration: ProjectId: 00000000-0000-0000-0000-000000000000 TaxAmount: TaxGroupId: 00000000-0000-0000-0000-000000000000 TaxModified: false TransType: 0 NextPageLink: http://api.reckonone.com:80/e17417ac-fc79-4d4d-9ee8-1780b3bc326f/journals/1?subscription-key=<>&$skip=1 Count: '400': description: You will get this response if you send a HTTP instead of HTTPS request or there was something wrong in the payload that you posted '401': description: You will get this response if the user is not authorised or does not have access to the requested resource '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookid}/payments/{pagesize}': get: tags: - core module - payments summary: 02 Core > Payments by Page Size description: This endpoint is used for those who wish to determine how much data to retrieve in any single call. The pagesize variable is used to determine the number of responses the API will deliver back. operationId: 59276e84c5007610ecccdfba parameters: - name: cashbookid in: path description: '' required: true schema: type: string - name: pagesize in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the API call is successful content: application/json: example: Items: - Id: 00055f97-ffee-4225-93b8-8e4613b007a4 CashbookId: e17417ac-fc79-4d4d-9ee8-1780b3bc326f BankAccountId: 00feb5c9-6da3-4603-87d8-d1ee7d6de894 Amount: 11 ContactName: AAMI Details: abc PaymentMethodType: 1 PaymentMethodName: Cash IsReconciled: false Reference: def TransDate: '2015-10-10T00:00:00.0000000+00:00' NextPageLink: http://api.reckonone.com:80/e17417ac-fc79-4d4d-9ee8-1780b3bc326f/payments/1?subscription-key=<>&$skip=1 Count: '400': description: You will get this response if you send a HTTP instead of HTTPS request or there was something wrong in the payload that you posted '401': description: You will get this response if the user is not authorised or does not have access to the requested resource '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookid}/projects/{pagesize}': get: tags: - projects summary: 06 Projects > Projects by Page Size description: This endpoint is used for those who wish to determine how much data to retrieve in any single call. The pagesize variable is used to determine the number of responses the API will deliver back. operationId: 59276ed1c5007610ecccdfbb parameters: - name: cashbookid in: path description: '' required: true schema: type: string - name: pagesize in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the API call is successful content: application/json: example: Items: - ID: 0599ddc4-5f78-4d91-91bb-ecad0ece5530 Name: multi contact project Status: 0 NextPageLink: http://api.reckonone.com:80/e17417ac-fc79-4d4d-9ee8-1780b3bc326f/projects/1?subscription-key=<>&$skip=1 Count: '/{cashbookid}/receipts/{pagesize}': get: tags: - core module - receipts summary: 02 Core > Receipts by Page Size description: This endpoint is used for those who wish to determine how much data to retrieve in any single call. The pagesize variable is used to determine the number of responses the API will deliver back. operationId: 59277032ecc05f1450941a7a parameters: - name: cashbookid in: path description: '' required: true schema: type: string - name: pagesize in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the API call is successful content: application/json: example: Items: - Id: 0013ade2-80df-4fed-bac2-7fc1c43790d0 CashbookId: e17417ac-fc79-4d4d-9ee8-1780b3bc326f BankAccountId: 00feb5c9-6da3-4603-87d8-d1ee7d6de894 Amount: 11 ContactName: Desc_AE94D6FA-2BD82002-49BF-874F-48720B990E87 Details: abc PaymentMethodType: 1 PaymentMethodName: Cash IsReconciled: true Reference: def TransDate: '2016-08-25T00:00:00.0000000+00:00' NextPageLink: http://api.reckonone.com:80/e17417ac-fc79-4d4d-9ee8-1780b3bc326f/receipts/1?subscription-key=<>&$skip=1 Count: '400': description: 'You will get this response if the JSON is not formed correctly, there''s something wrong with the request or if you attempt to send a HTTP API call instead of HTTPS.' '401': description: You will get this response if the user is not authorised to perform this request '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookid}/suppliercreditnotes/{pagesize}': get: tags: - supplier credit notes - invoices summary: 03 Invoices > Supplier Credit Notes by Page Size description: This endpoint is used for those who wish to determine how much data to retrieve in any single call. The pagesize variable is used to determine the number of responses the API will deliver back. operationId: 59277070c5007610ecccdfbc parameters: - name: cashbookid in: path description: '' required: true schema: type: string - name: pagesize in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the API call is successful content: application/json: example: Items: - Id: 11daf446-250e-4b16-ad4d-c2ee2db80693 AccountsPayableCategoryID: 4ba37c05-eca4-4c02-a4d7-e72b3e9d4247 Balance: 10 BillAmount: 10 BillDate: '2015-06-03T00:00:00.0000000+00:00' BillNumber: SAN0005 Notes: Reference: Status: 2 SupplierID: b09da867-1e2c-48e3-a9db-dd21b427a6bb SupplierName: City Rail NextPageLink: http://api.reckonone.com:80/e17417ac-fc79-4d4d-9ee8-1780b3bc326f/suppliercreditnotes/1?subscription-key=<>&$skip=1 Count: '/{cashbookid}/terms/{pagesize}': get: tags: - invoices - terms summary: 03 Invoices > Terms by Page Size description: This endpoint is used for those who wish to determine how much data to retrieve in any single call. The pagesize variable is used to determine the number of responses the API will deliver back. operationId: 5927708fecc05f1450941a7b parameters: - name: cashbookid in: path description: '' required: true schema: type: string - name: pagesize in: path description: '' required: true schema: type: string responses: '200': description: You will get this response if the API call is successful content: application/json: example: Items: - Id: 231e67f4-0862-4f3d-aa68-ea7cd6cf3ec9 Name: Day 20 of next month Description: 20th of the following month Type: 0 NextPageLink: http://api.reckonone.com:80/e17417ac-fc79-4d4d-9ee8-1780b3bc326f/terms/1?subscription-key=<>&$skip=1 Count: '/{cashbookId}/projects/{projectid}': delete: tags: - projects - projects module summary: 06 Projects > Delete description: Delete a project operationId: Projects Delete parameters: - name: cashbookId in: path description: Cashbook GUID required: true schema: type: GUID - name: projectid in: path description: Project GUID required: true schema: type: GUID responses: '200': description: '/{cashbookId}/bankaccounts/{bankaccountid}': delete: tags: - banking module - core module - bank accounts summary: 02 Core > Bank Accounts operationId: Delete Bank Account parameters: - name: cashbookId in: path description: cashbook guid required: true schema: type: GUID - name: bankaccountid in: path description: bank account guid required: true schema: type: GUID responses: '200': description: You'll get this response when the request to delete a bank account is successful. '400': description: You will get this response if you send a HTTP instead of HTTPS request or there was something wrong in the payload that you posted '401': description: You will get this response if the user is not authorised or does not have access to the requested resource '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookid}/receipts/{receiptid}': delete: tags: - receipts - core module summary: 02 Core > Receipts description: Delete an existing receipt operationId: Delete a receipt parameters: - name: cashbookid in: path description: cashbook guid required: true schema: type: GUID - name: receiptid in: path description: receipt id required: true schema: type: GUID responses: '200': description: You will get this response if the requested API call was successful. '/{cashbookId}/payments/{paymentid}': delete: tags: - core module - payments summary: 02 Core > Payments description: Delete a payment operationId: Delete a payment parameters: - name: cashbookId in: path description: cashbook id required: true schema: type: GUID - name: paymentid in: path description: payment id required: true schema: type: GUID responses: '200': description: You'll get this response when the request to delete the payment is successful. '400': description: You will get this response if you send a HTTP instead of HTTPS request or there was something wrong in the payload that you posted '401': description: You will get this response if the user is not authorised or does not have access to the requested resource '500': description: You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookid}/bills': put: tags: - bills - invoices module summary: 03 Invoices > Bills operationId: 03-invoices-bills-put parameters: - name: cashbookid in: path description: Reckon One CashBook ID required: true schema: type: GUID responses: '200': description: '/webhooks/v1/{cashbookId}/subscription': post: tags: - webhooks summary: 00 Webhooks - Add description: Add a new webhook subscription to a Reckon One book. operationId: 00-webhooks-add parameters: - name: cashbookId in: path required: true schema: type: string responses: '200': description: '/webhooks/v1/{cashbookId}/subscription/{subscriptionId}': delete: tags: - webhooks summary: 00 Webhooks - Delete description: Delete a webhook subscription from a Reckon One account operationId: 00-webhooks-delete parameters: - name: cashbookId in: path required: true schema: type: string - name: subscriptionId in: path required: true schema: type: string responses: '200': description: '/{cashbookId}/banktransfers/{transferguid}': delete: tags: - bank accounts summary: 01 Core > Bank Transfers (DELETE) operationId: 01-core-bank-transfers parameters: - name: cashbookId in: path required: true schema: type: '' - name: transferguid in: path required: true schema: type: '' requestBody: content: application/json: { } responses: '200': description: You will get this response if your request to delete a bank transfer transaction is processed successfully. content: application/json: { } put: summary: 01 Core > Bank Transfers (PUT) operationId: 5c189bd9fe27f4f67380694c parameters: - name: cashbookId in: path required: true schema: type: '' - name: transferguid in: path required: true schema: type: '' requestBody: content: application/json: { } responses: '200': description: You will get this response if your request is processed successfully. content: application/json: { } '/PaymentMethods/{regionCode}': get: tags: - receipts summary: 01 Core > Payment Methods operationId: 01-core-payment-methods parameters: - name: regionCode in: path description: "Australia: AU,\nNew Zealand: NZ,\nUnited Kingdom/GB: UK" required: true schema: type: '' responses: '200': description: You will get this response when the call to get the payment method is successful content: application/json: example: "{\n \"Id\": \"057ecf9c-b966-4fe5-93e5-edc8812344b3\",\n \"Description\": \"Cash\",\n \"SortOrder\": 1\n },\n {\n \"Id\": \"03c587a6-5fac-4894-8d3f-ce52f9f4162d\",\n \"Description\": \"Cheque\",\n \"SortOrder\": 2\n },\n {\n \"Id\": \"4d08d382-0666-4c70-bc59-e20092d44703\",\n \"Description\": \"Direct Deposit\",\n \"SortOrder\": 3\n },\n {\n \"Id\": \"ed6df814-f7cd-40ee-9347-934d7451e278\",\n \"Description\": \"EFTPOS\",\n \"SortOrder\": 4\n },\n {\n \"Id\": \"6e77c57d-63e3-4b12-bebd-c1d3156707bb\",\n \"Description\": \"BPay\",\n \"SortOrder\": 5\n },\n {\n \"Id\": \"56dc8f56-2c78-4f0f-9dc6-cd0e2844ae69\",\n \"Description\": \"Visa\",\n \"SortOrder\": 6\n },\n {\n \"Id\": \"187e4148-22b4-45d3-873b-967faae37330\",\n \"Description\": \"MasterCard\",\n \"SortOrder\": 7\n },\n {\n \"Id\": \"184f8888-f1dd-4bdd-ae71-02a3629fc793\",\n \"Description\": \"Diners\",\n \"SortOrder\": 8\n },\n {\n \"Id\": \"bfa1b2a5-7efb-4638-aad7-2c8a78f4cff8\",\n \"Description\": \"American Express\",\n \"SortOrder\": 9\n },\n {\n \"Id\": \"7fe668d1-9531-4d57-988a-3f17cd177c3b\",\n \"Description\": \"Other\",\n \"SortOrder\": 10\n }" '/{cashbookid}/items/detailed/{itemid}': get: summary: 02 Core > Get Items By ID operationId: 02-core-get-items-by-id parameters: - name: cashbookid in: path description: Cashbook id required: true schema: type: guid - name: itemid in: path description: item id required: true schema: type: guid responses: '200': description: '/{cashbookId}/banktransfers': get: tags: - bank accounts summary: 01 Core > Bank Transfers List (GET) operationId: 5c1897352f406c7dffa78d6d parameters: - name: cashbookId in: path required: true schema: type: '' responses: '200': description: You will get this response if your request is processed successfully. content: application/json: { } post: tags: - bank accounts summary: 01 Core > Bank Transfers (POST) operationId: 5c1898e9435c31c6c21437cf parameters: - name: cashbookId in: path required: true schema: type: '' requestBody: content: application/json: example: TransferDate: '2018-09-25' Description: Transfer of funds FromBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 ToBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 Amount: 200 responses: '200': description: You will get this response if your request is processed successfully. content: application/json: { } '/{cashbookId}/banktransfers/{transferId}': get: tags: - bank accounts summary: 01 Core > Bank Transfers by Id (GET) description: You can get a bank transfer transaction's details from this endpoint. operationId: 5c1898662d678e79213a129c parameters: - name: cashbookId in: path required: true schema: type: '' - name: transferId in: path required: true schema: type: '' responses: '200': description: You will get this response if your request is processed successfully. content: application/json: { } '/{cashbookid}/companyinfo/address': put: tags: - core module summary: 01 Core > Company Info > Address description: This endpoint allows you to update the Company's legal and/physical address of the Book you have requested API data from. operationId: 5d966aceef95971c38d20835 parameters: - name: cashbookid in: path description: '' required: true schema: type: string requestBody: description: Use this endpoint to update Company's legal and/ physical address. content: application/json: example: LegalAddress: Line1: 100 Pacific Highway Line2: '' Line3: Town: North Sydney Suburb: North Sydney State: New South Wales Postcode: '2060' Country: Australia IsInternational: false PhysicalAddress: Line1: 1 Sydney Way Line2: '' Line3: '' Town: Sydney Suburb: Sydney State: New South Wales Postcode: '2000' Country: '' IsInternational: false PhysicalSameAsLegal: false responses: '200': description: This is the response you'll get once the request is successful. content: application/json: example: "{\n \"BranchNumber\": \"001\",\n \"CashbookId\": \"624fee50-ba4c-4d5b-a5af-d6d6f995b1d6\",\n \"CompanyId\": \"b6288c93-bd0f-4432-9807-0f541e0097cf\",\n \"CompanyName\": \"Ifti Pty Ltd\",\n \"CompanyReference\": null,\n \"ContactEmail\": \"first.last@email.com\",\n \"ContactName\": null,\n \"FaxCode\": null,\n \"FaxNumber\": null,\n \"LegalAddress\": {\n \"AddressId\": \"0efecece-3530-463d-817f-e27cedc2adee\",\n \"Line1\": \"100 Pacific Highway\",\n \"Line2\": \"\",\n \"Line3\": null,\n \"Town\": \"North Sydney\",\n \"Suburb\": \"North Sydney\",\n \"State\": \"New South Wales\",\n \"Postcode\": \"2060\",\n \"Country\": \"Australia\",\n \"AddressType\": null,\n \"IsInternational\": null\n },\n \"LegalName\": \"Ifti Pty Ltd\",\n \"MobileCode\": null,\n \"MobileNumber\": null,\n \"PhoneCode\": null,\n \"PhoneNumber\": null,\n \"PhysicalAddress\": {\n \"AddressId\": \"da8157bc-3f0e-4767-9d16-94ced26804cd\",\n \"Line1\": \"1 Sydney Way\",\n \"Line2\": \"\",\n \"Line3\": \"\",\n \"Town\": \"Sydney\",\n \"Suburb\": \"Sydney\",\n \"State\": \"New South Wales\",\n \"Postcode\": \"2000\",\n \"Country\": \"\",\n \"AddressType\": null,\n \"IsInternational\": null\n },\n \"LegalName\": \"Ifti Pty Ltd\",\n \"MobileCode\": null,\n \"MobileNumber\": null,\n \"PhoneCode\": null,\n \"PhoneNumber\": null,\n \"PhysicalAddress\": {\n \"AddressId\": \"da8157bc-3f0e-4767-9d16-94ced26804cd\",\n \"Line1\": \"3 physical\",\n \"Line2\": \"4 physical\",\n \"Line3\": \"\",\n \"Town\": \"North Sydney\",\n \"Suburb\": \"North Sydney\",\n \"State\": \"New South Wales\",\n \"Postcode\": \"2066\",\n \"Country\": \"\",\n \"AddressType\": null,\n \"IsInternational\": null\n },\n \"TaxNumber\": \" 70 277 164 514\",\n \"Website\": null\n}" '400': description: You will get this error if you send a HTTP instead of HTTPS request or there was something wrong in the payload that you posted '401': description: You will get this response if the user is not authorised to access the resource. '500': description: You will get this response if there is an error on our end. Please email reckonapi@reckon.com if this continues '/{cashbookId}/payroll/contacts': post: tags: - payroll module summary: 09 Payroll > Contact (POST) description: Create Employees and add employment related data in Reckon One Payroll operationId: 5dba6206b9467b0874ec4c61 parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' requestBody: content: application/json: { } responses: '200': description: You will get this response if your request is processed successfully. content: application/json: example: 2a3c082b-0027-4376-b5ef-8b15f6d732ac '400': description: 'You will get this when the user is not authorised for either the book, or you do not have Payroll module enabled.' '500': description: You will get this response if there is a error on our end. Please email apisupport@reckon.com if this continues get: tags: - payroll module summary: 09 Payroll > Contacts (GET) description: Get the list of Employees data from Reckon One Payroll operationId: 5dba7c03050daf8aeecb6910 parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' requestBody: content: application/json: example: TransferDate: '2018-09-25' Description: Transfer of funds FromBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 ToBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 Amount: 200 responses: '200': description: You will get this response if your request is processed successfully. content: application/json: example: "[\r\n {\r\n \"EmployeeId\": \"318253cf-8f81-452a-bda4-56fe6e8505a5\",\r\n \"FirstName\": \"Reece\",\r\n \"LastName\": \"Montgomerie\",\r\n \"EmployeeNumber\": null,\r\n \"IsComplete\": false,\r\n \"IsActive\": true,\r\n \"EmploymentType\": null,\r\n \"PayrollEmail\": null\r\n },\r\n \"EmployeeId\": \"42f3a2ae-61d3-4dc8-8682-4448e1d6a930\",\r\n \"FirstName\": \"James\",\r\n \"LastName\": \"Hollis\",\r\n \"EmployeeNumber\": null,\r\n \"IsComplete\": false,\r\n \"IsActive\": true,\r\n \"EmploymentType\": null,\r\n \"PayrollEmail\": null\r\n }\r\n]" '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. '/{cashbookId}/payroll/contacts/{employeeid}': get: tags: - payroll module summary: 09 Payroll Contact by Id (GET) description: Get an Employee and it's employment related data from Reckon One Payroll operationId: 5dba6cf9d16f065cadf0363c parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' - name: employeeid in: path description: Employee's Id required: true schema: type: '' requestBody: content: application/json: example: TransferDate: '2018-09-25' Description: Transfer of funds FromBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 ToBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 Amount: 200 responses: '200': description: You will get this response if your request is processed successfully. content: application/json: { } '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. '/{cashbookId}/invoices/{invoiceid}/draft': post: tags: - invoices summary: 03 Invoices > Invoices > Draft description: 'Change status of an Invoice from Approved to Draft [customer] invoice in a book by its unique ID. Only required if the invoices module level is ''medium''.' operationId: 5ebcd25a8c50304139a242eb parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: invoiceid in: path description: '' required: true schema: type: string responses: '200': description: '/{cashbookId}/payroll/leaveitems': get: tags: - payroll module summary: 09 Payroll > Leave Items (GET) description: Get the list of Payroll Leave Items from Reckon One Payroll operationId: 5efd4844ae41065006a038b1 parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' requestBody: content: application/json: example: TransferDate: '2018-09-25' Description: Transfer of funds FromBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 ToBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 Amount: 200 responses: '200': description: You will get this response if your request is processed successfully. content: application/json: { } '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. post: tags: - payroll module summary: 09 Payroll > Leave Item (POST) description: Create a Payroll Leave Item in Reckon One Payroll operationId: 5efd71aa4e4c3fd695d1151e parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' requestBody: content: application/json: example: TransferDate: '2018-09-25' Description: Transfer of funds FromBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 ToBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 Amount: 200 responses: '200': description: You will get this response if your request is processed successfully. content: application/json: { } '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. '/{cashbookId}/payroll/payrollitems': get: tags: - payroll module summary: 09 Payroll Items (GET) description: Get the list of Payroll Items from Reckon One Payroll operationId: 5efd4aea68a95055bc9f3f4d parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' requestBody: content: application/json: example: TransferDate: '2018-09-25' Description: Transfer of funds FromBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 ToBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 Amount: 200 responses: '200': description: You will get this response if your request is processed successfully. content: application/json: { } '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. post: tags: - payroll module summary: 09 Payroll > Payroll Items (POST) description: Create Payroll Item in Reckon One Payroll operationId: 5efd629e68d7a349b3aa01a1 parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' requestBody: content: application/json: example: TransferDate: '2018-09-25' Description: Transfer of funds FromBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 ToBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 Amount: 200 responses: '200': description: You will get this response if your request is processed successfully. content: application/json: { } '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. '/{cashbookId}/payroll/superitems': get: tags: - payroll module summary: 09 Payroll Super Items (GET) description: Get the list of Payroll Super Items from Reckon One Payroll operationId: 5efd4f01164b596d6a1a5229 parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' requestBody: content: application/json: example: TransferDate: '2018-09-25' Description: Transfer of funds FromBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 ToBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 Amount: 200 responses: '200': description: You will get this response if your request is processed successfully. content: application/json: { } '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. post: tags: - payroll module summary: 08 Payroll > Super Item (POST) description: Create a Super type Item in Reckon One Payroll operationId: 5efd723bf5c5daa3c7b73786 parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' requestBody: content: application/json: example: TransferDate: '2018-09-25' Description: Transfer of funds FromBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 ToBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 Amount: 200 responses: '200': description: You will get this response if your request is processed successfully. content: application/json: { } '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. '/{cashbookId}/payroll/payruns': get: tags: - payroll module summary: 09 Payroll > Pay runs (GET) description: Get the list of pay runs from Reckon One Payroll operationId: 5efd4f40a19754ca2734b94e parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' requestBody: content: application/json: example: TransferDate: '2018-09-25' Description: Transfer of funds FromBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 ToBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 Amount: 200 responses: '200': description: You will get this response if your request is processed successfully. content: application/json: { } '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. post: tags: - payroll module summary: 09 Payroll > Add Pay run (POST) description: Create a pay run in Reckon One Payroll operationId: 5efd61da8e9e20fee71ecef8 parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' requestBody: content: application/json: { } responses: '200': description: You will get this response if your request is processed successfully. content: application/json: example: 2a3c082b-0027-4376-b5ef-8b15f6d732ac '400': description: 'You will get this when the user is not authorised for either the book, or you do not have Payroll module enabled.' '500': description: You will get this response if there is a error on our end. Please email apisupport@reckon.com if this continues '/{cashbookId}/payroll/payruns/{payrun-id}': get: tags: - payroll module summary: 09 Payroll > Pay run by ID (GET) description: Get the list of pay runs from Reckon One Payroll operationId: 5efd50698756157e19d84b27 parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' - name: payrun-id in: path description: Pay run Id required: true schema: type: '' requestBody: content: application/json: example: TransferDate: '2018-09-25' Description: Transfer of funds FromBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 ToBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 Amount: 200 responses: '200': description: You will get this response if your request is processed successfully. content: application/json: { } '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. delete: tags: - payroll module summary: 09 Payroll > Pay run by ID (DEL) description: Delete a pay run from Reckon One Payroll operationId: 5efd51cdad0cbf8ed2a0fd27 parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' - name: payrun-id in: path description: Pay run ID required: true schema: type: '' requestBody: content: application/json: example: TransferDate: '2018-09-25' Description: Transfer of funds FromBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 ToBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 Amount: 200 responses: '200': description: You will get this response if your request is processed successfully. content: application/json: { } '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. '/{cashbookId}/payroll/leaveitems/{payroll-item-id}': put: tags: - payroll module summary: 08 Payroll > Leave Items (PUT) description: Update a Payroll Leave Item in Reckon One Payroll operationId: 5efd72cee60e123723ee26e7 parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' - name: payroll-item-id in: path description: Payroll Item's Id required: true schema: type: '' requestBody: content: application/json: example: TransferDate: '2018-09-25' Description: Transfer of funds FromBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 ToBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 Amount: 200 responses: '200': description: You will get this response if your request is processed successfully. content: application/json: { } '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. '/{cashbookId}/payroll/superitems/{super-item-id}': put: tags: - payroll module summary: 09 Payroll > Super Items (PUT) description: Update a Payroll Super Item in Reckon One Payroll operationId: 5efd73316a8a995497e7ee0c parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' - name: super-item-id in: path description: Super Item's Id required: true schema: type: '' requestBody: content: application/json: example: TransferDate: '2018-09-25' Description: Transfer of funds FromBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 ToBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 Amount: 200 responses: '200': description: You will get this response if your request is processed successfully. content: application/json: { } '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. '/{cashbookId}/payroll/payrollitems/{payroll-item-id}': put: tags: - payroll module summary: 09 Payroll > Payroll Items (PUT) description: Update a Payroll Item in Reckon One Payroll operationId: 5efd73a81dbff1f7609c486c parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' - name: payroll-item-id in: path description: Payroll Item's Id required: true schema: type: '' requestBody: content: application/json: example: TransferDate: '2018-09-25' Description: Transfer of funds FromBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 ToBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 Amount: 200 responses: '200': description: You will get this response if your request is processed successfully. content: application/json: { } '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. delete: tags: - payroll module summary: 09 Payroll > Payroll Items (DELETE) description: Delete a Payroll Item in Reckon One Payroll operationId: 5f56ea1521fdcb0dbd47dc43 parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' - name: payroll-item-id in: path description: Payroll Item's Id required: true schema: type: '' requestBody: content: application/json: example: TransferDate: '2018-09-25' Description: Transfer of funds FromBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 ToBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 Amount: 200 responses: '200': description: You will get this response if your request is processed successfully. content: application/json: { } '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. '/{cashbookId}/payroll/contacts/{employee-id}': put: tags: - payroll module summary: 09 Payroll > Contacts (PUT) description: Update an Employee's record in Reckon One Payroll operationId: 5efd7402e726382e28cc7243 parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' - name: employee-id in: path required: true schema: type: '' requestBody: content: application/json: example: TransferDate: '2018-09-25' Description: Transfer of funds FromBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 ToBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 Amount: 200 responses: '200': description: You will get this response if your request is processed successfully. content: application/json: { } '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. '/{cashbookId}/payroll/payruns/{payrun-id}/employees/{employee-id}/earnings': post: tags: - payroll module summary: 09 Payroll > Pay run > Add earnings line (POST) description: Add an earnings line in a pay run in Reckon One Payroll operationId: 5efd784f11a9840e6a46e7e7 parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' - name: payrun-id in: path description: Pay run Id required: true schema: type: '' - name: employee-id in: path description: Employee's Id required: true schema: type: '' requestBody: content: application/json: { } responses: '200': description: You will get this response if your request is processed successfully. content: application/json: example: 2a3c082b-0027-4376-b5ef-8b15f6d732ac '400': description: 'You will get this when the user is not authorised for either the book, or you do not have Payroll module enabled.' '500': description: You will get this response if there is a error on our end. Please email apisupport@reckon.com if this continues '/{cashbookId}/payroll/payruns/{payrun-id}/employees/{payrunEmployeeId}/earnings/{earnings-item-lineId}': delete: tags: - payroll module summary: 09 Payroll > Pay run > Delete an earnings line (DEL) description: Delete an earnings line from a pay run in Reckon One Payroll operationId: 5efd7b1da04e5c7da1023f9d parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' - name: payrun-id in: path description: Pay run Id required: true schema: type: '' - name: payrunEmployeeId in: path description: Employee Id from the Pay run required: true schema: type: '' - name: earnings-item-lineId in: path description: Earning item's lineId from the Pay run required: true schema: type: '' requestBody: content: application/json: { } responses: '200': description: You will get this response if your request is processed successfully. content: application/json: example: 2a3c082b-0027-4376-b5ef-8b15f6d732ac '400': description: 'You will get this when the user is not authorised for either the book, or you do not have Payroll module enabled.' '500': description: You will get this response if there is a error on our end. Please email apisupport@reckon.com if this continues '/{cashbookId}/payroll/payruns/{payrun-id}/employees/{employee-id}/earnings/{earning-item-id}': put: tags: - payroll module summary: '09 Payroll > Pay run > Update an earnings line (PUT) ' description: Update an earnings line in a pay run in Reckon One Payroll operationId: 5efd7dcd85caea9f0484e67c parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' - name: payrun-id in: path description: Pay run Id required: true schema: type: '' - name: employee-id in: path description: Employee's Id required: true schema: type: '' - name: earning-item-id in: path description: Earning Item's Id required: true schema: type: '' requestBody: content: application/json: { } responses: '200': description: You will get this response if your request is processed successfully. content: application/json: example: 2a3c082b-0027-4376-b5ef-8b15f6d732ac '400': description: 'You will get this when the user is not authorised for either the book, or you do not have Payroll module enabled.' '500': description: You will get this response if there is a error on our end. Please email apisupport@reckon.com if this continues '/{cashbookId}/payroll/payruns/{payrun-id}/employees/{employee-id}/allowances': post: tags: - payroll module summary: 09 Payroll > Pay run > Add allowance line (POST) description: Add an allowance line in a pay run in Reckon One Payroll operationId: 5efd8064634667805e972c46 parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' - name: payrun-id in: path description: Pay run Id required: true schema: type: '' - name: employee-id in: path description: Employee's Id required: true schema: type: '' requestBody: content: application/json: { } responses: '200': description: You will get this response if your request is processed successfully. content: application/json: example: 2a3c082b-0027-4376-b5ef-8b15f6d732ac '400': description: 'You will get this when the user is not authorised for either the book, or you do not have Payroll module enabled.' '500': description: You will get this response if there is a error on our end. Please email apisupport@reckon.com if this continues '/{cashbookId}/payroll/payruns/{payrun-id}/employees/{employee-id}/allowances/{allowance-id}': put: tags: - payroll module summary: 09 Payroll > Pay run > Update an allowance line (PUT) description: Update an allowance line in a pay run in Reckon One Payroll operationId: 5efd80aa6876ccfa792ea3cc parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' - name: payrun-id in: path description: Pay run Id required: true schema: type: '' - name: employee-id in: path description: Employee's Id required: true schema: type: '' - name: allowance-id in: path required: true schema: type: '' requestBody: content: application/json: { } responses: '200': description: You will get this response if your request is processed successfully. content: application/json: example: 2a3c082b-0027-4376-b5ef-8b15f6d732ac '400': description: 'You will get this when the user is not authorised for either the book, or you do not have Payroll module enabled.' '500': description: You will get this response if there is a error on our end. Please email apisupport@reckon.com if this continues '/{cashbookId}/payroll/payruns/{payrun-id}/employees/{payrunEmployeeId}/allowances/{allowance-item-lineId}': delete: tags: - payroll module summary: 09 Payroll > Pay run > Delete an allowance line (DEL) description: Delete an allowance line from a pay run in Reckon One Payroll operationId: 5efd82951df39af540a97ada parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' - name: payrun-id in: path description: Pay run Id required: true schema: type: '' - name: payrunEmployeeId in: path description: Employee Id from the Pay run required: true schema: type: '' - name: allowance-item-lineId in: path description: Allowance item's lineId from the Pay run required: true schema: type: '' requestBody: content: application/json: { } responses: '200': description: You will get this response if your request is processed successfully. content: application/json: example: 2a3c082b-0027-4376-b5ef-8b15f6d732ac '400': description: 'You will get this when the user is not authorised for either the book, or you do not have Payroll module enabled.' '500': description: You will get this response if there is a error on our end. Please email apisupport@reckon.com if this continues '/{cashbookId}/payroll/payruns/{payrun-id}/employees/{employee-id}/deductions': post: tags: - payroll module summary: 09 Payroll > Pay run > Add deduction line (POST) description: Add a deduction line in a pay run in Reckon One Payroll operationId: 5efd84988682bd538cbe9d07 parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' - name: payrun-id in: path description: Pay run Id required: true schema: type: '' - name: employee-id in: path description: Employee's Id required: true schema: type: '' requestBody: content: application/json: { } responses: '200': description: You will get this response if your request is processed successfully. content: application/json: example: 2a3c082b-0027-4376-b5ef-8b15f6d732ac '400': description: 'You will get this when the user is not authorised for either the book, or you do not have Payroll module enabled.' '500': description: You will get this response if there is a error on our end. Please email apisupport@reckon.com if this continues '/{cashbookId}/payroll/payruns/{payrun-id}/employees/{employee-id}/deductions/{deduction-item-id}': put: tags: - payroll module summary: 09 Payroll > Pay run > Update a Deduction line (PUT) description: Update a deduction line in a pay run in Reckon One Payroll operationId: 5efd84c1b0a54ddbf90ac091 parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' - name: payrun-id in: path description: Pay run Id required: true schema: type: '' - name: employee-id in: path description: Employee's Id required: true schema: type: '' - name: deduction-item-id in: path description: Deduction Item's Id required: true schema: type: '' requestBody: content: application/json: { } responses: '200': description: You will get this response if your request is processed successfully. content: application/json: example: 2a3c082b-0027-4376-b5ef-8b15f6d732ac '400': description: 'You will get this when the user is not authorised for either the book, or you do not have Payroll module enabled.' '500': description: You will get this response if there is a error on our end. Please email apisupport@reckon.com if this continues '/{cashbookId}/payroll/payruns/{payrun-id}/employees/{payrunEmployeeId}/deductions/{deduction-item-lineId}': delete: tags: - payroll module summary: 09 Payroll > Pay run > Delete a Deduction line (DEL) description: Delete a Deduction line from a pay run in Reckon One Payroll operationId: 5efd85419cb113884e48ca49 parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' - name: payrun-id in: path description: Pay run Id required: true schema: type: '' - name: payrunEmployeeId in: path description: Employee Id from the Pay run required: true schema: type: '' - name: deduction-item-lineId in: path description: Deduction item's lineId from the Pay run required: true schema: type: '' requestBody: content: application/json: { } responses: '200': description: You will get this response if your request is processed successfully. content: application/json: example: 2a3c082b-0027-4376-b5ef-8b15f6d732ac '400': description: 'You will get this when the user is not authorised for either the book, or you do not have Payroll module enabled.' '500': description: You will get this response if there is a error on our end. Please email apisupport@reckon.com if this continues '/{cashbookId}/payroll/payslips/send': post: tags: - payroll module summary: 09 Payroll > Email Payslip (POST) description: Email a Payslip from Reckon One Payroll operationId: 5efd86172f4996d5b3133996 parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: '' requestBody: content: application/json: { } responses: '200': description: You will get this response if your request is processed successfully. content: application/json: example: 2a3c082b-0027-4376-b5ef-8b15f6d732ac '400': description: 'You will get this when the user is not authorised for either the book, or you do not have Payroll module enabled.' '500': description: You will get this response if there is a error on our end. Please email apisupport@reckon.com if this continues /integrations/receiptBank/*: get: summary: integrations description: Ping this endpoint to determine if the service is available. No cashbook ID is required operationId: 5f2165128c8c7eab99a2a224 parameters: - name: X-RB-Hostname in: header description: X-RB-Hostname required: true schema: type: string responses: '200': description: You will get this response if the service is available '404': description: You will get this response if the service is down '500': description: "You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues\n" post: summary: integrations description: Add a new webhook subscription to a Reckon One book. operationId: 5f2165a1e9b4758bf9655d1a parameters: - name: X-RB-Hostname in: header description: X-RB-Hostname required: true schema: type: string responses: '200': description: '/{cashbookId}/payroll/contacts/personal/{employeeId}': get: tags: - payroll module summary: 09 Payroll > Contacts > Personal (GET) description: Get the Employee's Personal tab data from Reckon One Payroll operationId: 5f333a3170a23e33296709a9 parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: GUID - name: employeeId in: path description: The Employee's Id required: true schema: type: GUID requestBody: content: application/json: example: TransferDate: '2018-09-25' Description: Transfer of funds FromBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 ToBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 Amount: 200 responses: '200': description: You will get this response if your request is processed successfully. content: application/json: example: "[\r\n {\r\n \"EmployeeId\": \"318253cf-8f81-452a-bda4-56fe6e8505a5\",\r\n \"FirstName\": \"Reece\",\r\n \"LastName\": \"Montgomerie\",\r\n \"EmployeeNumber\": null,\r\n \"IsComplete\": false,\r\n \"IsActive\": true,\r\n \"EmploymentType\": null,\r\n \"PayrollEmail\": null\r\n },\r\n \"EmployeeId\": \"42f3a2ae-61d3-4dc8-8682-4448e1d6a930\",\r\n \"FirstName\": \"James\",\r\n \"LastName\": \"Hollis\",\r\n \"EmployeeNumber\": null,\r\n \"IsComplete\": false,\r\n \"IsActive\": true,\r\n \"EmploymentType\": null,\r\n \"PayrollEmail\": null\r\n }\r\n]" '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. '/{cashbookId}/payroll/contacts/employment/{employeeId}': get: tags: - payroll module summary: 09 Payroll > Contacts > Employment (GET) description: Get the Employee's Employment tab data from Reckon One Payroll operationId: 5f333ac8b2416558ba1be89c parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: GUID - name: employeeId in: path description: The Employee's Id required: true schema: type: GUID requestBody: content: application/json: example: TransferDate: '2018-09-25' Description: Transfer of funds FromBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 ToBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 Amount: 200 responses: '200': description: You will get this response if your request is processed successfully. content: application/json: example: "[\r\n {\r\n \"EmployeeId\": \"318253cf-8f81-452a-bda4-56fe6e8505a5\",\r\n \"FirstName\": \"Reece\",\r\n \"LastName\": \"Montgomerie\",\r\n \"EmployeeNumber\": null,\r\n \"IsComplete\": false,\r\n \"IsActive\": true,\r\n \"EmploymentType\": null,\r\n \"PayrollEmail\": null\r\n },\r\n \"EmployeeId\": \"42f3a2ae-61d3-4dc8-8682-4448e1d6a930\",\r\n \"FirstName\": \"James\",\r\n \"LastName\": \"Hollis\",\r\n \"EmployeeNumber\": null,\r\n \"IsComplete\": false,\r\n \"IsActive\": true,\r\n \"EmploymentType\": null,\r\n \"PayrollEmail\": null\r\n }\r\n]" '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. '/{cashbookId}/payroll/contacts/tax/{employeeId}': get: tags: - payroll module summary: 09 Payroll > Contacts > Tax (GET) description: Get the Employee's Tax tab data from Reckon One Payroll operationId: 5f333b06f438eb48329d37dd parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: GUID - name: employeeId in: path description: The Employee's Id required: true schema: type: GUID requestBody: content: application/json: example: TransferDate: '2018-09-25' Description: Transfer of funds FromBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 ToBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 Amount: 200 responses: '200': description: You will get this response if your request is processed successfully. content: application/json: example: "[\r\n {\r\n \"EmployeeId\": \"318253cf-8f81-452a-bda4-56fe6e8505a5\",\r\n \"FirstName\": \"Reece\",\r\n \"LastName\": \"Montgomerie\",\r\n \"EmployeeNumber\": null,\r\n \"IsComplete\": false,\r\n \"IsActive\": true,\r\n \"EmploymentType\": null,\r\n \"PayrollEmail\": null\r\n },\r\n \"EmployeeId\": \"42f3a2ae-61d3-4dc8-8682-4448e1d6a930\",\r\n \"FirstName\": \"James\",\r\n \"LastName\": \"Hollis\",\r\n \"EmployeeNumber\": null,\r\n \"IsComplete\": false,\r\n \"IsActive\": true,\r\n \"EmploymentType\": null,\r\n \"PayrollEmail\": null\r\n }\r\n]" '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. '/{cashbookId}/payroll/contacts/{employeeId}/leave': get: tags: - payroll module summary: 09 Payroll > Contacts > Leave (GET) description: Get the Employee's Leave tab data from Reckon One Payroll operationId: 5f333b3c1ab8511c01f6fd1d parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: GUID - name: employeeId in: path description: The Employee's Id required: true schema: type: GUID requestBody: content: application/json: example: TransferDate: '2018-09-25' Description: Transfer of funds FromBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 ToBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 Amount: 200 responses: '200': description: You will get this response if your request is processed successfully. content: application/json: example: "[\r\n {\r\n \"EmployeeId\": \"318253cf-8f81-452a-bda4-56fe6e8505a5\",\r\n \"FirstName\": \"Reece\",\r\n \"LastName\": \"Montgomerie\",\r\n \"EmployeeNumber\": null,\r\n \"IsComplete\": false,\r\n \"IsActive\": true,\r\n \"EmploymentType\": null,\r\n \"PayrollEmail\": null\r\n },\r\n \"EmployeeId\": \"42f3a2ae-61d3-4dc8-8682-4448e1d6a930\",\r\n \"FirstName\": \"James\",\r\n \"LastName\": \"Hollis\",\r\n \"EmployeeNumber\": null,\r\n \"IsComplete\": false,\r\n \"IsActive\": true,\r\n \"EmploymentType\": null,\r\n \"PayrollEmail\": null\r\n }\r\n]" '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. '/{cashbookId}/reports/top10suppliers/{isFavourite}': post: tags: - reports summary: 80 Reports > Top 10 Suppliers Report description: Get Top 10 Suppliers Report with POST operationId: 60139026dc195530d09f58b0 parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: isFavourite in: path description: '' required: true schema: type: string responses: '200': description: '/{cashbookId}/reports/top10customers/{isFavourite}': post: tags: - reports summary: 80 Reports > Top 10 Customers Report description: Get Top 10 Customers Report with POST operationId: 601390d5ca78100676aa83a0 parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: isFavourite in: path description: '' required: true schema: type: string responses: '200': description: '/{cashbookId}/reports/ledgertransactions/{isFavourite}': post: tags: - reports summary: 80 Reports > Ledger Transactions description: Get Ledger Transactions Report with POST operationId: 601391086feba1834022b739 parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: isFavourite in: path description: '' required: true schema: type: string responses: '200': description: '/{cashbookId}/reports/transactionlineitems/{isFavourite}': post: tags: - reports summary: 80 Reports > Transaction Line Items description: Get Transaction Line Items Report with POST operationId: 60139173092a3cfa5b1a7ff7 parameters: - name: cashbookId in: path description: '' required: true schema: type: string - name: isFavourite in: path description: '' required: true schema: type: string responses: '200': description: '/{cashbookId}/payroll/payschedules': get: tags: - payroll module summary: 09 Payroll > Pay Schedules list (GET) description: Get the list of Payroll Schedules from Reckon One Payroll operationId: 6102122d5ce49ff039ecd70d parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: GUID responses: '200': description: You will get this response if your request is processed successfully. content: application/json: example: - Id: 2e23d545-6758-4cd9-9669-2b0bd09ec64d Name: Weekly Schedule PayFrequency: Id: 1 Name: Weekly StartPayPeriodDate: '2021-07-01' EndPayPeriodDate: '2021-07-05' OriginalEndPayPeriodDate: '2021-07-05' OriginalNextPaymentDate: '2021-07-02' NextPaymentDate: '2021-07-02' - Id: a9a40b9b-4d62-463d-9a1b-9e4bc6dbba3a Name: Monthly Schedule PayFrequency: Id: 3 Name: Monthly StartPayPeriodDate: '2021-07-01' EndPayPeriodDate: '2021-07-31' OriginalEndPayPeriodDate: '2021-07-31' OriginalNextPaymentDate: '2021-07-22' NextPaymentDate: '2021-07-22' '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. post: tags: - payroll module summary: 09 Payroll > Pay Schedule (POST) description: Create a Payroll Schedule in Reckon One Payroll operationId: 610215e71ed669d171d8abd3 parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: GUID requestBody: content: application/json: example: Name: Schedule name PayFrequency: Id/Name StartPayPeriodDate: Date EndPayPeriodDate: Date NextPaymentDate: Date responses: '200': description: You will get this response if your request is processed successfully. content: application/json: example: - Id: 2e23d545-6758-4cd9-9669-2b0bd09ec64d Name: Weekly Schedule PayFrequency: Id: 1 Name: Weekly StartPayPeriodDate: '2021-07-01' EndPayPeriodDate: '2021-07-05' OriginalEndPayPeriodDate: '2021-07-05' OriginalNextPaymentDate: '2021-07-02' NextPaymentDate: '2021-07-02' - Id: a9a40b9b-4d62-463d-9a1b-9e4bc6dbba3a Name: Monthly Schedule PayFrequency: Id: 3 Name: Monthly StartPayPeriodDate: '2021-07-01' EndPayPeriodDate: '2021-07-31' OriginalEndPayPeriodDate: '2021-07-31' OriginalNextPaymentDate: '2021-07-22' NextPaymentDate: '2021-07-22' '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. '/{cashbookId}/payroll/payschedules/{pay-schedule-id}': put: tags: - payroll module summary: 09 Payroll > Update Pay Schedule by ID (PUT) description: Update a Payroll Schedule from Reckon One Payroll operationId: 6102141084dc8bf2163c72c4 parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: GUID - name: pay-schedule-id in: path description: Pay Schedule Id required: true schema: type: GUID requestBody: content: application/json: example: Name: Schedule name PayFrequency: Id/Name StartPayPeriodDate: Date EndPayPeriodDate: Date NextPaymentDate: Date responses: '200': description: You will get this response if your request is processed successfully. content: application/json: example: - Id: 2e23d545-6758-4cd9-9669-2b0bd09ec64d Name: Weekly Schedule PayFrequency: Id: 1 Name: Weekly StartPayPeriodDate: '2021-07-01' EndPayPeriodDate: '2021-07-05' OriginalEndPayPeriodDate: '2021-07-05' OriginalNextPaymentDate: '2021-07-02' NextPaymentDate: '2021-07-02' - Id: a9a40b9b-4d62-463d-9a1b-9e4bc6dbba3a Name: Monthly Schedule PayFrequency: Id: 3 Name: Monthly StartPayPeriodDate: '2021-07-01' EndPayPeriodDate: '2021-07-31' OriginalEndPayPeriodDate: '2021-07-31' OriginalNextPaymentDate: '2021-07-22' NextPaymentDate: '2021-07-22' '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. delete: tags: - payroll module summary: 09 Payroll > Delete Pay Schedule by ID (DELETE) description: Delete a Payroll Schedule from Reckon One Payroll operationId: 61021767013ea8891f99866c parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: GUID - name: pay-schedule-id in: path description: Pay Schedule Id required: true schema: type: GUID responses: '200': description: You will get this response if your request is processed successfully. '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. get: tags: - payroll module summary: 09 Payroll > Pay Schedules by ID (GET) description: Get the details of a Payroll Schedule from Reckon One Payroll operationId: 610221f4e1ec1298b125f729 parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: GUID - name: pay-schedule-id in: path description: Pay Schedule Id required: true schema: type: GUID responses: '200': description: You will get this response if your request is processed successfully. content: application/json: example: Id: 3abb973a-b6fc-464b-89cc-4576897a7759 Name: Schedule 1 PayFrequency: Id: 1 Name: Weekly StartPayPeriodDate: '2016-07-29' EndPayPeriodDate: '2016-08-04' OriginalEndPayPeriodDate: '2016-08-04' OriginalNextPaymentDate: '2016-08-04' NextPaymentDate: '2016-08-04' '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. '/{cashbookId}/payroll/payschedules/{pay-schedule-id}/link': post: tags: - payroll module summary: 09 Payroll > Pay Schedule > Link employees description: Link employee/s to a Payroll Schedule in Reckon One Payroll operationId: 612c4d2792c6d564fff64015 parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: GUID - name: pay-schedule-id in: path description: Pay Schedule Id required: true schema: type: GUID requestBody: description: Request payload. content: application/json: example: "{\r\n\t \"Employees\":\r\n\t [\r\n\t\t{\r\n\t\t\t\"Id\": \"GUID\" //Only ID is supported. \r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Id\": \"GUID\" //Only ID is supported. \r\n\t\t}\r\n\t ]\r\n}" responses: '200': description: You will get this response if your request is processed successfully. '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. '/{cashbookId}/payroll/payschedules/{pay-schedule-id}/unlink': post: tags: - payroll module summary: 09 Payroll > Pay Schedule > Unlink employees description: Unlink employee/s from a Payroll Schedule in Reckon One Payroll operationId: 612c502b2d05a5fcbbce6e9e parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: GUID - name: pay-schedule-id in: path description: Pay Schedule Id required: true schema: type: GUID requestBody: description: Request payload. content: application/json: example: "{\r\n \"Employees\":\r\n [\r\n {\r\n \"Id\": \"GUID\", //Only ID is supported. \r\n \"Id\": \"GUID\" //Only ID is supported. \r\n }\r\n ]\r\n}" responses: '200': description: You will get this response if your request is processed successfully. '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. '/webhooks/v1/{bookId}/subscription/{subscriptionId}/status': put: summary: 00 Webhooks - Put description: Update a webhook subscription operationId: 61556f9ac09b3513a7bc75a2 parameters: - name: bookId in: path required: true schema: type: '' - name: subscriptionId in: path required: true schema: type: '' responses: '200': description: '/{cashbookId}/payroll/contacts/{employeeId}/leavebalances': get: tags: - payroll module summary: 09 Payroll > Contacts > Leave Balances (GET) description: Get the Employee's Leave Balances data from Reckon One Payroll operationId: 62144c187af4ffec9ec63370 parameters: - name: cashbookId in: path description: Your Reckon One Book ID required: true schema: type: GUID - name: employeeId in: path description: The Employee's Id required: true schema: type: GUID requestBody: content: application/json: example: TransferDate: '2018-09-25' Description: Transfer of funds FromBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 ToBankAccountId: 128be71d-2997-49e8-84a2-3f63e4542792 Amount: 200 responses: '200': description: You will get this response if your request is processed successfully. content: application/json: example: - EmployeeLeaveId: 9470a313-1d03-4520-90d1-9710dabe71f8 Accrued: 35 Used: 0 Available: 35 Projected: 35 AvailableDollarValue: 0 PayItemType: 13 PayItemName: Personal Leave - EmployeeLeaveId: 68781c6c-1b11-4686-9db0-efeb04a00eb2 Accrued: 105 Used: 0 Available: 105 Projected: 105 AvailableDollarValue: 0 PayItemType: 12 PayItemName: Annual Leave '401': description: You will get this when the user is not authorised for either the book or do not have payroll module enabled. /*: delete: summary: 99 - DELETE CatchAll description: 'Catch all route ' operationId: 99-delete-catchall responses: '200': description: get: summary: 99 - GET CatchAll description: Catchall request operationId: 99-get-catchall responses: '200': description: options: summary: 99 - OPTIONS CatchAll description: Options CatchAll operationId: 99-options-catchall responses: '200': description: patch: summary: 99 - PATCH CatchAll operationId: 99-patch-catchall responses: '200': description: post: summary: 99 - POST CatchAll operationId: 99-post-catchall responses: '200': description: put: summary: 99 - PUT CatchAll operationId: 99-put-catchall responses: '200': description: components: securitySchemes: apiKeyHeader: type: apiKey name: Ocp-Apim-Subscription-Key in: header apiKeyQuery: type: apiKey name: subscription-key in: query oauth255de5bf3fad2430facb57aaa: type: oauth2 flows: implicit: authorizationUrl: https://identity.reckon.com/connect/authorize scopes: read write: read write security: - apiKeyHeader: [ ] oauth255de5bf3fad2430facb57aaa: - read write - apiKeyQuery: [ ] oauth255de5bf3fad2430facb57aaa: - read write